Skip to content

BundlingOptions

Bundling options.

Initializer

using AlibabaCloud.SDK.ROS.CDK.Core;
new BundlingOptions {
    DockerImage Image,
    BundlingFileAccess BundlingFileAccess = null,
    string[] Command = null,
    string[] Entrypoint = null,
    System.Collections.Generic.IDictionary<string, string> Environment = null,
    ILocalBundling Local = null,
    string Network = null,
    BundlingOutput OutputType = null,
    string Platform = null,
    string SecurityOpt = null,
    string User = null,
    DockerVolume[] Volumes = null,
    string[] VolumesFrom = null,
    string WorkingDirectory = null
};

Properties

Name Type Description
Image DockerImage The Docker image where the command will run.
BundlingFileAccess BundlingFileAccess The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.
Command string[] The command to run in the Docker container.
Entrypoint string[] The entrypoint to run in the Docker container.
Environment System.Collections.Generic.IDictionary The environment variables to pass to the Docker container.
Local ILocalBundling Local bundling provider.
Network string Docker Networking options.
OutputType BundlingOutput The type of output that this bundling operation is producing.
Platform string Platform to build for. Requires Docker Buildx.
SecurityOpt string Security configuration when running the docker container.
User string The user to use when running the Docker container.
Volumes DockerVolume[] Additional Docker volumes to mount.
VolumesFrom string[] Where to mount the specified volumes from.
WorkingDirectory string Working directory inside the Docker container.

ImageRequired

public DockerImage Image { get; set; }

The Docker image where the command will run.


BundlingFileAccessOptional

public BundlingFileAccess BundlingFileAccess { get; set; }

The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.


CommandOptional

public string[] Command { get; set; }
  • Type: string[]
  • Default: run the command defined in the image

The command to run in the Docker container.

Example value: ['npm', 'install']

https://docs.docker.com/engine/reference/run/


EntrypointOptional

public string[] Entrypoint { get; set; }
  • Type: string[]
  • Default: run the entrypoint defined in the image

The entrypoint to run in the Docker container.

Example value: ['/bin/sh', '-c']

https://docs.docker.com/engine/reference/builder/#entrypoint


EnvironmentOptional

public System.Collections.Generic.IDictionary<string, string> Environment { get; set; }
  • Type: System.Collections.Generic.IDictionary
  • Default: no environment variables.

The environment variables to pass to the Docker container.


LocalOptional

public ILocalBundling Local { get; set; }
  • Type: ILocalBundling
  • Default: bundling will only be performed in a Docker container

Local bundling provider.

The provider implements a method tryBundle() which should return true if local bundling was performed. If false is returned, docker bundling will be done.


NetworkOptional

public string Network { get; set; }
  • Type: string
  • Default: no networking options

Docker Networking options.


OutputTypeOptional

public BundlingOutput OutputType { get; set; }

The type of output that this bundling operation is producing.


PlatformOptional

public string Platform { get; set; }
  • Type: string
  • Default: no platform specified (the current machine architecture will be used)

Platform to build for. Requires Docker Buildx.

Specify this property to build images on a specific platform.


SecurityOptOptional

public string SecurityOpt { get; set; }
  • Type: string
  • Default: no security options

Security configuration when running the docker container.


UserOptional

public string User { get; set; }
  • Type: string
  • Default: uid:gid of the current user or 1000:1000 on Windows

The user to use when running the Docker container.

user | user:group | uid | uid:gid | user:gid | uid:group

https://docs.docker.com/engine/reference/run/#user


VolumesOptional

public DockerVolume[] Volumes { get; set; }
  • Type: DockerVolume[]
  • Default: no additional volumes are mounted

Additional Docker volumes to mount.


VolumesFromOptional

public string[] VolumesFrom { get; set; }
  • Type: string[]
  • Default: no containers are specified to mount volumes from

Where to mount the specified volumes from.

https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container---volumes-from


WorkingDirectoryOptional

public string WorkingDirectory { get; set; }
  • Type: string
  • Default: /asset-input

Working directory inside the Docker container.