Skip to main content

Container Images

This section explains how to build, run and manage container images via the Atym CLI.

add aot​

Add an AOT (Ahead of Time) compilation to a repository image

Usage:
  atym add aot [IMAGE_NAME[:TAG]] [flags]

Flags:
  -c, --cpu string         Device cpu type
  -p, --heapSize int       Heap size in bytes
  -h, --help               help for aot
  -s, --stackSize int      Stack size in bytes
  -t, --target string      Device architecture type
  -a, --targetAbi string   Device target ABI
  -x, --xip                XIP (Execute In Place) enabled

Required: IMAGE_NAME[:TAG] and --target. Additional requirements depend on your configuration:

  • For target-only: --target
  • For target + target-abi: --target and --targetAbi
  • For target + target-abi + cpu: --target, --targetAbi, and --cpu

Optional: --xip (can be used with any combination above)

Note: The compiler will validate the combination of target and target-abi. If an invalid combination is provided, the compiler will return an error.

Accepted Values​

ParameterDescriptionAccepted Values
cpuThe device cpu typeSee available CPU types
targetThe device architecture typeSee available Target types
targetAbiThe Application Binary Interface for the target platformSee available TargetAbi types

build​

Builds a container image based on the build file.

Usage:
  atym build [-f FILENAME]

Flags:
  -f, --filename string   image definition file (default "build.yaml")
  -h, --help              help for build
  -s, --skip-validation   skip validation of the buildfile
  -v, --verbose           verbose output

Note: If filename is not specified, the build operation assumes a build file named build.yaml in your CWD.

clear​

Clears a container or container set from a given device.

Usage:
  atym clear [flags]

Flags:
  -d, --device string   device Id to remove the container set from
  -h, --help            help for clear
  -n, --name string     device name to look up

If no device is given, atym clear will remove containers from the default device set in your config.

list containers​

Returns a list of containers associated with the device.

Usage:
  atym list containers [DEVICE_ID] [flags]

Flags:
  -h, --help          help for containers
  -n, --name string   Device Name

Required: DEVICE_ID, or -n followed by your Device name.

list images​

Returns a list of images in a given repo.

Usage:
  atym list images [repository] [flags]

Flags:
  -h, --help   help for images

Required: repository.

push​

Pushes the specified container image to the Atym Hub.

Usage:
  atym push [-v] [IMAGE_NAME|IMAGE_NAME[:TAG] [-d "Image description"] [-k keep zip]

Flags:
  -a, --aotConfig string     AOT yaml configuration file
  -d, --description string   package description
  -h, --help                 help for push
  -k, --keep                 Do not delete upload zip file
  -v, --verbose              provide verbose output

Required: IMAGE_NAME. If no tag is given latest is assumed.

info

For more details on the AOT configuration file (used with --aotConfig), see AOT Compilation.

run​

This command deploys the provided images to the device container set. It replaces all existing containers on the device with the specified image. If the image tag is not specified, 'latest' will be used. The NAME field is used to specify a name for the container. If not specified, the NAME IMAGE_REF is used as the container name. The device Id is the ID of the device to which the container is to be deployed. you can supply any number of container images by using repeating pairs of: [ NAME IMAGE_REF[:TAG] ]

Examples:

  • atym run mycontainer1 myimage:latest mycontainer2 myimage2:latest(assumes DEVICE_ID is set in config)
  • atym run -d 12345678-1234-1234-1234-123456789012 mycontainer1 myimage:latest mycontainer2 myimage2:latest
  • atym run -n mydevice mycontainer1 myimage:latest mycontainer2 myimage2:latest
  • atym run -n mydevice -t 12345678-1234-1234-1234-123456789012 mycontainer1 myimage:latest mycontainer2 myimage2:latest
Usage:
  atym run [-d DEVICE_ID | -n DEVICE_NAME]  [ NAME IMAGE_REF[:TAG] ]

Flags:
  -d, --device string   device Id to deploy the container set to
  -h, --help            help for run
  -n, --name string     device name to look up
  -v, --verbose         provide verbose output

Required: NAME IMAGE_REF[:TAG]

show manifest​

Gets the manifest of a container image

Usage:
  atym show manifest [IMAGE_NAME[:TAG]] [flags]

Flags:
  -h, --help   help for manifest

Required: NAME IMAGE_REF[:TAG]