Convert an application to run in ACI.

  • Published on Jul 30, 2024
  • 1 minute(s) read
Prev Next
Post
/v1/tools/converter/convert-app/aci
Body parameters
Expand All
object
request
object (ConverterSvcConversionRequest) Required
input_image
object (ConversionRequestImageInfo) Required
name
string Required

Docker image name

auth_config
object (AuthConfig)

Credentials for authenticating to a docker registry

username
string

User name for docker registry authentication

password
string

Password for docker registry authentication. Note that this field may be redacted when it appears in API responses.

output_image
object (ConversionRequestImageInfo) Required
name
string Required

Docker image name

auth_config
object (AuthConfig)

Credentials for authenticating to a docker registry

username
string

User name for docker registry authentication

password
string

Password for docker registry authentication. Note that this field may be redacted when it appears in API responses.

converter_options
object (ConverterSvcConverterOptions) Required
allow_cmdline_args
boolean

Allow command line arguments.

allow_docker_pull_failure
boolean

Allow Docker Pull failure.

certificates
Array of object (CertificateConfig)
object
issuer
string

Certificate issuance strategy

Valid values[ "MANAGER_CA", "NODE", "SELF_IAS" ]
Default"MANAGER_CA"
subject
string

Certificate subject common name, typically a DNS name

keyType
string

Type of key to generate

Valid values[ "RSA" ]
Default"RSA"
keyParam
object

Key parameters. Currently must be an instance of RsaKeyParam, but other types may be supported in the future.

keyPath
string

Path to expose the key in the application filesystem

certPath
string

Path to expose the certificate in the application filesystem

debug
boolean

Enables debug logging from EnclaveOS

entrypoint
Array of string

Override the entrypoint of the original container

string
entrypoint_args
Array of string

Override additional arguments to the container entrypoint

string
push_converted_image
boolean

Enables Pushing Converted Image

env_vars
Array of string

List of manifest environment variables. For ACI, these fixed values become part of the security policy.

string
mutable_env_vars
Array of string

List of mutable environment variable default values. For ACI, these become deployment template parameters.

string
java_mode
string

Type of the Java JVM used

aci_options
object (AciConversionRequestOptions) Required
cpu_count
integer (int32)

Number of cores

Maximum65535
Minimum1
Default"1"
gb_mem
number (double)

Container memory size in GBs (1,000,000,000 bytes)

Minimum0
Default"1"
wait_for_agent
boolean

Inserts a loop waiting for /opt/fortanix/agent.ready into your application's entrypoint; ensures app startup occurs after confidential compute verifications. Don't touch this unless there's good reason.

Default"True"
Responses
200

Generated templates

Expand All
object
converted_image
object (ConverterSvcConvertedImageInfo)
name
string

Converted image name (with tag)

sha
string

Converted image sha

size
integer (int64)

Converted image size

config
object (ConverterSvcAciConfig)
caci_template
string

Confidential ACI deployment template

exposed_ports
Array of object (DockerNetworkPort)

List of ports exposed by the Docker image.

object

A port exposed by a docker container.

port
integer

A valid, specific port number from 1..65535 (inclusive).

protocol
string

Protocol Associated with a Port exposed by a docker container.

Valid values[ "Tcp", "Udp" ]