@nebius/js-sdk - v0.2.78
    Preparing search index...

    Interface ContainerDefinition

    ContainerDefinition defines a container that will be run on the VM.

    interface ContainerDefinition {
        "[customJson]"?: () => unknown;
        "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>;
        $type: "nebius.applications.v1alpha1.ContainerDefinition";
        command: string;
        entrypoint: string;
        environmentVariables: EnvironmentVariable[];
        exportLogs: boolean;
        gpu?:
            | { $case: "gpuCount"; gpuCount: Long }
            | { $case: "allGpus"; allGpus: boolean };
        hostIpc: boolean;
        hostNetwork: boolean;
        image: string;
        injectedFiles: ContainerDefinition_InjectedFile[];
        maxAttempts?: Long;
        name: string;
        ports: ContainerDefinition_Port[];
        privileged: boolean;
        registryPassword: string;
        registryUsername: string;
        restartPolicy: ContainerDefinition_RestartPolicy;
        runtimeUser?: ContainerDefinition_User;
        shmSizeBytes: Long;
        volumes: ContainerDefinition_Volume[];
        workingDir: string;
        [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined;
    }

    Indexable

    • [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined

      ContainerDefinition defines a container that will be run on the VM.

      • Uint8Array<ArrayBufferLike>
      • () => unknown
          • (): unknown

          • ContainerDefinition defines a container that will be run on the VM.

            Returns unknown

      • undefined
    Index
    [customJson]? [unknownFieldsSymbol]? $type command entrypoint environmentVariables exportLogs gpu? hostIpc hostNetwork image injectedFiles maxAttempts? name ports privileged registryPassword registryUsername restartPolicy runtimeUser? shmSizeBytes volumes workingDir
    "[customJson]"?: () => unknown

    Returns a safe value for JSON logs.

    Type Declaration

      • (): unknown

      • Returns a safe value for JSON logs.

        Returns unknown

    "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>

    Preserves protobuf fields that this SDK version does not recognize.

    $type: "nebius.applications.v1alpha1.ContainerDefinition"

    Contains the fully qualified protobuf type name.

    command: string

    The command for the container in shell-string format. If not specified, the default entrypoint from the image will be used.

    entrypoint: string

    The entrypoint for the container.

    environmentVariables: EnvironmentVariable[]

    Specifies the environment variables for the container.

    exportLogs: boolean

    Enables logs export to Nebius Observability.

    gpu?:
        | { $case: "gpuCount"; gpuCount: Long }
        | { $case: "allGpus"; allGpus: boolean }

    GPU configuration for the container. If not specified, the container will not have access to GPUs. Ignored if the compute instance does not have GPUs.

    Type Declaration

    • { $case: "gpuCount"; gpuCount: Long }
      • $case: "gpuCount"

        Contains the case.

      • gpuCount: Long

        Contains the gpu count.

    • { $case: "allGpus"; allGpus: boolean }
      • $case: "allGpus"

        Contains the case.

      • allGpus: boolean

        Contains the all gpus.

    hostIpc: boolean

    Enables host IPC namespace sharing.

    hostNetwork: boolean

    Enables host network namespace sharing.

    image: string

    The Docker image to use for the container.

    injectedFiles: ContainerDefinition_InjectedFile[]

    Small files materialized inside the container before it starts.

    maxAttempts?: Long

    The maximum number of restart attempts for the ON_FAILURE restart policy. If absent or zero, restarts have no limit. A positive value limits the number of restarts. Other restart policies ignore this field. Devlab templates must omit it.

    name: string

    The name of the container. This name is should be unique within the VM app. If not specified, it will be generated based on the image name.

    ports: ContainerDefinition_Port[]

    Specifies the ports that the container exposes.

    privileged: boolean

    If true, the container will be run in privileged mode.

    registryPassword: string

    The docker registry password to configure for the container.

    registryUsername: string

    The docker registry username to configure for the container.

    restartPolicy: ContainerDefinition_RestartPolicy

    The restart policy for the container. If not specified, the default policy is "always".

    runtimeUser?: ContainerDefinition_User

    The user to run the container as.

    shmSizeBytes: Long

    Shared memory size in bytes.

    volumes: ContainerDefinition_Volume[]

    The volume to be mounted into the container.

    workingDir: string

    The working directory for the container.

    Settings
    Member Visibility

    On This Page
    Properties