Package version:

Interface DeploymentSettings

Deployment settings payload

Hierarchy

  • DeploymentSettings

Properties

addonConfigs? containerProbeSettings? environmentVariables? livenessProbe? readinessProbe? resourceRequests? startupProbe? terminationGracePeriodSeconds?

Properties

Optional addonConfigs

addonConfigs?: {
    [propertyName: string]: {
        [propertyName: string]: Record<string, unknown>;
    };
}

Collection of addons

Type declaration

  • [propertyName: string]: {
        [propertyName: string]: Record<string, unknown>;
    }
    • [propertyName: string]: Record<string, unknown>

Optional containerProbeSettings

containerProbeSettings?: ContainerProbeSettings

Container liveness and readiness probe settings

Optional environmentVariables

environmentVariables?: {
    [propertyName: string]: string;
}

Collection of environment variables

Type declaration

  • [propertyName: string]: string

Optional livenessProbe

livenessProbe?: Probe

Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Optional readinessProbe

readinessProbe?: Probe

Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Optional resourceRequests

resourceRequests?: ResourceRequests

The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later.

Optional startupProbe

startupProbe?: Probe

StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Optional terminationGracePeriodSeconds

terminationGracePeriodSeconds?: number

Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.

Settings

Member Visibility

Theme

Generated using TypeDoc