Documentation - v0.0.0
    Preparing search index...

    Interface CeleryProps

    interface CeleryProps {
        args?: string[];
        automountServiceAccountToken?: boolean;
        concurrency?: number;
        config?: IApiConfig;
        containerDefaults?: Partial<ContainerProps>;
        containers?: ContainerProps[];
        dns?: PodDnsProps;
        dockerRegistryAuth?: ISecret;
        hostAliases?: HostAlias[];
        hostNetwork?: boolean;
        image?: ContainerImageProps;
        initContainers?: ContainerProps[];
        isolate?: boolean;
        metadata?: ApiObjectMetadata;
        name?: string;
        podMetadata?: ApiObjectMetadata;
        probes?: Pick<ContainerProps, "readiness" | "liveness" | "startup">;
        queues: string[];
        replicaCount?: number;
        resources?: ContainerResourceProps;
        restartPolicy?: RestartPolicy;
        scaling?: ComponentScalingProps;
        securityContext?: PodSecurityContextProps;
        select?: boolean;
        serviceAccount?: IServiceAccount;
        shareProcessNamespace?: boolean;
        spread?: boolean;
        terminationGracePeriod?: Duration;
        verticalScaling?: VerticalAutoscalingDeploymentProps;
        volumes?: Volume[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    args? automountServiceAccountToken? concurrency? config? containerDefaults? containers? dns? dockerRegistryAuth? hostAliases? hostNetwork? image? initContainers? isolate? metadata? name? podMetadata? probes? queues replicaCount? resources? restartPolicy? scaling? securityContext? select? serviceAccount? shareProcessNamespace? spread? terminationGracePeriod? verticalScaling? volumes?

    Properties

    args?: string[]
    automountServiceAccountToken?: boolean

    Indicates whether a service account token should be automatically mounted.

    false

    https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server

    concurrency?: number
    config?: IApiConfig
    containerDefaults?: Partial<ContainerProps>
    containers?: ContainerProps[]

    List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod.

    You can add additionnal containers using podSpec.addContainer()

    - No containers. Note that a pod spec must include at least one container.
    dns?: PodDnsProps

    DNS settings for the pod.

    https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/

    policy: DnsPolicy.CLUSTER_FIRST
     hostnameAsFQDN: false
    dockerRegistryAuth?: ISecret

    A secret containing docker credentials for authenticating to a registry.

    - No auth. Images are assumed to be publicly available.
    hostAliases?: HostAlias[]

    HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

    io.k8s.api.core.v1.HostAlias

    hostNetwork?: boolean

    Host network for the pod.

    false
    image?: ContainerImageProps
    initContainers?: ContainerProps[]

    List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

    Init containers cannot currently be added ,removed or updated.

    https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

    - No init containers.
    isolate?: boolean

    Isolates the pod. This will prevent any ingress or egress connections to / from this pod. You can however allow explicit connections post instantiation by using the .connections property.

    false
    metadata?: ApiObjectMetadata

    Metadata that all persisted resources must have, which includes all objects users must create.

    name?: string
    podMetadata?: ApiObjectMetadata

    The pod metadata of this workload.

    probes?: Pick<ContainerProps, "readiness" | "liveness" | "startup">
    queues: string[]
    replicaCount?: number
    resources?: ContainerResourceProps
    restartPolicy?: RestartPolicy

    Restart policy for all containers within the pod.

    https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy

    RestartPolicy.ALWAYS
    scaling?: ComponentScalingProps
    securityContext?: PodSecurityContextProps

    SecurityContext holds pod-level security attributes and common container settings.

    fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS
      ensureNonRoot: true
    select?: boolean

    Automatically allocates a pod label selector for this workload and add it to the pod metadata. This ensures this workload manages pods created by its pod template.

    true
    serviceAccount?: IServiceAccount

    A service account provides an identity for processes that run in a Pod.

    When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

    https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

    - No service account.
    shareProcessNamespace?: boolean

    When process namespace sharing is enabled, processes in a container are visible to all other containers in the same pod.

    false

    https://kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/

    spread?: boolean

    Automatically spread pods across hostname and zones.

    https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints

    false
    terminationGracePeriod?: Duration

    Grace period until the pod is terminated

    Duration.seconds(30)
    verticalScaling?: VerticalAutoscalingDeploymentProps
    volumes?: Volume[]

    List of volumes that can be mounted by containers belonging to the pod.

    You can also add volumes later using podSpec.addVolume()

    https://kubernetes.io/docs/concepts/storage/volumes

    - No volumes.

    Settings

    Member Visibility

    On This Page

    Properties