Help Center> ModelArts> DevEnviron> ModelArts CLI Command Reference> ma-cli Image Building Command> Creating an Image in ModelArts Notebook

Creating an Image in ModelArts Notebook

Run the ma-cli image build command to create an image based on a specified Dockerfile. This command is available only in ModelArts notebook instances.

$ ma-cli image build -h
Usage: ma-cli image build [OPTIONS] FILE_PATH

  Build docker image in Notebook.

  Example:

  # Build a image and push to SWR
  ma-cli image build .ma/customize_from_ubuntu_18.04_to_modelarts/Dockerfile -swr my_organization/my_image:0.0.1

  # Build a image and push to SWR, dockerfile context path is current dir
  ma-cli image build .ma/customize_from_ubuntu_18.04_to_modelarts/Dockerfile -swr my_organization/my_image:0.0.1 -context .

  # Build a local image and save to local path and OBS
  ma-cli image build .ma/customize_from_ubuntu_18.04_to_modelarts/Dockerfile --target ./build.tar --obs_path obs://bucket/object --swr-path my_organization/my_image:0.0.1

Options:
  -t, --target TEXT       Name and optionally a tag in the 'name:tag' format.
  -swr, --swr-path TEXT   SWR path without swr endpoint, eg:organization/image:tag.  [required]
  --context DIRECTORY     build context path.
  -arg, --build-arg TEXT  build arg for Dockerfile.
  -obs, --obs-path TEXT   OBS path to save local built image.
  -f, --force             Force to overwrite the existing swr image with the same name and tag.
  -C, --config-file PATH  Configure file path for authorization.
  -D, --debug             Debug Mode. Shows full stack trace when error occurs.
  -P, --profile TEXT      CLI connection profile to use. The default profile is "DEFAULT".
  -H, -h, --help          Show this message and exit.
Table 1 Parameters

Parameter

Type

Mandatory

Description

FILE_PATH

String

Yes

Directory where the Dockerfile is stored

-t / --target

String

No

Local path for storing the generated TAR package. The current directory is used by default.

-swr / --swr-path

String

Yes

SWR image name, which is in the format of "organization/image_name:tag". This parameter can be omitted when a TAR package is saved for creating an image.

--context

String

No

Path of the context information for data copying when creating a Dockerfile

-arg / --build-arg

String

No

Parameter for creating an image. If there are multiple parameters, run --build-arg VERSION=18.04 --build-arg ARCH=X86_64.

-obs / --obs-path

String

No

Automatically upload the generated TAR package to OBS.

-f / --force

Bool

No

Whether to forcibly overwrite an existing SWR image with the same name. By default, the SWR image is not overwritten.

Examples

Create an image in ModelArts notebook.

ma-cli image build .ma/customize_from_ubuntu_18.04_to_modelarts/Dockerfile -swr notebook_test/my_image:0.0.1

In this command, .ma/customize_from_ubuntu_18.04_to_modelarts/Dockerfile is the path where the Dockerfile is stored, and notebook_test/my_image:0.0.1 is the SWR path of the new image.