Action "docker.save"

Save Docker images.

Output

err
Error object if any.
$status
True if container was saved.
stdout
Stdout value(s) unless stdout option is provided.
stderr
Stderr value(s) unless stderr option is provided.

Example

const {$status} = await nikita.docker.save({
  image: 'nikita/load_test:latest',
  output: `${scratch}/nikita_saved.tar`,
})
console.info(`Container was saved: ${$status}`)

Hooks

on_action = ({config}) ->
  config.output ?= config.target

Schema definitions

definitions =
  config:
    type: 'object'
    properties:
      'docker':
        $ref: 'module://@nikitajs/docker/src/tools/execute#/definitions/docker'
      'image':
        type: 'string'
        description: '''
        Name/ID of base image.
        '''
      'tag':
        type: 'string'
        description: '''
        Tag of the image.
        '''
      'output':
        type: 'string'
        description: '''
        TAR archive output path.
        '''
      'target':
        type: 'string'
        description: '''
        Shortcut for "output" option, required.
        '''
    required: ['image', 'output']

Handler

handler = ({config, tools: {log}}) ->
  # Saves image to local tmp path, than copy it
  log message: "Extracting image #{config.output} to file:#{config.image}", level: 'INFO'
  await @docker.tools.execute
    command: [
      "save -o #{config.output} #{config.image}"
      ":#{config.tag}" if config.tag?
    ].join ''

Exports

module.exports =
  handler: handler
  hooks:
    on_action: on_action
  metadata:
    global: 'docker'
    definitions: definitions

Edit on GitHub