export declare namespace io.k8s.api.authentication.v1 { /** BoundObjectReference is a reference to an object that a token is bound to. */ interface BoundObjectReference { /** API version of the referent. */ apiVersion?: string; /** Kind of the referent. Valid kinds are 'Pod' and 'Secret'. */ kind?: string; /** Name of the referent. */ name?: string; /** UID of the referent. */ uid?: string; } /** TokenRequest requests a token for a given service account. */ interface TokenRequest { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec holds information about the request being evaluated */ spec: io.k8s.api.authentication.v1.TokenRequestSpec; /** Status is filled in by the server and indicates whether the token can be authenticated. */ status?: io.k8s.api.authentication.v1.TokenRequestStatus; } /** TokenRequestSpec contains client provided parameters of a token request. */ interface TokenRequestSpec { /** Audiences are the intendend audiences of the token. A recipient of a token must identify themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences. */ audiences: string[]; /** BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation. */ boundObjectRef?: io.k8s.api.authentication.v1.BoundObjectReference; /** * ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response. * @format int64 */ expirationSeconds?: number; } /** TokenRequestStatus is the result of a token request. */ interface TokenRequestStatus { /** ExpirationTimestamp is the time of expiration of the returned token. */ expirationTimestamp: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Token is the opaque bearer token. */ token: string; } /** SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase. */ interface SelfSubjectReview { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Status is filled in by the server with the user attributes. */ status?: io.k8s.api.authentication.v1.SelfSubjectReviewStatus; } /** SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user. */ interface SelfSubjectReviewStatus { /** User attributes of the user making this request. */ userInfo?: io.k8s.api.authentication.v1.UserInfo; } /** TokenReview attempts to authenticate a token to a known user. Note: TokenReview requests may be cached by the webhook token authenticator plugin in the kube-apiserver. */ interface TokenReview { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec holds information about the request being evaluated */ spec: io.k8s.api.authentication.v1.TokenReviewSpec; /** Status is filled in by the server and indicates whether the request can be authenticated. */ status?: io.k8s.api.authentication.v1.TokenReviewStatus; } /** TokenReviewSpec is a description of the token authentication request. */ interface TokenReviewSpec { /** Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. */ audiences?: string[]; /** Token is the opaque bearer token. */ token?: string; } /** TokenReviewStatus is the result of the token authentication request. */ interface TokenReviewStatus { /** Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server. */ audiences?: string[]; /** Authenticated indicates that the token was associated with a known user. */ authenticated?: boolean; /** Error indicates that the token couldn't be checked */ error?: string; /** User is the UserInfo associated with the provided token. */ user?: io.k8s.api.authentication.v1.UserInfo; } /** UserInfo holds the information about the user needed to implement the user.Info interface. */ interface UserInfo { /** Any additional information provided by the authenticator. */ extra?: Record; /** The names of groups this user is a part of. */ groups?: string[]; /** A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs. */ uid?: string; /** The name that uniquely identifies this user among all active users. */ username?: string; } } export declare namespace io.k8s.api.autoscaling.v1 { /** Scale represents a scaling request for a resource. */ interface Scale { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec defines the behavior of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. */ spec?: io.k8s.api.autoscaling.v1.ScaleSpec; /** status is the current status of the scale. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. Read-only. */ status?: io.k8s.api.autoscaling.v1.ScaleStatus; } /** ScaleSpec describes the attributes of a scale subresource. */ interface ScaleSpec { /** * replicas is the desired number of instances for the scaled object. * @format int32 */ replicas?: number; } /** ScaleStatus represents the current status of a scale subresource. */ interface ScaleStatus { /** * replicas is the actual number of observed instances of the scaled object. * @format int32 */ replicas: number; /** selector is the label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ */ selector?: string; } /** CrossVersionObjectReference contains enough information to let you identify the referred resource. */ interface CrossVersionObjectReference { /** apiVersion is the API version of the referent */ apiVersion?: string; /** kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind: string; /** name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** configuration of a horizontal pod autoscaler. */ interface HorizontalPodAutoscaler { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec defines the behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. */ spec?: io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerSpec; /** status is the current information about the autoscaler. */ status?: io.k8s.api.autoscaling.v1.HorizontalPodAutoscalerStatus; } /** list of horizontal pod autoscaler objects. */ interface HorizontalPodAutoscalerList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of horizontal pod autoscaler objects. */ items: io.k8s.api.autoscaling.v1.HorizontalPodAutoscaler[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** specification of a horizontal pod autoscaler. */ interface HorizontalPodAutoscalerSpec { /** * maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. * @format int32 */ maxReplicas: number; /** * minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. * @format int32 */ minReplicas?: number; /** reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource. */ scaleTargetRef: io.k8s.api.autoscaling.v1.CrossVersionObjectReference; /** * targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used. * @format int32 */ targetCPUUtilizationPercentage?: number; } /** current status of a horizontal pod autoscaler */ interface HorizontalPodAutoscalerStatus { /** * currentCPUUtilizationPercentage is the current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU. * @format int32 */ currentCPUUtilizationPercentage?: number; /** * currentReplicas is the current number of replicas of pods managed by this autoscaler. * @format int32 */ currentReplicas: number; /** * desiredReplicas is the desired number of replicas of pods managed by this autoscaler. * @format int32 */ desiredReplicas: number; /** lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed. */ lastScaleTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** * observedGeneration is the most recent generation observed by this autoscaler. * @format int64 */ observedGeneration?: number; } } export declare namespace io.k8s.api.core.v1 { /** * Represents a Persistent Disk resource in AWS. * * An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. */ interface AWSElasticBlockStoreVolumeSource { /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ fsType?: string; /** * partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). * @format int32 */ partition?: number; /** readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ readOnly?: boolean; /** volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ volumeID: string; } /** Affinity is a group of affinity scheduling rules. */ interface Affinity { /** Describes node affinity scheduling rules for the pod. */ nodeAffinity?: io.k8s.api.core.v1.NodeAffinity; /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ podAffinity?: io.k8s.api.core.v1.PodAffinity; /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ podAntiAffinity?: io.k8s.api.core.v1.PodAntiAffinity; } /** AttachedVolume describes a volume attached to a node */ interface AttachedVolume { /** DevicePath represents the device path where the volume should be available */ devicePath: string; /** Name of the attached volume */ name: string; } /** AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. */ interface AzureDiskVolumeSource { /** cachingMode is the Host Caching mode: None, Read Only, Read Write. */ cachingMode?: string; /** diskName is the Name of the data disk in the blob storage */ diskName: string; /** diskURI is the URI of data disk in the blob storage */ diskURI: string; /** fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared */ kind?: string; /** readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; } /** AzureFile represents an Azure File Service mount on the host and bind mount to the pod. */ interface AzureFilePersistentVolumeSource { /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretName is the name of secret that contains Azure Storage Account Name and Key */ secretName: string; /** secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod */ secretNamespace?: string; /** shareName is the azure Share Name */ shareName: string; } /** AzureFile represents an Azure File Service mount on the host and bind mount to the pod. */ interface AzureFileVolumeSource { /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretName is the name of secret that contains Azure Storage Account Name and Key */ secretName: string; /** shareName is the azure share Name */ shareName: string; } /** Binding ties one object to another; for example, a pod is bound to a node by a scheduler. Deprecated in 1.7, please use the bindings subresource of pods instead. */ interface Binding { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** The target object that you want to bind to the standard object. */ target: io.k8s.api.core.v1.ObjectReference; } /** Represents storage that is managed by an external CSI volume driver (Beta feature) */ interface CSIPersistentVolumeSource { /** controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. */ controllerExpandSecretRef?: io.k8s.api.core.v1.SecretReference; /** controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. */ controllerPublishSecretRef?: io.k8s.api.core.v1.SecretReference; /** driver is the name of the driver to use for this volume. Required. */ driver: string; /** fsType to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". */ fsType?: string; /** nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call. This is a beta field which is enabled default by CSINodeExpandSecret feature gate. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed. */ nodeExpandSecretRef?: io.k8s.api.core.v1.SecretReference; /** nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. */ nodePublishSecretRef?: io.k8s.api.core.v1.SecretReference; /** nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed. */ nodeStageSecretRef?: io.k8s.api.core.v1.SecretReference; /** readOnly value to pass to ControllerPublishVolumeRequest. Defaults to false (read/write). */ readOnly?: boolean; /** volumeAttributes of the volume to publish. */ volumeAttributes?: Record; /** volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls. Required. */ volumeHandle: string; } /** Represents a source location of a volume to mount, managed by an external CSI driver */ interface CSIVolumeSource { /** driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. */ driver: string; /** fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. */ fsType?: string; /** nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. */ nodePublishSecretRef?: io.k8s.api.core.v1.LocalObjectReference; /** readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). */ readOnly?: boolean; /** volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. */ volumeAttributes?: Record; } /** Adds and removes POSIX capabilities from running containers. */ interface Capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. */ interface CephFSPersistentVolumeSource { /** monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ monitors: string[]; /** path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / */ path?: string; /** readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ readOnly?: boolean; /** secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ secretFile?: string; /** secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ secretRef?: io.k8s.api.core.v1.SecretReference; /** user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ user?: string; } /** Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling. */ interface CephFSVolumeSource { /** monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ monitors: string[]; /** path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / */ path?: string; /** readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ readOnly?: boolean; /** secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ secretFile?: string; /** secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ secretRef?: io.k8s.api.core.v1.LocalObjectReference; /** user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ user?: string; } /** Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. */ interface CinderPersistentVolumeSource { /** fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ fsType?: string; /** readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ readOnly?: boolean; /** secretRef is Optional: points to a secret object containing parameters used to connect to OpenStack. */ secretRef?: io.k8s.api.core.v1.SecretReference; /** volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ volumeID: string; } /** Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling. */ interface CinderVolumeSource { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ fsType?: string; /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ readOnly?: boolean; /** secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. */ secretRef?: io.k8s.api.core.v1.LocalObjectReference; /** volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ volumeID: string; } /** * ClaimSource describes a reference to a ResourceClaim. * * Exactly one of these fields should be set. Consumers of this type must treat an empty object as if it has an unknown value. */ interface ClaimSource { /** ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod. */ resourceClaimName?: string; /** * ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. * * The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses. * * This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim. */ resourceClaimTemplateName?: string; } /** ClientIPConfig represents the configurations of Client IP based session affinity. */ interface ClientIPConfig { /** * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). * @format int32 */ timeoutSeconds?: number; } /** Information about the condition of a component. */ interface ComponentCondition { /** Condition error code for a component. For example, a health check error code. */ error?: string; /** Message about the condition for a component. For example, information about a health check. */ message?: string; /** Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown". */ status: string; /** Type of condition for a component. Valid value: "Healthy" */ type: string; } /** ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+ */ interface ComponentStatus { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of component conditions observed */ conditions?: io.k8s.api.core.v1.ComponentCondition[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; } /** Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+ */ interface ComponentStatusList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of ComponentStatus objects. */ items: io.k8s.api.core.v1.ComponentStatus[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ConfigMap holds configuration data for pods to consume. */ interface ConfigMap { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. */ binaryData?: Record; /** Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. */ data?: Record; /** Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. */ immutable?: boolean; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface ConfigMapEnvSource { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** Selects a key from a ConfigMap. */ interface ConfigMapKeySelector { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ConfigMapList is a resource containing a list of ConfigMap objects. */ interface ConfigMapList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of ConfigMaps. */ items: io.k8s.api.core.v1.ConfigMap[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration */ interface ConfigMapNodeConfigSource { /** KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases. */ kubeletConfigKey: string; /** Name is the metadata.name of the referenced ConfigMap. This field is required in all cases. */ name: string; /** Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases. */ namespace: string; /** ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. */ resourceVersion?: string; /** UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status. */ uid?: string; } /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ interface ConfigMapProjection { /** items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: io.k8s.api.core.v1.KeyToPath[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** optional specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ interface ConfigMapVolumeSource { /** * defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: io.k8s.api.core.v1.KeyToPath[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** optional specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** A single application container that you want to run within a pod. */ interface Container { /** Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: io.k8s.api.core.v1.EnvVar[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: io.k8s.api.core.v1.EnvFromSource[]; /** Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Actions that the management system should take in response to container lifecycle events. Cannot be updated. */ lifecycle?: io.k8s.api.core.v1.Lifecycle; /** Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ livenessProbe?: io.k8s.api.core.v1.Probe; /** Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. */ name: string; /** List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. */ ports?: io.k8s.api.core.v1.ContainerPort[]; /** Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ readinessProbe?: io.k8s.api.core.v1.Probe; /** Resources resize policy for the container. */ resizePolicy?: io.k8s.api.core.v1.ContainerResizePolicy[]; /** Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ resources?: io.k8s.api.core.v1.ResourceRequirements; /** RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. */ restartPolicy?: string; /** SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ */ securityContext?: io.k8s.api.core.v1.SecurityContext; /** StartupProbe indicates that the Pod 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 Pod'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 */ startupProbe?: io.k8s.api.core.v1.Probe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: io.k8s.api.core.v1.VolumeDevice[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: io.k8s.api.core.v1.VolumeMount[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** Describe a container image */ interface ContainerImage { /** Names by which this image is known. e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"] */ names?: string[]; /** * The size of the image in bytes. * @format int64 */ sizeBytes?: number; } /** ContainerPort represents a network port in a single container. */ interface ContainerPort { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** * Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". * @default TCP */ protocol?: string; } /** ContainerResizePolicy represents resource resize policy for the container. */ interface ContainerResizePolicy { /** Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. */ resourceName: string; /** Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. */ restartPolicy: string; } /** ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting. */ interface ContainerState { /** Details about a running container */ running?: io.k8s.api.core.v1.ContainerStateRunning; /** Details about a terminated container */ terminated?: io.k8s.api.core.v1.ContainerStateTerminated; /** Details about a waiting container */ waiting?: io.k8s.api.core.v1.ContainerStateWaiting; } /** ContainerStateRunning is a running state of a container. */ interface ContainerStateRunning { /** Time at which the container was last (re-)started */ startedAt?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; } /** ContainerStateTerminated is a terminated state of a container. */ interface ContainerStateTerminated { /** Container's ID in the format '://' */ containerID?: string; /** * Exit status from the last termination of the container * @format int32 */ exitCode: number; /** Time at which the container last terminated */ finishedAt?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Message regarding the last termination of the container */ message?: string; /** (brief) reason from the last termination of the container */ reason?: string; /** * Signal from the last termination of the container * @format int32 */ signal?: number; /** Time at which previous execution of the container started */ startedAt?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; } /** ContainerStateWaiting is a waiting state of a container. */ interface ContainerStateWaiting { /** Message regarding why the container is not yet running. */ message?: string; /** (brief) reason the container is not yet running. */ reason?: string; } /** ContainerStatus contains details for the current status of this container. */ interface ContainerStatus { /** AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after successfully admitting desired pod resize. */ allocatedResources?: Record; /** ContainerID is the ID of the container in the format '://'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd"). */ containerID?: string; /** Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info: https://kubernetes.io/docs/concepts/containers/images. */ image: string; /** ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime. */ imageID: string; /** LastTerminationState holds the last termination state of the container to help debug container crashes and restarts. This field is not populated if the container is still running and RestartCount is 0. */ lastState?: io.k8s.api.core.v1.ContainerState; /** Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated. */ name: string; /** * Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to true once the container is fully started (see Started field). * * The value is typically used to determine whether a container is ready to accept traffic. */ ready: boolean; /** Resources represents the compute resource requests and limits that have been successfully enacted on the running container after it has been started or has been successfully resized. */ resources?: io.k8s.api.core.v1.ResourceRequirements; /** * RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and then the value may be reset to 0. The value is never negative. * @format int32 */ restartCount: number; /** Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. In both cases, startup probes will run again. Is always true when no startupProbe is defined and container is running and has passed the postStart lifecycle hook. The null value must be treated the same as false. */ started?: boolean; /** State holds details about the container's current condition. */ state?: io.k8s.api.core.v1.ContainerState; } /** DaemonEndpoint contains information about a single Daemon endpoint. */ interface DaemonEndpoint { /** * Port number of the given endpoint. * @format int32 */ Port: number; } /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ interface DownwardAPIProjection { /** Items is a list of DownwardAPIVolume file */ items?: io.k8s.api.core.v1.DownwardAPIVolumeFile[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface DownwardAPIVolumeFile { /** Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. */ fieldRef?: io.k8s.api.core.v1.ObjectFieldSelector; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. */ resourceFieldRef?: io.k8s.api.core.v1.ResourceFieldSelector; } /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ interface DownwardAPIVolumeSource { /** * Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** Items is a list of downward API volume file */ items?: io.k8s.api.core.v1.DownwardAPIVolumeFile[]; } /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ interface EmptyDirVolumeSource { /** medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ medium?: string; /** sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ sizeLimit?: io.k8s.apimachinery.pkg.api.resource.Quantity; } /** EndpointAddress is a tuple that describes single IP address. */ interface EndpointAddress { /** The Hostname of this endpoint */ hostname?: string; /** The IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16). */ ip: string; /** Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. */ nodeName?: string; /** Reference to object providing the endpoint. */ targetRef?: io.k8s.api.core.v1.ObjectReference; } /** EndpointPort is a tuple that describes a single port. */ interface EndpointPort { /** * The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * * * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * * * Kubernetes-defined prefixed names: * * 'kubernetes.io/h2c' - HTTP/2 over cleartext as described in https://www.rfc-editor.org/rfc/rfc7540 * * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * * * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. */ appProtocol?: string; /** The name of this port. This must match the 'name' field in the corresponding ServicePort. Must be a DNS_LABEL. Optional only if one port is defined. */ name?: string; /** * The port number of the endpoint. * @format int32 */ port: number; /** The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. */ protocol?: string; } /** * EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: * * { * Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], * Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] * } * * The resulting set of endpoints can be viewed as: * * a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], * b: [ 10.10.1.1:309, 10.10.2.2:309 ] */ interface EndpointSubset { /** IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. */ addresses?: io.k8s.api.core.v1.EndpointAddress[]; /** IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. */ notReadyAddresses?: io.k8s.api.core.v1.EndpointAddress[]; /** Port numbers available on the related IP addresses. */ ports?: io.k8s.api.core.v1.EndpointPort[]; } /** * Endpoints is a collection of endpoints that implement the actual service. Example: * * Name: "mysvc", * Subsets: [ * { * Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], * Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] * }, * { * Addresses: [{"ip": "10.10.3.3"}], * Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] * }, * ] */ interface Endpoints { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. */ subsets?: io.k8s.api.core.v1.EndpointSubset[]; } /** EndpointsList is a list of endpoints. */ interface EndpointsList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of endpoints. */ items: io.k8s.api.core.v1.Endpoints[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface EnvFromSource { /** The ConfigMap to select from */ configMapRef?: io.k8s.api.core.v1.ConfigMapEnvSource; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** The Secret to select from */ secretRef?: io.k8s.api.core.v1.SecretEnvSource; } /** EnvVar represents an environment variable present in a Container. */ interface EnvVar { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** Source for the environment variable's value. Cannot be used if value is not empty. */ valueFrom?: io.k8s.api.core.v1.EnvVarSource; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface EnvVarSource { /** Selects a key of a ConfigMap. */ configMapKeyRef?: io.k8s.api.core.v1.ConfigMapKeySelector; /** Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. */ fieldRef?: io.k8s.api.core.v1.ObjectFieldSelector; /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. */ resourceFieldRef?: io.k8s.api.core.v1.ResourceFieldSelector; /** Selects a key of a secret in the pod's namespace */ secretKeyRef?: io.k8s.api.core.v1.SecretKeySelector; } /** * An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation. * * To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted. */ interface EphemeralContainer { /** Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: io.k8s.api.core.v1.EnvVar[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: io.k8s.api.core.v1.EnvFromSource[]; /** Container image name. More info: https://kubernetes.io/docs/concepts/containers/images */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle is not allowed for ephemeral containers. */ lifecycle?: io.k8s.api.core.v1.Lifecycle; /** Probes are not allowed for ephemeral containers. */ livenessProbe?: io.k8s.api.core.v1.Probe; /** Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. */ name: string; /** Ports are not allowed for ephemeral containers. */ ports?: io.k8s.api.core.v1.ContainerPort[]; /** Probes are not allowed for ephemeral containers. */ readinessProbe?: io.k8s.api.core.v1.Probe; /** Resources resize policy for the container. */ resizePolicy?: io.k8s.api.core.v1.ContainerResizePolicy[]; /** Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. */ resources?: io.k8s.api.core.v1.ResourceRequirements; /** Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers. */ restartPolicy?: string; /** Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. */ securityContext?: io.k8s.api.core.v1.SecurityContext; /** Probes are not allowed for ephemeral containers. */ startupProbe?: io.k8s.api.core.v1.Probe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** * If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. * * The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined. */ targetContainerName?: string; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: io.k8s.api.core.v1.VolumeDevice[]; /** Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated. */ volumeMounts?: io.k8s.api.core.v1.VolumeMount[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** Represents an ephemeral volume that is handled by a normal storage driver. */ interface EphemeralVolumeSource { /** * Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). * * An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. * * This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. * * Required, must not be nil. */ volumeClaimTemplate?: io.k8s.api.core.v1.PersistentVolumeClaimTemplate; } /** Event is a report of an event somewhere in the cluster. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. */ interface Event { /** What action was taken/failed regarding to the Regarding object. */ action?: string; /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** * The number of times this event has occurred. * @format int32 */ count?: number; /** Time when this Event was first observed. */ eventTime?: io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime; /** The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) */ firstTimestamp?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** The object that this event is about. */ involvedObject: io.k8s.api.core.v1.ObjectReference; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** The time at which the most recent occurrence of this event was recorded. */ lastTimestamp?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** A human-readable description of the status of this operation. */ message?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** This should be a short, machine understandable string that gives the reason for the transition into the object's current status. */ reason?: string; /** Optional secondary object for more complex actions. */ related?: io.k8s.api.core.v1.ObjectReference; /** Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. */ reportingComponent?: string; /** ID of the controller instance, e.g. `kubelet-xyzf`. */ reportingInstance?: string; /** Data about the Event series this event represents or nil if it's a singleton Event. */ series?: io.k8s.api.core.v1.EventSeries; /** The component reporting this event. Should be a short machine understandable string. */ source?: io.k8s.api.core.v1.EventSource; /** Type of this event (Normal, Warning), new types could be added in the future */ type?: string; } /** EventList is a list of events. */ interface EventList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of events */ items: io.k8s.api.core.v1.Event[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. */ interface EventSeries { /** * Number of occurrences in this series up to the last heartbeat time * @format int32 */ count?: number; /** Time of the last occurrence observed */ lastObservedTime?: io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime; } /** EventSource contains information for an event. */ interface EventSource { /** Component from which the event is generated. */ component?: string; /** Node name on which the event is generated. */ host?: string; } /** ExecAction describes a "run in container" action. */ interface ExecAction { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling. */ interface FCVolumeSource { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** * lun is Optional: FC target lun number * @format int32 */ lun?: number; /** readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** targetWWNs is Optional: FC target worldwide names (WWNs) */ targetWWNs?: string[]; /** wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. */ wwids?: string[]; } /** FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin. */ interface FlexPersistentVolumeSource { /** driver is the name of the driver to use for this volume. */ driver: string; /** fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. */ fsType?: string; /** options is Optional: this field holds extra command options if any. */ options?: Record; /** readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef is Optional: SecretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. */ secretRef?: io.k8s.api.core.v1.SecretReference; } /** FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. */ interface FlexVolumeSource { /** driver is the name of the driver to use for this volume. */ driver: string; /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. */ fsType?: string; /** options is Optional: this field holds extra command options if any. */ options?: Record; /** readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. */ secretRef?: io.k8s.api.core.v1.LocalObjectReference; } /** Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling. */ interface FlockerVolumeSource { /** datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated */ datasetName?: string; /** datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset */ datasetUUID?: string; } /** * Represents a Persistent Disk resource in Google Compute Engine. * * A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. */ interface GCEPersistentDiskVolumeSource { /** fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ fsType?: string; /** * partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk * @format int32 */ partition?: number; /** pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ pdName: string; /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ readOnly?: boolean; } /** */ interface GRPCAction { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ interface GitRepoVolumeSource { /** directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */ directory?: string; /** repository is the URL */ repository: string; /** revision is the commit hash for the specified revision. */ revision?: string; } /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ interface GlusterfsPersistentVolumeSource { /** endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ endpoints: string; /** endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ endpointsNamespace?: string; /** path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ path: string; /** readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ readOnly?: boolean; } /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ interface GlusterfsVolumeSource { /** endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ endpoints: string; /** path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ path: string; /** readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ readOnly?: boolean; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface HTTPGetAction { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: io.k8s.api.core.v1.HTTPHeader[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: io.k8s.apimachinery.pkg.util.intstr.IntOrString; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface HTTPHeader { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. */ interface HostAlias { /** Hostnames for the above IP address. */ hostnames?: string[]; /** IP address of the host file entry. */ ip?: string; } /** HostIP represents a single IP address allocated to the host. */ interface HostIP { /** IP is the IP address assigned to the host */ ip?: string; } /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ interface HostPathVolumeSource { /** path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ path: string; /** type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ type?: string; } /** ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. */ interface ISCSIPersistentVolumeSource { /** chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication */ chapAuthDiscovery?: boolean; /** chapAuthSession defines whether support iSCSI Session CHAP authentication */ chapAuthSession?: boolean; /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi */ fsType?: string; /** initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. */ initiatorName?: string; /** iqn is Target iSCSI Qualified Name. */ iqn: string; /** iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). */ iscsiInterface?: string; /** * lun is iSCSI Target Lun number. * @format int32 */ lun: number; /** portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). */ portals?: string[]; /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. */ readOnly?: boolean; /** secretRef is the CHAP Secret for iSCSI target and initiator authentication */ secretRef?: io.k8s.api.core.v1.SecretReference; /** targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). */ targetPortal: string; } /** Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling. */ interface ISCSIVolumeSource { /** chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication */ chapAuthDiscovery?: boolean; /** chapAuthSession defines whether support iSCSI Session CHAP authentication */ chapAuthSession?: boolean; /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi */ fsType?: string; /** initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. */ initiatorName?: string; /** iqn is the target iSCSI Qualified Name. */ iqn: string; /** iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). */ iscsiInterface?: string; /** * lun represents iSCSI Target Lun number. * @format int32 */ lun: number; /** portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). */ portals?: string[]; /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. */ readOnly?: boolean; /** secretRef is the CHAP Secret for iSCSI target and initiator authentication */ secretRef?: io.k8s.api.core.v1.LocalObjectReference; /** targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). */ targetPortal: string; } /** Maps a string key to a path within a volume. */ interface KeyToPath { /** key is the key to project. */ key: string; /** * mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface Lifecycle { /** PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ postStart?: io.k8s.api.core.v1.LifecycleHandler; /** PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ preStop?: io.k8s.api.core.v1.LifecycleHandler; } /** LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified. */ interface LifecycleHandler { /** Exec specifies the action to take. */ exec?: io.k8s.api.core.v1.ExecAction; /** HTTPGet specifies the http request to perform. */ httpGet?: io.k8s.api.core.v1.HTTPGetAction; /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ tcpSocket?: io.k8s.api.core.v1.TCPSocketAction; } /** LimitRange sets resource usage limits for each kind of resource in a Namespace. */ interface LimitRange { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.core.v1.LimitRangeSpec; } /** LimitRangeItem defines a min/max usage limit for any resource that matches on kind. */ interface LimitRangeItem { /** Default resource requirement limit value by resource name if resource limit is omitted. */ default?: Record; /** DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. */ defaultRequest?: Record; /** Max usage constraints on this kind by resource name. */ max?: Record; /** MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. */ maxLimitRequestRatio?: Record; /** Min usage constraints on this kind by resource name. */ min?: Record; /** Type of resource that this limit applies to. */ type: string; } /** LimitRangeList is a list of LimitRange items. */ interface LimitRangeList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ items: io.k8s.api.core.v1.LimitRange[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** LimitRangeSpec defines a min/max usage limit for resources that match on kind. */ interface LimitRangeSpec { /** Limits is the list of LimitRangeItem objects that are enforced. */ limits: io.k8s.api.core.v1.LimitRangeItem[]; } /** LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point. */ interface LoadBalancerIngress { /** Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers) */ hostname?: string; /** IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers) */ ip?: string; /** Ports is a list of records of service ports If used, every port defined in the service should have an entry in it */ ports?: io.k8s.api.core.v1.PortStatus[]; } /** LoadBalancerStatus represents the status of a load-balancer. */ interface LoadBalancerStatus { /** Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points. */ ingress?: io.k8s.api.core.v1.LoadBalancerIngress[]; } /** LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. */ interface LocalObjectReference { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; } /** Local represents directly-attached storage with node affinity (Beta feature) */ interface LocalVolumeSource { /** fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a filesystem if unspecified. */ fsType?: string; /** path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...). */ path: string; } /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ interface NFSVolumeSource { /** path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ path: string; /** readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ readOnly?: boolean; /** server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ server: string; } /** Namespace provides a scope for Names. Use of multiple namespaces is optional. */ interface Namespace { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.core.v1.NamespaceSpec; /** Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.core.v1.NamespaceStatus; } /** NamespaceCondition contains details about state of namespace. */ interface NamespaceCondition { /** */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** */ message?: string; /** */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of namespace controller condition. */ type: string; } /** NamespaceList is a list of Namespaces. */ interface NamespaceList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */ items: io.k8s.api.core.v1.Namespace[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** NamespaceSpec describes the attributes on a Namespace. */ interface NamespaceSpec { /** Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ */ finalizers?: string[]; } /** NamespaceStatus is information about the current status of a Namespace. */ interface NamespaceStatus { /** Represents the latest available observations of a namespace's current state. */ conditions?: io.k8s.api.core.v1.NamespaceCondition[]; /** Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ */ phase?: string; } /** Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd). */ interface Node { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.core.v1.NodeSpec; /** Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.core.v1.NodeStatus; } /** NodeAddress contains information for the node's address. */ interface NodeAddress { /** The node address. */ address: string; /** Node address type, one of Hostname, ExternalIP or InternalIP. */ type: string; } /** Node affinity is a group of node affinity scheduling rules. */ interface NodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: io.k8s.api.core.v1.PreferredSchedulingTerm[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ requiredDuringSchedulingIgnoredDuringExecution?: io.k8s.api.core.v1.NodeSelector; } /** NodeCondition contains condition information for a node. */ interface NodeCondition { /** Last time we got an update on a given condition. */ lastHeartbeatTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Last time the condition transit from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Human readable message indicating details about last transition. */ message?: string; /** (brief) reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of node condition. */ type: string; } /** NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22 */ interface NodeConfigSource { /** ConfigMap is a reference to a Node's ConfigMap */ configMap?: io.k8s.api.core.v1.ConfigMapNodeConfigSource; } /** NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource. */ interface NodeConfigStatus { /** Active reports the checkpointed config the node is actively using. Active will represent either the current version of the Assigned config, or the current LastKnownGood config, depending on whether attempting to use the Assigned config results in an error. */ active?: io.k8s.api.core.v1.NodeConfigSource; /** Assigned reports the checkpointed config the node will try to use. When Node.Spec.ConfigSource is updated, the node checkpoints the associated config payload to local disk, along with a record indicating intended config. The node refers to this record to choose its config checkpoint, and reports this record in Assigned. Assigned only updates in the status after the record has been checkpointed to disk. When the Kubelet is restarted, it tries to make the Assigned config the Active config by loading and validating the checkpointed payload identified by Assigned. */ assigned?: io.k8s.api.core.v1.NodeConfigSource; /** Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting to load or validate the Assigned config, etc. Errors may occur at different points while syncing config. Earlier errors (e.g. download or checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error by fixing the config assigned in Spec.ConfigSource. You can find additional information for debugging by searching the error message in the Kubelet log. Error is a human-readable description of the error state; machines can check whether or not Error is empty, but should not rely on the stability of the Error text across Kubelet versions. */ error?: string; /** LastKnownGood reports the checkpointed config the node will fall back to when it encounters an error attempting to use the Assigned config. The Assigned config becomes the LastKnownGood config when the node determines that the Assigned config is stable and correct. This is currently implemented as a 10-minute soak period starting when the local record of Assigned config is updated. If the Assigned config is Active at the end of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, because the local default config is always assumed good. You should not make assumptions about the node's method of determining config stability and correctness, as this may change or become configurable in the future. */ lastKnownGood?: io.k8s.api.core.v1.NodeConfigSource; } /** NodeDaemonEndpoints lists ports opened by daemons running on the Node. */ interface NodeDaemonEndpoints { /** Endpoint on which Kubelet is listening. */ kubeletEndpoint?: io.k8s.api.core.v1.DaemonEndpoint; } /** NodeList is the whole list of all Nodes which have been registered with master. */ interface NodeList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of nodes */ items: io.k8s.api.core.v1.Node[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface NodeSelector { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: io.k8s.api.core.v1.NodeSelectorTerm[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface NodeSelectorRequirement { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface NodeSelectorTerm { /** A list of node selector requirements by node's labels. */ matchExpressions?: io.k8s.api.core.v1.NodeSelectorRequirement[]; /** A list of node selector requirements by node's fields. */ matchFields?: io.k8s.api.core.v1.NodeSelectorRequirement[]; } /** NodeSpec describes the attributes that a node is created with. */ interface NodeSpec { /** Deprecated: Previously used to specify the source of the node's configuration for the DynamicKubeletConfig feature. This feature is removed. */ configSource?: io.k8s.api.core.v1.NodeConfigSource; /** Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 */ externalID?: string; /** PodCIDR represents the pod IP range assigned to the node. */ podCIDR?: string; /** podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. */ podCIDRs?: string[]; /** ID of the node assigned by the cloud provider in the format: :// */ providerID?: string; /** If specified, the node's taints. */ taints?: io.k8s.api.core.v1.Taint[]; /** Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration */ unschedulable?: boolean; } /** NodeStatus is information about the current status of a node. */ interface NodeStatus { /** List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See https://pr.k8s.io/79391 for an example. Consumers should assume that addresses can change during the lifetime of a Node. However, there are some exceptions where this may not be possible, such as Pods that inherit a Node's address in its own status or consumers of the downward API (status.hostIP). */ addresses?: io.k8s.api.core.v1.NodeAddress[]; /** Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. */ allocatable?: Record; /** Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity */ capacity?: Record; /** Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition */ conditions?: io.k8s.api.core.v1.NodeCondition[]; /** Status of the config assigned to the node via the dynamic Kubelet config feature. */ config?: io.k8s.api.core.v1.NodeConfigStatus; /** Endpoints of daemons running on the Node. */ daemonEndpoints?: io.k8s.api.core.v1.NodeDaemonEndpoints; /** List of container images on this node */ images?: io.k8s.api.core.v1.ContainerImage[]; /** Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info */ nodeInfo?: io.k8s.api.core.v1.NodeSystemInfo; /** NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated. */ phase?: string; /** List of volumes that are attached to the node. */ volumesAttached?: io.k8s.api.core.v1.AttachedVolume[]; /** List of attachable volumes in use (mounted) by the node. */ volumesInUse?: string[]; } /** NodeSystemInfo is a set of ids/uuids to uniquely identify the node. */ interface NodeSystemInfo { /** The Architecture reported by the node */ architecture: string; /** Boot ID reported by the node. */ bootID: string; /** ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2). */ containerRuntimeVersion: string; /** Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). */ kernelVersion: string; /** KubeProxy Version reported by the node. */ kubeProxyVersion: string; /** Kubelet Version reported by the node. */ kubeletVersion: string; /** MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html */ machineID: string; /** The Operating System reported by the node */ operatingSystem: string; /** OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). */ osImage: string; /** SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html/rhsm/uuid */ systemUUID: string; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface ObjectFieldSelector { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ObjectReference contains enough information to let you inspect or modify the referred object. */ interface ObjectReference { /** API version of the referent. */ apiVersion?: string; /** If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. */ fieldPath?: string; /** Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ */ namespace?: string; /** Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency */ resourceVersion?: string; /** UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids */ uid?: string; } /** PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes */ interface PersistentVolume { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes */ spec?: io.k8s.api.core.v1.PersistentVolumeSpec; /** status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes */ status?: io.k8s.api.core.v1.PersistentVolumeStatus; } /** PersistentVolumeClaim is a user's request for and claim to a persistent volume */ interface PersistentVolumeClaim { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */ spec?: io.k8s.api.core.v1.PersistentVolumeClaimSpec; /** status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */ status?: io.k8s.api.core.v1.PersistentVolumeClaimStatus; } /** PersistentVolumeClaimCondition contains details about state of pvc */ interface PersistentVolumeClaimCondition { /** lastProbeTime is the time we probed the condition. */ lastProbeTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** lastTransitionTime is the time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** message is the human-readable message indicating details about last transition. */ message?: string; /** reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "ResizeStarted" that means the underlying persistent volume is being resized. */ reason?: string; /** */ status: string; /** */ type: string; } /** PersistentVolumeClaimList is a list of PersistentVolumeClaim items. */ interface PersistentVolumeClaimList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is a list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */ items: io.k8s.api.core.v1.PersistentVolumeClaim[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes */ interface PersistentVolumeClaimSpec { /** accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 */ accessModes?: string[]; /** dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. */ dataSource?: io.k8s.api.core.v1.TypedLocalObjectReference; /** * dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef * allows any non-core object, as well as PersistentVolumeClaim objects. * * While dataSource ignores disallowed values (dropping them), dataSourceRef * preserves all values, and generates an error if a disallowed value is * specified. * * While dataSource only allows local objects, dataSourceRef allows objects * in any namespaces. * (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. */ dataSourceRef?: io.k8s.api.core.v1.TypedObjectReference; /** resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources */ resources?: io.k8s.api.core.v1.ResourceRequirements; /** selector is a label query over volumes to consider for binding. */ selector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 */ storageClassName?: string; /** volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. */ volumeMode?: string; /** volumeName is the binding reference to the PersistentVolume backing this claim. */ volumeName?: string; } /** PersistentVolumeClaimStatus is the current status of a persistent volume claim. */ interface PersistentVolumeClaimStatus { /** accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 */ accessModes?: string[]; /** * allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * * Un-prefixed keys: * - storage - the capacity of the volume. * * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" * Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. * * ClaimResourceStatus can be in any of following states: * - ControllerResizeInProgress: * State set when resize controller starts resizing the volume in control-plane. * - ControllerResizeFailed: * State set when resize has failed in resize controller with a terminal error. * - NodeResizePending: * State set when resize controller has finished resizing the volume but further resizing of * volume is needed on the node. * - NodeResizeInProgress: * State set when kubelet starts resizing the volume. * - NodeResizeFailed: * State set when resizing has failed in kubelet with a terminal error. Transient errors don't set * NodeResizeFailed. * For example: if expanding a PVC for more capacity - this field can be one of the following states: * - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress" * - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed" * - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending" * - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress" * - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed" * When this field is not set, it means that no resize operation is in progress for the given PVC. * * A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. * * This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature. */ allocatedResourceStatuses?: Record; /** * allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * * Un-prefixed keys: * - storage - the capacity of the volume. * * Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource" * Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used. * * Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity. * * A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC. * * This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature. */ allocatedResources?: Record; /** capacity represents the actual resources of the underlying volume. */ capacity?: Record; /** conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. */ conditions?: io.k8s.api.core.v1.PersistentVolumeClaimCondition[]; /** phase represents the current phase of PersistentVolumeClaim. */ phase?: string; } /** PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource. */ interface PersistentVolumeClaimTemplate { /** May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. */ spec: io.k8s.api.core.v1.PersistentVolumeClaimSpec; } /** PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system). */ interface PersistentVolumeClaimVolumeSource { /** claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */ claimName: string; /** readOnly Will force the ReadOnly setting in VolumeMounts. Default false. */ readOnly?: boolean; } /** PersistentVolumeList is a list of PersistentVolume items. */ interface PersistentVolumeList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is a list of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes */ items: io.k8s.api.core.v1.PersistentVolume[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PersistentVolumeSpec is the specification of a persistent volume. */ interface PersistentVolumeSpec { /** accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes */ accessModes?: string[]; /** awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ awsElasticBlockStore?: io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource; /** azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. */ azureDisk?: io.k8s.api.core.v1.AzureDiskVolumeSource; /** azureFile represents an Azure File Service mount on the host and bind mount to the pod. */ azureFile?: io.k8s.api.core.v1.AzureFilePersistentVolumeSource; /** capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity */ capacity?: Record; /** cephFS represents a Ceph FS mount on the host that shares a pod's lifetime */ cephfs?: io.k8s.api.core.v1.CephFSPersistentVolumeSource; /** cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ cinder?: io.k8s.api.core.v1.CinderPersistentVolumeSource; /** claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding */ claimRef?: io.k8s.api.core.v1.ObjectReference; /** csi represents storage that is handled by an external CSI driver (Beta feature). */ csi?: io.k8s.api.core.v1.CSIPersistentVolumeSource; /** fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. */ fc?: io.k8s.api.core.v1.FCVolumeSource; /** flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. */ flexVolume?: io.k8s.api.core.v1.FlexPersistentVolumeSource; /** flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running */ flocker?: io.k8s.api.core.v1.FlockerVolumeSource; /** gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ gcePersistentDisk?: io.k8s.api.core.v1.GCEPersistentDiskVolumeSource; /** glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md */ glusterfs?: io.k8s.api.core.v1.GlusterfsPersistentVolumeSource; /** hostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ hostPath?: io.k8s.api.core.v1.HostPathVolumeSource; /** iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. */ iscsi?: io.k8s.api.core.v1.ISCSIPersistentVolumeSource; /** local represents directly-attached storage with node affinity */ local?: io.k8s.api.core.v1.LocalVolumeSource; /** mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options */ mountOptions?: string[]; /** nfs represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ nfs?: io.k8s.api.core.v1.NFSVolumeSource; /** nodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. */ nodeAffinity?: io.k8s.api.core.v1.VolumeNodeAffinity; /** persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming */ persistentVolumeReclaimPolicy?: string; /** photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine */ photonPersistentDisk?: io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource; /** portworxVolume represents a portworx volume attached and mounted on kubelets host machine */ portworxVolume?: io.k8s.api.core.v1.PortworxVolumeSource; /** quobyte represents a Quobyte mount on the host that shares a pod's lifetime */ quobyte?: io.k8s.api.core.v1.QuobyteVolumeSource; /** rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md */ rbd?: io.k8s.api.core.v1.RBDPersistentVolumeSource; /** scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. */ scaleIO?: io.k8s.api.core.v1.ScaleIOPersistentVolumeSource; /** storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. */ storageClassName?: string; /** storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md */ storageos?: io.k8s.api.core.v1.StorageOSPersistentVolumeSource; /** volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. */ volumeMode?: string; /** vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine */ vsphereVolume?: io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource; } /** PersistentVolumeStatus is the current status of a persistent volume. */ interface PersistentVolumeStatus { /** lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions. This is an alpha field and requires enabling PersistentVolumeLastPhaseTransitionTime feature. */ lastPhaseTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** message is a human-readable message indicating details about why the volume is in this state. */ message?: string; /** phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase */ phase?: string; /** reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. */ reason?: string; } /** Represents a Photon Controller persistent disk resource. */ interface PhotonPersistentDiskVolumeSource { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** pdID is the ID that identifies Photon Controller persistent disk */ pdID: string; } /** Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts. */ interface Pod { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.core.v1.PodSpec; /** Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.core.v1.PodStatus; } /** Pod affinity is a group of inter pod affinity scheduling rules. */ interface PodAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: io.k8s.api.core.v1.WeightedPodAffinityTerm[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: io.k8s.api.core.v1.PodAffinityTerm[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface PodAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** Pod anti affinity is a group of inter pod anti affinity scheduling rules. */ interface PodAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: io.k8s.api.core.v1.WeightedPodAffinityTerm[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: io.k8s.api.core.v1.PodAffinityTerm[]; } /** PodCondition contains details for the current condition of this pod. */ interface PodCondition { /** Last time we probed the condition. */ lastProbeTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Human-readable message indicating details about last transition. */ message?: string; /** Unique, one-word, CamelCase reason for the condition's last transition. */ reason?: string; /** Status is the status of the condition. Can be True, False, Unknown. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions */ status: string; /** Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions */ type: string; } /** PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy. */ interface PodDNSConfig { /** A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. */ nameservers?: string[]; /** A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. */ options?: io.k8s.api.core.v1.PodDNSConfigOption[]; /** A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. */ searches?: string[]; } /** PodDNSConfigOption defines DNS resolver options of a pod. */ interface PodDNSConfigOption { /** Required. */ name?: string; /** */ value?: string; } /** PodIP represents a single IP address allocated to the pod. */ interface PodIP { /** IP is the IP address assigned to the pod */ ip?: string; } /** PodList is a list of Pods. */ interface PodList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md */ items: io.k8s.api.core.v1.Pod[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PodOS defines the OS parameters of a pod. */ interface PodOS { /** Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null */ name: string; } /** PodReadinessGate contains the reference to a pod condition */ interface PodReadinessGate { /** ConditionType refers to a condition in the pod's condition list with matching type. */ conditionType: string; } /** PodResourceClaim references exactly one ResourceClaim through a ClaimSource. It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name. */ interface PodResourceClaim { /** Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL. */ name: string; /** Source describes where to find the ResourceClaim. */ source?: io.k8s.api.core.v1.ClaimSource; } /** PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim which references a ResourceClaimTemplate. It stores the generated name for the corresponding ResourceClaim. */ interface PodResourceClaimStatus { /** Name uniquely identifies this resource claim inside the pod. This must match the name of an entry in pod.spec.resourceClaims, which implies that the string must be a DNS_LABEL. */ name: string; /** ResourceClaimName is the name of the ResourceClaim that was generated for the Pod in the namespace of the Pod. It this is unset, then generating a ResourceClaim was not necessary. The pod.spec.resourceClaims entry can be ignored in this case. */ resourceClaimName?: string; } /** PodSchedulingGate is associated to a Pod to guard its scheduling. */ interface PodSchedulingGate { /** Name of the scheduling gate. Each scheduling gate must have a unique name field. */ name: string; } /** PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext. */ interface PodSecurityContext { /** * A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: * * 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- * * If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ fsGroup?: number; /** fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows. */ fsGroupChangePolicy?: string; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsUser?: number; /** The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. */ seLinuxOptions?: io.k8s.api.core.v1.SELinuxOptions; /** The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. */ seccompProfile?: io.k8s.api.core.v1.SeccompProfile; /** A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows. */ supplementalGroups?: number[]; /** Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. */ sysctls?: io.k8s.api.core.v1.Sysctl[]; /** The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ windowsOptions?: io.k8s.api.core.v1.WindowsSecurityContextOptions; } /** PodSpec is a description of a pod. */ interface PodSpec { /** * Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. * @format int64 */ activeDeadlineSeconds?: number; /** If specified, the pod's scheduling constraints */ affinity?: io.k8s.api.core.v1.Affinity; /** AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. */ automountServiceAccountToken?: boolean; /** List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. */ containers: io.k8s.api.core.v1.Container[]; /** Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. */ dnsConfig?: io.k8s.api.core.v1.PodDNSConfig; /** Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. */ dnsPolicy?: string; /** EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. */ enableServiceLinks?: boolean; /** List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. */ ephemeralContainers?: io.k8s.api.core.v1.EphemeralContainer[]; /** HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. */ hostAliases?: io.k8s.api.core.v1.HostAlias[]; /** Use the host's ipc namespace. Optional: Default to false. */ hostIPC?: boolean; /** Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. */ hostNetwork?: boolean; /** Use the host's pid namespace. Optional: Default to false. */ hostPID?: boolean; /** Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature. */ hostUsers?: boolean; /** Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. */ hostname?: string; /** ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod */ imagePullSecrets?: io.k8s.api.core.v1.LocalObjectReference[]; /** 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 or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ */ initContainers?: io.k8s.api.core.v1.Container[]; /** NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. */ nodeName?: string; /** NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ */ nodeSelector?: Record; /** * Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. * * If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions * * If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup */ os?: io.k8s.api.core.v1.PodOS; /** Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md */ overhead?: Record; /** PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. */ preemptionPolicy?: string; /** * The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. * @format int32 */ priority?: number; /** If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. */ priorityClassName?: string; /** If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates */ readinessGates?: io.k8s.api.core.v1.PodReadinessGate[]; /** * ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. * * This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. * * This field is immutable. */ resourceClaims?: io.k8s.api.core.v1.PodResourceClaim[]; /** Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy */ restartPolicy?: string; /** RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class */ runtimeClassName?: string; /** If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. */ schedulerName?: string; /** * SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. * * SchedulingGates can only be set at pod creation time, and be removed only afterwards. * * This is a beta feature enabled by the PodSchedulingReadiness feature gate. */ schedulingGates?: io.k8s.api.core.v1.PodSchedulingGate[]; /** SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. */ securityContext?: io.k8s.api.core.v1.PodSecurityContext; /** DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. */ serviceAccount?: string; /** ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ */ serviceAccountName?: string; /** If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. */ setHostnameAsFQDN?: boolean; /** Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. */ shareProcessNamespace?: boolean; /** If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. */ subdomain?: string; /** * Optional duration in seconds the pod 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 pod 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 30 seconds. * @format int64 */ terminationGracePeriodSeconds?: number; /** If specified, the pod's tolerations. */ tolerations?: io.k8s.api.core.v1.Toleration[]; /** TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. */ topologySpreadConstraints?: io.k8s.api.core.v1.TopologySpreadConstraint[]; /** List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes */ volumes?: io.k8s.api.core.v1.Volume[]; } /** PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane. */ interface PodStatus { /** Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions */ conditions?: io.k8s.api.core.v1.PodCondition[]; /** The list has one entry per container in the manifest. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status */ containerStatuses?: io.k8s.api.core.v1.ContainerStatus[]; /** Status for any ephemeral containers that have run in this pod. */ ephemeralContainerStatuses?: io.k8s.api.core.v1.ContainerStatus[]; /** hostIP holds the IP address of the host to which the pod is assigned. Empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns mean that HostIP will not be updated even if there is a node is assigned to pod */ hostIP?: string; /** hostIPs holds the IP addresses allocated to the host. If this field is specified, the first entry must match the hostIP field. This list is empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns means that HostIPs will not be updated even if there is a node is assigned to this pod. */ hostIPs?: io.k8s.api.core.v1.HostIP[]; /** The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status */ initContainerStatuses?: io.k8s.api.core.v1.ContainerStatus[]; /** A human readable message indicating details about why the pod is in this condition. */ message?: string; /** nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled. */ nominatedNodeName?: string; /** * The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: * * Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. * * More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase */ phase?: string; /** podIP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. */ podIP?: string; /** podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet. */ podIPs?: io.k8s.api.core.v1.PodIP[]; /** The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#quality-of-service-classes */ qosClass?: string; /** A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' */ reason?: string; /** Status of resources resize desired for pod's containers. It is empty if no resources resize is pending. Any changes to container resources will automatically set this to "Proposed" */ resize?: string; /** Status of resource claims. */ resourceClaimStatuses?: io.k8s.api.core.v1.PodResourceClaimStatus[]; /** RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. */ startTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; } /** PodTemplate describes a template for creating copies of a predefined pod. */ interface PodTemplate { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ template?: io.k8s.api.core.v1.PodTemplateSpec; } /** PodTemplateList is a list of PodTemplates. */ interface PodTemplateList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of pod templates */ items: io.k8s.api.core.v1.PodTemplate[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PodTemplateSpec describes the data a pod should have when created from a template */ interface PodTemplateSpec { /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.core.v1.PodSpec; } /** */ interface PortStatus { /** * Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use * CamelCase names * - cloud provider specific error values must have names that comply with the * format foo.example.com/CamelCase. */ error?: string; /** * Port is the port number of the service port of which status is recorded here * @format int32 */ port: number; /** Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP" */ protocol: string; } /** PortworxVolumeSource represents a Portworx volume resource. */ interface PortworxVolumeSource { /** fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** volumeID uniquely identifies a Portworx volume */ volumeID: string; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface PreferredSchedulingTerm { /** A node selector term, associated with the corresponding weight. */ preference: io.k8s.api.core.v1.NodeSelectorTerm; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface Probe { /** Exec specifies the action to take. */ exec?: io.k8s.api.core.v1.ExecAction; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: io.k8s.api.core.v1.GRPCAction; /** HTTPGet specifies the http request to perform. */ httpGet?: io.k8s.api.core.v1.HTTPGetAction; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: io.k8s.api.core.v1.TCPSocketAction; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Represents a projected volume source */ interface ProjectedVolumeSource { /** * defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** sources is the list of volume projections */ sources?: io.k8s.api.core.v1.VolumeProjection[]; } /** Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling. */ interface QuobyteVolumeSource { /** group to map volume access to Default is no group */ group?: string; /** readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. */ readOnly?: boolean; /** registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes */ registry: string; /** tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin */ tenant?: string; /** user to map volume access to Defaults to serivceaccount user */ user?: string; /** volume is a string that references an already created Quobyte volume by name. */ volume: string; } /** Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. */ interface RBDPersistentVolumeSource { /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd */ fsType?: string; /** image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ image: string; /** keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ keyring?: string; /** monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ monitors: string[]; /** pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ pool?: string; /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ readOnly?: boolean; /** secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ secretRef?: io.k8s.api.core.v1.SecretReference; /** user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ user?: string; } /** Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling. */ interface RBDVolumeSource { /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd */ fsType?: string; /** image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ image: string; /** keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ keyring?: string; /** monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ monitors: string[]; /** pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ pool?: string; /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ readOnly?: boolean; /** secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ secretRef?: io.k8s.api.core.v1.LocalObjectReference; /** user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ user?: string; } /** ReplicationController represents the configuration of a replication controller. */ interface ReplicationController { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.core.v1.ReplicationControllerSpec; /** Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.core.v1.ReplicationControllerStatus; } /** ReplicationControllerCondition describes the state of a replication controller at a certain point. */ interface ReplicationControllerCondition { /** The last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of replication controller condition. */ type: string; } /** ReplicationControllerList is a collection of replication controllers. */ interface ReplicationControllerList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller */ items: io.k8s.api.core.v1.ReplicationController[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ReplicationControllerSpec is the specification of a replication controller. */ interface ReplicationControllerSpec { /** * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) * @format int32 */ minReadySeconds?: number; /** * Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller * @format int32 */ replicas?: number; /** Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors */ selector?: Record; /** Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template */ template?: io.k8s.api.core.v1.PodTemplateSpec; } /** ReplicationControllerStatus represents the current status of a replication controller. */ interface ReplicationControllerStatus { /** * The number of available replicas (ready for at least minReadySeconds) for this replication controller. * @format int32 */ availableReplicas?: number; /** Represents the latest available observations of a replication controller's current state. */ conditions?: io.k8s.api.core.v1.ReplicationControllerCondition[]; /** * The number of pods that have labels matching the labels of the pod template of the replication controller. * @format int32 */ fullyLabeledReplicas?: number; /** * ObservedGeneration reflects the generation of the most recently observed replication controller. * @format int64 */ observedGeneration?: number; /** * The number of ready replicas for this replication controller. * @format int32 */ readyReplicas?: number; /** * Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller * @format int32 */ replicas: number; } /** ResourceClaim references one entry in PodSpec.ResourceClaims. */ interface ResourceClaim { /** Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. */ name: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface ResourceFieldSelector { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** Specifies the output format of the exposed resources, defaults to "1" */ divisor?: io.k8s.apimachinery.pkg.api.resource.Quantity; /** Required: resource to select */ resource: string; } /** ResourceQuota sets aggregate quota restrictions enforced per namespace */ interface ResourceQuota { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.core.v1.ResourceQuotaSpec; /** Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.core.v1.ResourceQuotaStatus; } /** ResourceQuotaList is a list of ResourceQuota items. */ interface ResourceQuotaList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ */ items: io.k8s.api.core.v1.ResourceQuota[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ResourceQuotaSpec defines the desired hard limits to enforce for Quota. */ interface ResourceQuotaSpec { /** hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ */ hard?: Record; /** scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. */ scopeSelector?: io.k8s.api.core.v1.ScopeSelector; /** A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. */ scopes?: string[]; } /** ResourceQuotaStatus defines the enforced hard limits and observed use. */ interface ResourceQuotaStatus { /** Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ */ hard?: Record; /** Used is the current observed total usage of the resource in the namespace. */ used?: Record; } /** ResourceRequirements describes the compute resource requirements. */ interface ResourceRequirements { /** * Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. * * This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. * * This field is immutable. It can only be set for containers. */ claims?: io.k8s.api.core.v1.ResourceClaim[]; /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SELinuxOptions are the labels to be applied to the container */ interface SELinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume */ interface ScaleIOPersistentVolumeSource { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs" */ fsType?: string; /** gateway is the host address of the ScaleIO API Gateway. */ gateway: string; /** protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. */ protectionDomain?: string; /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. */ secretRef: io.k8s.api.core.v1.SecretReference; /** sslEnabled is the flag to enable/disable SSL communication with Gateway, default false */ sslEnabled?: boolean; /** storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. */ storageMode?: string; /** storagePool is the ScaleIO Storage Pool associated with the protection domain. */ storagePool?: string; /** system is the name of the storage system as configured in ScaleIO. */ system: string; /** volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. */ volumeName?: string; } /** ScaleIOVolumeSource represents a persistent ScaleIO volume */ interface ScaleIOVolumeSource { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". */ fsType?: string; /** gateway is the host address of the ScaleIO API Gateway. */ gateway: string; /** protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. */ protectionDomain?: string; /** readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. */ secretRef: io.k8s.api.core.v1.LocalObjectReference; /** sslEnabled Flag enable/disable SSL communication with Gateway, default false */ sslEnabled?: boolean; /** storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. */ storageMode?: string; /** storagePool is the ScaleIO Storage Pool associated with the protection domain. */ storagePool?: string; /** system is the name of the storage system as configured in ScaleIO. */ system: string; /** volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. */ volumeName?: string; } /** A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements. */ interface ScopeSelector { /** A list of scope selector requirements by scope of the resources. */ matchExpressions?: io.k8s.api.core.v1.ScopedResourceSelectorRequirement[]; } /** A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values. */ interface ScopedResourceSelectorRequirement { /** Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. */ operator: string; /** The name of the scope that the selector applies to. */ scopeName: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SeccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. */ interface Secret { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 */ data?: Record; /** Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. */ immutable?: boolean; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write, overwriting any existing values. The stringData field is never output when reading from the API. */ stringData?: Record; /** Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types */ type?: string; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SecretEnvSource { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** SecretKeySelector selects a key of a Secret. */ interface SecretKeySelector { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** SecretList is a list of Secret. */ interface SecretList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret */ items: io.k8s.api.core.v1.Secret[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ interface SecretProjection { /** items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: io.k8s.api.core.v1.KeyToPath[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** optional field specify whether the Secret or its key must be defined */ optional?: boolean; } /** SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace */ interface SecretReference { /** name is unique within a namespace to reference a secret resource. */ name?: string; /** namespace defines the space within which the secret name must be unique. */ namespace?: string; } /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ interface SecretVolumeSource { /** * defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: io.k8s.api.core.v1.KeyToPath[]; /** optional field specify whether the Secret or its keys must be defined */ optional?: boolean; /** secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ secretName?: string; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SecurityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. */ allowPrivilegeEscalation?: boolean; /** The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. */ capabilities?: io.k8s.api.core.v1.Capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsUser?: number; /** The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */ seLinuxOptions?: io.k8s.api.core.v1.SELinuxOptions; /** The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. */ seccompProfile?: io.k8s.api.core.v1.SeccompProfile; /** The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ windowsOptions?: io.k8s.api.core.v1.WindowsSecurityContextOptions; } /** Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy. */ interface Service { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.core.v1.ServiceSpec; /** Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.core.v1.ServiceStatus; } /** ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets */ interface ServiceAccount { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. */ automountServiceAccountToken?: boolean; /** ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod */ imagePullSecrets?: io.k8s.api.core.v1.LocalObjectReference[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a "kubernetes.io/enforce-mountable-secrets" annotation set to "true". This field should not be used to find auto-generated service account token secrets for use outside of pods. Instead, tokens can be requested directly using the TokenRequest API, or service account token secrets can be manually created. More info: https://kubernetes.io/docs/concepts/configuration/secret */ secrets?: io.k8s.api.core.v1.ObjectReference[]; } /** ServiceAccountList is a list of ServiceAccount objects */ interface ServiceAccountList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ */ items: io.k8s.api.core.v1.ServiceAccount[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ interface ServiceAccountTokenProjection { /** audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. */ audience?: string; /** * expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. * @format int64 */ expirationSeconds?: number; /** path is the path relative to the mount point of the file to project the token into. */ path: string; } /** ServiceList holds a list of services. */ interface ServiceList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of services */ items: io.k8s.api.core.v1.Service[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ServicePort contains information on service's port. */ interface ServicePort { /** * The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * * * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * * * Kubernetes-defined prefixed names: * * 'kubernetes.io/h2c' - HTTP/2 over cleartext as described in https://www.rfc-editor.org/rfc/rfc7540 * * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * * * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. */ appProtocol?: string; /** The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. */ name?: string; /** * The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport * @format int32 */ nodePort?: number; /** * The port that will be exposed by this service. * @format int32 */ port: number; /** * The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. * @default TCP */ protocol?: string; /** Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service */ targetPort?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; } /** ServiceSpec describes the attributes that a user creates on a service. */ interface ServiceSpec { /** allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. */ allocateLoadBalancerNodePorts?: boolean; /** clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies */ clusterIP?: string; /** * ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. * * This field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies */ clusterIPs?: string[]; /** externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. */ externalIPs?: string[]; /** externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires `type` to be "ExternalName". */ externalName?: string; /** externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. */ externalTrafficPolicy?: string; /** * healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. * @format int32 */ healthCheckNodePort?: number; /** InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). */ internalTrafficPolicy?: string; /** * IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. * * This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. */ ipFamilies?: string[]; /** IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. */ ipFamilyPolicy?: string; /** loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. */ loadBalancerClass?: string; /** Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations. Using it is non-portable and it may not support dual-stack. Users are encouraged to use implementation-specific annotations when available. */ loadBalancerIP?: string; /** If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ */ loadBalancerSourceRanges?: string[]; /** The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies */ ports?: io.k8s.api.core.v1.ServicePort[]; /** publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. */ publishNotReadyAddresses?: boolean; /** Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ */ selector?: Record; /** Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies */ sessionAffinity?: string; /** sessionAffinityConfig contains the configurations of session affinity. */ sessionAffinityConfig?: io.k8s.api.core.v1.SessionAffinityConfig; /** type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types */ type?: string; } /** ServiceStatus represents the current status of a service. */ interface ServiceStatus { /** Current service state */ conditions?: io.k8s.apimachinery.pkg.apis.meta.v1.Condition[]; /** LoadBalancer contains the current status of the load-balancer, if one is present. */ loadBalancer?: io.k8s.api.core.v1.LoadBalancerStatus; } /** SessionAffinityConfig represents the configurations of session affinity. */ interface SessionAffinityConfig { /** clientIP contains the configurations of Client IP based session affinity. */ clientIP?: io.k8s.api.core.v1.ClientIPConfig; } /** Represents a StorageOS persistent volume resource. */ interface StorageOSPersistentVolumeSource { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. */ secretRef?: io.k8s.api.core.v1.ObjectReference; /** volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. */ volumeName?: string; /** volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. */ volumeNamespace?: string; } /** Represents a StorageOS persistent volume resource. */ interface StorageOSVolumeSource { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. */ secretRef?: io.k8s.api.core.v1.LocalObjectReference; /** volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. */ volumeName?: string; /** volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. */ volumeNamespace?: string; } /** Sysctl defines a kernel parameter to be set */ interface Sysctl { /** Name of a property to set */ name: string; /** Value of a property to set */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface TCPSocketAction { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: io.k8s.apimachinery.pkg.util.intstr.IntOrString; } /** The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint. */ interface Taint { /** Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute. */ effect: string; /** Required. The taint key to be applied to a node. */ key: string; /** TimeAdded represents the time at which the taint was added. It is only written for NoExecute taints. */ timeAdded?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** The taint value corresponding to the taint key. */ value?: string; } /** The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . */ interface Toleration { /** Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** TopologySpreadConstraint specifies how to spread matching pods among the given topology. */ interface TopologySpreadConstraint { /** LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. */ labelSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** * MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. * * This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). */ matchLabelKeys?: string[]; /** * MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. * @format int32 */ maxSkew: number; /** * MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. * * For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. * * This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default). * @format int32 */ minDomains?: number; /** * NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. * * If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeAffinityPolicy?: string; /** * NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. * * If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeTaintsPolicy?: string; /** TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. */ topologyKey: string; /** * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, * but giving higher precedence to topologies that would help reduce the * skew. * A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. */ whenUnsatisfiable: string; } /** TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace. */ interface TypedLocalObjectReference { /** APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** Kind is the type of resource being referenced */ kind: string; /** Name is the name of resource being referenced */ name: string; } /** */ interface TypedObjectReference { /** APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** Kind is the type of resource being referenced */ kind: string; /** Name is the name of resource being referenced */ name: string; /** Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. */ namespace?: string; } /** Volume represents a named volume in a pod that may be accessed by any container in the pod. */ interface Volume { /** awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ awsElasticBlockStore?: io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource; /** azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. */ azureDisk?: io.k8s.api.core.v1.AzureDiskVolumeSource; /** azureFile represents an Azure File Service mount on the host and bind mount to the pod. */ azureFile?: io.k8s.api.core.v1.AzureFileVolumeSource; /** cephFS represents a Ceph FS mount on the host that shares a pod's lifetime */ cephfs?: io.k8s.api.core.v1.CephFSVolumeSource; /** cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ cinder?: io.k8s.api.core.v1.CinderVolumeSource; /** configMap represents a configMap that should populate this volume */ configMap?: io.k8s.api.core.v1.ConfigMapVolumeSource; /** csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). */ csi?: io.k8s.api.core.v1.CSIVolumeSource; /** downwardAPI represents downward API about the pod that should populate this volume */ downwardAPI?: io.k8s.api.core.v1.DownwardAPIVolumeSource; /** emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ emptyDir?: io.k8s.api.core.v1.EmptyDirVolumeSource; /** * ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. * * Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity * tracking are needed, * c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through * a PersistentVolumeClaim (see EphemeralVolumeSource for more * information on the connection between this volume type * and PersistentVolumeClaim). * * Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. * * Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. * * A pod can use both types of ephemeral volumes and persistent volumes at the same time. */ ephemeral?: io.k8s.api.core.v1.EphemeralVolumeSource; /** fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. */ fc?: io.k8s.api.core.v1.FCVolumeSource; /** flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. */ flexVolume?: io.k8s.api.core.v1.FlexVolumeSource; /** flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running */ flocker?: io.k8s.api.core.v1.FlockerVolumeSource; /** gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ gcePersistentDisk?: io.k8s.api.core.v1.GCEPersistentDiskVolumeSource; /** gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ gitRepo?: io.k8s.api.core.v1.GitRepoVolumeSource; /** glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md */ glusterfs?: io.k8s.api.core.v1.GlusterfsVolumeSource; /** hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ hostPath?: io.k8s.api.core.v1.HostPathVolumeSource; /** iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md */ iscsi?: io.k8s.api.core.v1.ISCSIVolumeSource; /** name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; /** nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ nfs?: io.k8s.api.core.v1.NFSVolumeSource; /** persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */ persistentVolumeClaim?: io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource; /** photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine */ photonPersistentDisk?: io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource; /** portworxVolume represents a portworx volume attached and mounted on kubelets host machine */ portworxVolume?: io.k8s.api.core.v1.PortworxVolumeSource; /** projected items for all in one resources secrets, configmaps, and downward API */ projected?: io.k8s.api.core.v1.ProjectedVolumeSource; /** quobyte represents a Quobyte mount on the host that shares a pod's lifetime */ quobyte?: io.k8s.api.core.v1.QuobyteVolumeSource; /** rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md */ rbd?: io.k8s.api.core.v1.RBDVolumeSource; /** scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. */ scaleIO?: io.k8s.api.core.v1.ScaleIOVolumeSource; /** secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ secret?: io.k8s.api.core.v1.SecretVolumeSource; /** storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. */ storageos?: io.k8s.api.core.v1.StorageOSVolumeSource; /** vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine */ vsphereVolume?: io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface VolumeDevice { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface VolumeMount { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. */ interface VolumeNodeAffinity { /** required specifies hard node constraints that must be met. */ required?: io.k8s.api.core.v1.NodeSelector; } /** Projection that may be projected along with other supported volume types */ interface VolumeProjection { /** configMap information about the configMap data to project */ configMap?: io.k8s.api.core.v1.ConfigMapProjection; /** downwardAPI information about the downwardAPI data to project */ downwardAPI?: io.k8s.api.core.v1.DownwardAPIProjection; /** secret information about the secret data to project */ secret?: io.k8s.api.core.v1.SecretProjection; /** serviceAccountToken is information about the serviceAccountToken data to project */ serviceAccountToken?: io.k8s.api.core.v1.ServiceAccountTokenProjection; } /** Represents a vSphere volume resource. */ interface VsphereVirtualDiskVolumeSource { /** fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. */ storagePolicyID?: string; /** storagePolicyName is the storage Policy Based Management (SPBM) profile name. */ storagePolicyName?: string; /** volumePath is the path that identifies vSphere volume vmdk */ volumePath: string; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface WeightedPodAffinityTerm { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: io.k8s.api.core.v1.PodAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface WindowsSecurityContextOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future. */ interface TopologySelectorLabelRequirement { /** The label key that the selector applies to. */ key: string; /** An array of string values. One value must match the label to be selected. Each entry in Values is ORed. */ values: string[]; } /** A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future. */ interface TopologySelectorTerm { /** A list of topology selector requirements by labels. */ matchLabelExpressions?: io.k8s.api.core.v1.TopologySelectorLabelRequirement[]; } } export declare namespace io.k8s.api.policy.v1 { /** Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions. */ interface Eviction { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** DeleteOptions may be provided */ deleteOptions?: io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** ObjectMeta describes the pod that is being evicted. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; } /** PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods */ interface PodDisruptionBudget { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the PodDisruptionBudget. */ spec?: io.k8s.api.policy.v1.PodDisruptionBudgetSpec; /** Most recently observed status of the PodDisruptionBudget. */ status?: io.k8s.api.policy.v1.PodDisruptionBudgetStatus; } /** PodDisruptionBudgetList is a collection of PodDisruptionBudgets. */ interface PodDisruptionBudgetList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is a list of PodDisruptionBudgets */ items: io.k8s.api.policy.v1.PodDisruptionBudget[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PodDisruptionBudgetSpec is a description of a PodDisruptionBudget. */ interface PodDisruptionBudgetSpec { /** An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". */ maxUnavailable?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; /** An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". */ minAvailable?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; /** Label query over pods whose evictions are managed by the disruption budget. A null selector will match no pods, while an empty ({}) selector will select all pods within the namespace. */ selector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** * UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with type="Ready",status="True". * * Valid policies are IfHealthyBudget and AlwaysAllow. If no policy is specified, the default behavior will be used, which corresponds to the IfHealthyBudget policy. * * IfHealthyBudget policy means that running pods (status.phase="Running"), but not yet healthy can be evicted only if the guarded application is not disrupted (status.currentHealthy is at least equal to status.desiredHealthy). Healthy pods will be subject to the PDB for eviction. * * AlwaysAllow policy means that all running pods (status.phase="Running"), but not yet healthy are considered disrupted and can be evicted regardless of whether the criteria in a PDB is met. This means perspective running pods of a disrupted application might not get a chance to become healthy. Healthy pods will be subject to the PDB for eviction. * * Additional policies may be added in the future. Clients making eviction decisions should disallow eviction of unhealthy pods if they encounter an unrecognized policy in this field. * * This field is beta-level. The eviction API uses this field when the feature gate PDBUnhealthyPodEvictionPolicy is enabled (enabled by default). */ unhealthyPodEvictionPolicy?: string; } /** PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system. */ interface PodDisruptionBudgetStatus { /** * Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the future): - SyncFailed: The controller encountered an error and wasn't able to compute * the number of allowed disruptions. Therefore no disruptions are * allowed and the status of the condition will be False. * - InsufficientPods: The number of pods are either at or below the number * required by the PodDisruptionBudget. No disruptions are * allowed and the status of the condition will be False. * - SufficientPods: There are more pods than required by the PodDisruptionBudget. * The condition will be True, and the number of allowed * disruptions are provided by the disruptionsAllowed property. */ conditions?: io.k8s.apimachinery.pkg.apis.meta.v1.Condition[]; /** * current number of healthy pods * @format int32 */ currentHealthy: number; /** * minimum desired number of healthy pods * @format int32 */ desiredHealthy: number; /** DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions. */ disruptedPods?: Record; /** * Number of pod disruptions that are currently allowed. * @format int32 */ disruptionsAllowed: number; /** * total number of pods counted by this disruption budget * @format int32 */ expectedPods: number; /** * Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation. * @format int64 */ observedGeneration?: number; } } export declare namespace io.k8s.apimachinery.pkg.api.resource { /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ``` ::= * * (Note that may be empty, from the "" case in .) * * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * * ::= m | "" | k | M | G | T | P | E * * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * * ::= "e" | "E" ``` * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * * - No precision is lost - No fractional digits will be emitted - The exponent (or suffix) is as large as possible. * * The sign will be omitted unless the number is negative. * * Examples: * * - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ type Quantity = string | number; } export declare namespace io.k8s.apimachinery.pkg.apis.meta.v1 { /** APIResource specifies the name of a resource and whether it is namespaced. */ interface APIResource { /** categories is a list of the grouped resources this resource belongs to (e.g. 'all') */ categories?: string[]; /** group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale". */ group?: string; /** kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') */ kind: string; /** name is the plural name of the resource. */ name: string; /** namespaced indicates if a resource is namespaced or not. */ namespaced: boolean; /** shortNames is a list of suggested short names of the resource. */ shortNames?: string[]; /** singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface. */ singularName: string; /** The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates. */ storageVersionHash?: string; /** verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy) */ verbs: string[]; /** version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)". */ version?: string; } /** APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced. */ interface APIResourceList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** groupVersion is the group and version this APIResourceList is for. */ groupVersion: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** resources contains the name of the resources and if they are namespaced. */ resources: io.k8s.apimachinery.pkg.apis.meta.v1.APIResource[]; } /** Condition contains details for one aspect of the current state of this API Resource. */ interface Condition { /** lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. */ lastTransitionTime: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** message is a human readable message indicating details about the transition. This may be an empty string. */ message: string; /** * observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. * @format int64 */ observedGeneration?: number; /** reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. */ reason: string; /** status of the condition, one of True, False, Unknown. */ status: string; /** type of condition in CamelCase or in foo.example.com/CamelCase. */ type: string; } /** DeleteOptions may be provided when deleting an API object. */ interface DeleteOptions { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed */ dryRun?: string[]; /** * The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. * @format int64 */ gracePeriodSeconds?: number; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. */ orphanDependents?: boolean; /** Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. */ preconditions?: io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions; /** Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. */ propagationPolicy?: string; } /** * FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. * * Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. * * The exact format is defined in sigs.k8s.io/structured-merge-diff */ interface FieldsV1 { } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface LabelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface LabelSelectorRequirement { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. */ interface ListMeta { /** continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. */ continue?: string; /** * remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. * @format int64 */ remainingItemCount?: number; /** String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency */ resourceVersion?: string; /** Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. */ selfLink?: string; } /** ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. */ interface ManagedFieldsEntry { /** APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. */ apiVersion?: string; /** FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" */ fieldsType?: string; /** FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. */ fieldsV1?: io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1; /** Manager is an identifier of the workflow managing these fields. */ manager?: string; /** Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. */ operation?: string; /** Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. */ subresource?: string; /** Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. */ time?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; } /** * MicroTime is version of Time with microsecond level precision. * @format date-time */ type MicroTime = string; /** ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. */ interface ObjectMeta { /** Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations */ annotations?: Record; /** * CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. * * Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ creationTimestamp?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** * Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. * @format int64 */ deletionGracePeriodSeconds?: number; /** * DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. * * Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ deletionTimestamp?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. */ finalizers?: string[]; /** * GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. * * If this field is specified and the generated name exists, the server will return a 409. * * Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency */ generateName?: string; /** * A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. * @format int64 */ generation?: number; /** Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels */ labels?: Record; /** ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. */ managedFields?: io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry[]; /** Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names */ name?: string; /** * Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. * * Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces */ namespace?: string; /** List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. */ ownerReferences?: io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference[]; /** * An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. * * Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency */ resourceVersion?: string; /** Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. */ selfLink?: string; /** * UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. * * Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids */ uid?: string; } /** OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. */ interface OwnerReference { /** API version of the referent. */ apiVersion: string; /** If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. */ blockOwnerDeletion?: boolean; /** If true, this reference points to the managing controller. */ controller?: boolean; /** Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names */ name: string; /** UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids */ uid: string; } /** Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. */ interface Patch { } /** Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. */ interface Preconditions { /** Specifies the target ResourceVersion */ resourceVersion?: string; /** Specifies the target UID. */ uid?: string; } /** Status is a return value for calls that don't return other objects. */ interface Status { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** * Suggested HTTP return code for this status, 0 if not set. * @format int32 */ code?: number; /** Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type. */ details?: io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** A human-readable description of the status of this operation. */ message?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; /** A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it. */ reason?: string; /** Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: string; } /** StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered. */ interface StatusCause { /** * The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. * * Examples: * "name" - the field "name" on the current resource * "items[0].name" - the field "name" on the first array entry in "items" */ field?: string; /** A human-readable description of the cause of the error. This field may be presented as-is to a reader. */ message?: string; /** A machine-readable description of the cause of the error. If this value is empty there is no information available. */ reason?: string; } /** StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined. */ interface StatusDetails { /** The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. */ causes?: io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause[]; /** The group attribute of the resource associated with the status StatusReason. */ group?: string; /** The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described). */ name?: string; /** * If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action. * @format int32 */ retryAfterSeconds?: number; /** UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids */ uid?: string; } /** * Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. * @format date-time */ type Time = string; /** Event represents a single event to a watched resource. */ interface WatchEvent { /** * Object is: * * If Type is Added or Modified: the new state of the object. * * If Type is Deleted: the state of the object immediately before deletion. * * If Type is Error: *Status is recommended; other types may make sense * depending on context. */ object: io.k8s.apimachinery.pkg.runtime.RawExtension; /** */ type: string; } /** APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API. */ interface APIVersions { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. */ serverAddressByClientCIDRs: io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR[]; /** versions are the api versions that are available. */ versions: string[]; } /** ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match. */ interface ServerAddressByClientCIDR { /** The CIDR with which clients can match their IP to figure out the server address that they should use. */ clientCIDR: string; /** Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port. */ serverAddress: string; } /** APIGroup contains the name, the supported versions, and the preferred version of a group. */ interface APIGroup { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** name is the name of the group. */ name: string; /** preferredVersion is the version preferred by the API server, which probably is the storage version. */ preferredVersion?: io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery; /** a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. */ serverAddressByClientCIDRs?: io.k8s.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR[]; /** versions are the versions supported in this group. */ versions: io.k8s.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery[]; } /** GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility. */ interface GroupVersionForDiscovery { /** groupVersion specifies the API group and version in the form "group/version" */ groupVersion: string; /** version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion. */ version: string; } /** APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis. */ interface APIGroupList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** groups is a list of APIGroup. */ groups: io.k8s.apimachinery.pkg.apis.meta.v1.APIGroup[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; } } export declare namespace io.k8s.apimachinery.pkg.runtime { /** * RawExtension is used to hold extensions in external versions. * * To use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types. * * // Internal package: * * type MyAPIObject struct { * runtime.TypeMeta `json:",inline"` * MyPlugin runtime.Object `json:"myPlugin"` * } * * type PluginA struct { * AOption string `json:"aOption"` * } * * // External package: * * type MyAPIObject struct { * runtime.TypeMeta `json:",inline"` * MyPlugin runtime.RawExtension `json:"myPlugin"` * } * * type PluginA struct { * AOption string `json:"aOption"` * } * * // On the wire, the JSON will look something like this: * * { * "kind":"MyAPIObject", * "apiVersion":"v1", * "myPlugin": { * "kind":"PluginA", * "aOption":"foo", * }, * } * * So what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.) */ interface RawExtension { } } export declare namespace io.k8s.apimachinery.pkg.util.intstr { /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ type IntOrString = number | string; } export declare namespace io.k8s.api.admissionregistration.v1 { /** MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook. */ interface MatchCondition { /** * Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables: * * 'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. * See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz * 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the * request resource. * Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ * * Required. */ expression: string; /** * Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') * * Required. */ name: string; } /** MutatingWebhook describes an admission webhook and the resources and operations it applies to. */ interface MutatingWebhook { /** AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. */ admissionReviewVersions: string[]; /** ClientConfig defines how to communicate with the hook. Required */ clientConfig: io.k8s.api.admissionregistration.v1.WebhookClientConfig; /** FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. */ failurePolicy?: string; /** * MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. * * The exact matching logic is (in order): * 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. * 2. If ALL matchConditions evaluate to TRUE, the webhook is called. * 3. If any matchCondition evaluates to an error (but none are FALSE): * - If failurePolicy=Fail, reject the request * - If failurePolicy=Ignore, the error is ignored and the webhook is skipped * * This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate. */ matchConditions?: io.k8s.api.admissionregistration.v1.MatchCondition[]; /** * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". * * - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. * * - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. * * Defaults to "Equivalent" */ matchPolicy?: string; /** The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. */ name: string; /** * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. * * For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { * "matchExpressions": [ * { * "key": "runlevel", * "operator": "NotIn", * "values": [ * "0", * "1" * ] * } * ] * } * * If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { * "matchExpressions": [ * { * "key": "environment", * "operator": "In", * "values": [ * "prod", * "staging" * ] * } * ] * } * * See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. * * Default to the empty LabelSelector, which matches everything. */ namespaceSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. */ objectSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** * reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". * * Never: the webhook will not be called more than once in a single admission evaluation. * * IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. * * Defaults to "Never". */ reinvocationPolicy?: string; /** Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. */ rules?: io.k8s.api.admissionregistration.v1.RuleWithOperations[]; /** SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. */ sideEffects: string; /** * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. * @format int32 */ timeoutSeconds?: number; } /** MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object. */ interface MutatingWebhookConfiguration { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Webhooks is a list of webhooks and the affected resources and operations. */ webhooks?: io.k8s.api.admissionregistration.v1.MutatingWebhook[]; } /** MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration. */ interface MutatingWebhookConfigurationList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of MutatingWebhookConfiguration. */ items: io.k8s.api.admissionregistration.v1.MutatingWebhookConfiguration[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid. */ interface RuleWithOperations { /** APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. */ apiGroups?: string[]; /** APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. */ apiVersions?: string[]; /** Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. */ operations?: string[]; /** * Resources is a list of resources this rule applies to. * * For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*\//scale' means all scale subresources. '*\//*' means all resources and their subresources. * * If wildcard is present, the validation rule will ensure resources do not overlap with each other. * * Depending on the enclosing object, subresources might not be allowed. Required. */ resources?: string[]; /** scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". */ scope?: string; } /** ServiceReference holds a reference to Service.legacy.k8s.io */ interface ServiceReference { /** `name` is the name of the service. Required */ name: string; /** `namespace` is the namespace of the service. Required */ namespace: string; /** `path` is an optional URL path which will be sent in any request to this service. */ path?: string; /** * If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). * @format int32 */ port?: number; } /** ValidatingWebhook describes an admission webhook and the resources and operations it applies to. */ interface ValidatingWebhook { /** AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. */ admissionReviewVersions: string[]; /** ClientConfig defines how to communicate with the hook. Required */ clientConfig: io.k8s.api.admissionregistration.v1.WebhookClientConfig; /** FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail. */ failurePolicy?: string; /** * MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. * * The exact matching logic is (in order): * 1. If ANY matchCondition evaluates to FALSE, the webhook is skipped. * 2. If ALL matchConditions evaluate to TRUE, the webhook is called. * 3. If any matchCondition evaluates to an error (but none are FALSE): * - If failurePolicy=Fail, reject the request * - If failurePolicy=Ignore, the error is ignored and the webhook is skipped * * This is a beta feature and managed by the AdmissionWebhookMatchConditions feature gate. */ matchConditions?: io.k8s.api.admissionregistration.v1.MatchCondition[]; /** * matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". * * - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. * * - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. * * Defaults to "Equivalent" */ matchPolicy?: string; /** The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. */ name: string; /** * NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. * * For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { * "matchExpressions": [ * { * "key": "runlevel", * "operator": "NotIn", * "values": [ * "0", * "1" * ] * } * ] * } * * If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { * "matchExpressions": [ * { * "key": "environment", * "operator": "In", * "values": [ * "prod", * "staging" * ] * } * ] * } * * See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. * * Default to the empty LabelSelector, which matches everything. */ namespaceSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. */ objectSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. */ rules?: io.k8s.api.admissionregistration.v1.RuleWithOperations[]; /** SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. */ sideEffects: string; /** * TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 10 seconds. * @format int32 */ timeoutSeconds?: number; } /** ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it. */ interface ValidatingWebhookConfiguration { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Webhooks is a list of webhooks and the affected resources and operations. */ webhooks?: io.k8s.api.admissionregistration.v1.ValidatingWebhook[]; } /** ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration. */ interface ValidatingWebhookConfigurationList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of ValidatingWebhookConfiguration. */ items: io.k8s.api.admissionregistration.v1.ValidatingWebhookConfiguration[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** WebhookClientConfig contains the information to make a TLS connection with the webhook */ interface WebhookClientConfig { /** * `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. * @format byte */ caBundle?: string; /** * `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. * * If the webhook is running within the cluster, then you should use `service`. */ service?: io.k8s.api.admissionregistration.v1.ServiceReference; /** * `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. * * The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. * * Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. * * The scheme must be "https"; the URL must begin with "https://". * * A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. * * Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. */ url?: string; } } export declare namespace io.k8s.api.admissionregistration.v1alpha1 { /** AuditAnnotation describes how to produce an audit annotation for an API request. */ interface AuditAnnotation { /** * key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length. * * The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}". * * If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded. * * Required. */ key: string; /** * valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb. * * If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list. * * Required. */ valueExpression: string; } /** ExpressionWarning is a warning information that targets a specific expression. */ interface ExpressionWarning { /** The path to the field that refers the expression. For example, the reference to the expression of the first item of validations is "spec.validations[0].expression" */ fieldRef: string; /** The content of type checking information in a human-readable form. Each line of the warning contains the type that the expression is checked against, followed by the type check error from the compiler. */ warning: string; } /** */ interface MatchCondition { /** * Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables: * * 'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. * See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz * 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the * request resource. * Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ * * Required. */ expression: string; /** * Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') * * Required. */ name: string; } /** MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) */ interface MatchResources { /** ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) */ excludeResourceRules?: io.k8s.api.admissionregistration.v1alpha1.NamedRuleWithOperations[]; /** * matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". * * - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy. * * - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy. * * Defaults to "Equivalent" */ matchPolicy?: string; /** * NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy. * * For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { * "matchExpressions": [ * { * "key": "runlevel", * "operator": "NotIn", * "values": [ * "0", * "1" * ] * } * ] * } * * If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { * "matchExpressions": [ * { * "key": "environment", * "operator": "In", * "values": [ * "prod", * "staging" * ] * } * ] * } * * See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. * * Default to the empty LabelSelector, which matches everything. */ namespaceSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. */ objectSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule. */ resourceRules?: io.k8s.api.admissionregistration.v1alpha1.NamedRuleWithOperations[]; } /** NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames. */ interface NamedRuleWithOperations { /** APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. */ apiGroups?: string[]; /** APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. */ apiVersions?: string[]; /** Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. */ operations?: string[]; /** ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. */ resourceNames?: string[]; /** * Resources is a list of resources this rule applies to. * * For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*\//scale' means all scale subresources. '*\//*' means all resources and their subresources. * * If wildcard is present, the validation rule will ensure resources do not overlap with each other. * * Depending on the enclosing object, subresources might not be allowed. Required. */ resources?: string[]; /** scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". */ scope?: string; } /** ParamKind is a tuple of Group Kind and Version. */ interface ParamKind { /** APIVersion is the API group version the resources belong to. In format of "group/version". Required. */ apiVersion?: string; /** Kind is the API kind the resources belong to. Required. */ kind?: string; } /** ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding. */ interface ParamRef { /** * `name` is the name of the resource being referenced. * * `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. */ name?: string; /** * namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields. * * A per-namespace parameter may be used by specifying a namespace-scoped `paramKind` in the policy and leaving this field empty. * * - If `paramKind` is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error. * * - If `paramKind` is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error. */ namespace?: string; /** * `parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to `Allow`, then no matched parameters will be treated as successful validation by the binding. If set to `Deny`, then no matched parameters will be subject to the `failurePolicy` of the policy. * * Allowed values are `Allow` or `Deny` Default to `Deny` */ parameterNotFoundAction?: string; /** * selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind. * * If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together. * * One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. */ selector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; } /** TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy */ interface TypeChecking { /** The type checking warnings for each expression. */ expressionWarnings?: io.k8s.api.admissionregistration.v1alpha1.ExpressionWarning[]; } /** ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it. */ interface ValidatingAdmissionPolicy { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the ValidatingAdmissionPolicy. */ spec?: io.k8s.api.admissionregistration.v1alpha1.ValidatingAdmissionPolicySpec; /** The status of the ValidatingAdmissionPolicy, including warnings that are useful to determine if the policy behaves in the expected way. Populated by the system. Read-only. */ status?: io.k8s.api.admissionregistration.v1alpha1.ValidatingAdmissionPolicyStatus; } /** * ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters. * * For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding. * * The CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget. */ interface ValidatingAdmissionPolicyBinding { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. */ spec?: io.k8s.api.admissionregistration.v1alpha1.ValidatingAdmissionPolicyBindingSpec; } /** ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding. */ interface ValidatingAdmissionPolicyBindingList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of PolicyBinding. */ items?: io.k8s.api.admissionregistration.v1alpha1.ValidatingAdmissionPolicyBinding[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding. */ interface ValidatingAdmissionPolicyBindingSpec { /** MatchResources declares what resources match this binding and will be validated by it. Note that this is intersected with the policy's matchConstraints, so only requests that are matched by the policy can be selected by this. If this is unset, all resources matched by the policy are validated by this binding When resourceRules is unset, it does not constrain resource matching. If a resource is matched by the other fields of this object, it will be validated. Note that this is differs from ValidatingAdmissionPolicy matchConstraints, where resourceRules are required. */ matchResources?: io.k8s.api.admissionregistration.v1alpha1.MatchResources; /** paramRef specifies the parameter resource used to configure the admission control policy. It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy. If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist, this binding is considered mis-configured and the FailurePolicy of the ValidatingAdmissionPolicy applied. If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param. */ paramRef?: io.k8s.api.admissionregistration.v1alpha1.ParamRef; /** PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required. */ policyName?: string; /** * validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. If a validation evaluates to false it is always enforced according to these actions. * * Failures defined by the ValidatingAdmissionPolicy's FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail, otherwise the failures are ignored. This includes compilation errors, runtime errors and misconfigurations of the policy. * * validationActions is declared as a set of action values. Order does not matter. validationActions may not contain duplicates of the same action. * * The supported actions values are: * * "Deny" specifies that a validation failure results in a denied request. * * "Warn" specifies that a validation failure is reported to the request client in HTTP Warning headers, with a warning code of 299. Warnings can be sent both for allowed or denied admission responses. * * "Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{"message": "Invalid value", {"policy": "policy.example.com", {"binding": "policybinding.example.com", {"expressionIndex": "1", {"validationActions": ["Audit"]}]"` * * Clients should expect to handle additional values by ignoring any values not recognized. * * "Deny" and "Warn" may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers. * * Required. */ validationActions?: string[]; } /** ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy. */ interface ValidatingAdmissionPolicyList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of ValidatingAdmissionPolicy. */ items?: io.k8s.api.admissionregistration.v1alpha1.ValidatingAdmissionPolicy[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy. */ interface ValidatingAdmissionPolicySpec { /** auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required. */ auditAnnotations?: io.k8s.api.admissionregistration.v1alpha1.AuditAnnotation[]; /** * failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings. * * A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource. * * failurePolicy does not define how validations that evaluate to false are handled. * * When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced. * * Allowed values are Ignore or Fail. Defaults to Fail. */ failurePolicy?: string; /** * MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. * * If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions. * * The exact matching logic is (in order): * 1. If ANY matchCondition evaluates to FALSE, the policy is skipped. * 2. If ALL matchConditions evaluate to TRUE, the policy is evaluated. * 3. If any matchCondition evaluates to an error (but none are FALSE): * - If failurePolicy=Fail, reject the request * - If failurePolicy=Ignore, the policy is skipped */ matchConditions?: io.k8s.api.admissionregistration.v1alpha1.MatchCondition[]; /** MatchConstraints specifies what resources this policy is designed to validate. The AdmissionPolicy cares about a request if it matches _all_ Constraints. However, in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding. Required. */ matchConstraints?: io.k8s.api.admissionregistration.v1alpha1.MatchResources; /** ParamKind specifies the kind of resources used to parameterize this policy. If absent, there are no parameters for this policy and the param CEL variable will not be provided to validation expressions. If ParamKind refers to a non-existent kind, this policy definition is mis-configured and the FailurePolicy is applied. If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding, the params variable will be null. */ paramKind?: io.k8s.api.admissionregistration.v1alpha1.ParamKind; /** Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required. */ validations?: io.k8s.api.admissionregistration.v1alpha1.Validation[]; /** * Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy. * * The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic. */ variables?: io.k8s.api.admissionregistration.v1alpha1.Variable[]; } /** ValidatingAdmissionPolicyStatus represents the status of a ValidatingAdmissionPolicy. */ interface ValidatingAdmissionPolicyStatus { /** The conditions represent the latest available observations of a policy's current state. */ conditions?: io.k8s.apimachinery.pkg.apis.meta.v1.Condition[]; /** * The generation observed by the controller. * @format int64 */ observedGeneration?: number; /** The results of type checking for each expression. Presence of this field indicates the completion of the type checking. */ typeChecking?: io.k8s.api.admissionregistration.v1alpha1.TypeChecking; } /** Validation specifies the CEL expression which is used to apply the validation. */ interface Validation { /** * Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables: * * - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. * For example, a variable named 'foo' can be accessed as 'variables.foo'. * - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. * See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz * - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the * request resource. * * The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible. * * Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are: * "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", * "import", "let", "loop", "package", "namespace", "return". * Examples: * - Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"} * - Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"} * - Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"} * * Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: * - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and * non-intersecting elements in `Y` are appended, retaining their partial order. * - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values * are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with * non-intersecting keys are appended, retaining their partial order. * Required. */ expression: string; /** Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}". */ message?: string; /** messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")" */ messageExpression?: string; /** Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client. */ reason?: string; } /** Variable is the definition of a variable that is used for composition. */ interface Variable { /** Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation. */ expression: string; /** Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is "foo", the variable will be available as `variables.foo` */ name: string; } } export declare namespace io.k8s.api.admissionregistration.v1beta1 { /** AuditAnnotation describes how to produce an audit annotation for an API request. */ interface AuditAnnotation { /** * key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in length. * * The key is combined with the resource name of the ValidatingAdmissionPolicy to construct an audit annotation key: "{ValidatingAdmissionPolicy name}/{key}". * * If an admission webhook uses the same resource name as this ValidatingAdmissionPolicy and the same audit annotation key, the annotation key will be identical. In this case, the first annotation written with the key will be included in the audit event and all subsequent annotations with the same key will be discarded. * * Required. */ key: string; /** * valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to a string, the audit annotation is included with the string value. If the expression evaluates to null or empty string the audit annotation will be omitted. The valueExpression may be no longer than 5kb in length. If the result of the valueExpression is more than 10kb in length, it will be truncated to 10kb. * * If multiple ValidatingAdmissionPolicyBinding resources match an API request, then the valueExpression will be evaluated for each binding. All unique values produced by the valueExpressions will be joined together in a comma-separated list. * * Required. */ valueExpression: string; } /** ExpressionWarning is a warning information that targets a specific expression. */ interface ExpressionWarning { /** The path to the field that refers the expression. For example, the reference to the expression of the first item of validations is "spec.validations[0].expression" */ fieldRef: string; /** The content of type checking information in a human-readable form. Each line of the warning contains the type that the expression is checked against, followed by the type check error from the compiler. */ warning: string; } /** MatchCondition represents a condition which must be fulfilled for a request to be sent to a webhook. */ interface MatchCondition { /** * Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL variables: * * 'object' - The object from the incoming request. The value is null for DELETE requests. 'oldObject' - The existing object. The value is null for CREATE requests. 'request' - Attributes of the admission request(/pkg/apis/admission/types.go#AdmissionRequest). 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. * See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz * 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the * request resource. * Documentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ * * Required. */ expression: string; /** * Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the associated expression. Name must be a qualified name consisting of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character (e.g. 'MyName', or 'my.name', or '123-abc', regex used for validation is '([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]') with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName') * * Required. */ name: string; } /** MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) */ interface MatchResources { /** ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is excluded) */ excludeResourceRules?: io.k8s.api.admissionregistration.v1beta1.NamedRuleWithOperations[]; /** * matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". * * - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the ValidatingAdmissionPolicy. * * - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the ValidatingAdmissionPolicy. * * Defaults to "Equivalent" */ matchPolicy?: string; /** * NamespaceSelector decides whether to run the admission control policy on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the policy. * * For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { * "matchExpressions": [ * { * "key": "runlevel", * "operator": "NotIn", * "values": [ * "0", * "1" * ] * } * ] * } * * If instead you want to only run the policy on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { * "matchExpressions": [ * { * "key": "environment", * "operator": "In", * "values": [ * "prod", * "staging" * ] * } * ] * } * * See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. * * Default to the empty LabelSelector, which matches everything. */ namespaceSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** ObjectSelector decides whether to run the validation based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the cel validation, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. */ objectSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches _any_ Rule. */ resourceRules?: io.k8s.api.admissionregistration.v1beta1.NamedRuleWithOperations[]; } /** NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames. */ interface NamedRuleWithOperations { /** APIGroups is the API groups the resources belong to. '*' is all groups. If '*' is present, the length of the slice must be one. Required. */ apiGroups?: string[]; /** APIVersions is the API versions the resources belong to. '*' is all versions. If '*' is present, the length of the slice must be one. Required. */ apiVersions?: string[]; /** Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present, the length of the slice must be one. Required. */ operations?: string[]; /** ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. */ resourceNames?: string[]; /** * Resources is a list of resources this rule applies to. * * For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '*' means all resources, but not subresources. 'pods/*' means all subresources of pods. '*\//scale' means all scale subresources. '*\//*' means all resources and their subresources. * * If wildcard is present, the validation rule will ensure resources do not overlap with each other. * * Depending on the enclosing object, subresources might not be allowed. Required. */ resources?: string[]; /** scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". */ scope?: string; } /** ParamKind is a tuple of Group Kind and Version. */ interface ParamKind { /** APIVersion is the API group version the resources belong to. In format of "group/version". Required. */ apiVersion?: string; /** Kind is the API kind the resources belong to. Required. */ kind?: string; } /** ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding. */ interface ParamRef { /** * name is the name of the resource being referenced. * * One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. * * A single parameter used for all admission requests can be configured by setting the `name` field, leaving `selector` blank, and setting namespace if `paramKind` is namespace-scoped. */ name?: string; /** * namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields. * * A per-namespace parameter may be used by specifying a namespace-scoped `paramKind` in the policy and leaving this field empty. * * - If `paramKind` is cluster-scoped, this field MUST be unset. Setting this field results in a configuration error. * * - If `paramKind` is namespace-scoped, the namespace of the object being evaluated for admission will be used when this field is left unset. Take care that if this is left empty the binding must not match any cluster-scoped resources, which will result in an error. */ namespace?: string; /** * `parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to `Allow`, then no matched parameters will be treated as successful validation by the binding. If set to `Deny`, then no matched parameters will be subject to the `failurePolicy` of the policy. * * Allowed values are `Allow` or `Deny` * * Required */ parameterNotFoundAction?: string; /** * selector can be used to match multiple param objects based on their labels. Supply selector: {} to match all resources of the ParamKind. * * If multiple params are found, they are all evaluated with the policy expressions and the results are ANDed together. * * One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. */ selector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; } /** TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy */ interface TypeChecking { /** The type checking warnings for each expression. */ expressionWarnings?: io.k8s.api.admissionregistration.v1beta1.ExpressionWarning[]; } /** ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it. */ interface ValidatingAdmissionPolicy { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the ValidatingAdmissionPolicy. */ spec?: io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicySpec; /** The status of the ValidatingAdmissionPolicy, including warnings that are useful to determine if the policy behaves in the expected way. Populated by the system. Read-only. */ status?: io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyStatus; } /** * ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters. * * For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding. * * The CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget. */ interface ValidatingAdmissionPolicyBinding { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the ValidatingAdmissionPolicyBinding. */ spec?: io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBindingSpec; } /** ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding. */ interface ValidatingAdmissionPolicyBindingList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of PolicyBinding. */ items?: io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicyBinding[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding. */ interface ValidatingAdmissionPolicyBindingSpec { /** MatchResources declares what resources match this binding and will be validated by it. Note that this is intersected with the policy's matchConstraints, so only requests that are matched by the policy can be selected by this. If this is unset, all resources matched by the policy are validated by this binding When resourceRules is unset, it does not constrain resource matching. If a resource is matched by the other fields of this object, it will be validated. Note that this is differs from ValidatingAdmissionPolicy matchConstraints, where resourceRules are required. */ matchResources?: io.k8s.api.admissionregistration.v1beta1.MatchResources; /** paramRef specifies the parameter resource used to configure the admission control policy. It should point to a resource of the type specified in ParamKind of the bound ValidatingAdmissionPolicy. If the policy specifies a ParamKind and the resource referred to by ParamRef does not exist, this binding is considered mis-configured and the FailurePolicy of the ValidatingAdmissionPolicy applied. If the policy does not specify a ParamKind then this field is ignored, and the rules are evaluated without a param. */ paramRef?: io.k8s.api.admissionregistration.v1beta1.ParamRef; /** PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be ignored Required. */ policyName?: string; /** * validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. If a validation evaluates to false it is always enforced according to these actions. * * Failures defined by the ValidatingAdmissionPolicy's FailurePolicy are enforced according to these actions only if the FailurePolicy is set to Fail, otherwise the failures are ignored. This includes compilation errors, runtime errors and misconfigurations of the policy. * * validationActions is declared as a set of action values. Order does not matter. validationActions may not contain duplicates of the same action. * * The supported actions values are: * * "Deny" specifies that a validation failure results in a denied request. * * "Warn" specifies that a validation failure is reported to the request client in HTTP Warning headers, with a warning code of 299. Warnings can be sent both for allowed or denied admission responses. * * "Audit" specifies that a validation failure is included in the published audit event for the request. The audit event will contain a `validation.policy.admission.k8s.io/validation_failure` audit annotation with a value containing the details of the validation failures, formatted as a JSON list of objects, each with the following fields: - message: The validation failure message string - policy: The resource name of the ValidatingAdmissionPolicy - binding: The resource name of the ValidatingAdmissionPolicyBinding - expressionIndex: The index of the failed validations in the ValidatingAdmissionPolicy - validationActions: The enforcement actions enacted for the validation failure Example audit annotation: `"validation.policy.admission.k8s.io/validation_failure": "[{"message": "Invalid value", {"policy": "policy.example.com", {"binding": "policybinding.example.com", {"expressionIndex": "1", {"validationActions": ["Audit"]}]"` * * Clients should expect to handle additional values by ignoring any values not recognized. * * "Deny" and "Warn" may not be used together since this combination needlessly duplicates the validation failure both in the API response body and the HTTP warning headers. * * Required. */ validationActions?: string[]; } /** ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy. */ interface ValidatingAdmissionPolicyList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of ValidatingAdmissionPolicy. */ items?: io.k8s.api.admissionregistration.v1beta1.ValidatingAdmissionPolicy[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy. */ interface ValidatingAdmissionPolicySpec { /** auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of validations or auditAnnotations is required. */ auditAnnotations?: io.k8s.api.admissionregistration.v1beta1.AuditAnnotation[]; /** * failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions or bindings. * * A policy is invalid if spec.paramKind refers to a non-existent Kind. A binding is invalid if spec.paramRef.name refers to a non-existent resource. * * failurePolicy does not define how validations that evaluate to false are handled. * * When failurePolicy is set to Fail, ValidatingAdmissionPolicyBinding validationActions define how failures are enforced. * * Allowed values are Ignore or Fail. Defaults to Fail. */ failurePolicy?: string; /** * MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and objectSelector. An empty list of matchConditions matches all requests. There are a maximum of 64 match conditions allowed. * * If a parameter object is provided, it can be accessed via the `params` handle in the same manner as validation expressions. * * The exact matching logic is (in order): * 1. If ANY matchCondition evaluates to FALSE, the policy is skipped. * 2. If ALL matchConditions evaluate to TRUE, the policy is evaluated. * 3. If any matchCondition evaluates to an error (but none are FALSE): * - If failurePolicy=Fail, reject the request * - If failurePolicy=Ignore, the policy is skipped */ matchConditions?: io.k8s.api.admissionregistration.v1beta1.MatchCondition[]; /** MatchConstraints specifies what resources this policy is designed to validate. The AdmissionPolicy cares about a request if it matches _all_ Constraints. However, in order to prevent clusters from being put into an unstable state that cannot be recovered from via the API ValidatingAdmissionPolicy cannot match ValidatingAdmissionPolicy and ValidatingAdmissionPolicyBinding. Required. */ matchConstraints?: io.k8s.api.admissionregistration.v1beta1.MatchResources; /** ParamKind specifies the kind of resources used to parameterize this policy. If absent, there are no parameters for this policy and the param CEL variable will not be provided to validation expressions. If ParamKind refers to a non-existent kind, this policy definition is mis-configured and the FailurePolicy is applied. If paramKind is specified but paramRef is unset in ValidatingAdmissionPolicyBinding, the params variable will be null. */ paramKind?: io.k8s.api.admissionregistration.v1beta1.ParamKind; /** Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required. */ validations?: io.k8s.api.admissionregistration.v1beta1.Validation[]; /** * Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy. * * The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic. */ variables?: io.k8s.api.admissionregistration.v1beta1.Variable[]; } /** ValidatingAdmissionPolicyStatus represents the status of an admission validation policy. */ interface ValidatingAdmissionPolicyStatus { /** The conditions represent the latest available observations of a policy's current state. */ conditions?: io.k8s.apimachinery.pkg.apis.meta.v1.Condition[]; /** * The generation observed by the controller. * @format int64 */ observedGeneration?: number; /** The results of type checking for each expression. Presence of this field indicates the completion of the type checking. */ typeChecking?: io.k8s.api.admissionregistration.v1beta1.TypeChecking; } /** Validation specifies the CEL expression which is used to apply the validation. */ interface Validation { /** * Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into CEL variables as well as some other useful variables: * * - 'object' - The object from the incoming request. The value is null for DELETE requests. - 'oldObject' - The existing object. The value is null for CREATE requests. - 'request' - Attributes of the API request([ref](/pkg/apis/admission/types.go#AdmissionRequest)). - 'params' - Parameter resource referred to by the policy binding being evaluated. Only populated if the policy has a ParamKind. - 'namespaceObject' - The namespace object that the incoming object belongs to. The value is null for cluster-scoped resources. - 'variables' - Map of composited variables, from its name to its lazily evaluated value. * For example, a variable named 'foo' can be accessed as 'variables.foo'. * - 'authorizer' - A CEL Authorizer. May be used to perform authorization checks for the principal (user or service account) of the request. * See https://pkg.go.dev/k8s.io/apiserver/pkg/cel/library#Authz * - 'authorizer.requestResource' - A CEL ResourceCheck constructed from the 'authorizer' and configured with the * request resource. * * The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object. No other metadata properties are accessible. * * Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are: * "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", * "import", "let", "loop", "package", "namespace", "return". * Examples: * - Expression accessing a property named "namespace": {"Expression": "object.__namespace__ > 0"} * - Expression accessing a property named "x-prop": {"Expression": "object.x__dash__prop > 0"} * - Expression accessing a property named "redact__d": {"Expression": "object.redact__underscores__d > 0"} * * Equality on arrays with list type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: * - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and * non-intersecting elements in `Y` are appended, retaining their partial order. * - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values * are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with * non-intersecting keys are appended, retaining their partial order. * Required. */ expression: string; /** Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" If the Expression contains line breaks. Message is required. The message must not contain line breaks. If unset, the message is "failed Expression: {Expression}". */ message?: string; /** messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a validation, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the `expression` except for 'authorizer' and 'authorizer.requestResource'. Example: "object.x must be less than max ("+string(params.max)+")" */ messageExpression?: string; /** Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are used in the HTTP response to the client. The currently supported reasons are: "Unauthorized", "Forbidden", "Invalid", "RequestEntityTooLarge". If not set, StatusReasonInvalid is used in the response to the client. */ reason?: string; } /** Variable is the definition of a variable that is used for composition. A variable is defined as a named expression. */ interface Variable { /** Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation. */ expression: string; /** Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is "foo", the variable will be available as `variables.foo` */ name: string; } } export declare namespace io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1 { /** CustomResourceColumnDefinition specifies a column for server side printing. */ interface CustomResourceColumnDefinition { /** description is a human readable description of this column. */ description?: string; /** format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. */ format?: string; /** jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. */ jsonPath: string; /** name is a human readable name for the column. */ name: string; /** * priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. * @format int32 */ priority?: number; /** type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. */ type: string; } /** CustomResourceConversion describes how to convert different versions of a CR. */ interface CustomResourceConversion { /** * strategy specifies how custom resources are converted between versions. Allowed values are: - `"None"`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `"Webhook"`: API Server will call to an external webhook to do the conversion. Additional information * is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhook to be set. */ strategy: string; /** webhook describes how to call the conversion webhook. Required when `strategy` is set to `"Webhook"`. */ webhook?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.WebhookConversion; } /** CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>. */ interface CustomResourceDefinition { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec describes how the user wants the resources to appear */ spec: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionSpec; /** status indicates the actual state of the CustomResourceDefinition */ status?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionStatus; } /** CustomResourceDefinitionCondition contains details for the current condition of this pod. */ interface CustomResourceDefinitionCondition { /** lastTransitionTime last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** message is a human-readable message indicating details about last transition. */ message?: string; /** reason is a unique, one-word, CamelCase reason for the condition's last transition. */ reason?: string; /** status is the status of the condition. Can be True, False, Unknown. */ status: string; /** type is the type of the condition. Types include Established, NamesAccepted and Terminating. */ type: string; } /** CustomResourceDefinitionList is a list of CustomResourceDefinition objects. */ interface CustomResourceDefinitionList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items list individual CustomResourceDefinition objects */ items: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinition[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition */ interface CustomResourceDefinitionNames { /** categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. */ categories?: string[]; /** kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. */ kind: string; /** listKind is the serialized kind of the list for this resource. Defaults to "`kind`List". */ listKind?: string; /** plural is the plural name of the resource to serve. The custom resources are served under `/apis///.../`. Must match the name of the CustomResourceDefinition (in the form `.`). Must be all lowercase. */ plural: string; /** shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get `. It must be all lowercase. */ shortNames?: string[]; /** singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. */ singular?: string; } /** CustomResourceDefinitionSpec describes how a user wants their resource to appear */ interface CustomResourceDefinitionSpec { /** conversion defines conversion settings for the CRD. */ conversion?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceConversion; /** group is the API group of the defined custom resource. The custom resources are served under `/apis//...`. Must match the name of the CustomResourceDefinition (in the form `.`). */ group: string; /** names specify the resource and kind names for the custom resource. */ names: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames; /** preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#field-pruning for details. */ preserveUnknownFields?: boolean; /** scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. */ scope: string; /** versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. */ versions: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionVersion[]; } /** CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition */ interface CustomResourceDefinitionStatus { /** acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec. */ acceptedNames?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionNames; /** conditions indicate state for particular aspects of a CustomResourceDefinition */ conditions?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceDefinitionCondition[]; /** storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list. */ storedVersions?: string[]; } /** CustomResourceDefinitionVersion describes a version for CRD. */ interface CustomResourceDefinitionVersion { /** additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no columns are specified, a single column displaying the age of the custom resource is used. */ additionalPrinterColumns?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceColumnDefinition[]; /** deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false. */ deprecated?: boolean; /** deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. */ deprecationWarning?: string; /** name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis///...` if `served` is true. */ name: string; /** schema describes the schema used for validation, pruning, and defaulting of this version of the custom resource. */ schema?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceValidation; /** served is a flag enabling/disabling this version from being served via REST APIs */ served: boolean; /** storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true. */ storage: boolean; /** subresources specify what subresources this version of the defined custom resource have. */ subresources?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresources; } /** CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources. */ interface CustomResourceSubresourceScale { /** labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. */ labelSelectorPath?: string; /** specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. */ specReplicasPath: string; /** statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. */ statusReplicasPath: string; } /** CustomResourceSubresourceStatus defines how to serve the status subresource for CustomResources. Status is represented by the `.status` JSON path inside of a CustomResource. When set, * exposes a /status subresource for the custom resource * PUT requests to the /status subresource take a custom resource object, and ignore changes to anything except the status stanza * PUT/POST/PATCH requests to the custom resource ignore changes to the status stanza */ interface CustomResourceSubresourceStatus { } /** CustomResourceSubresources defines the status and scale subresources for CustomResources. */ interface CustomResourceSubresources { /** scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. */ scale?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceScale; /** status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. */ status?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.CustomResourceSubresourceStatus; } /** CustomResourceValidation is a list of validation methods for CustomResources. */ interface CustomResourceValidation { /** openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. */ openAPIV3Schema?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps; } /** ExternalDocumentation allows referencing an external resource for extended documentation. */ interface ExternalDocumentation { /** */ description?: string; /** */ url?: string; } /** JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil. */ type JSON = any; /** JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/). */ interface JSONSchemaProps { /** */ $ref?: string; /** */ $schema?: string; additionalItems: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrBool; additionalProperties: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrBool; /** */ allOf?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[]; /** */ anyOf?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[]; /** default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false. */ default?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSON; /** */ definitions?: Record; /** */ dependencies?: Record; /** */ description?: string; /** */ enum?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSON[]; example: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSON; /** */ exclusiveMaximum?: boolean; /** */ exclusiveMinimum?: boolean; externalDocs: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.ExternalDocumentation; /** * format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: * * - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. */ format?: string; /** */ id?: string; items: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSONSchemaPropsOrArray; /** @format int64 */ maxItems?: number; /** @format int64 */ maxLength?: number; /** @format int64 */ maxProperties?: number; /** @format double */ maximum?: number; /** @format int64 */ minItems?: number; /** @format int64 */ minLength?: number; /** @format int64 */ minProperties?: number; /** @format double */ minimum?: number; /** @format double */ multipleOf?: number; not: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps; /** */ nullable?: boolean; /** */ oneOf?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps[]; /** */ pattern?: string; /** */ patternProperties?: Record; /** */ properties?: Record; /** */ required?: string[]; /** */ title?: string; /** */ type?: string; /** */ uniqueItems?: boolean; /** x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). */ "x-kubernetes-embedded-resource"?: boolean; /** * x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: * * 1) anyOf: * - type: integer * - type: string * 2) allOf: * - anyOf: * - type: integer * - type: string * - ... zero or more */ "x-kubernetes-int-or-string"?: boolean; /** * x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. * * This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). * * The properties specified must either be required or have a default value, to ensure those properties are present for all list items. */ "x-kubernetes-list-map-keys"?: string[]; /** * x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: * * 1) `atomic`: the list is treated as a single entity, like a scalar. * Atomic lists will be entirely replaced when updated. This extension * may be used on any type of list (struct, scalar, ...). * 2) `set`: * Sets are lists that must not have multiple items with the same value. Each * value must be a scalar, an object with x-kubernetes-map-type `atomic` or an * array with x-kubernetes-list-type `atomic`. * 3) `map`: * These lists are like maps in that their elements have a non-index key * used to identify them. Order is preserved upon merge. The map tag * must only be used on a list with elements of type object. * Defaults to atomic for arrays. */ "x-kubernetes-list-type"?: string; /** * x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: * * 1) `granular`: * These maps are actual maps (key-value pairs) and each fields are independent * from each other (they can each be manipulated by separate actors). This is * the default behaviour for all maps. * 2) `atomic`: the list is treated as a single entity, like a scalar. * Atomic maps will be entirely replaced when updated. */ "x-kubernetes-map-type"?: string; /** x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. */ "x-kubernetes-preserve-unknown-fields"?: boolean; /** x-kubernetes-validations describes a list of validation rules written in the CEL expression language. This field is an alpha-level. Using this field requires the feature gate `CustomResourceValidationExpressions` to be enabled. */ "x-kubernetes-validations"?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.ValidationRule[]; } /** JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes. */ type JSONSchemaPropsOrArray = any; /** JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property. */ type JSONSchemaPropsOrBool = any; /** JSONSchemaPropsOrStringArray represents a JSONSchemaProps or a string array. */ type JSONSchemaPropsOrStringArray = any; /** ServiceReference holds a reference to Service.legacy.k8s.io */ interface ServiceReference { /** name is the name of the service. Required */ name: string; /** namespace is the namespace of the service. Required */ namespace: string; /** path is an optional URL path at which the webhook will be contacted. */ path?: string; /** * port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility. * @format int32 */ port?: number; } /** ValidationRule describes a validation rule written in the CEL expression language. */ interface ValidationRule { /** fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in the schema and refer to an existing field. e.g. when validation checks if a specific attribute `foo` under a map `testMap`, the fieldPath could be set to `.testMap.foo` If the validation checks two lists must have unique attributes, the fieldPath could be set to either of the list: e.g. `.testList` It does not support list numeric index. It supports child operation to refer to an existing field currently. Refer to [JSONPath support in Kubernetes](https://kubernetes.io/docs/reference/kubectl/jsonpath/) for more info. Numeric index of array is not supported. For field name which contains special characters, use `['specialName']` to refer the field name. e.g. for attribute `foo.34$` appears in a list `testList`, the fieldPath could be set to `.testList['foo.34$']` */ fieldPath?: string; /** Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed rule: {Rule}". e.g. "must be a URL with the host matching spec.host" */ message?: string; /** MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must evaluate to a string. If both message and messageExpression are present on a rule, then messageExpression will be used if validation fails. If messageExpression results in a runtime error, the runtime error is logged, and the validation failure message is produced as if the messageExpression field were unset. If messageExpression evaluates to an empty string, a string with only spaces, or a string that contains line breaks, then the validation failure message will also be produced as if the messageExpression field were unset, and the fact that messageExpression produced an empty string/string with only spaces/string with line breaks will be logged. messageExpression has access to all the same variables as the rule; the only difference is the return type. Example: "x must be less than max ("+string(self.max)+")" */ messageExpression?: string; /** reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the reason of the reason of the first failed validation rule. The currently supported reasons are: "FieldValueInvalid", "FieldValueForbidden", "FieldValueRequired", "FieldValueDuplicate". If not set, default to use "FieldValueInvalid". All future added reasons must be accepted by clients when reading this value and unknown reasons should be treated as FieldValueInvalid. */ reason?: string; /** * Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The `self` variable in the CEL expression is bound to the scoped value. Example: - Rule scoped to the root of a resource with a status subresource: {"rule": "self.status.actual <= self.spec.maxDesired"} * * If the Rule is scoped to an object with properties, the accessible properties of the object are field selectable via `self.field` and field presence can be checked via `has(self.field)`. Null valued fields are treated as absent fields in CEL expressions. If the Rule is scoped to an object with additionalProperties (i.e. a map) the value of the map are accessible via `self[mapKey]`, map containment can be checked via `mapKey in self` and all entries of the map are accessible via CEL macros and functions such as `self.all(...)`. If the Rule is scoped to an array, the elements of the array are accessible via `self[i]` and also by macros and functions. If the Rule is scoped to a scalar, `self` is bound to the scalar value. Examples: - Rule scoped to a map of objects: {"rule": "self.components['Widget'].priority < 10"} - Rule scoped to a list of integers: {"rule": "self.values.all(value, value >= 0 && value < 100)"} - Rule scoped to a string value: {"rule": "self.startsWith('kube')"} * * The `apiVersion`, `kind`, `metadata.name` and `metadata.generateName` are always accessible from the root of the object and from any x-kubernetes-embedded-resource annotated objects. No other metadata properties are accessible. * * Unknown data preserved in custom resources via x-kubernetes-preserve-unknown-fields is not accessible in CEL expressions. This includes: - Unknown field values that are preserved by object schemas with x-kubernetes-preserve-unknown-fields. - Object properties where the property schema is of an "unknown type". An "unknown type" is recursively defined as: * - A schema with no type and x-kubernetes-preserve-unknown-fields set to true * - An array where the items schema is of an "unknown type" * - An object where the additionalProperties schema is of an "unknown type" * * Only property names of the form `[a-zA-Z_.-/][a-zA-Z0-9_.-/]*` are accessible. Accessible property names are escaped according to the following rules when accessed in the expression: - '__' escapes to '__underscores__' - '.' escapes to '__dot__' - '-' escapes to '__dash__' - '/' escapes to '__slash__' - Property names that exactly match a CEL RESERVED keyword escape to '__{keyword}__'. The keywords are: * "true", "false", "null", "in", "as", "break", "const", "continue", "else", "for", "function", "if", * "import", "let", "loop", "package", "namespace", "return". * Examples: * - Rule accessing a property named "namespace": {"rule": "self.__namespace__ > 0"} * - Rule accessing a property named "x-prop": {"rule": "self.x__dash__prop > 0"} * - Rule accessing a property named "redact__d": {"rule": "self.redact__underscores__d > 0"} * * Equality on arrays with x-kubernetes-list-type of 'set' or 'map' ignores element order, i.e. [1, 2] == [2, 1]. Concatenation on arrays with x-kubernetes-list-type use the semantics of the list type: * - 'set': `X + Y` performs a union where the array positions of all elements in `X` are preserved and * non-intersecting elements in `Y` are appended, retaining their partial order. * - 'map': `X + Y` performs a merge where the array positions of all keys in `X` are preserved but the values * are overwritten by values in `Y` when the key sets of `X` and `Y` intersect. Elements in `Y` with * non-intersecting keys are appended, retaining their partial order. */ rule: string; } /** WebhookClientConfig contains the information to make a TLS connection with the webhook. */ interface WebhookClientConfig { /** * caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. * @format byte */ caBundle?: string; /** * service is a reference to the service for this webhook. Either service or url must be specified. * * If the webhook is running within the cluster, then you should use `service`. */ service?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.ServiceReference; /** * url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. * * The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. * * Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. * * The scheme must be "https"; the URL must begin with "https://". * * A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. * * Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. */ url?: string; } /** WebhookConversion describes how to call a conversion webhook */ interface WebhookConversion { /** clientConfig is the instructions for how to call the webhook if strategy is `Webhook`. */ clientConfig?: io.k8s.apiextensions_apiserver.pkg.apis.apiextensions.v1.WebhookClientConfig; /** conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. */ conversionReviewVersions: string[]; } } export declare namespace io.k8s.kube_aggregator.pkg.apis.apiregistration.v1 { /** APIService represents a server for a particular GroupVersion. Name must be "version.group". */ interface APIService { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec contains information for locating and communicating with a server */ spec?: io.k8s.kube_aggregator.pkg.apis.apiregistration.v1.APIServiceSpec; /** Status contains derived information about an API server */ status?: io.k8s.kube_aggregator.pkg.apis.apiregistration.v1.APIServiceStatus; } /** APIServiceCondition describes the state of an APIService at a particular point */ interface APIServiceCondition { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Human-readable message indicating details about last transition. */ message?: string; /** Unique, one-word, CamelCase reason for the condition's last transition. */ reason?: string; /** Status is the status of the condition. Can be True, False, Unknown. */ status: string; /** Type is the type of the condition. */ type: string; } /** APIServiceList is a list of APIService objects. */ interface APIServiceList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of APIService */ items: io.k8s.kube_aggregator.pkg.apis.apiregistration.v1.APIService[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification. */ interface APIServiceSpec { /** * CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. * @format byte */ caBundle?: string; /** Group is the API group name this server hosts */ group?: string; /** * GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s * @format int32 */ groupPriorityMinimum: number; /** InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. */ insecureSkipTLSVerify?: boolean; /** Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. */ service?: io.k8s.kube_aggregator.pkg.apis.apiregistration.v1.ServiceReference; /** Version is the API version this server hosts. For example, "v1" */ version?: string; /** * VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. * @format int32 */ versionPriority: number; } /** APIServiceStatus contains derived information about an API server */ interface APIServiceStatus { /** Current service state of apiService. */ conditions?: io.k8s.kube_aggregator.pkg.apis.apiregistration.v1.APIServiceCondition[]; } /** ServiceReference holds a reference to Service.legacy.k8s.io */ interface ServiceReference { /** Name is the name of the service */ name?: string; /** Namespace is the namespace of the service */ namespace?: string; /** * If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). * @format int32 */ port?: number; } } export declare namespace io.k8s.api.apps.v1 { /** ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers. */ interface ControllerRevision { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Data is the serialized representation of the state. */ data?: io.k8s.apimachinery.pkg.runtime.RawExtension; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** * Revision indicates the revision of the state represented by Data. * @format int64 */ revision: number; } /** ControllerRevisionList is a resource containing a list of ControllerRevision objects. */ interface ControllerRevisionList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of ControllerRevisions */ items: io.k8s.api.apps.v1.ControllerRevision[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** DaemonSet represents the configuration of a daemon set. */ interface DaemonSet { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.apps.v1.DaemonSetSpec; /** The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.apps.v1.DaemonSetStatus; } /** DaemonSetCondition describes the state of a DaemonSet at a certain point. */ interface DaemonSetCondition { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of DaemonSet condition. */ type: string; } /** DaemonSetList is a collection of daemon sets. */ interface DaemonSetList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** A list of daemon sets. */ items: io.k8s.api.apps.v1.DaemonSet[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** DaemonSetSpec is the specification of a daemon set. */ interface DaemonSetSpec { /** * The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). * @format int32 */ minReadySeconds?: number; /** * The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. * @format int32 */ revisionHistoryLimit?: number; /** A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors */ selector: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). The only allowed template.spec.restartPolicy value is "Always". More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template */ template: io.k8s.api.core.v1.PodTemplateSpec; /** An update strategy to replace existing DaemonSet pods with new pods. */ updateStrategy?: io.k8s.api.apps.v1.DaemonSetUpdateStrategy; } /** DaemonSetStatus represents the current status of a daemon set. */ interface DaemonSetStatus { /** * Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. * @format int32 */ collisionCount?: number; /** Represents the latest available observations of a DaemonSet's current state. */ conditions?: io.k8s.api.apps.v1.DaemonSetCondition[]; /** * The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ * @format int32 */ currentNumberScheduled: number; /** * The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ * @format int32 */ desiredNumberScheduled: number; /** * The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds) * @format int32 */ numberAvailable?: number; /** * The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ * @format int32 */ numberMisscheduled: number; /** * numberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running with a Ready Condition. * @format int32 */ numberReady: number; /** * The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds) * @format int32 */ numberUnavailable?: number; /** * The most recent generation observed by the daemon set controller. * @format int64 */ observedGeneration?: number; /** * The total number of nodes that are running updated daemon pod * @format int32 */ updatedNumberScheduled?: number; } /** DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet. */ interface DaemonSetUpdateStrategy { /** Rolling update config params. Present only if type = "RollingUpdate". */ rollingUpdate?: io.k8s.api.apps.v1.RollingUpdateDaemonSet; /** Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate. */ type?: string; } /** Deployment enables declarative updates for Pods and ReplicaSets. */ interface Deployment { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the Deployment. */ spec?: io.k8s.api.apps.v1.DeploymentSpec; /** Most recently observed status of the Deployment. */ status?: io.k8s.api.apps.v1.DeploymentStatus; } /** DeploymentCondition describes the state of a deployment at a certain point. */ interface DeploymentCondition { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** The last time this condition was updated. */ lastUpdateTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of deployment condition. */ type: string; } /** DeploymentList is a list of Deployments. */ interface DeploymentList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of Deployments. */ items: io.k8s.api.apps.v1.Deployment[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** DeploymentSpec is the specification of the desired behavior of the Deployment. */ interface DeploymentSpec { /** * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) * @format int32 */ minReadySeconds?: number; /** Indicates that the deployment is paused. */ paused?: boolean; /** * The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. * @format int32 */ progressDeadlineSeconds?: number; /** * Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. * @format int32 */ replicas?: number; /** * The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. * @format int32 */ revisionHistoryLimit?: number; /** Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. */ selector: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** The deployment strategy to use to replace existing pods with new ones. */ strategy?: io.k8s.api.apps.v1.DeploymentStrategy; /** Template describes the pods that will be created. The only allowed template.spec.restartPolicy value is "Always". */ template: io.k8s.api.core.v1.PodTemplateSpec; } /** DeploymentStatus is the most recently observed status of the Deployment. */ interface DeploymentStatus { /** * Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. * @format int32 */ availableReplicas?: number; /** * Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet. * @format int32 */ collisionCount?: number; /** Represents the latest available observations of a deployment's current state. */ conditions?: io.k8s.api.apps.v1.DeploymentCondition[]; /** * The generation observed by the deployment controller. * @format int64 */ observedGeneration?: number; /** * readyReplicas is the number of pods targeted by this Deployment with a Ready Condition. * @format int32 */ readyReplicas?: number; /** * Total number of non-terminated pods targeted by this deployment (their labels match the selector). * @format int32 */ replicas?: number; /** * Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created. * @format int32 */ unavailableReplicas?: number; /** * Total number of non-terminated pods targeted by this deployment that have the desired template spec. * @format int32 */ updatedReplicas?: number; } /** DeploymentStrategy describes how to replace existing pods with new ones. */ interface DeploymentStrategy { /** Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. */ rollingUpdate?: io.k8s.api.apps.v1.RollingUpdateDeployment; /** Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. */ type?: string; } /** ReplicaSet ensures that a specified number of pod replicas are running at any given time. */ interface ReplicaSet { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.apps.v1.ReplicaSetSpec; /** Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.apps.v1.ReplicaSetStatus; } /** ReplicaSetCondition describes the state of a replica set at a certain point. */ interface ReplicaSetCondition { /** The last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of replica set condition. */ type: string; } /** ReplicaSetList is a collection of ReplicaSets. */ interface ReplicaSetList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller */ items: io.k8s.api.apps.v1.ReplicaSet[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ReplicaSetSpec is the specification of a ReplicaSet. */ interface ReplicaSetSpec { /** * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) * @format int32 */ minReadySeconds?: number; /** * Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller * @format int32 */ replicas?: number; /** Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors */ selector: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template */ template?: io.k8s.api.core.v1.PodTemplateSpec; } /** ReplicaSetStatus represents the current status of a ReplicaSet. */ interface ReplicaSetStatus { /** * The number of available replicas (ready for at least minReadySeconds) for this replica set. * @format int32 */ availableReplicas?: number; /** Represents the latest available observations of a replica set's current state. */ conditions?: io.k8s.api.apps.v1.ReplicaSetCondition[]; /** * The number of pods that have labels matching the labels of the pod template of the replicaset. * @format int32 */ fullyLabeledReplicas?: number; /** * ObservedGeneration reflects the generation of the most recently observed ReplicaSet. * @format int64 */ observedGeneration?: number; /** * readyReplicas is the number of pods targeted by this ReplicaSet with a Ready Condition. * @format int32 */ readyReplicas?: number; /** * Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller * @format int32 */ replicas: number; } /** Spec to control the desired behavior of daemon set rolling update. */ interface RollingUpdateDaemonSet { /** The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. */ maxSurge?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; /** The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. */ maxUnavailable?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; } /** Spec to control the desired behavior of rolling update. */ interface RollingUpdateDeployment { /** The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. */ maxSurge?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; /** The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. */ maxUnavailable?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; } /** RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType. */ interface RollingUpdateStatefulSetStrategy { /** The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0. Defaults to 1. This field is alpha-level and is only honored by servers that enable the MaxUnavailableStatefulSet feature. The field applies to all pods in the range 0 to Replicas-1. That means if there is any unavailable pod in the range 0 to Replicas-1, it will be counted towards MaxUnavailable. */ maxUnavailable?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; /** * Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal Partition-1 to 0 remain untouched. This is helpful in being able to do a canary based deployment. The default value is 0. * @format int32 */ partition?: number; } /** * StatefulSet represents a set of pods with consistent identities. Identities are defined as: * - Network: A single stable DNS and hostname. * - Storage: As many VolumeClaims as requested. * * The StatefulSet guarantees that a given network identity will always map to the same storage identity. */ interface StatefulSet { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec defines the desired identities of pods in this set. */ spec?: io.k8s.api.apps.v1.StatefulSetSpec; /** Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. */ status?: io.k8s.api.apps.v1.StatefulSetStatus; } /** StatefulSetCondition describes the state of a statefulset at a certain point. */ interface StatefulSetCondition { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of statefulset condition. */ type: string; } /** StatefulSetList is a collection of StatefulSets. */ interface StatefulSetList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of stateful sets. */ items: io.k8s.api.apps.v1.StatefulSet[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet. */ interface StatefulSetOrdinals { /** * start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive movement of replicas from one StatefulSet to another. If set, replica indices will be in the range: * [.spec.ordinals.start, .spec.ordinals.start + .spec.replicas). * If unset, defaults to 0. Replica indices will be in the range: * [0, .spec.replicas). * @format int32 */ start?: number; } /** StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates. */ interface StatefulSetPersistentVolumeClaimRetentionPolicy { /** WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet deletion. The `Delete` policy causes those PVCs to be deleted. */ whenDeleted?: string; /** WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a scaledown. The `Delete` policy causes the associated PVCs for any excess pods above the replica count to be deleted. */ whenScaled?: string; } /** A StatefulSetSpec is the specification of a StatefulSet. */ interface StatefulSetSpec { /** * Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) * @format int32 */ minReadySeconds?: number; /** ordinals controls the numbering of replica indices in a StatefulSet. The default ordinals behavior assigns a "0" index to the first replica and increments the index by one for each additional replica requested. Using the ordinals field requires the StatefulSetStartOrdinal feature gate to be enabled, which is beta. */ ordinals?: io.k8s.api.apps.v1.StatefulSetOrdinals; /** persistentVolumeClaimRetentionPolicy describes the lifecycle of persistent volume claims created from volumeClaimTemplates. By default, all persistent volume claims are created as needed and retained until manually deleted. This policy allows the lifecycle to be altered, for example by deleting persistent volume claims when their stateful set is deleted, or when their pod is scaled down. This requires the StatefulSetAutoDeletePVC feature gate to be enabled, which is alpha. +optional */ persistentVolumeClaimRetentionPolicy?: io.k8s.api.apps.v1.StatefulSetPersistentVolumeClaimRetentionPolicy; /** podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. */ podManagementPolicy?: string; /** * replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. * @format int32 */ replicas?: number; /** * revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. * @format int32 */ revisionHistoryLimit?: number; /** selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors */ selector: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. */ serviceName: string; /** template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. Each pod will be named with the format -. For example, a pod in a StatefulSet named "web" with index number "3" would be named "web-3". The only allowed template.spec.restartPolicy value is "Always". */ template: io.k8s.api.core.v1.PodTemplateSpec; /** updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. */ updateStrategy?: io.k8s.api.apps.v1.StatefulSetUpdateStrategy; /** volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. */ volumeClaimTemplates?: io.k8s.api.core.v1.PersistentVolumeClaim[]; } /** StatefulSetStatus represents the current state of a StatefulSet. */ interface StatefulSetStatus { /** * Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset. * @format int32 */ availableReplicas?: number; /** * collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. * @format int32 */ collisionCount?: number; /** Represents the latest available observations of a statefulset's current state. */ conditions?: io.k8s.api.apps.v1.StatefulSetCondition[]; /** * currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision. * @format int32 */ currentReplicas?: number; /** currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas). */ currentRevision?: string; /** * observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server. * @format int64 */ observedGeneration?: number; /** * readyReplicas is the number of pods created for this StatefulSet with a Ready Condition. * @format int32 */ readyReplicas?: number; /** * replicas is the number of Pods created by the StatefulSet controller. * @format int32 */ replicas: number; /** updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas) */ updateRevision?: string; /** * updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. * @format int32 */ updatedReplicas?: number; } /** StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy. */ interface StatefulSetUpdateStrategy { /** RollingUpdate is used to communicate parameters when Type is RollingUpdateStatefulSetStrategyType. */ rollingUpdate?: io.k8s.api.apps.v1.RollingUpdateStatefulSetStrategy; /** Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate. */ type?: string; } } export declare namespace io.k8s.api.authentication.v1alpha1 { /** SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase. */ interface SelfSubjectReview { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Status is filled in by the server with the user attributes. */ status?: io.k8s.api.authentication.v1alpha1.SelfSubjectReviewStatus; } /** SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user. */ interface SelfSubjectReviewStatus { /** User attributes of the user making this request. */ userInfo?: io.k8s.api.authentication.v1.UserInfo; } } export declare namespace io.k8s.api.authentication.v1beta1 { /** SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase. */ interface SelfSubjectReview { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Status is filled in by the server with the user attributes. */ status?: io.k8s.api.authentication.v1beta1.SelfSubjectReviewStatus; } /** SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user. */ interface SelfSubjectReviewStatus { /** User attributes of the user making this request. */ userInfo?: io.k8s.api.authentication.v1.UserInfo; } } export declare namespace io.k8s.api.authorization.v1 { /** LocalSubjectAccessReview checks whether or not a user or group can perform an action in a given namespace. Having a namespace scoped resource makes it much easier to grant namespace scoped policy that includes permissions checking. */ interface LocalSubjectAccessReview { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. */ spec: io.k8s.api.authorization.v1.SubjectAccessReviewSpec; /** Status is filled in by the server and indicates whether the request is allowed or not */ status?: io.k8s.api.authorization.v1.SubjectAccessReviewStatus; } /** NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface */ interface NonResourceAttributes { /** Path is the URL path of the request */ path?: string; /** Verb is the standard HTTP verb */ verb?: string; } /** NonResourceRule holds information that describes a rule for the non-resource */ interface NonResourceRule { /** NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all. */ nonResourceURLs?: string[]; /** Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all. */ verbs: string[]; } /** ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface */ interface ResourceAttributes { /** Group is the API Group of the Resource. "*" means all. */ group?: string; /** Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. */ name?: string; /** Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview */ namespace?: string; /** Resource is one of the existing resource types. "*" means all. */ resource?: string; /** Subresource is one of the existing resource types. "" means none. */ subresource?: string; /** Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. */ verb?: string; /** Version is the API Version of the Resource. "*" means all. */ version?: string; } /** ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. */ interface ResourceRule { /** APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all. */ apiGroups?: string[]; /** ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all. */ resourceNames?: string[]; /** * Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups. * "*\//foo" represents the subresource 'foo' for all resources in the specified apiGroups. */ resources?: string[]; /** Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all. */ verbs: string[]; } /** SelfSubjectAccessReview checks whether or the current user can perform an action. Not filling in a spec.namespace means "in all namespaces". Self is a special case, because users should always be able to check whether they can perform an action */ interface SelfSubjectAccessReview { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec holds information about the request being evaluated. user and groups must be empty */ spec: io.k8s.api.authorization.v1.SelfSubjectAccessReviewSpec; /** Status is filled in by the server and indicates whether the request is allowed or not */ status?: io.k8s.api.authorization.v1.SubjectAccessReviewStatus; } /** SelfSubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set */ interface SelfSubjectAccessReviewSpec { /** NonResourceAttributes describes information for a non-resource access request */ nonResourceAttributes?: io.k8s.api.authorization.v1.NonResourceAttributes; /** ResourceAuthorizationAttributes describes information for a resource access request */ resourceAttributes?: io.k8s.api.authorization.v1.ResourceAttributes; } /** SelfSubjectRulesReview enumerates the set of actions the current user can perform within a namespace. The returned list of actions may be incomplete depending on the server's authorization mode, and any errors experienced during the evaluation. SelfSubjectRulesReview should be used by UIs to show/hide actions, or to quickly let an end user reason about their permissions. It should NOT Be used by external systems to drive authorization decisions as this raises confused deputy, cache lifetime/revocation, and correctness concerns. SubjectAccessReview, and LocalAccessReview are the correct way to defer authorization decisions to the API server. */ interface SelfSubjectRulesReview { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec holds information about the request being evaluated. */ spec: io.k8s.api.authorization.v1.SelfSubjectRulesReviewSpec; /** Status is filled in by the server and indicates the set of actions a user can perform. */ status?: io.k8s.api.authorization.v1.SubjectRulesReviewStatus; } /** SelfSubjectRulesReviewSpec defines the specification for SelfSubjectRulesReview. */ interface SelfSubjectRulesReviewSpec { /** Namespace to evaluate rules for. Required. */ namespace?: string; } /** SubjectAccessReview checks whether or not a user or group can perform an action. */ interface SubjectAccessReview { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec holds information about the request being evaluated */ spec: io.k8s.api.authorization.v1.SubjectAccessReviewSpec; /** Status is filled in by the server and indicates whether the request is allowed or not */ status?: io.k8s.api.authorization.v1.SubjectAccessReviewStatus; } /** SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAuthorizationAttributes and NonResourceAuthorizationAttributes must be set */ interface SubjectAccessReviewSpec { /** Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. */ extra?: Record; /** Groups is the groups you're testing for. */ groups?: string[]; /** NonResourceAttributes describes information for a non-resource access request */ nonResourceAttributes?: io.k8s.api.authorization.v1.NonResourceAttributes; /** ResourceAuthorizationAttributes describes information for a resource access request */ resourceAttributes?: io.k8s.api.authorization.v1.ResourceAttributes; /** UID information about the requesting user. */ uid?: string; /** User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups */ user?: string; } /** SubjectAccessReviewStatus */ interface SubjectAccessReviewStatus { /** Allowed is required. True if the action would be allowed, false otherwise. */ allowed: boolean; /** Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true. */ denied?: boolean; /** EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request. */ evaluationError?: string; /** Reason is optional. It indicates why a request was allowed or denied. */ reason?: string; } /** SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete. */ interface SubjectRulesReviewStatus { /** EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete. */ evaluationError?: string; /** Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation. */ incomplete: boolean; /** NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. */ nonResourceRules: io.k8s.api.authorization.v1.NonResourceRule[]; /** ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. */ resourceRules: io.k8s.api.authorization.v1.ResourceRule[]; } } export declare namespace io.k8s.api.autoscaling.v2 { /** ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. */ interface ContainerResourceMetricSource { /** container is the name of the container in the pods of the scaling target */ container: string; /** name is the name of the resource in question. */ name: string; /** target specifies the target value for the given metric */ target: io.k8s.api.autoscaling.v2.MetricTarget; } /** ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. */ interface ContainerResourceMetricStatus { /** container is the name of the container in the pods of the scaling target */ container: string; /** current contains the current value for the given metric */ current: io.k8s.api.autoscaling.v2.MetricValueStatus; /** name is the name of the resource in question. */ name: string; } /** CrossVersionObjectReference contains enough information to let you identify the referred resource. */ interface CrossVersionObjectReference { /** apiVersion is the API version of the referent */ apiVersion?: string; /** kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind: string; /** name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). */ interface ExternalMetricSource { /** metric identifies the target metric by name and selector */ metric: io.k8s.api.autoscaling.v2.MetricIdentifier; /** target specifies the target value for the given metric */ target: io.k8s.api.autoscaling.v2.MetricTarget; } /** ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object. */ interface ExternalMetricStatus { /** current contains the current value for the given metric */ current: io.k8s.api.autoscaling.v2.MetricValueStatus; /** metric identifies the target metric by name and selector */ metric: io.k8s.api.autoscaling.v2.MetricIdentifier; } /** HPAScalingPolicy is a single policy which must hold true for a specified past interval. */ interface HPAScalingPolicy { /** * periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). * @format int32 */ periodSeconds: number; /** type is used to specify the scaling policy. */ type: string; /** * value contains the amount of change which is permitted by the policy. It must be greater than zero * @format int32 */ value: number; } /** HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen. */ interface HPAScalingRules { /** policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid */ policies?: io.k8s.api.autoscaling.v2.HPAScalingPolicy[]; /** selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. */ selectPolicy?: string; /** * stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). * @format int32 */ stabilizationWindowSeconds?: number; } /** HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified. */ interface HorizontalPodAutoscaler { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. */ spec?: io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerSpec; /** status is the current information about the autoscaler. */ status?: io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerStatus; } /** HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). */ interface HorizontalPodAutoscalerBehavior { /** scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). */ scaleDown?: io.k8s.api.autoscaling.v2.HPAScalingRules; /** * scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * * increase no more than 4 pods per 60 seconds * * double the number of pods per 60 seconds * No stabilization is used. */ scaleUp?: io.k8s.api.autoscaling.v2.HPAScalingRules; } /** HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point. */ interface HorizontalPodAutoscalerCondition { /** lastTransitionTime is the last time the condition transitioned from one status to another */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** message is a human-readable explanation containing details about the transition */ message?: string; /** reason is the reason for the condition's last transition. */ reason?: string; /** status is the status of the condition (True, False, Unknown) */ status: string; /** type describes the current condition */ type: string; } /** HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects. */ interface HorizontalPodAutoscalerList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of horizontal pod autoscaler objects. */ items: io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** metadata is the standard list metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler. */ interface HorizontalPodAutoscalerSpec { /** behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used. */ behavior?: io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerBehavior; /** * maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. * @format int32 */ maxReplicas: number; /** metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization. */ metrics?: io.k8s.api.autoscaling.v2.MetricSpec[]; /** * minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. * @format int32 */ minReplicas?: number; /** scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. */ scaleTargetRef: io.k8s.api.autoscaling.v2.CrossVersionObjectReference; } /** HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler. */ interface HorizontalPodAutoscalerStatus { /** conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. */ conditions?: io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerCondition[]; /** currentMetrics is the last read state of the metrics used by this autoscaler. */ currentMetrics?: io.k8s.api.autoscaling.v2.MetricStatus[]; /** * currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. * @format int32 */ currentReplicas?: number; /** * desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. * @format int32 */ desiredReplicas: number; /** lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed. */ lastScaleTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** * observedGeneration is the most recent generation observed by this autoscaler. * @format int64 */ observedGeneration?: number; } /** MetricIdentifier defines the name and optionally selector for a metric */ interface MetricIdentifier { /** name is the name of the given metric */ name: string; /** selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. */ selector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; } /** MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once). */ interface MetricSpec { /** containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. */ containerResource?: io.k8s.api.autoscaling.v2.ContainerResourceMetricSource; /** external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). */ external?: io.k8s.api.autoscaling.v2.ExternalMetricSource; /** object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). */ object?: io.k8s.api.autoscaling.v2.ObjectMetricSource; /** pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. */ pods?: io.k8s.api.autoscaling.v2.PodsMetricSource; /** resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. */ resource?: io.k8s.api.autoscaling.v2.ResourceMetricSource; /** type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled */ type: string; } /** MetricStatus describes the last-read state of a single metric. */ interface MetricStatus { /** container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. */ containerResource?: io.k8s.api.autoscaling.v2.ContainerResourceMetricStatus; /** external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). */ external?: io.k8s.api.autoscaling.v2.ExternalMetricStatus; /** object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). */ object?: io.k8s.api.autoscaling.v2.ObjectMetricStatus; /** pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. */ pods?: io.k8s.api.autoscaling.v2.PodsMetricStatus; /** resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. */ resource?: io.k8s.api.autoscaling.v2.ResourceMetricStatus; /** type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled */ type: string; } /** MetricTarget defines the target value, average value, or average utilization of a specific metric */ interface MetricTarget { /** * averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type * @format int32 */ averageUtilization?: number; /** averageValue is the target value of the average of the metric across all relevant pods (as a quantity) */ averageValue?: io.k8s.apimachinery.pkg.api.resource.Quantity; /** type represents whether the metric type is Utilization, Value, or AverageValue */ type: string; /** value is the target value of the metric (as a quantity). */ value?: io.k8s.apimachinery.pkg.api.resource.Quantity; } /** MetricValueStatus holds the current value for a metric */ interface MetricValueStatus { /** * currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. * @format int32 */ averageUtilization?: number; /** averageValue is the current value of the average of the metric across all relevant pods (as a quantity) */ averageValue?: io.k8s.apimachinery.pkg.api.resource.Quantity; /** value is the current value of the metric (as a quantity). */ value?: io.k8s.apimachinery.pkg.api.resource.Quantity; } /** ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). */ interface ObjectMetricSource { /** describedObject specifies the descriptions of a object,such as kind,name apiVersion */ describedObject: io.k8s.api.autoscaling.v2.CrossVersionObjectReference; /** metric identifies the target metric by name and selector */ metric: io.k8s.api.autoscaling.v2.MetricIdentifier; /** target specifies the target value for the given metric */ target: io.k8s.api.autoscaling.v2.MetricTarget; } /** ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object). */ interface ObjectMetricStatus { /** current contains the current value for the given metric */ current: io.k8s.api.autoscaling.v2.MetricValueStatus; /** DescribedObject specifies the descriptions of a object,such as kind,name apiVersion */ describedObject: io.k8s.api.autoscaling.v2.CrossVersionObjectReference; /** metric identifies the target metric by name and selector */ metric: io.k8s.api.autoscaling.v2.MetricIdentifier; } /** PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. */ interface PodsMetricSource { /** metric identifies the target metric by name and selector */ metric: io.k8s.api.autoscaling.v2.MetricIdentifier; /** target specifies the target value for the given metric */ target: io.k8s.api.autoscaling.v2.MetricTarget; } /** PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second). */ interface PodsMetricStatus { /** current contains the current value for the given metric */ current: io.k8s.api.autoscaling.v2.MetricValueStatus; /** metric identifies the target metric by name and selector */ metric: io.k8s.api.autoscaling.v2.MetricIdentifier; } /** ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set. */ interface ResourceMetricSource { /** name is the name of the resource in question. */ name: string; /** target specifies the target value for the given metric */ target: io.k8s.api.autoscaling.v2.MetricTarget; } /** ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. */ interface ResourceMetricStatus { /** current contains the current value for the given metric */ current: io.k8s.api.autoscaling.v2.MetricValueStatus; /** name is the name of the resource in question. */ name: string; } } export declare namespace io.k8s.api.batch.v1 { /** CronJob represents the configuration of a single cron job. */ interface CronJob { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.batch.v1.CronJobSpec; /** Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.batch.v1.CronJobStatus; } /** CronJobList is a collection of cron jobs. */ interface CronJobList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of CronJobs. */ items: io.k8s.api.batch.v1.CronJob[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** CronJobSpec describes how the job execution will look like and when it will actually run. */ interface CronJobSpec { /** * Specifies how to treat concurrent executions of a Job. Valid values are: * * - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one */ concurrencyPolicy?: string; /** * The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1. * @format int32 */ failedJobsHistoryLimit?: number; /** Specifies the job that will be created when executing a CronJob. */ jobTemplate: io.k8s.api.batch.v1.JobTemplateSpec; /** The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. */ schedule: string; /** * Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. * @format int64 */ startingDeadlineSeconds?: number; /** * The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3. * @format int32 */ successfulJobsHistoryLimit?: number; /** This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. */ suspend?: boolean; /** The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager process. The set of valid time zone names and the time zone offset is loaded from the system-wide time zone database by the API server during CronJob validation and the controller manager during execution. If no system-wide time zone database can be found a bundled version of the database is used instead. If the time zone name becomes invalid during the lifetime of a CronJob or due to a change in host configuration, the controller will stop creating new new Jobs and will create a system event with the reason UnknownTimeZone. More information can be found in https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/#time-zones */ timeZone?: string; } /** CronJobStatus represents the current state of a cron job. */ interface CronJobStatus { /** A list of pointers to currently running jobs. */ active?: io.k8s.api.core.v1.ObjectReference[]; /** Information when was the last time the job was successfully scheduled. */ lastScheduleTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Information when was the last time the job successfully completed. */ lastSuccessfulTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; } /** Job represents the configuration of a single job. */ interface Job { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.batch.v1.JobSpec; /** Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.batch.v1.JobStatus; } /** JobCondition describes current state of a job. */ interface JobCondition { /** Last time the condition was checked. */ lastProbeTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Last time the condition transit from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** Human readable message indicating details about last transition. */ message?: string; /** (brief) reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of job condition, Complete or Failed. */ type: string; } /** JobList is a collection of jobs. */ interface JobList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of Jobs. */ items: io.k8s.api.batch.v1.Job[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** JobSpec describes how the job execution will look like. */ interface JobSpec { /** * Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. * @format int64 */ activeDeadlineSeconds?: number; /** * Specifies the number of retries before marking this job failed. Defaults to 6 * @format int32 */ backoffLimit?: number; /** * Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable. This field is alpha-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (disabled by default). * @format int32 */ backoffLimitPerIndex?: number; /** * completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. * * `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. * * `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`. * * More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job. */ completionMode?: string; /** * Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ * @format int32 */ completions?: number; /** manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector */ manualSelector?: boolean; /** * Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. This field is alpha-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (disabled by default). * @format int32 */ maxFailedIndexes?: number; /** * Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ * @format int32 */ parallelism?: number; /** * Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs's .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure. * * This field is beta-level. It can be used when the `JobPodFailurePolicy` feature gate is enabled (enabled by default). */ podFailurePolicy?: io.k8s.api.batch.v1.PodFailurePolicy; /** * podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods * when they are terminating (has a metadata.deletionTimestamp) or failed. * - Failed means to wait until a previously created Pod is fully terminated (has phase * Failed or Succeeded) before creating a replacement Pod. * * When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an alpha field. Enable JobPodReplacementPolicy to be able to use this field. */ podReplacementPolicy?: string; /** A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors */ selector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false. */ suspend?: boolean; /** Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ */ template: io.k8s.api.core.v1.PodTemplateSpec; /** * ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. * @format int32 */ ttlSecondsAfterFinished?: number; } /** JobStatus represents the current state of a Job. */ interface JobStatus { /** * The number of pending and running pods. * @format int32 */ active?: number; /** completedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the completed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". */ completedIndexes?: string; /** Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully. */ completionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will have type "Suspended" and status true; when the Job is resumed, the status of this condition will become false. When a Job is completed, one of the conditions will have type "Complete" and status true. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ */ conditions?: io.k8s.api.batch.v1.JobCondition[]; /** * The number of pods which reached phase Failed. * @format int32 */ failed?: number; /** FailedIndexes holds the failed indexes when backoffLimitPerIndex=true. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as decimal integers separated by commas. The numbers are listed in increasing order. Three or more consecutive numbers are compressed and represented by the first and last element of the series, separated by a hyphen. For example, if the failed indexes are 1, 3, 4, 5 and 7, they are represented as "1,3-5,7". This field is alpha-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (disabled by default). */ failedIndexes?: string; /** * The number of pods which have a Ready condition. * * This field is beta-level. The job controller populates the field when the feature gate JobReadyPods is enabled (enabled by default). * @format int32 */ ready?: number; /** Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every time a Job is resumed from suspension. It is represented in RFC3339 form and is in UTC. */ startTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** * The number of pods which reached phase Succeeded. * @format int32 */ succeeded?: number; /** * The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp). * * This field is alpha-level. The job controller populates the field when the feature gate JobPodReplacementPolicy is enabled (disabled by default). * @format int32 */ terminating?: number; /** * uncountedTerminatedPods holds the UIDs of Pods that have terminated but the job controller hasn't yet accounted for in the status counters. * * The job controller creates pods with a finalizer. When a pod terminates (succeeded or failed), the controller does three steps to account for it in the job status: * * 1. Add the pod UID to the arrays in this field. 2. Remove the pod finalizer. 3. Remove the pod UID from the arrays while increasing the corresponding * counter. * * Old jobs might not be tracked using this field, in which case the field remains null. */ uncountedTerminatedPods?: io.k8s.api.batch.v1.UncountedTerminatedPods; } /** JobTemplateSpec describes the data a Job should have when created from a template */ interface JobTemplateSpec { /** Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.batch.v1.JobSpec; } /** PodFailurePolicy describes how failed pods influence the backoffLimit. */ interface PodFailurePolicy { /** A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed. */ rules: io.k8s.api.batch.v1.PodFailurePolicyRule[]; } /** PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check. */ interface PodFailurePolicyOnExitCodesRequirement { /** Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template. */ containerName?: string; /** * Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are: * * - In: the requirement is satisfied if at least one container exit code * (might be multiple if there are multiple containers not restricted * by the 'containerName' field) is in the set of specified values. * - NotIn: the requirement is satisfied if at least one container exit code * (might be multiple if there are multiple containers not restricted * by the 'containerName' field) is not in the set of specified values. * Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied. */ operator: string; /** Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value '0' cannot be used for the In operator. At least one element is required. At most 255 elements are allowed. */ values: number[]; } /** PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type. */ interface PodFailurePolicyOnPodConditionsPattern { /** Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True. */ status: string; /** Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type. */ type: string; } /** PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule. */ interface PodFailurePolicyRule { /** * Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are: * * - FailJob: indicates that the pod's job is marked as Failed and all * running pods are terminated. * - FailIndex: indicates that the pod's index is marked as Failed and will * not be restarted. * This value is alpha-level. It can be used when the * `JobBackoffLimitPerIndex` feature gate is enabled (disabled by default). * - Ignore: indicates that the counter towards the .backoffLimit is not * incremented and a replacement pod is created. * - Count: indicates that the pod is handled in the default way - the * counter towards the .backoffLimit is incremented. * Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule. */ action: string; /** Represents the requirement on the container exit codes. */ onExitCodes?: io.k8s.api.batch.v1.PodFailurePolicyOnExitCodesRequirement; /** Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed. */ onPodConditions?: io.k8s.api.batch.v1.PodFailurePolicyOnPodConditionsPattern[]; } /** UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters. */ interface UncountedTerminatedPods { /** failed holds UIDs of failed Pods. */ failed?: string[]; /** succeeded holds UIDs of succeeded Pods. */ succeeded?: string[]; } } export declare namespace io.k8s.api.certificates.v1 { /** * CertificateSigningRequest objects provide a mechanism to obtain x509 certificates by submitting a certificate signing request, and having it asynchronously approved and issued. * * Kubelets use this API to obtain: * 1. client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client-kubelet" signerName). * 2. serving certificates for TLS endpoints kube-apiserver can connect to securely (with the "kubernetes.io/kubelet-serving" signerName). * * This API can be used to request client certificates to authenticate to kube-apiserver (with the "kubernetes.io/kube-apiserver-client" signerName), or to obtain certificates from custom non-Kubernetes signers. */ interface CertificateSigningRequest { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec contains the certificate request, and is immutable after creation. Only the request, signerName, expirationSeconds, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users. */ spec: io.k8s.api.certificates.v1.CertificateSigningRequestSpec; /** status contains information about whether the request is approved or denied, and the certificate issued by the signer, or the failure condition indicating signer failure. */ status?: io.k8s.api.certificates.v1.CertificateSigningRequestStatus; } /** CertificateSigningRequestCondition describes a condition of a CertificateSigningRequest object */ interface CertificateSigningRequestCondition { /** lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** lastUpdateTime is the time of the last update to this condition */ lastUpdateTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** message contains a human readable message with details about the request state */ message?: string; /** reason indicates a brief reason for the request state */ reason?: string; /** status of the condition, one of True, False, Unknown. Approved, Denied, and Failed conditions may not be "False" or "Unknown". */ status: string; /** * type of the condition. Known conditions are "Approved", "Denied", and "Failed". * * An "Approved" condition is added via the /approval subresource, indicating the request was approved and should be issued by the signer. * * A "Denied" condition is added via the /approval subresource, indicating the request was denied and should not be issued by the signer. * * A "Failed" condition is added via the /status subresource, indicating the signer failed to issue the certificate. * * Approved and Denied conditions are mutually exclusive. Approved, Denied, and Failed conditions cannot be removed once added. * * Only one condition of a given type is allowed. */ type: string; } /** CertificateSigningRequestList is a collection of CertificateSigningRequest objects */ interface CertificateSigningRequestList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is a collection of CertificateSigningRequest objects */ items: io.k8s.api.certificates.v1.CertificateSigningRequest[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** CertificateSigningRequestSpec contains the certificate request. */ interface CertificateSigningRequestSpec { /** * expirationSeconds is the requested duration of validity of the issued certificate. The certificate signer may issue a certificate with a different validity duration so a client must check the delta between the notBefore and and notAfter fields in the issued certificate to determine the actual duration. * * The v1.22+ in-tree implementations of the well-known Kubernetes signers will honor this field as long as the requested duration is not greater than the maximum duration they will honor per the --cluster-signing-duration CLI flag to the Kubernetes controller manager. * * Certificate signers may not honor this field for various reasons: * * 1. Old signer that is unaware of the field (such as the in-tree * implementations prior to v1.22) * 2. Signer whose configured maximum is shorter than the requested duration * 3. Signer whose configured minimum is longer than the requested duration * * The minimum valid value for expirationSeconds is 600, i.e. 10 minutes. * @format int32 */ expirationSeconds?: number; /** extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. */ extra?: Record; /** groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. */ groups?: string[]; /** * request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded. * @format byte */ request: string; /** * signerName indicates the requested signer, and is a qualified name. * * List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector. * * Well-known Kubernetes signers are: * 1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. * Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager. * 2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. * Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. * 3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. * Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. * * More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers * * Custom signerNames can also be specified. The signer defines: * 1. Trust distribution: how trust (CA bundles) are distributed. * 2. Permitted subjects: and behavior when a disallowed subject is requested. * 3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested. * 4. Required, permitted, or forbidden key usages / extended key usages. * 5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin. * 6. Whether or not requests for CA certificates are allowed. */ signerName: string; /** uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. */ uid?: string; /** * usages specifies a set of key usages requested in the issued certificate. * * Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth". * * Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth". * * Valid values are: * "signing", "digital signature", "content commitment", * "key encipherment", "key agreement", "data encipherment", * "cert sign", "crl sign", "encipher only", "decipher only", "any", * "server auth", "client auth", * "code signing", "email protection", "s/mime", * "ipsec end system", "ipsec tunnel", "ipsec user", * "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc" */ usages?: string[]; /** username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. */ username?: string; } /** CertificateSigningRequestStatus contains conditions used to indicate approved/denied/failed status of the request, and the issued certificate. */ interface CertificateSigningRequestStatus { /** * certificate is populated with an issued certificate by the signer after an Approved condition is present. This field is set via the /status subresource. Once populated, this field is immutable. * * If the certificate signing request is denied, a condition of type "Denied" is added and this field remains empty. If the signer cannot issue the certificate, a condition of type "Failed" is added and this field remains empty. * * Validation requirements: * 1. certificate must contain one or more PEM blocks. * 2. All PEM blocks must have the "CERTIFICATE" label, contain no headers, and the encoded data * must be a BER-encoded ASN.1 Certificate structure as described in section 4 of RFC5280. * 3. Non-PEM content may appear before or after the "CERTIFICATE" PEM blocks and is unvalidated, * to allow for explanatory text as described in section 5.2 of RFC7468. * * If more than one PEM block is present, and the definition of the requested spec.signerName does not indicate otherwise, the first block is the issued certificate, and subsequent blocks should be treated as intermediate certificates and presented in TLS handshakes. * * The certificate is encoded in PEM format. * * When serialized as JSON or YAML, the data is additionally base64-encoded, so it consists of: * * base64( * -----BEGIN CERTIFICATE----- * ... * -----END CERTIFICATE----- * ) * @format byte */ certificate?: string; /** conditions applied to the request. Known conditions are "Approved", "Denied", and "Failed". */ conditions?: io.k8s.api.certificates.v1.CertificateSigningRequestCondition[]; } } export declare namespace io.k8s.api.certificates.v1alpha1 { /** * ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates). * * ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the `clusterTrustBundle` projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to. * * It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle. */ interface ClusterTrustBundle { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** metadata contains the object metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec contains the signer (if any) and trust anchors. */ spec: io.k8s.api.certificates.v1alpha1.ClusterTrustBundleSpec; } /** ClusterTrustBundleList is a collection of ClusterTrustBundle objects */ interface ClusterTrustBundleList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is a collection of ClusterTrustBundle objects */ items: io.k8s.api.certificates.v1alpha1.ClusterTrustBundle[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** metadata contains the list metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ClusterTrustBundleSpec contains the signer and trust anchors. */ interface ClusterTrustBundleSpec { /** * signerName indicates the associated signer, if any. * * In order to create or update a ClusterTrustBundle that sets signerName, you must have the following cluster-scoped permission: group=certificates.k8s.io resource=signers resourceName= verb=attest. * * If signerName is not empty, then the ClusterTrustBundle object must be named with the signer name as a prefix (translating slashes to colons). For example, for the signer name `example.com/foo`, valid ClusterTrustBundle object names include `example.com:foo:abc` and `example.com:foo:v1`. * * If signerName is empty, then the ClusterTrustBundle object's name must not have such a prefix. * * List/watch requests for ClusterTrustBundles can filter on this field using a `spec.signerName=NAME` field selector. */ signerName?: string; /** * trustBundle contains the individual X.509 trust anchors for this bundle, as PEM bundle of PEM-wrapped, DER-formatted X.509 certificates. * * The data must consist only of PEM certificate blocks that parse as valid X.509 certificates. Each certificate must include a basic constraints extension with the CA bit set. The API server will reject objects that contain duplicate certificates, or that use PEM block headers. * * Users of ClusterTrustBundles, including Kubelet, are free to reorder and deduplicate certificate blocks in this file according to their own logic, as well as to drop PEM block headers and inter-block data. */ trustBundle: string; } } export declare namespace io.k8s.api.coordination.v1 { /** Lease defines a lease concept. */ interface Lease { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec contains the specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.coordination.v1.LeaseSpec; } /** LeaseList is a list of Lease objects. */ interface LeaseList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is a list of schema objects. */ items: io.k8s.api.coordination.v1.Lease[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** LeaseSpec is a specification of a Lease. */ interface LeaseSpec { /** acquireTime is a time when the current lease was acquired. */ acquireTime?: io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime; /** holderIdentity contains the identity of the holder of a current lease. */ holderIdentity?: string; /** * leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed renewTime. * @format int32 */ leaseDurationSeconds?: number; /** * leaseTransitions is the number of transitions of a lease between holders. * @format int32 */ leaseTransitions?: number; /** renewTime is a time when the current holder of a lease has last updated the lease. */ renewTime?: io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime; } } export declare namespace io.k8s.api.discovery.v1 { /** Endpoint represents a single logical "backend" implementing a service. */ interface Endpoint { /** addresses of this endpoint. The contents of this field are interpreted according to the corresponding EndpointSlice addressType field. Consumers must handle different types of addresses in the context of their own capabilities. This must contain at least one address but no more than 100. These are all assumed to be fungible and clients may choose to only use the first element. Refer to: https://issue.k8s.io/106267 */ addresses: string[]; /** conditions contains information about the current status of the endpoint. */ conditions?: io.k8s.api.discovery.v1.EndpointConditions; /** deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this field can hold values, it is not writable through the v1 API, and any attempts to write to it will be silently ignored. Topology information can be found in the zone and nodeName fields instead. */ deprecatedTopology?: Record; /** hints contains information associated with how an endpoint should be consumed. */ hints?: io.k8s.api.discovery.v1.EndpointHints; /** hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be considered fungible (e.g. multiple A values in DNS). Must be lowercase and pass DNS Label (RFC 1123) validation. */ hostname?: string; /** nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node. */ nodeName?: string; /** targetRef is a reference to a Kubernetes object that represents this endpoint. */ targetRef?: io.k8s.api.core.v1.ObjectReference; /** zone is the name of the Zone this endpoint exists in. */ zone?: string; } /** EndpointConditions represents the current condition of an endpoint. */ interface EndpointConditions { /** ready indicates that this endpoint is prepared to receive traffic, according to whatever system is managing the endpoint. A nil value indicates an unknown state. In most cases consumers should interpret this unknown state as ready. For compatibility reasons, ready should never be "true" for terminating endpoints, except when the normal readiness behavior is being explicitly overridden, for example when the associated Service has set the publishNotReadyAddresses flag. */ ready?: boolean; /** serving is identical to ready except that it is set regardless of the terminating state of endpoints. This condition should be set to true for a ready endpoint that is terminating. If nil, consumers should defer to the ready condition. */ serving?: boolean; /** terminating indicates that this endpoint is terminating. A nil value indicates an unknown state. Consumers should interpret this unknown state to mean that the endpoint is not terminating. */ terminating?: boolean; } /** EndpointHints provides hints describing how an endpoint should be consumed. */ interface EndpointHints { /** forZones indicates the zone(s) this endpoint should be consumed by to enable topology aware routing. */ forZones?: io.k8s.api.discovery.v1.ForZone[]; } /** EndpointPort represents a Port used by an EndpointSlice */ interface EndpointPort { /** * The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax. Valid values are either: * * * Un-prefixed protocol names - reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). * * * Kubernetes-defined prefixed names: * * 'kubernetes.io/h2c' - HTTP/2 over cleartext as described in https://www.rfc-editor.org/rfc/rfc7540 * * 'kubernetes.io/ws' - WebSocket over cleartext as described in https://www.rfc-editor.org/rfc/rfc6455 * * 'kubernetes.io/wss' - WebSocket over TLS as described in https://www.rfc-editor.org/rfc/rfc6455 * * * Other protocols should use implementation-defined prefixed names such as mycompany.com/my-custom-protocol. */ appProtocol?: string; /** name represents the name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string. */ name?: string; /** * port represents the port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer. * @format int32 */ port?: number; /** protocol represents the IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. */ protocol?: string; } /** EndpointSlice represents a subset of the endpoints that implement a service. For a given service there may be multiple EndpointSlice objects, selected by labels, which must be joined to produce the full set of endpoints. */ interface EndpointSlice { /** addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. */ addressType: string; /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints. */ endpoints: io.k8s.api.discovery.v1.Endpoint[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. */ ports?: io.k8s.api.discovery.v1.EndpointPort[]; } /** EndpointSliceList represents a list of endpoint slices */ interface EndpointSliceList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of endpoint slices */ items: io.k8s.api.discovery.v1.EndpointSlice[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ForZone provides information about which zones should consume this endpoint. */ interface ForZone { /** name represents the name of the zone. */ name: string; } } export declare namespace io.k8s.api.events.v1 { /** Event is a report of an event somewhere in the cluster. It generally denotes some state change in the system. Events have a limited retention time and triggers and messages may evolve with time. Event consumers should not rely on the timing of an event with a given Reason reflecting a consistent underlying trigger, or the continued existence of events with that Reason. Events should be treated as informative, best-effort, supplemental data. */ interface Event { /** action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters. */ action?: string; /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** * deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. * @format int32 */ deprecatedCount?: number; /** deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. */ deprecatedFirstTimestamp?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. */ deprecatedLastTimestamp?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. */ deprecatedSource?: io.k8s.api.core.v1.EventSource; /** eventTime is the time when this Event was first observed. It is required. */ eventTime: io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. */ note?: string; /** reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. */ reason?: string; /** regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. */ regarding?: io.k8s.api.core.v1.ObjectReference; /** related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. */ related?: io.k8s.api.core.v1.ObjectReference; /** reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. */ reportingController?: string; /** reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. */ reportingInstance?: string; /** series is data about the Event series this event represents or nil if it's a singleton Event. */ series?: io.k8s.api.events.v1.EventSeries; /** type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events. */ type?: string; } /** EventList is a list of Event objects. */ interface EventList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is a list of schema objects. */ items: io.k8s.api.events.v1.Event[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** EventSeries contain information on series of events, i.e. thing that was/is happening continuously for some time. How often to update the EventSeries is up to the event reporters. The default event reporter in "k8s.io/client-go/tools/events/event_broadcaster.go" shows how this struct is updated on heartbeats and can guide customized reporter implementations. */ interface EventSeries { /** * count is the number of occurrences in this series up to the last heartbeat time. * @format int32 */ count: number; /** lastObservedTime is the time when last Event from the series was seen before last heartbeat. */ lastObservedTime: io.k8s.apimachinery.pkg.apis.meta.v1.MicroTime; } } export declare namespace io.k8s.api.flowcontrol.v1beta2 { /** ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the `spec`. */ interface ExemptPriorityLevelConfiguration { /** * `lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. This value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level's LendableConcurrencyLimit (LendableCL), is defined as follows. * * LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 ) * @format int32 */ lendablePercent?: number; /** * `nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats nominally reserved for this priority level. This DOES NOT limit the dispatching from this priority level but affects the other priority levels through the borrowing mechanism. The server's concurrency limit (ServerCL) is divided among all the priority levels in proportion to their NCS values: * * NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k) * * Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. This field has a default value of zero. * @format int32 */ nominalConcurrencyShares?: number; } /** FlowDistinguisherMethod specifies the method of a flow distinguisher. */ interface FlowDistinguisherMethod { /** `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. */ type: string; } /** FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". */ interface FlowSchema { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.flowcontrol.v1beta2.FlowSchemaSpec; /** `status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.flowcontrol.v1beta2.FlowSchemaStatus; } /** FlowSchemaCondition describes conditions for a FlowSchema. */ interface FlowSchemaCondition { /** `lastTransitionTime` is the last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** `message` is a human-readable message indicating details about last transition. */ message?: string; /** `reason` is a unique, one-word, CamelCase reason for the condition's last transition. */ reason?: string; /** `status` is the status of the condition. Can be True, False, Unknown. Required. */ status?: string; /** `type` is the type of the condition. Required. */ type?: string; } /** FlowSchemaList is a list of FlowSchema objects. */ interface FlowSchemaList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** `items` is a list of FlowSchemas. */ items: io.k8s.api.flowcontrol.v1beta2.FlowSchema[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** FlowSchemaSpec describes how the FlowSchema's specification looks like. */ interface FlowSchemaSpec { /** `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string. */ distinguisherMethod?: io.k8s.api.flowcontrol.v1beta2.FlowDistinguisherMethod; /** * `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default. * @format int32 */ matchingPrecedence?: number; /** `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. */ priorityLevelConfiguration: io.k8s.api.flowcontrol.v1beta2.PriorityLevelConfigurationReference; /** `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. */ rules?: io.k8s.api.flowcontrol.v1beta2.PolicyRulesWithSubjects[]; } /** FlowSchemaStatus represents the current state of a FlowSchema. */ interface FlowSchemaStatus { /** `conditions` is a list of the current states of FlowSchema. */ conditions?: io.k8s.api.flowcontrol.v1beta2.FlowSchemaCondition[]; } /** GroupSubject holds detailed information for group-kind subject. */ interface GroupSubject { /** name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required. */ name: string; } /** LimitResponse defines how to handle requests that can not be executed right now. */ interface LimitResponse { /** `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`. */ queuing?: io.k8s.api.flowcontrol.v1beta2.QueuingConfiguration; /** `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. */ type: string; } /** * LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: * - How are requests for this priority level limited? * - What should be done with requests that exceed the limit? */ interface LimitedPriorityLevelConfiguration { /** * `assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level: * * ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) ) * * bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30. * @format int32 */ assuredConcurrencyShares?: number; /** * `borrowingLimitPercent`, if present, configures a limit on how many seats this priority level can borrow from other priority levels. The limit is known as this level's BorrowingConcurrencyLimit (BorrowingCL) and is a limit on the total number of seats that this level may borrow at any one time. This field holds the ratio of that limit to the level's nominal concurrency limit. When this field is non-nil, it must hold a non-negative integer and the limit is calculated as follows. * * BorrowingCL(i) = round( NominalCL(i) * borrowingLimitPercent(i)/100.0 ) * * The value of this field can be more than 100, implying that this priority level can borrow a number of seats that is greater than its own nominal concurrency limit (NominalCL). When this field is left `nil`, the limit is effectively infinite. * @format int32 */ borrowingLimitPercent?: number; /** * `lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. The value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level's LendableConcurrencyLimit (LendableCL), is defined as follows. * * LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 ) * @format int32 */ lendablePercent?: number; /** `limitResponse` indicates what to do with requests that can not be executed right now */ limitResponse?: io.k8s.api.flowcontrol.v1beta2.LimitResponse; } /** NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. */ interface NonResourcePolicyRule { /** * `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: * - "/healthz" is legal * - "/hea*" is illegal * - "/hea" is legal but matches nothing * - "/hea/*" also matches nothing * - "/healthz/*" matches all per-component health checks. * "*" matches all non-resource urls. if it is present, it must be the only entry. Required. */ nonResourceURLs: string[]; /** `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required. */ verbs: string[]; } /** PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. */ interface PolicyRulesWithSubjects { /** `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. */ nonResourceRules?: io.k8s.api.flowcontrol.v1beta2.NonResourcePolicyRule[]; /** `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty. */ resourceRules?: io.k8s.api.flowcontrol.v1beta2.ResourcePolicyRule[]; /** subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. */ subjects: io.k8s.api.flowcontrol.v1beta2.Subject[]; } /** PriorityLevelConfiguration represents the configuration of a priority level. */ interface PriorityLevelConfiguration { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.flowcontrol.v1beta2.PriorityLevelConfigurationSpec; /** `status` is the current status of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.flowcontrol.v1beta2.PriorityLevelConfigurationStatus; } /** PriorityLevelConfigurationCondition defines the condition of priority level. */ interface PriorityLevelConfigurationCondition { /** `lastTransitionTime` is the last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** `message` is a human-readable message indicating details about last transition. */ message?: string; /** `reason` is a unique, one-word, CamelCase reason for the condition's last transition. */ reason?: string; /** `status` is the status of the condition. Can be True, False, Unknown. Required. */ status?: string; /** `type` is the type of the condition. Required. */ type?: string; } /** PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. */ interface PriorityLevelConfigurationList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** `items` is a list of request-priorities. */ items: io.k8s.api.flowcontrol.v1beta2.PriorityLevelConfiguration[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PriorityLevelConfigurationReference contains information that points to the "request-priority" being used. */ interface PriorityLevelConfigurationReference { /** `name` is the name of the priority level configuration being referenced Required. */ name: string; } /** PriorityLevelConfigurationSpec specifies the configuration of a priority level. */ interface PriorityLevelConfigurationSpec { /** `exempt` specifies how requests are handled for an exempt priority level. This field MUST be empty if `type` is `"Limited"`. This field MAY be non-empty if `type` is `"Exempt"`. If empty and `type` is `"Exempt"` then the default values for `ExemptPriorityLevelConfiguration` apply. */ exempt?: io.k8s.api.flowcontrol.v1beta2.ExemptPriorityLevelConfiguration; /** `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. */ limited?: io.k8s.api.flowcontrol.v1beta2.LimitedPriorityLevelConfiguration; /** `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. */ type: string; } /** PriorityLevelConfigurationStatus represents the current state of a "request-priority". */ interface PriorityLevelConfigurationStatus { /** `conditions` is the current state of "request-priority". */ conditions?: io.k8s.api.flowcontrol.v1beta2.PriorityLevelConfigurationCondition[]; } /** QueuingConfiguration holds the configuration parameters for queuing */ interface QueuingConfiguration { /** * `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8. * @format int32 */ handSize?: number; /** * `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50. * @format int32 */ queueLengthLimit?: number; /** * `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. * @format int32 */ queues?: number; } /** ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e., `Namespace==""`) and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request's namespace. */ interface ResourcePolicyRule { /** `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required. */ apiGroups: string[]; /** `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list. */ clusterScope?: boolean; /** `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true. */ namespaces?: string[]; /** `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. */ resources: string[]; /** `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. */ verbs: string[]; } /** ServiceAccountSubject holds detailed information for service-account-kind subject. */ interface ServiceAccountSubject { /** `name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required. */ name: string; /** `namespace` is the namespace of matching ServiceAccount objects. Required. */ namespace: string; } /** Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account. */ interface Subject { /** `group` matches based on user group name. */ group?: io.k8s.api.flowcontrol.v1beta2.GroupSubject; /** `kind` indicates which one of the other fields is non-empty. Required */ kind: string; /** `serviceAccount` matches ServiceAccounts. */ serviceAccount?: io.k8s.api.flowcontrol.v1beta2.ServiceAccountSubject; /** `user` matches based on username. */ user?: io.k8s.api.flowcontrol.v1beta2.UserSubject; } /** UserSubject holds detailed information for user-kind subject. */ interface UserSubject { /** `name` is the username that matches, or "*" to match all usernames. Required. */ name: string; } } export declare namespace io.k8s.api.flowcontrol.v1beta3 { /** ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the `spec`. */ interface ExemptPriorityLevelConfiguration { /** * `lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. This value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level's LendableConcurrencyLimit (LendableCL), is defined as follows. * * LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 ) * @format int32 */ lendablePercent?: number; /** * `nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats nominally reserved for this priority level. This DOES NOT limit the dispatching from this priority level but affects the other priority levels through the borrowing mechanism. The server's concurrency limit (ServerCL) is divided among all the priority levels in proportion to their NCS values: * * NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k) * * Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. This field has a default value of zero. * @format int32 */ nominalConcurrencyShares?: number; } /** FlowDistinguisherMethod specifies the method of a flow distinguisher. */ interface FlowDistinguisherMethod { /** `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. */ type: string; } /** FlowSchema defines the schema of a group of flows. Note that a flow is made up of a set of inbound API requests with similar attributes and is identified by a pair of strings: the name of the FlowSchema and a "flow distinguisher". */ interface FlowSchema { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.flowcontrol.v1beta3.FlowSchemaSpec; /** `status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.flowcontrol.v1beta3.FlowSchemaStatus; } /** FlowSchemaCondition describes conditions for a FlowSchema. */ interface FlowSchemaCondition { /** `lastTransitionTime` is the last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** `message` is a human-readable message indicating details about last transition. */ message?: string; /** `reason` is a unique, one-word, CamelCase reason for the condition's last transition. */ reason?: string; /** `status` is the status of the condition. Can be True, False, Unknown. Required. */ status?: string; /** `type` is the type of the condition. Required. */ type?: string; } /** FlowSchemaList is a list of FlowSchema objects. */ interface FlowSchemaList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** `items` is a list of FlowSchemas. */ items: io.k8s.api.flowcontrol.v1beta3.FlowSchema[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** FlowSchemaSpec describes how the FlowSchema's specification looks like. */ interface FlowSchemaSpec { /** `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string. */ distinguisherMethod?: io.k8s.api.flowcontrol.v1beta3.FlowDistinguisherMethod; /** * `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default. * @format int32 */ matchingPrecedence?: number; /** `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. */ priorityLevelConfiguration: io.k8s.api.flowcontrol.v1beta3.PriorityLevelConfigurationReference; /** `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. */ rules?: io.k8s.api.flowcontrol.v1beta3.PolicyRulesWithSubjects[]; } /** FlowSchemaStatus represents the current state of a FlowSchema. */ interface FlowSchemaStatus { /** `conditions` is a list of the current states of FlowSchema. */ conditions?: io.k8s.api.flowcontrol.v1beta3.FlowSchemaCondition[]; } /** GroupSubject holds detailed information for group-kind subject. */ interface GroupSubject { /** name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required. */ name: string; } /** LimitResponse defines how to handle requests that can not be executed right now. */ interface LimitResponse { /** `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`. */ queuing?: io.k8s.api.flowcontrol.v1beta3.QueuingConfiguration; /** `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. */ type: string; } /** * LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: * - How are requests for this priority level limited? * - What should be done with requests that exceed the limit? */ interface LimitedPriorityLevelConfiguration { /** * `borrowingLimitPercent`, if present, configures a limit on how many seats this priority level can borrow from other priority levels. The limit is known as this level's BorrowingConcurrencyLimit (BorrowingCL) and is a limit on the total number of seats that this level may borrow at any one time. This field holds the ratio of that limit to the level's nominal concurrency limit. When this field is non-nil, it must hold a non-negative integer and the limit is calculated as follows. * * BorrowingCL(i) = round( NominalCL(i) * borrowingLimitPercent(i)/100.0 ) * * The value of this field can be more than 100, implying that this priority level can borrow a number of seats that is greater than its own nominal concurrency limit (NominalCL). When this field is left `nil`, the limit is effectively infinite. * @format int32 */ borrowingLimitPercent?: number; /** * `lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. The value of this field must be between 0 and 100, inclusive, and it defaults to 0. The number of seats that other levels can borrow from this level, known as this level's LendableConcurrencyLimit (LendableCL), is defined as follows. * * LendableCL(i) = round( NominalCL(i) * lendablePercent(i)/100.0 ) * @format int32 */ lendablePercent?: number; /** `limitResponse` indicates what to do with requests that can not be executed right now */ limitResponse?: io.k8s.api.flowcontrol.v1beta3.LimitResponse; /** * `nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats available at this priority level. This is used both for requests dispatched from this priority level as well as requests dispatched from other priority levels borrowing seats from this level. The server's concurrency limit (ServerCL) is divided among the Limited priority levels in proportion to their NCS values: * * NominalCL(i) = ceil( ServerCL * NCS(i) / sum_ncs ) sum_ncs = sum[priority level k] NCS(k) * * Bigger numbers mean a larger nominal concurrency limit, at the expense of every other priority level. This field has a default value of 30. * @format int32 */ nominalConcurrencyShares?: number; } /** NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request. */ interface NonResourcePolicyRule { /** * `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: * - "/healthz" is legal * - "/hea*" is illegal * - "/hea" is legal but matches nothing * - "/hea/*" also matches nothing * - "/healthz/*" matches all per-component health checks. * "*" matches all non-resource urls. if it is present, it must be the only entry. Required. */ nonResourceURLs: string[]; /** `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required. */ verbs: string[]; } /** PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request. */ interface PolicyRulesWithSubjects { /** `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. */ nonResourceRules?: io.k8s.api.flowcontrol.v1beta3.NonResourcePolicyRule[]; /** `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty. */ resourceRules?: io.k8s.api.flowcontrol.v1beta3.ResourcePolicyRule[]; /** subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. */ subjects: io.k8s.api.flowcontrol.v1beta3.Subject[]; } /** PriorityLevelConfiguration represents the configuration of a priority level. */ interface PriorityLevelConfiguration { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.flowcontrol.v1beta3.PriorityLevelConfigurationSpec; /** `status` is the current status of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.flowcontrol.v1beta3.PriorityLevelConfigurationStatus; } /** PriorityLevelConfigurationCondition defines the condition of priority level. */ interface PriorityLevelConfigurationCondition { /** `lastTransitionTime` is the last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** `message` is a human-readable message indicating details about last transition. */ message?: string; /** `reason` is a unique, one-word, CamelCase reason for the condition's last transition. */ reason?: string; /** `status` is the status of the condition. Can be True, False, Unknown. Required. */ status?: string; /** `type` is the type of the condition. Required. */ type?: string; } /** PriorityLevelConfigurationList is a list of PriorityLevelConfiguration objects. */ interface PriorityLevelConfigurationList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** `items` is a list of request-priorities. */ items: io.k8s.api.flowcontrol.v1beta3.PriorityLevelConfiguration[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PriorityLevelConfigurationReference contains information that points to the "request-priority" being used. */ interface PriorityLevelConfigurationReference { /** `name` is the name of the priority level configuration being referenced Required. */ name: string; } /** PriorityLevelConfigurationSpec specifies the configuration of a priority level. */ interface PriorityLevelConfigurationSpec { /** `exempt` specifies how requests are handled for an exempt priority level. This field MUST be empty if `type` is `"Limited"`. This field MAY be non-empty if `type` is `"Exempt"`. If empty and `type` is `"Exempt"` then the default values for `ExemptPriorityLevelConfiguration` apply. */ exempt?: io.k8s.api.flowcontrol.v1beta3.ExemptPriorityLevelConfiguration; /** `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. */ limited?: io.k8s.api.flowcontrol.v1beta3.LimitedPriorityLevelConfiguration; /** `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. */ type: string; } /** PriorityLevelConfigurationStatus represents the current state of a "request-priority". */ interface PriorityLevelConfigurationStatus { /** `conditions` is the current state of "request-priority". */ conditions?: io.k8s.api.flowcontrol.v1beta3.PriorityLevelConfigurationCondition[]; } /** QueuingConfiguration holds the configuration parameters for queuing */ interface QueuingConfiguration { /** * `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8. * @format int32 */ handSize?: number; /** * `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50. * @format int32 */ queueLengthLimit?: number; /** * `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. * @format int32 */ queues?: number; } /** ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e., `Namespace==""`) and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request's namespace. */ interface ResourcePolicyRule { /** `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required. */ apiGroups: string[]; /** `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list. */ clusterScope?: boolean; /** `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true. */ namespaces?: string[]; /** `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. */ resources: string[]; /** `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. */ verbs: string[]; } /** ServiceAccountSubject holds detailed information for service-account-kind subject. */ interface ServiceAccountSubject { /** `name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required. */ name: string; /** `namespace` is the namespace of matching ServiceAccount objects. Required. */ namespace: string; } /** Subject matches the originator of a request, as identified by the request authentication system. There are three ways of matching an originator; by user, group, or service account. */ interface Subject { /** `group` matches based on user group name. */ group?: io.k8s.api.flowcontrol.v1beta3.GroupSubject; /** `kind` indicates which one of the other fields is non-empty. Required */ kind: string; /** `serviceAccount` matches ServiceAccounts. */ serviceAccount?: io.k8s.api.flowcontrol.v1beta3.ServiceAccountSubject; /** `user` matches based on username. */ user?: io.k8s.api.flowcontrol.v1beta3.UserSubject; } /** UserSubject holds detailed information for user-kind subject. */ interface UserSubject { /** `name` is the username that matches, or "*" to match all usernames. Required. */ name: string; } } export declare namespace io.k8s.api.apiserverinternal.v1alpha1 { /** An API server instance reports the version it can decode and the version it encodes objects to when persisting objects in the backend. */ interface ServerStorageVersion { /** The ID of the reporting API server. */ apiServerID?: string; /** The API server can decode objects encoded in these versions. The encodingVersion must be included in the decodableVersions. */ decodableVersions?: string[]; /** The API server encodes the object to this version when persisting it in the backend (e.g., etcd). */ encodingVersion?: string; /** The API server can serve these versions. DecodableVersions must include all ServedVersions. */ servedVersions?: string[]; } /** Storage version of a specific resource. */ interface StorageVersion { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** The name is .. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec is an empty spec. It is here to comply with Kubernetes API style. */ spec: io.k8s.api.apiserverinternal.v1alpha1.StorageVersionSpec; /** API server instances report the version they can decode and the version they encode objects to when persisting objects in the backend. */ status: io.k8s.api.apiserverinternal.v1alpha1.StorageVersionStatus; } /** Describes the state of the storageVersion at a certain point. */ interface StorageVersionCondition { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; /** A human readable message indicating details about the transition. */ message?: string; /** * If set, this represents the .metadata.generation that the condition was set based upon. * @format int64 */ observedGeneration?: number; /** The reason for the condition's last transition. */ reason: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of the condition. */ type: string; } /** A list of StorageVersions. */ interface StorageVersionList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items holds a list of StorageVersion */ items: io.k8s.api.apiserverinternal.v1alpha1.StorageVersion[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** StorageVersionSpec is an empty spec. */ interface StorageVersionSpec { } /** API server instances report the versions they can decode and the version they encode objects to when persisting objects in the backend. */ interface StorageVersionStatus { /** If all API server instances agree on the same encoding storage version, then this field is set to that version. Otherwise this field is left empty. API servers should finish updating its storageVersionStatus entry before serving write operations, so that this field will be in sync with the reality. */ commonEncodingVersion?: string; /** The latest available observations of the storageVersion's state. */ conditions?: io.k8s.api.apiserverinternal.v1alpha1.StorageVersionCondition[]; /** The reported versions per API server instance. */ storageVersions?: io.k8s.api.apiserverinternal.v1alpha1.ServerStorageVersion[]; } } export declare namespace io.k8s.api.networking.v1 { /** HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend. */ interface HTTPIngressPath { /** backend defines the referenced service endpoint to which the traffic will be forwarded to. */ backend: io.k8s.api.networking.v1.IngressBackend; /** path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/' and must be present when using PathType with value "Exact" or "Prefix". */ path?: string; /** * pathType determines the interpretation of the path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is * done on a path element by element basis. A path element refers is the * list of labels in the path split by the '/' separator. A request is a * match for path p if every p is an element-wise prefix of p of the * request path. Note that if the last element of the path is a substring * of the last element in request path, it is not a match (e.g. /foo/bar * matches /foo/bar/baz, but does not match /foo/barbaz). * * ImplementationSpecific: Interpretation of the Path matching is up to * the IngressClass. Implementations can treat this as a separate PathType * or treat it identically to Prefix or Exact path types. * Implementations are required to support all path types. */ pathType: string; } /** HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'. */ interface HTTPIngressRuleValue { /** paths is a collection of paths that map requests to backends. */ paths: io.k8s.api.networking.v1.HTTPIngressPath[]; } /** IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule. */ interface IPBlock { /** cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" */ cidr: string; /** except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range */ except?: string[]; } /** Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend. An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc. */ interface Ingress { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.networking.v1.IngressSpec; /** status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: io.k8s.api.networking.v1.IngressStatus; } /** IngressBackend describes all endpoints for a given service and port. */ interface IngressBackend { /** resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, a service.Name and service.Port must not be specified. This is a mutually exclusive setting with "Service". */ resource?: io.k8s.api.core.v1.TypedLocalObjectReference; /** service references a service as a backend. This is a mutually exclusive setting with "Resource". */ service?: io.k8s.api.networking.v1.IngressServiceBackend; } /** IngressClass represents the class of the Ingress, referenced by the Ingress Spec. The `ingressclass.kubernetes.io/is-default-class` annotation can be used to indicate that an IngressClass should be considered default. When a single IngressClass resource has this annotation set to true, new Ingress resources without a class specified will be assigned this default class. */ interface IngressClass { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.networking.v1.IngressClassSpec; } /** IngressClassList is a collection of IngressClasses. */ interface IngressClassList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of IngressClasses. */ items: io.k8s.api.networking.v1.IngressClass[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** IngressClassParametersReference identifies an API object. This can be used to specify a cluster or namespace-scoped resource. */ interface IngressClassParametersReference { /** apiGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** kind is the type of resource being referenced. */ kind: string; /** name is the name of resource being referenced. */ name: string; /** namespace is the namespace of the resource being referenced. This field is required when scope is set to "Namespace" and must be unset when scope is set to "Cluster". */ namespace?: string; /** scope represents if this refers to a cluster or namespace scoped resource. This may be set to "Cluster" (default) or "Namespace". */ scope?: string; } /** IngressClassSpec provides information about the class of an Ingress. */ interface IngressClassSpec { /** controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable. */ controller?: string; /** parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. */ parameters?: io.k8s.api.networking.v1.IngressClassParametersReference; } /** IngressList is a collection of Ingress. */ interface IngressList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of Ingress. */ items: io.k8s.api.networking.v1.Ingress[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** IngressLoadBalancerIngress represents the status of a load-balancer ingress point. */ interface IngressLoadBalancerIngress { /** hostname is set for load-balancer ingress points that are DNS based. */ hostname?: string; /** ip is set for load-balancer ingress points that are IP based. */ ip?: string; /** ports provides information about the ports exposed by this LoadBalancer. */ ports?: io.k8s.api.networking.v1.IngressPortStatus[]; } /** IngressLoadBalancerStatus represents the status of a load-balancer. */ interface IngressLoadBalancerStatus { /** ingress is a list containing ingress points for the load-balancer. */ ingress?: io.k8s.api.networking.v1.IngressLoadBalancerIngress[]; } /** IngressPortStatus represents the error condition of a service port */ interface IngressPortStatus { /** * error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use * CamelCase names * - cloud provider specific error values must have names that comply with the * format foo.example.com/CamelCase. */ error?: string; /** * port is the port number of the ingress port. * @format int32 */ port: number; /** protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP" */ protocol: string; } /** IngressRule represents the rules mapping the paths under a specified host to the related backend services. Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching IngressRuleValue. */ interface IngressRule { /** * host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to * the IP in the Spec of the parent Ingress. * 2. The `:` delimiter is not respected because ports are not allowed. * Currently the port of an Ingress is implicitly :80 for http and * :443 for https. * Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. * * host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If host is precise, the request matches this rule if the http host header is equal to Host. 2. If host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. */ host?: string; http: io.k8s.api.networking.v1.HTTPIngressRuleValue; } /** IngressServiceBackend references a Kubernetes Service as a Backend. */ interface IngressServiceBackend { /** name is the referenced service. The service must exist in the same namespace as the Ingress object. */ name: string; /** port of the referenced service. A port name or port number is required for a IngressServiceBackend. */ port?: io.k8s.api.networking.v1.ServiceBackendPort; } /** IngressSpec describes the Ingress the user wishes to exist. */ interface IngressSpec { /** defaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller. */ defaultBackend?: io.k8s.api.networking.v1.IngressBackend; /** ingressClassName is the name of an IngressClass cluster resource. Ingress controller implementations use this field to know whether they should be serving this Ingress resource, by a transitive connection (controller -> IngressClass -> Ingress resource). Although the `kubernetes.io/ingress.class` annotation (simple constant name) was never formally defined, it was widely supported by Ingress controllers to create a direct binding between Ingress controller and Ingress resources. Newly created Ingress resources should prefer using the field. However, even though the annotation is officially deprecated, for backwards compatibility reasons, ingress controllers should still honor that annotation if present. */ ingressClassName?: string; /** rules is a list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. */ rules?: io.k8s.api.networking.v1.IngressRule[]; /** tls represents the TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. */ tls?: io.k8s.api.networking.v1.IngressTLS[]; } /** IngressStatus describe the current state of the Ingress. */ interface IngressStatus { /** loadBalancer contains the current status of the load-balancer. */ loadBalancer?: io.k8s.api.networking.v1.IngressLoadBalancerStatus; } /** IngressTLS describes the transport layer security associated with an ingress. */ interface IngressTLS { /** hosts is a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. */ hosts?: string[]; /** secretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the "Host" header is used for routing. */ secretName?: string; } /** NetworkPolicy describes what network traffic is allowed for a set of Pods */ interface NetworkPolicy { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec represents the specification of the desired behavior for this NetworkPolicy. */ spec?: io.k8s.api.networking.v1.NetworkPolicySpec; } /** NetworkPolicyEgressRule describes a particular set of traffic that is allowed out of pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and to. This type is beta-level in 1.8 */ interface NetworkPolicyEgressRule { /** ports is a list of destination ports for outgoing traffic. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. */ ports?: io.k8s.api.networking.v1.NetworkPolicyPort[]; /** to is a list of destinations for outgoing traffic of pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all destinations (traffic not restricted by destination). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the to list. */ to?: io.k8s.api.networking.v1.NetworkPolicyPeer[]; } /** NetworkPolicyIngressRule describes a particular set of traffic that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The traffic must match both ports and from. */ interface NetworkPolicyIngressRule { /** from is a list of sources which should be able to access the pods selected for this rule. Items in this list are combined using a logical OR operation. If this field is empty or missing, this rule matches all sources (traffic not restricted by source). If this field is present and contains at least one item, this rule allows traffic only if the traffic matches at least one item in the from list. */ from?: io.k8s.api.networking.v1.NetworkPolicyPeer[]; /** ports is a list of ports which should be made accessible on the pods selected for this rule. Each item in this list is combined using a logical OR. If this field is empty or missing, this rule matches all ports (traffic not restricted by port). If this field is present and contains at least one item, then this rule allows traffic only if the traffic matches at least one port in the list. */ ports?: io.k8s.api.networking.v1.NetworkPolicyPort[]; } /** NetworkPolicyList is a list of NetworkPolicy objects. */ interface NetworkPolicyList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is a list of schema objects. */ items: io.k8s.api.networking.v1.NetworkPolicy[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** NetworkPolicyPeer describes a peer to allow traffic to/from. Only certain combinations of fields are allowed */ interface NetworkPolicyPeer { /** ipBlock defines policy on a particular IPBlock. If this field is set then neither of the other fields can be. */ ipBlock?: io.k8s.api.networking.v1.IPBlock; /** * namespaceSelector selects namespaces using cluster-scoped labels. This field follows standard label selector semantics; if present but empty, it selects all namespaces. * * If podSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the namespaces selected by namespaceSelector. Otherwise it selects all pods in the namespaces selected by namespaceSelector. */ namespaceSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** * podSelector is a label selector which selects pods. This field follows standard label selector semantics; if present but empty, it selects all pods. * * If namespaceSelector is also set, then the NetworkPolicyPeer as a whole selects the pods matching podSelector in the Namespaces selected by NamespaceSelector. Otherwise it selects the pods matching podSelector in the policy's own namespace. */ podSelector?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; } /** NetworkPolicyPort describes a port to allow traffic on */ interface NetworkPolicyPort { /** * endPort indicates that the range of ports from port to endPort if set, inclusive, should be allowed by the policy. This field cannot be defined if the port field is not defined or if the port field is defined as a named (string) port. The endPort must be equal or greater than port. * @format int32 */ endPort?: number; /** port represents the port on the given protocol. This can either be a numerical or named port on a pod. If this field is not provided, this matches all port names and numbers. If present, only traffic on the specified protocol AND port will be matched. */ port?: io.k8s.apimachinery.pkg.util.intstr.IntOrString; /** protocol represents the protocol (TCP, UDP, or SCTP) which traffic must match. If not specified, this field defaults to TCP. */ protocol?: string; } /** NetworkPolicySpec provides the specification of a NetworkPolicy */ interface NetworkPolicySpec { /** egress is a list of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 */ egress?: io.k8s.api.networking.v1.NetworkPolicyEgressRule[]; /** ingress is a list of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) */ ingress?: io.k8s.api.networking.v1.NetworkPolicyIngressRule[]; /** podSelector selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. */ podSelector: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** policyTypes is a list of rule types that the NetworkPolicy relates to. Valid options are ["Ingress"], ["Egress"], or ["Ingress", "Egress"]. If this field is not specified, it will default based on the existence of ingress or egress rules; policies that contain an egress section are assumed to affect egress, and all policies (whether or not they contain an ingress section) are assumed to affect ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 */ policyTypes?: string[]; } /** ServiceBackendPort is the service port being referenced. */ interface ServiceBackendPort { /** name is the name of the port on the Service. This is a mutually exclusive setting with "Number". */ name?: string; /** * number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name". * @format int32 */ number?: number; } } export declare namespace io.k8s.api.networking.v1alpha1 { /** ClusterCIDR represents a single configuration for per-Node Pod CIDR allocations when the MultiCIDRRangeAllocator is enabled (see the config for kube-controller-manager). A cluster may have any number of ClusterCIDR resources, all of which will be considered when allocating a CIDR for a Node. A ClusterCIDR is eligible to be used for a given Node when the node selector matches the node in question and has free CIDRs to allocate. In case of multiple matching ClusterCIDR resources, the allocator will attempt to break ties using internal heuristics, but any ClusterCIDR whose node selector matches the Node may be used. */ interface ClusterCIDR { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec is the desired state of the ClusterCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.networking.v1alpha1.ClusterCIDRSpec; } /** ClusterCIDRList contains a list of ClusterCIDR. */ interface ClusterCIDRList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of ClusterCIDRs. */ items: io.k8s.api.networking.v1alpha1.ClusterCIDR[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ClusterCIDRSpec defines the desired state of ClusterCIDR. */ interface ClusterCIDRSpec { /** ipv4 defines an IPv4 IP block in CIDR notation(e.g. "10.0.0.0/8"). At least one of ipv4 and ipv6 must be specified. This field is immutable. */ ipv4?: string; /** ipv6 defines an IPv6 IP block in CIDR notation(e.g. "2001:db8::/64"). At least one of ipv4 and ipv6 must be specified. This field is immutable. */ ipv6?: string; /** nodeSelector defines which nodes the config is applicable to. An empty or nil nodeSelector selects all nodes. This field is immutable. */ nodeSelector?: io.k8s.api.core.v1.NodeSelector; /** * perNodeHostBits defines the number of host bits to be configured per node. A subnet mask determines how much of the address is used for network bits and host bits. For example an IPv4 address of 192.168.0.0/24, splits the address into 24 bits for the network portion and 8 bits for the host portion. To allocate 256 IPs, set this field to 8 (a /24 mask for IPv4 or a /120 for IPv6). Minimum value is 4 (16 IPs). This field is immutable. * @format int32 */ perNodeHostBits: number; } /** IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1 */ interface IPAddress { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec is the desired state of the IPAddress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: io.k8s.api.networking.v1alpha1.IPAddressSpec; } /** IPAddressList contains a list of IPAddress. */ interface IPAddressList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of IPAddresses. */ items: io.k8s.api.networking.v1alpha1.IPAddress[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** IPAddressSpec describe the attributes in an IP Address. */ interface IPAddressSpec { /** ParentRef references the resource that an IPAddress is attached to. An IPAddress must reference a parent object. */ parentRef?: io.k8s.api.networking.v1alpha1.ParentReference; } /** ParentReference describes a reference to a parent object. */ interface ParentReference { /** Group is the group of the object being referenced. */ group?: string; /** Name is the name of the object being referenced. */ name?: string; /** Namespace is the namespace of the object being referenced. */ namespace?: string; /** Resource is the resource of the object being referenced. */ resource?: string; /** UID is the uid of the object being referenced. */ uid?: string; } } export declare namespace io.k8s.api.node.v1 { /** Overhead structure represents the resource overhead associated with running a pod. */ interface Overhead { /** podFixed represents the fixed resource overhead associated with running a pod. */ podFixed?: Record; } /** RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/ */ interface RuntimeClass { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. */ handler: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** * overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see * https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/ */ overhead?: io.k8s.api.node.v1.Overhead; /** scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. */ scheduling?: io.k8s.api.node.v1.Scheduling; } /** RuntimeClassList is a list of RuntimeClass objects. */ interface RuntimeClassList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is a list of schema objects. */ items: io.k8s.api.node.v1.RuntimeClass[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass. */ interface Scheduling { /** nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. */ nodeSelector?: Record; /** tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. */ tolerations?: io.k8s.api.core.v1.Toleration[]; } } export declare namespace io.k8s.api.rbac.v1 { /** AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole */ interface AggregationRule { /** ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added */ clusterRoleSelectors?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[]; } /** ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. */ interface ClusterRole { /** AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. */ aggregationRule?: io.k8s.api.rbac.v1.AggregationRule; /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Rules holds all the PolicyRules for this ClusterRole */ rules?: io.k8s.api.rbac.v1.PolicyRule[]; } /** ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. */ interface ClusterRoleBinding { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable. */ roleRef: io.k8s.api.rbac.v1.RoleRef; /** Subjects holds references to the objects the role applies to. */ subjects?: io.k8s.api.rbac.v1.Subject[]; } /** ClusterRoleBindingList is a collection of ClusterRoleBindings */ interface ClusterRoleBindingList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is a list of ClusterRoleBindings */ items: io.k8s.api.rbac.v1.ClusterRoleBinding[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ClusterRoleList is a collection of ClusterRoles */ interface ClusterRoleList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is a list of ClusterRoles */ items: io.k8s.api.rbac.v1.ClusterRole[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to. */ interface PolicyRule { /** APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "" represents the core API group and "*" represents all API groups. */ apiGroups?: string[]; /** NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. */ nonResourceURLs?: string[]; /** ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. */ resourceNames?: string[]; /** Resources is a list of resources this rule applies to. '*' represents all resources. */ resources?: string[]; /** Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs. */ verbs: string[]; } /** Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. */ interface Role { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Rules holds all the PolicyRules for this Role */ rules?: io.k8s.api.rbac.v1.PolicyRule[]; } /** RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. */ interface RoleBinding { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. This field is immutable. */ roleRef: io.k8s.api.rbac.v1.RoleRef; /** Subjects holds references to the objects the role applies to. */ subjects?: io.k8s.api.rbac.v1.Subject[]; } /** RoleBindingList is a collection of RoleBindings */ interface RoleBindingList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is a list of RoleBindings */ items: io.k8s.api.rbac.v1.RoleBinding[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** RoleList is a collection of Roles */ interface RoleList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is a list of Roles */ items: io.k8s.api.rbac.v1.Role[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** RoleRef contains information that points to the role being used */ interface RoleRef { /** APIGroup is the group for the resource being referenced */ apiGroup: string; /** Kind is the type of resource being referenced */ kind: string; /** Name is the name of resource being referenced */ name: string; } /** Subject contains a reference to the object or user identities a role binding applies to. This can either hold a direct API object reference, or a value for non-objects such as user and group names. */ interface Subject { /** APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. */ apiGroup?: string; /** Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. */ kind: string; /** Name of the object being referenced. */ name: string; /** Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. */ namespace?: string; } } export declare namespace io.k8s.api.resource.v1alpha2 { /** AllocationResult contains attributes of an allocated resource. */ interface AllocationResult { /** * This field will get set by the resource driver after it has allocated the resource to inform the scheduler where it can schedule Pods using the ResourceClaim. * * Setting this field is optional. If null, the resource is available everywhere. */ availableOnNodes?: io.k8s.api.core.v1.NodeSelector; /** * ResourceHandles contain the state associated with an allocation that should be maintained throughout the lifetime of a claim. Each ResourceHandle contains data that should be passed to a specific kubelet plugin once it lands on a node. This data is returned by the driver after a successful allocation and is opaque to Kubernetes. Driver documentation may explain to users how to interpret this data if needed. * * Setting this field is optional. It has a maximum size of 32 entries. If null (or empty), it is assumed this allocation will be processed by a single kubelet plugin with no ResourceHandle data attached. The name of the kubelet plugin invoked will match the DriverName set in the ResourceClaimStatus this AllocationResult is embedded in. */ resourceHandles?: io.k8s.api.resource.v1alpha2.ResourceHandle[]; /** Shareable determines whether the resource supports more than one consumer at a time. */ shareable?: boolean; } /** * PodSchedulingContext objects hold information that is needed to schedule a Pod with ResourceClaims that use "WaitForFirstConsumer" allocation mode. * * This is an alpha type and requires enabling the DynamicResourceAllocation feature gate. */ interface PodSchedulingContext { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec describes where resources for the Pod are needed. */ spec: io.k8s.api.resource.v1alpha2.PodSchedulingContextSpec; /** Status describes where resources for the Pod can be allocated. */ status?: io.k8s.api.resource.v1alpha2.PodSchedulingContextStatus; } /** PodSchedulingContextList is a collection of Pod scheduling objects. */ interface PodSchedulingContextList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of PodSchedulingContext objects. */ items: io.k8s.api.resource.v1alpha2.PodSchedulingContext[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** PodSchedulingContextSpec describes where resources for the Pod are needed. */ interface PodSchedulingContextSpec { /** * PotentialNodes lists nodes where the Pod might be able to run. * * The size of this field is limited to 128. This is large enough for many clusters. Larger clusters may need more attempts to find a node that suits all pending resources. This may get increased in the future, but not reduced. */ potentialNodes?: string[]; /** SelectedNode is the node for which allocation of ResourceClaims that are referenced by the Pod and that use "WaitForFirstConsumer" allocation is to be attempted. */ selectedNode?: string; } /** PodSchedulingContextStatus describes where resources for the Pod can be allocated. */ interface PodSchedulingContextStatus { /** ResourceClaims describes resource availability for each pod.spec.resourceClaim entry where the corresponding ResourceClaim uses "WaitForFirstConsumer" allocation mode. */ resourceClaims?: io.k8s.api.resource.v1alpha2.ResourceClaimSchedulingStatus[]; } /** * ResourceClaim describes which resources are needed by a resource consumer. Its status tracks whether the resource has been allocated and what the resulting attributes are. * * This is an alpha type and requires enabling the DynamicResourceAllocation feature gate. */ interface ResourceClaim { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec describes the desired attributes of a resource that then needs to be allocated. It can only be set once when creating the ResourceClaim. */ spec: io.k8s.api.resource.v1alpha2.ResourceClaimSpec; /** Status describes whether the resource is available and with which attributes. */ status?: io.k8s.api.resource.v1alpha2.ResourceClaimStatus; } /** ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim. The user must be a resource in the same namespace as the ResourceClaim. */ interface ResourceClaimConsumerReference { /** APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources. */ apiGroup?: string; /** Name is the name of resource being referenced. */ name: string; /** Resource is the type of resource being referenced, for example "pods". */ resource: string; /** UID identifies exactly one incarnation of the resource. */ uid: string; } /** ResourceClaimList is a collection of claims. */ interface ResourceClaimList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of resource claims. */ items: io.k8s.api.resource.v1alpha2.ResourceClaim[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ResourceClaimParametersReference contains enough information to let you locate the parameters for a ResourceClaim. The object must be in the same namespace as the ResourceClaim. */ interface ResourceClaimParametersReference { /** APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources. */ apiGroup?: string; /** Kind is the type of resource being referenced. This is the same value as in the parameter object's metadata, for example "ConfigMap". */ kind: string; /** Name is the name of resource being referenced. */ name: string; } /** ResourceClaimSchedulingStatus contains information about one particular ResourceClaim with "WaitForFirstConsumer" allocation mode. */ interface ResourceClaimSchedulingStatus { /** Name matches the pod.spec.resourceClaims[*].Name field. */ name?: string; /** * UnsuitableNodes lists nodes that the ResourceClaim cannot be allocated for. * * The size of this field is limited to 128, the same as for PodSchedulingSpec.PotentialNodes. This may get increased in the future, but not reduced. */ unsuitableNodes?: string[]; } /** ResourceClaimSpec defines how a resource is to be allocated. */ interface ResourceClaimSpec { /** Allocation can start immediately or when a Pod wants to use the resource. "WaitForFirstConsumer" is the default. */ allocationMode?: string; /** * ParametersRef references a separate object with arbitrary parameters that will be used by the driver when allocating a resource for the claim. * * The object must be in the same namespace as the ResourceClaim. */ parametersRef?: io.k8s.api.resource.v1alpha2.ResourceClaimParametersReference; /** ResourceClassName references the driver and additional parameters via the name of a ResourceClass that was created as part of the driver deployment. */ resourceClassName: string; } /** ResourceClaimStatus tracks whether the resource has been allocated and what the resulting attributes are. */ interface ResourceClaimStatus { /** Allocation is set by the resource driver once a resource or set of resources has been allocated successfully. If this is not specified, the resources have not been allocated yet. */ allocation?: io.k8s.api.resource.v1alpha2.AllocationResult; /** * DeallocationRequested indicates that a ResourceClaim is to be deallocated. * * The driver then must deallocate this claim and reset the field together with clearing the Allocation field. * * While DeallocationRequested is set, no new consumers may be added to ReservedFor. */ deallocationRequested?: boolean; /** DriverName is a copy of the driver name from the ResourceClass at the time when allocation started. */ driverName?: string; /** * ReservedFor indicates which entities are currently allowed to use the claim. A Pod which references a ResourceClaim which is not reserved for that Pod will not be started. * * There can be at most 32 such reservations. This may get increased in the future, but not reduced. */ reservedFor?: io.k8s.api.resource.v1alpha2.ResourceClaimConsumerReference[]; } /** ResourceClaimTemplate is used to produce ResourceClaim objects. */ interface ResourceClaimTemplate { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** * Describes the ResourceClaim that is to be generated. * * This field is immutable. A ResourceClaim will get created by the control plane for a Pod when needed and then not get updated anymore. */ spec: io.k8s.api.resource.v1alpha2.ResourceClaimTemplateSpec; } /** ResourceClaimTemplateList is a collection of claim templates. */ interface ResourceClaimTemplateList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of resource claim templates. */ items: io.k8s.api.resource.v1alpha2.ResourceClaimTemplate[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim. */ interface ResourceClaimTemplateSpec { /** ObjectMeta may contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** Spec for the ResourceClaim. The entire content is copied unchanged into the ResourceClaim that gets created from this template. The same fields as in a ResourceClaim are also valid here. */ spec: io.k8s.api.resource.v1alpha2.ResourceClaimSpec; } /** * ResourceClass is used by administrators to influence how resources are allocated. * * This is an alpha type and requires enabling the DynamicResourceAllocation feature gate. */ interface ResourceClass { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** * DriverName defines the name of the dynamic resource driver that is used for allocation of a ResourceClaim that uses this class. * * Resource drivers have a unique name in forward domain order (acme.example.com). */ driverName: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** ParametersRef references an arbitrary separate object that may hold parameters that will be used by the driver when allocating a resource that uses this class. A dynamic resource driver can distinguish between parameters stored here and and those stored in ResourceClaimSpec. */ parametersRef?: io.k8s.api.resource.v1alpha2.ResourceClassParametersReference; /** * Only nodes matching the selector will be considered by the scheduler when trying to find a Node that fits a Pod when that Pod uses a ResourceClaim that has not been allocated yet. * * Setting this field is optional. If null, all nodes are candidates. */ suitableNodes?: io.k8s.api.core.v1.NodeSelector; } /** ResourceClassList is a collection of classes. */ interface ResourceClassList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Items is the list of resource classes. */ items: io.k8s.api.resource.v1alpha2.ResourceClass[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** ResourceClassParametersReference contains enough information to let you locate the parameters for a ResourceClass. */ interface ResourceClassParametersReference { /** APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources. */ apiGroup?: string; /** Kind is the type of resource being referenced. This is the same value as in the parameter object's metadata. */ kind: string; /** Name is the name of resource being referenced. */ name: string; /** Namespace that contains the referenced resource. Must be empty for cluster-scoped resources and non-empty for namespaced resources. */ namespace?: string; } /** ResourceHandle holds opaque resource data for processing by a specific kubelet plugin. */ interface ResourceHandle { /** * Data contains the opaque data associated with this ResourceHandle. It is set by the controller component of the resource driver whose name matches the DriverName set in the ResourceClaimStatus this ResourceHandle is embedded in. It is set at allocation time and is intended for processing by the kubelet plugin whose name matches the DriverName set in this ResourceHandle. * * The maximum size of this field is 16KiB. This may get increased in the future, but not reduced. */ data?: string; /** DriverName specifies the name of the resource driver whose kubelet plugin should be invoked to process this ResourceHandle's data once it lands on a node. This may differ from the DriverName set in ResourceClaimStatus this ResourceHandle is embedded in. */ driverName?: string; } } export declare namespace io.k8s.api.scheduling.v1 { /** PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer. */ interface PriorityClass { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** description is an arbitrary string that usually provides guidelines on when this priority class should be used. */ description?: string; /** globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. */ globalDefault?: boolean; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** preemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. */ preemptionPolicy?: string; /** * value represents the integer value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. * @format int32 */ value: number; } /** PriorityClassList is a collection of priority classes. */ interface PriorityClassList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of PriorityClasses */ items: io.k8s.api.scheduling.v1.PriorityClass[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } } export declare namespace io.k8s.api.storage.v1 { /** CSIDriver captures information about a Container Storage Interface (CSI) volume driver deployed on the cluster. Kubernetes attach detach controller uses this object to determine whether attach is required. Kubelet uses this object to determine whether pod information needs to be passed on mount. CSIDriver objects are non-namespaced. */ interface CSIDriver { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec represents the specification of the CSI Driver. */ spec: io.k8s.api.storage.v1.CSIDriverSpec; } /** CSIDriverList is a collection of CSIDriver objects. */ interface CSIDriverList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of CSIDriver */ items: io.k8s.api.storage.v1.CSIDriver[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** CSIDriverSpec is the specification of a CSIDriver. */ interface CSIDriverSpec { /** * attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. * * This field is immutable. */ attachRequired?: boolean; /** * fsGroupPolicy defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. * * This field is immutable. * * Defaults to ReadWriteOnceWithFSType, which will examine each volume to determine if Kubernetes should modify ownership and permissions of the volume. With the default policy the defined fsGroup will only be applied if a fstype is defined and the volume's access mode contains ReadWriteOnce. */ fsGroupPolicy?: string; /** * podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations, if set to true. If set to false, pod information will not be passed on mount. Default is false. * * The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. * * The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" if the volume is an ephemeral inline volume * defined by a CSIVolumeSource, otherwise "false" * * "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. * * This field is immutable. */ podInfoOnMount?: boolean; /** * requiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. * * Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. */ requiresRepublish?: boolean; /** * seLinuxMount specifies if the CSI driver supports "-o context" mount option. * * When "true", the CSI driver must ensure that all volumes provided by this CSI driver can be mounted separately with different `-o context` options. This is typical for storage backends that provide volumes as filesystems on block devices or as independent shared volumes. Kubernetes will call NodeStage / NodePublish with "-o context=xyz" mount option when mounting a ReadWriteOncePod volume used in Pod that has explicitly set SELinux context. In the future, it may be expanded to other volume AccessModes. In any case, Kubernetes will ensure that the volume is mounted only with a single SELinux context. * * When "false", Kubernetes won't pass any special SELinux mount options to the driver. This is typical for volumes that represent subdirectories of a bigger shared filesystem. * * Default is "false". */ seLinuxMount?: boolean; /** * storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information, if set to true. * * The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. * * Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. * * This field was immutable in Kubernetes <= 1.22 and now is mutable. */ storageCapacity?: boolean; /** * tokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { * "": { * "token": , * "expirationTimestamp": , * }, * ... * } * * Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. */ tokenRequests?: io.k8s.api.storage.v1.TokenRequest[]; /** * volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. * * The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. * * For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. * * This field is beta. This field is immutable. */ volumeLifecycleModes?: string[]; } /** CSINode holds information about all CSI drivers installed on a node. CSI drivers do not need to create the CSINode object directly. As long as they use the node-driver-registrar sidecar container, the kubelet will automatically populate the CSINode object for the CSI driver as part of kubelet plugin registration. CSINode has the same name as a node. If the object is missing, it means either there are no CSI Drivers available on the node, or the Kubelet version is low enough that it doesn't create this object. CSINode has an OwnerReference that points to the corresponding node object. */ interface CSINode { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. metadata.name must be the Kubernetes node name. */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec is the specification of CSINode */ spec: io.k8s.api.storage.v1.CSINodeSpec; } /** CSINodeDriver holds information about the specification of one CSI driver installed on a node */ interface CSINodeDriver { /** allocatable represents the volume resources of a node that are available for scheduling. This field is beta. */ allocatable?: io.k8s.api.storage.v1.VolumeNodeResources; /** name represents the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver. */ name: string; /** nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. */ nodeID: string; /** topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. */ topologyKeys?: string[]; } /** CSINodeList is a collection of CSINode objects. */ interface CSINodeList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of CSINode */ items: io.k8s.api.storage.v1.CSINode[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** CSINodeSpec holds information about the specification of all CSI drivers installed on a node */ interface CSINodeSpec { /** drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. */ drivers: io.k8s.api.storage.v1.CSINodeDriver[]; } /** * CSIStorageCapacity stores the result of one CSI GetCapacity call. For a given StorageClass, this describes the available capacity in a particular topology segment. This can be used when considering where to instantiate new PersistentVolumes. * * For example this can express things like: - StorageClass "standard" has "1234 GiB" available in "topology.kubernetes.io/zone=us-east1" - StorageClass "localssd" has "10 GiB" available in "kubernetes.io/hostname=knode-abc123" * * The following three cases all imply that no capacity is available for a certain combination: - no object exists with suitable topology and storage class name - such an object exists, but the capacity is unset - such an object exists, but the capacity is zero * * The producer of these objects can decide which approach is more suitable. * * They are consumed by the kube-scheduler when a CSI driver opts into capacity-aware scheduling with CSIDriverSpec.StorageCapacity. The scheduler compares the MaximumVolumeSize against the requested size of pending volumes to filter out unsuitable nodes. If MaximumVolumeSize is unset, it falls back to a comparison against the less precise Capacity. If that is also unset, the scheduler assumes that capacity is insufficient and tries some other node. */ interface CSIStorageCapacity { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** * capacity is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. * * The semantic is currently (CSI spec 1.2) defined as: The available capacity, in bytes, of the storage that can be used to provision volumes. If not set, that information is currently unavailable. */ capacity?: io.k8s.apimachinery.pkg.api.resource.Quantity; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** * maximumVolumeSize is the value reported by the CSI driver in its GetCapacityResponse for a GetCapacityRequest with topology and parameters that match the previous fields. * * This is defined since CSI spec 1.4.0 as the largest size that may be used in a CreateVolumeRequest.capacity_range.required_bytes field to create a volume with the same parameters as those in GetCapacityRequest. The corresponding value in the Kubernetes API is ResourceRequirements.Requests in a volume claim. */ maximumVolumeSize?: io.k8s.apimachinery.pkg.api.resource.Quantity; /** * Standard object's metadata. The name has no particular meaning. It must be a DNS subdomain (dots allowed, 253 characters). To ensure that there are no conflicts with other CSI drivers on the cluster, the recommendation is to use csisc-, a generated name, or a reverse-domain name which ends with the unique CSI driver name. * * Objects are namespaced. * * More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** nodeTopology defines which nodes have access to the storage for which capacity was reported. If not set, the storage is not accessible from any node in the cluster. If empty, the storage is accessible from all nodes. This field is immutable. */ nodeTopology?: io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector; /** storageClassName represents the name of the StorageClass that the reported capacity applies to. It must meet the same requirements as the name of a StorageClass object (non-empty, DNS subdomain). If that object no longer exists, the CSIStorageCapacity object is obsolete and should be removed by its creator. This field is immutable. */ storageClassName: string; } /** CSIStorageCapacityList is a collection of CSIStorageCapacity objects. */ interface CSIStorageCapacityList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of CSIStorageCapacity objects. */ items: io.k8s.api.storage.v1.CSIStorageCapacity[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** * StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned. * * StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name. */ interface StorageClass { /** allowVolumeExpansion shows whether the storage class allow volume expand. */ allowVolumeExpansion?: boolean; /** allowedTopologies restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. */ allowedTopologies?: io.k8s.api.core.v1.TopologySelectorTerm[]; /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class. e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. */ mountOptions?: string[]; /** parameters holds the parameters for the provisioner that should create volumes of this storage class. */ parameters?: Record; /** provisioner indicates the type of the provisioner. */ provisioner: string; /** reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class. Defaults to Delete. */ reclaimPolicy?: string; /** volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. */ volumeBindingMode?: string; } /** StorageClassList is a collection of storage classes. */ interface StorageClassList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of StorageClasses */ items: io.k8s.api.storage.v1.StorageClass[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** TokenRequest contains parameters of a service account token. */ interface TokenRequest { /** audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver. */ audience: string; /** * expirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec". * @format int64 */ expirationSeconds?: number; } /** * VolumeAttachment captures the intent to attach or detach the specified volume to/from the specified node. * * VolumeAttachment objects are non-namespaced. */ interface VolumeAttachment { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta; /** spec represents specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. */ spec: io.k8s.api.storage.v1.VolumeAttachmentSpec; /** status represents status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. */ status?: io.k8s.api.storage.v1.VolumeAttachmentStatus; } /** VolumeAttachmentList is a collection of VolumeAttachment objects. */ interface VolumeAttachmentList { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** items is the list of VolumeAttachments */ items: io.k8s.api.storage.v1.VolumeAttachment[]; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta; } /** VolumeAttachmentSource represents a volume that should be attached. Right now only PersistenVolumes can be attached via external attacher, in future we may allow also inline volumes in pods. Exactly one member can be set. */ interface VolumeAttachmentSource { /** inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is beta-level and is only honored by servers that enabled the CSIMigration feature. */ inlineVolumeSpec?: io.k8s.api.core.v1.PersistentVolumeSpec; /** persistentVolumeName represents the name of the persistent volume to attach. */ persistentVolumeName?: string; } /** VolumeAttachmentSpec is the specification of a VolumeAttachment request. */ interface VolumeAttachmentSpec { /** attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). */ attacher: string; /** nodeName represents the node that the volume should be attached to. */ nodeName: string; /** source represents the volume that should be attached. */ source: io.k8s.api.storage.v1.VolumeAttachmentSource; } /** VolumeAttachmentStatus is the status of a VolumeAttachment request. */ interface VolumeAttachmentStatus { /** attachError represents the last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. */ attachError?: io.k8s.api.storage.v1.VolumeError; /** attached indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. */ attached: boolean; /** attachmentMetadata is populated with any information returned by the attach operation, upon successful attach, that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. */ attachmentMetadata?: Record; /** detachError represents the last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher. */ detachError?: io.k8s.api.storage.v1.VolumeError; } /** VolumeError captures an error encountered during a volume operation. */ interface VolumeError { /** message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information. */ message?: string; /** time represents the time the error was encountered. */ time?: io.k8s.apimachinery.pkg.apis.meta.v1.Time; } /** VolumeNodeResources is a set of resource limits for scheduling of volumes. */ interface VolumeNodeResources { /** * count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is not specified, then the supported number of volumes on this node is unbounded. * @format int32 */ count?: number; } } export declare namespace io.k8s.apimachinery.pkg.version { /** Info contains versioning information. how we'll want to distribute that information. */ interface Info { /** */ buildDate: string; /** */ compiler: string; /** */ gitCommit: string; /** */ gitTreeState: string; /** */ gitVersion: string; /** */ goVersion: string; /** */ major: string; /** */ minor: string; /** */ platform: string; } } export declare namespace io.cert_manager.v1 { /** * A CertificateRequest is used to request a signed certificate from one of the configured issuers. * All fields within the CertificateRequest's `spec` are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its `Ready` status condition and its `status.failureTime` field. * A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used. */ interface CertificateRequest { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: object; /** Specification of the desired state of the CertificateRequest resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: CertificateRequest_spec; /** Status of the CertificateRequest. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: CertificateRequest_status; } /** Specification of the desired state of the CertificateRequest resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ interface CertificateRequest_spec { /** Requested 'duration' (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute. */ duration?: string; /** Extra contains extra attributes of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. */ extra?: Record; /** Groups contains group membership of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. */ groups?: string[]; /** * Requested basic constraints isCA value. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute. * NOTE: If the CSR in the `Request` field has a BasicConstraints extension, it must have the same isCA value as specified here. * If true, this will automatically add the `cert sign` usage to the list of requested `usages`. */ isCA?: boolean; /** * Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace. * The `name` field of the reference must always be specified. */ issuerRef: CertificateRequest_spec_issuerRef; /** * The PEM-encoded X.509 certificate signing request to be submitted to the issuer for signing. * If the CSR has a BasicConstraints extension, its isCA attribute must match the `isCA` value of this CertificateRequest. If the CSR has a KeyUsage extension, its key usages must match the key usages in the `usages` field of this CertificateRequest. If the CSR has a ExtKeyUsage extension, its extended key usages must match the extended key usages in the `usages` field of this CertificateRequest. * @format byte */ request: string; /** UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. */ uid?: string; /** * Requested key usages and extended key usages. * NOTE: If the CSR in the `Request` field has uses the KeyUsage or ExtKeyUsage extension, these extensions must have the same values as specified here without any additional values. * If unset, defaults to `digital signature` and `key encipherment`. */ usages?: Array<"signing" | "digital signature" | "content commitment" | "key encipherment" | "key agreement" | "data encipherment" | "cert sign" | "crl sign" | "encipher only" | "decipher only" | "any" | "server auth" | "client auth" | "code signing" | "email protection" | "s/mime" | "ipsec end system" | "ipsec tunnel" | "ipsec user" | "timestamping" | "ocsp signing" | "microsoft sgc" | "netscape sgc">; /** Username contains the name of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable. */ username?: string; } /** * Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace. * The `name` field of the reference must always be specified. */ interface CertificateRequest_spec_issuerRef { /** Group of the resource being referred to. */ group?: string; /** Kind of the resource being referred to. */ kind?: string; /** Name of the resource being referred to. */ name: string; } /** Status of the CertificateRequest. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ interface CertificateRequest_status { /** * The PEM encoded X.509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available. * @format byte */ ca?: string; /** * The PEM encoded X.509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the `conditions` field. * @format byte */ certificate?: string; /** List of status conditions to indicate the status of a CertificateRequest. Known condition types are `Ready`, `InvalidRequest`, `Approved` and `Denied`. */ conditions?: CertificateRequest_status_conditions[]; /** * FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. * @format date-time */ failureTime?: string; } /** CertificateRequestCondition contains condition information for a CertificateRequest. */ interface CertificateRequest_status_conditions { /** * LastTransitionTime is the timestamp corresponding to the last status change of this condition. * @format date-time */ lastTransitionTime?: string; /** Message is a human readable description of the details of the last transition, complementing reason. */ message?: string; /** Reason is a brief machine readable explanation for the condition's last transition. */ reason?: string; /** Status of the condition, one of (`True`, `False`, `Unknown`). */ status: "True" | "False" | "Unknown"; /** Type of the condition, known values are (`Ready`, `InvalidRequest`, `Approved`, `Denied`). */ type: string; } /** * A Certificate resource should be created to ensure an up to date and signed X.509 certificate is stored in the Kubernetes Secret resource named in `spec.secretName`. * The stored certificate will be renewed before it expires (as configured by `spec.renewBefore`). */ interface Certificate { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: object; /** Specification of the desired state of the Certificate resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: Certificate_spec; /** Status of the Certificate. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ status?: Certificate_status; } /** Specification of the desired state of the Certificate resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ interface Certificate_spec { /** * Defines extra output formats of the private key and signed certificate chain to be written to this Certificate's target Secret. * This is an Alpha Feature and is only enabled with the `--feature-gates=AdditionalCertificateOutputFormats=true` option set on both the controller and webhook components. */ additionalOutputFormats?: Certificate_spec_additionalOutputFormats[]; /** * Requested common name X509 certificate subject attribute. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 NOTE: TLS clients will ignore this value when any subject alternative name is set (see https://tools.ietf.org/html/rfc6125#section-6.4.4). * Should have a length of 64 characters or fewer to avoid generating invalid CSRs. Cannot be set if the `literalSubject` field is set. */ commonName?: string; /** Requested DNS subject alternative names. */ dnsNames?: string[]; /** * Requested 'duration' (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute. * If unset, this defaults to 90 days. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration. */ duration?: string; /** Requested email subject alternative names. */ emailAddresses?: string[]; /** * Whether the KeyUsage and ExtKeyUsage extensions should be set in the encoded CSR. * This option defaults to true, and should only be disabled if the target issuer does not support CSRs with these X509 KeyUsage/ ExtKeyUsage extensions. */ encodeUsagesInRequest?: boolean; /** Requested IP address subject alternative names. */ ipAddresses?: string[]; /** * Requested basic constraints isCA value. The isCA value is used to set the `isCA` field on the created CertificateRequest resources. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute. * If true, this will automatically add the `cert sign` usage to the list of requested `usages`. */ isCA?: boolean; /** * Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace. * The `name` field of the reference must always be specified. */ issuerRef: Certificate_spec_issuerRef; /** Additional keystore output formats to be stored in the Certificate's Secret. */ keystores?: Certificate_spec_keystores; /** * Requested X.509 certificate subject, represented using the LDAP "String Representation of a Distinguished Name" [1]. Important: the LDAP string format also specifies the order of the attributes in the subject, this is important when issuing certs for LDAP authentication. Example: `CN=foo,DC=corp,DC=example,DC=com` More info [1]: https://datatracker.ietf.org/doc/html/rfc4514 More info: https://github.com/cert-manager/cert-manager/issues/3203 More info: https://github.com/cert-manager/cert-manager/issues/4424 * Cannot be set if the `subject` or `commonName` field is set. This is an Alpha Feature and is only enabled with the `--feature-gates=LiteralCertificateSubject=true` option set on both the controller and webhook components. */ literalSubject?: string; /** Private key options. These include the key algorithm and size, the used encoding and the rotation policy. */ privateKey?: Certificate_spec_privateKey; /** * How long before the currently issued certificate's expiry cert-manager should renew the certificate. For example, if a certificate is valid for 60 minutes, and `renewBefore=10m`, cert-manager will begin to attempt to renew the certificate 50 minutes after it was issued (i.e. when there are 10 minutes remaining until the certificate is no longer valid). * NOTE: The actual lifetime of the issued certificate is used to determine the renewal time. If an issuer returns a certificate with a different lifetime than the one requested, cert-manager will use the lifetime of the issued certificate. * If unset, this defaults to 1/3 of the issued certificate's lifetime. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration. */ renewBefore?: string; /** * The maximum number of CertificateRequest revisions that are maintained in the Certificate's history. Each revision represents a single `CertificateRequest` created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number. * If set, revisionHistoryLimit must be a value of `1` or greater. If unset (`nil`), revisions will not be garbage collected. Default value is `nil`. * @format int32 */ revisionHistoryLimit?: number; /** Name of the Secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer. The Secret resource lives in the same namespace as the Certificate resource. */ secretName: string; /** Defines annotations and labels to be copied to the Certificate's Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate's Secret. */ secretTemplate?: Certificate_spec_secretTemplate; /** * Requested set of X509 certificate subject attributes. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 * The common name attribute is specified separately in the `commonName` field. Cannot be set if the `literalSubject` field is set. */ subject?: Certificate_spec_subject; /** Requested URI subject alternative names. */ uris?: string[]; /** * Requested key usages and extended key usages. These usages are used to set the `usages` field on the created CertificateRequest resources. If `encodeUsagesInRequest` is unset or set to `true`, the usages will additionally be encoded in the `request` field which contains the CSR blob. * If unset, defaults to `digital signature` and `key encipherment`. */ usages?: Array<"signing" | "digital signature" | "content commitment" | "key encipherment" | "key agreement" | "data encipherment" | "cert sign" | "crl sign" | "encipher only" | "decipher only" | "any" | "server auth" | "client auth" | "code signing" | "email protection" | "s/mime" | "ipsec end system" | "ipsec tunnel" | "ipsec user" | "timestamping" | "ocsp signing" | "microsoft sgc" | "netscape sgc">; } /** CertificateAdditionalOutputFormat defines an additional output format of a Certificate resource. These contain supplementary data formats of the signed certificate chain and paired private key. */ interface Certificate_spec_additionalOutputFormats { /** Type is the name of the format type that should be written to the Certificate's target Secret. */ type: "DER" | "CombinedPEM"; } /** * Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace. * The `name` field of the reference must always be specified. */ interface Certificate_spec_issuerRef { /** Group of the resource being referred to. */ group?: string; /** Kind of the resource being referred to. */ kind?: string; /** Name of the resource being referred to. */ name: string; } /** Additional keystore output formats to be stored in the Certificate's Secret. */ interface Certificate_spec_keystores { /** JKS configures options for storing a JKS keystore in the `spec.secretName` Secret resource. */ jks?: Certificate_spec_keystores_jks; /** PKCS12 configures options for storing a PKCS12 keystore in the `spec.secretName` Secret resource. */ pkcs12?: Certificate_spec_keystores_pkcs12; } /** JKS configures options for storing a JKS keystore in the `spec.secretName` Secret resource. */ interface Certificate_spec_keystores_jks { /** Create enables JKS keystore creation for the Certificate. If true, a file named `keystore.jks` will be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef`. The keystore file will be updated immediately. If the issuer provided a CA certificate, a file named `truststore.jks` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority */ create: boolean; /** PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore. */ passwordSecretRef: Certificate_spec_keystores_jks_passwordSecretRef; } /** PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore. */ interface Certificate_spec_keystores_jks_passwordSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** PKCS12 configures options for storing a PKCS12 keystore in the `spec.secretName` Secret resource. */ interface Certificate_spec_keystores_pkcs12 { /** Create enables PKCS12 keystore creation for the Certificate. If true, a file named `keystore.p12` will be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef`. The keystore file will be updated immediately. If the issuer provided a CA certificate, a file named `truststore.p12` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority */ create: boolean; /** PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore. */ passwordSecretRef: Certificate_spec_keystores_pkcs12_passwordSecretRef; } /** PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore. */ interface Certificate_spec_keystores_pkcs12_passwordSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Private key options. These include the key algorithm and size, the used encoding and the rotation policy. */ interface Certificate_spec_privateKey { /** * Algorithm is the private key algorithm of the corresponding private key for this certificate. * If provided, allowed values are either `RSA`, `ECDSA` or `Ed25519`. If `algorithm` is specified and `size` is not provided, key size of 2048 will be used for `RSA` key algorithm and key size of 256 will be used for `ECDSA` key algorithm. key size is ignored when using the `Ed25519` key algorithm. */ algorithm?: "RSA" | "ECDSA" | "Ed25519"; /** * The private key cryptography standards (PKCS) encoding for this certificate's private key to be encoded in. * If provided, allowed values are `PKCS1` and `PKCS8` standing for PKCS#1 and PKCS#8, respectively. Defaults to `PKCS1` if not specified. */ encoding?: "PKCS1" | "PKCS8"; /** * RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. * If set to `Never`, a private key will only be generated if one does not already exist in the target `spec.secretName`. If one does exists but it does not have the correct algorithm or size, a warning will be raised to await user intervention. If set to `Always`, a private key matching the specified requirements will be generated whenever a re-issuance occurs. Default is `Never` for backward compatibility. */ rotationPolicy?: "Never" | "Always"; /** * Size is the key bit size of the corresponding private key for this certificate. * If `algorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `algorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. If `algorithm` is set to `Ed25519`, Size is ignored. No other values are allowed. */ size?: number; } /** Defines annotations and labels to be copied to the Certificate's Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate's Secret. */ interface Certificate_spec_secretTemplate { /** Annotations is a key value map to be copied to the target Kubernetes Secret. */ annotations?: Record; /** Labels is a key value map to be copied to the target Kubernetes Secret. */ labels?: Record; } /** * Requested set of X509 certificate subject attributes. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 * The common name attribute is specified separately in the `commonName` field. Cannot be set if the `literalSubject` field is set. */ interface Certificate_spec_subject { /** Countries to be used on the Certificate. */ countries?: string[]; /** Cities to be used on the Certificate. */ localities?: string[]; /** Organizational Units to be used on the Certificate. */ organizationalUnits?: string[]; /** Organizations to be used on the Certificate. */ organizations?: string[]; /** Postal codes to be used on the Certificate. */ postalCodes?: string[]; /** State/Provinces to be used on the Certificate. */ provinces?: string[]; /** Serial number to be used on the Certificate. */ serialNumber?: string; /** Street addresses to be used on the Certificate. */ streetAddresses?: string[]; } /** Status of the Certificate. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ interface Certificate_status { /** List of status conditions to indicate the status of certificates. Known condition types are `Ready` and `Issuing`. */ conditions?: Certificate_status_conditions[]; /** The number of continuous failed issuance attempts up till now. This field gets removed (if set) on a successful issuance and gets set to 1 if unset and an issuance has failed. If an issuance has failed, the delay till the next issuance will be calculated using formula time.Hour * 2 ^ (failedIssuanceAttempts - 1). */ failedIssuanceAttempts?: number; /** * LastFailureTime is set only if the lastest issuance for this Certificate failed and contains the time of the failure. If an issuance has failed, the delay till the next issuance will be calculated using formula time.Hour * 2 ^ (failedIssuanceAttempts - 1). If the latest issuance has succeeded this field will be unset. * @format date-time */ lastFailureTime?: string; /** The name of the Secret resource containing the private key to be used for the next certificate iteration. The keymanager controller will automatically set this field if the `Issuing` condition is set to `True`. It will automatically unset this field when the Issuing condition is not set or False. */ nextPrivateKeySecretName?: string; /** * The expiration time of the certificate stored in the secret named by this resource in `spec.secretName`. * @format date-time */ notAfter?: string; /** * The time after which the certificate stored in the secret named by this resource in `spec.secretName` is valid. * @format date-time */ notBefore?: string; /** * RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled. * @format date-time */ renewalTime?: string; /** * The current 'revision' of the certificate as issued. * When a CertificateRequest resource is created, it will have the `cert-manager.io/certificate-revision` set to one greater than the current value of this field. * Upon issuance, this field will be set to the value of the annotation on the CertificateRequest resource used to issue the certificate. * Persisting the value on the CertificateRequest resource allows the certificates controller to know whether a request is part of an old issuance or if it is part of the ongoing revision's issuance by checking if the revision value in the annotation is greater than this field. */ revision?: number; } /** CertificateCondition contains condition information for an Certificate. */ interface Certificate_status_conditions { /** * LastTransitionTime is the timestamp corresponding to the last status change of this condition. * @format date-time */ lastTransitionTime?: string; /** Message is a human readable description of the details of the last transition, complementing reason. */ message?: string; /** * If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Certificate. * @format int64 */ observedGeneration?: number; /** Reason is a brief machine readable explanation for the condition's last transition. */ reason?: string; /** Status of the condition, one of (`True`, `False`, `Unknown`). */ status: "True" | "False" | "Unknown"; /** Type of the condition, known values are (`Ready`, `Issuing`). */ type: string; } /** A ClusterIssuer represents a certificate issuing authority which can be referenced as part of `issuerRef` fields. It is similar to an Issuer, however it is cluster-scoped and therefore can be referenced by resources that exist in *any* namespace, not just the same namespace as the referent. */ interface ClusterIssuer { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: object; /** Desired state of the ClusterIssuer resource. */ spec: ClusterIssuer_spec; /** Status of the ClusterIssuer. This is set and managed automatically. */ status?: ClusterIssuer_status; } /** Desired state of the ClusterIssuer resource. */ interface ClusterIssuer_spec { /** ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates. */ acme?: ClusterIssuer_spec_acme; /** CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager. */ ca?: ClusterIssuer_spec_ca; /** SelfSigned configures this issuer to 'self sign' certificates using the private key used to create the CertificateRequest object. */ selfSigned?: ClusterIssuer_spec_selfSigned; /** Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend. */ vault?: ClusterIssuer_spec_vault; /** Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone. */ venafi?: ClusterIssuer_spec_venafi; } /** ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates. */ interface ClusterIssuer_spec_acme { /** * Base64-encoded bundle of PEM CAs which can be used to validate the certificate chain presented by the ACME server. Mutually exclusive with SkipTLSVerify; prefer using CABundle to prevent various kinds of security vulnerabilities. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection. * @format byte */ caBundle?: string; /** Enables or disables generating a new ACME account key. If true, the Issuer resource will *not* request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false. */ disableAccountKeyGeneration?: boolean; /** Email is the email address to be associated with the ACME account. This field is optional, but it is strongly recommended to be set. It will be used to contact you in case of issues with your account or certificates, including expiry notification emails. This field may be updated after the account is initially registered. */ email?: string; /** Enables requesting a Not After date on certificates that matches the duration of the certificate. This is not supported by all ACME servers like Let's Encrypt. If set to true when the ACME server does not support it it will create an error on the Order. Defaults to false. */ enableDurationFeature?: boolean; /** ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account. */ externalAccountBinding?: ClusterIssuer_spec_acme_externalAccountBinding; /** PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let's Encrypt's DST crosssign you would use: "DST Root CA X3" or "ISRG Root X1" for the newer Let's Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer's CN */ preferredChain?: string; /** PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a `key` may be specified to select a specific entry within the named Secret resource. If `key` is not specified, a default of `tls.key` will be used. */ privateKeySecretRef: ClusterIssuer_spec_acme_privateKeySecretRef; /** Server is the URL used to access the ACME server's 'directory' endpoint. For example, for Let's Encrypt's staging endpoint, you would use: "https://acme-staging-v02.api.letsencrypt.org/directory". Only ACME v2 endpoints (i.e. RFC 8555) are supported. */ server: string; /** INSECURE: Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have the TLS certificate chain validated. Mutually exclusive with CABundle; prefer using CABundle to prevent various kinds of security vulnerabilities. Only enable this option in development environments. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection. Defaults to false. */ skipTLSVerify?: boolean; /** Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/ */ solvers?: ClusterIssuer_spec_acme_solvers[]; } /** ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account. */ interface ClusterIssuer_spec_acme_externalAccountBinding { /** Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme. */ keyAlgorithm?: "HS256" | "HS384" | "HS512"; /** keyID is the ID of the CA key that the External Account is bound to. */ keyID: string; /** keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The `key` is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret **must** be un-padded, base64 URL encoded data. */ keySecretRef: ClusterIssuer_spec_acme_externalAccountBinding_keySecretRef; } /** keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The `key` is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret **must** be un-padded, base64 URL encoded data. */ interface ClusterIssuer_spec_acme_externalAccountBinding_keySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a `key` may be specified to select a specific entry within the named Secret resource. If `key` is not specified, a default of `tls.key` will be used. */ interface ClusterIssuer_spec_acme_privateKeySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided. */ interface ClusterIssuer_spec_acme_solvers { /** Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. */ dns01?: ClusterIssuer_spec_acme_solvers_dns01; /** Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism. */ http01?: ClusterIssuer_spec_acme_solvers_http01; /** Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. */ selector?: ClusterIssuer_spec_acme_solvers_selector; } /** Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. */ interface ClusterIssuer_spec_acme_solvers_dns01 { /** Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. */ acmeDNS?: ClusterIssuer_spec_acme_solvers_dns01_acmeDNS; /** Use the Akamai DNS zone management API to manage DNS01 challenge records. */ akamai?: ClusterIssuer_spec_acme_solvers_dns01_akamai; /** Use the Microsoft Azure DNS API to manage DNS01 challenge records. */ azureDNS?: ClusterIssuer_spec_acme_solvers_dns01_azureDNS; /** Use the Google Cloud DNS API to manage DNS01 challenge records. */ cloudDNS?: ClusterIssuer_spec_acme_solvers_dns01_cloudDNS; /** Use the Cloudflare API to manage DNS01 challenge records. */ cloudflare?: ClusterIssuer_spec_acme_solvers_dns01_cloudflare; /** CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. */ cnameStrategy?: "None" | "Follow"; /** Use the DigitalOcean DNS API to manage DNS01 challenge records. */ digitalocean?: ClusterIssuer_spec_acme_solvers_dns01_digitalocean; /** Use RFC2136 ("Dynamic Updates in the Domain Name System") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. */ rfc2136?: ClusterIssuer_spec_acme_solvers_dns01_rfc2136; /** Use the AWS Route53 API to manage DNS01 challenge records. */ route53?: ClusterIssuer_spec_acme_solvers_dns01_route53; /** Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. */ webhook?: ClusterIssuer_spec_acme_solvers_dns01_webhook; } /** Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_acmeDNS { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ accountSecretRef: ClusterIssuer_spec_acme_solvers_dns01_acmeDNS_accountSecretRef; /** */ host: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface ClusterIssuer_spec_acme_solvers_dns01_acmeDNS_accountSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Akamai DNS zone management API to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_akamai { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ accessTokenSecretRef: ClusterIssuer_spec_acme_solvers_dns01_akamai_accessTokenSecretRef; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ clientSecretSecretRef: ClusterIssuer_spec_acme_solvers_dns01_akamai_clientSecretSecretRef; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ clientTokenSecretRef: ClusterIssuer_spec_acme_solvers_dns01_akamai_clientTokenSecretRef; /** */ serviceConsumerDomain: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface ClusterIssuer_spec_acme_solvers_dns01_akamai_accessTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface ClusterIssuer_spec_acme_solvers_dns01_akamai_clientSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface ClusterIssuer_spec_acme_solvers_dns01_akamai_clientTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Microsoft Azure DNS API to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_azureDNS { /** if both this and ClientSecret are left unset MSI will be used */ clientID?: string; /** if both this and ClientID are left unset MSI will be used */ clientSecretSecretRef?: ClusterIssuer_spec_acme_solvers_dns01_azureDNS_clientSecretSecretRef; /** name of the Azure environment (default AzurePublicCloud) */ environment?: "AzurePublicCloud" | "AzureChinaCloud" | "AzureGermanCloud" | "AzureUSGovernmentCloud"; /** name of the DNS zone that should be used */ hostedZoneName?: string; /** managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID */ managedIdentity?: ClusterIssuer_spec_acme_solvers_dns01_azureDNS_managedIdentity; /** resource group the DNS zone is located in */ resourceGroupName: string; /** ID of the Azure subscription */ subscriptionID: string; /** when specifying ClientID and ClientSecret then this field is also needed */ tenantID?: string; } /** if both this and ClientID are left unset MSI will be used */ interface ClusterIssuer_spec_acme_solvers_dns01_azureDNS_clientSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID */ interface ClusterIssuer_spec_acme_solvers_dns01_azureDNS_managedIdentity { /** client ID of the managed identity, can not be used at the same time as resourceID */ clientID?: string; /** resource ID of the managed identity, can not be used at the same time as clientID */ resourceID?: string; } /** Use the Google Cloud DNS API to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_cloudDNS { /** HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone. */ hostedZoneName?: string; /** */ project: string; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ serviceAccountSecretRef?: ClusterIssuer_spec_acme_solvers_dns01_cloudDNS_serviceAccountSecretRef; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface ClusterIssuer_spec_acme_solvers_dns01_cloudDNS_serviceAccountSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Cloudflare API to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_cloudflare { /** API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. */ apiKeySecretRef?: ClusterIssuer_spec_acme_solvers_dns01_cloudflare_apiKeySecretRef; /** API token used to authenticate with Cloudflare. */ apiTokenSecretRef?: ClusterIssuer_spec_acme_solvers_dns01_cloudflare_apiTokenSecretRef; /** Email of the account, only required when using API key based authentication. */ email?: string; } /** API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. */ interface ClusterIssuer_spec_acme_solvers_dns01_cloudflare_apiKeySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** API token used to authenticate with Cloudflare. */ interface ClusterIssuer_spec_acme_solvers_dns01_cloudflare_apiTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the DigitalOcean DNS API to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_digitalocean { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ tokenSecretRef: ClusterIssuer_spec_acme_solvers_dns01_digitalocean_tokenSecretRef; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface ClusterIssuer_spec_acme_solvers_dns01_digitalocean_tokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use RFC2136 ("Dynamic Updates in the Domain Name System") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_rfc2136 { /** The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required. */ nameserver: string; /** The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when ``tsigSecretSecretRef`` and ``tsigKeyName`` are defined. Supported values are (case-insensitive): ``HMACMD5`` (default), ``HMACSHA1``, ``HMACSHA256`` or ``HMACSHA512``. */ tsigAlgorithm?: string; /** The TSIG Key name configured in the DNS. If ``tsigSecretSecretRef`` is defined, this field is required. */ tsigKeyName?: string; /** The name of the secret containing the TSIG value. If ``tsigKeyName`` is defined, this field is required. */ tsigSecretSecretRef?: ClusterIssuer_spec_acme_solvers_dns01_rfc2136_tsigSecretSecretRef; } /** The name of the secret containing the TSIG value. If ``tsigKeyName`` is defined, this field is required. */ interface ClusterIssuer_spec_acme_solvers_dns01_rfc2136_tsigSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the AWS Route53 API to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_route53 { /** The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ accessKeyID?: string; /** The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ accessKeyIDSecretRef?: ClusterIssuer_spec_acme_solvers_dns01_route53_accessKeyIDSecretRef; /** If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call. */ hostedZoneID?: string; /** Always set the region when using AccessKeyID and SecretAccessKey */ region: string; /** Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata */ role?: string; /** The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ secretAccessKeySecretRef?: ClusterIssuer_spec_acme_solvers_dns01_route53_secretAccessKeySecretRef; } /** The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ interface ClusterIssuer_spec_acme_solvers_dns01_route53_accessKeyIDSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ interface ClusterIssuer_spec_acme_solvers_dns01_route53_secretAccessKeySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. */ interface ClusterIssuer_spec_acme_solvers_dns01_webhook { /** Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation's documentation. */ config?: any; /** The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation. */ groupName: string; /** The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. 'cloudflare'. */ solverName: string; } /** Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism. */ interface ClusterIssuer_spec_acme_solvers_http01 { /** The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future. */ gatewayHTTPRoute?: ClusterIssuer_spec_acme_solvers_http01_gatewayHTTPRoute; /** The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. */ ingress?: ClusterIssuer_spec_acme_solvers_http01_ingress; } /** The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future. */ interface ClusterIssuer_spec_acme_solvers_http01_gatewayHTTPRoute { /** Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges. */ labels?: Record; /** When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways */ parentRefs?: ClusterIssuer_spec_acme_solvers_http01_gatewayHTTPRoute_parentRefs[]; /** Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. */ serviceType?: string; } /** * ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). There are two kinds of parent resources with "Core" support: * * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) * This API may be extended in the future to support additional kinds of parent resources. * The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid. */ interface ClusterIssuer_spec_acme_solvers_http01_gatewayHTTPRoute_parentRefs { /** * Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string). * Support: Core * @pattern ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ * @default gateway.networking.k8s.io */ group?: string; /** * Kind is kind of the referent. * There are two kinds of parent resources with "Core" support: * * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) * Support for other resources is Implementation-Specific. * @pattern ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$ * @default Gateway */ kind?: string; /** * Name is the name of the referent. * Support: Core */ name: string; /** * Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. * Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. * ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. * ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. * Support: Core * @pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ */ namespace?: string; /** * Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. * When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. * When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. * Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. * For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. * Support: Extended * * @format int32 */ port?: number; /** * SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. * Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. * When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. * Support: Core * @pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ */ sectionName?: string; } /** The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress { /** This field configures the annotation `kubernetes.io/ingress.class` when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of `class`, `name` or `ingressClassName` may be specified. */ class?: string; /** This field configures the field `ingressClassName` on the created Ingress resources used to solve ACME challenges that use this challenge solver. This is the recommended way of configuring the ingress class. Only one of `class`, `name` or `ingressClassName` may be specified. */ ingressClassName?: string; /** Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges. */ ingressTemplate?: ClusterIssuer_spec_acme_solvers_http01_ingress_ingressTemplate; /** The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. Only one of `class`, `name` or `ingressClassName` may be specified. */ name?: string; /** Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges. */ podTemplate?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate; /** Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. */ serviceType?: string; } /** Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_ingressTemplate { /** ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ metadata?: ClusterIssuer_spec_acme_solvers_http01_ingress_ingressTemplate_metadata; } /** ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_ingressTemplate_metadata { /** Annotations that should be added to the created ACME HTTP01 solver ingress. */ annotations?: Record; /** Labels that should be added to the created ACME HTTP01 solver ingress. */ labels?: Record; } /** Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate { /** ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ metadata?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_metadata; /** PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored. */ spec?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec; } /** ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_metadata { /** Annotations that should be added to the create ACME HTTP01 solver pods. */ annotations?: Record; /** Labels that should be added to the created ACME HTTP01 solver pods. */ labels?: Record; } /** PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec { /** If specified, the pod's scheduling constraints */ affinity?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity; /** If specified, the pod's imagePullSecrets */ imagePullSecrets?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_imagePullSecrets[]; /** NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ */ nodeSelector?: Record; /** If specified, the pod's priorityClassName. */ priorityClassName?: string; /** If specified, the pod's service account */ serviceAccountName?: string; /** If specified, the pod's tolerations. */ tolerations?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_tolerations[]; } /** If specified, the pod's scheduling constraints */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity { /** Describes node affinity scheduling rules for the pod. */ nodeAffinity?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity; /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ podAffinity?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity; /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ podAntiAffinity?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity; } /** Describes node affinity scheduling rules for the pod. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ requiredDuringSchedulingIgnoredDuringExecution?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A node selector term, associated with the corresponding weight. */ preference: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A node selector term, associated with the corresponding weight. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Required. A pod affinity term, associated with the corresponding weight. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label query over a set of resources, in this case pods. */ labelSelector?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Required. A pod affinity term, associated with the corresponding weight. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label query over a set of resources, in this case pods. */ labelSelector?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_imagePullSecrets { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . */ interface ClusterIssuer_spec_acme_solvers_http01_ingress_podTemplate_spec_tolerations { /** Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. */ interface ClusterIssuer_spec_acme_solvers_selector { /** List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. */ dnsNames?: string[]; /** List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. */ dnsZones?: string[]; /** A label selector that is used to refine the set of certificate's that this challenge solver will apply to. */ matchLabels?: Record; } /** CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager. */ interface ClusterIssuer_spec_ca { /** The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set. */ crlDistributionPoints?: string[]; /** The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be "http://ocsp.int-x3.letsencrypt.org". */ ocspServers?: string[]; /** SecretName is the name of the secret used to sign Certificates issued by this Issuer. */ secretName: string; } /** SelfSigned configures this issuer to 'self sign' certificates using the private key used to create the CertificateRequest object. */ interface ClusterIssuer_spec_selfSigned { /** The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings. */ crlDistributionPoints?: string[]; } /** Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend. */ interface ClusterIssuer_spec_vault { /** Auth configures how cert-manager authenticates with the Vault server. */ auth: ClusterIssuer_spec_vault_auth; /** * Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by Vault. Only used if using HTTPS to connect to Vault and ignored for HTTP connections. Mutually exclusive with CABundleSecretRef. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. * @format byte */ caBundle?: string; /** Reference to a Secret containing a bundle of PEM-encoded CAs to use when verifying the certificate chain presented by Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to 'ca.crt'. */ caBundleSecretRef?: ClusterIssuer_spec_vault_caBundleSecretRef; /** Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: "ns1" More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces */ namespace?: string; /** Path is the mount path of the Vault PKI backend's `sign` endpoint, e.g: "my_pki_mount/sign/my-role-name". */ path: string; /** Server is the connection address for the Vault server, e.g: "https://vault.example.com:8200". */ server: string; } /** Auth configures how cert-manager authenticates with the Vault server. */ interface ClusterIssuer_spec_vault_auth { /** AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource. */ appRole?: ClusterIssuer_spec_vault_auth_appRole; /** Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server. */ kubernetes?: ClusterIssuer_spec_vault_auth_kubernetes; /** TokenSecretRef authenticates with Vault by presenting a token. */ tokenSecretRef?: ClusterIssuer_spec_vault_auth_tokenSecretRef; } /** AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource. */ interface ClusterIssuer_spec_vault_auth_appRole { /** Path where the App Role authentication backend is mounted in Vault, e.g: "approle" */ path: string; /** RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault. */ roleId: string; /** Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The `key` field must be specified and denotes which entry within the Secret resource is used as the app role secret. */ secretRef: ClusterIssuer_spec_vault_auth_appRole_secretRef; } /** Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The `key` field must be specified and denotes which entry within the Secret resource is used as the app role secret. */ interface ClusterIssuer_spec_vault_auth_appRole_secretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server. */ interface ClusterIssuer_spec_vault_auth_kubernetes { /** The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to `/v1/auth/foo`, will use the path `/v1/auth/foo/login` to authenticate with Vault. If unspecified, the default value "/v1/auth/kubernetes" will be used. */ mountPath?: string; /** A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies. */ role: string; /** The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of 'ambient credentials' is not supported. */ secretRef?: ClusterIssuer_spec_vault_auth_kubernetes_secretRef; /** A reference to a service account that will be used to request a bound token (also known as "projected token"). Compared to using "secretRef", using this field means that you don't rely on statically bound tokens. To use this field, you must configure an RBAC rule to let cert-manager request a token. */ serviceAccountRef?: ClusterIssuer_spec_vault_auth_kubernetes_serviceAccountRef; } /** The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of 'ambient credentials' is not supported. */ interface ClusterIssuer_spec_vault_auth_kubernetes_secretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** A reference to a service account that will be used to request a bound token (also known as "projected token"). Compared to using "secretRef", using this field means that you don't rely on statically bound tokens. To use this field, you must configure an RBAC rule to let cert-manager request a token. */ interface ClusterIssuer_spec_vault_auth_kubernetes_serviceAccountRef { /** Name of the ServiceAccount used to request a token. */ name: string; } /** TokenSecretRef authenticates with Vault by presenting a token. */ interface ClusterIssuer_spec_vault_auth_tokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Reference to a Secret containing a bundle of PEM-encoded CAs to use when verifying the certificate chain presented by Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to 'ca.crt'. */ interface ClusterIssuer_spec_vault_caBundleSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone. */ interface ClusterIssuer_spec_venafi { /** Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified. */ cloud?: ClusterIssuer_spec_venafi_cloud; /** TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified. */ tpp?: ClusterIssuer_spec_venafi_tpp; /** Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required. */ zone: string; } /** Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified. */ interface ClusterIssuer_spec_venafi_cloud { /** APITokenSecretRef is a secret key selector for the Venafi Cloud API token. */ apiTokenSecretRef: ClusterIssuer_spec_venafi_cloud_apiTokenSecretRef; /** URL is the base URL for Venafi Cloud. Defaults to "https://api.venafi.cloud/v1". */ url?: string; } /** APITokenSecretRef is a secret key selector for the Venafi Cloud API token. */ interface ClusterIssuer_spec_venafi_cloud_apiTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified. */ interface ClusterIssuer_spec_venafi_tpp { /** * Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by the TPP server. Only used if using HTTPS; ignored for HTTP. If undefined, the certificate bundle in the cert-manager controller container is used to validate the chain. * @format byte */ caBundle?: string; /** CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, 'username' and 'password'. */ credentialsRef: ClusterIssuer_spec_venafi_tpp_credentialsRef; /** URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: "https://tpp.example.com/vedsdk". */ url: string; } /** CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, 'username' and 'password'. */ interface ClusterIssuer_spec_venafi_tpp_credentialsRef { /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Status of the ClusterIssuer. This is set and managed automatically. */ interface ClusterIssuer_status { /** ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates. */ acme?: ClusterIssuer_status_acme; /** List of status conditions to indicate the status of a CertificateRequest. Known condition types are `Ready`. */ conditions?: ClusterIssuer_status_conditions[]; } /** ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates. */ interface ClusterIssuer_status_acme { /** LastPrivateKeyHash is a hash of the private key associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer */ lastPrivateKeyHash?: string; /** LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer */ lastRegisteredEmail?: string; /** URI is the unique account identifier, which can also be used to retrieve account details from the CA */ uri?: string; } /** IssuerCondition contains condition information for an Issuer. */ interface ClusterIssuer_status_conditions { /** * LastTransitionTime is the timestamp corresponding to the last status change of this condition. * @format date-time */ lastTransitionTime?: string; /** Message is a human readable description of the details of the last transition, complementing reason. */ message?: string; /** * If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer. * @format int64 */ observedGeneration?: number; /** Reason is a brief machine readable explanation for the condition's last transition. */ reason?: string; /** Status of the condition, one of (`True`, `False`, `Unknown`). */ status: "True" | "False" | "Unknown"; /** Type of the condition, known values are (`Ready`). */ type: string; } /** An Issuer represents a certificate issuing authority which can be referenced as part of `issuerRef` fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace. */ interface Issuer { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: object; /** Desired state of the Issuer resource. */ spec: Issuer_spec; /** Status of the Issuer. This is set and managed automatically. */ status?: Issuer_status; } /** Desired state of the Issuer resource. */ interface Issuer_spec { /** ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates. */ acme?: Issuer_spec_acme; /** CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager. */ ca?: Issuer_spec_ca; /** SelfSigned configures this issuer to 'self sign' certificates using the private key used to create the CertificateRequest object. */ selfSigned?: Issuer_spec_selfSigned; /** Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend. */ vault?: Issuer_spec_vault; /** Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone. */ venafi?: Issuer_spec_venafi; } /** ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates. */ interface Issuer_spec_acme { /** * Base64-encoded bundle of PEM CAs which can be used to validate the certificate chain presented by the ACME server. Mutually exclusive with SkipTLSVerify; prefer using CABundle to prevent various kinds of security vulnerabilities. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection. * @format byte */ caBundle?: string; /** Enables or disables generating a new ACME account key. If true, the Issuer resource will *not* request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false. */ disableAccountKeyGeneration?: boolean; /** Email is the email address to be associated with the ACME account. This field is optional, but it is strongly recommended to be set. It will be used to contact you in case of issues with your account or certificates, including expiry notification emails. This field may be updated after the account is initially registered. */ email?: string; /** Enables requesting a Not After date on certificates that matches the duration of the certificate. This is not supported by all ACME servers like Let's Encrypt. If set to true when the ACME server does not support it it will create an error on the Order. Defaults to false. */ enableDurationFeature?: boolean; /** ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account. */ externalAccountBinding?: Issuer_spec_acme_externalAccountBinding; /** PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let's Encrypt's DST crosssign you would use: "DST Root CA X3" or "ISRG Root X1" for the newer Let's Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer's CN */ preferredChain?: string; /** PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a `key` may be specified to select a specific entry within the named Secret resource. If `key` is not specified, a default of `tls.key` will be used. */ privateKeySecretRef: Issuer_spec_acme_privateKeySecretRef; /** Server is the URL used to access the ACME server's 'directory' endpoint. For example, for Let's Encrypt's staging endpoint, you would use: "https://acme-staging-v02.api.letsencrypt.org/directory". Only ACME v2 endpoints (i.e. RFC 8555) are supported. */ server: string; /** INSECURE: Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have the TLS certificate chain validated. Mutually exclusive with CABundle; prefer using CABundle to prevent various kinds of security vulnerabilities. Only enable this option in development environments. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection. Defaults to false. */ skipTLSVerify?: boolean; /** Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/ */ solvers?: Issuer_spec_acme_solvers[]; } /** ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account. */ interface Issuer_spec_acme_externalAccountBinding { /** Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme. */ keyAlgorithm?: "HS256" | "HS384" | "HS512"; /** keyID is the ID of the CA key that the External Account is bound to. */ keyID: string; /** keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The `key` is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret **must** be un-padded, base64 URL encoded data. */ keySecretRef: Issuer_spec_acme_externalAccountBinding_keySecretRef; } /** keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The `key` is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret **must** be un-padded, base64 URL encoded data. */ interface Issuer_spec_acme_externalAccountBinding_keySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a `key` may be specified to select a specific entry within the named Secret resource. If `key` is not specified, a default of `tls.key` will be used. */ interface Issuer_spec_acme_privateKeySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided. */ interface Issuer_spec_acme_solvers { /** Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. */ dns01?: Issuer_spec_acme_solvers_dns01; /** Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism. */ http01?: Issuer_spec_acme_solvers_http01; /** Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. */ selector?: Issuer_spec_acme_solvers_selector; } /** Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. */ interface Issuer_spec_acme_solvers_dns01 { /** Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. */ acmeDNS?: Issuer_spec_acme_solvers_dns01_acmeDNS; /** Use the Akamai DNS zone management API to manage DNS01 challenge records. */ akamai?: Issuer_spec_acme_solvers_dns01_akamai; /** Use the Microsoft Azure DNS API to manage DNS01 challenge records. */ azureDNS?: Issuer_spec_acme_solvers_dns01_azureDNS; /** Use the Google Cloud DNS API to manage DNS01 challenge records. */ cloudDNS?: Issuer_spec_acme_solvers_dns01_cloudDNS; /** Use the Cloudflare API to manage DNS01 challenge records. */ cloudflare?: Issuer_spec_acme_solvers_dns01_cloudflare; /** CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. */ cnameStrategy?: "None" | "Follow"; /** Use the DigitalOcean DNS API to manage DNS01 challenge records. */ digitalocean?: Issuer_spec_acme_solvers_dns01_digitalocean; /** Use RFC2136 ("Dynamic Updates in the Domain Name System") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. */ rfc2136?: Issuer_spec_acme_solvers_dns01_rfc2136; /** Use the AWS Route53 API to manage DNS01 challenge records. */ route53?: Issuer_spec_acme_solvers_dns01_route53; /** Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. */ webhook?: Issuer_spec_acme_solvers_dns01_webhook; } /** Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_acmeDNS { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ accountSecretRef: Issuer_spec_acme_solvers_dns01_acmeDNS_accountSecretRef; /** */ host: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Issuer_spec_acme_solvers_dns01_acmeDNS_accountSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Akamai DNS zone management API to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_akamai { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ accessTokenSecretRef: Issuer_spec_acme_solvers_dns01_akamai_accessTokenSecretRef; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ clientSecretSecretRef: Issuer_spec_acme_solvers_dns01_akamai_clientSecretSecretRef; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ clientTokenSecretRef: Issuer_spec_acme_solvers_dns01_akamai_clientTokenSecretRef; /** */ serviceConsumerDomain: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Issuer_spec_acme_solvers_dns01_akamai_accessTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Issuer_spec_acme_solvers_dns01_akamai_clientSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Issuer_spec_acme_solvers_dns01_akamai_clientTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Microsoft Azure DNS API to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_azureDNS { /** if both this and ClientSecret are left unset MSI will be used */ clientID?: string; /** if both this and ClientID are left unset MSI will be used */ clientSecretSecretRef?: Issuer_spec_acme_solvers_dns01_azureDNS_clientSecretSecretRef; /** name of the Azure environment (default AzurePublicCloud) */ environment?: "AzurePublicCloud" | "AzureChinaCloud" | "AzureGermanCloud" | "AzureUSGovernmentCloud"; /** name of the DNS zone that should be used */ hostedZoneName?: string; /** managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID */ managedIdentity?: Issuer_spec_acme_solvers_dns01_azureDNS_managedIdentity; /** resource group the DNS zone is located in */ resourceGroupName: string; /** ID of the Azure subscription */ subscriptionID: string; /** when specifying ClientID and ClientSecret then this field is also needed */ tenantID?: string; } /** if both this and ClientID are left unset MSI will be used */ interface Issuer_spec_acme_solvers_dns01_azureDNS_clientSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID */ interface Issuer_spec_acme_solvers_dns01_azureDNS_managedIdentity { /** client ID of the managed identity, can not be used at the same time as resourceID */ clientID?: string; /** resource ID of the managed identity, can not be used at the same time as clientID */ resourceID?: string; } /** Use the Google Cloud DNS API to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_cloudDNS { /** HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone. */ hostedZoneName?: string; /** */ project: string; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ serviceAccountSecretRef?: Issuer_spec_acme_solvers_dns01_cloudDNS_serviceAccountSecretRef; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Issuer_spec_acme_solvers_dns01_cloudDNS_serviceAccountSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Cloudflare API to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_cloudflare { /** API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. */ apiKeySecretRef?: Issuer_spec_acme_solvers_dns01_cloudflare_apiKeySecretRef; /** API token used to authenticate with Cloudflare. */ apiTokenSecretRef?: Issuer_spec_acme_solvers_dns01_cloudflare_apiTokenSecretRef; /** Email of the account, only required when using API key based authentication. */ email?: string; } /** API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. */ interface Issuer_spec_acme_solvers_dns01_cloudflare_apiKeySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** API token used to authenticate with Cloudflare. */ interface Issuer_spec_acme_solvers_dns01_cloudflare_apiTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the DigitalOcean DNS API to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_digitalocean { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ tokenSecretRef: Issuer_spec_acme_solvers_dns01_digitalocean_tokenSecretRef; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Issuer_spec_acme_solvers_dns01_digitalocean_tokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use RFC2136 ("Dynamic Updates in the Domain Name System") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_rfc2136 { /** The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required. */ nameserver: string; /** The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when ``tsigSecretSecretRef`` and ``tsigKeyName`` are defined. Supported values are (case-insensitive): ``HMACMD5`` (default), ``HMACSHA1``, ``HMACSHA256`` or ``HMACSHA512``. */ tsigAlgorithm?: string; /** The TSIG Key name configured in the DNS. If ``tsigSecretSecretRef`` is defined, this field is required. */ tsigKeyName?: string; /** The name of the secret containing the TSIG value. If ``tsigKeyName`` is defined, this field is required. */ tsigSecretSecretRef?: Issuer_spec_acme_solvers_dns01_rfc2136_tsigSecretSecretRef; } /** The name of the secret containing the TSIG value. If ``tsigKeyName`` is defined, this field is required. */ interface Issuer_spec_acme_solvers_dns01_rfc2136_tsigSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the AWS Route53 API to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_route53 { /** The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ accessKeyID?: string; /** The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ accessKeyIDSecretRef?: Issuer_spec_acme_solvers_dns01_route53_accessKeyIDSecretRef; /** If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call. */ hostedZoneID?: string; /** Always set the region when using AccessKeyID and SecretAccessKey */ region: string; /** Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata */ role?: string; /** The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ secretAccessKeySecretRef?: Issuer_spec_acme_solvers_dns01_route53_secretAccessKeySecretRef; } /** The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ interface Issuer_spec_acme_solvers_dns01_route53_accessKeyIDSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ interface Issuer_spec_acme_solvers_dns01_route53_secretAccessKeySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. */ interface Issuer_spec_acme_solvers_dns01_webhook { /** Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation's documentation. */ config?: any; /** The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation. */ groupName: string; /** The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. 'cloudflare'. */ solverName: string; } /** Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism. */ interface Issuer_spec_acme_solvers_http01 { /** The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future. */ gatewayHTTPRoute?: Issuer_spec_acme_solvers_http01_gatewayHTTPRoute; /** The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. */ ingress?: Issuer_spec_acme_solvers_http01_ingress; } /** The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future. */ interface Issuer_spec_acme_solvers_http01_gatewayHTTPRoute { /** Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges. */ labels?: Record; /** When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways */ parentRefs?: Issuer_spec_acme_solvers_http01_gatewayHTTPRoute_parentRefs[]; /** Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. */ serviceType?: string; } /** * ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). There are two kinds of parent resources with "Core" support: * * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) * This API may be extended in the future to support additional kinds of parent resources. * The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid. */ interface Issuer_spec_acme_solvers_http01_gatewayHTTPRoute_parentRefs { /** * Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string). * Support: Core * @pattern ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ * @default gateway.networking.k8s.io */ group?: string; /** * Kind is kind of the referent. * There are two kinds of parent resources with "Core" support: * * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) * Support for other resources is Implementation-Specific. * @pattern ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$ * @default Gateway */ kind?: string; /** * Name is the name of the referent. * Support: Core */ name: string; /** * Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. * Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. * ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. * ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. * Support: Core * @pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ */ namespace?: string; /** * Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. * When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. * When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. * Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. * For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. * Support: Extended * * @format int32 */ port?: number; /** * SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. * Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. * When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. * Support: Core * @pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ */ sectionName?: string; } /** The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. */ interface Issuer_spec_acme_solvers_http01_ingress { /** This field configures the annotation `kubernetes.io/ingress.class` when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of `class`, `name` or `ingressClassName` may be specified. */ class?: string; /** This field configures the field `ingressClassName` on the created Ingress resources used to solve ACME challenges that use this challenge solver. This is the recommended way of configuring the ingress class. Only one of `class`, `name` or `ingressClassName` may be specified. */ ingressClassName?: string; /** Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges. */ ingressTemplate?: Issuer_spec_acme_solvers_http01_ingress_ingressTemplate; /** The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. Only one of `class`, `name` or `ingressClassName` may be specified. */ name?: string; /** Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges. */ podTemplate?: Issuer_spec_acme_solvers_http01_ingress_podTemplate; /** Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. */ serviceType?: string; } /** Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges. */ interface Issuer_spec_acme_solvers_http01_ingress_ingressTemplate { /** ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ metadata?: Issuer_spec_acme_solvers_http01_ingress_ingressTemplate_metadata; } /** ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ interface Issuer_spec_acme_solvers_http01_ingress_ingressTemplate_metadata { /** Annotations that should be added to the created ACME HTTP01 solver ingress. */ annotations?: Record; /** Labels that should be added to the created ACME HTTP01 solver ingress. */ labels?: Record; } /** Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate { /** ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ metadata?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_metadata; /** PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored. */ spec?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec; } /** ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_metadata { /** Annotations that should be added to the create ACME HTTP01 solver pods. */ annotations?: Record; /** Labels that should be added to the created ACME HTTP01 solver pods. */ labels?: Record; } /** PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec { /** If specified, the pod's scheduling constraints */ affinity?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity; /** If specified, the pod's imagePullSecrets */ imagePullSecrets?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_imagePullSecrets[]; /** NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ */ nodeSelector?: Record; /** If specified, the pod's priorityClassName. */ priorityClassName?: string; /** If specified, the pod's service account */ serviceAccountName?: string; /** If specified, the pod's tolerations. */ tolerations?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_tolerations[]; } /** If specified, the pod's scheduling constraints */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity { /** Describes node affinity scheduling rules for the pod. */ nodeAffinity?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity; /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ podAffinity?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity; /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ podAntiAffinity?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity; } /** Describes node affinity scheduling rules for the pod. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ requiredDuringSchedulingIgnoredDuringExecution?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A node selector term, associated with the corresponding weight. */ preference: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A node selector term, associated with the corresponding weight. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Required. A pod affinity term, associated with the corresponding weight. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label query over a set of resources, in this case pods. */ labelSelector?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Required. A pod affinity term, associated with the corresponding weight. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label query over a set of resources, in this case pods. */ labelSelector?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_imagePullSecrets { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . */ interface Issuer_spec_acme_solvers_http01_ingress_podTemplate_spec_tolerations { /** Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. */ interface Issuer_spec_acme_solvers_selector { /** List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. */ dnsNames?: string[]; /** List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. */ dnsZones?: string[]; /** A label selector that is used to refine the set of certificate's that this challenge solver will apply to. */ matchLabels?: Record; } /** CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager. */ interface Issuer_spec_ca { /** The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set. */ crlDistributionPoints?: string[]; /** The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be "http://ocsp.int-x3.letsencrypt.org". */ ocspServers?: string[]; /** SecretName is the name of the secret used to sign Certificates issued by this Issuer. */ secretName: string; } /** SelfSigned configures this issuer to 'self sign' certificates using the private key used to create the CertificateRequest object. */ interface Issuer_spec_selfSigned { /** The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings. */ crlDistributionPoints?: string[]; } /** Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend. */ interface Issuer_spec_vault { /** Auth configures how cert-manager authenticates with the Vault server. */ auth: Issuer_spec_vault_auth; /** * Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by Vault. Only used if using HTTPS to connect to Vault and ignored for HTTP connections. Mutually exclusive with CABundleSecretRef. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. * @format byte */ caBundle?: string; /** Reference to a Secret containing a bundle of PEM-encoded CAs to use when verifying the certificate chain presented by Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to 'ca.crt'. */ caBundleSecretRef?: Issuer_spec_vault_caBundleSecretRef; /** Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: "ns1" More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces */ namespace?: string; /** Path is the mount path of the Vault PKI backend's `sign` endpoint, e.g: "my_pki_mount/sign/my-role-name". */ path: string; /** Server is the connection address for the Vault server, e.g: "https://vault.example.com:8200". */ server: string; } /** Auth configures how cert-manager authenticates with the Vault server. */ interface Issuer_spec_vault_auth { /** AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource. */ appRole?: Issuer_spec_vault_auth_appRole; /** Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server. */ kubernetes?: Issuer_spec_vault_auth_kubernetes; /** TokenSecretRef authenticates with Vault by presenting a token. */ tokenSecretRef?: Issuer_spec_vault_auth_tokenSecretRef; } /** AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource. */ interface Issuer_spec_vault_auth_appRole { /** Path where the App Role authentication backend is mounted in Vault, e.g: "approle" */ path: string; /** RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault. */ roleId: string; /** Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The `key` field must be specified and denotes which entry within the Secret resource is used as the app role secret. */ secretRef: Issuer_spec_vault_auth_appRole_secretRef; } /** Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The `key` field must be specified and denotes which entry within the Secret resource is used as the app role secret. */ interface Issuer_spec_vault_auth_appRole_secretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server. */ interface Issuer_spec_vault_auth_kubernetes { /** The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to `/v1/auth/foo`, will use the path `/v1/auth/foo/login` to authenticate with Vault. If unspecified, the default value "/v1/auth/kubernetes" will be used. */ mountPath?: string; /** A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies. */ role: string; /** The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of 'ambient credentials' is not supported. */ secretRef?: Issuer_spec_vault_auth_kubernetes_secretRef; /** A reference to a service account that will be used to request a bound token (also known as "projected token"). Compared to using "secretRef", using this field means that you don't rely on statically bound tokens. To use this field, you must configure an RBAC rule to let cert-manager request a token. */ serviceAccountRef?: Issuer_spec_vault_auth_kubernetes_serviceAccountRef; } /** The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of 'ambient credentials' is not supported. */ interface Issuer_spec_vault_auth_kubernetes_secretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** A reference to a service account that will be used to request a bound token (also known as "projected token"). Compared to using "secretRef", using this field means that you don't rely on statically bound tokens. To use this field, you must configure an RBAC rule to let cert-manager request a token. */ interface Issuer_spec_vault_auth_kubernetes_serviceAccountRef { /** Name of the ServiceAccount used to request a token. */ name: string; } /** TokenSecretRef authenticates with Vault by presenting a token. */ interface Issuer_spec_vault_auth_tokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Reference to a Secret containing a bundle of PEM-encoded CAs to use when verifying the certificate chain presented by Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to 'ca.crt'. */ interface Issuer_spec_vault_caBundleSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone. */ interface Issuer_spec_venafi { /** Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified. */ cloud?: Issuer_spec_venafi_cloud; /** TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified. */ tpp?: Issuer_spec_venafi_tpp; /** Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required. */ zone: string; } /** Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified. */ interface Issuer_spec_venafi_cloud { /** APITokenSecretRef is a secret key selector for the Venafi Cloud API token. */ apiTokenSecretRef: Issuer_spec_venafi_cloud_apiTokenSecretRef; /** URL is the base URL for Venafi Cloud. Defaults to "https://api.venafi.cloud/v1". */ url?: string; } /** APITokenSecretRef is a secret key selector for the Venafi Cloud API token. */ interface Issuer_spec_venafi_cloud_apiTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified. */ interface Issuer_spec_venafi_tpp { /** * Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by the TPP server. Only used if using HTTPS; ignored for HTTP. If undefined, the certificate bundle in the cert-manager controller container is used to validate the chain. * @format byte */ caBundle?: string; /** CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, 'username' and 'password'. */ credentialsRef: Issuer_spec_venafi_tpp_credentialsRef; /** URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: "https://tpp.example.com/vedsdk". */ url: string; } /** CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, 'username' and 'password'. */ interface Issuer_spec_venafi_tpp_credentialsRef { /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Status of the Issuer. This is set and managed automatically. */ interface Issuer_status { /** ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates. */ acme?: Issuer_status_acme; /** List of status conditions to indicate the status of a CertificateRequest. Known condition types are `Ready`. */ conditions?: Issuer_status_conditions[]; } /** ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates. */ interface Issuer_status_acme { /** LastPrivateKeyHash is a hash of the private key associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer */ lastPrivateKeyHash?: string; /** LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer */ lastRegisteredEmail?: string; /** URI is the unique account identifier, which can also be used to retrieve account details from the CA */ uri?: string; } /** IssuerCondition contains condition information for an Issuer. */ interface Issuer_status_conditions { /** * LastTransitionTime is the timestamp corresponding to the last status change of this condition. * @format date-time */ lastTransitionTime?: string; /** Message is a human readable description of the details of the last transition, complementing reason. */ message?: string; /** * If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer. * @format int64 */ observedGeneration?: number; /** Reason is a brief machine readable explanation for the condition's last transition. */ reason?: string; /** Status of the condition, one of (`True`, `False`, `Unknown`). */ status: "True" | "False" | "Unknown"; /** Type of the condition, known values are (`Ready`). */ type: string; } } export declare namespace io.cert_manager.acme.v1 { /** Challenge is a type to represent a Challenge request with an ACME server */ interface Challenge { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata: object; /** */ spec: Challenge_spec; /** */ status?: Challenge_status; } /** */ interface Challenge_spec { /** The URL to the ACME Authorization resource that this challenge is a part of. */ authorizationURL: string; /** dnsName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a 'wildcard', this field MUST be set to the non-wildcard domain, e.g. for `*.example.com`, it must be `example.com`. */ dnsName: string; /** References a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an 'ACME' Issuer, an error will be returned and the Challenge will be marked as failed. */ issuerRef: Challenge_spec_issuerRef; /** The ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format: `.`. For DNS01 challenges, this is the base64 encoded SHA256 sum of the `.` text that must be set as the TXT record content. */ key: string; /** Contains the domain solving configuration that should be used to solve this challenge resource. */ solver: Challenge_spec_solver; /** The ACME challenge token for this challenge. This is the raw value returned from the ACME server. */ token: string; /** The type of ACME challenge this resource represents. One of "HTTP-01" or "DNS-01". */ type: "HTTP-01" | "DNS-01"; /** The URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge. */ url: string; /** wildcard will be true if this challenge is for a wildcard identifier, for example '*.example.com'. */ wildcard?: boolean; } /** References a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an 'ACME' Issuer, an error will be returned and the Challenge will be marked as failed. */ interface Challenge_spec_issuerRef { /** Group of the resource being referred to. */ group?: string; /** Kind of the resource being referred to. */ kind?: string; /** Name of the resource being referred to. */ name: string; } /** Contains the domain solving configuration that should be used to solve this challenge resource. */ interface Challenge_spec_solver { /** Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. */ dns01?: Challenge_spec_solver_dns01; /** Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism. */ http01?: Challenge_spec_solver_http01; /** Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. */ selector?: Challenge_spec_solver_selector; } /** Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow. */ interface Challenge_spec_solver_dns01 { /** Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. */ acmeDNS?: Challenge_spec_solver_dns01_acmeDNS; /** Use the Akamai DNS zone management API to manage DNS01 challenge records. */ akamai?: Challenge_spec_solver_dns01_akamai; /** Use the Microsoft Azure DNS API to manage DNS01 challenge records. */ azureDNS?: Challenge_spec_solver_dns01_azureDNS; /** Use the Google Cloud DNS API to manage DNS01 challenge records. */ cloudDNS?: Challenge_spec_solver_dns01_cloudDNS; /** Use the Cloudflare API to manage DNS01 challenge records. */ cloudflare?: Challenge_spec_solver_dns01_cloudflare; /** CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones. */ cnameStrategy?: "None" | "Follow"; /** Use the DigitalOcean DNS API to manage DNS01 challenge records. */ digitalocean?: Challenge_spec_solver_dns01_digitalocean; /** Use RFC2136 ("Dynamic Updates in the Domain Name System") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. */ rfc2136?: Challenge_spec_solver_dns01_rfc2136; /** Use the AWS Route53 API to manage DNS01 challenge records. */ route53?: Challenge_spec_solver_dns01_route53; /** Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. */ webhook?: Challenge_spec_solver_dns01_webhook; } /** Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_acmeDNS { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ accountSecretRef: Challenge_spec_solver_dns01_acmeDNS_accountSecretRef; /** */ host: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Challenge_spec_solver_dns01_acmeDNS_accountSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Akamai DNS zone management API to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_akamai { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ accessTokenSecretRef: Challenge_spec_solver_dns01_akamai_accessTokenSecretRef; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ clientSecretSecretRef: Challenge_spec_solver_dns01_akamai_clientSecretSecretRef; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ clientTokenSecretRef: Challenge_spec_solver_dns01_akamai_clientTokenSecretRef; /** */ serviceConsumerDomain: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Challenge_spec_solver_dns01_akamai_accessTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Challenge_spec_solver_dns01_akamai_clientSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Challenge_spec_solver_dns01_akamai_clientTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Microsoft Azure DNS API to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_azureDNS { /** if both this and ClientSecret are left unset MSI will be used */ clientID?: string; /** if both this and ClientID are left unset MSI will be used */ clientSecretSecretRef?: Challenge_spec_solver_dns01_azureDNS_clientSecretSecretRef; /** name of the Azure environment (default AzurePublicCloud) */ environment?: "AzurePublicCloud" | "AzureChinaCloud" | "AzureGermanCloud" | "AzureUSGovernmentCloud"; /** name of the DNS zone that should be used */ hostedZoneName?: string; /** managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID */ managedIdentity?: Challenge_spec_solver_dns01_azureDNS_managedIdentity; /** resource group the DNS zone is located in */ resourceGroupName: string; /** ID of the Azure subscription */ subscriptionID: string; /** when specifying ClientID and ClientSecret then this field is also needed */ tenantID?: string; } /** if both this and ClientID are left unset MSI will be used */ interface Challenge_spec_solver_dns01_azureDNS_clientSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID */ interface Challenge_spec_solver_dns01_azureDNS_managedIdentity { /** client ID of the managed identity, can not be used at the same time as resourceID */ clientID?: string; /** resource ID of the managed identity, can not be used at the same time as clientID */ resourceID?: string; } /** Use the Google Cloud DNS API to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_cloudDNS { /** HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone. */ hostedZoneName?: string; /** */ project: string; /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ serviceAccountSecretRef?: Challenge_spec_solver_dns01_cloudDNS_serviceAccountSecretRef; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Challenge_spec_solver_dns01_cloudDNS_serviceAccountSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the Cloudflare API to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_cloudflare { /** API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. */ apiKeySecretRef?: Challenge_spec_solver_dns01_cloudflare_apiKeySecretRef; /** API token used to authenticate with Cloudflare. */ apiTokenSecretRef?: Challenge_spec_solver_dns01_cloudflare_apiTokenSecretRef; /** Email of the account, only required when using API key based authentication. */ email?: string; } /** API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions. */ interface Challenge_spec_solver_dns01_cloudflare_apiKeySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** API token used to authenticate with Cloudflare. */ interface Challenge_spec_solver_dns01_cloudflare_apiTokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the DigitalOcean DNS API to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_digitalocean { /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ tokenSecretRef: Challenge_spec_solver_dns01_digitalocean_tokenSecretRef; } /** A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field. */ interface Challenge_spec_solver_dns01_digitalocean_tokenSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use RFC2136 ("Dynamic Updates in the Domain Name System") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_rfc2136 { /** The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required. */ nameserver: string; /** The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when ``tsigSecretSecretRef`` and ``tsigKeyName`` are defined. Supported values are (case-insensitive): ``HMACMD5`` (default), ``HMACSHA1``, ``HMACSHA256`` or ``HMACSHA512``. */ tsigAlgorithm?: string; /** The TSIG Key name configured in the DNS. If ``tsigSecretSecretRef`` is defined, this field is required. */ tsigKeyName?: string; /** The name of the secret containing the TSIG value. If ``tsigKeyName`` is defined, this field is required. */ tsigSecretSecretRef?: Challenge_spec_solver_dns01_rfc2136_tsigSecretSecretRef; } /** The name of the secret containing the TSIG value. If ``tsigKeyName`` is defined, this field is required. */ interface Challenge_spec_solver_dns01_rfc2136_tsigSecretSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Use the AWS Route53 API to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_route53 { /** The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ accessKeyID?: string; /** The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ accessKeyIDSecretRef?: Challenge_spec_solver_dns01_route53_accessKeyIDSecretRef; /** If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call. */ hostedZoneID?: string; /** Always set the region when using AccessKeyID and SecretAccessKey */ region: string; /** Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata */ role?: string; /** The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ secretAccessKeySecretRef?: Challenge_spec_solver_dns01_route53_secretAccessKeySecretRef; } /** The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ interface Challenge_spec_solver_dns01_route53_accessKeyIDSecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials */ interface Challenge_spec_solver_dns01_route53_secretAccessKeySecretRef { /** The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required. */ key?: string; /** Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; } /** Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records. */ interface Challenge_spec_solver_dns01_webhook { /** Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation's documentation. */ config?: any; /** The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation. */ groupName: string; /** The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. 'cloudflare'. */ solverName: string; } /** Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism. */ interface Challenge_spec_solver_http01 { /** The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future. */ gatewayHTTPRoute?: Challenge_spec_solver_http01_gatewayHTTPRoute; /** The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. */ ingress?: Challenge_spec_solver_http01_ingress; } /** The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future. */ interface Challenge_spec_solver_http01_gatewayHTTPRoute { /** Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges. */ labels?: Record; /** When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways */ parentRefs?: Challenge_spec_solver_http01_gatewayHTTPRoute_parentRefs[]; /** Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. */ serviceType?: string; } /** * ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). There are two kinds of parent resources with "Core" support: * * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) * This API may be extended in the future to support additional kinds of parent resources. * The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid. */ interface Challenge_spec_solver_http01_gatewayHTTPRoute_parentRefs { /** * Group is the group of the referent. When unspecified, "gateway.networking.k8s.io" is inferred. To set the core API group (such as for a "Service" kind referent), Group must be explicitly set to "" (empty string). * Support: Core * @pattern ^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ * @default gateway.networking.k8s.io */ group?: string; /** * Kind is kind of the referent. * There are two kinds of parent resources with "Core" support: * * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) * Support for other resources is Implementation-Specific. * @pattern ^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$ * @default Gateway */ kind?: string; /** * Name is the name of the referent. * Support: Core */ name: string; /** * Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. * Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. * ParentRefs from a Route to a Service in the same namespace are "producer" routes, which apply default routing rules to inbound connections from any namespace to the Service. * ParentRefs from a Route to a Service in a different namespace are "consumer" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. * Support: Core * @pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$ */ namespace?: string; /** * Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. * When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. * When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. * Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. * For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. * Support: Extended * * @format int32 */ port?: number; /** * SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. * Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. * When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. * Support: Core * @pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$ */ sectionName?: string; } /** The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed. */ interface Challenge_spec_solver_http01_ingress { /** This field configures the annotation `kubernetes.io/ingress.class` when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of `class`, `name` or `ingressClassName` may be specified. */ class?: string; /** This field configures the field `ingressClassName` on the created Ingress resources used to solve ACME challenges that use this challenge solver. This is the recommended way of configuring the ingress class. Only one of `class`, `name` or `ingressClassName` may be specified. */ ingressClassName?: string; /** Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges. */ ingressTemplate?: Challenge_spec_solver_http01_ingress_ingressTemplate; /** The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. Only one of `class`, `name` or `ingressClassName` may be specified. */ name?: string; /** Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges. */ podTemplate?: Challenge_spec_solver_http01_ingress_podTemplate; /** Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort. */ serviceType?: string; } /** Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges. */ interface Challenge_spec_solver_http01_ingress_ingressTemplate { /** ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ metadata?: Challenge_spec_solver_http01_ingress_ingressTemplate_metadata; } /** ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ interface Challenge_spec_solver_http01_ingress_ingressTemplate_metadata { /** Annotations that should be added to the created ACME HTTP01 solver ingress. */ annotations?: Record; /** Labels that should be added to the created ACME HTTP01 solver ingress. */ labels?: Record; } /** Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges. */ interface Challenge_spec_solver_http01_ingress_podTemplate { /** ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ metadata?: Challenge_spec_solver_http01_ingress_podTemplate_metadata; /** PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored. */ spec?: Challenge_spec_solver_http01_ingress_podTemplate_spec; } /** ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_metadata { /** Annotations that should be added to the create ACME HTTP01 solver pods. */ annotations?: Record; /** Labels that should be added to the created ACME HTTP01 solver pods. */ labels?: Record; } /** PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec { /** If specified, the pod's scheduling constraints */ affinity?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity; /** If specified, the pod's imagePullSecrets */ imagePullSecrets?: Challenge_spec_solver_http01_ingress_podTemplate_spec_imagePullSecrets[]; /** NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ */ nodeSelector?: Record; /** If specified, the pod's priorityClassName. */ priorityClassName?: string; /** If specified, the pod's service account */ serviceAccountName?: string; /** If specified, the pod's tolerations. */ tolerations?: Challenge_spec_solver_http01_ingress_podTemplate_spec_tolerations[]; } /** If specified, the pod's scheduling constraints */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity { /** Describes node affinity scheduling rules for the pod. */ nodeAffinity?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity; /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ podAffinity?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity; /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ podAntiAffinity?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity; } /** Describes node affinity scheduling rules for the pod. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ requiredDuringSchedulingIgnoredDuringExecution?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A node selector term, associated with the corresponding weight. */ preference: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A node selector term, associated with the corresponding weight. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Required. A pod affinity term, associated with the corresponding weight. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label query over a set of resources, in this case pods. */ labelSelector?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Required. A pod affinity term, associated with the corresponding weight. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label query over a set of resources, in this case pods. */ labelSelector?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_imagePullSecrets { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . */ interface Challenge_spec_solver_http01_ingress_podTemplate_spec_tolerations { /** Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead. */ interface Challenge_spec_solver_selector { /** List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. */ dnsNames?: string[]; /** List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected. */ dnsZones?: string[]; /** A label selector that is used to refine the set of certificate's that this challenge solver will apply to. */ matchLabels?: Record; } /** */ interface Challenge_status { /** presented will be set to true if the challenge values for this challenge are currently 'presented'. This *does not* imply the self check is passing. Only that the values have been 'submitted' for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured). */ presented?: boolean; /** Used to denote whether this challenge should be processed or not. This field will only be set to true by the 'scheduling' component. It will only be set to false by the 'challenges' controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action. */ processing?: boolean; /** Contains human readable information on why the Challenge is in the current state. */ reason?: string; /** Contains the current 'state' of the challenge. If not set, the state of the challenge is unknown. */ state?: "valid" | "ready" | "pending" | "processing" | "invalid" | "expired" | "errored"; } /** Order is a type to represent an Order with an ACME server */ interface Order { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata: object; /** */ spec: Order_spec; /** */ status?: Order_status; } /** */ interface Order_spec { /** CommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in `dnsNames` or `ipAddresses`. This field must match the corresponding field on the DER encoded CSR. */ commonName?: string; /** DNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. */ dnsNames?: string[]; /** Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec. */ duration?: string; /** IPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR. */ ipAddresses?: string[]; /** IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an 'ACME' Issuer, an error will be returned and the Order will be marked as failed. */ issuerRef: Order_spec_issuerRef; /** * Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order. * @format byte */ request: string; } /** IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an 'ACME' Issuer, an error will be returned and the Order will be marked as failed. */ interface Order_spec_issuerRef { /** Group of the resource being referred to. */ group?: string; /** Kind of the resource being referred to. */ kind?: string; /** Name of the resource being referred to. */ name: string; } /** */ interface Order_status { /** Authorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order. */ authorizations?: Order_status_authorizations[]; /** * Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the 'valid' state. * @format byte */ certificate?: string; /** * FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off. * @format date-time */ failureTime?: string; /** FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed. */ finalizeURL?: string; /** Reason optionally provides more information about a why the order is in the current state. */ reason?: string; /** State contains the current state of this Order resource. States 'success' and 'expired' are 'final' */ state?: "valid" | "ready" | "pending" | "processing" | "invalid" | "expired" | "errored"; /** URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set. */ url?: string; } /** ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource. */ interface Order_status_authorizations { /** Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process. */ challenges?: Order_status_authorizations_challenges[]; /** Identifier is the DNS name to be validated as part of this authorization */ identifier?: string; /** InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already 'valid', the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables 'authz reuse' (such as Let's Encrypt's production endpoint). If not set and 'identifier' is set, the state is assumed to be pending and a Challenge will be created. */ initialState?: "valid" | "ready" | "pending" | "processing" | "invalid" | "expired" | "errored"; /** URL is the URL of the Authorization that must be completed */ url: string; /** Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the *non-wildcard* version of the DNS name. For example, if '*.example.com' is the DNS name being validated, this field will be 'true' and the 'identifier' field will be 'example.com'. */ wildcard?: boolean; } /** Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process. */ interface Order_status_authorizations_challenges { /** Token is the token that must be presented for this challenge. This is used to compute the 'key' that must also be presented. */ token: string; /** Type is the type of challenge being offered, e.g. 'http-01', 'dns-01', 'tls-sni-01', etc. This is the raw value retrieved from the ACME server. Only 'http-01' and 'dns-01' are supported by cert-manager, other values will be ignored. */ type: string; /** URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server. */ url: string; } } export declare namespace io.stackgres.v1 { /** * A manual or automatically generated backup of an SGCluster configured with an SGBackupConfig. * * When a SGBackup is created a Job will perform a full backup of the database and update the status of the SGBackup * with the all the information required to restore it and some stats (or a failure message in case something unexpected * happened). * After an SGBackup is created the same Job performs a reconciliation of the backups by applying the retention window * that has been configured in the SGBackupConfig and removing the backups with managed lifecycle and the WAL files older * than the ones that fit in the retention window. The reconciliation also removes backups (excluding WAL files) that do * not belongs to any SGBackup. If the target storage of the SGBackupConfig is changed deletion of an SGBackup backups * with managed lifecycle and the WAL files older than the ones that fit in the retention window and of backups that do * not belongs to any SGBackup will not be performed anymore on the previous storage, only on the new target storage. * */ interface SGBackup { /** */ metadata: SGBackup_metadata; /** */ spec: SGBackup_spec; /** */ status?: SGBackup_status; } /** */ interface SGBackup_metadata { /** * Name of the backup. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all StackGres backups in the same namespace." * * @pattern ^[a-z]([-a-z0-9]*[a-z0-9])?$ */ name?: string; } /** */ interface SGBackup_spec { /** * The name of the `SGCluster` from which this backup is/will be taken. * * If this is a copy of an existing completed backup in a different namespace * the value must be prefixed with the namespace of the source backup and a * dot `.` (e.g. `.`) or have the same value * if the source backup is also a copy. * */ sgCluster?: string; /** * Indicate if this backup is permanent and should not be removed by the automated * retention policy. Default is `false`. * */ managedLifecycle?: boolean; } /** */ interface SGBackup_status { /** * The name of the backup. * */ internalName?: string; /** * The path were the backup is stored. * */ backupPath?: string; /** */ process?: SGBackup_status_process; /** */ backupInformation?: SGBackup_status_backupInformation; /** The name of the backup configuration used to perform this backup. */ sgBackupConfig?: SGBackup_status_sgBackupConfig; } /** */ interface SGBackup_status_process { /** * Status of the backup. * */ status?: string; /** * If the status is `failed` this field will contain a message indicating the failure reason. * */ failure?: string; /** * Name of the pod assigned to the backup. StackGres utilizes internally a locking mechanism based on the pod name of the job that creates the backup. * */ jobPod?: string; /** * Status (may be transient) until converging to `spec.managedLifecycle`. * */ managedLifecycle?: boolean; /** */ timing?: SGBackup_status_process_timing; } /** */ interface SGBackup_status_process_timing { /** * Start time of backup. * */ start?: string; /** * End time of backup. * */ end?: string; /** * Time at which the backup is safely stored in the object storage. * */ stored?: string; } /** */ interface SGBackup_status_backupInformation { /** * Hostname of the instance where the backup is taken from. * */ hostname?: string; /** * Pod where the backup is taken from. * */ sourcePod?: string; /** * Postgres *system identifier* of the cluster this backup is taken from. * */ systemIdentifier?: string; /** * Postgres version of the server where the backup is taken from. * */ postgresVersion?: string; /** * Data directory where the backup is taken from. * */ pgData?: string; /** */ size?: SGBackup_status_backupInformation_size; /** */ lsn?: SGBackup_status_backupInformation_lsn; /** * WAL segment file name when the backup was started. * */ startWalFile?: string; /** * Backup timeline. * */ timeline?: string; /** * An object containing data from the output of pg_controldata on the backup. * */ controlData?: SGBackup_status_backupInformation_controlData; } /** */ interface SGBackup_status_backupInformation_size { /** * Size (in bytes) of the uncompressed backup. * * @format int64 */ uncompressed?: number; /** * Size (in bytes) of the compressed backup. * * @format int64 */ compressed?: number; } /** */ interface SGBackup_status_backupInformation_lsn { /** * LSN of when the backup started. * */ start?: string; /** * LSN of when the backup finished. * */ end?: string; } /** * An object containing data from the output of pg_controldata on the backup. * */ interface SGBackup_status_backupInformation_controlData { /** */ "pg_control version number"?: string; /** */ "Catalog version number"?: string; /** */ "Database system identifier"?: string; /** */ "Database cluster state"?: string; /** */ "pg_control last modified"?: string; /** */ "Latest checkpoint location"?: string; /** */ "Latest checkpoint's REDO location"?: string; /** */ "Latest checkpoint's REDO WAL file"?: string; /** */ "Latest checkpoint's TimeLineID"?: string; /** */ "Latest checkpoint's PrevTimeLineID"?: string; /** */ "Latest checkpoint's full_page_writes"?: string; /** */ "Latest checkpoint's NextXID"?: string; /** */ "Latest checkpoint's NextOID"?: string; /** */ "Latest checkpoint's NextMultiXactId"?: string; /** */ "Latest checkpoint's NextMultiOffset"?: string; /** */ "Latest checkpoint's oldestXID"?: string; /** */ "Latest checkpoint's oldestXID's DB"?: string; /** */ "Latest checkpoint's oldestActiveXID"?: string; /** */ "Latest checkpoint's oldestMultiXid"?: string; /** */ "Latest checkpoint's oldestMulti's DB"?: string; /** */ "Latest checkpoint's oldestCommitTsXid"?: string; /** */ "Latest checkpoint's newestCommitTsXid"?: string; /** */ "Time of latest checkpoint"?: string; /** */ "Fake LSN counter for unlogged rels"?: string; /** */ "Minimum recovery ending location"?: string; /** */ "Min recovery ending loc's timeline"?: string; /** */ "Backup start location"?: string; /** */ "Backup end location"?: string; /** */ "End-of-backup record required"?: string; /** */ "wal_level setting"?: string; /** */ "wal_log_hints setting"?: string; /** */ "max_connections setting"?: string; /** */ "max_worker_processes setting"?: string; /** */ "max_wal_senders setting"?: string; /** */ "max_prepared_xacts setting"?: string; /** */ "max_locks_per_xact setting"?: string; /** */ "track_commit_timestamp setting"?: string; /** */ "Maximum data alignment"?: string; /** */ "Database block size"?: string; /** */ "Blocks per segment of large relation"?: string; /** */ "WAL block size"?: string; /** */ "Bytes per WAL segment"?: string; /** */ "Maximum length of identifiers"?: string; /** */ "Maximum columns in an index"?: string; /** */ "Maximum size of a TOAST chunk"?: string; /** */ "Size of a large-object chunk"?: string; /** */ "Date/time type storage"?: string; /** */ "Float4 argument passing"?: string; /** */ "Float8 argument passing"?: string; /** */ "Data page checksum version"?: string; /** */ "Mock authentication nonce"?: string; } /** The name of the backup configuration used to perform this backup. */ interface SGBackup_status_sgBackupConfig { /** * Back backups configuration. * */ baseBackups?: SGBackup_status_sgBackupConfig_baseBackups; /** * Select the backup compression algorithm. Possible options are: lz4, lzma, brotli. The default method is `lz4`. LZ4 is the fastest method, but compression ratio is the worst. LZMA is way slower, but it compresses backups about 6 times better than LZ4. Brotli is a good trade-off between speed and compression ratio, being about 3 times better than LZ4. * */ compression?: "lz4" | "lzma" | "brotli"; /** * Backup storage configuration. * */ storage: SGBackup_status_sgBackupConfig_storage; } /** * Back backups configuration. * */ interface SGBackup_status_sgBackupConfig_baseBackups { /** * Continuous Archiving backups are composed of periodic *base backups* and all the WAL segments produced in between those base backups. This parameter specifies at what time and with what frequency to start performing a new base backup. * * Use cron syntax (`m h dom mon dow`) for this parameter, i.e., 5 values separated by spaces: * * `m`: minute, 0 to 59 * * `h`: hour, 0 to 23 * * `dom`: day of month, 1 to 31 (recommended not to set it higher than 28) * * `mon`: month, 1 to 12 * * `dow`: day of week, 0 to 7 (0 and 7 both represent Sunday) * * Also ranges of values (`start-end`), the symbol `*` (meaning `first-last`) or even `*\//N`, where `N` is a number, meaning every `N`, may be used. All times are UTC. It is recommended to avoid 00:00 as base backup time, to avoid overlapping with any other external operations happening at this time. * * If not provided, full backups will be performed each day at 05:00 UTC * */ cronSchedule?: string; /** * Based on this parameter, an automatic retention policy is defined to delete old base backups. * This parameter specifies the number of base backups to keep, in a sliding window. * Consequently, the time range covered by backups is `periodicity*retention`, where `periodicity` is the separation between backups as specified by the `cronSchedule` property. * * Default is 5. * */ retention?: number; /** * Select the backup compression algorithm. Possible options are: lz4, lzma, brotli. The default method is `lz4`. LZ4 is the fastest method, but compression ratio is the worst. LZMA is way slower, but it compresses backups about 6 times better than LZ4. Brotli is a good trade-off between speed and compression ratio, being about 3 times better than LZ4. * */ compression?: "lz4" | "lzma" | "brotli"; /** */ performance?: SGBackup_status_sgBackupConfig_baseBackups_performance; } /** */ interface SGBackup_status_sgBackupConfig_baseBackups_performance { /** * **Deprecated**: use instead maxNetworkBandwidth. * * Maximum storage upload bandwidth to be used when storing the backup. In bytes (per second). * */ maxNetworkBandwitdh?: number; /** * **Deprecated**: use instead maxDiskBandwidth. * * Maximum disk read I/O when performing a backup. In bytes (per second). * */ maxDiskBandwitdh?: number; /** * Maximum storage upload bandwidth to be used when storing the backup. In bytes (per second). * */ maxNetworkBandwidth?: number; /** * Maximum disk read I/O when performing a backup. In bytes (per second). * */ maxDiskBandwidth?: number; /** * Backup storage may use several concurrent streams to store the data. This parameter configures the number of parallel streams to use to reading from disk. By default, it's set to 1 (use one stream). * */ uploadDiskConcurrency?: number; /** * Backup storage may use several concurrent streams to store the data. This parameter configures the number of parallel streams to use. By default, it's set to 1 (use one stream). * */ uploadConcurrency?: number; } /** * Backup storage configuration. * */ interface SGBackup_status_sgBackupConfig_storage { /** * Specifies the type of object storage used for storing the base backups and WAL segments. * Possible values: * * `s3`: Amazon Web Services S3 (Simple Storage Service). * * `s3Compatible`: non-AWS services that implement a compatibility API with AWS S3. * * `gcs`: Google Cloud Storage. * * `azureBlob`: Microsoft Azure Blob Storage. * */ type: "s3" | "s3Compatible" | "gcs" | "azureBlob"; /** * Amazon Web Services S3 configuration. * */ s3?: SGBackup_status_sgBackupConfig_storage_s3; /** AWS S3-Compatible API configuration */ s3Compatible?: SGBackup_status_sgBackupConfig_storage_s3Compatible; /** * Google Cloud Storage configuration. * */ gcs?: SGBackup_status_sgBackupConfig_storage_gcs; /** * Azure Blob Storage configuration. * */ azureBlob?: SGBackup_status_sgBackupConfig_storage_azureBlob; } /** * Amazon Web Services S3 configuration. * */ interface SGBackup_status_sgBackupConfig_storage_s3 { /** * AWS S3 bucket name. * * @pattern ^[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the S3 bucket. Note that StackGres generates in any case a folder per * StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * AWS S3 region. The Region may be detected using s3:GetBucketLocation, but to avoid giving permissions to this API call or forbid it from the applicable IAM policy, this property must be explicitely specified. * */ region?: string; /** * [Amazon S3 Storage Class](https://aws.amazon.com/s3/storage-classes/) used for the backup object storage. By default, the `STANDARD` storage class is used. Other supported values include `STANDARD_IA` for Infrequent Access and `REDUCED_REDUNDANCY`. * */ storageClass?: string; /** * Credentials to access AWS S3 for writing and reading. * */ awsCredentials: SGBackup_status_sgBackupConfig_storage_s3_awsCredentials; } /** * Credentials to access AWS S3 for writing and reading. * */ interface SGBackup_status_sgBackupConfig_storage_s3_awsCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)s to reference the Secrets that contain the information about the `awsCredentials`. * */ secretKeySelectors: SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)s to reference the Secrets that contain the information about the `awsCredentials`. * */ interface SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors { /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Access Key ID secret. * */ accessKeyId: SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors_accessKeyId; /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Secret Access Key secret. * */ secretAccessKey: SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors_secretAccessKey; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Access Key ID secret. * */ interface SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors_accessKeyId { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Secret Access Key secret. * */ interface SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors_secretAccessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** AWS S3-Compatible API configuration */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible { /** * Bucket name. * * @pattern ^[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the S3 bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * Enable path-style addressing (i.e. `http://s3.amazonaws.com/BUCKET/KEY`) when connecting to an S3-compatible service that lacks support for sub-domain style bucket URLs (i.e. `http://BUCKET.s3.amazonaws.com/KEY`). Defaults to false. * */ enablePathStyleAddressing?: boolean; /** * Overrides the default url to connect to an S3-compatible service. * For example: `http://s3-like-service:9000`. * */ endpoint?: string; /** * AWS S3 region. The Region may be detected using s3:GetBucketLocation, but to avoid giving permissions to this API call or forbid it from the applicable IAM policy, this property must be explicitely specified. * */ region?: string; /** * [Amazon S3 Storage Class](https://aws.amazon.com/s3/storage-classes/) used for the backup object storage. By default, the `STANDARD` storage class is used. Other supported values include `STANDARD_IA` for Infrequent Access and `REDUCED_REDUNDANCY`. * */ storageClass?: string; /** * Credentials to access AWS S3 for writing and reading. * */ awsCredentials: SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials; } /** * Credentials to access AWS S3 for writing and reading. * */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the `awsCredentials`. * */ secretKeySelectors: SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the `awsCredentials`. * */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors { /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Access Key ID secret. * */ accessKeyId: SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors_accessKeyId; /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Secret Access Key secret. * */ secretAccessKey: SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors_secretAccessKey; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Access Key ID secret. * */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors_accessKeyId { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Secret Access Key secret. * */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors_secretAccessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * Google Cloud Storage configuration. * */ interface SGBackup_status_sgBackupConfig_storage_gcs { /** * GCS bucket name. * * @pattern ^[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the GCS bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * Credentials to access GCS for writing and reading. * */ gcpCredentials: SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials; } /** * Credentials to access GCS for writing and reading. * */ interface SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials { /** * If true, the credentials will be fetched from the GCE/GKE metadata service and the credentials from `secretKeySelectors` field will not be used. * * This is useful when running StackGres inside a GKE cluster using [Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity). * */ fetchCredentialsFromMetadataService?: boolean; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the Service Account to access GCS. * */ secretKeySelectors?: SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials_secretKeySelectors; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the Service Account to access GCS. * */ interface SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials_secretKeySelectors { /** * A service account key from GCP. In JSON format, as downloaded from the GCP Console. * */ serviceAccountJSON: SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials_secretKeySelectors_serviceAccountJSON; } /** * A service account key from GCP. In JSON format, as downloaded from the GCP Console. * */ interface SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials_secretKeySelectors_serviceAccountJSON { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * Azure Blob Storage configuration. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob { /** * Azure Blob Storage bucket name. * * @pattern ^[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the Azure Blobk bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * Credentials to access Azure Blob Storage for writing and reading. * */ azureCredentials: SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials; } /** * Credentials to access Azure Blob Storage for writing and reading. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)s to reference the Secrets that contain the information about the `azureCredentials`. * */ secretKeySelectors?: SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)s to reference the Secrets that contain the information about the `azureCredentials`. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors { /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the name of the storage account. * */ storageAccount: SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors_storageAccount; /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the primary or secondary access key for the storage account. * */ accessKey: SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors_accessKey; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the name of the storage account. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors_storageAccount { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the primary or secondary access key for the storage account. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors_accessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** */ interface SGBackupConfig { /** */ metadata: SGBackupConfig_metadata; /** */ spec: SGBackupConfig_spec; } /** */ interface SGBackupConfig_metadata { /** * Name of the Backup Configuration. StackGres supports [Continuous Archiving](https://www.postgresql.org/docs/current/continuous-archiving.html)-based backups which are performed automatically, helping achieve near-zero data loss in case of recovery from a backup. An SGBackupConfig contains the necessary configuration to perform these automatic backups and may be referenced by zero or more SGClusters, and if so it would be referenced by its name. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all backup configurations in the same namespace. * */ name?: string; } /** */ interface SGBackupConfig_spec { /** * Back backups configuration. * */ baseBackups?: SGBackupConfig_spec_baseBackups; /** * Backup storage configuration. * */ storage: SGBackupConfig_spec_storage; } /** * Back backups configuration. * */ interface SGBackupConfig_spec_baseBackups { /** * Continuous Archiving backups are composed of periodic *base backups* and all the WAL segments produced in between those base backups. This parameter specifies at what time and with what frequency to start performing a new base backup. * * Use cron syntax (`m h dom mon dow`) for this parameter, i.e., 5 values separated by spaces: * * `m`: minute, 0 to 59. * * `h`: hour, 0 to 23. * * `dom`: day of month, 1 to 31 (recommended not to set it higher than 28). * * `mon`: month, 1 to 12. * * `dow`: day of week, 0 to 7 (0 and 7 both represent Sunday). * * Also ranges of values (`start-end`), the symbol `*` (meaning `first-last`) or even `*\//N`, where `N` is a number, meaning ""every `N`, may be used. All times are UTC. It is recommended to avoid 00:00 as base backup time, to avoid overlapping with any other external operations happening at this time. * * If not set, full backups are performed everyday at 05:00 UTC. * */ cronSchedule?: string; /** * Define the number of backups with managed lifecycle to keep, in a sliding window. * * Consequently, the time range covered by backups is `periodicity*retention`, where `periodicity` is the separation between backups as specified by the `cronSchedule` property. * * WAL files before the oldest backup with managed lifecycle will also be removed. So that, when retention is applied, the oldest WAL available will be `periodicity*retention` old. * * Default is 5. * */ retention?: number; /** * Specifies the backup compression algorithm. Possible options are: lz4, lzma, brotli. The default method is `lz4`. LZ4 is the fastest method, but compression ratio is the worst. LZMA is way slower, but it compresses backups about 6 times better than LZ4. Brotli is a good trade-off between speed and compression ratio, being about 3 times better than LZ4. * */ compression?: "lz4" | "lzma" | "brotli"; /** */ performance?: SGBackupConfig_spec_baseBackups_performance; } /** */ interface SGBackupConfig_spec_baseBackups_performance { /** * **Deprecated**: use instead maxNetworkBandwidth. * * Maximum storage upload bandwidth used when storing a backup. In bytes (per second). * */ maxNetworkBandwitdh?: number; /** * **Deprecated**: use instead maxDiskBandwidth. * * Maximum disk read I/O when performing a backup. In bytes (per second). * */ maxDiskBandwitdh?: number; /** * Maximum storage upload bandwidth used when storing a backup. In bytes (per second). * */ maxNetworkBandwidth?: number; /** * Maximum disk read I/O when performing a backup. In bytes (per second). * */ maxDiskBandwidth?: number; /** * Backup storage may use several concurrent streams to store the data. This parameter configures the number of parallel streams to use. By default, it's set to 1 (use one stream). * */ uploadDiskConcurrency?: number; } /** * Backup storage configuration. * */ interface SGBackupConfig_spec_storage { /** * Determine the type of object storage used for storing the base backups and WAL segments. * Possible values: * * `s3`: Amazon Web Services S3 (Simple Storage Service). * * `s3Compatible`: non-AWS services that implement a compatibility API with AWS S3. * * `gcs`: Google Cloud Storage. * * `azureBlob`: Microsoft Azure Blob Storage. * */ type: "s3" | "s3Compatible" | "gcs" | "azureBlob"; /** * Amazon Web Services S3 configuration. * */ s3?: SGBackupConfig_spec_storage_s3; /** AWS S3-Compatible API configuration */ s3Compatible?: SGBackupConfig_spec_storage_s3Compatible; /** * Google Cloud Storage configuration. * */ gcs?: SGBackupConfig_spec_storage_gcs; /** * Azure Blob Storage configuration. * */ azureBlob?: SGBackupConfig_spec_storage_azureBlob; } /** * Amazon Web Services S3 configuration. * */ interface SGBackupConfig_spec_storage_s3 { /** * AWS S3 bucket name. * * @pattern ^((s3|https?)://)?[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the S3 bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * The AWS S3 region. The Region may be detected using s3:GetBucketLocation, but if you wish to avoid giving permissions to this API call or forbid it from the applicable IAM policy, you must then specify this property. * */ region?: string; /** * The [Amazon S3 Storage Class](https://aws.amazon.com/s3/storage-classes/) to use for the backup object storage. By default, the `STANDARD` storage class is used. Other supported values include `STANDARD_IA` for Infrequent Access and `REDUCED_REDUNDANCY`. * */ storageClass?: string; /** * The credentials to access AWS S3 for writing and reading. * */ awsCredentials: SGBackupConfig_spec_storage_s3_awsCredentials; } /** * The credentials to access AWS S3 for writing and reading. * */ interface SGBackupConfig_spec_storage_s3_awsCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secrets that contain the information about the `awsCredentials`. Note that you may use the same or different Secrets for the `accessKeyId` and the `secretAccessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ secretKeySelectors: SGBackupConfig_spec_storage_s3_awsCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secrets that contain the information about the `awsCredentials`. Note that you may use the same or different Secrets for the `accessKeyId` and the `secretAccessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ interface SGBackupConfig_spec_storage_s3_awsCredentials_secretKeySelectors { /** * AWS [access key ID](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `AKIAIOSFODNN7EXAMPLE`. * */ accessKeyId: SGBackupConfig_spec_storage_s3_awsCredentials_secretKeySelectors_accessKeyId; /** * AWS [secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`. * */ secretAccessKey: SGBackupConfig_spec_storage_s3_awsCredentials_secretKeySelectors_secretAccessKey; } /** * AWS [access key ID](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `AKIAIOSFODNN7EXAMPLE`. * */ interface SGBackupConfig_spec_storage_s3_awsCredentials_secretKeySelectors_accessKeyId { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * AWS [secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`. * */ interface SGBackupConfig_spec_storage_s3_awsCredentials_secretKeySelectors_secretAccessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** AWS S3-Compatible API configuration */ interface SGBackupConfig_spec_storage_s3Compatible { /** * Bucket name. * * @pattern ^((s3|https?)://)?[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the S3 bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * Enable path-style addressing (i.e. `http://s3.amazonaws.com/BUCKET/KEY`) when connecting to an S3-compatible service that lacks support for sub-domain style bucket URLs (i.e. `http://BUCKET.s3.amazonaws.com/KEY`). * * Defaults to false. * */ enablePathStyleAddressing?: boolean; /** * Overrides the default url to connect to an S3-compatible service. * For example: `http://s3-like-service:9000`. * */ endpoint?: string; /** * The AWS S3 region. The Region may be detected using s3:GetBucketLocation, but if you wish to avoid giving permissions to this API call or forbid it from the applicable IAM policy, you must then specify this property. * */ region?: string; /** * The [Amazon S3 Storage Class](https://aws.amazon.com/s3/storage-classes/) to use for the backup object storage. By default, the `STANDARD` storage class is used. Other supported values include `STANDARD_IA` for Infrequent Access and `REDUCED_REDUNDANCY`. * */ storageClass?: string; /** * The credentials to access AWS S3 for writing and reading. * */ awsCredentials: SGBackupConfig_spec_storage_s3Compatible_awsCredentials; } /** * The credentials to access AWS S3 for writing and reading. * */ interface SGBackupConfig_spec_storage_s3Compatible_awsCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secret(s) that contain the information about the `awsCredentials`. Note that you may use the same or different Secrets for the `accessKeyId` and the `secretAccessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ secretKeySelectors: SGBackupConfig_spec_storage_s3Compatible_awsCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secret(s) that contain the information about the `awsCredentials`. Note that you may use the same or different Secrets for the `accessKeyId` and the `secretAccessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ interface SGBackupConfig_spec_storage_s3Compatible_awsCredentials_secretKeySelectors { /** * AWS [access key ID](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `AKIAIOSFODNN7EXAMPLE`. * */ accessKeyId: SGBackupConfig_spec_storage_s3Compatible_awsCredentials_secretKeySelectors_accessKeyId; /** * AWS [secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`. * */ secretAccessKey: SGBackupConfig_spec_storage_s3Compatible_awsCredentials_secretKeySelectors_secretAccessKey; } /** * AWS [access key ID](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `AKIAIOSFODNN7EXAMPLE`. * */ interface SGBackupConfig_spec_storage_s3Compatible_awsCredentials_secretKeySelectors_accessKeyId { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * AWS [secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`. * */ interface SGBackupConfig_spec_storage_s3Compatible_awsCredentials_secretKeySelectors_secretAccessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * Google Cloud Storage configuration. * */ interface SGBackupConfig_spec_storage_gcs { /** * GCS bucket name. * * @pattern ^(gs://)?[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the GCS bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * The credentials to access GCS for writing and reading. * */ gcpCredentials: SGBackupConfig_spec_storage_gcs_gcpCredentials; } /** * The credentials to access GCS for writing and reading. * */ interface SGBackupConfig_spec_storage_gcs_gcpCredentials { /** * If true, the credentials will be fetched from the GCE/GKE metadata service and the field `secretKeySelectors` have to be set to null or omitted. * * This is useful when running StackGres inside a GKE cluster using [Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity). * */ fetchCredentialsFromMetadataService?: boolean; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the Service Account to access GCS. * */ secretKeySelectors?: SGBackupConfig_spec_storage_gcs_gcpCredentials_secretKeySelectors; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the Service Account to access GCS. * */ interface SGBackupConfig_spec_storage_gcs_gcpCredentials_secretKeySelectors { /** * A service account key from GCP. In JSON format, as downloaded from the GCP Console. * */ serviceAccountJSON: SGBackupConfig_spec_storage_gcs_gcpCredentials_secretKeySelectors_serviceAccountJSON; } /** * A service account key from GCP. In JSON format, as downloaded from the GCP Console. * */ interface SGBackupConfig_spec_storage_gcs_gcpCredentials_secretKeySelectors_serviceAccountJSON { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * Azure Blob Storage configuration. * */ interface SGBackupConfig_spec_storage_azureBlob { /** * Azure Blob Storage bucket name. * * @pattern ^(azure://)?[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the Azure Blob bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * The credentials to access Azure Blob Storage for writing and reading. * */ azureCredentials: SGBackupConfig_spec_storage_azureBlob_azureCredentials; } /** * The credentials to access Azure Blob Storage for writing and reading. * */ interface SGBackupConfig_spec_storage_azureBlob_azureCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secret(s) that contain the information about the `azureCredentials`. . Note that you may use the same or different Secrets for the `storageAccount` and the `accessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ secretKeySelectors?: SGBackupConfig_spec_storage_azureBlob_azureCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secret(s) that contain the information about the `azureCredentials`. . Note that you may use the same or different Secrets for the `storageAccount` and the `accessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ interface SGBackupConfig_spec_storage_azureBlob_azureCredentials_secretKeySelectors { /** * The [Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json) that contains the Blob bucket to be used. * */ storageAccount: SGBackupConfig_spec_storage_azureBlob_azureCredentials_secretKeySelectors_storageAccount; /** * The [storage account access key](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal). * */ accessKey: SGBackupConfig_spec_storage_azureBlob_azureCredentials_secretKeySelectors_accessKey; } /** * The [Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json) that contains the Blob bucket to be used. * */ interface SGBackupConfig_spec_storage_azureBlob_azureCredentials_secretKeySelectors_storageAccount { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * The [storage account access key](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal). * */ interface SGBackupConfig_spec_storage_azureBlob_azureCredentials_secretKeySelectors_accessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** */ interface SGCluster { /** */ metadata: SGCluster_metadata; /** */ spec: SGCluster_spec; /** */ status?: SGCluster_status; } /** */ interface SGCluster_metadata { /** * Name of the StackGres cluster. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all SGCluster, SGShardedCluster and SGDistributedLogs in the same namespace. * * @pattern ^[a-z]([-a-z0-9]*[a-z0-9])?$ */ name?: string; } /** */ interface SGCluster_spec { /** * This section allows to configure Postgres features * */ postgres: SGCluster_spec_postgres; /** * Number of StackGres instances for the cluster. Each instance contains one Postgres server. * Out of all of the Postgres servers, one is elected as the primary, the rest remain as read-only replicas. * */ instances: number; /** * This section allows to configure Postgres replication mode and HA roles groups. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ replication?: SGCluster_spec_replication; /** * Name of the [SGInstanceProfile](https://stackgres.io/doc/latest/04-postgres-cluster-management/03-resource-profiles/). A SGInstanceProfile defines CPU and memory limits. Must exist before creating a cluster. When no profile is set, a default (currently: 1 core, 2 GiB RAM) one is used. * */ sgInstanceProfile?: string; /** Metadata information from cluster created resources. */ metadata?: SGCluster_spec_metadata; /** Kubernetes [services](https://kubernetes.io/docs/concepts/services-networking/service/) created or managed by StackGres. */ postgresServices?: SGCluster_spec_postgresServices; /** Cluster pod's configuration. */ pods: SGCluster_spec_pods; /** * Cluster custom configurations. * */ configurations?: SGCluster_spec_configurations; /** * This section allows to reference SQL scripts that will be applied to the cluster live. * */ managedSql?: SGCluster_spec_managedSql; /** Cluster initialization data options. Cluster may be initialized empty, or from a backup restoration. Specifying scripts to run on the database after cluster creation is also possible. */ initialData?: SGCluster_spec_initialData; /** * Make the cluster a read-only standby replica allowing to replicate from another PostgreSQL instance and acting as a rely. * * Changing this section is allowed to fix issues or to change the replication source. * * Removing this section convert the cluster in a normal cluster where the standby leader is converted into the a primary instance. * */ replicateFrom?: SGCluster_spec_replicateFrom; /** * If enabled, a ServiceMonitor is created for each Prometheus instance found in order to collect metrics. * */ prometheusAutobind?: boolean; /** */ nonProductionOptions?: SGCluster_spec_nonProductionOptions; /** StackGres features a functionality for all pods to send Postgres, Patroni and PgBouncer logs to a central (distributed) location, which is in turn another Postgres database. Logs can then be accessed via SQL interface or from the web UI. This section controls whether to enable this feature or not. If not enabled, logs are send to the pod's standard output. */ distributedLogs?: SGCluster_spec_distributedLogs; /** The list of Postgres extensions to install. This section is filled by the operator. */ toInstallPostgresExtensions?: SGCluster_spec_toInstallPostgresExtensions[]; } /** * This section allows to configure Postgres features * */ interface SGCluster_spec_postgres { /** * Postgres version used on the cluster. It is either of: * * The string 'latest', which automatically sets the latest major.minor Postgres version. * * A major version, like '14' or '13', which sets that major version and the latest minor version. * * A specific major.minor version, like '14.4'. * */ version: string; /** * Postgres flavor used on the cluster. It is either of: * * `babelfish` will use the [Babelfish for Postgres](https://babelfish-for-postgresql.github.io/babelfish-for-postgresql/). * * If not specified then the vanilla Postgres will be used for the cluster. * */ flavor?: string; /** * StackGres support deploy of extensions at runtime by simply adding an entry to this array. A deployed extension still * requires the creation in a database using the [`CREATE EXTENSION`](https://www.postgresql.org/docs/current/sql-createextension.html) * statement. After an extension is deployed correctly it will be present until removed and the cluster restarted. * * A cluster restart is required for: * * Extensions that requires to add an entry to [`shared_preload_libraries`](https://postgresqlco.nf/en/doc/param/shared_preload_libraries/) configuration parameter. * * Upgrading extensions that overwrite any file that is not the extension''s control file or extension''s script file. * * Removing extensions. Until the cluster is not restarted a removed extension will still be available. * * Install of extensions that require extra mount. After installed the cluster will require to be restarted. * */ extensions?: SGCluster_spec_postgres_extensions[]; /** * This section allows to use SSL when connecting to Postgres * */ ssl?: SGCluster_spec_postgres_ssl; } /** */ interface SGCluster_spec_postgres_extensions { /** The name of the extension to deploy. */ name: string; /** The id of the publisher of the extension to deploy. If not specified `com.ongres` will be used by default. */ publisher?: string; /** The version of the extension to deploy. If not specified version of `stable` channel will be used by default. */ version?: string; /** The repository base URL from where to obtain the extension to deploy. If not specified https://stackgres.io/downloads/postgres/extensions will be used by default (or the value specified during operator deployment). */ repository?: string; } /** * This section allows to use SSL when connecting to Postgres * */ interface SGCluster_spec_postgres_ssl { /** * Allow to enable SSL for connections to Postgres. By default is `false`. * * If `true` certificate and private key will be auto-generated unless fields `certificateSecretKeySelector` and `privateKeySecretKeySelector` are specified. * */ enabled?: boolean; /** * Secret key selector for the certificate or certificate chain used for SSL connections. * */ certificateSecretKeySelector?: SGCluster_spec_postgres_ssl_certificateSecretKeySelector; /** * Secret key selector for the private key used for SSL connections. * */ privateKeySecretKeySelector?: SGCluster_spec_postgres_ssl_privateKeySecretKeySelector; } /** * Secret key selector for the certificate or certificate chain used for SSL connections. * */ interface SGCluster_spec_postgres_ssl_certificateSecretKeySelector { /** * The name of Secret that contains the certificate or certificate chain for SSL connections * */ name: string; /** * The key of Secret that contains the certificate or certificate chain for SSL connections * */ key: string; } /** * Secret key selector for the private key used for SSL connections. * */ interface SGCluster_spec_postgres_ssl_privateKeySecretKeySelector { /** * The name of Secret that contains the private key for SSL connections * */ name: string; /** * The key of Secret that contains the private key for SSL connections * */ key: string; } /** * This section allows to configure Postgres replication mode and HA roles groups. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ interface SGCluster_spec_replication { /** * The replication mode applied to the whole cluster. * Possible values are: * * `async` (default) * * `sync` * * `strict-sync` * * `sync-all` * * `strict-sync-all` * * ### `async` Mode * * When in asynchronous mode the cluster is allowed to lose some committed transactions. * When the primary server fails or becomes unavailable for any other reason a sufficiently healthy standby * will automatically be promoted to primary. Any transactions that have not been replicated to that standby * remain in a "forked timeline" on the primary, and are effectively unrecoverable (the data is still there, * but recovering it requires a manual recovery effort by data recovery specialists). * * ### `sync` Mode * * When in synchronous mode a standby will not be promoted unless it is certain that the standby contains all * transactions that may have returned a successful commit status to client (clients can change the behavior * per transaction using PostgreSQL’s `synchronous_commit` setting. Transactions with `synchronous_commit` * values of `off` and `local` may be lost on fail over, but will not be blocked by replication delays). This * means that the system may be unavailable for writes even though some servers are available. System * administrators can still use manual failover commands to promote a standby even if it results in transaction * loss. * * Synchronous mode does not guarantee multi node durability of commits under all circumstances. When no suitable * standby is available, primary server will still accept writes, but does not guarantee their replication. When * the primary fails in this mode no standby will be promoted. When the host that used to be the primary comes * back it will get promoted automatically, unless system administrator performed a manual failover. This behavior * makes synchronous mode usable with 2 node clusters. * * When synchronous mode is used and a standby crashes, commits will block until the primary is switched to standalone * mode. Manually shutting down or restarting a standby will not cause a commit service interruption. Standby will * signal the primary to release itself from synchronous standby duties before PostgreSQL shutdown is initiated. * * ### `strict-sync` Mode * * When it is absolutely necessary to guarantee that each write is stored durably on at least two nodes, use the strict * synchronous mode. This mode prevents synchronous replication to be switched off on the primary when no synchronous * standby candidates are available. As a downside, the primary will not be available for writes (unless the Postgres * transaction explicitly turns off `synchronous_mode` parameter), blocking all client write requests until at least one * synchronous replica comes up. * * **Note**: Because of the way synchronous replication is implemented in PostgreSQL it is still possible to lose * transactions even when using strict synchronous mode. If the PostgreSQL backend is cancelled while waiting to acknowledge * replication (as a result of packet cancellation due to client timeout or backend failure) transaction changes become * visible for other backends. Such changes are not yet replicated and may be lost in case of standby promotion. * * ### `sync-all` Mode * * The same as `sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * * ### `strict-sync-all` Mode * * The same as `strict-sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * */ mode?: string; /** * This role is applied to the instances of the implicit replication group that is composed by `.spec.instances` number of instances. * Possible values are: * * `ha-read` (default) * * `ha` * The primary instance will be elected among all the replication groups that are either `ha` or `ha-read`. * Only if the role is set to `ha-read` instances of main replication group will be exposed via the replicas service. * */ role?: string; /** * Number of synchronous standby instances. Must be less than the total number of instances. It is set to 1 by default. * Only setteable if mode is `sync` or `strict-sync`. * */ syncInstances?: number; /** * StackGres support replication groups where a replication group of a specified number of instances could have different * replication role. The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * */ groups?: SGCluster_spec_replication_groups[]; } /** */ interface SGCluster_spec_replication_groups { /** The name of the replication group. If not set will default to the `group-`. */ name?: string; /** * This role is applied to the instances of this replication group. * Possible values are: * * `ha-read` * * `ha` * * `readonly` * * `none` * The primary instance will be elected among all the replication groups that are either `ha` or `ha-read`. * Only if the role is set to `readonly` or `ha-read` instances of such replication group will be exposed via the replicas service. * */ role: string; /** * Number of StackGres instances for this replication group. * * The total number of instance of a cluster is always `.spec.instances`. The sum of the instances in the replication group must be * less than the total number of instances. * */ instances: number; } /** Metadata information from cluster created resources. */ interface SGCluster_spec_metadata { /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ annotations?: SGCluster_spec_metadata_annotations; /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ labels?: SGCluster_spec_metadata_labels; } /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ interface SGCluster_spec_metadata_annotations { /** Annotations to attach to any resource created or managed by StackGres. */ allResources?: Record; /** Annotations to attach to pods created or managed by StackGres. */ clusterPods?: Record; /** Annotations to attach to all services created or managed by StackGres. */ services?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-primary` service. */ primaryService?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-replicas` service. */ replicasService?: Record; } /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ interface SGCluster_spec_metadata_labels { /** Labels to attach to Pods created or managed by StackGres. */ clusterPods?: Record; /** Labels to attach to Services and Endpoints created or managed by StackGres. */ services?: Record; } /** Kubernetes [services](https://kubernetes.io/docs/concepts/services-networking/service/) created or managed by StackGres. */ interface SGCluster_spec_postgresServices { /** * Configure the service to the primary with the same name as the SGCluster. A legacy service * * Provides a stable connection (regardless of primary failures or switchovers) to the read-write Postgres server of the cluster. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ primary?: SGCluster_spec_postgresServices_primary; /** * Configure the service to any replica with the name as the SGCluster plus the `-replicas` suffix. * * It provides a stable connection (regardless of replica node failures) to any read-only Postgres server of the cluster. Read-only servers are load-balanced via this service. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ replicas?: SGCluster_spec_postgresServices_replicas; } /** * Configure the service to the primary with the same name as the SGCluster. A legacy service * * Provides a stable connection (regardless of primary failures or switchovers) to the read-write Postgres server of the cluster. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ interface SGCluster_spec_postgresServices_primary { /** Specify if the service should be created or not. */ enabled?: boolean; /** * type determines how the Service is exposed. Defaults to ClusterIP. Valid * options are ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates * a cluster-internal IP address for load-balancing to endpoints. * "NodePort" builds on ClusterIP and allocates a port on every node. * "LoadBalancer" builds on NodePort and creates * an external load-balancer (if supported in the current cloud). * More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types * */ type?: "ClusterIP" | "LoadBalancer" | "NodePort"; /** * The list of custom ports that will be exposed by the service. * * The names of custom ports will be prefixed with the string `custom-` so they do not * conflict with ports defined for the service. * * The names of target ports will be prefixed with the string `custom-` so that the ports * that can be referenced in this section will be only those defined under * .spec.pods.customContainers[].ports sections were names are also prepended with the same * prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#serviceport-v1-core * */ customPorts?: SGCluster_spec_postgresServices_primary_customPorts[]; /** allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. */ allocateLoadBalancerNodePorts?: boolean; /** externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. */ externalIPs?: string[]; /** * externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. * * */ externalTrafficPolicy?: string; /** * healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. * @format int32 */ healthCheckNodePort?: number; /** InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). */ internalTrafficPolicy?: string; /** * IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. * * This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. */ ipFamilies?: string[]; /** IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. */ ipFamilyPolicy?: string; /** loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. */ loadBalancerClass?: string; /** Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version. */ loadBalancerIP?: string; /** If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ */ loadBalancerSourceRanges?: string[]; /** * Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies * * */ sessionAffinity?: string; /** SessionAffinityConfig represents the configurations of session affinity. */ sessionAffinityConfig?: SGCluster_spec_postgresServices_primary_sessionAffinityConfig; } /** * A custom port that will be exposed by the service. * * The name of the custom port will be prefixed with the string `custom-` so it does not * conflict with ports defined for the service. * * The name of target port will be prefixed with the string `custom-` so that the port * that can be referenced in this section will be only those defined under * .spec.pods.customContainers[].ports sections were names are also prepended with the same * prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#serviceport-v1-core * */ interface SGCluster_spec_postgresServices_primary_customPorts { /** The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. */ appProtocol?: string; /** The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. */ name?: string; /** * The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport * @format int32 */ nodePort?: number; /** * The port that will be exposed by this service. * @format int32 */ port: number; /** The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. */ protocol?: string; /** * IntOrString is a type that can hold an int32 or a string. When * used in JSON or YAML marshalling and unmarshalling, it produces * or consumes the inner type. This allows you to have, for example, * a JSON field that can accept a name or number. * * The name will be prefixed with the string `custom-` so that the target port that can be * referenced will be only those defined under .spec.pods.customContainers[].ports sections * were names are also prepended with the same prefix. * * @format int-or-string */ targetPort?: string; } /** SessionAffinityConfig represents the configurations of session affinity. */ interface SGCluster_spec_postgresServices_primary_sessionAffinityConfig { /** ClientIPConfig represents the configurations of Client IP based session affinity. */ clientIP?: SGCluster_spec_postgresServices_primary_sessionAffinityConfig_clientIP; } /** ClientIPConfig represents the configurations of Client IP based session affinity. */ interface SGCluster_spec_postgresServices_primary_sessionAffinityConfig_clientIP { /** * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). * @format int32 */ timeoutSeconds?: number; } /** * Configure the service to any replica with the name as the SGCluster plus the `-replicas` suffix. * * It provides a stable connection (regardless of replica node failures) to any read-only Postgres server of the cluster. Read-only servers are load-balanced via this service. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ interface SGCluster_spec_postgresServices_replicas { /** Specify if the service should be created or not. */ enabled?: boolean; /** * type determines how the Service is exposed. Defaults to ClusterIP. Valid * options are ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates * a cluster-internal IP address for load-balancing to endpoints. * "NodePort" builds on ClusterIP and allocates a port on every node. * "LoadBalancer" builds on NodePort and creates * an external load-balancer (if supported in the current cloud). * More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types * */ type?: "ClusterIP" | "LoadBalancer" | "NodePort"; /** * The list of custom ports that will be exposed by the service. * * The names of custom ports will be prefixed with the string `custom-` so they do not * conflict with ports defined for the service. * * The names of target ports will be prefixed with the string `custom-` so that the ports * that can be referenced in this section will be only those defined under * .spec.pods.customContainers[].ports sections were names are also prepended with the same * prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#serviceport-v1-core * */ customPorts?: SGCluster_spec_postgresServices_replicas_customPorts[]; /** allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. */ allocateLoadBalancerNodePorts?: boolean; /** externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. */ externalIPs?: string[]; /** * externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. * * */ externalTrafficPolicy?: string; /** * healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. * @format int32 */ healthCheckNodePort?: number; /** InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). */ internalTrafficPolicy?: string; /** * IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. * * This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. */ ipFamilies?: string[]; /** IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. */ ipFamilyPolicy?: string; /** loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. */ loadBalancerClass?: string; /** Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version. */ loadBalancerIP?: string; /** If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ */ loadBalancerSourceRanges?: string[]; /** * Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies * * */ sessionAffinity?: string; /** SessionAffinityConfig represents the configurations of session affinity. */ sessionAffinityConfig?: SGCluster_spec_postgresServices_replicas_sessionAffinityConfig; } /** * A custom port that will be exposed by the service. * * The name of the custom port will be prefixed with the string `custom-` so it does not * conflict with ports defined for the service. * * The name of target port will be prefixed with the string `custom-` so that the port * that can be referenced in this section will be only those defined under * .spec.pods.customContainers[].ports sections were names are also prepended with the same * prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#serviceport-v1-core * */ interface SGCluster_spec_postgresServices_replicas_customPorts { /** The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. */ appProtocol?: string; /** The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. */ name?: string; /** * The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport * @format int32 */ nodePort?: number; /** * The port that will be exposed by this service. * @format int32 */ port: number; /** The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. */ protocol?: string; /** * IntOrString is a type that can hold an int32 or a string. When * used in JSON or YAML marshalling and unmarshalling, it produces * or consumes the inner type. This allows you to have, for example, * a JSON field that can accept a name or number. * * The name will be prefixed with the string `custom-` so that the target port that can be * referenced will be only those defined under .spec.pods.customContainers[].ports sections * were names are also prepended with the same prefix. * * @format int-or-string */ targetPort?: string; } /** SessionAffinityConfig represents the configurations of session affinity. */ interface SGCluster_spec_postgresServices_replicas_sessionAffinityConfig { /** ClientIPConfig represents the configurations of Client IP based session affinity. */ clientIP?: SGCluster_spec_postgresServices_replicas_sessionAffinityConfig_clientIP; } /** ClientIPConfig represents the configurations of Client IP based session affinity. */ interface SGCluster_spec_postgresServices_replicas_sessionAffinityConfig_clientIP { /** * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). * @format int32 */ timeoutSeconds?: number; } /** Cluster pod's configuration. */ interface SGCluster_spec_pods { /** Pod's persistent volume configuration. */ persistentVolume: SGCluster_spec_pods_persistentVolume; /** If set to `true`, avoids creating a connection pooling (using [PgBouncer](https://www.pgbouncer.org/)) sidecar. */ disableConnectionPooling?: boolean; /** If set to `true`, avoids creating the Prometheus exporter sidecar. Recommended when there's no intention to use Prometheus for monitoring. */ disableMetricsExporter?: boolean; /** If set to `true`, avoids creating the `postgres-util` sidecar. This sidecar contains usual Postgres administration utilities *that are not present in the main (`patroni`) container*, like `psql`. Only disable if you know what you are doing. */ disablePostgresUtil?: boolean; /** Pod custom resources configuration. */ resources?: SGCluster_spec_pods_resources; /** Pod custom scheduling, affinity and topology spread constratins configuration. */ scheduling?: SGCluster_spec_pods_scheduling; /** * managementPolicy controls how pods are created during initial scale up, when replacing pods * on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created * in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is * ready before continuing. When scaling down, the pods are removed in the opposite order. * The alternative policy is `Parallel` which will create pods in parallel to match the desired * scale without waiting, and on scale down will delete all pods at once. * */ managementPolicy?: string; /** * A list of custom volumes that may be used along with any container defined in * customInitContainers or customContainers sections. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the customInitContainers or customContainers sections the name used * have to be prepended with the same prefix. * * Only the following volume types are allowed: configMap, downwardAPI, emptyDir, * gitRepo, glusterfs, hostPath, nfs, projected and secret * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core * */ customVolumes?: SGCluster_spec_pods_customVolumes[]; /** * A list of custom application init containers that run within the cluster's Pods. The * custom init containers will run following the defined sequence as the end of * cluster's Pods init containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ customInitContainers?: SGCluster_spec_pods_customInitContainers[]; /** * A list of custom application containers that run within the cluster's Pods. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ customContainers?: SGCluster_spec_pods_customContainers[]; } /** Pod's persistent volume configuration. */ interface SGCluster_spec_pods_persistentVolume { /** * Size of the PersistentVolume set for each instance of the cluster. This size is specified either in Mebibytes, Gibibytes or Tebibytes (multiples of 2^20, 2^30 or 2^40, respectively). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi|Ti)$ */ size: string; /** * Name of an existing StorageClass in the Kubernetes cluster, used to create the PersistentVolumes for the instances of the cluster. * */ storageClass?: string; } /** Pod custom resources configuration. */ interface SGCluster_spec_pods_resources { /** When enabled resource limits for containers other than the patroni container wil be set just like for patroni contianer as specified in the SGInstanceProfile. */ enableClusterLimitsRequirements?: boolean; } /** Pod custom scheduling, affinity and topology spread constratins configuration. */ interface SGCluster_spec_pods_scheduling { /** * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ * */ nodeSelector?: Record; /** * If specified, the pod's tolerations. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ tolerations?: SGCluster_spec_pods_scheduling_tolerations[]; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGCluster_spec_pods_scheduling_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGCluster_spec_pods_scheduling_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGCluster_spec_pods_scheduling_podAntiAffinity; /** * TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. * */ topologySpreadConstraints?: SGCluster_spec_pods_scheduling_topologySpreadConstraints[]; /** Backup Pod custom scheduling and affinity configuration. */ backup?: SGCluster_spec_pods_scheduling_backup; } /** * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ interface SGCluster_spec_pods_scheduling_tolerations { /** * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. * * */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. * * */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGCluster_spec_pods_scheduling_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGCluster_spec_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGCluster_spec_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGCluster_spec_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGCluster_spec_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGCluster_spec_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGCluster_spec_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGCluster_spec_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGCluster_spec_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGCluster_spec_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGCluster_spec_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGCluster_spec_pods_scheduling_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGCluster_spec_pods_scheduling_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * TopologySpreadConstraint specifies how to spread matching pods among the given topology. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#topologyspreadconstraint-v1-core * */ interface SGCluster_spec_pods_scheduling_topologySpreadConstraints { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_topologySpreadConstraints_labelSelector; /** MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. */ matchLabelKeys?: string[]; /** * MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. * @format int32 */ maxSkew: number; /** * MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. * * For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. * * This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default). * @format int32 */ minDomains?: number; /** * NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. * * If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeAffinityPolicy?: string; /** * NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. * * If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeTaintsPolicy?: string; /** TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. */ topologyKey: string; /** * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, * but giving higher precedence to topologies that would help reduce the * skew. * A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. * * */ whenUnsatisfiable: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_topologySpreadConstraints_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_topologySpreadConstraints_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_topologySpreadConstraints_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Backup Pod custom scheduling and affinity configuration. */ interface SGCluster_spec_pods_scheduling_backup { /** * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ * */ nodeSelector?: Record; /** * If specified, the pod's tolerations. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ tolerations?: SGCluster_spec_pods_scheduling_backup_tolerations[]; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGCluster_spec_pods_scheduling_backup_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGCluster_spec_pods_scheduling_backup_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity; } /** * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ interface SGCluster_spec_pods_scheduling_backup_tolerations { /** * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. * * */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. * * */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGCluster_spec_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGCluster_spec_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGCluster_spec_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGCluster_spec_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGCluster_spec_pods_scheduling_backup_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGCluster_spec_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * A custom volume that may be used along with any container defined in * customInitContainers or customContainers sections. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the customInitContainers or customContainers sections the name used * have to be prepended with the same prefix. * * Only the following volume types are allowed: configMap, downwardAPI, emptyDir, * gitRepo, glusterfs, hostPath, nfs, projected and secret * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core * */ interface SGCluster_spec_pods_customVolumes { /** * Volumes name. Must be a DNS_LABEL and unique within the pod. * More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names * * The name will be prefixed with the string `custom-` so that when referencing them in the * customInitContainers or customContainers sections the name used have to be prepended with * the same prefix. * */ name?: string; /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ configMap?: SGCluster_spec_pods_customVolumes_configMap; /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ downwardAPI?: SGCluster_spec_pods_customVolumes_downwardAPI; /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ emptyDir?: SGCluster_spec_pods_customVolumes_emptyDir; /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ gitRepo?: SGCluster_spec_pods_customVolumes_gitRepo; /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ glusterfs?: SGCluster_spec_pods_customVolumes_glusterfs; /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ hostPath?: SGCluster_spec_pods_customVolumes_hostPath; /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ nfs?: SGCluster_spec_pods_customVolumes_nfs; /** Represents a projected volume source */ projected?: SGCluster_spec_pods_customVolumes_projected; /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ secret?: SGCluster_spec_pods_customVolumes_secret; } /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ interface SGCluster_spec_pods_customVolumes_configMap { /** * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGCluster_spec_pods_customVolumes_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGCluster_spec_pods_customVolumes_configMap_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ interface SGCluster_spec_pods_customVolumes_downwardAPI { /** * Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** Items is a list of downward API volume file */ items?: SGCluster_spec_pods_customVolumes_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface SGCluster_spec_pods_customVolumes_downwardAPI_items { /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGCluster_spec_pods_customVolumes_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGCluster_spec_pods_customVolumes_downwardAPI_items_resourceFieldRef; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGCluster_spec_pods_customVolumes_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGCluster_spec_pods_customVolumes_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ interface SGCluster_spec_pods_customVolumes_emptyDir { /** What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ medium?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ sizeLimit?: string; } /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ interface SGCluster_spec_pods_customVolumes_gitRepo { /** Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */ directory?: string; /** Repository URL */ repository: string; /** Commit hash for the specified revision. */ revision?: string; } /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ interface SGCluster_spec_pods_customVolumes_glusterfs { /** EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ endpoints: string; /** Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ path: string; /** ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ readOnly?: boolean; } /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ interface SGCluster_spec_pods_customVolumes_hostPath { /** Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ path: string; /** Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ type?: string; } /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ interface SGCluster_spec_pods_customVolumes_nfs { /** Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ path: string; /** ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ readOnly?: boolean; /** Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ server: string; } /** Represents a projected volume source */ interface SGCluster_spec_pods_customVolumes_projected { /** * Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** list of volume projections */ sources?: SGCluster_spec_pods_customVolumes_projected_sources[]; } /** Projection that may be projected along with other supported volume types */ interface SGCluster_spec_pods_customVolumes_projected_sources { /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ configMap?: SGCluster_spec_pods_customVolumes_projected_sources_configMap; /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ downwardAPI?: SGCluster_spec_pods_customVolumes_projected_sources_downwardAPI; /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ secret?: SGCluster_spec_pods_customVolumes_projected_sources_secret; /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ serviceAccountToken?: SGCluster_spec_pods_customVolumes_projected_sources_serviceAccountToken; } /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ interface SGCluster_spec_pods_customVolumes_projected_sources_configMap { /** If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGCluster_spec_pods_customVolumes_projected_sources_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGCluster_spec_pods_customVolumes_projected_sources_configMap_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ interface SGCluster_spec_pods_customVolumes_projected_sources_downwardAPI { /** Items is a list of DownwardAPIVolume file */ items?: SGCluster_spec_pods_customVolumes_projected_sources_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface SGCluster_spec_pods_customVolumes_projected_sources_downwardAPI_items { /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGCluster_spec_pods_customVolumes_projected_sources_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGCluster_spec_pods_customVolumes_projected_sources_downwardAPI_items_resourceFieldRef; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGCluster_spec_pods_customVolumes_projected_sources_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGCluster_spec_pods_customVolumes_projected_sources_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ interface SGCluster_spec_pods_customVolumes_projected_sources_secret { /** If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGCluster_spec_pods_customVolumes_projected_sources_secret_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGCluster_spec_pods_customVolumes_projected_sources_secret_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ interface SGCluster_spec_pods_customVolumes_projected_sources_serviceAccountToken { /** Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. */ audience?: string; /** * ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. * @format int64 */ expirationSeconds?: number; /** Path is the path relative to the mount point of the file to project the token into. */ path: string; } /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ interface SGCluster_spec_pods_customVolumes_secret { /** * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGCluster_spec_pods_customVolumes_secret_items[]; /** Specify whether the Secret or its keys must be defined */ optional?: boolean; /** Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ secretName?: string; } /** Maps a string key to a path within a volume. */ interface SGCluster_spec_pods_customVolumes_secret_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** * A custom application init container that run within the cluster's Pods. The custom init * containers will run following the defined sequence as the end of cluster's Pods init * containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ interface SGCluster_spec_pods_customInitContainers { /** Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: SGCluster_spec_pods_customInitContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: SGCluster_spec_pods_customInitContainers_envFrom[]; /** Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ lifecycle?: SGCluster_spec_pods_customInitContainers_lifecycle; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ livenessProbe?: SGCluster_spec_pods_customInitContainers_livenessProbe; /** * Name of the container specified as a DNS_LABEL. Each * container in a pod must have a unique name (DNS_LABEL). Cannot * be updated. * * The name will be prefixed with the string `custom-` so that when referencing it * in the .spec.containers section of SGInstanceProfile the name used have to be * prepended with the same prefix. * */ name: string; /** List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. */ ports?: SGCluster_spec_pods_customInitContainers_ports[]; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ readinessProbe?: SGCluster_spec_pods_customInitContainers_readinessProbe; /** ResourceRequirements describes the compute resource requirements. */ resources?: SGCluster_spec_pods_customInitContainers_resources; /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ securityContext?: SGCluster_spec_pods_customInitContainers_securityContext; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ startupProbe?: SGCluster_spec_pods_customInitContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: SGCluster_spec_pods_customInitContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: SGCluster_spec_pods_customInitContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface SGCluster_spec_pods_customInitContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** EnvVarSource represents a source for the value of an EnvVar. */ valueFrom?: SGCluster_spec_pods_customInitContainers_env_valueFrom; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface SGCluster_spec_pods_customInitContainers_env_valueFrom { /** Selects a key from a ConfigMap. */ configMapKeyRef?: SGCluster_spec_pods_customInitContainers_env_valueFrom_configMapKeyRef; /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGCluster_spec_pods_customInitContainers_env_valueFrom_fieldRef; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGCluster_spec_pods_customInitContainers_env_valueFrom_resourceFieldRef; /** SecretKeySelector selects a key of a Secret. */ secretKeyRef?: SGCluster_spec_pods_customInitContainers_env_valueFrom_secretKeyRef; } /** Selects a key from a ConfigMap. */ interface SGCluster_spec_pods_customInitContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGCluster_spec_pods_customInitContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGCluster_spec_pods_customInitContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** SecretKeySelector selects a key of a Secret. */ interface SGCluster_spec_pods_customInitContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface SGCluster_spec_pods_customInitContainers_envFrom { /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ configMapRef?: SGCluster_spec_pods_customInitContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ secretRef?: SGCluster_spec_pods_customInitContainers_envFrom_secretRef; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface SGCluster_spec_pods_customInitContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SGCluster_spec_pods_customInitContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface SGCluster_spec_pods_customInitContainers_lifecycle { /** Handler defines a specific action that should be taken */ postStart?: SGCluster_spec_pods_customInitContainers_lifecycle_postStart; /** Handler defines a specific action that should be taken */ preStop?: SGCluster_spec_pods_customInitContainers_lifecycle_preStop; } /** Handler defines a specific action that should be taken */ interface SGCluster_spec_pods_customInitContainers_lifecycle_postStart { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customInitContainers_lifecycle_postStart_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customInitContainers_lifecycle_postStart_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customInitContainers_lifecycle_postStart_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customInitContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customInitContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customInitContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customInitContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customInitContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Handler defines a specific action that should be taken */ interface SGCluster_spec_pods_customInitContainers_lifecycle_preStop { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customInitContainers_lifecycle_preStop_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customInitContainers_lifecycle_preStop_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customInitContainers_lifecycle_preStop_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customInitContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customInitContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customInitContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customInitContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customInitContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGCluster_spec_pods_customInitContainers_livenessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customInitContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customInitContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customInitContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customInitContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customInitContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customInitContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customInitContainers_livenessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customInitContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ContainerPort represents a network port in a single container. */ interface SGCluster_spec_pods_customInitContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */ protocol?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGCluster_spec_pods_customInitContainers_readinessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customInitContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customInitContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customInitContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customInitContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customInitContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customInitContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customInitContainers_readinessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customInitContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ResourceRequirements describes the compute resource requirements. */ interface SGCluster_spec_pods_customInitContainers_resources { /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SGCluster_spec_pods_customInitContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN */ allowPrivilegeEscalation?: boolean; /** Adds and removes POSIX capabilities from running containers. */ capabilities?: SGCluster_spec_pods_customInitContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsUser?: number; /** SELinuxOptions are the labels to be applied to the container */ seLinuxOptions?: SGCluster_spec_pods_customInitContainers_securityContext_seLinuxOptions; /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ seccompProfile?: SGCluster_spec_pods_customInitContainers_securityContext_seccompProfile; /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ windowsOptions?: SGCluster_spec_pods_customInitContainers_securityContext_windowsOptions; } /** Adds and removes POSIX capabilities from running containers. */ interface SGCluster_spec_pods_customInitContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** SELinuxOptions are the labels to be applied to the container */ interface SGCluster_spec_pods_customInitContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SGCluster_spec_pods_customInitContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface SGCluster_spec_pods_customInitContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGCluster_spec_pods_customInitContainers_startupProbe { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customInitContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customInitContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customInitContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customInitContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customInitContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customInitContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customInitContainers_startupProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customInitContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface SGCluster_spec_pods_customInitContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface SGCluster_spec_pods_customInitContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * A custom application init container that run within the cluster's Pods. The custom init * containers will run following the defined sequence as the end of cluster's Pods init * containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ interface SGCluster_spec_pods_customContainers { /** Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: SGCluster_spec_pods_customContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: SGCluster_spec_pods_customContainers_envFrom[]; /** Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ lifecycle?: SGCluster_spec_pods_customContainers_lifecycle; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ livenessProbe?: SGCluster_spec_pods_customContainers_livenessProbe; /** * Name of the container specified as a DNS_LABEL. Each * container in a pod must have a unique name (DNS_LABEL). Cannot * be updated. * * The name will be prefixed with the string `custom-` so that when referencing it * in the .spec.containers section of SGInstanceProfile the name used have to be * prepended with the same prefix. * */ name: string; /** List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. */ ports?: SGCluster_spec_pods_customContainers_ports[]; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ readinessProbe?: SGCluster_spec_pods_customContainers_readinessProbe; /** ResourceRequirements describes the compute resource requirements. */ resources?: SGCluster_spec_pods_customContainers_resources; /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ securityContext?: SGCluster_spec_pods_customContainers_securityContext; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ startupProbe?: SGCluster_spec_pods_customContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: SGCluster_spec_pods_customContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: SGCluster_spec_pods_customContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface SGCluster_spec_pods_customContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** EnvVarSource represents a source for the value of an EnvVar. */ valueFrom?: SGCluster_spec_pods_customContainers_env_valueFrom; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface SGCluster_spec_pods_customContainers_env_valueFrom { /** Selects a key from a ConfigMap. */ configMapKeyRef?: SGCluster_spec_pods_customContainers_env_valueFrom_configMapKeyRef; /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGCluster_spec_pods_customContainers_env_valueFrom_fieldRef; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGCluster_spec_pods_customContainers_env_valueFrom_resourceFieldRef; /** SecretKeySelector selects a key of a Secret. */ secretKeyRef?: SGCluster_spec_pods_customContainers_env_valueFrom_secretKeyRef; } /** Selects a key from a ConfigMap. */ interface SGCluster_spec_pods_customContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGCluster_spec_pods_customContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGCluster_spec_pods_customContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** SecretKeySelector selects a key of a Secret. */ interface SGCluster_spec_pods_customContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface SGCluster_spec_pods_customContainers_envFrom { /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ configMapRef?: SGCluster_spec_pods_customContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ secretRef?: SGCluster_spec_pods_customContainers_envFrom_secretRef; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface SGCluster_spec_pods_customContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SGCluster_spec_pods_customContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface SGCluster_spec_pods_customContainers_lifecycle { /** Handler defines a specific action that should be taken */ postStart?: SGCluster_spec_pods_customContainers_lifecycle_postStart; /** Handler defines a specific action that should be taken */ preStop?: SGCluster_spec_pods_customContainers_lifecycle_preStop; } /** Handler defines a specific action that should be taken */ interface SGCluster_spec_pods_customContainers_lifecycle_postStart { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customContainers_lifecycle_postStart_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customContainers_lifecycle_postStart_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customContainers_lifecycle_postStart_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Handler defines a specific action that should be taken */ interface SGCluster_spec_pods_customContainers_lifecycle_preStop { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customContainers_lifecycle_preStop_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customContainers_lifecycle_preStop_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customContainers_lifecycle_preStop_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGCluster_spec_pods_customContainers_livenessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customContainers_livenessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ContainerPort represents a network port in a single container. */ interface SGCluster_spec_pods_customContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */ protocol?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGCluster_spec_pods_customContainers_readinessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customContainers_readinessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ResourceRequirements describes the compute resource requirements. */ interface SGCluster_spec_pods_customContainers_resources { /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SGCluster_spec_pods_customContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN */ allowPrivilegeEscalation?: boolean; /** Adds and removes POSIX capabilities from running containers. */ capabilities?: SGCluster_spec_pods_customContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsUser?: number; /** SELinuxOptions are the labels to be applied to the container */ seLinuxOptions?: SGCluster_spec_pods_customContainers_securityContext_seLinuxOptions; /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ seccompProfile?: SGCluster_spec_pods_customContainers_securityContext_seccompProfile; /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ windowsOptions?: SGCluster_spec_pods_customContainers_securityContext_windowsOptions; } /** Adds and removes POSIX capabilities from running containers. */ interface SGCluster_spec_pods_customContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** SELinuxOptions are the labels to be applied to the container */ interface SGCluster_spec_pods_customContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SGCluster_spec_pods_customContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface SGCluster_spec_pods_customContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGCluster_spec_pods_customContainers_startupProbe { /** ExecAction describes a "run in container" action. */ exec?: SGCluster_spec_pods_customContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGCluster_spec_pods_customContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGCluster_spec_pods_customContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGCluster_spec_pods_customContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGCluster_spec_pods_customContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGCluster_spec_pods_customContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGCluster_spec_pods_customContainers_startupProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGCluster_spec_pods_customContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface SGCluster_spec_pods_customContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface SGCluster_spec_pods_customContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * Cluster custom configurations. * */ interface SGCluster_spec_configurations { /** * Name of the [SGPostgresConfig](https://stackgres.io/doc/latest/reference/crd/sgpgconfig) used for the cluster. It must exist. When not set, a default Postgres config, for the major version selected, is used. * */ sgPostgresConfig?: string; /** * Name of the [SGPoolingConfig](https://stackgres.io/doc/latest/reference/crd/sgpoolconfig) used for this cluster. Each pod contains a sidecar with a connection pooler (currently: [PgBouncer](https://www.pgbouncer.org/)). The connection pooler is implemented as a sidecar. * * If not set, a default configuration will be used. Disabling connection pooling altogether is possible if the disableConnectionPooling property of the pods object is set to true. * */ sgPoolingConfig?: string; /** * **Deprecated**: use instead .spec.configurations.backups with sgObjectStorage. * * Name of the [SGBackupConfig](https://stackgres.io/doc/latest/reference/crd/sgbackupconfig) to use for the cluster. It defines the backups policy, storage and retention, among others, applied to the cluster. When not set, backup configuration will not be used. * */ sgBackupConfig?: string; /** * **Deprecated**: use instead .spec.configurations.backups[].path * * The path were the backup is stored. If not set this field is filled up by the operator. * * When provided will indicate were the backups and WAL files will be stored. * */ backupPath?: string; /** * List of backups configurations for this SGCluster * */ backups?: SGCluster_spec_configurations_backups[]; /** Allow to specify Patroni configuration that will extend the generated one */ patroni?: SGCluster_spec_configurations_patroni; /** Allow to specify custom credentials for Postgres users and Patroni REST API */ credentials?: SGCluster_spec_configurations_credentials; } /** * Backup configuration for this SGCluster * */ interface SGCluster_spec_configurations_backups { /** * Specifies the backup compression algorithm. Possible options are: lz4, lzma, brotli. The default method is `lz4`. LZ4 is the fastest method, but compression ratio is the worst. LZMA is way slower, but it compresses backups about 6 times better than LZ4. Brotli is a good trade-off between speed and compression ratio, being about 3 times better than LZ4. * */ compression?: "lz4" | "lzma" | "brotli"; /** * Continuous Archiving backups are composed of periodic *base backups* and all the WAL segments produced in between those base backups. This parameter specifies at what time and with what frequency to start performing a new base backup. * * Use cron syntax (`m h dom mon dow`) for this parameter, i.e., 5 values separated by spaces: * * `m`: minute, 0 to 59. * * `h`: hour, 0 to 23. * * `dom`: day of month, 1 to 31 (recommended not to set it higher than 28). * * `mon`: month, 1 to 12. * * `dow`: day of week, 0 to 7 (0 and 7 both represent Sunday). * * Also ranges of values (`start-end`), the symbol `*` (meaning `first-last`) or even `*\//N`, where `N` is a number, meaning ""every `N`, may be used. All times are UTC. It is recommended to avoid 00:00 as base backup time, to avoid overlapping with any other external operations happening at this time. * * If not set, full backups are performed each day at 05:00 UTC. * */ cronSchedule?: string; /** * Configuration that affects the backup network and disk usage performance. * */ performance?: SGCluster_spec_configurations_backups_performance; /** * When an automatic retention policy is defined to delete old base backups, this parameter specifies the number of base backups to keep, in a sliding window. * * Consequently, the time range covered by backups is `periodicity*retention`, where `periodicity` is the separation between backups as specified by the `cronSchedule` property. * * Default is 5. * */ retention?: number; /** * Name of the [SGObjectStorage](https://stackgres.io/doc/latest/reference/crd/sgobjectstorage) to use for the cluster. It defines the location in which the the backups will be stored. * */ sgObjectStorage: string; /** * The path were the backup is stored. If not set this field is filled up by the operator. * * When provided will indicate were the backups and WAL files will be stored. * */ path?: string; } /** * Configuration that affects the backup network and disk usage performance. * */ interface SGCluster_spec_configurations_backups_performance { /** * Maximum storage upload bandwidth used when storing a backup. In bytes (per second). * */ maxNetworkBandwidth?: number; /** * Maximum disk read I/O when performing a backup. In bytes (per second). * */ maxDiskBandwidth?: number; /** * Backup storage may use several concurrent streams to store the data. This parameter configures the number of parallel streams to use to reading from disk. By default, it's set to 1. * */ uploadDiskConcurrency?: number; /** * Backup storage may use several concurrent streams to store the data. This parameter configures the number of parallel streams to use. By default, it's set to 16. * */ uploadConcurrency?: number; /** * Backup storage may use several concurrent streams to read the data. This parameter configures the number of parallel streams to use. By default, it's set to the minimum between the number of file to read and 10. * */ downloadConcurrency?: number; } /** Allow to specify Patroni configuration that will extend the generated one */ interface SGCluster_spec_configurations_patroni { /** Allow to specify Patroni configuration that will overwrite the generated one */ initialConfig?: object; } /** Allow to specify custom credentials for Postgres users and Patroni REST API */ interface SGCluster_spec_configurations_credentials { /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials for patroni REST API. * */ patroni?: SGCluster_spec_configurations_credentials_patroni; /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the users. * */ users?: SGCluster_spec_configurations_credentials_users; } /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials for patroni REST API. * */ interface SGCluster_spec_configurations_credentials_patroni { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password for the patroni REST API. * */ restApiPassword?: SGCluster_spec_configurations_credentials_patroni_restApiPassword; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password for the patroni REST API. * */ interface SGCluster_spec_configurations_credentials_patroni_restApiPassword { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the users. * */ interface SGCluster_spec_configurations_credentials_users { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the superuser (usually the postgres user). * */ superuser?: SGCluster_spec_configurations_credentials_users_superuser; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the replication user used to replicate from the primary cluster and from replicas of this cluster. * */ replication?: SGCluster_spec_configurations_credentials_users_replication; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the authenticator user used by pgbouncer to authenticate other users. * */ authenticator?: SGCluster_spec_configurations_credentials_users_authenticator; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the superuser (usually the postgres user). * */ interface SGCluster_spec_configurations_credentials_users_superuser { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username?: SGCluster_spec_configurations_credentials_users_superuser_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password?: SGCluster_spec_configurations_credentials_users_superuser_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGCluster_spec_configurations_credentials_users_superuser_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGCluster_spec_configurations_credentials_users_superuser_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the replication user used to replicate from the primary cluster and from replicas of this cluster. * */ interface SGCluster_spec_configurations_credentials_users_replication { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username?: SGCluster_spec_configurations_credentials_users_replication_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password?: SGCluster_spec_configurations_credentials_users_replication_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGCluster_spec_configurations_credentials_users_replication_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGCluster_spec_configurations_credentials_users_replication_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the authenticator user used by pgbouncer to authenticate other users. * */ interface SGCluster_spec_configurations_credentials_users_authenticator { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username?: SGCluster_spec_configurations_credentials_users_authenticator_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password?: SGCluster_spec_configurations_credentials_users_authenticator_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGCluster_spec_configurations_credentials_users_authenticator_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGCluster_spec_configurations_credentials_users_authenticator_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * This section allows to reference SQL scripts that will be applied to the cluster live. * */ interface SGCluster_spec_managedSql { /** If true, when any entry of any `SGScript` fail will not prevent subsequent `SGScript` from being executed. By default is `false`. */ continueOnSGScriptError?: boolean; /** * A list of script references that will be executed in sequence. * */ scripts?: SGCluster_spec_managedSql_scripts[]; } /** * A script reference. Each version of each entry of the script referenced will be executed exactly once following the sequence defined * in the referenced script and skipping any script entry that have already been executed. * */ interface SGCluster_spec_managedSql_scripts { /** The id is immutable and must be unique across all the `SGScript` entries. It is replaced by the operator and is used to identify the `SGScript` entry. */ id?: number; /** A reference to an `SGScript` */ sgScript?: string; } /** Cluster initialization data options. Cluster may be initialized empty, or from a backup restoration. Specifying scripts to run on the database after cluster creation is also possible. */ interface SGCluster_spec_initialData { /** */ restore?: SGCluster_spec_initialData_restore; /** * **Deprecated** use instead .spec.managedSql with SGScript. * * A list of SQL scripts executed in sequence, exactly once, when the database is bootstrap and/or after restore is completed. * */ scripts?: SGCluster_spec_initialData_scripts[]; } /** */ interface SGCluster_spec_initialData_restore { /** * From which backup to restore and how the process is configured * */ fromBackup?: SGCluster_spec_initialData_restore_fromBackup; /** * The backup fetch process may fetch several streams in parallel. Parallel fetching is enabled when set to a value larger than one. * * If not specified it will be interpreted as latest. * */ downloadDiskConcurrency?: number; } /** * From which backup to restore and how the process is configured * */ interface SGCluster_spec_initialData_restore_fromBackup { /** * When set to the UID of an existing [SGBackup](https://stackgres.io/doc/latest/reference/crd/sgbackup), the cluster is initialized by restoring the * backup data to it. If not set, the cluster is initialized empty. This field is deprecated. * */ uid?: string; /** * When set to the name of an existing [SGBackup](https://stackgres.io/doc/latest/reference/crd/sgbackup), the cluster is initialized by restoring the * backup data to it. If not set, the cluster is initialized empty. The selected backup must be in the same namespace. * */ name?: string; /** * Specify the [recovery_target](https://postgresqlco.nf/doc/en/param/recovery_target/) that specifies that recovery should end as soon as a consistent * state is reached, i.e., as early as possible. When restoring from an online backup, this means the point where taking the backup ended. * * Technically, this is a string parameter, but 'immediate' is currently the only allowed value. * */ target?: string; /** * Specify the [recovery_target_timeline](https://postgresqlco.nf/doc/en/param/recovery_target_timeline/) to recover into a particular timeline. * The default is to recover along the same timeline that was current when the base backup was taken. Setting this to latest recovers to the latest * timeline found in the archive, which is useful in a standby server. Other than that you only need to set this parameter in complex re-recovery * situations, where you need to return to a state that itself was reached after a point-in-time recovery. * */ targetTimeline?: string; /** * Specify the [recovery_target_inclusive](https://postgresqlco.nf/doc/en/param/recovery_target_timeline/) to stop recovery just after the specified * recovery target (true), or just before the recovery target (false). Applies when targetLsn, pointInTimeRecovery, or targetXid is specified. This * setting controls whether transactions having exactly the target WAL location (LSN), commit time, or transaction ID, respectively, will be included * in the recovery. Default is true. * */ targetInclusive?: boolean; /** * [recovery_target_name](https://postgresqlco.nf/doc/en/param/recovery_target_name/) specifies the named restore point * (created with pg_create_restore_point()) to which recovery will proceed. * */ targetName?: string; /** * [recovery_target_xid](https://postgresqlco.nf/doc/en/param/recovery_target_xid/) specifies the transaction ID up to which recovery will proceed. * Keep in mind that while transaction IDs are assigned sequentially at transaction start, transactions can complete in a different numeric order. * The transactions that will be recovered are those that committed before (and optionally including) the specified one. The precise stopping point * is also influenced by targetInclusive. * */ targetXid?: string; /** * [recovery_target_lsn](https://postgresqlco.nf/doc/en/param/recovery_target_lsn/) specifies the LSN of the write-ahead log location up to which * recovery will proceed. The precise stopping point is also influenced by targetInclusive. This parameter is parsed using the system data type * pg_lsn. * */ targetLsn?: string; /** * It is possible to restore the database to its state at any time since your backup was taken using Point-in-Time Recovery (PITR) as long as another * backup newer than the PITR requested restoration date does not exists. * * Point In Time Recovery (PITR). PITR allow to restore the database state to an arbitrary point of time in the past, as long as you specify a backup * older than the PITR requested restoration date and does not exists a backup newer than the same restoration date. * * See also: https://www.postgresql.org/docs/current/continuous-archiving.html * */ pointInTimeRecovery?: SGCluster_spec_initialData_restore_fromBackup_pointInTimeRecovery; } /** * It is possible to restore the database to its state at any time since your backup was taken using Point-in-Time Recovery (PITR) as long as another * backup newer than the PITR requested restoration date does not exists. * * Point In Time Recovery (PITR). PITR allow to restore the database state to an arbitrary point of time in the past, as long as you specify a backup * older than the PITR requested restoration date and does not exists a backup newer than the same restoration date. * * See also: https://www.postgresql.org/docs/current/continuous-archiving.html * */ interface SGCluster_spec_initialData_restore_fromBackup_pointInTimeRecovery { /** * An ISO 8601 date, that holds UTC date indicating at which point-in-time the database have to be restored. * */ restoreToTimestamp?: string; } /** * **Deprecated** use instead .spec.managedSql with SGScript. * * Scripts are executed in auto-commit mode with the user `postgres` in the specified database (or in database `postgres` if not specified). * * Fields `script` and `scriptFrom` are mutually exclusive and only one of them is required. * */ interface SGCluster_spec_initialData_scripts { /** * Name of the script. Must be unique across this SGCluster. * */ name?: string; /** * Database where the script is executed. Defaults to the `postgres` database, if not specified. * */ database?: string; /** * Raw SQL script to execute. This field is mutually exclusive with `scriptFrom` field. * */ script?: string; /** * Reference to either a Kubernetes [Secret](https://kubernetes.io/docs/concepts/configuration/secret/) or a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) that contains the SQL script to execute. This field is mutually exclusive with `script` field. * * Fields `secretKeyRef` and `configMapKeyRef` are mutually exclusive, and one of them is required. * */ scriptFrom?: SGCluster_spec_initialData_scripts_scriptFrom; } /** * Reference to either a Kubernetes [Secret](https://kubernetes.io/docs/concepts/configuration/secret/) or a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) that contains the SQL script to execute. This field is mutually exclusive with `script` field. * * Fields `secretKeyRef` and `configMapKeyRef` are mutually exclusive, and one of them is required. * */ interface SGCluster_spec_initialData_scripts_scriptFrom { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the SQL script to execute. This field is mutually exclusive with `configMapKeyRef` field. * */ secretKeyRef?: SGCluster_spec_initialData_scripts_scriptFrom_secretKeyRef; /** * A [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) reference that contains the SQL script to execute. This field is mutually exclusive with `secretKeyRef` field. * */ configMapKeyRef?: SGCluster_spec_initialData_scripts_scriptFrom_configMapKeyRef; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the SQL script to execute. This field is mutually exclusive with `configMapKeyRef` field. * */ interface SGCluster_spec_initialData_scripts_scriptFrom_secretKeyRef { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name?: string; /** The key of the secret to select from. Must be a valid secret key. */ key?: string; } /** * A [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) reference that contains the SQL script to execute. This field is mutually exclusive with `secretKeyRef` field. * */ interface SGCluster_spec_initialData_scripts_scriptFrom_configMapKeyRef { /** * The name of the ConfigMap that contains the SQL script to execute. * */ name?: string; /** * The key name within the ConfigMap that contains the SQL script to execute. * */ key?: string; } /** * Make the cluster a read-only standby replica allowing to replicate from another PostgreSQL instance and acting as a rely. * * Changing this section is allowed to fix issues or to change the replication source. * * Removing this section convert the cluster in a normal cluster where the standby leader is converted into the a primary instance. * */ interface SGCluster_spec_replicateFrom { /** * Configure replication from a PostgreSQL instance. * */ instance?: SGCluster_spec_replicateFrom_instance; /** * Configure replication from an SGObjectStorage using WAL shipping. * * The file structure of the object storage must follow the * [WAL-G](https://github.com/wal-g/wal-g) file structure. * */ storage?: SGCluster_spec_replicateFrom_storage; /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the users. * */ users?: SGCluster_spec_replicateFrom_users; } /** * Configure replication from a PostgreSQL instance. * */ interface SGCluster_spec_replicateFrom_instance { /** * Configure replication from an SGCluster. * */ sgCluster?: string; /** * Configure replication from an external PostgreSQL instance. * */ external?: SGCluster_spec_replicateFrom_instance_external; } /** * Configure replication from an external PostgreSQL instance. * */ interface SGCluster_spec_replicateFrom_instance_external { /** The host of the PostgreSQL to replicate from. */ host: string; /** The port of the PostgreSQL to replicate from. */ port: number; } /** * Configure replication from an SGObjectStorage using WAL shipping. * * The file structure of the object storage must follow the * [WAL-G](https://github.com/wal-g/wal-g) file structure. * */ interface SGCluster_spec_replicateFrom_storage { /** * Configuration that affects the backup network and disk usage performance. * */ performance?: SGCluster_spec_replicateFrom_storage_performance; /** The SGObjectStorage name to replicate from. */ sgObjectStorage: string; /** The path in the SGObjectStorage to replicate from. */ path: string; } /** * Configuration that affects the backup network and disk usage performance. * */ interface SGCluster_spec_replicateFrom_storage_performance { /** * Maximum storage upload bandwidth used when storing a backup. In bytes (per second). * */ maxNetworkBandwidth?: number; /** * Maximum disk read I/O when performing a backup. In bytes (per second). * */ maxDiskBandwidth?: number; /** * Backup storage may use several concurrent streams to read the data. This parameter configures the number of parallel streams to use. By default, it's set to the minimum between the number of file to read and 10. * */ downloadConcurrency?: number; } /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the users. * */ interface SGCluster_spec_replicateFrom_users { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the superuser (usually the postgres user). * */ superuser: SGCluster_spec_replicateFrom_users_superuser; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the replication user used to replicate from the primary cluster and from replicas of this cluster. * */ replication: SGCluster_spec_replicateFrom_users_replication; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the authenticator user used by pgbouncer to authenticate other users. * */ authenticator: SGCluster_spec_replicateFrom_users_authenticator; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the superuser (usually the postgres user). * */ interface SGCluster_spec_replicateFrom_users_superuser { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username: SGCluster_spec_replicateFrom_users_superuser_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password: SGCluster_spec_replicateFrom_users_superuser_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGCluster_spec_replicateFrom_users_superuser_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGCluster_spec_replicateFrom_users_superuser_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the replication user used to replicate from the primary cluster and from replicas of this cluster. * */ interface SGCluster_spec_replicateFrom_users_replication { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username: SGCluster_spec_replicateFrom_users_replication_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password: SGCluster_spec_replicateFrom_users_replication_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGCluster_spec_replicateFrom_users_replication_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGCluster_spec_replicateFrom_users_replication_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the authenticator user used by pgbouncer to authenticate other users. * */ interface SGCluster_spec_replicateFrom_users_authenticator { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username: SGCluster_spec_replicateFrom_users_authenticator_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password: SGCluster_spec_replicateFrom_users_authenticator_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGCluster_spec_replicateFrom_users_authenticator_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGCluster_spec_replicateFrom_users_authenticator_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** */ interface SGCluster_spec_nonProductionOptions { /** * It is a best practice, on non-containerized environments, when running production workloads, to run each database server on a different server (virtual or physical), i.e., not to co-locate more than one database server per host. * * The same best practice applies to databases on containers. By default, StackGres will not allow to run more than one StackGres pod on a given Kubernetes node. Set this property to true to allow more than one StackGres pod per node. * */ disableClusterPodAntiAffinity?: boolean; /** * It is a best practice, on containerized environments, when running production workloads, to enforce container's resources requirements. * * The same best practice applies to databases on containers. By default, StackGres will configure resource requirements for patroni container. Set this property to true to prevent StackGres from setting patroni container's resources requirement. * */ disablePatroniResourceRequirements?: boolean; /** * It is a best practice, on containerized environments, when running production workloads, to enforce container's resources requirements. * * By default, StackGres will configure resource requirements for all the containers. Set this property to true to prevent StackGres from setting container's resources requirements (except for patroni container, see `disablePatroniResourceRequirements`). * */ disableClusterResourceRequirements?: boolean; /** * On containerized environments, when running production workloads, enforcing container's cpu requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less cpu than it requires. It also allow to set [static CPU management policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) that allows to guarantee a pod the usage exclusive CPUs on the node. * * By default, StackGres will configure cpu requirements to have the same limit and request for the patroni container. Set this property to true to prevent StackGres from setting patroni container's cpu requirements request equals to the limit * when `.spec.requests.cpu` is configured in the referenced `SGInstanceProfile`. * */ enableSetPatroniCpuRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's cpu requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less cpu than it requires. It also allow to set [static CPU management policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) that allows to guarantee a pod the usage exclusive CPUs on the node. * * By default, StackGres will configure cpu requirements to have the same limit and request for all the containers. Set this property to true to prevent StackGres from setting container's cpu requirements request equals to the limit (except for patroni container, see `enablePatroniCpuRequests`) * when `.spec.requests.containers..cpu` `.spec.requests.initContainers..cpu` is configured in the referenced `SGInstanceProfile`. * */ enableSetClusterCpuRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's memory requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less memory than it requires. * * By default, StackGres will configure memory requirements to have the same limit and request for the patroni container. Set this property to true to prevent StackGres from setting patroni container's memory requirements request equals to the limit * when `.spec.requests.memory` is configured in the referenced `SGInstanceProfile`. * */ enableSetPatroniMemoryRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's memory requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less memory than it requires. * * By default, StackGres will configure memory requirements to have the same limit and request for all the containers. Set this property to true to prevent StackGres from setting container's memory requirements request equals to the limit (except for patroni container, see `enablePatroniCpuRequests`) * when `.spec.requests.containers..memory` `.spec.requests.initContainers..memory` is configured in the referenced `SGInstanceProfile`. * */ enableSetClusterMemoryRequests?: boolean; /** * A list of StackGres feature gates to enable (not suitable for a production environment). * * Available feature gates are: * * `babelfish-flavor`: Allow to use `babelfish` flavor. * */ enabledFeatureGates?: string[]; } /** StackGres features a functionality for all pods to send Postgres, Patroni and PgBouncer logs to a central (distributed) location, which is in turn another Postgres database. Logs can then be accessed via SQL interface or from the web UI. This section controls whether to enable this feature or not. If not enabled, logs are send to the pod's standard output. */ interface SGCluster_spec_distributedLogs { /** * Name of the [SGDistributedLogs](https://stackgres.io/doc/latest/04-postgres-cluster-management/06-distributed-logs/) to use for this cluster. It must exist. * */ sgDistributedLogs?: string; /** * Define a retention window with the syntax ` (minutes|hours|days|months)` in which log entries are kept. * Log entries will be removed when they get older more than the double of the specified retention window. * * When this field is changed the retention will be applied only to log entries that are newer than the end of * the retention window previously specified. If no retention window was previously specified it is considered * to be of 7 days. This means that if previous retention window is of `7 days` new retention configuration will * apply after UTC timestamp calculated with: `SELECT date_trunc('days', now() at time zone 'UTC') - INTERVAL '7 days'`. * * @pattern ^[0-9]+ (minutes?|hours?|days?|months?) */ retention?: string; } /** */ interface SGCluster_spec_toInstallPostgresExtensions { /** The name of the extension to install. */ name: string; /** The id of the publisher of the extension to install. */ publisher: string; /** The version of the extension to install. */ version: string; /** The repository base URL from where the extension will be installed from. */ repository: string; /** The postgres major version of the extension to install. */ postgresVersion: string; /** The build version of the extension to install. */ build?: string; /** The extra mounts of the extension to install. */ extraMounts?: string[]; } /** */ interface SGCluster_status { /** */ conditions?: SGCluster_status_conditions[]; /** The list of pod statuses. */ podStatuses?: SGCluster_status_podStatuses[]; /** * Used by some [SGDbOps](https://stackgres.io/doc/latest/reference/crd/sgdbops) to indicate the operation configuration and status to the operator. * */ dbOps?: SGCluster_status_dbOps; /** The architecture on which the cluster has been initialized. */ arch?: string; /** The operative system on which the cluster has been initialized. */ os?: string; /** The custom prefix that is prepended to all labels. */ labelPrefix?: string; /** * This section stores the state of referenced SQL scripts that are applied to the cluster live. * */ managedSql?: SGCluster_status_managedSql; } /** */ interface SGCluster_status_conditions { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: string; /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status?: string; /** Type of deployment condition. */ type?: string; } /** */ interface SGCluster_status_podStatuses { /** The name of the pod. */ name: string; /** Indicates the replication group this Pod belongs to. */ replicationGroup?: number; /** Indicates if the pod is the elected primary */ primary?: boolean; /** Indicates if the pod requires restart */ pendingRestart?: boolean; /** The list of Postgres extensions currently installed. */ installedPostgresExtensions?: SGCluster_status_podStatuses_installedPostgresExtensions[]; } /** */ interface SGCluster_status_podStatuses_installedPostgresExtensions { /** The name of the installed extension. */ name: string; /** The id of the publisher of the installed extension. */ publisher: string; /** The version of the installed extension. */ version: string; /** The repository base URL from where the extension was installed from. */ repository: string; /** The postgres major version of the installed extension. */ postgresVersion: string; /** The build version of the installed extension. */ build?: string; /** The extra mounts of the installed extension. */ extraMounts?: string[]; } /** * Used by some [SGDbOps](https://stackgres.io/doc/latest/reference/crd/sgdbops) to indicate the operation configuration and status to the operator. * */ interface SGCluster_status_dbOps { /** * The major version upgrade configuration and status * */ majorVersionUpgrade?: SGCluster_status_dbOps_majorVersionUpgrade; /** * The minor version upgrade configuration and status * */ restart?: SGCluster_status_dbOps_restart; /** * The minor version upgrade configuration and status * */ minorVersionUpgrade?: SGCluster_status_dbOps_minorVersionUpgrade; /** * The minor version upgrade configuration and status * */ securityUpgrade?: SGCluster_status_dbOps_securityUpgrade; } /** * The major version upgrade configuration and status * */ interface SGCluster_status_dbOps_majorVersionUpgrade { /** * The instances that this operation is targetting * */ initialInstances?: string[]; /** * The primary instance that this operation is targetting * */ primaryInstance?: string; /** * The source PostgreSQL version * */ sourcePostgresVersion?: string; /** * The source SGPostgresConfig reference * */ sourceSgPostgresConfig?: string; /** * The source backup path * */ sourceBackupPath?: string; /** * The target PostgreSQL version * */ targetPostgresVersion?: string; /** * The PostgreSQL locale * */ locale?: string; /** * The PostgreSQL encoding * */ encoding?: string; /** * Indicates if PostgreSQL data checksum is enabled * */ dataChecksum?: boolean; /** * Use `--link` option when running `pg_upgrade` * */ link?: boolean; /** * Use `--clone` option when running `pg_upgrade` * */ clone?: boolean; /** * Run `pg_upgrade` with check option instead of performing the real upgrade * */ check?: boolean; /** * Indicates to rollback from a previous major version upgrade * */ rollback?: boolean; } /** * The minor version upgrade configuration and status * */ interface SGCluster_status_dbOps_restart { /** * The instances that this operation is targetting * */ initialInstances?: string[]; /** * The primary instance that this operation is targetting * */ primaryInstance?: string; } /** * The minor version upgrade configuration and status * */ interface SGCluster_status_dbOps_minorVersionUpgrade { /** * The instances that this operation is targetting * */ initialInstances?: string[]; /** * The primary instance that this operation is targetting * */ primaryInstance?: string; /** * Postgres version that is currently running on the cluster * */ sourcePostgresVersion?: string; /** * The desired Postgres version for the cluster * */ targetPostgresVersion?: string; } /** * The minor version upgrade configuration and status * */ interface SGCluster_status_dbOps_securityUpgrade { /** * The instances that this operation is targetting * */ initialInstances?: string[]; /** * The primary instance that this operation is targetting * */ primaryInstance?: string; } /** * This section stores the state of referenced SQL scripts that are applied to the cluster live. * */ interface SGCluster_status_managedSql { /** A list of statuses for script references. */ scripts?: SGCluster_status_managedSql_scripts[]; } /** The status of a script reference. */ interface SGCluster_status_managedSql_scripts { /** Identify the associated `SGScript` entry with the same value in the `id` field. */ id?: number; /** ISO-8601 datetime of when the script execution has been started. */ startedAt?: string; /** ISO-8601 datetime of when the last script execution occurred. Will be reset each time the referenced `SGScripts` entry will be applied. */ updatedAt?: string; /** ISO-8601 datetime of when the script execution had failed (mutually exclusive with `completedAt`). */ failedAt?: string; /** ISO-8601 datetime of when the script execution had completed (mutually exclusive with `failedAt`). */ completedAt?: string; /** A list of statuses for script entries of referenced script. */ scripts?: SGCluster_status_managedSql_scripts_scripts[]; } /** The status of a script entry of a referenced script. */ interface SGCluster_status_managedSql_scripts_scripts { /** Identify the associated script entry with the same value in the `id` field. */ id?: number; /** The latest version applied */ version?: number; /** Indicates the number of intents or failures occurred */ intents?: number; /** If failed, the error code of the failure. See also https://www.postgresql.org/docs/current/errcodes-appendix.html */ failureCode?: string; /** If failed, a message of the failure */ failure?: string; } /** */ interface SGDbOps { /** */ metadata: SGDbOps_metadata; /** */ spec: SGDbOps_spec; /** */ status?: SGDbOps_status; } /** */ interface SGDbOps_metadata { /** * Name of the Database Operation. A database operation represents a ""kind"" of operation on a StackGres cluster, classified by a given name. The operation reference one SGCluster by its name. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 `label`, an alphanumeric (a-z, and 0-9) string, with a maximum length of 21 characters, with the '-' character allowed anywhere except the first or last character. * * The name must be unique across all database operations in the same namespace." * * @pattern ^[a-z]([-a-z0-9]*[a-z0-9])?$ */ name?: string; } /** */ interface SGDbOps_spec { /** * The name of SGCluster on which the operation will be performed. * */ sgCluster: string; /** Pod custom node scheduling and affinity configuration */ scheduling?: SGDbOps_spec_scheduling; /** * The kind of operation that will be performed on the SGCluster. Available operations are: * * * `benchmark`: run a benchmark on the specified SGCluster and report the results in the status. * * `vacuum`: perform a [vacuum](https://www.postgresql.org/docs/current/sql-vacuum.html) operation on the specified SGCluster. * * `repack`: run [`pg_repack`](https://github.com/reorg/pg_repack) command on the specified SGCluster. * * `majorVersionUpgrade`: perform a major version upgrade of PostgreSQL using [`pg_upgrade`](https://www.postgresql.org/docs/current/pgupgrade.html) command. * * `restart`: perform a restart of the cluster. * * `minorVersionUpgrade`: perform a minor version upgrade of PostgreSQL. * * `securityUpgrade`: perform a security upgrade of the cluster. * * `upgrade`: perform a operator API upgrade of the cluster * */ op: string; /** * An ISO 8601 date, that holds UTC scheduled date of the operation execution. * * If not specified or if the date it's in the past, it will be interpreted ASAP. * */ runAt?: string; /** * An ISO 8601 duration in the format `PnDTnHnMn.nS`, that specifies a timeout after which the operation execution will be canceled. * * If the operation can not be performed due to timeout expiration, the condition `Failed` will have a status of `True` and the reason will be `OperationTimedOut`. * * If not specified the operation will never fail for timeout expiration. * */ timeout?: string; /** * The maximum number of retries the operation is allowed to do after a failure. * * A value of `0` (zero) means no retries are made. Can not be greater than `10`. Defaults to: `0`. * */ maxRetries?: number; /** * Configuration of the benchmark * */ benchmark?: SGDbOps_spec_benchmark; /** * Configuration of [vacuum](https://www.postgresql.org/docs/current/sql-vacuum.html) operation * */ vacuum?: SGDbOps_spec_vacuum; /** * Configuration of [`pg_repack`](https://github.com/reorg/pg_repack) command * */ repack?: SGDbOps_spec_repack; /** * Configuration of major version upgrade (see also [`pg_upgrade`](https://www.postgresql.org/docs/current/pgupgrade.html) command) * */ majorVersionUpgrade?: SGDbOps_spec_majorVersionUpgrade; /** * Configuration of restart * */ restart?: SGDbOps_spec_restart; /** * Configuration of minor version upgrade * */ minorVersionUpgrade?: SGDbOps_spec_minorVersionUpgrade; /** * Configuration of security upgrade * */ securityUpgrade?: SGDbOps_spec_securityUpgrade; } /** Pod custom node scheduling and affinity configuration */ interface SGDbOps_spec_scheduling { /** * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ * */ nodeSelector?: Record; /** * If specified, the pod's tolerations. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ tolerations?: SGDbOps_spec_scheduling_tolerations[]; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGDbOps_spec_scheduling_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGDbOps_spec_scheduling_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGDbOps_spec_scheduling_podAntiAffinity; } /** * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ interface SGDbOps_spec_scheduling_tolerations { /** * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. * * */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. * * */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGDbOps_spec_scheduling_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGDbOps_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGDbOps_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGDbOps_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGDbOps_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGDbOps_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGDbOps_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGDbOps_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGDbOps_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGDbOps_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGDbOps_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGDbOps_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGDbOps_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGDbOps_spec_scheduling_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGDbOps_spec_scheduling_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDbOps_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Configuration of the benchmark * */ interface SGDbOps_spec_benchmark { /** * The type of benchmark that will be performed on the SGCluster. Available benchmarks are: * * * `pgbench`: run [pgbench](https://www.postgresql.org/docs/current/pgbench.html) on the specified SGCluster and report the results in the status. * */ type: string; /** * Configuration of [pgbench](https://www.postgresql.org/docs/current/pgbench.html) benchmark * */ pgbench?: SGDbOps_spec_benchmark_pgbench; /** * Specify the service where the benchmark will connect to: * * * `primary-service`: Connect to the primary service * * `replicas-service`: Connect to the replicas service * */ connectionType?: string; } /** * Configuration of [pgbench](https://www.postgresql.org/docs/current/pgbench.html) benchmark * */ interface SGDbOps_spec_benchmark_pgbench { /** * Size of the database to generate. This size is specified either in Mebibytes, Gibibytes or Tebibytes (multiples of 2^20, 2^30 or 2^40, respectively). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi|Ti)$ */ databaseSize: string; /** * An ISO 8601 duration in the format `PnDTnHnMn.nS`, that specifies how long the benchmark will run. * */ duration: string; /** * Use extended query protocol with prepared statements. Defaults to: `false`. * */ usePreparedStatements?: boolean; /** * Number of clients simulated, that is, number of concurrent database sessions. Defaults to: `1`. * */ concurrentClients?: number; /** * Number of worker threads within pgbench. Using more than one thread can be helpful on multi-CPU machines. Clients are distributed as evenly as possible among available threads. Default is `1`. * */ threads?: number; } /** * Configuration of [vacuum](https://www.postgresql.org/docs/current/sql-vacuum.html) operation * */ interface SGDbOps_spec_vacuum { /** * If true selects "full" vacuum, which can reclaim more space, but takes much longer and exclusively locks the table. * This method also requires extra disk space, since it writes a new copy of the table and doesn't release the old copy * until the operation is complete. Usually this should only be used when a significant amount of space needs to be * reclaimed from within the table. Defaults to: `false`. * */ full?: boolean; /** * If true selects aggressive "freezing" of tuples. Specifying FREEZE is equivalent to performing VACUUM with the * vacuum_freeze_min_age and vacuum_freeze_table_age parameters set to zero. Aggressive freezing is always performed * when the table is rewritten, so this option is redundant when FULL is specified. Defaults to: `false`. * */ freeze?: boolean; /** * If true, updates statistics used by the planner to determine the most efficient way to execute a query. Defaults to: `true`. * */ analyze?: boolean; /** * Normally, VACUUM will skip pages based on the visibility map. Pages where all tuples are known to be frozen can always be * skipped, and those where all tuples are known to be visible to all transactions may be skipped except when performing an * aggressive vacuum. Furthermore, except when performing an aggressive vacuum, some pages may be skipped in order to avoid * waiting for other sessions to finish using them. This option disables all page-skipping behavior, and is intended to be * used only when the contents of the visibility map are suspect, which should happen only if there is a hardware or * software issue causing database corruption. Defaults to: `false`. * */ disablePageSkipping?: boolean; /** * List of databases to vacuum or repack, don't specify to select all databases * */ databases?: SGDbOps_spec_vacuum_databases[]; } /** */ interface SGDbOps_spec_vacuum_databases { /** the name of the database */ name: string; /** * If true selects "full" vacuum, which can reclaim more space, but takes much longer and exclusively locks the table. * This method also requires extra disk space, since it writes a new copy of the table and doesn't release the old copy * until the operation is complete. Usually this should only be used when a significant amount of space needs to be * reclaimed from within the table. Defaults to: `false`. * */ full?: boolean; /** * If true selects aggressive "freezing" of tuples. Specifying FREEZE is equivalent to performing VACUUM with the * vacuum_freeze_min_age and vacuum_freeze_table_age parameters set to zero. Aggressive freezing is always performed * when the table is rewritten, so this option is redundant when FULL is specified. Defaults to: `false`. * */ freeze?: boolean; /** * If true, updates statistics used by the planner to determine the most efficient way to execute a query. Defaults to: `true`. * */ analyze?: boolean; /** * Normally, VACUUM will skip pages based on the visibility map. Pages where all tuples are known to be frozen can always be * skipped, and those where all tuples are known to be visible to all transactions may be skipped except when performing an * aggressive vacuum. Furthermore, except when performing an aggressive vacuum, some pages may be skipped in order to avoid * waiting for other sessions to finish using them. This option disables all page-skipping behavior, and is intended to be * used only when the contents of the visibility map are suspect, which should happen only if there is a hardware or * software issue causing database corruption. Defaults to: `false`. * */ disablePageSkipping?: boolean; } /** * Configuration of [`pg_repack`](https://github.com/reorg/pg_repack) command * */ interface SGDbOps_spec_repack { /** * If true do vacuum full instead of cluster. Defaults to: `false`. * */ noOrder?: boolean; /** * If specified, an ISO 8601 duration format `PnDTnHnMn.nS` to set a timeout to cancel other backends on conflict. * */ waitTimeout?: string; /** * If true don't kill other backends when timed out. Defaults to: `false`. * */ noKillBackend?: boolean; /** * If true don't analyze at end. Defaults to: `false`. * */ noAnalyze?: boolean; /** * If true don't repack tables which belong to specific extension. Defaults to: `false`. * */ excludeExtension?: boolean; /** * List of database to vacuum or repack, don't specify to select all databases * */ databases?: SGDbOps_spec_repack_databases[]; } /** */ interface SGDbOps_spec_repack_databases { /** the name of the database */ name: string; /** * If true do vacuum full instead of cluster. Defaults to: `false`. * */ noOrder?: boolean; /** * If specified, an ISO 8601 duration format `PnDTnHnMn.nS` to set a timeout to cancel other backends on conflict. * */ waitTimeout?: string; /** * If true don't kill other backends when timed out. Defaults to: `false`. * */ noKillBackend?: boolean; /** * If true don't analyze at end. Defaults to: `false`. * */ noAnalyze?: boolean; /** * If true don't repack tables which belong to specific extension. Defaults to: `false`. * */ excludeExtension?: boolean; } /** * Configuration of major version upgrade (see also [`pg_upgrade`](https://www.postgresql.org/docs/current/pgupgrade.html) command) * */ interface SGDbOps_spec_majorVersionUpgrade { /** * The target postgres version that must have the same major version of the target SGCluster. * */ postgresVersion?: string; /** * The postgres config that must have the same major version of the target postgres version. * */ sgPostgresConfig?: string; /** * The path were the backup is stored. If not set this field is filled up by the operator. * * When provided will indicate were the backups and WAL files will be stored. * * The path should be different from the current `.spec.configurations.backupPath` value for the target `SGCluster` * in order to avoid mixing WAL files of two distinct major versions of postgres. * */ backupPath?: string; /** * If true use hard links instead of copying files to the new cluster. This option is mutually exclusive with `clone`. Defaults to: `false`. * */ link?: boolean; /** * If true use efficient file cloning (also known as "reflinks" on some systems) instead of copying files to the new cluster. * This can result in near-instantaneous copying of the data files, giving the speed advantages of `link` while leaving the old * cluster untouched. This option is mutually exclusive with `link`. Defaults to: `false`. * * File cloning is only supported on some operating systems and file systems. If it is selected but not supported, the pg_upgrade * run will error. At present, it is supported on Linux (kernel 4.5 or later) with Btrfs and XFS (on file systems created with * reflink support), and on macOS with APFS. * */ clone?: boolean; /** * If true does some checks to see if the cluster can perform a major version upgrade without changing any data. Defaults to: `false`. * */ check?: boolean; } /** * Configuration of restart * */ interface SGDbOps_spec_restart { /** * The method used to perform the restart operation. Available methods are: * * * `InPlace`: the in-place method does not require more resources than those that are available. * In case only an instance of the StackGres cluster is present this mean the service disruption will * last longer so we encourage use the reduced impact restart and especially for a production environment. * * `ReducedImpact`: this procedure is the same as the in-place method but require additional * resources in order to spawn a new updated replica that will be removed when the procedure completes. * */ method?: string; /** * By default all Pods are restarted. Setting this option to `true` allow to restart only those Pods which * are in pending restart state as detected by the operation. Defaults to: `false`. * */ onlyPendingRestart?: boolean; } /** * Configuration of minor version upgrade * */ interface SGDbOps_spec_minorVersionUpgrade { /** * The target postgres version that must have the same major version of the target SGCluster. * */ postgresVersion?: string; /** * The method used to perform the minor version upgrade operation. Available methods are: * * * `InPlace`: the in-place method does not require more resources than those that are available. * In case only an instance of the StackGres cluster is present this mean the service disruption will * last longer so we encourage use the reduced impact restart and especially for a production environment. * * `ReducedImpact`: this procedure is the same as the in-place method but require additional * resources in order to spawn a new updated replica that will be removed when the procedure completes. * */ method?: string; } /** * Configuration of security upgrade * */ interface SGDbOps_spec_securityUpgrade { /** * The method used to perform the security upgrade operation. Available methods are: * * * `InPlace`: the in-place method does not require more resources than those that are available. * In case only an instance of the StackGres cluster is present this mean the service disruption will * last longer so we encourage use the reduced impact restart and especially for a production environment. * * `ReducedImpact`: this procedure is the same as the in-place method but require additional * resources in order to spawn a new updated replica that will be removed when the procedure completes. * */ method?: string; } /** */ interface SGDbOps_status { /** * Possible conditions are: * * * Running: to indicate when the operation is actually running * * Completed: to indicate when the operation has completed successfully * * Failed: to indicate when the operation has failed * */ conditions?: SGDbOps_status_conditions[]; /** * The number of retries performed by the operation * */ opRetries?: number; /** * The ISO 8601 timestamp of when the operation started running * */ opStarted?: string; /** * The results of the benchmark * */ benchmark?: SGDbOps_status_benchmark; /** * The results of a major version upgrade * */ majorVersionUpgrade?: SGDbOps_status_majorVersionUpgrade; /** * The results of a restart * */ restart?: SGDbOps_status_restart; /** * The results of a minor version upgrade * */ minorVersionUpgrade?: SGDbOps_status_minorVersionUpgrade; /** * The results of a security upgrade * */ securityUpgrade?: SGDbOps_status_securityUpgrade; } /** */ interface SGDbOps_status_conditions { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: string; /** A human-readable message indicating details about the transition. */ message?: string; /** The reason for the condition last transition. */ reason?: string; /** Status of the condition, one of `True`, `False` or `Unknown`. */ status?: string; /** Type of deployment condition. */ type?: string; } /** * The results of the benchmark * */ interface SGDbOps_status_benchmark { /** * The results of the pgbench benchmark * */ pgbench?: SGDbOps_status_benchmark_pgbench; } /** * The results of the pgbench benchmark * */ interface SGDbOps_status_benchmark_pgbench { /** * The scale factor used to run pgbench (`--scale`). * * @nullable */ scaleFactor?: number; /** * The number of transactions processed. * * @nullable */ transactionsProcessed?: number; /** * The latency results of the pgbench benchmark * */ latency?: SGDbOps_status_benchmark_pgbench_latency; /** * All the transactions per second results of the pgbench benchmark * */ transactionsPerSecond?: SGDbOps_status_benchmark_pgbench_transactionsPerSecond; } /** * The latency results of the pgbench benchmark * */ interface SGDbOps_status_benchmark_pgbench_latency { /** * Average latency of transactions * */ average?: SGDbOps_status_benchmark_pgbench_latency_average; /** * The latency standard deviation of transactions. * */ standardDeviation?: SGDbOps_status_benchmark_pgbench_latency_standardDeviation; } /** * Average latency of transactions * */ interface SGDbOps_status_benchmark_pgbench_latency_average { /** * The latency average value * * @nullable */ value?: number; /** * The latency measure unit represented in milliseconds * */ unit?: string; } /** * The latency standard deviation of transactions. * */ interface SGDbOps_status_benchmark_pgbench_latency_standardDeviation { /** * The latency standard deviation value * * @nullable */ value?: number; /** * The latency measure unit represented in milliseconds * */ unit?: string; } /** * All the transactions per second results of the pgbench benchmark * */ interface SGDbOps_status_benchmark_pgbench_transactionsPerSecond { /** * Number of Transaction Per Second (tps) including connection establishing. * */ includingConnectionsEstablishing?: SGDbOps_status_benchmark_pgbench_transactionsPerSecond_includingConnectionsEstablishing; /** * Number of Transaction Per Second (tps) excluding connection establishing. * */ excludingConnectionsEstablishing?: SGDbOps_status_benchmark_pgbench_transactionsPerSecond_excludingConnectionsEstablishing; } /** * Number of Transaction Per Second (tps) including connection establishing. * */ interface SGDbOps_status_benchmark_pgbench_transactionsPerSecond_includingConnectionsEstablishing { /** * The Transaction Per Second (tps) including connections establishing value * * @nullable */ value?: number; /** * Transaction Per Second (tps) measure * */ unit?: string; } /** * Number of Transaction Per Second (tps) excluding connection establishing. * */ interface SGDbOps_status_benchmark_pgbench_transactionsPerSecond_excludingConnectionsEstablishing { /** * The Transaction Per Second (tps) excluding connections establishing value * * @nullable */ value?: number; /** * Transaction Per Second (tps) measure * */ unit?: string; } /** * The results of a major version upgrade * */ interface SGDbOps_status_majorVersionUpgrade { /** * The postgres version currently used by the primary instance * */ sourcePostgresVersion?: string; /** * The postgres version that the cluster will be upgraded to * */ targetPostgresVersion?: string; /** * The primary instance when the operation started * */ primaryInstance?: string; /** * The instances present when the operation started * */ initialInstances?: string[]; /** * The instances that are pending to be restarted * */ pendingToRestartInstances?: string[]; /** * The instances that have been restarted * */ restartedInstances?: string[]; /** * A failure message (when available) * */ failure?: string; } /** * The results of a restart * */ interface SGDbOps_status_restart { /** * The primary instance when the operation started * */ primaryInstance?: string; /** * The instances present when the operation started * */ initialInstances?: string[]; /** * The instances that are pending to be restarted * */ pendingToRestartInstances?: string[]; /** * The instances that have been restarted * */ restartedInstances?: string[]; /** * An ISO 8601 date indicating if and when the switchover initiated * */ switchoverInitiated?: string; /** * An ISO 8601 date indicating if and when the switchover finalized * */ switchoverFinalized?: string; /** * A failure message (when available) * */ failure?: string; } /** * The results of a minor version upgrade * */ interface SGDbOps_status_minorVersionUpgrade { /** * The postgres version currently used by the primary instance * */ sourcePostgresVersion?: string; /** * The postgres version that the cluster will be upgraded (or downgraded) to * */ targetPostgresVersion?: string; /** * The primary instance when the operation started * */ primaryInstance?: string; /** * The instances present when the operation started * */ initialInstances?: string[]; /** * The instances that are pending to be restarted * */ pendingToRestartInstances?: string[]; /** * The instances that have been restarted * */ restartedInstances?: string[]; /** * An ISO 8601 date indicating if and when the switchover initiated * */ switchoverInitiated?: string; /** * An ISO 8601 date indicating if and when the switchover finalized * */ switchoverFinalized?: string; /** * A failure message (when available) * */ failure?: string; } /** * The results of a security upgrade * */ interface SGDbOps_status_securityUpgrade { /** * The primary instance when the operation started * */ primaryInstance?: string; /** * The instances present when the operation started * */ initialInstances?: string[]; /** * The instances that are pending to be restarted * */ pendingToRestartInstances?: string[]; /** * The instances that have been restarted * */ restartedInstances?: string[]; /** * An ISO 8601 date indicating if and when the switchover initiated * */ switchoverInitiated?: string; /** * An ISO 8601 date indicating if and when the switchover finalized * */ switchoverFinalized?: string; /** * A failure message (when available) * */ failure?: string; } /** */ interface SGDistributedLogs { /** */ metadata: SGDistributedLogs_metadata; /** */ spec: SGDistributedLogs_spec; /** */ status?: SGDistributedLogs_status; } /** */ interface SGDistributedLogs_metadata { /** * Name of the Distributed Logs cluster. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * A Distributed Logs cluster may store logs for zero or more SGClusters. * * The name must be unique across all SGCluster, SGShardedCluster and SGDistributedLogs in the same namespace. * * @pattern ^[a-z]([-a-z0-9]*[a-z0-9])?$ */ name?: string; } /** */ interface SGDistributedLogs_spec { /** Pod's persistent volume configuration */ persistentVolume: SGDistributedLogs_spec_persistentVolume; /** * Kubernetes [services](https://kubernetes.io/docs/concepts/services-networking/service/) created or managed by StackGres. * @nullable */ postgresServices?: SGDistributedLogs_spec_postgresServices; /** Pod custom resources configuration. */ resources?: SGDistributedLogs_spec_resources; /** Pod custom scheduling and affinity configuration. */ scheduling?: SGDistributedLogs_spec_scheduling; /** * Name of the [SGInstanceProfile](https://stackgres.io/doc/latest/04-postgres-cluster-management/03-resource-profiles/). A SGInstanceProfile defines CPU and memory limits. Must exist before creating a distributed logs. When no profile is set, a default (currently: 1 core, 2 GiB RAM) one is used. * */ sgInstanceProfile?: string; /** * Cluster custom configurations. * */ configurations?: SGDistributedLogs_spec_configurations; /** Metadata information from cluster created resources. */ metadata?: SGDistributedLogs_spec_metadata; /** The list of Postgres extensions to install. */ toInstallPostgresExtensions?: SGDistributedLogs_spec_toInstallPostgresExtensions[]; /** */ nonProductionOptions?: SGDistributedLogs_spec_nonProductionOptions; } /** Pod's persistent volume configuration */ interface SGDistributedLogs_spec_persistentVolume { /** * Size of the PersistentVolume set for the pod of the cluster for distributed logs. This size is specified either in Mebibytes, Gibibytes or Tebibytes (multiples of 2^20, 2^30 or 2^40, respectively). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi|Ti)$ */ size?: string; /** * Name of an existing StorageClass in the Kubernetes cluster, used to create the PersistentVolumes for the instances of the cluster. * */ storageClass?: string; } /** * Kubernetes [services](https://kubernetes.io/docs/concepts/services-networking/service/) created or managed by StackGres. * @nullable */ interface SGDistributedLogs_spec_postgresServices { /** Configuration for the `-primary` service. It provides a stable connection (regardless of primary failures or switchovers) to the read-write Postgres server of the cluster. */ primary?: SGDistributedLogs_spec_postgresServices_primary; /** Configuration for the `-replicas` service. It provides a stable connection (regardless of replica node failures) to any read-only Postgres server of the cluster. Read-only servers are load-balanced via this service. */ replicas?: SGDistributedLogs_spec_postgresServices_replicas; } /** Configuration for the `-primary` service. It provides a stable connection (regardless of primary failures or switchovers) to the read-write Postgres server of the cluster. */ interface SGDistributedLogs_spec_postgresServices_primary { /** Specifies the type of Kubernetes service(`ClusterIP`, `LoadBalancer`, `NodePort`) */ type?: "ClusterIP" | "LoadBalancer" | "NodePort"; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-primary` service. */ annotations?: Record; /** Specify loadBalancer IP of Postgres primary service for Distributed Log */ loadBalancerIP?: string; } /** Configuration for the `-replicas` service. It provides a stable connection (regardless of replica node failures) to any read-only Postgres server of the cluster. Read-only servers are load-balanced via this service. */ interface SGDistributedLogs_spec_postgresServices_replicas { /** Specify if the `-replicas` service should be created or not. */ enabled?: boolean; /** Specifies the type of Kubernetes service(`ClusterIP`, `LoadBalancer`, `NodePort`). */ type?: "ClusterIP" | "LoadBalancer" | "NodePort"; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-replicas` service. */ annotations?: Record; /** Specify loadBalancer IP of Postgres replica service for Distributed Log */ loadBalancerIP?: string; } /** Pod custom resources configuration. */ interface SGDistributedLogs_spec_resources { /** When enabled resource limits for containers other than the patroni container wil be set just like for patroni contianer as specified in the SGInstanceProfile. */ enableClusterLimitsRequirements?: boolean; } /** Pod custom scheduling and affinity configuration. */ interface SGDistributedLogs_spec_scheduling { /** * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ * */ nodeSelector?: Record; /** * If specified, the pod's tolerations. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ tolerations?: SGDistributedLogs_spec_scheduling_tolerations[]; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGDistributedLogs_spec_scheduling_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGDistributedLogs_spec_scheduling_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGDistributedLogs_spec_scheduling_podAntiAffinity; } /** * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ interface SGDistributedLogs_spec_scheduling_tolerations { /** * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. * * */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. * * */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGDistributedLogs_spec_scheduling_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGDistributedLogs_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGDistributedLogs_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGDistributedLogs_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGDistributedLogs_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGDistributedLogs_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGDistributedLogs_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGDistributedLogs_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGDistributedLogs_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGDistributedLogs_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGDistributedLogs_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGDistributedLogs_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGDistributedLogs_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGDistributedLogs_spec_scheduling_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGDistributedLogs_spec_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Cluster custom configurations. * */ interface SGDistributedLogs_spec_configurations { /** * Name of the [SGPostgresConfig](https://stackgres.io/doc/latest/reference/crd/sgpgconfig) used for the distributed logs. It must exist. When not set, a default Postgres config, for the major version selected, is used. * */ sgPostgresConfig?: string; } /** Metadata information from cluster created resources. */ interface SGDistributedLogs_spec_metadata { /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ annotations?: SGDistributedLogs_spec_metadata_annotations; } /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ interface SGDistributedLogs_spec_metadata_annotations { /** Annotations to attach to any resource created or managed by StackGres. */ allResources?: Record; /** Annotations to attach to pods created or managed by StackGres. */ pods?: Record; /** Annotations to attach to services created or managed by StackGres. */ services?: Record; } /** */ interface SGDistributedLogs_spec_toInstallPostgresExtensions { /** The name of the extension to install. */ name: string; /** The id of the publisher of the extension to install. */ publisher: string; /** The version of the extension to install. */ version: string; /** The repository base URL from where the extension will be installed from. */ repository: string; /** The postgres major version of the extension to install. */ postgresVersion: string; /** The build version of the extension to install. */ build?: string; /** The extra mounts of the extension to install. */ extraMounts?: string[]; } /** */ interface SGDistributedLogs_spec_nonProductionOptions { /** * It is a best practice, on non-containerized environments, when running production workloads, to run each database server on a different server (virtual or physical), i.e., not to co-locate more than one database server per host. * * The same best practice applies to databases on containers. By default, StackGres will not allow to run more than one StackGres or Distributed Logs pod on a given Kubernetes node. If set to `true` it will allow more than one StackGres pod per node. * */ disableClusterPodAntiAffinity?: boolean; /** * It is a best practice, on containerized environments, when running production workloads, to enforce container's resources requirements. * * The same best practice applies to databases on containers. By default, StackGres will configure resource requirements for patroni container. Set this property to true to prevent StackGres from setting patroni container's resources requirement. * */ disablePatroniResourceRequirements?: boolean; /** * It is a best practice, on containerized environments, when running production workloads, to enforce container's resources requirements. * * By default, StackGres will configure resource requirements for all the containers. Set this property to true to prevent StackGres from setting container's resources requirements (except for patroni container, see `disablePatroniResourceRequirements`). * */ disableClusterResourceRequirements?: boolean; /** * On containerized environments, when running production workloads, enforcing container's cpu requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less cpu than it requires. It also allow to set [static CPU management policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) that allows to guarantee a pod the usage exclusive CPUs on the node. * * By default, StackGres will configure cpu requirements to have the same limit and request for the patroni container. Set this property to true to prevent StackGres from setting patroni container's cpu requirements request equals to the limit * when `.spec.requests.cpu` is configured in the referenced `SGInstanceProfile`. * */ enableSetPatroniCpuRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's cpu requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less cpu than it requires. It also allow to set [static CPU management policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) that allows to guarantee a pod the usage exclusive CPUs on the node. * * By default, StackGres will configure cpu requirements to have the same limit and request for all the containers. Set this property to true to prevent StackGres from setting container's cpu requirements request equals to the limit (except for patroni container, see `enablePatroniCpuRequests`) * when `.spec.requests.containers..cpu` `.spec.requests.initContainers..cpu` is configured in the referenced `SGInstanceProfile`. * */ enableSetClusterCpuRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's memory requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less memory than it requires. * * By default, StackGres will configure memory requirements to have the same limit and request for the patroni container. Set this property to true to prevent StackGres from setting patroni container's memory requirements request equals to the limit * when `.spec.requests.memory` is configured in the referenced `SGInstanceProfile`. * */ enableSetPatroniMemoryRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's memory requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less memory than it requires. * * By default, StackGres will configure memory requirements to have the same limit and request for all the containers. Set this property to true to prevent StackGres from setting container's memory requirements request equals to the limit (except for patroni container, see `enablePatroniCpuRequests`) * when `.spec.requests.containers..memory` `.spec.requests.initContainers..memory` is configured in the referenced `SGInstanceProfile`. * */ enableSetClusterMemoryRequests?: boolean; } /** */ interface SGDistributedLogs_status { /** */ conditions?: SGDistributedLogs_status_conditions[]; /** The list of pod statuses. */ podStatuses?: SGDistributedLogs_status_podStatuses[]; /** The list of database status */ databases?: SGDistributedLogs_status_databases[]; /** The list of connected `sgclusters` */ connectedClusters?: SGDistributedLogs_status_connectedClusters[]; /** The hash of the configuration file that is used by fluentd */ fluentdConfigHash?: string; /** The architecture on which the cluster has been initialized. */ arch?: string; /** The operative system on which the cluster has been initialized. */ os?: string; /** The custom prefix that is prepended to all labels. */ labelPrefix?: string; } /** */ interface SGDistributedLogs_status_conditions { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: string; /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status?: string; /** Type of deployment condition. */ type?: string; } /** */ interface SGDistributedLogs_status_podStatuses { /** The name of the pod. */ name: string; /** Indicates if the pod is the elected primary */ primary?: boolean; /** Indicates if the pod requires restart */ pendingRestart?: boolean; /** The list of extensions currently installed. */ installedPostgresExtensions?: SGDistributedLogs_status_podStatuses_installedPostgresExtensions[]; } /** */ interface SGDistributedLogs_status_podStatuses_installedPostgresExtensions { /** The name of the installed extension. */ name: string; /** The id of the publisher of the installed extension. */ publisher: string; /** The version of the installed extension. */ version: string; /** The repository base URL from where the extension was installed. */ repository: string; /** The postgres major version of the installed extension. */ postgresVersion: string; /** The build version of the installed extension. */ build?: string; } /** A database status */ interface SGDistributedLogs_status_databases { /** The database name that has been created */ name?: string; /** The retention window that has been applied to tables */ retention?: string; } /** A connected `sgcluster` */ interface SGDistributedLogs_status_connectedClusters { /** The `sgcluster` namespace */ namespace?: string; /** The `sgcluster` name */ name?: string; /** The configuration for `sgdistributedlgos` of this `sgcluster` */ config?: SGDistributedLogs_status_connectedClusters_config; } /** The configuration for `sgdistributedlgos` of this `sgcluster` */ interface SGDistributedLogs_status_connectedClusters_config { /** The `sgdistributedlogs` to which this `sgcluster` is connected to */ sgDistributedLogs?: string; /** The retention window that has been applied to tables */ retention?: string; } /** */ interface SGInstanceProfile { /** */ metadata: SGInstanceProfile_metadata; /** */ spec: SGInstanceProfile_spec; } /** */ interface SGInstanceProfile_metadata { /** * Name of the Instance Profile. An instance profile represents a "kind" of * server (CPU and RAM) where you may run StackGres Pods, classified by a given name. * The profile may be referenced by zero or more SGClusters, and if so it would * be referenced by its name. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all instance profiles in the same namespace. * */ name?: string; } /** */ interface SGInstanceProfile_spec { /** * CPU(s) (cores) used for every instance of a SGCluster. The suffix `m` * specifies millicpus (where 1000m is equals to 1). * * The number of cores set is assigned to the patroni container (that runs both Patroni and PostgreSQL). * * A minimum of 2 cores is recommended. * * @pattern ^[1-9][0-9]*[m]?$ */ cpu: string; /** * RAM allocated to every instance of a SGCluster. The suffix `Mi` or `Gi` * specifies Mebibytes or Gibibytes, respectively. * * The amount of RAM set is assigned to the patroni container (that runs both Patroni and PostgreSQL). * * A minimum of 2-4Gi is recommended. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ memory: string; /** * RAM allocated for huge pages * */ hugePages?: SGInstanceProfile_spec_hugePages; /** * The CPU(s) (cores) and RAM assigned to containers other than patroni container. * * This section, if left empty, will be filled automatically by the operator with * some defaults that can be proportional to the resources assigned to patroni * container (except for the huge pages that are always left empty). * */ containers?: Record; /** The CPU(s) (cores) and RAM assigned to init containers. */ initContainers?: Record; /** * On containerized environments, when running production workloads, enforcing container's resources requirements request to be equals to the limits allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less resources than it requires. It also allow to set [static CPU management policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) that allows to guarantee a pod the usage exclusive CPUs on the node. * * There are cases where you may need to set resource requirement request to a different value than limit. This section allow to do so but requires to enable such feature in the `SGCluster` and `SGDistributedLogs` (see `.spec.nonProductionOptions` section for each of those custom resources). * */ requests?: SGInstanceProfile_spec_requests; } /** * RAM allocated for huge pages * */ interface SGInstanceProfile_spec_hugePages { /** * RAM allocated for huge pages with a size of 2Mi. The suffix `Mi` or `Gi` * specifies Mebibytes or Gibibytes, respectively. * * By default the amount of RAM set is assigned to patroni container * (that runs both Patroni and PostgreSQL). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ "hugepages-2Mi"?: string; /** * RAM allocated for huge pages with a size of 1Gi. The suffix `Mi` or `Gi` * specifies Mebibytes or Gibibytes, respectively. * * By default the amount of RAM set is assigned to patroni container * (that runs both Patroni and PostgreSQL). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ "hugepages-1Gi"?: string; } /** */ interface SGInstanceProfile_spec_containers { /** * CPU(s) (cores) used for the specified Pod container. The suffix `m` * specifies millicpus (where 1000m is equals to 1). * * @pattern ^[1-9][0-9]*[m]?$ */ cpu: string; /** * RAM allocated to the specified Pod container. The suffix `Mi` or `Gi` * specifies Mebibytes or Gibibytes, respectively. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ memory: string; /** * RAM allocated for huge pages * */ hugePages?: SGInstanceProfile_spec_containers_hugePages; } /** * RAM allocated for huge pages * */ interface SGInstanceProfile_spec_containers_hugePages { /** * RAM allocated for huge pages with a size of 2Mi. The suffix `Mi` * or `Gi` specifies Mebibytes or Gibibytes, respectively. * * The amount of RAM is assigned to the specified container. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ "hugepages-2Mi"?: string; /** * RAM allocated for huge pages with a size of 1Gi. The suffix `Mi` * or `Gi` specifies Mebibytes or Gibibytes, respectively. * * The amount of RAM is assigned to the specified container. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ "hugepages-1Gi"?: string; } /** */ interface SGInstanceProfile_spec_initContainers { /** * CPU(s) (cores) used for the specified Pod init container. The suffix * `m` specifies millicpus (where 1000m is equals to 1). * * @pattern ^[1-9][0-9]*[m]?$ */ cpu: string; /** * RAM allocated to the specified Pod init container. The suffix `Mi` * or `Gi` specifies Mebibytes or Gibibytes, respectively. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ memory: string; /** * RAM allocated for huge pages * */ hugePages?: SGInstanceProfile_spec_initContainers_hugePages; } /** * RAM allocated for huge pages * */ interface SGInstanceProfile_spec_initContainers_hugePages { /** * RAM allocated for huge pages with a size of 2Mi. The suffix `Mi` * or `Gi` specifies Mebibytes or Gibibytes, respectively. * * The amount of RAM is assigned to the specified init container. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ "hugepages-2Mi"?: string; /** * RAM allocated for huge pages with a size of 1Gi. The suffix `Mi` or `Gi` * specifies Mebibytes or Gibibytes, respectively. * * The amount of RAM is assigned to the specified init container. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ "hugepages-1Gi"?: string; } /** * On containerized environments, when running production workloads, enforcing container's resources requirements request to be equals to the limits allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less resources than it requires. It also allow to set [static CPU management policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) that allows to guarantee a pod the usage exclusive CPUs on the node. * * There are cases where you may need to set resource requirement request to a different value than limit. This section allow to do so but requires to enable such feature in the `SGCluster` and `SGDistributedLogs` (see `.spec.nonProductionOptions` section for each of those custom resources). * */ interface SGInstanceProfile_spec_requests { /** * CPU(s) (cores) used for every instance of a SGCluster. The suffix `m` * specifies millicpus (where 1000m is equals to 1). * * The number of cores set is assigned to the patroni container (that runs both Patroni and PostgreSQL). * * @pattern ^[1-9][0-9]*[m]?$ */ cpu?: string; /** * RAM allocated to every instance of a SGCluster. The suffix `Mi` or `Gi` * specifies Mebibytes or Gibibytes, respectively. * * The amount of RAM set is assigned to the patroni container (that runs both Patroni and PostgreSQL). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ memory?: string; /** * The CPU(s) (cores) and RAM assigned to containers other than patroni container. * */ containers?: Record; /** The CPU(s) (cores) and RAM assigned to init containers. */ initContainers?: Record; } /** */ interface SGInstanceProfile_spec_requests_containers { /** * CPU(s) (cores) used for the specified Pod container. The suffix `m` * specifies millicpus (where 1000m is equals to 1). * * @pattern ^[1-9][0-9]*[m]?$ */ cpu?: string; /** * RAM allocated to the specified Pod container. The suffix `Mi` or `Gi` * specifies Mebibytes or Gibibytes, respectively. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ memory?: string; } /** */ interface SGInstanceProfile_spec_requests_initContainers { /** * CPU(s) (cores) used for the specified Pod init container. The suffix * `m` specifies millicpus (where 1000m is equals to 1). * * @pattern ^[1-9][0-9]*[m]?$ */ cpu?: string; /** * RAM allocated to the specified Pod init container. The suffix `Mi` * or `Gi` specifies Mebibytes or Gibibytes, respectively. * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi)$ */ memory?: string; } /** */ interface SGPoolingConfig { /** */ metadata: SGPoolingConfig_metadata; /** */ spec: SGPoolingConfig_spec; /** */ status?: SGPoolingConfig_status; } /** */ interface SGPoolingConfig_metadata { /** * Name of the Connection Pooling Configuration. The configuration may be referenced by zero or more SGClusters, and if so it would be referenced by its name. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all Connection Pooling configurations in the same namespace. * */ name?: string; } /** */ interface SGPoolingConfig_spec { /** * Connection pooling configuration based on PgBouncer. * */ pgBouncer?: SGPoolingConfig_spec_pgBouncer; } /** * Connection pooling configuration based on PgBouncer. * */ interface SGPoolingConfig_spec_pgBouncer { /** * The `pgbouncer.ini` parameters the configuration contains, represented as an object where the keys are valid names for the `pgbouncer.ini` configuration file parameters. * * Check [pgbouncer configuration](https://www.pgbouncer.org/config.html#generic-settings) for more information about supported parameters. * */ "pgbouncer.ini"?: SGPoolingConfig_spec_pgBouncer_pgbouncer_ini; } /** * The `pgbouncer.ini` parameters the configuration contains, represented as an object where the keys are valid names for the `pgbouncer.ini` configuration file parameters. * * Check [pgbouncer configuration](https://www.pgbouncer.org/config.html#generic-settings) for more information about supported parameters. * */ interface SGPoolingConfig_spec_pgBouncer_pgbouncer_ini { /** * The `pgbouncer.ini` (Section [pgbouncer]) parameters the configuration contains, represented as an object where the keys are valid names for the `pgbouncer.ini` configuration file parameters. * * Check [pgbouncer configuration](https://www.pgbouncer.org/config.html#generic-settings) for more information about supported parameters * */ pgbouncer?: object; /** * The `pgbouncer.ini` (Section [databases]) parameters the configuration contains, represented as an object where the keys are valid names for the `pgbouncer.ini` configuration file parameters. * * Check [pgbouncer configuration](https://www.pgbouncer.org/config.html#section-databases) for more information about supported parameters. * */ databases?: Record; /** * The `pgbouncer.ini` (Section [users]) parameters the configuration contains, represented as an object where the keys are valid names for the `pgbouncer.ini` configuration file parameters. * * Check [pgbouncer configuration](https://www.pgbouncer.org/config.html#section-users) for more information about supported parameters. * */ users?: Record; } /** */ interface SGPoolingConfig_spec_pgBouncer_pgbouncer_ini_databases { } /** */ interface SGPoolingConfig_spec_pgBouncer_pgbouncer_ini_users { } /** */ interface SGPoolingConfig_status { /** * Connection pooling configuration status based on PgBouncer. * */ pgBouncer?: SGPoolingConfig_status_pgBouncer; } /** * Connection pooling configuration status based on PgBouncer. * */ interface SGPoolingConfig_status_pgBouncer { /** * The `pgbouncer.ini` default parameters parameters which are used if not set. * */ defaultParameters: Record; } /** */ interface SGPostgresConfig { /** */ metadata: SGPostgresConfig_metadata; /** */ spec: SGPostgresConfig_spec; /** */ status?: SGPostgresConfig_status; } /** */ interface SGPostgresConfig_metadata { /** * Name of the Postgres Configuration. The configuration may be referenced by zero or more SGClusters, and if so it would be referenced by its name. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all Postgres configurations in the same namespace. * */ name?: string; } /** */ interface SGPostgresConfig_spec { /** * The **major** Postgres version the configuration is for. Postgres major versions contain one number starting with version 10 (`10`, `11`, `12`, etc), and two numbers separated by a dot for previous versions (`9.6`, `9.5`, etc). * * Note that Postgres maintains full compatibility across minor versions, and hence a configuration for a given major version will work for any minor version of that same major version. * * Check [StackGres component versions](https://stackgres.io/doc/latest/intro/versions) to see the Postgres versions supported by this version of StackGres. * */ postgresVersion: string; /** * The `postgresql.conf` parameters the configuration contains, represented as an object where the keys are valid names for the `postgresql.conf` configuration file parameters of the given `postgresVersion`. You may check [postgresqlco.nf](https://postgresqlco.nf) as a reference on how to tune and find the valid parameters for a given major version. * */ "postgresql.conf": Record; } /** */ interface SGPostgresConfig_status { /** * The `postgresql.conf` default parameters which are used if not set. * */ defaultParameters: Record; } /** */ interface SGScript { /** */ metadata: SGScript_metadata; /** */ spec: SGScript_spec; /** */ status?: SGScript_status; } /** */ interface SGScript_metadata { /** * Name of the StackGres script. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all StackGres scripts in the same namespace. The full script name includes the namespace in which the script is created. * * @pattern ^[a-z]([-a-z0-9]*[a-z0-9])?$ */ name?: string; } /** */ interface SGScript_spec { /** * If `true` the versions will be managed by the operator automatically. The user will still be able to update them if needed. `true` by default. * */ managedVersions?: boolean; /** * If `true`, when any script entry fail will not prevent subsequent script entries from being executed. `false` by default. * */ continueOnError?: boolean; /** * A list of SQL scripts. * */ scripts?: SGScript_spec_scripts[]; } /** * Scripts are executed in auto-commit mode with the user `postgres` in the specified database (or in database `postgres` if not specified). * * Fields `script` and `scriptFrom` are mutually exclusive and only one of them is required. * */ interface SGScript_spec_scripts { /** * Name of the script. Must be unique across this SGScript. * */ name?: string; /** * The id is immutable and must be unique across all the script entries. It is replaced by the operator and is used to identify the script for the whole life of the `SGScript` object. * */ id?: number; /** * Version of the script. It will allow to identify if this script entry has been changed. * */ version?: number; /** * Database where the script is executed. Defaults to the `postgres` database, if not specified. * */ database?: string; /** * User that will execute the script. Defaults to the `postgres` user. * */ user?: string; /** * Wrap the script in a transaction using the specified transaction mode: * * * `read-committed`: The script will be wrapped in a transaction using [READ COMMITTED](https://www.postgresql.org/docs/current/transaction-iso.html#XACT-READ-COMMITTED) isolation level. * * `repeatable-read`: The script will be wrapped in a transaction using [REPEATABLE READ](https://www.postgresql.org/docs/current/transaction-iso.html#XACT-REPEATABLE-READ) isolation level. * * `serializable`: The script will be wrapped in a transaction using [SERIALIZABLE](https://www.postgresql.org/docs/current/transaction-iso.html#XACT-SERIALIZABLE) isolation level. * * If not set the script entry will not be wrapped in a transaction * */ wrapInTransaction?: string; /** * When set to `true` the script entry execution will include storing the status of the execution of this * script entry in the table `managed_sql.status` that will be created in the specified `database`. This * will avoid an operation that fails partially to be unrecoverable requiring the intervention from the user * if user in conjunction with `retryOnError`. * * If set to `true` then `wrapInTransaction` field must be set. * * This is `false` by default. * */ storeStatusInDatabase?: boolean; /** * If not set or set to `false` the script entry will not be retried if it fails. * * When set to `true` the script execution will be retried with an exponential backoff of 5 minutes, * starting from 10 seconds and a standard deviation of 10 seconds. * * This is `false` by default. * */ retryOnError?: boolean; /** * Raw SQL script to execute. This field is mutually exclusive with `scriptFrom` field. * */ script?: string; /** * Reference to either a Kubernetes [Secret](https://kubernetes.io/docs/concepts/configuration/secret/) or a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) that contains the SQL script to execute. This field is mutually exclusive with `script` field. * * Fields `secretKeyRef` and `configMapKeyRef` are mutually exclusive, and one of them is required. * */ scriptFrom?: SGScript_spec_scripts_scriptFrom; } /** * Reference to either a Kubernetes [Secret](https://kubernetes.io/docs/concepts/configuration/secret/) or a [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) that contains the SQL script to execute. This field is mutually exclusive with `script` field. * * Fields `secretKeyRef` and `configMapKeyRef` are mutually exclusive, and one of them is required. * */ interface SGScript_spec_scripts_scriptFrom { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the SQL script to execute. This field is mutually exclusive with `configMapKeyRef` field. * */ secretKeyRef?: SGScript_spec_scripts_scriptFrom_secretKeyRef; /** * A [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) reference that contains the SQL script to execute. This field is mutually exclusive with `secretKeyRef` field. * */ configMapKeyRef?: SGScript_spec_scripts_scriptFrom_configMapKeyRef; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the SQL script to execute. This field is mutually exclusive with `configMapKeyRef` field. * */ interface SGScript_spec_scripts_scriptFrom_secretKeyRef { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name?: string; /** The key of the secret to select from. Must be a valid secret key. */ key?: string; } /** * A [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) reference that contains the SQL script to execute. This field is mutually exclusive with `secretKeyRef` field. * */ interface SGScript_spec_scripts_scriptFrom_configMapKeyRef { /** * The name of the ConfigMap that contains the SQL script to execute. * */ name?: string; /** * The key name within the ConfigMap that contains the SQL script to execute. * */ key?: string; } /** */ interface SGScript_status { /** * A list of script entry statuses where a script entry under `.spec.scripts` is identified by the `id` field. * */ scripts?: SGScript_status_scripts[]; } /** */ interface SGScript_status_scripts { /** * The id that identifies a script entry. * */ id?: number; /** * The hash of a ConfigMap or Secret referenced with the associated script entry. * */ hash?: string; } } export declare namespace io.stackgres.v1beta1 { /** * A manual or automatically generated backup of a SGCluster. * */ interface SGBackup { /** */ metadata: SGBackup_metadata; /** */ spec: SGBackup_spec; /** */ status?: SGBackup_status; } /** */ interface SGBackup_metadata { /** * Name of the backup. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all StackGres backups in the same namespace." * */ name?: string; } /** */ interface SGBackup_spec { /** * Indicate if this backup is permanent and should not be removed by the automated retention policy. * */ managedLifecycle?: boolean; /** * The name of the `SGCluster` from which this backup is/will be taken. * */ sgCluster?: string; } /** */ interface SGBackup_status { /** */ backupInformation?: SGBackup_status_backupInformation; /** * The name of the backup. * */ internalName?: string; /** */ process?: SGBackup_status_process; /** The name of the backup configuration used to perform this backup. */ sgBackupConfig?: SGBackup_status_sgBackupConfig; } /** */ interface SGBackup_status_backupInformation { /** * An object containing data from the output of pg_controldata on the backup. * */ controlData?: object; /** * Hostname of the instance where the backup is taken from. * */ hostname?: string; /** */ lsn?: SGBackup_status_backupInformation_lsn; /** * Data directory where the backup is taken from. * */ pgData?: string; /** * Postgres version of the server where the backup is taken from. * */ postgresVersion?: string; /** */ size?: SGBackup_status_backupInformation_size; /** * Pod where the backup is taken from. * */ sourcePod?: string; /** * WAL segment file name when the backup was started. * */ startWalFile?: string; /** * Postgres *system identifier* of the cluster this backup is taken from. * */ systemIdentifier?: string; /** * Backup timeline. * */ timeline?: string; } /** */ interface SGBackup_status_backupInformation_lsn { /** * LSN of when the backup finished. * */ end?: string; /** * LSN of when the backup started. * */ start?: string; } /** */ interface SGBackup_status_backupInformation_size { /** * Size (in bytes) of the compressed backup. * * @format int64 */ compressed?: number; /** * Size (in bytes) of the uncompressed backup. * * @format int64 */ uncompressed?: number; } /** */ interface SGBackup_status_process { /** * If the status is `failed` this field will contain a message indicating the failure reason. * */ failure?: string; /** * Name of the pod assigned to the backup. StackGres utilizes internally a locking mechanism based on the pod name of the job that creates the backup. * */ jobPod?: string; /** * Status (may be transient) until converging to `spec.managedLifecycle`. * */ managedLifecycle?: boolean; /** * Status of the backup. * */ status?: "Running" | "Completed" | "Failed"; /** */ timing?: SGBackup_status_process_timing; } /** */ interface SGBackup_status_process_timing { /** * End time of backup. * */ end?: string; /** * Start time of backup. * */ start?: string; /** * Time at which the backup is safely stored in the object storage. * */ stored?: string; } /** The name of the backup configuration used to perform this backup. */ interface SGBackup_status_sgBackupConfig { /** * Back backups configuration. * */ baseBackups?: SGBackup_status_sgBackupConfig_baseBackups; /** * Select the backup compression algorithm. Possible options are: lz4, lzma, brotli. The default method is `lz4`. LZ4 is the fastest method, but compression ratio is the worst. LZMA is way slower, but it compresses backups about 6 times better than LZ4. Brotli is a good trade-off between speed and compression ratio, being about 3 times better than LZ4. * */ compression?: "lz4" | "lzma" | "brotli"; /** * Backup storage configuration. * */ storage: SGBackup_status_sgBackupConfig_storage; } /** * Back backups configuration. * */ interface SGBackup_status_sgBackupConfig_baseBackups { /** * Continuous Archiving backups are composed of periodic *base backups* and all the WAL segments produced in between those base backups. This parameter specifies at what time and with what frequency to start performing a new base backup. * * Use cron syntax (`m h dom mon dow`) for this parameter, i.e., 5 values separated by spaces: * * `m`: minute, 0 to 59 * * `h`: hour, 0 to 23 * * `dom`: day of month, 1 to 31 (recommended not to set it higher than 28) * * `mon`: month, 1 to 12 * * `dow`: day of week, 0 to 7 (0 and 7 both represent Sunday) * * Also ranges of values (`start-end`), the symbol `*` (meaning `first-last`) or even `*\//N`, where `N` is a number, meaning every `N`, may be used. All times are UTC. It is recommended to avoid 00:00 as base backup time, to avoid overlapping with any other external operations happening at this time. * * If not provided, full backups will be performed each day at 05:00 UTC * */ cronSchedule?: string; /** * Based on this parameter, an automatic retention policy is defined to delete old base backups. * This parameter specifies the number of base backups to keep, in a sliding window. * Consequently, the time range covered by backups is `periodicity*retention`, where `periodicity` is the separation between backups as specified by the `cronSchedule` property. * * Default is 5. * */ retention?: number; /** * Select the backup compression algorithm. Possible options are: lz4, lzma, brotli. The default method is `lz4`. LZ4 is the fastest method, but compression ratio is the worst. LZMA is way slower, but it compresses backups about 6 times better than LZ4. Brotli is a good trade-off between speed and compression ratio, being about 3 times better than LZ4. * */ compression?: "lz4" | "lzma" | "brotli"; /** */ performance?: SGBackup_status_sgBackupConfig_baseBackups_performance; } /** */ interface SGBackup_status_sgBackupConfig_baseBackups_performance { /** * Maximum storage upload bandwidth to be used when storing the backup. In bytes (per second). * */ maxNetworkBandwitdh?: number; /** * Maximum disk read I/O when performing a backup. In bytes (per second). * */ maxDiskBandwitdh?: number; /** * Backup storage may use several concurrent streams to store the data. This parameter configures the number of parallel streams to use. By default, it will use 1 (one stream). * */ uploadDiskConcurrency?: number; } /** * Backup storage configuration. * */ interface SGBackup_status_sgBackupConfig_storage { /** * Azure Blob Storage configuration. * */ azureBlob?: SGBackup_status_sgBackupConfig_storage_azureBlob; /** * Google Cloud Storage configuration. * */ gcs?: SGBackup_status_sgBackupConfig_storage_gcs; /** * Amazon Web Services S3 configuration. * */ s3?: SGBackup_status_sgBackupConfig_storage_s3; /** AWS S3-Compatible API configuration */ s3Compatible?: SGBackup_status_sgBackupConfig_storage_s3Compatible; /** * Specifies the type of object storage used for storing the base backups and WAL segments. * Possible values: * * `s3`: Amazon Web Services S3 (Simple Storage Service). * * `s3Compatible`: non-AWS services that implement a compatibility API with AWS S3. * * `gcs`: Google Cloud Storage. * * `azureBlob`: Microsoft Azure Blob Storage. * */ type: "s3" | "s3Compatible" | "gcs" | "azureBlob"; } /** * Azure Blob Storage configuration. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob { /** * The credentials to access Azure Blob Storage for writing and reading. * */ azureCredentials: SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials; /** * Azure Blob Storage bucket name. * * @pattern ^[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the Azure Blobk bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; } /** * The credentials to access Azure Blob Storage for writing and reading. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)s to reference the Secrets that contain the information about the `azureCredentials`. * */ secretKeySelectors?: SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)s to reference the Secrets that contain the information about the `azureCredentials`. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors { /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the primary or secondary access key for the storage account. * */ accessKey: SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors_accessKey; /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the name of the storage account. * */ storageAccount: SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors_storageAccount; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the primary or secondary access key for the storage account. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors_accessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the name of the storage account. * */ interface SGBackup_status_sgBackupConfig_storage_azureBlob_azureCredentials_secretKeySelectors_storageAccount { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * Google Cloud Storage configuration. * */ interface SGBackup_status_sgBackupConfig_storage_gcs { /** * GCS bucket name. * * @pattern ^[^/]+(/[^/]*)*$ */ bucket: string; /** * Credentials to access GCS for writing and reading. * */ gcpCredentials: SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials; /** * Optional path within the GCS bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; } /** * Credentials to access GCS for writing and reading. * */ interface SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials { /** * If true, the credentials will be fetched from the GCE/GKE metadata service and the credentials from `secretKeySelectors` field will not be used. * * This is useful when running StackGres inside a GKE cluster using [Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity). * */ fetchCredentialsFromMetadataService?: boolean; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the Service Account to access GCS. * */ secretKeySelectors?: SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials_secretKeySelectors; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the Service Account to access GCS. * */ interface SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials_secretKeySelectors { /** * A service account key from GCP. In JSON format, as downloaded from the GCP Console. * */ serviceAccountJSON: SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials_secretKeySelectors_serviceAccountJSON; } /** * A service account key from GCP. In JSON format, as downloaded from the GCP Console. * */ interface SGBackup_status_sgBackupConfig_storage_gcs_gcpCredentials_secretKeySelectors_serviceAccountJSON { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * Amazon Web Services S3 configuration. * */ interface SGBackup_status_sgBackupConfig_storage_s3 { /** * Credentials to access AWS S3 for writing and reading. * */ awsCredentials: SGBackup_status_sgBackupConfig_storage_s3_awsCredentials; /** * AWS S3 bucket name. * * @pattern ^[^/]+(/[^/]*)*$ */ bucket: string; /** * Optional path within the S3 bucket. Note that StackGres generates in any case a folder per * StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * AWS S3 region. The Region may be detected using s3:GetBucketLocation, but to avoid giving permissions to this API call or forbid it from the applicable IAM policy, this property must be explicitely specified. * */ region?: string; /** * [Amazon S3 Storage Class](https://aws.amazon.com/s3/storage-classes/) used for the backup object storage. By default, the `STANDARD` storage class is used. Other supported values include `STANDARD_IA` for Infrequent Access and `REDUCED_REDUNDANCY`. * */ storageClass?: string; } /** * Credentials to access AWS S3 for writing and reading. * */ interface SGBackup_status_sgBackupConfig_storage_s3_awsCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)s to reference the Secrets that contain the information about the `awsCredentials`. * */ secretKeySelectors: SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)s to reference the Secrets that contain the information about the `awsCredentials`. * */ interface SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors { /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Access Key ID secret. * */ accessKeyId: SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors_accessKeyId; /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Secret Access Key secret. * */ secretAccessKey: SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors_secretAccessKey; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Access Key ID secret. * */ interface SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors_accessKeyId { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Secret Access Key secret. * */ interface SGBackup_status_sgBackupConfig_storage_s3_awsCredentials_secretKeySelectors_secretAccessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** AWS S3-Compatible API configuration */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible { /** * Credentials to access AWS S3 for writing and reading. * */ awsCredentials: SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials; /** * Bucket name. * * @pattern ^[^/]+(/[^/]*)*$ */ bucket: string; /** * Enable path-style addressing (i.e. `http://s3.amazonaws.com/BUCKET/KEY`) when connecting to an S3-compatible service that lacks support for sub-domain style bucket URLs (i.e. `http://BUCKET.s3.amazonaws.com/KEY`). Defaults to false. * */ enablePathStyleAddressing?: boolean; /** * Overrides the default url to connect to an S3-compatible service. * For example: `http://s3-like-service:9000`. * */ endpoint?: string; /** * Optional path within the S3 bucket. Note that StackGres generates in any case a folder per StackGres cluster, using the `SGCluster.metadata.name`. * * @pattern ^(/[^/]*)*$ */ path?: string; /** * AWS S3 region. The Region may be detected using s3:GetBucketLocation, but to avoid giving permissions to this API call or forbid it from the applicable IAM policy, this property must be explicitely specified. * */ region?: string; /** * [Amazon S3 Storage Class](https://aws.amazon.com/s3/storage-classes/) used for the backup object storage. By default, the `STANDARD` storage class is used. Other supported values include `STANDARD_IA` for Infrequent Access and `REDUCED_REDUNDANCY`. * */ storageClass?: string; } /** * Credentials to access AWS S3 for writing and reading. * */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the `awsCredentials`. * */ secretKeySelectors: SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the `awsCredentials`. * */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors { /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Access Key ID secret. * */ accessKeyId: SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors_accessKeyId; /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Secret Access Key secret. * */ secretAccessKey: SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors_secretAccessKey; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Access Key ID secret. * */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors_accessKeyId { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) containing the AWS Secret Access Key secret. * */ interface SGBackup_status_sgBackupConfig_storage_s3Compatible_awsCredentials_secretKeySelectors_secretAccessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** */ interface SGObjectStorage { /** */ metadata: SGObjectStorage_metadata; /** * Object Storage configuration * */ spec: SGObjectStorage_spec; } /** */ interface SGObjectStorage_metadata { /** * Name of the Object Storage configuration. * The name must be unique across all object storage configurations in the same namespace. * */ name?: string; } /** * Object Storage configuration * */ interface SGObjectStorage_spec { /** * Determine the type of object storage used for storing the base backups and WAL segments. * Possible values: * * `s3`: Amazon Web Services S3 (Simple Storage Service). * * `s3Compatible`: non-AWS services that implement a compatibility API with AWS S3. * * `gcs`: Google Cloud Storage. * * `azureBlob`: Microsoft Azure Blob Storage. * */ type: "s3" | "s3Compatible" | "gcs" | "azureBlob"; /** * Amazon Web Services S3 configuration. * */ s3?: SGObjectStorage_spec_s3; /** AWS S3-Compatible API configuration */ s3Compatible?: SGObjectStorage_spec_s3Compatible; /** * Google Cloud Storage configuration. * */ gcs?: SGObjectStorage_spec_gcs; /** * Azure Blob Storage configuration. * */ azureBlob?: SGObjectStorage_spec_azureBlob; } /** * Amazon Web Services S3 configuration. * */ interface SGObjectStorage_spec_s3 { /** * AWS S3 bucket name. * * @pattern ^((s3|https?)://)?[^/]+(/[^/]*)*$ */ bucket: string; /** * The AWS S3 region. The Region may be detected using s3:GetBucketLocation, but if you wish to avoid giving permissions to this API call or forbid it from the applicable IAM policy, you must then specify this property. * */ region?: string; /** * The [Amazon S3 Storage Class](https://aws.amazon.com/s3/storage-classes/) to use for the backup object storage. By default, the `STANDARD` storage class is used. Other supported values include `STANDARD_IA` for Infrequent Access and `REDUCED_REDUNDANCY`. * */ storageClass?: string; /** * The credentials to access AWS S3 for writing and reading. * */ awsCredentials: SGObjectStorage_spec_s3_awsCredentials; } /** * The credentials to access AWS S3 for writing and reading. * */ interface SGObjectStorage_spec_s3_awsCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secrets that contain the information about the `awsCredentials`. Note that you may use the same or different Secrets for the `accessKeyId` and the `secretAccessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ secretKeySelectors: SGObjectStorage_spec_s3_awsCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secrets that contain the information about the `awsCredentials`. Note that you may use the same or different Secrets for the `accessKeyId` and the `secretAccessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ interface SGObjectStorage_spec_s3_awsCredentials_secretKeySelectors { /** * AWS [access key ID](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `AKIAIOSFODNN7EXAMPLE`. * */ accessKeyId: SGObjectStorage_spec_s3_awsCredentials_secretKeySelectors_accessKeyId; /** * AWS [secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`. * */ secretAccessKey: SGObjectStorage_spec_s3_awsCredentials_secretKeySelectors_secretAccessKey; } /** * AWS [access key ID](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `AKIAIOSFODNN7EXAMPLE`. * */ interface SGObjectStorage_spec_s3_awsCredentials_secretKeySelectors_accessKeyId { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * AWS [secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`. * */ interface SGObjectStorage_spec_s3_awsCredentials_secretKeySelectors_secretAccessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** AWS S3-Compatible API configuration */ interface SGObjectStorage_spec_s3Compatible { /** * Bucket name. * * @pattern ^((s3|https?)://)?[^/]+(/[^/]*)*$ */ bucket: string; /** * Enable path-style addressing (i.e. `http://s3.amazonaws.com/BUCKET/KEY`) when connecting to an S3-compatible service that lacks support for sub-domain style bucket URLs (i.e. `http://BUCKET.s3.amazonaws.com/KEY`). * * Defaults to false. * */ enablePathStyleAddressing?: boolean; /** * Overrides the default url to connect to an S3-compatible service. * For example: `http://s3-like-service:9000`. * */ endpoint?: string; /** * The AWS S3 region. The Region may be detected using s3:GetBucketLocation, but if you wish to avoid giving permissions to this API call or forbid it from the applicable IAM policy, you must then specify this property. * */ region?: string; /** * The [Amazon S3 Storage Class](https://aws.amazon.com/s3/storage-classes/) to use for the backup object storage. By default, the `STANDARD` storage class is used. Other supported values include `STANDARD_IA` for Infrequent Access and `REDUCED_REDUNDANCY`. * */ storageClass?: string; /** * The credentials to access AWS S3 for writing and reading. * */ awsCredentials: SGObjectStorage_spec_s3Compatible_awsCredentials; } /** * The credentials to access AWS S3 for writing and reading. * */ interface SGObjectStorage_spec_s3Compatible_awsCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secret(s) that contain the information about the `awsCredentials`. Note that you may use the same or different Secrets for the `accessKeyId` and the `secretAccessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ secretKeySelectors: SGObjectStorage_spec_s3Compatible_awsCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secret(s) that contain the information about the `awsCredentials`. Note that you may use the same or different Secrets for the `accessKeyId` and the `secretAccessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ interface SGObjectStorage_spec_s3Compatible_awsCredentials_secretKeySelectors { /** * AWS [access key ID](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `AKIAIOSFODNN7EXAMPLE`. * */ accessKeyId: SGObjectStorage_spec_s3Compatible_awsCredentials_secretKeySelectors_accessKeyId; /** * AWS [secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`. * */ secretAccessKey: SGObjectStorage_spec_s3Compatible_awsCredentials_secretKeySelectors_secretAccessKey; /** * CA Certificate file to be used when connecting to the S3 Compatible Service. * */ caCertificate?: SGObjectStorage_spec_s3Compatible_awsCredentials_secretKeySelectors_caCertificate; } /** * AWS [access key ID](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `AKIAIOSFODNN7EXAMPLE`. * */ interface SGObjectStorage_spec_s3Compatible_awsCredentials_secretKeySelectors_accessKeyId { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * AWS [secret access key](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). For example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`. * */ interface SGObjectStorage_spec_s3Compatible_awsCredentials_secretKeySelectors_secretAccessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * CA Certificate file to be used when connecting to the S3 Compatible Service. * */ interface SGObjectStorage_spec_s3Compatible_awsCredentials_secretKeySelectors_caCertificate { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * Google Cloud Storage configuration. * */ interface SGObjectStorage_spec_gcs { /** * GCS bucket name. * * @pattern ^(gs://)?[^/]+(/[^/]*)*$ */ bucket: string; /** * The credentials to access GCS for writing and reading. * */ gcpCredentials: SGObjectStorage_spec_gcs_gcpCredentials; } /** * The credentials to access GCS for writing and reading. * */ interface SGObjectStorage_spec_gcs_gcpCredentials { /** * If true, the credentials will be fetched from the GCE/GKE metadata service and the field `secretKeySelectors` have to be set to null or omitted. * * This is useful when running StackGres inside a GKE cluster using [Workload Identity](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity). * */ fetchCredentialsFromMetadataService?: boolean; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the Service Account to access GCS. * */ secretKeySelectors?: SGObjectStorage_spec_gcs_gcpCredentials_secretKeySelectors; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) to reference the Secrets that contain the information about the Service Account to access GCS. * */ interface SGObjectStorage_spec_gcs_gcpCredentials_secretKeySelectors { /** * A service account key from GCP. In JSON format, as downloaded from the GCP Console. * */ serviceAccountJSON: SGObjectStorage_spec_gcs_gcpCredentials_secretKeySelectors_serviceAccountJSON; } /** * A service account key from GCP. In JSON format, as downloaded from the GCP Console. * */ interface SGObjectStorage_spec_gcs_gcpCredentials_secretKeySelectors_serviceAccountJSON { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * Azure Blob Storage configuration. * */ interface SGObjectStorage_spec_azureBlob { /** * Azure Blob Storage bucket name. * * @pattern ^(azure://)?[^/]+(/[^/]*)*$ */ bucket: string; /** * The credentials to access Azure Blob Storage for writing and reading. * */ azureCredentials: SGObjectStorage_spec_azureBlob_azureCredentials; } /** * The credentials to access Azure Blob Storage for writing and reading. * */ interface SGObjectStorage_spec_azureBlob_azureCredentials { /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secret(s) that contain the information about the `azureCredentials`. . Note that you may use the same or different Secrets for the `storageAccount` and the `accessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ secretKeySelectors?: SGObjectStorage_spec_azureBlob_azureCredentials_secretKeySelectors; } /** * Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core)(s) to reference the Secret(s) that contain the information about the `azureCredentials`. . Note that you may use the same or different Secrets for the `storageAccount` and the `accessKey`. In the former case, the `keys` that identify each must be, obviously, different. * */ interface SGObjectStorage_spec_azureBlob_azureCredentials_secretKeySelectors { /** * The [Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json) that contains the Blob bucket to be used. * */ storageAccount: SGObjectStorage_spec_azureBlob_azureCredentials_secretKeySelectors_storageAccount; /** * The [storage account access key](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal). * */ accessKey: SGObjectStorage_spec_azureBlob_azureCredentials_secretKeySelectors_accessKey; } /** * The [Storage Account](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-overview?toc=/azure/storage/blobs/toc.json) that contains the Blob bucket to be used. * */ interface SGObjectStorage_spec_azureBlob_azureCredentials_secretKeySelectors_storageAccount { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } /** * The [storage account access key](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal). * */ interface SGObjectStorage_spec_azureBlob_azureCredentials_secretKeySelectors_accessKey { /** * The key of the secret to select from. Must be a valid secret key. * */ key: string; /** * Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). * */ name: string; } } export declare namespace io.stackgres.v1alpha1 { /** */ interface SGShardedCluster { /** */ metadata: SGShardedCluster_metadata; /** */ spec: SGShardedCluster_spec; /** */ status?: SGShardedCluster_status; } /** */ interface SGShardedCluster_metadata { /** * Name of the StackGres sharded cluster. Following [Kubernetes naming conventions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/architecture/identifiers.md), it must be an rfc1035/rfc1123 subdomain, that is, up to 253 characters consisting of one or more lowercase labels separated by `.`. Where each label is an alphanumeric (a-z, and 0-9) string, with a maximum length of 63 characters, with the `-` character allowed anywhere except the first or last character. * * The name must be unique across all SGCluster, SGShardedCluster and SGDistributedLogs in the same namespace. * * @pattern ^[a-z]([-a-z0-9]*[a-z0-9])?$ */ name?: string; } /** */ interface SGShardedCluster_spec { /** * The sharding technology that will be used for the sharded cluster. * * Currently the only possible value for this field is `citus`. * */ type?: string; /** * The database name that will be created and used across all node and where "partitioned" (distributed) tables will live in. * */ database: string; /** * This section allows to configure Postgres features * */ postgres: SGShardedCluster_spec_postgres; /** * This section allows to configure the global Postgres replication mode. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ replication?: SGShardedCluster_spec_replication; /** Kubernetes [services](https://kubernetes.io/docs/concepts/services-networking/service/) created or managed by StackGres. */ postgresServices?: SGShardedCluster_spec_postgresServices; /** * Sharded cluster custom configurations. * */ configurations?: SGShardedCluster_spec_configurations; /** Metadata information from any cluster created resources. */ metadata?: SGShardedCluster_spec_metadata; /** * The coordinator is a StackGres cluster responsible of coordinating data storage and access from the shards. * */ coordinator: SGShardedCluster_spec_coordinator; /** * The shards are a group of StackGres clusters where the partitioned data chunks are stored. * * When referring to the cluster in the descriptions belove it apply to any shard's StackGres cluster. * */ shards: SGShardedCluster_spec_shards; /** * If enabled, a ServiceMonitor is created for each Prometheus instance found in order to collect metrics. * */ prometheusAutobind?: boolean; /** StackGres features a functionality for all pods to send Postgres, Patroni and PgBouncer logs to a central (distributed) location, which is in turn another Postgres database. Logs can then be accessed via SQL interface or from the web UI. This section controls whether to enable this feature or not. If not enabled, logs are send to the pod's standard output. */ distributedLogs?: SGShardedCluster_spec_distributedLogs; /** */ nonProductionOptions?: SGShardedCluster_spec_nonProductionOptions; } /** * This section allows to configure Postgres features * */ interface SGShardedCluster_spec_postgres { /** * Postgres version used on the cluster. It is either of: * * The string 'latest', which automatically sets the latest major.minor Postgres version. * * A major version, like '14' or '13', which sets that major version and the latest minor version. * * A specific major.minor version, like '14.4'. * */ version: string; /** * Postgres flavor used on the cluster. It is either of: * * `babelfish` will use the [Babelfish for Postgres](https://babelfish-for-postgresql.github.io/babelfish-for-postgresql/). * * If not specified then the vanilla Postgres will be used for the cluster. * */ flavor?: string; /** * StackGres support deploy of extensions at runtime by simply adding an entry to this array. A deployed extension still * requires the creation in a database using the [`CREATE EXTENSION`](https://www.postgresql.org/docs/current/sql-createextension.html) * statement. After an extension is deployed correctly it will be present until removed and the cluster restarted. * * A cluster restart is required for: * * Extensions that requires to add an entry to [`shared_preload_libraries`](https://postgresqlco.nf/en/doc/param/shared_preload_libraries/) configuration parameter. * * Upgrading extensions that overwrite any file that is not the extension''s control file or extension''s script file. * * Removing extensions. Until the cluster is not restarted a removed extension will still be available. * * Install of extensions that require extra mount. After installed the cluster will require to be restarted. * */ extensions?: SGShardedCluster_spec_postgres_extensions[]; /** * This section allows to use SSL when connecting to Postgres * */ ssl?: SGShardedCluster_spec_postgres_ssl; } /** */ interface SGShardedCluster_spec_postgres_extensions { /** The name of the extension to deploy. */ name: string; /** The id of the publisher of the extension to deploy. If not specified `com.ongres` will be used by default. */ publisher?: string; /** The version of the extension to deploy. If not specified version of `stable` channel will be used by default. */ version?: string; /** The repository base URL from where to obtain the extension to deploy. If not specified https://stackgres.io/downloads/postgres/extensions will be used by default (or the value specified during operator deployment). */ repository?: string; } /** * This section allows to use SSL when connecting to Postgres * */ interface SGShardedCluster_spec_postgres_ssl { /** * Allow to enable SSL for connections to Postgres. By default is `true`. * * If `true` certificate and private key will be auto-generated unless fields `certificateSecretKeySelector` and `privateKeySecretKeySelector` are specified. * */ enabled?: boolean; /** * Secret key selector for the certificate or certificate chain used for SSL connections. * */ certificateSecretKeySelector?: SGShardedCluster_spec_postgres_ssl_certificateSecretKeySelector; /** * Secret key selector for the private key used for SSL connections. * */ privateKeySecretKeySelector?: SGShardedCluster_spec_postgres_ssl_privateKeySecretKeySelector; } /** * Secret key selector for the certificate or certificate chain used for SSL connections. * */ interface SGShardedCluster_spec_postgres_ssl_certificateSecretKeySelector { /** * The name of Secret that contains the certificate or certificate chain for SSL connections * */ name: string; /** * The key of Secret that contains the certificate or certificate chain for SSL connections * */ key: string; } /** * Secret key selector for the private key used for SSL connections. * */ interface SGShardedCluster_spec_postgres_ssl_privateKeySecretKeySelector { /** * The name of Secret that contains the private key for SSL connections * */ name: string; /** * The key of Secret that contains the private key for SSL connections * */ key: string; } /** * This section allows to configure the global Postgres replication mode. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ interface SGShardedCluster_spec_replication { /** * The replication mode applied to the whole cluster. * Possible values are: * * `async` (default) * * `sync` * * `strict-sync` * * `sync-all` * * `strict-sync-all` * * ### `async` Mode * * When in asynchronous mode the cluster is allowed to lose some committed transactions. * When the primary server fails or becomes unavailable for any other reason a sufficiently healthy standby * will automatically be promoted to primary. Any transactions that have not been replicated to that standby * remain in a "forked timeline" on the primary, and are effectively unrecoverable (the data is still there, * but recovering it requires a manual recovery effort by data recovery specialists). * * ### `sync` Mode * * When in synchronous mode a standby will not be promoted unless it is certain that the standby contains all * transactions that may have returned a successful commit status to client (clients can change the behavior * per transaction using PostgreSQL’s `synchronous_commit` setting. Transactions with `synchronous_commit` * values of `off` and `local` may be lost on fail over, but will not be blocked by replication delays). This * means that the system may be unavailable for writes even though some servers are available. System * administrators can still use manual failover commands to promote a standby even if it results in transaction * loss. * * Synchronous mode does not guarantee multi node durability of commits under all circumstances. When no suitable * standby is available, primary server will still accept writes, but does not guarantee their replication. When * the primary fails in this mode no standby will be promoted. When the host that used to be the primary comes * back it will get promoted automatically, unless system administrator performed a manual failover. This behavior * makes synchronous mode usable with 2 node clusters. * * When synchronous mode is used and a standby crashes, commits will block until the primary is switched to standalone * mode. Manually shutting down or restarting a standby will not cause a commit service interruption. Standby will * signal the primary to release itself from synchronous standby duties before PostgreSQL shutdown is initiated. * * ### `strict-sync` Mode * * When it is absolutely necessary to guarantee that each write is stored durably on at least two nodes, use the strict * synchronous mode. This mode prevents synchronous replication to be switched off on the primary when no synchronous * standby candidates are available. As a downside, the primary will not be available for writes (unless the Postgres * transaction explicitly turns off `synchronous_mode` parameter), blocking all client write requests until at least one * synchronous replica comes up. * * **Note**: Because of the way synchronous replication is implemented in PostgreSQL it is still possible to lose * transactions even when using strict synchronous mode. If the PostgreSQL backend is cancelled while waiting to acknowledge * replication (as a result of packet cancellation due to client timeout or backend failure) transaction changes become * visible for other backends. Such changes are not yet replicated and may be lost in case of standby promotion. * * ### `sync-all` Mode * * The same as `sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * * ### `strict-sync-all` Mode * * The same as `strict-sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * */ mode?: string; /** * Number of synchronous standby instances. Must be less than the total number of instances. It is set to 1 by default. * Only setteable if mode is `sync` or `strict-sync`. * */ syncInstances?: number; } /** Kubernetes [services](https://kubernetes.io/docs/concepts/services-networking/service/) created or managed by StackGres. */ interface SGShardedCluster_spec_postgresServices { /** * Configuration for the coordinator services * */ coordinator?: SGShardedCluster_spec_postgresServices_coordinator; /** * Configuration for the shards services * */ shards?: SGShardedCluster_spec_postgresServices_shards; } /** * Configuration for the coordinator services * */ interface SGShardedCluster_spec_postgresServices_coordinator { /** * Configure the coordinator service to any instance of the coordinator with the same name as the SGShardedCluster plus the `-reads` suffix. * * It provides a stable connection (regardless of node failures) to any Postgres server of the coordinator cluster. Servers are load-balanced via this service. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ any?: SGShardedCluster_spec_postgresServices_coordinator_any; /** * Configure the coordinator service to the primary of the coordinator with the name as the SGShardedCluster. * * It provides a stable connection (regardless of primary failures or switchovers) to the read-write Postgres server of the coordinator cluster. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ primary?: SGShardedCluster_spec_postgresServices_coordinator_primary; /** * The list of custom ports that will be exposed by the coordinator services. * * The names of custom ports will be prefixed with the string `custom-` so they do not * conflict with ports defined for the coordinator services. * * The names of target ports will be prefixed with the string `custom-` so that the ports * that can be referenced in this section will be only those defined under * .spec.pods.customContainers[].ports sections were names are also prepended with the same * prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#serviceport-v1-core * */ customPorts?: SGShardedCluster_spec_postgresServices_coordinator_customPorts[]; } /** * Configure the coordinator service to any instance of the coordinator with the same name as the SGShardedCluster plus the `-reads` suffix. * * It provides a stable connection (regardless of node failures) to any Postgres server of the coordinator cluster. Servers are load-balanced via this service. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ interface SGShardedCluster_spec_postgresServices_coordinator_any { /** Specify if the service should be created or not. */ enabled?: boolean; /** * type determines how the Service is exposed. Defaults to ClusterIP. Valid * options are ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates * a cluster-internal IP address for load-balancing to endpoints. * "NodePort" builds on ClusterIP and allocates a port on every node. * "LoadBalancer" builds on NodePort and creates * an external load-balancer (if supported in the current cloud). * More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types * */ type?: "ClusterIP" | "LoadBalancer" | "NodePort"; /** allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. */ allocateLoadBalancerNodePorts?: boolean; /** externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. */ externalIPs?: string[]; /** * externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. * * */ externalTrafficPolicy?: string; /** * healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. * @format int32 */ healthCheckNodePort?: number; /** InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). */ internalTrafficPolicy?: string; /** * IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. * * This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. */ ipFamilies?: string[]; /** IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. */ ipFamilyPolicy?: string; /** loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. */ loadBalancerClass?: string; /** Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version. */ loadBalancerIP?: string; /** If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ */ loadBalancerSourceRanges?: string[]; /** * Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies * * */ sessionAffinity?: string; /** SessionAffinityConfig represents the configurations of session affinity. */ sessionAffinityConfig?: SGShardedCluster_spec_postgresServices_coordinator_any_sessionAffinityConfig; } /** SessionAffinityConfig represents the configurations of session affinity. */ interface SGShardedCluster_spec_postgresServices_coordinator_any_sessionAffinityConfig { /** ClientIPConfig represents the configurations of Client IP based session affinity. */ clientIP?: SGShardedCluster_spec_postgresServices_coordinator_any_sessionAffinityConfig_clientIP; } /** ClientIPConfig represents the configurations of Client IP based session affinity. */ interface SGShardedCluster_spec_postgresServices_coordinator_any_sessionAffinityConfig_clientIP { /** * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). * @format int32 */ timeoutSeconds?: number; } /** * Configure the coordinator service to the primary of the coordinator with the name as the SGShardedCluster. * * It provides a stable connection (regardless of primary failures or switchovers) to the read-write Postgres server of the coordinator cluster. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ interface SGShardedCluster_spec_postgresServices_coordinator_primary { /** Specify if the service should be created or not. */ enabled?: boolean; /** * type determines how the Service is exposed. Defaults to ClusterIP. Valid * options are ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates * a cluster-internal IP address for load-balancing to endpoints. * "NodePort" builds on ClusterIP and allocates a port on every node. * "LoadBalancer" builds on NodePort and creates * an external load-balancer (if supported in the current cloud). * More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types * */ type?: "ClusterIP" | "LoadBalancer" | "NodePort"; /** allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. */ allocateLoadBalancerNodePorts?: boolean; /** externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. */ externalIPs?: string[]; /** * externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. * * */ externalTrafficPolicy?: string; /** * healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. * @format int32 */ healthCheckNodePort?: number; /** InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). */ internalTrafficPolicy?: string; /** * IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. * * This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. */ ipFamilies?: string[]; /** IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. */ ipFamilyPolicy?: string; /** loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. */ loadBalancerClass?: string; /** Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version. */ loadBalancerIP?: string; /** If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ */ loadBalancerSourceRanges?: string[]; /** * Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies * * */ sessionAffinity?: string; /** SessionAffinityConfig represents the configurations of session affinity. */ sessionAffinityConfig?: SGShardedCluster_spec_postgresServices_coordinator_primary_sessionAffinityConfig; } /** SessionAffinityConfig represents the configurations of session affinity. */ interface SGShardedCluster_spec_postgresServices_coordinator_primary_sessionAffinityConfig { /** ClientIPConfig represents the configurations of Client IP based session affinity. */ clientIP?: SGShardedCluster_spec_postgresServices_coordinator_primary_sessionAffinityConfig_clientIP; } /** ClientIPConfig represents the configurations of Client IP based session affinity. */ interface SGShardedCluster_spec_postgresServices_coordinator_primary_sessionAffinityConfig_clientIP { /** * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). * @format int32 */ timeoutSeconds?: number; } /** * A custom port that will be exposed by the Postgres coordinator services. * * The name of the custom port will be prefixed with the string `custom-` so it does not * conflict with ports defined for the coordinator services. * * The name of target port will be prefixed with the string `custom-` so that the port * that can be referenced in this section will be only those defined under * .spec.pods.customContainers[].ports sections were names are also prepended with the same * prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#serviceport-v1-core * */ interface SGShardedCluster_spec_postgresServices_coordinator_customPorts { /** The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. */ appProtocol?: string; /** The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. */ name?: string; /** * The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport * @format int32 */ nodePort?: number; /** * The port that will be exposed by this service. * @format int32 */ port: number; /** The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. */ protocol?: string; /** * IntOrString is a type that can hold an int32 or a string. When * used in JSON or YAML marshalling and unmarshalling, it produces * or consumes the inner type. This allows you to have, for example, * a JSON field that can accept a name or number. * * The name will be prefixed with the string `custom-` so that the target port that can be * referenced will be only those defined under .spec.pods.customContainers[].ports sections * were names are also prepended with the same prefix. * * @format int-or-string */ targetPort?: string; } /** * Configuration for the shards services * */ interface SGShardedCluster_spec_postgresServices_shards { /** * Configure the shards service to any primary in the shards with the name as the SGShardedCluster plus the `-shards` suffix. * * It provides a stable connection (regardless of primary failures or switchovers) to read-write Postgres servers of any shard cluster. Read-write servers are load-balanced via this service. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ primaries?: SGShardedCluster_spec_postgresServices_shards_primaries; /** * The list of custom ports that will be exposed by the shards services. * * The names of custom ports will be prefixed with the string `custom-` so they do not * conflict with ports defined for the shards services. * * The names of target ports will be prefixed with the string `custom-` so that the ports * that can be referenced in this section will be only those defined under * .spec.pods.customContainers[].ports sections were names are also prepended with the same * prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#serviceport-v1-core * */ customPorts?: SGShardedCluster_spec_postgresServices_shards_customPorts[]; } /** * Configure the shards service to any primary in the shards with the name as the SGShardedCluster plus the `-shards` suffix. * * It provides a stable connection (regardless of primary failures or switchovers) to read-write Postgres servers of any shard cluster. Read-write servers are load-balanced via this service. * * See also https://kubernetes.io/docs/concepts/services-networking/service/ * */ interface SGShardedCluster_spec_postgresServices_shards_primaries { /** Specify if the service should be created or not. */ enabled?: boolean; /** * type determines how the Service is exposed. Defaults to ClusterIP. Valid * options are ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates * a cluster-internal IP address for load-balancing to endpoints. * "NodePort" builds on ClusterIP and allocates a port on every node. * "LoadBalancer" builds on NodePort and creates * an external load-balancer (if supported in the current cloud). * More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types * */ type?: "ClusterIP" | "LoadBalancer" | "NodePort"; /** allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. If the caller requests specific NodePorts (by specifying a value), those requests will be respected, regardless of this field. This field may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. */ allocateLoadBalancerNodePorts?: boolean; /** externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. */ externalIPs?: string[]; /** * externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to "Local", the proxy will configure the service in a way that assumes that external load balancers will take care of balancing the service traffic between nodes, and so each node will deliver traffic only to the node-local endpoints of the service, without masquerading the client source IP. (Traffic mistakenly sent to a node with no endpoints will be dropped.) The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). Note that traffic sent to an External IP or LoadBalancer IP from within the cluster will always get "Cluster" semantics, but clients sending to a NodePort from within the cluster may need to take traffic policy into account when picking a node. * * */ externalTrafficPolicy?: string; /** * healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). This field cannot be updated once set. * @format int32 */ healthCheckNodePort?: number; /** InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service on the same node as the pod, dropping the traffic if there are no local endpoints. The default value, "Cluster", uses the standard behavior of routing to all endpoints evenly (possibly modified by topology and other features). */ internalTrafficPolicy?: string; /** * IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. * * This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. */ ipFamilies?: string[]; /** IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. */ ipFamilyPolicy?: string; /** loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g. "internal-vip" or "example.com/internal-vip". Unprefixed names are reserved for end-users. This field can only be set when the Service type is 'LoadBalancer'. If not set, the default load balancer implementation is used, today this is typically done through the cloud provider integration, but should apply for any default implementation. If set, it is assumed that a load balancer implementation is watching for Services with a matching class. Any default load balancer implementation (e.g. cloud providers) should ignore Services that set this field. This field can only be set when creating or updating a Service to type 'LoadBalancer'. Once set, it can not be changed. This field will be wiped when a service is updated to a non 'LoadBalancer' type. */ loadBalancerClass?: string; /** Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. Deprecated: This field was under-specified and its meaning varies across implementations, and it cannot support dual-stack. As of Kubernetes v1.24, users are encouraged to use implementation-specific annotations when available. This field may be removed in a future API version. */ loadBalancerIP?: string; /** If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/ */ loadBalancerSourceRanges?: string[]; /** * Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies * * */ sessionAffinity?: string; /** SessionAffinityConfig represents the configurations of session affinity. */ sessionAffinityConfig?: SGShardedCluster_spec_postgresServices_shards_primaries_sessionAffinityConfig; } /** SessionAffinityConfig represents the configurations of session affinity. */ interface SGShardedCluster_spec_postgresServices_shards_primaries_sessionAffinityConfig { /** ClientIPConfig represents the configurations of Client IP based session affinity. */ clientIP?: SGShardedCluster_spec_postgresServices_shards_primaries_sessionAffinityConfig_clientIP; } /** ClientIPConfig represents the configurations of Client IP based session affinity. */ interface SGShardedCluster_spec_postgresServices_shards_primaries_sessionAffinityConfig_clientIP { /** * timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours). * @format int32 */ timeoutSeconds?: number; } /** * A custom port that will be exposed by the Postgres shards services. * * The name of the custom port will be prefixed with the string `custom-` so it does not * conflict with ports defined for the shards services. * * The name of target port will be prefixed with the string `custom-` so that the port * that can be referenced in this section will be only those defined under * .spec.pods.customContainers[].ports sections were names are also prepended with the same * prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#serviceport-v1-core * */ interface SGShardedCluster_spec_postgresServices_shards_customPorts { /** The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. */ appProtocol?: string; /** The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service. */ name?: string; /** * The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport * @format int32 */ nodePort?: number; /** * The port that will be exposed by this service. * @format int32 */ port: number; /** The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. */ protocol?: string; /** * IntOrString is a type that can hold an int32 or a string. When * used in JSON or YAML marshalling and unmarshalling, it produces * or consumes the inner type. This allows you to have, for example, * a JSON field that can accept a name or number. * * The name will be prefixed with the string `custom-` so that the target port that can be * referenced will be only those defined under .spec.pods.customContainers[].ports sections * were names are also prepended with the same prefix. * * @format int-or-string */ targetPort?: string; } /** * Sharded cluster custom configurations. * */ interface SGShardedCluster_spec_configurations { /** * List of backups configurations for this SGCluster * */ backups?: SGShardedCluster_spec_configurations_backups[]; /** Allow to specify custom credentials for Postgres users and Patroni REST API */ credentials?: SGShardedCluster_spec_configurations_credentials; } /** * Backup configuration for this SGCluster * */ interface SGShardedCluster_spec_configurations_backups { /** * Specifies the backup compression algorithm. Possible options are: lz4, lzma, brotli. The default method is `lz4`. LZ4 is the fastest method, but compression ratio is the worst. LZMA is way slower, but it compresses backups about 6 times better than LZ4. Brotli is a good trade-off between speed and compression ratio, being about 3 times better than LZ4. * */ compression?: "lz4" | "lzma" | "brotli"; /** * Continuous Archiving backups are composed of periodic *base backups* and all the WAL segments produced in between those base backups. This parameter specifies at what time and with what frequency to start performing a new base backup. * * Use cron syntax (`m h dom mon dow`) for this parameter, i.e., 5 values separated by spaces: * * `m`: minute, 0 to 59. * * `h`: hour, 0 to 23. * * `dom`: day of month, 1 to 31 (recommended not to set it higher than 28). * * `mon`: month, 1 to 12. * * `dow`: day of week, 0 to 7 (0 and 7 both represent Sunday). * * Also ranges of values (`start-end`), the symbol `*` (meaning `first-last`) or even `*\//N`, where `N` is a number, meaning ""every `N`, may be used. All times are UTC. It is recommended to avoid 00:00 as base backup time, to avoid overlapping with any other external operations happening at this time. * * If not set, full backups are performed each day at 05:00 UTC. * */ cronSchedule?: string; /** * Configuration that affects the backup network and disk usage performance. * */ performance?: SGShardedCluster_spec_configurations_backups_performance; /** * When an automatic retention policy is defined to delete old base backups, this parameter specifies the number of base backups to keep, in a sliding window. * * Consequently, the time range covered by backups is `periodicity*retention`, where `periodicity` is the separation between backups as specified by the `cronSchedule` property. * * Default is 5. * */ retention?: number; /** * Name of the [SGObjectStorage](https://stackgres.io/doc/latest/reference/crd/sgobjectstorage) to use for the cluster. It defines the location in which the the backups will be stored. * */ sgObjectStorage: string; /** * The paths were the backups are stored. If not set this field is filled up by the operator. * * When provided will indicate were the backups and WAL files will be stored. * * The first path indicate the coordinator path and the other paths indicate the shards paths * */ paths?: string[]; } /** * Configuration that affects the backup network and disk usage performance. * */ interface SGShardedCluster_spec_configurations_backups_performance { /** * Maximum storage upload bandwidth used when storing a backup. In bytes (per second). * */ maxNetworkBandwidth?: number; /** * Maximum disk read I/O when performing a backup. In bytes (per second). * */ maxDiskBandwidth?: number; /** * Backup storage may use several concurrent streams to store the data. This parameter configures the number of parallel streams to use to reading from disk. By default, it's set to 1. * */ uploadDiskConcurrency?: number; /** * Backup storage may use several concurrent streams to store the data. This parameter configures the number of parallel streams to use. By default, it's set to 16. * */ uploadConcurrency?: number; /** * Backup storage may use several concurrent streams to read the data. This parameter configures the number of parallel streams to use. By default, it's set to the minimum between the number of file to read and 10. * */ downloadConcurrency?: number; } /** Allow to specify custom credentials for Postgres users and Patroni REST API */ interface SGShardedCluster_spec_configurations_credentials { /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials for patroni REST API. * */ patroni?: SGShardedCluster_spec_configurations_credentials_patroni; /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the users. * */ users?: SGShardedCluster_spec_configurations_credentials_users; } /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials for patroni REST API. * */ interface SGShardedCluster_spec_configurations_credentials_patroni { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password for the patroni REST API. * */ restApiPassword?: SGShardedCluster_spec_configurations_credentials_patroni_restApiPassword; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password for the patroni REST API. * */ interface SGShardedCluster_spec_configurations_credentials_patroni_restApiPassword { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * Kubernetes [SecretKeySelectors](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the users. * */ interface SGShardedCluster_spec_configurations_credentials_users { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the superuser (usually the postgres user). * */ superuser?: SGShardedCluster_spec_configurations_credentials_users_superuser; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the replication user used to replicate from the primary cluster and from replicas of this cluster. * */ replication?: SGShardedCluster_spec_configurations_credentials_users_replication; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the authenticator user used by pgbouncer to authenticate other users. * */ authenticator?: SGShardedCluster_spec_configurations_credentials_users_authenticator; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the superuser (usually the postgres user). * */ interface SGShardedCluster_spec_configurations_credentials_users_superuser { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username?: SGShardedCluster_spec_configurations_credentials_users_superuser_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password?: SGShardedCluster_spec_configurations_credentials_users_superuser_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGShardedCluster_spec_configurations_credentials_users_superuser_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGShardedCluster_spec_configurations_credentials_users_superuser_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the replication user used to replicate from the primary cluster and from replicas of this cluster. * */ interface SGShardedCluster_spec_configurations_credentials_users_replication { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username?: SGShardedCluster_spec_configurations_credentials_users_replication_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password?: SGShardedCluster_spec_configurations_credentials_users_replication_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGShardedCluster_spec_configurations_credentials_users_replication_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGShardedCluster_spec_configurations_credentials_users_replication_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the credentials of the authenticator user used by pgbouncer to authenticate other users. * */ interface SGShardedCluster_spec_configurations_credentials_users_authenticator { /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ username?: SGShardedCluster_spec_configurations_credentials_users_authenticator_username; /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ password?: SGShardedCluster_spec_configurations_credentials_users_authenticator_password; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the username of the user. * */ interface SGShardedCluster_spec_configurations_credentials_users_authenticator_username { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** * A Kubernetes [SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#secretkeyselector-v1-core) that contains the password of the user. * */ interface SGShardedCluster_spec_configurations_credentials_users_authenticator_password { /** Name of the referent. [More information](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names). */ name: string; /** The key of the secret to select from. Must be a valid secret key. */ key: string; } /** Metadata information from any cluster created resources. */ interface SGShardedCluster_spec_metadata { /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ annotations?: SGShardedCluster_spec_metadata_annotations; /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ labels?: SGShardedCluster_spec_metadata_labels; } /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ interface SGShardedCluster_spec_metadata_annotations { /** Annotations to attach to any resource created or managed by StackGres. */ allResources?: Record; /** Annotations to attach to pods created or managed by StackGres. */ clusterPods?: Record; /** Annotations to attach to all services created or managed by StackGres. */ services?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-primary` service. */ primaryService?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-replicas` service. */ replicasService?: Record; } /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ interface SGShardedCluster_spec_metadata_labels { /** Labels to attach to Pods created or managed by StackGres. */ clusterPods?: Record; /** Labels to attach to Services and Endpoints created or managed by StackGres. */ services?: Record; } /** * The coordinator is a StackGres cluster responsible of coordinating data storage and access from the shards. * */ interface SGShardedCluster_spec_coordinator { /** * Number of StackGres instances for the cluster. Each instance contains one Postgres server. * Out of all of the Postgres servers, one is elected as the primary, the rest remain as read-only replicas. * */ instances: number; /** * Name of the [SGInstanceProfile](https://stackgres.io/doc/latest/04-postgres-cluster-management/03-resource-profiles/). A SGInstanceProfile defines CPU and memory limits. Must exist before creating a cluster. When no profile is set, a default (currently: 1 core, 2 GiB RAM) one is used. * */ sgInstanceProfile?: string; /** * This section allows to reference SQL scripts that will be applied to the cluster live. * */ managedSql?: SGShardedCluster_spec_coordinator_managedSql; /** Cluster pod's configuration. */ pods: SGShardedCluster_spec_coordinator_pods; /** * Coordinator custom configurations. * */ configurations?: SGShardedCluster_spec_coordinator_configurations; /** * This section allows to configure the global Postgres replication mode. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ replication?: SGShardedCluster_spec_coordinator_replication; /** Metadata information from coordinator cluster created resources. */ metadata?: SGShardedCluster_spec_coordinator_metadata; } /** * This section allows to reference SQL scripts that will be applied to the cluster live. * */ interface SGShardedCluster_spec_coordinator_managedSql { /** If true, when any entry of any `SGScript` fail will not prevent subsequent `SGScript` from being executed. By default is `false`. */ continueOnSGScriptError?: boolean; /** * A list of script references that will be executed in sequence. * */ scripts?: SGShardedCluster_spec_coordinator_managedSql_scripts[]; } /** * A script reference. Each version of each entry of the script referenced will be executed exactly once following the sequence defined * in the referenced script and skipping any script entry that have already been executed. * */ interface SGShardedCluster_spec_coordinator_managedSql_scripts { /** The id is immutable and must be unique across all the `SGScript` entries. It is replaced by the operator and is used to identify the `SGScript` entry. */ id?: number; /** A reference to an `SGScript` */ sgScript?: string; } /** Cluster pod's configuration. */ interface SGShardedCluster_spec_coordinator_pods { /** Pod's persistent volume configuration. */ persistentVolume: SGShardedCluster_spec_coordinator_pods_persistentVolume; /** If set to `true`, avoids creating a connection pooling (using [PgBouncer](https://www.pgbouncer.org/)) sidecar. */ disableConnectionPooling?: boolean; /** If set to `true`, avoids creating the Prometheus exporter sidecar. Recommended when there's no intention to use Prometheus for monitoring. */ disableMetricsExporter?: boolean; /** If set to `true`, avoids creating the `postgres-util` sidecar. This sidecar contains usual Postgres administration utilities *that are not present in the main (`patroni`) container*, like `psql`. Only disable if you know what you are doing. */ disablePostgresUtil?: boolean; /** Pod custom resources configuration. */ resources?: SGShardedCluster_spec_coordinator_pods_resources; /** Pod custom scheduling, affinity and topology spread constratins configuration. */ scheduling?: SGShardedCluster_spec_coordinator_pods_scheduling; /** * managementPolicy controls how pods are created during initial scale up, when replacing pods * on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created * in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is * ready before continuing. When scaling down, the pods are removed in the opposite order. * The alternative policy is `Parallel` which will create pods in parallel to match the desired * scale without waiting, and on scale down will delete all pods at once. * */ managementPolicy?: string; /** * A list of custom volumes that may be used along with any container defined in * customInitContainers or customContainers sections for the coordinator. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the customInitContainers or customContainers sections the name used * have to be prepended with the same prefix. * * Only the following volume types are allowed: configMap, downwardAPI, emptyDir, * gitRepo, glusterfs, hostPath, nfs, projected and secret * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core * */ customVolumes?: SGShardedCluster_spec_coordinator_pods_customVolumes[]; /** * A list of custom application init containers that run within the shards cluster's Pods. The * custom init containers will run following the defined sequence as the end of * cluster's Pods init containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ customInitContainers?: SGShardedCluster_spec_coordinator_pods_customInitContainers[]; /** * A list of custom application containers that run within the coordinator cluster's Pods. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ customContainers?: SGShardedCluster_spec_coordinator_pods_customContainers[]; } /** Pod's persistent volume configuration. */ interface SGShardedCluster_spec_coordinator_pods_persistentVolume { /** * Size of the PersistentVolume set for each instance of the cluster. This size is specified either in Mebibytes, Gibibytes or Tebibytes (multiples of 2^20, 2^30 or 2^40, respectively). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi|Ti)$ */ size: string; /** * Name of an existing StorageClass in the Kubernetes cluster, used to create the PersistentVolumes for the instances of the cluster. * */ storageClass?: string; } /** Pod custom resources configuration. */ interface SGShardedCluster_spec_coordinator_pods_resources { /** When enabled resource limits for containers other than the patroni container wil be set just like for patroni contianer as specified in the SGInstanceProfile. */ enableClusterLimitsRequirements?: boolean; } /** Pod custom scheduling, affinity and topology spread constratins configuration. */ interface SGShardedCluster_spec_coordinator_pods_scheduling { /** * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ * */ nodeSelector?: Record; /** * If specified, the pod's tolerations. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ tolerations?: SGShardedCluster_spec_coordinator_pods_scheduling_tolerations[]; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity; /** * TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. * */ topologySpreadConstraints?: SGShardedCluster_spec_coordinator_pods_scheduling_topologySpreadConstraints[]; /** Backup Pod custom scheduling and affinity configuration. */ backup?: SGShardedCluster_spec_coordinator_pods_scheduling_backup; } /** * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_tolerations { /** * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. * * */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. * * */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * TopologySpreadConstraint specifies how to spread matching pods among the given topology. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#topologyspreadconstraint-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_topologySpreadConstraints { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_topologySpreadConstraints_labelSelector; /** MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. */ matchLabelKeys?: string[]; /** * MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. * @format int32 */ maxSkew: number; /** * MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. * * For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. * * This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default). * @format int32 */ minDomains?: number; /** * NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. * * If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeAffinityPolicy?: string; /** * NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. * * If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeTaintsPolicy?: string; /** TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. */ topologyKey: string; /** * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, * but giving higher precedence to topologies that would help reduce the * skew. * A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. * * */ whenUnsatisfiable: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_topologySpreadConstraints_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_topologySpreadConstraints_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_topologySpreadConstraints_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Backup Pod custom scheduling and affinity configuration. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup { /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ tolerations?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_coordinator_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * A custom volume that may be used along with any container defined in * customInitContainers or customContainers sections. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the customInitContainers or customContainers sections the name used * have to be prepended with the same prefix. * * Only the following volume types are allowed: configMap, downwardAPI, emptyDir, * gitRepo, glusterfs, hostPath, nfs, projected and secret * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_customVolumes { /** * Volumes name. Must be a DNS_LABEL and unique within the pod. * More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names * * The name will be prefixed with the string `custom-` so that when referencing them in the * customInitContainers or customContainers sections the name used have to be prepended with * the same prefix. * */ name?: string; /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ configMap?: SGShardedCluster_spec_coordinator_pods_customVolumes_configMap; /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ downwardAPI?: SGShardedCluster_spec_coordinator_pods_customVolumes_downwardAPI; /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ emptyDir?: SGShardedCluster_spec_coordinator_pods_customVolumes_emptyDir; /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ gitRepo?: SGShardedCluster_spec_coordinator_pods_customVolumes_gitRepo; /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ glusterfs?: SGShardedCluster_spec_coordinator_pods_customVolumes_glusterfs; /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ hostPath?: SGShardedCluster_spec_coordinator_pods_customVolumes_hostPath; /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ nfs?: SGShardedCluster_spec_coordinator_pods_customVolumes_nfs; /** Represents a projected volume source */ projected?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected; /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ secret?: SGShardedCluster_spec_coordinator_pods_customVolumes_secret; } /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_configMap { /** * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_coordinator_pods_customVolumes_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_configMap_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_downwardAPI { /** * Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** Items is a list of downward API volume file */ items?: SGShardedCluster_spec_coordinator_pods_customVolumes_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_downwardAPI_items { /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_coordinator_pods_customVolumes_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_coordinator_pods_customVolumes_downwardAPI_items_resourceFieldRef; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_emptyDir { /** What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ medium?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ sizeLimit?: string; } /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_gitRepo { /** Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */ directory?: string; /** Repository URL */ repository: string; /** Commit hash for the specified revision. */ revision?: string; } /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_glusterfs { /** EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ endpoints: string; /** Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ path: string; /** ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ readOnly?: boolean; } /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_hostPath { /** Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ path: string; /** Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ type?: string; } /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_nfs { /** Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ path: string; /** ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ readOnly?: boolean; /** Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ server: string; } /** Represents a projected volume source */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected { /** * Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** list of volume projections */ sources?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources[]; } /** Projection that may be projected along with other supported volume types */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources { /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ configMap?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_configMap; /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ downwardAPI?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_downwardAPI; /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ secret?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_secret; /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ serviceAccountToken?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_serviceAccountToken; } /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_configMap { /** If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_configMap_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_downwardAPI { /** Items is a list of DownwardAPIVolume file */ items?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_downwardAPI_items { /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_downwardAPI_items_resourceFieldRef; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_secret { /** If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_secret_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_secret_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_projected_sources_serviceAccountToken { /** Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. */ audience?: string; /** * ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. * @format int64 */ expirationSeconds?: number; /** Path is the path relative to the mount point of the file to project the token into. */ path: string; } /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_secret { /** * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_coordinator_pods_customVolumes_secret_items[]; /** Specify whether the Secret or its keys must be defined */ optional?: boolean; /** Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ secretName?: string; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_coordinator_pods_customVolumes_secret_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** * A custom application init container that run within the cluster's Pods. The custom init * containers will run following the defined sequence as the end of cluster's Pods init * containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers { /** Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: SGShardedCluster_spec_coordinator_pods_customInitContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: SGShardedCluster_spec_coordinator_pods_customInitContainers_envFrom[]; /** Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ lifecycle?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ livenessProbe?: SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe; /** * Name of the container specified as a DNS_LABEL. Each * container in a pod must have a unique name (DNS_LABEL). Cannot * be updated. * * The name will be prefixed with the string `custom-` so that when referencing it * in the .spec.containers section of SGInstanceProfile the name used have to be * prepended with the same prefix. * */ name: string; /** List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. */ ports?: SGShardedCluster_spec_coordinator_pods_customInitContainers_ports[]; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ readinessProbe?: SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe; /** ResourceRequirements describes the compute resource requirements. */ resources?: SGShardedCluster_spec_coordinator_pods_customInitContainers_resources; /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ securityContext?: SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ startupProbe?: SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: SGShardedCluster_spec_coordinator_pods_customInitContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: SGShardedCluster_spec_coordinator_pods_customInitContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** EnvVarSource represents a source for the value of an EnvVar. */ valueFrom?: SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom { /** Selects a key from a ConfigMap. */ configMapKeyRef?: SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom_configMapKeyRef; /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom_fieldRef; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom_resourceFieldRef; /** SecretKeySelector selects a key of a Secret. */ secretKeyRef?: SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom_secretKeyRef; } /** Selects a key from a ConfigMap. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** SecretKeySelector selects a key of a Secret. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_envFrom { /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ configMapRef?: SGShardedCluster_spec_coordinator_pods_customInitContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ secretRef?: SGShardedCluster_spec_coordinator_pods_customInitContainers_envFrom_secretRef; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle { /** Handler defines a specific action that should be taken */ postStart?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart; /** Handler defines a specific action that should be taken */ preStop?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ContainerPort represents a network port in a single container. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */ protocol?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ResourceRequirements describes the compute resource requirements. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_resources { /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN */ allowPrivilegeEscalation?: boolean; /** Adds and removes POSIX capabilities from running containers. */ capabilities?: SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsUser?: number; /** SELinuxOptions are the labels to be applied to the container */ seLinuxOptions?: SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext_seLinuxOptions; /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ seccompProfile?: SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext_seccompProfile; /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ windowsOptions?: SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext_windowsOptions; } /** Adds and removes POSIX capabilities from running containers. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** SELinuxOptions are the labels to be applied to the container */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface SGShardedCluster_spec_coordinator_pods_customInitContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * A custom application init container that run within the cluster's Pods. The custom init * containers will run following the defined sequence as the end of cluster's Pods init * containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ interface SGShardedCluster_spec_coordinator_pods_customContainers { /** Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: SGShardedCluster_spec_coordinator_pods_customContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: SGShardedCluster_spec_coordinator_pods_customContainers_envFrom[]; /** Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ lifecycle?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ livenessProbe?: SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe; /** * Name of the container specified as a DNS_LABEL. Each * container in a pod must have a unique name (DNS_LABEL). Cannot * be updated. * * The name will be prefixed with the string `custom-` so that when referencing it * in the .spec.containers section of SGInstanceProfile the name used have to be * prepended with the same prefix. * */ name: string; /** List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. */ ports?: SGShardedCluster_spec_coordinator_pods_customContainers_ports[]; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ readinessProbe?: SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe; /** ResourceRequirements describes the compute resource requirements. */ resources?: SGShardedCluster_spec_coordinator_pods_customContainers_resources; /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ securityContext?: SGShardedCluster_spec_coordinator_pods_customContainers_securityContext; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ startupProbe?: SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: SGShardedCluster_spec_coordinator_pods_customContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: SGShardedCluster_spec_coordinator_pods_customContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** EnvVarSource represents a source for the value of an EnvVar. */ valueFrom?: SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom { /** Selects a key from a ConfigMap. */ configMapKeyRef?: SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom_configMapKeyRef; /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom_fieldRef; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom_resourceFieldRef; /** SecretKeySelector selects a key of a Secret. */ secretKeyRef?: SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom_secretKeyRef; } /** Selects a key from a ConfigMap. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** SecretKeySelector selects a key of a Secret. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface SGShardedCluster_spec_coordinator_pods_customContainers_envFrom { /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ configMapRef?: SGShardedCluster_spec_coordinator_pods_customContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ secretRef?: SGShardedCluster_spec_coordinator_pods_customContainers_envFrom_secretRef; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle { /** Handler defines a specific action that should be taken */ postStart?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart; /** Handler defines a specific action that should be taken */ preStop?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ContainerPort represents a network port in a single container. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */ protocol?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ResourceRequirements describes the compute resource requirements. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_resources { /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN */ allowPrivilegeEscalation?: boolean; /** Adds and removes POSIX capabilities from running containers. */ capabilities?: SGShardedCluster_spec_coordinator_pods_customContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsUser?: number; /** SELinuxOptions are the labels to be applied to the container */ seLinuxOptions?: SGShardedCluster_spec_coordinator_pods_customContainers_securityContext_seLinuxOptions; /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ seccompProfile?: SGShardedCluster_spec_coordinator_pods_customContainers_securityContext_seccompProfile; /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ windowsOptions?: SGShardedCluster_spec_coordinator_pods_customContainers_securityContext_windowsOptions; } /** Adds and removes POSIX capabilities from running containers. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** SELinuxOptions are the labels to be applied to the container */ interface SGShardedCluster_spec_coordinator_pods_customContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_coordinator_pods_customContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface SGShardedCluster_spec_coordinator_pods_customContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * Coordinator custom configurations. * */ interface SGShardedCluster_spec_coordinator_configurations { /** * Name of the [SGPostgresConfig](https://stackgres.io/doc/latest/reference/crd/sgpgconfig) used for the cluster. It must exist. When not set, a default Postgres config, for the major version selected, is used. * */ sgPostgresConfig?: string; /** * Name of the [SGPoolingConfig](https://stackgres.io/doc/latest/reference/crd/sgpoolconfig) used for this cluster. Each pod contains a sidecar with a connection pooler (currently: [PgBouncer](https://www.pgbouncer.org/)). The connection pooler is implemented as a sidecar. * * If not set, a default configuration will be used. Disabling connection pooling altogether is possible if the disableConnectionPooling property of the pods object is set to true. * */ sgPoolingConfig?: string; } /** * This section allows to configure the global Postgres replication mode. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ interface SGShardedCluster_spec_coordinator_replication { /** * The replication mode applied to the whole cluster. * Possible values are: * * `async` * * `sync` * * `strict-sync` * * `sync-all` (default) * * `strict-sync-all` * * ### `async` Mode * * When in asynchronous mode the cluster is allowed to lose some committed transactions. * When the primary server fails or becomes unavailable for any other reason a sufficiently healthy standby * will automatically be promoted to primary. Any transactions that have not been replicated to that standby * remain in a "forked timeline" on the primary, and are effectively unrecoverable (the data is still there, * but recovering it requires a manual recovery effort by data recovery specialists). * * ### `sync` Mode * * When in synchronous mode a standby will not be promoted unless it is certain that the standby contains all * transactions that may have returned a successful commit status to client (clients can change the behavior * per transaction using PostgreSQL’s `synchronous_commit` setting. Transactions with `synchronous_commit` * values of `off` and `local` may be lost on fail over, but will not be blocked by replication delays). This * means that the system may be unavailable for writes even though some servers are available. System * administrators can still use manual failover commands to promote a standby even if it results in transaction * loss. * * Synchronous mode does not guarantee multi node durability of commits under all circumstances. When no suitable * standby is available, primary server will still accept writes, but does not guarantee their replication. When * the primary fails in this mode no standby will be promoted. When the host that used to be the primary comes * back it will get promoted automatically, unless system administrator performed a manual failover. This behavior * makes synchronous mode usable with 2 node clusters. * * When synchronous mode is used and a standby crashes, commits will block until the primary is switched to standalone * mode. Manually shutting down or restarting a standby will not cause a commit service interruption. Standby will * signal the primary to release itself from synchronous standby duties before PostgreSQL shutdown is initiated. * * ### `strict-sync` Mode * * When it is absolutely necessary to guarantee that each write is stored durably on at least two nodes, use the strict * synchronous mode. This mode prevents synchronous replication to be switched off on the primary when no synchronous * standby candidates are available. As a downside, the primary will not be available for writes (unless the Postgres * transaction explicitly turns off `synchronous_mode` parameter), blocking all client write requests until at least one * synchronous replica comes up. * * **Note**: Because of the way synchronous replication is implemented in PostgreSQL it is still possible to lose * transactions even when using strict synchronous mode. If the PostgreSQL backend is cancelled while waiting to acknowledge * replication (as a result of packet cancellation due to client timeout or backend failure) transaction changes become * visible for other backends. Such changes are not yet replicated and may be lost in case of standby promotion. * * ### `sync-all` Mode * * The same as `sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * * ### `strict-sync-all` Mode * * The same as `strict-sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * */ mode?: string; /** * Number of synchronous standby instances. Must be less than the total number of instances. It is set to 1 by default. * Only setteable if mode is `sync` or `strict-sync`. * */ syncInstances?: number; } /** Metadata information from coordinator cluster created resources. */ interface SGShardedCluster_spec_coordinator_metadata { /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ annotations?: SGShardedCluster_spec_coordinator_metadata_annotations; /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ labels?: SGShardedCluster_spec_coordinator_metadata_labels; } /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ interface SGShardedCluster_spec_coordinator_metadata_annotations { /** Annotations to attach to any resource created or managed by StackGres. */ allResources?: Record; /** Annotations to attach to pods created or managed by StackGres. */ clusterPods?: Record; /** Annotations to attach to all services created or managed by StackGres. */ services?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-primary` service. */ primaryService?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-replicas` service. */ replicasService?: Record; } /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ interface SGShardedCluster_spec_coordinator_metadata_labels { /** Labels to attach to Pods created or managed by StackGres. */ clusterPods?: Record; /** Labels to attach to Services and Endpoints created or managed by StackGres. */ services?: Record; } /** * The shards are a group of StackGres clusters where the partitioned data chunks are stored. * * When referring to the cluster in the descriptions belove it apply to any shard's StackGres cluster. * */ interface SGShardedCluster_spec_shards { /** * Number of shard's StackGres clusters * */ clusters: number; /** * Number of StackGres instances per shard's StackGres cluster. Each instance contains one Postgres server. * Out of all of the Postgres servers, one is elected as the primary, the rest remain as read-only replicas. * */ instancesPerCluster: number; /** * Name of the [SGInstanceProfile](https://stackgres.io/doc/latest/04-postgres-cluster-management/03-resource-profiles/). A SGInstanceProfile defines CPU and memory limits. Must exist before creating a cluster. When no profile is set, a default (currently: 1 core, 2 GiB RAM) one is used. * */ sgInstanceProfile?: string; /** * This section allows to reference SQL scripts that will be applied to the cluster live. * */ managedSql?: SGShardedCluster_spec_shards_managedSql; /** Cluster pod's configuration. */ pods: SGShardedCluster_spec_shards_pods; /** * Shards custom configurations. * */ configurations?: SGShardedCluster_spec_shards_configurations; /** * This section allows to configure the global Postgres replication mode. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ replication?: SGShardedCluster_spec_shards_replication; /** Metadata information from shards cluster created resources. */ metadata?: SGShardedCluster_spec_shards_metadata; /** * Any shard can be overriden by this section. * */ overrides?: SGShardedCluster_spec_shards_overrides[]; } /** * This section allows to reference SQL scripts that will be applied to the cluster live. * */ interface SGShardedCluster_spec_shards_managedSql { /** If true, when any entry of any `SGScript` fail will not prevent subsequent `SGScript` from being executed. By default is `false`. */ continueOnSGScriptError?: boolean; /** * A list of script references that will be executed in sequence. * */ scripts?: SGShardedCluster_spec_shards_managedSql_scripts[]; } /** * A script reference. Each version of each entry of the script referenced will be executed exactly once following the sequence defined * in the referenced script and skipping any script entry that have already been executed. * */ interface SGShardedCluster_spec_shards_managedSql_scripts { /** The id is immutable and must be unique across all the `SGScript` entries. It is replaced by the operator and is used to identify the `SGScript` entry. */ id?: number; /** A reference to an `SGScript` */ sgScript?: string; } /** Cluster pod's configuration. */ interface SGShardedCluster_spec_shards_pods { /** Pod's persistent volume configuration. */ persistentVolume: SGShardedCluster_spec_shards_pods_persistentVolume; /** If set to `true`, avoids creating a connection pooling (using [PgBouncer](https://www.pgbouncer.org/)) sidecar. */ disableConnectionPooling?: boolean; /** If set to `true`, avoids creating the Prometheus exporter sidecar. Recommended when there's no intention to use Prometheus for monitoring. */ disableMetricsExporter?: boolean; /** If set to `true`, avoids creating the `postgres-util` sidecar. This sidecar contains usual Postgres administration utilities *that are not present in the main (`patroni`) container*, like `psql`. Only disable if you know what you are doing. */ disablePostgresUtil?: boolean; /** Pod custom resources configuration. */ resources?: SGShardedCluster_spec_shards_pods_resources; /** Pod custom scheduling, affinity and topology spread constratins configuration. */ scheduling?: SGShardedCluster_spec_shards_pods_scheduling; /** * managementPolicy controls how pods are created during initial scale up, when replacing pods * on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created * in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is * ready before continuing. When scaling down, the pods are removed in the opposite order. * The alternative policy is `Parallel` which will create pods in parallel to match the desired * scale without waiting, and on scale down will delete all pods at once. * */ managementPolicy?: string; /** * A list of custom volumes that may be used along with any container defined in * customInitContainers or customContainers sections for the shards. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the customInitContainers or customContainers sections the name used * have to be prepended with the same prefix. * * Only the following volume types are allowed: configMap, downwardAPI, emptyDir, * gitRepo, glusterfs, hostPath, nfs, projected and secret * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core * */ customVolumes?: SGShardedCluster_spec_shards_pods_customVolumes[]; /** * A list of custom application init containers that run within the coordinator cluster's Pods. The * custom init containers will run following the defined sequence as the end of * cluster's Pods init containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ customInitContainers?: SGShardedCluster_spec_shards_pods_customInitContainers[]; /** * A list of custom application containers that run within the shards cluster's Pods. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ customContainers?: SGShardedCluster_spec_shards_pods_customContainers[]; } /** Pod's persistent volume configuration. */ interface SGShardedCluster_spec_shards_pods_persistentVolume { /** * Size of the PersistentVolume set for each instance of the cluster. This size is specified either in Mebibytes, Gibibytes or Tebibytes (multiples of 2^20, 2^30 or 2^40, respectively). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi|Ti)$ */ size: string; /** * Name of an existing StorageClass in the Kubernetes cluster, used to create the PersistentVolumes for the instances of the cluster. * */ storageClass?: string; } /** Pod custom resources configuration. */ interface SGShardedCluster_spec_shards_pods_resources { /** When enabled resource limits for containers other than the patroni container wil be set just like for patroni contianer as specified in the SGInstanceProfile. */ enableClusterLimitsRequirements?: boolean; } /** Pod custom scheduling, affinity and topology spread constratins configuration. */ interface SGShardedCluster_spec_shards_pods_scheduling { /** * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ * */ nodeSelector?: Record; /** * If specified, the pod's tolerations. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ tolerations?: SGShardedCluster_spec_shards_pods_scheduling_tolerations[]; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity; /** * TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. * */ topologySpreadConstraints?: SGShardedCluster_spec_shards_pods_scheduling_topologySpreadConstraints[]; /** Backup Pod custom scheduling and affinity configuration. */ backup?: SGShardedCluster_spec_shards_pods_scheduling_backup; } /** * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_tolerations { /** * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. * * */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. * * */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * TopologySpreadConstraint specifies how to spread matching pods among the given topology. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#topologyspreadconstraint-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_topologySpreadConstraints { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_topologySpreadConstraints_labelSelector; /** MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. */ matchLabelKeys?: string[]; /** * MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. * @format int32 */ maxSkew: number; /** * MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. * * For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. * * This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default). * @format int32 */ minDomains?: number; /** * NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. * * If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeAffinityPolicy?: string; /** * NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. * * If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeTaintsPolicy?: string; /** TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. */ topologyKey: string; /** * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, * but giving higher precedence to topologies that would help reduce the * skew. * A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. * * */ whenUnsatisfiable: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_topologySpreadConstraints_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_topologySpreadConstraints_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_topologySpreadConstraints_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Backup Pod custom scheduling and affinity configuration. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup { /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ tolerations?: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * A custom volume that may be used along with any container defined in * customInitContainers or customContainers sections. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the customInitContainers or customContainers sections the name used * have to be prepended with the same prefix. * * Only the following volume types are allowed: configMap, downwardAPI, emptyDir, * gitRepo, glusterfs, hostPath, nfs, projected and secret * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core * */ interface SGShardedCluster_spec_shards_pods_customVolumes { /** * Volumes name. Must be a DNS_LABEL and unique within the pod. * More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names * * The name will be prefixed with the string `custom-` so that when referencing them in the * customInitContainers or customContainers sections the name used have to be prepended with * the same prefix. * */ name?: string; /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ configMap?: SGShardedCluster_spec_shards_pods_customVolumes_configMap; /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ downwardAPI?: SGShardedCluster_spec_shards_pods_customVolumes_downwardAPI; /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ emptyDir?: SGShardedCluster_spec_shards_pods_customVolumes_emptyDir; /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ gitRepo?: SGShardedCluster_spec_shards_pods_customVolumes_gitRepo; /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ glusterfs?: SGShardedCluster_spec_shards_pods_customVolumes_glusterfs; /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ hostPath?: SGShardedCluster_spec_shards_pods_customVolumes_hostPath; /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ nfs?: SGShardedCluster_spec_shards_pods_customVolumes_nfs; /** Represents a projected volume source */ projected?: SGShardedCluster_spec_shards_pods_customVolumes_projected; /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ secret?: SGShardedCluster_spec_shards_pods_customVolumes_secret; } /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_shards_pods_customVolumes_configMap { /** * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_shards_pods_customVolumes_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_shards_pods_customVolumes_configMap_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_shards_pods_customVolumes_downwardAPI { /** * Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** Items is a list of downward API volume file */ items?: SGShardedCluster_spec_shards_pods_customVolumes_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface SGShardedCluster_spec_shards_pods_customVolumes_downwardAPI_items { /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_shards_pods_customVolumes_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_shards_pods_customVolumes_downwardAPI_items_resourceFieldRef; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_shards_pods_customVolumes_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_shards_pods_customVolumes_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_shards_pods_customVolumes_emptyDir { /** What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ medium?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ sizeLimit?: string; } /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ interface SGShardedCluster_spec_shards_pods_customVolumes_gitRepo { /** Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */ directory?: string; /** Repository URL */ repository: string; /** Commit hash for the specified revision. */ revision?: string; } /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_shards_pods_customVolumes_glusterfs { /** EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ endpoints: string; /** Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ path: string; /** ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ readOnly?: boolean; } /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_shards_pods_customVolumes_hostPath { /** Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ path: string; /** Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ type?: string; } /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_shards_pods_customVolumes_nfs { /** Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ path: string; /** ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ readOnly?: boolean; /** Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ server: string; } /** Represents a projected volume source */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected { /** * Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** list of volume projections */ sources?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources[]; } /** Projection that may be projected along with other supported volume types */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources { /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ configMap?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_configMap; /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ downwardAPI?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_downwardAPI; /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ secret?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_secret; /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ serviceAccountToken?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_serviceAccountToken; } /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_configMap { /** If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_configMap_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_downwardAPI { /** Items is a list of DownwardAPIVolume file */ items?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_downwardAPI_items { /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_downwardAPI_items_resourceFieldRef; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_secret { /** If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_secret_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_secret_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ interface SGShardedCluster_spec_shards_pods_customVolumes_projected_sources_serviceAccountToken { /** Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. */ audience?: string; /** * ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. * @format int64 */ expirationSeconds?: number; /** Path is the path relative to the mount point of the file to project the token into. */ path: string; } /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_shards_pods_customVolumes_secret { /** * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_shards_pods_customVolumes_secret_items[]; /** Specify whether the Secret or its keys must be defined */ optional?: boolean; /** Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ secretName?: string; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_shards_pods_customVolumes_secret_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** * A custom application init container that run within the cluster's Pods. The custom init * containers will run following the defined sequence as the end of cluster's Pods init * containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ interface SGShardedCluster_spec_shards_pods_customInitContainers { /** Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: SGShardedCluster_spec_shards_pods_customInitContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: SGShardedCluster_spec_shards_pods_customInitContainers_envFrom[]; /** Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ lifecycle?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ livenessProbe?: SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe; /** * Name of the container specified as a DNS_LABEL. Each * container in a pod must have a unique name (DNS_LABEL). Cannot * be updated. * * The name will be prefixed with the string `custom-` so that when referencing it * in the .spec.containers section of SGInstanceProfile the name used have to be * prepended with the same prefix. * */ name: string; /** List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. */ ports?: SGShardedCluster_spec_shards_pods_customInitContainers_ports[]; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ readinessProbe?: SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe; /** ResourceRequirements describes the compute resource requirements. */ resources?: SGShardedCluster_spec_shards_pods_customInitContainers_resources; /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ securityContext?: SGShardedCluster_spec_shards_pods_customInitContainers_securityContext; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ startupProbe?: SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: SGShardedCluster_spec_shards_pods_customInitContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: SGShardedCluster_spec_shards_pods_customInitContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** EnvVarSource represents a source for the value of an EnvVar. */ valueFrom?: SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom { /** Selects a key from a ConfigMap. */ configMapKeyRef?: SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom_configMapKeyRef; /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom_fieldRef; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom_resourceFieldRef; /** SecretKeySelector selects a key of a Secret. */ secretKeyRef?: SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom_secretKeyRef; } /** Selects a key from a ConfigMap. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** SecretKeySelector selects a key of a Secret. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface SGShardedCluster_spec_shards_pods_customInitContainers_envFrom { /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ configMapRef?: SGShardedCluster_spec_shards_pods_customInitContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ secretRef?: SGShardedCluster_spec_shards_pods_customInitContainers_envFrom_secretRef; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle { /** Handler defines a specific action that should be taken */ postStart?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart; /** Handler defines a specific action that should be taken */ preStop?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customInitContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customInitContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ContainerPort represents a network port in a single container. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */ protocol?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customInitContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ResourceRequirements describes the compute resource requirements. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_resources { /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN */ allowPrivilegeEscalation?: boolean; /** Adds and removes POSIX capabilities from running containers. */ capabilities?: SGShardedCluster_spec_shards_pods_customInitContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsUser?: number; /** SELinuxOptions are the labels to be applied to the container */ seLinuxOptions?: SGShardedCluster_spec_shards_pods_customInitContainers_securityContext_seLinuxOptions; /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ seccompProfile?: SGShardedCluster_spec_shards_pods_customInitContainers_securityContext_seccompProfile; /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ windowsOptions?: SGShardedCluster_spec_shards_pods_customInitContainers_securityContext_windowsOptions; } /** Adds and removes POSIX capabilities from running containers. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** SELinuxOptions are the labels to be applied to the container */ interface SGShardedCluster_spec_shards_pods_customInitContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customInitContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface SGShardedCluster_spec_shards_pods_customInitContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * A custom application init container that run within the cluster's Pods. The custom init * containers will run following the defined sequence as the end of cluster's Pods init * containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ interface SGShardedCluster_spec_shards_pods_customContainers { /** Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: SGShardedCluster_spec_shards_pods_customContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: SGShardedCluster_spec_shards_pods_customContainers_envFrom[]; /** Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ lifecycle?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ livenessProbe?: SGShardedCluster_spec_shards_pods_customContainers_livenessProbe; /** * Name of the container specified as a DNS_LABEL. Each * container in a pod must have a unique name (DNS_LABEL). Cannot * be updated. * * The name will be prefixed with the string `custom-` so that when referencing it * in the .spec.containers section of SGInstanceProfile the name used have to be * prepended with the same prefix. * */ name: string; /** List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. */ ports?: SGShardedCluster_spec_shards_pods_customContainers_ports[]; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ readinessProbe?: SGShardedCluster_spec_shards_pods_customContainers_readinessProbe; /** ResourceRequirements describes the compute resource requirements. */ resources?: SGShardedCluster_spec_shards_pods_customContainers_resources; /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ securityContext?: SGShardedCluster_spec_shards_pods_customContainers_securityContext; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ startupProbe?: SGShardedCluster_spec_shards_pods_customContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: SGShardedCluster_spec_shards_pods_customContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: SGShardedCluster_spec_shards_pods_customContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface SGShardedCluster_spec_shards_pods_customContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** EnvVarSource represents a source for the value of an EnvVar. */ valueFrom?: SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom { /** Selects a key from a ConfigMap. */ configMapKeyRef?: SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom_configMapKeyRef; /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom_fieldRef; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom_resourceFieldRef; /** SecretKeySelector selects a key of a Secret. */ secretKeyRef?: SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom_secretKeyRef; } /** Selects a key from a ConfigMap. */ interface SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** SecretKeySelector selects a key of a Secret. */ interface SGShardedCluster_spec_shards_pods_customContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface SGShardedCluster_spec_shards_pods_customContainers_envFrom { /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ configMapRef?: SGShardedCluster_spec_shards_pods_customContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ secretRef?: SGShardedCluster_spec_shards_pods_customContainers_envFrom_secretRef; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_shards_pods_customContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_shards_pods_customContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle { /** Handler defines a specific action that should be taken */ postStart?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart; /** Handler defines a specific action that should be taken */ preStop?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_pods_customContainers_livenessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customContainers_livenessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ContainerPort represents a network port in a single container. */ interface SGShardedCluster_spec_shards_pods_customContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */ protocol?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_pods_customContainers_readinessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customContainers_readinessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ResourceRequirements describes the compute resource requirements. */ interface SGShardedCluster_spec_shards_pods_customContainers_resources { /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SGShardedCluster_spec_shards_pods_customContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN */ allowPrivilegeEscalation?: boolean; /** Adds and removes POSIX capabilities from running containers. */ capabilities?: SGShardedCluster_spec_shards_pods_customContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsUser?: number; /** SELinuxOptions are the labels to be applied to the container */ seLinuxOptions?: SGShardedCluster_spec_shards_pods_customContainers_securityContext_seLinuxOptions; /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ seccompProfile?: SGShardedCluster_spec_shards_pods_customContainers_securityContext_seccompProfile; /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ windowsOptions?: SGShardedCluster_spec_shards_pods_customContainers_securityContext_windowsOptions; } /** Adds and removes POSIX capabilities from running containers. */ interface SGShardedCluster_spec_shards_pods_customContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** SELinuxOptions are the labels to be applied to the container */ interface SGShardedCluster_spec_shards_pods_customContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SGShardedCluster_spec_shards_pods_customContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface SGShardedCluster_spec_shards_pods_customContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_pods_customContainers_startupProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_pods_customContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_pods_customContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_pods_customContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_pods_customContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_pods_customContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_pods_customContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_pods_customContainers_startupProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_pods_customContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface SGShardedCluster_spec_shards_pods_customContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface SGShardedCluster_spec_shards_pods_customContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * Shards custom configurations. * */ interface SGShardedCluster_spec_shards_configurations { /** * Name of the [SGPostgresConfig](https://stackgres.io/doc/latest/reference/crd/sgpgconfig) used for the cluster. It must exist. When not set, a default Postgres config, for the major version selected, is used. * */ sgPostgresConfig?: string; /** * Name of the [SGPoolingConfig](https://stackgres.io/doc/latest/reference/crd/sgpoolconfig) used for this cluster. Each pod contains a sidecar with a connection pooler (currently: [PgBouncer](https://www.pgbouncer.org/)). The connection pooler is implemented as a sidecar. * * If not set, a default configuration will be used. Disabling connection pooling altogether is possible if the disableConnectionPooling property of the pods object is set to true. * */ sgPoolingConfig?: string; } /** * This section allows to configure the global Postgres replication mode. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ interface SGShardedCluster_spec_shards_replication { /** * The replication mode applied to the whole cluster. * Possible values are: * * `async` (default) * * `sync` * * `strict-sync` * * `sync-all` * * `strict-sync-all` * * ### `async` Mode * * When in asynchronous mode the cluster is allowed to lose some committed transactions. * When the primary server fails or becomes unavailable for any other reason a sufficiently healthy standby * will automatically be promoted to primary. Any transactions that have not been replicated to that standby * remain in a "forked timeline" on the primary, and are effectively unrecoverable (the data is still there, * but recovering it requires a manual recovery effort by data recovery specialists). * * ### `sync` Mode * * When in synchronous mode a standby will not be promoted unless it is certain that the standby contains all * transactions that may have returned a successful commit status to client (clients can change the behavior * per transaction using PostgreSQL’s `synchronous_commit` setting. Transactions with `synchronous_commit` * values of `off` and `local` may be lost on fail over, but will not be blocked by replication delays). This * means that the system may be unavailable for writes even though some servers are available. System * administrators can still use manual failover commands to promote a standby even if it results in transaction * loss. * * Synchronous mode does not guarantee multi node durability of commits under all circumstances. When no suitable * standby is available, primary server will still accept writes, but does not guarantee their replication. When * the primary fails in this mode no standby will be promoted. When the host that used to be the primary comes * back it will get promoted automatically, unless system administrator performed a manual failover. This behavior * makes synchronous mode usable with 2 node clusters. * * When synchronous mode is used and a standby crashes, commits will block until the primary is switched to standalone * mode. Manually shutting down or restarting a standby will not cause a commit service interruption. Standby will * signal the primary to release itself from synchronous standby duties before PostgreSQL shutdown is initiated. * * ### `strict-sync` Mode * * When it is absolutely necessary to guarantee that each write is stored durably on at least two nodes, use the strict * synchronous mode. This mode prevents synchronous replication to be switched off on the primary when no synchronous * standby candidates are available. As a downside, the primary will not be available for writes (unless the Postgres * transaction explicitly turns off `synchronous_mode` parameter), blocking all client write requests until at least one * synchronous replica comes up. * * **Note**: Because of the way synchronous replication is implemented in PostgreSQL it is still possible to lose * transactions even when using strict synchronous mode. If the PostgreSQL backend is cancelled while waiting to acknowledge * replication (as a result of packet cancellation due to client timeout or backend failure) transaction changes become * visible for other backends. Such changes are not yet replicated and may be lost in case of standby promotion. * * ### `sync-all` Mode * * The same as `sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * * ### `strict-sync-all` Mode * * The same as `strict-sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * */ mode?: string; /** * Number of synchronous standby instances. Must be less than the total number of instances. It is set to 1 by default. * Only setteable if mode is `sync` or `strict-sync`. * */ syncInstances?: number; } /** Metadata information from shards cluster created resources. */ interface SGShardedCluster_spec_shards_metadata { /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ annotations?: SGShardedCluster_spec_shards_metadata_annotations; /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ labels?: SGShardedCluster_spec_shards_metadata_labels; } /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ interface SGShardedCluster_spec_shards_metadata_annotations { /** Annotations to attach to any resource created or managed by StackGres. */ allResources?: Record; /** Annotations to attach to pods created or managed by StackGres. */ clusterPods?: Record; /** Annotations to attach to all services created or managed by StackGres. */ services?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-primary` service. */ primaryService?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-replicas` service. */ replicasService?: Record; } /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ interface SGShardedCluster_spec_shards_metadata_labels { /** Labels to attach to Pods created or managed by StackGres. */ clusterPods?: Record; /** Labels to attach to Services and Endpoints created or managed by StackGres. */ services?: Record; } /** * Any shard can be overriden by this section. * */ interface SGShardedCluster_spec_shards_overrides { /** * Identifier of the shard StackGres cluster to override (starting from 0) * */ index: number; /** * Number of StackGres instances per shard's StackGres cluster. Each instance contains one Postgres server. * Out of all of the Postgres servers, one is elected as the primary, the rest remain as read-only replicas. * */ instancesPerCluster?: number; /** * Name of the [SGInstanceProfile](https://stackgres.io/doc/latest/04-postgres-cluster-management/03-resource-profiles/). A SGInstanceProfile defines CPU and memory limits. Must exist before creating a cluster. When no profile is set, a default (currently: 1 core, 2 GiB RAM) one is used. * */ sgInstanceProfile?: string; /** * This section allows to reference SQL scripts that will be applied to the cluster live. * */ managedSql?: SGShardedCluster_spec_shards_overrides_managedSql; /** Cluster pod's configuration. */ pods?: SGShardedCluster_spec_shards_overrides_pods; /** * Shards custom configurations. * */ configurations?: SGShardedCluster_spec_shards_overrides_configurations; /** * This section allows to configure the global Postgres replication mode. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ replication?: SGShardedCluster_spec_shards_overrides_replication; /** Metadata information from shards cluster created resources. */ metadata?: SGShardedCluster_spec_shards_overrides_metadata; } /** * This section allows to reference SQL scripts that will be applied to the cluster live. * */ interface SGShardedCluster_spec_shards_overrides_managedSql { /** If true, when any entry of any `SGScript` fail will not prevent subsequent `SGScript` from being executed. By default is `false`. */ continueOnSGScriptError?: boolean; /** * A list of script references that will be executed in sequence. * */ scripts?: SGShardedCluster_spec_shards_overrides_managedSql_scripts[]; } /** * A script reference. Each version of each entry of the script referenced will be executed exactly once following the sequence defined * in the referenced script and skipping any script entry that have already been executed. * */ interface SGShardedCluster_spec_shards_overrides_managedSql_scripts { /** The id is immutable and must be unique across all the `SGScript` entries. It is replaced by the operator and is used to identify the `SGScript` entry. */ id?: number; /** A reference to an `SGScript` */ sgScript?: string; } /** Cluster pod's configuration. */ interface SGShardedCluster_spec_shards_overrides_pods { /** Pod's persistent volume configuration. */ persistentVolume?: SGShardedCluster_spec_shards_overrides_pods_persistentVolume; /** If set to `true`, avoids creating a connection pooling (using [PgBouncer](https://www.pgbouncer.org/)) sidecar. */ disableConnectionPooling?: boolean; /** If set to `true`, avoids creating the Prometheus exporter sidecar. Recommended when there's no intention to use Prometheus for monitoring. */ disableMetricsExporter?: boolean; /** If set to `true`, avoids creating the `postgres-util` sidecar. This sidecar contains usual Postgres administration utilities *that are not present in the main (`patroni`) container*, like `psql`. Only disable if you know what you are doing. */ disablePostgresUtil?: boolean; /** Pod custom resources configuration. */ resources?: SGShardedCluster_spec_shards_overrides_pods_resources; /** Pod custom scheduling, affinity and topology spread constratins configuration. */ scheduling?: SGShardedCluster_spec_shards_overrides_pods_scheduling; /** * managementPolicy controls how pods are created during initial scale up, when replacing pods * on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created * in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is * ready before continuing. When scaling down, the pods are removed in the opposite order. * The alternative policy is `Parallel` which will create pods in parallel to match the desired * scale without waiting, and on scale down will delete all pods at once. * */ managementPolicy?: string; /** * A list of custom volumes that may be used along with any container defined in * customInitContainers or customContainers sections for the shards. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the customInitContainers or customContainers sections the name used * have to be prepended with the same prefix. * * Only the following volume types are allowed: configMap, downwardAPI, emptyDir, * gitRepo, glusterfs, hostPath, nfs, projected and secret * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core * */ customVolumes?: SGShardedCluster_spec_shards_overrides_pods_customVolumes[]; /** * A list of custom application init containers that run within the coordinator cluster's Pods. The * custom init containers will run following the defined sequence as the end of * cluster's Pods init containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ customInitContainers?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers[]; /** * A list of custom application containers that run within the shards cluster's Pods. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ customContainers?: SGShardedCluster_spec_shards_overrides_pods_customContainers[]; } /** Pod's persistent volume configuration. */ interface SGShardedCluster_spec_shards_overrides_pods_persistentVolume { /** * Size of the PersistentVolume set for each instance of the cluster. This size is specified either in Mebibytes, Gibibytes or Tebibytes (multiples of 2^20, 2^30 or 2^40, respectively). * * @pattern ^[0-9]+(\.[0-9]+)?(Mi|Gi|Ti)$ */ size: string; /** * Name of an existing StorageClass in the Kubernetes cluster, used to create the PersistentVolumes for the instances of the cluster. * */ storageClass?: string; } /** Pod custom resources configuration. */ interface SGShardedCluster_spec_shards_overrides_pods_resources { /** When enabled resource limits for containers other than the patroni container wil be set just like for patroni contianer as specified in the SGInstanceProfile. */ enableClusterLimitsRequirements?: boolean; } /** Pod custom scheduling, affinity and topology spread constratins configuration. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling { /** * NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ * */ nodeSelector?: Record; /** * If specified, the pod's tolerations. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ tolerations?: SGShardedCluster_spec_shards_overrides_pods_scheduling_tolerations[]; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity; /** * TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. * */ topologySpreadConstraints?: SGShardedCluster_spec_shards_overrides_pods_scheduling_topologySpreadConstraints[]; /** Backup Pod custom scheduling and affinity configuration. */ backup?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup; } /** * The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#toleration-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_tolerations { /** * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. * * */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. * * */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * TopologySpreadConstraint specifies how to spread matching pods among the given topology. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#topologyspreadconstraint-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_topologySpreadConstraints { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_topologySpreadConstraints_labelSelector; /** MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. */ matchLabelKeys?: string[]; /** * MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. * @format int32 */ maxSkew: number; /** * MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. * * For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. * * This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default). * @format int32 */ minDomains?: number; /** * NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. * * If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeAffinityPolicy?: string; /** * NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. * * If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeTaintsPolicy?: string; /** TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. */ topologyKey: string; /** * WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, * but giving higher precedence to topologies that would help reduce the * skew. * A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. * * */ whenUnsatisfiable: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_topologySpreadConstraints_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_topologySpreadConstraints_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_topologySpreadConstraints_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Backup Pod custom scheduling and affinity configuration. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup { /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ tolerations?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations; /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ nodeAffinity?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity; /** * Priority indicates the importance of a Pod relative to other Pods. If a Pod cannot be scheduled, the scheduler tries to preempt (evict) lower priority Pods to make scheduling of the pending Pod possible. * */ priorityClassName?: string; /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ podAffinity?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity; /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ podAntiAffinity?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeSelector_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_tolerations_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Node affinity is a group of node affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#nodeaffinity-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ preference: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** * Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. * * */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod affinity is a group of inter pod affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podaffinity-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * Pod anti affinity is a group of inter pod anti affinity scheduling rules. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#podantiaffinity-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ podAffinityTerm: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ labelSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ namespaceSelector?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface SGShardedCluster_spec_shards_overrides_pods_scheduling_backup_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * A custom volume that may be used along with any container defined in * customInitContainers or customContainers sections. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the customInitContainers or customContainers sections the name used * have to be prepended with the same prefix. * * Only the following volume types are allowed: configMap, downwardAPI, emptyDir, * gitRepo, glusterfs, hostPath, nfs, projected and secret * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#volume-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes { /** * Volumes name. Must be a DNS_LABEL and unique within the pod. * More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names * * The name will be prefixed with the string `custom-` so that when referencing them in the * customInitContainers or customContainers sections the name used have to be prepended with * the same prefix. * */ name?: string; /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ configMap?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_configMap; /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ downwardAPI?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_downwardAPI; /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ emptyDir?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_emptyDir; /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ gitRepo?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_gitRepo; /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ glusterfs?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_glusterfs; /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ hostPath?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_hostPath; /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ nfs?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_nfs; /** Represents a projected volume source */ projected?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected; /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ secret?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_secret; } /** * Adapts a ConfigMap into a volume. * * The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_configMap { /** * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_configMap_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_downwardAPI { /** * Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** Items is a list of downward API volume file */ items?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_downwardAPI_items { /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_downwardAPI_items_resourceFieldRef; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_emptyDir { /** What type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ medium?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ sizeLimit?: string; } /** * Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. * * DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_gitRepo { /** Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */ directory?: string; /** Repository URL */ repository: string; /** Commit hash for the specified revision. */ revision?: string; } /** Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_glusterfs { /** EndpointsName is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ endpoints: string; /** Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ path: string; /** ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ readOnly?: boolean; } /** Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_hostPath { /** Path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ path: string; /** Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ type?: string; } /** Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_nfs { /** Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ path: string; /** ReadOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ readOnly?: boolean; /** Server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ server: string; } /** Represents a projected volume source */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected { /** * Mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** list of volume projections */ sources?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources[]; } /** Projection that may be projected along with other supported volume types */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources { /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ configMap?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_configMap; /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ downwardAPI?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_downwardAPI; /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ secret?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_secret; /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ serviceAccountToken?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_serviceAccountToken; } /** * Adapts a ConfigMap into a projected volume. * * The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_configMap { /** If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_configMap_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_downwardAPI { /** Items is a list of DownwardAPIVolume file */ items?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_downwardAPI_items { /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_downwardAPI_items_resourceFieldRef; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** * Adapts a secret into a projected volume. * * The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_secret { /** If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_secret_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_secret_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise). */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_projected_sources_serviceAccountToken { /** Audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. */ audience?: string; /** * ExpirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. * @format int64 */ expirationSeconds?: number; /** Path is the path relative to the mount point of the file to project the token into. */ path: string; } /** * Adapts a Secret into a volume. * * The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_secret { /** * Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: SGShardedCluster_spec_shards_overrides_pods_customVolumes_secret_items[]; /** Specify whether the Secret or its keys must be defined */ optional?: boolean; /** Name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ secretName?: string; } /** Maps a string key to a path within a volume. */ interface SGShardedCluster_spec_shards_overrides_pods_customVolumes_secret_items { /** The key to project. */ key: string; /** * Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** The relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** * A custom application init container that run within the cluster's Pods. The custom init * containers will run following the defined sequence as the end of cluster's Pods init * containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers { /** Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_envFrom[]; /** Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ lifecycle?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ livenessProbe?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe; /** * Name of the container specified as a DNS_LABEL. Each * container in a pod must have a unique name (DNS_LABEL). Cannot * be updated. * * The name will be prefixed with the string `custom-` so that when referencing it * in the .spec.containers section of SGInstanceProfile the name used have to be * prepended with the same prefix. * */ name: string; /** List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. */ ports?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_ports[]; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ readinessProbe?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe; /** ResourceRequirements describes the compute resource requirements. */ resources?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_resources; /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ securityContext?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ startupProbe?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** EnvVarSource represents a source for the value of an EnvVar. */ valueFrom?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom { /** Selects a key from a ConfigMap. */ configMapKeyRef?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom_configMapKeyRef; /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom_fieldRef; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom_resourceFieldRef; /** SecretKeySelector selects a key of a Secret. */ secretKeyRef?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom_secretKeyRef; } /** Selects a key from a ConfigMap. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** SecretKeySelector selects a key of a Secret. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_envFrom { /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ configMapRef?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ secretRef?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_envFrom_secretRef; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle { /** Handler defines a specific action that should be taken */ postStart?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart; /** Handler defines a specific action that should be taken */ preStop?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ContainerPort represents a network port in a single container. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */ protocol?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ResourceRequirements describes the compute resource requirements. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_resources { /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN */ allowPrivilegeEscalation?: boolean; /** Adds and removes POSIX capabilities from running containers. */ capabilities?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsUser?: number; /** SELinuxOptions are the labels to be applied to the container */ seLinuxOptions?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext_seLinuxOptions; /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ seccompProfile?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext_seccompProfile; /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ windowsOptions?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext_windowsOptions; } /** Adds and removes POSIX capabilities from running containers. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** SELinuxOptions are the labels to be applied to the container */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface SGShardedCluster_spec_shards_overrides_pods_customInitContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * A custom application init container that run within the cluster's Pods. The custom init * containers will run following the defined sequence as the end of cluster's Pods init * containers. * * The name used in this section will be prefixed with the string `custom-` so that when * referencing them in the .spec.containers section of SGInstanceProfile the name used * have to be prepended with the same prefix. * * See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#container-v1-core * */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers { /** Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: SGShardedCluster_spec_shards_overrides_pods_customContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: SGShardedCluster_spec_shards_overrides_pods_customContainers_envFrom[]; /** Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ lifecycle?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ livenessProbe?: SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe; /** * Name of the container specified as a DNS_LABEL. Each * container in a pod must have a unique name (DNS_LABEL). Cannot * be updated. * * The name will be prefixed with the string `custom-` so that when referencing it * in the .spec.containers section of SGInstanceProfile the name used have to be * prepended with the same prefix. * */ name: string; /** List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. */ ports?: SGShardedCluster_spec_shards_overrides_pods_customContainers_ports[]; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ readinessProbe?: SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe; /** ResourceRequirements describes the compute resource requirements. */ resources?: SGShardedCluster_spec_shards_overrides_pods_customContainers_resources; /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ securityContext?: SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext; /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ startupProbe?: SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: SGShardedCluster_spec_shards_overrides_pods_customContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: SGShardedCluster_spec_shards_overrides_pods_customContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** EnvVarSource represents a source for the value of an EnvVar. */ valueFrom?: SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom; } /** EnvVarSource represents a source for the value of an EnvVar. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom { /** Selects a key from a ConfigMap. */ configMapKeyRef?: SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom_configMapKeyRef; /** ObjectFieldSelector selects an APIVersioned field of an object. */ fieldRef?: SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom_fieldRef; /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ resourceFieldRef?: SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom_resourceFieldRef; /** SecretKeySelector selects a key of a Secret. */ secretKeyRef?: SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom_secretKeyRef; } /** Selects a key from a ConfigMap. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** ObjectFieldSelector selects an APIVersioned field of an object. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** ResourceFieldSelector represents container resources (cpu, memory) and their output format */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. * * The serialization format is: * * ::= * (Note that may be empty, from the "" case in .) * ::= 0 | 1 | ... | 9 ::= | ::= | . | . | . ::= "+" | "-" ::= | ::= | | ::= Ki | Mi | Gi | Ti | Pi | Ei * (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) * ::= m | "" | k | M | G | T | P | E * (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) * ::= "e" | "E" * * No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. * * When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. * * Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: * a. No precision is lost * b. No fractional digits will be emitted * c. The exponent (or suffix) is as large as possible. * The sign will be omitted unless the number is negative. * * Examples: * 1.5 will be serialized as "1500m" * 1.5Gi will be serialized as "1536Mi" * * Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. * * Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) * * This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. */ divisor?: string; /** Required: resource to select */ resource: string; } /** SecretKeySelector selects a key of a Secret. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_envFrom { /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ configMapRef?: SGShardedCluster_spec_shards_overrides_pods_customContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ secretRef?: SGShardedCluster_spec_shards_overrides_pods_customContainers_envFrom_secretRef; } /** * ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. * * The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** * SecretEnvSource selects a Secret to populate the environment variables with. * * The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle { /** Handler defines a specific action that should be taken */ postStart?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart; /** Handler defines a specific action that should be taken */ preStop?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Handler defines a specific action that should be taken */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop_exec; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop_httpGet; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop_tcpSocket; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ContainerPort represents a network port in a single container. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". */ protocol?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** ResourceRequirements describes the compute resource requirements. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_resources { /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN */ allowPrivilegeEscalation?: boolean; /** Adds and removes POSIX capabilities from running containers. */ capabilities?: SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. * @format int64 */ runAsUser?: number; /** SELinuxOptions are the labels to be applied to the container */ seLinuxOptions?: SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext_seLinuxOptions; /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ seccompProfile?: SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext_seccompProfile; /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ windowsOptions?: SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext_windowsOptions; } /** Adds and removes POSIX capabilities from running containers. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** SELinuxOptions are the labels to be applied to the container */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must only be set if type is "Localhost". */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** WindowsSecurityContextOptions contain Windows-specific options and credentials. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. This field is alpha-level and will only be honored by components that enable the WindowsHostProcessContainers feature flag. Setting this field without the feature flag will result in errors when validating the Pod. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe { /** ExecAction describes a "run in container" action. */ exec?: SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** HTTPGetAction describes an action based on HTTP Get requests. */ httpGet?: SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocketAction describes an action based on opening a socket */ tcpSocket?: SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** ExecAction describes a "run in container" action. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGetAction describes an action based on HTTP Get requests. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe_httpGet_httpHeaders { /** The header field name */ name: string; /** The header field value */ value: string; } /** TCPSocketAction describes an action based on opening a socket */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. * @format int-or-string */ port: string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface SGShardedCluster_spec_shards_overrides_pods_customContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * Shards custom configurations. * */ interface SGShardedCluster_spec_shards_overrides_configurations { /** * Name of the [SGPostgresConfig](https://stackgres.io/doc/latest/reference/crd/sgpgconfig) used for the cluster. It must exist. When not set, a default Postgres config, for the major version selected, is used. * */ sgPostgresConfig?: string; /** * Name of the [SGPoolingConfig](https://stackgres.io/doc/latest/reference/crd/sgpoolconfig) used for this cluster. Each pod contains a sidecar with a connection pooler (currently: [PgBouncer](https://www.pgbouncer.org/)). The connection pooler is implemented as a sidecar. * * If not set, a default configuration will be used. Disabling connection pooling altogether is possible if the disableConnectionPooling property of the pods object is set to true. * */ sgPoolingConfig?: string; } /** * This section allows to configure the global Postgres replication mode. * * The main replication group is implicit and contains the total number of instances less the sum of all * instances in other replication groups. * * The total number of instances is always specified by `.spec.instances`. * */ interface SGShardedCluster_spec_shards_overrides_replication { /** * The replication mode applied to the whole cluster. * Possible values are: * * `async` (default) * * `sync` * * `strict-sync` * * `sync-all` * * `strict-sync-all` * * ### `async` Mode * * When in asynchronous mode the cluster is allowed to lose some committed transactions. * When the primary server fails or becomes unavailable for any other reason a sufficiently healthy standby * will automatically be promoted to primary. Any transactions that have not been replicated to that standby * remain in a "forked timeline" on the primary, and are effectively unrecoverable (the data is still there, * but recovering it requires a manual recovery effort by data recovery specialists). * * ### `sync` Mode * * When in synchronous mode a standby will not be promoted unless it is certain that the standby contains all * transactions that may have returned a successful commit status to client (clients can change the behavior * per transaction using PostgreSQL’s `synchronous_commit` setting. Transactions with `synchronous_commit` * values of `off` and `local` may be lost on fail over, but will not be blocked by replication delays). This * means that the system may be unavailable for writes even though some servers are available. System * administrators can still use manual failover commands to promote a standby even if it results in transaction * loss. * * Synchronous mode does not guarantee multi node durability of commits under all circumstances. When no suitable * standby is available, primary server will still accept writes, but does not guarantee their replication. When * the primary fails in this mode no standby will be promoted. When the host that used to be the primary comes * back it will get promoted automatically, unless system administrator performed a manual failover. This behavior * makes synchronous mode usable with 2 node clusters. * * When synchronous mode is used and a standby crashes, commits will block until the primary is switched to standalone * mode. Manually shutting down or restarting a standby will not cause a commit service interruption. Standby will * signal the primary to release itself from synchronous standby duties before PostgreSQL shutdown is initiated. * * ### `strict-sync` Mode * * When it is absolutely necessary to guarantee that each write is stored durably on at least two nodes, use the strict * synchronous mode. This mode prevents synchronous replication to be switched off on the primary when no synchronous * standby candidates are available. As a downside, the primary will not be available for writes (unless the Postgres * transaction explicitly turns off `synchronous_mode` parameter), blocking all client write requests until at least one * synchronous replica comes up. * * **Note**: Because of the way synchronous replication is implemented in PostgreSQL it is still possible to lose * transactions even when using strict synchronous mode. If the PostgreSQL backend is cancelled while waiting to acknowledge * replication (as a result of packet cancellation due to client timeout or backend failure) transaction changes become * visible for other backends. Such changes are not yet replicated and may be lost in case of standby promotion. * * ### `sync-all` Mode * * The same as `sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * * ### `strict-sync-all` Mode * * The same as `strict-sync` but `syncInstances` is ignored and the number of synchronous instances is equals to the total number * of instances less one. * */ mode?: string; /** * Number of synchronous standby instances. Must be less than the total number of instances. It is set to 1 by default. * Only setteable if mode is `sync` or `strict-sync`. * */ syncInstances?: number; } /** Metadata information from shards cluster created resources. */ interface SGShardedCluster_spec_shards_overrides_metadata { /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ annotations?: SGShardedCluster_spec_shards_overrides_metadata_annotations; /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ labels?: SGShardedCluster_spec_shards_overrides_metadata_labels; } /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to be passed to resources created and managed by StackGres. */ interface SGShardedCluster_spec_shards_overrides_metadata_annotations { /** Annotations to attach to any resource created or managed by StackGres. */ allResources?: Record; /** Annotations to attach to pods created or managed by StackGres. */ clusterPods?: Record; /** Annotations to attach to all services created or managed by StackGres. */ services?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-primary` service. */ primaryService?: Record; /** Custom Kubernetes [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) passed to the `-replicas` service. */ replicasService?: Record; } /** Custom Kubernetes [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to be passed to resources created and managed by StackGres. */ interface SGShardedCluster_spec_shards_overrides_metadata_labels { /** Labels to attach to Pods created or managed by StackGres. */ clusterPods?: Record; /** Labels to attach to Services and Endpoints created or managed by StackGres. */ services?: Record; } /** StackGres features a functionality for all pods to send Postgres, Patroni and PgBouncer logs to a central (distributed) location, which is in turn another Postgres database. Logs can then be accessed via SQL interface or from the web UI. This section controls whether to enable this feature or not. If not enabled, logs are send to the pod's standard output. */ interface SGShardedCluster_spec_distributedLogs { /** * Name of the [SGDistributedLogs](https://stackgres.io/doc/latest/04-postgres-cluster-management/06-distributed-logs/) to use for this cluster. It must exist. * */ sgDistributedLogs?: string; /** * Define a retention window with the syntax ` (minutes|hours|days|months)` in which log entries are kept. * Log entries will be removed when they get older more than the double of the specified retention window. * * When this field is changed the retention will be applied only to log entries that are newer than the end of * the retention window previously specified. If no retention window was previously specified it is considered * to be of 7 days. This means that if previous retention window is of `7 days` new retention configuration will * apply after UTC timestamp calculated with: `SELECT date_trunc('days', now() at time zone 'UTC') - INTERVAL '7 days'`. * * @pattern ^[0-9]+ (minutes?|hours?|days?|months?) */ retention?: string; } /** */ interface SGShardedCluster_spec_nonProductionOptions { /** * It is a best practice, on non-containerized environments, when running production workloads, to run each database server on a different server (virtual or physical), i.e., not to co-locate more than one database server per host. * * The same best practice applies to databases on containers. By default, StackGres will not allow to run more than one StackGres pod on a given Kubernetes node. Set this property to true to allow more than one StackGres pod per node. * */ disableClusterPodAntiAffinity?: boolean; /** * It is a best practice, on containerized environments, when running production workloads, to enforce container's resources requirements. * * The same best practice applies to databases on containers. By default, StackGres will configure resource requirements for patroni container. Set this property to true to prevent StackGres from setting patroni container's resources requirement. * */ disablePatroniResourceRequirements?: boolean; /** * It is a best practice, on containerized environments, when running production workloads, to enforce container's resources requirements. * * By default, StackGres will configure resource requirements for all the containers. Set this property to true to prevent StackGres from setting container's resources requirements (except for patroni container, see `disablePatroniResourceRequirements`). * */ disableClusterResourceRequirements?: boolean; /** * On containerized environments, when running production workloads, enforcing container's cpu requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less cpu than it requires. It also allow to set [static CPU management policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) that allows to guarantee a pod the usage exclusive CPUs on the node. * * By default, StackGres will configure cpu requirements to have the same limit and request for the patroni container. Set this property to true to prevent StackGres from setting patroni container's cpu requirements request equals to the limit * when `.spec.requests.cpu` is configured in the referenced `SGInstanceProfile`. * */ enableSetPatroniCpuRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's cpu requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less cpu than it requires. It also allow to set [static CPU management policy](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#static-policy) that allows to guarantee a pod the usage exclusive CPUs on the node. * * By default, StackGres will configure cpu requirements to have the same limit and request for all the containers. Set this property to true to prevent StackGres from setting container's cpu requirements request equals to the limit (except for patroni container, see `enablePatroniCpuRequests`) * when `.spec.requests.containers..cpu` `.spec.requests.initContainers..cpu` is configured in the referenced `SGInstanceProfile`. * */ enableSetClusterCpuRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's memory requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less memory than it requires. * * By default, StackGres will configure memory requirements to have the same limit and request for the patroni container. Set this property to true to prevent StackGres from setting patroni container's memory requirements request equals to the limit * when `.spec.requests.memory` is configured in the referenced `SGInstanceProfile`. * */ enableSetPatroniMemoryRequests?: boolean; /** * On containerized environments, when running production workloads, enforcing container's memory requirements request to be equals to the limit allow to achieve the highest level of performance. Doing so, reduces the chances of leaving * the workload with less memory than it requires. * * By default, StackGres will configure memory requirements to have the same limit and request for all the containers. Set this property to true to prevent StackGres from setting container's memory requirements request equals to the limit (except for patroni container, see `enablePatroniCpuRequests`) * when `.spec.requests.containers..memory` `.spec.requests.initContainers..memory` is configured in the referenced `SGInstanceProfile`. * */ enableSetClusterMemoryRequests?: boolean; /** * A list of StackGres feature gates to enable (not suitable for a production environment). * * Available feature gates are: * * `babelfish-flavor`: Allow to use `babelfish` flavor. * */ enabledFeatureGates?: string[]; } /** */ interface SGShardedCluster_status { /** */ conditions?: SGShardedCluster_status_conditions[]; /** The list of cluster statuses. */ clusterStatuses?: SGShardedCluster_status_clusterStatuses[]; /** The list of Postgres extensions to install */ toInstallPostgresExtensions?: SGShardedCluster_status_toInstallPostgresExtensions[]; } /** */ interface SGShardedCluster_status_conditions { /** Last time the condition transitioned from one status to another. */ lastTransitionTime?: string; /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status?: string; /** Type of deployment condition. */ type?: string; } /** */ interface SGShardedCluster_status_clusterStatuses { /** The name of the cluster. */ name: string; /** Indicates if the cluster requires restart */ pendingRestart?: boolean; } /** */ interface SGShardedCluster_status_toInstallPostgresExtensions { /** The name of the extension to install. */ name: string; /** The id of the publisher of the extension to install. */ publisher: string; /** The version of the extension to install. */ version: string; /** The repository base URL from where the extension will be installed from. */ repository: string; /** The postgres major version of the extension to install. */ postgresVersion: string; /** The build version of the extension to install. */ build?: string; /** The extra mounts of the extension to install. */ extraMounts?: string[]; } } export declare namespace sh.keda.v1alpha1 { /** ClusterTriggerAuthentication defines how a trigger can authenticate globally */ interface ClusterTriggerAuthentication { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: object; /** TriggerAuthenticationSpec defines the various ways to authenticate */ spec: ClusterTriggerAuthentication_spec; /** TriggerAuthenticationStatus defines the observed state of TriggerAuthentication */ status?: ClusterTriggerAuthentication_status; } /** TriggerAuthenticationSpec defines the various ways to authenticate */ interface ClusterTriggerAuthentication_spec { /** AzureKeyVault is used to authenticate using Azure Key Vault */ azureKeyVault?: ClusterTriggerAuthentication_spec_azureKeyVault; /** */ env?: ClusterTriggerAuthentication_spec_env[]; /** HashiCorpVault is used to authenticate using Hashicorp Vault */ hashiCorpVault?: ClusterTriggerAuthentication_spec_hashiCorpVault; /** AuthPodIdentity allows users to select the platform native identity mechanism */ podIdentity?: ClusterTriggerAuthentication_spec_podIdentity; /** */ secretTargetRef?: ClusterTriggerAuthentication_spec_secretTargetRef[]; } /** AzureKeyVault is used to authenticate using Azure Key Vault */ interface ClusterTriggerAuthentication_spec_azureKeyVault { /** */ cloud?: ClusterTriggerAuthentication_spec_azureKeyVault_cloud; /** */ credentials?: ClusterTriggerAuthentication_spec_azureKeyVault_credentials; /** AuthPodIdentity allows users to select the platform native identity mechanism */ podIdentity?: ClusterTriggerAuthentication_spec_azureKeyVault_podIdentity; /** */ secrets: ClusterTriggerAuthentication_spec_azureKeyVault_secrets[]; /** */ vaultUri: string; } /** */ interface ClusterTriggerAuthentication_spec_azureKeyVault_cloud { /** */ activeDirectoryEndpoint?: string; /** */ keyVaultResourceURL?: string; /** */ type: string; } /** */ interface ClusterTriggerAuthentication_spec_azureKeyVault_credentials { /** */ clientId: string; /** */ clientSecret: ClusterTriggerAuthentication_spec_azureKeyVault_credentials_clientSecret; /** */ tenantId: string; } /** */ interface ClusterTriggerAuthentication_spec_azureKeyVault_credentials_clientSecret { /** */ valueFrom: ClusterTriggerAuthentication_spec_azureKeyVault_credentials_clientSecret_valueFrom; } /** */ interface ClusterTriggerAuthentication_spec_azureKeyVault_credentials_clientSecret_valueFrom { /** */ secretKeyRef: ClusterTriggerAuthentication_spec_azureKeyVault_credentials_clientSecret_valueFrom_secretKeyRef; } /** */ interface ClusterTriggerAuthentication_spec_azureKeyVault_credentials_clientSecret_valueFrom_secretKeyRef { /** */ key: string; /** */ name: string; } /** AuthPodIdentity allows users to select the platform native identity mechanism */ interface ClusterTriggerAuthentication_spec_azureKeyVault_podIdentity { /** */ identityId?: string; /** PodIdentityProvider contains the list of providers */ provider: string; } /** */ interface ClusterTriggerAuthentication_spec_azureKeyVault_secrets { /** */ name: string; /** */ parameter: string; /** */ version?: string; } /** AuthEnvironment is used to authenticate using environment variables in the destination ScaleTarget spec */ interface ClusterTriggerAuthentication_spec_env { /** */ containerName?: string; /** */ name: string; /** */ parameter: string; } /** HashiCorpVault is used to authenticate using Hashicorp Vault */ interface ClusterTriggerAuthentication_spec_hashiCorpVault { /** */ address: string; /** VaultAuthentication contains the list of Hashicorp Vault authentication methods */ authentication: string; /** Credential defines the Hashicorp Vault credentials depending on the authentication method */ credential?: ClusterTriggerAuthentication_spec_hashiCorpVault_credential; /** */ mount?: string; /** */ namespace?: string; /** */ role?: string; /** */ secrets: ClusterTriggerAuthentication_spec_hashiCorpVault_secrets[]; } /** Credential defines the Hashicorp Vault credentials depending on the authentication method */ interface ClusterTriggerAuthentication_spec_hashiCorpVault_credential { /** */ serviceAccount?: string; /** */ token?: string; } /** VaultSecret defines the mapping between the path of the secret in Vault to the parameter */ interface ClusterTriggerAuthentication_spec_hashiCorpVault_secrets { /** */ key: string; /** */ parameter: string; /** */ path: string; } /** AuthPodIdentity allows users to select the platform native identity mechanism */ interface ClusterTriggerAuthentication_spec_podIdentity { /** */ identityId?: string; /** PodIdentityProvider contains the list of providers */ provider: string; } /** AuthSecretTargetRef is used to authenticate using a reference to a secret */ interface ClusterTriggerAuthentication_spec_secretTargetRef { /** */ key: string; /** */ name: string; /** */ parameter: string; } /** TriggerAuthenticationStatus defines the observed state of TriggerAuthentication */ interface ClusterTriggerAuthentication_status { /** */ scaledjobs?: string; /** */ scaledobjects?: string; } /** ScaledJob is the Schema for the scaledjobs API */ interface ScaledJob { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: object; /** ScaledJobSpec defines the desired state of ScaledJob */ spec?: ScaledJob_spec; /** ScaledJobStatus defines the observed state of ScaledJob */ status?: ScaledJob_status; } /** ScaledJobSpec defines the desired state of ScaledJob */ interface ScaledJob_spec { /** */ envSourceContainerName?: string; /** @format int32 */ failedJobsHistoryLimit?: number; /** JobSpec describes how the job execution will look like. */ jobTargetRef: ScaledJob_spec_jobTargetRef; /** @format int32 */ maxReplicaCount?: number; /** @format int32 */ minReplicaCount?: number; /** @format int32 */ pollingInterval?: number; /** Rollout defines the strategy for job rollouts */ rollout?: ScaledJob_spec_rollout; /** */ rolloutStrategy?: string; /** ScalingStrategy defines the strategy of Scaling */ scalingStrategy?: ScaledJob_spec_scalingStrategy; /** @format int32 */ successfulJobsHistoryLimit?: number; /** */ triggers: ScaledJob_spec_triggers[]; } /** JobSpec describes how the job execution will look like. */ interface ScaledJob_spec_jobTargetRef { /** * Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at creation or through an update), this timer will effectively be stopped and reset when the Job is resumed again. * @format int64 */ activeDeadlineSeconds?: number; /** * Specifies the number of retries before marking this job failed. Defaults to 6 * @format int32 */ backoffLimit?: number; /** * Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's batch.kubernetes.io/job-index-failure-count annotation. It can only be set when Job's completionMode=Indexed, and the Pod's restart policy is Never. The field is immutable. This field is alpha-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (disabled by default). * @format int32 */ backoffLimitPerIndex?: number; /** * completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. * `NonIndexed` means that the Job is considered complete when there have been .spec.completions successfully completed Pods. Each Pod completion is homologous to each other. * `Indexed` means that the Pods of a Job get an associated completion index from 0 to (.spec.completions - 1), available in the annotation batch.kubernetes.io/job-completion-index. The Job is considered complete when there is one successfully completed Pod for each index. When value is `Indexed`, .spec.completions must be specified and `.spec.parallelism` must be less than or equal to 10^5. In addition, The Pod name takes the form `$(job-name)-$(index)-$(random-string)`, the Pod hostname takes the form `$(job-name)-$(index)`. * More completion modes can be added in the future. If the Job controller observes a mode that it doesn't recognize, which is possible during upgrades due to version skew, the controller skips updates for the Job. */ completionMode?: string; /** * Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ * @format int32 */ completions?: number; /** manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector */ manualSelector?: boolean; /** * Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as Failed and its execution is terminated. When left as null the job continues execution of all of its indexes and is marked with the `Complete` Job condition. It can only be specified when backoffLimitPerIndex is set. It can be null or up to completions. It is required and must be less than or equal to 10^4 when is completions greater than 10^5. This field is alpha-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (disabled by default). * @format int32 */ maxFailedIndexes?: number; /** * Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ * @format int32 */ parallelism?: number; /** * Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs's .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure. * This field is beta-level. It can be used when the `JobPodFailurePolicy` feature gate is enabled (enabled by default). */ podFailurePolicy?: ScaledJob_spec_jobTargetRef_podFailurePolicy; /** * podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp) or failed. - Failed means to wait until a previously created Pod is fully terminated (has phase Failed or Succeeded) before creating a replacement Pod. * When using podFailurePolicy, Failed is the the only allowed value. TerminatingOrFailed and Failed are allowed values when podFailurePolicy is not in use. This is an alpha field. Enable JobPodReplacementPolicy to be able to use this field. */ podReplacementPolicy?: string; /** A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors */ selector?: ScaledJob_spec_jobTargetRef_selector; /** suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation (i.e. the flag goes from false to true), the Job controller will delete all active Pods associated with this Job. Users must design their workload to gracefully handle this. Suspending a Job will reset the StartTime field of the Job, effectively resetting the ActiveDeadlineSeconds timer too. Defaults to false. */ suspend?: boolean; /** Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ */ template: ScaledJob_spec_jobTargetRef_template; /** * ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. * @format int32 */ ttlSecondsAfterFinished?: number; } /** * Specifies the policy of handling failed pods. In particular, it allows to specify the set of actions and conditions which need to be satisfied to take the associated action. If empty, the default behaviour applies - the counter of failed pods, represented by the jobs's .status.failed field, is incremented and it is checked against the backoffLimit. This field cannot be used in combination with restartPolicy=OnFailure. * This field is beta-level. It can be used when the `JobPodFailurePolicy` feature gate is enabled (enabled by default). */ interface ScaledJob_spec_jobTargetRef_podFailurePolicy { /** A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default handling applies - the counter of pod failures is incremented and it is checked against the backoffLimit. At most 20 elements are allowed. */ rules: ScaledJob_spec_jobTargetRef_podFailurePolicy_rules[]; } /** PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule. */ interface ScaledJob_spec_jobTargetRef_podFailurePolicy_rules { /** * Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are: * - FailJob: indicates that the pod's job is marked as Failed and all running pods are terminated. - FailIndex: indicates that the pod's index is marked as Failed and will not be restarted. This value is alpha-level. It can be used when the `JobBackoffLimitPerIndex` feature gate is enabled (disabled by default). - Ignore: indicates that the counter towards the .backoffLimit is not incremented and a replacement pod is created. - Count: indicates that the pod is handled in the default way - the counter towards the .backoffLimit is incremented. Additional values are considered to be added in the future. Clients should react to an unknown action by skipping the rule. */ action: string; /** Represents the requirement on the container exit codes. */ onExitCodes?: ScaledJob_spec_jobTargetRef_podFailurePolicy_rules_onExitCodes; /** Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod condition. At most 20 elements are allowed. */ onPodConditions?: ScaledJob_spec_jobTargetRef_podFailurePolicy_rules_onPodConditions[]; } /** Represents the requirement on the container exit codes. */ interface ScaledJob_spec_jobTargetRef_podFailurePolicy_rules_onExitCodes { /** Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in the pod template. */ containerName?: string; /** * Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are: * - In: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the 'containerName' field) is in the set of specified values. - NotIn: the requirement is satisfied if at least one container exit code (might be multiple if there are multiple containers not restricted by the 'containerName' field) is not in the set of specified values. Additional values are considered to be added in the future. Clients should react to an unknown operator by assuming the requirement is not satisfied. */ operator: string; /** Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of values must be ordered and must not contain duplicates. Value '0' cannot be used for the In operator. At least one element is required. At most 255 elements are allowed. */ values: number[]; } /** PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type. */ interface ScaledJob_spec_jobTargetRef_podFailurePolicy_rules_onPodConditions { /** Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True. */ status: string; /** Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type. */ type: string; } /** A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors */ interface ScaledJob_spec_jobTargetRef_selector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_selector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_selector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes the pod that will be created when executing a job. The only allowed template.spec.restartPolicy values are "Never" or "OnFailure". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ */ interface ScaledJob_spec_jobTargetRef_template { /** Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */ metadata?: object; /** Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ spec?: ScaledJob_spec_jobTargetRef_template_spec; } /** Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status */ interface ScaledJob_spec_jobTargetRef_template_spec { /** * Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. * @format int64 */ activeDeadlineSeconds?: number; /** If specified, the pod's scheduling constraints */ affinity?: ScaledJob_spec_jobTargetRef_template_spec_affinity; /** AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. */ automountServiceAccountToken?: boolean; /** List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. */ containers: ScaledJob_spec_jobTargetRef_template_spec_containers[]; /** Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. */ dnsConfig?: ScaledJob_spec_jobTargetRef_template_spec_dnsConfig; /** Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. */ dnsPolicy?: string; /** EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. */ enableServiceLinks?: boolean; /** List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. */ ephemeralContainers?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers[]; /** HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. */ hostAliases?: ScaledJob_spec_jobTargetRef_template_spec_hostAliases[]; /** Use the host's ipc namespace. Optional: Default to false. */ hostIPC?: boolean; /** Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. */ hostNetwork?: boolean; /** Use the host's pid namespace. Optional: Default to false. */ hostPID?: boolean; /** Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the host user namespace, such as loading a kernel module with CAP_SYS_MODULE. When set to false, a new userns is created for the pod. Setting false is useful for mitigating container breakout vulnerabilities even allowing users to run their containers as root without actually having root privileges on the host. This field is alpha-level and is only honored by servers that enable the UserNamespacesSupport feature. */ hostUsers?: boolean; /** Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. */ hostname?: string; /** ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod */ imagePullSecrets?: ScaledJob_spec_jobTargetRef_template_spec_imagePullSecrets[]; /** 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 or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ */ initContainers?: ScaledJob_spec_jobTargetRef_template_spec_initContainers[]; /** NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. */ nodeName?: string; /** NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ */ nodeSelector?: Record; /** * Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. * If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions * If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup */ os?: ScaledJob_spec_jobTargetRef_template_spec_os; /** Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md */ overhead?: Record; /** PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. */ preemptionPolicy?: string; /** * The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. * @format int32 */ priority?: number; /** If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. */ priorityClassName?: string; /** If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates */ readinessGates?: ScaledJob_spec_jobTargetRef_template_spec_readinessGates[]; /** * ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. * This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. * This field is immutable. */ resourceClaims?: ScaledJob_spec_jobTargetRef_template_spec_resourceClaims[]; /** Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy */ restartPolicy?: string; /** RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class */ runtimeClassName?: string; /** If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. */ schedulerName?: string; /** * SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not attempt to schedule the pod. * SchedulingGates can only be set at pod creation time, and be removed only afterwards. * This is a beta feature enabled by the PodSchedulingReadiness feature gate. */ schedulingGates?: ScaledJob_spec_jobTargetRef_template_spec_schedulingGates[]; /** SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. */ securityContext?: ScaledJob_spec_jobTargetRef_template_spec_securityContext; /** DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. */ serviceAccount?: string; /** ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ */ serviceAccountName?: string; /** If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\Tcpip\\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. */ setHostnameAsFQDN?: boolean; /** Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. */ shareProcessNamespace?: boolean; /** If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all. */ subdomain?: string; /** * Optional duration in seconds the pod 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 pod 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 30 seconds. * @format int64 */ terminationGracePeriodSeconds?: number; /** If specified, the pod's tolerations. */ tolerations?: ScaledJob_spec_jobTargetRef_template_spec_tolerations[]; /** TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. */ topologySpreadConstraints?: ScaledJob_spec_jobTargetRef_template_spec_topologySpreadConstraints[]; /** List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes */ volumes?: ScaledJob_spec_jobTargetRef_template_spec_volumes[]; } /** If specified, the pod's scheduling constraints */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity { /** Describes node affinity scheduling rules for the pod. */ nodeAffinity?: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity; /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ podAffinity?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity; /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ podAntiAffinity?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity; } /** Describes node affinity scheduling rules for the pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ requiredDuringSchedulingIgnoredDuringExecution?: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution; } /** An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** A node selector term, associated with the corresponding weight. */ preference: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference; /** * Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. * @format int32 */ weight: number; } /** A node selector term, associated with the corresponding weight. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference { /** A list of node selector requirements by node's labels. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchExpressions { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_preferredDuringSchedulingIgnoredDuringExecution_preference_matchFields { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** Required. A list of node selector terms. The terms are ORed. */ nodeSelectorTerms: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms[]; } /** A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms { /** A list of node selector requirements by node's labels. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions[]; /** A list of node selector requirements by node's fields. */ matchFields?: ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchExpressions { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_nodeAffinity_requiredDuringSchedulingIgnoredDuringExecution_nodeSelectorTerms_matchFields { /** The label key that the selector applies to. */ key: string; /** Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. */ operator: string; /** An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Required. A pod affinity term, associated with the corresponding weight. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label query over a set of resources, in this case pods. */ labelSelector?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity { /** The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. */ preferredDuringSchedulingIgnoredDuringExecution?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution[]; /** If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied. */ requiredDuringSchedulingIgnoredDuringExecution?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution[]; } /** The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution { /** Required. A pod affinity term, associated with the corresponding weight. */ podAffinityTerm: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm; /** * weight associated with matching the corresponding podAffinityTerm, in the range 1-100. * @format int32 */ weight: number; } /** Required. A pod affinity term, associated with the corresponding weight. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm { /** A label query over a set of resources, in this case pods. */ labelSelector?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_preferredDuringSchedulingIgnoredDuringExecution_podAffinityTerm_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution { /** A label query over a set of resources, in this case pods. */ labelSelector?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector; /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ namespaceSelector?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector; /** namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means "this pod's namespace". */ namespaces?: string[]; /** This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed. */ topologyKey: string; } /** A label query over a set of resources, in this case pods. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means "this pod's namespace". An empty selector ({}) matches all namespaces. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_affinity_podAntiAffinity_requiredDuringSchedulingIgnoredDuringExecution_namespaceSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** A single application container that you want to run within a pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers { /** Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: ScaledJob_spec_jobTargetRef_template_spec_containers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: ScaledJob_spec_jobTargetRef_template_spec_containers_envFrom[]; /** Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Actions that the management system should take in response to container lifecycle events. Cannot be updated. */ lifecycle?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle; /** Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ livenessProbe?: ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe; /** Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. */ name: string; /** List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. */ ports?: ScaledJob_spec_jobTargetRef_template_spec_containers_ports[]; /** Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ readinessProbe?: ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe; /** Resources resize policy for the container. */ resizePolicy?: ScaledJob_spec_jobTargetRef_template_spec_containers_resizePolicy[]; /** Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ resources?: ScaledJob_spec_jobTargetRef_template_spec_containers_resources; /** RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. */ restartPolicy?: string; /** SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ */ securityContext?: ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext; /** StartupProbe indicates that the Pod 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 Pod'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 */ startupProbe?: ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: ScaledJob_spec_jobTargetRef_template_spec_containers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: ScaledJob_spec_jobTargetRef_template_spec_containers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** Source for the environment variable's value. Cannot be used if value is not empty. */ valueFrom?: ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom; } /** Source for the environment variable's value. Cannot be used if value is not empty. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom { /** Selects a key of a ConfigMap. */ configMapKeyRef?: ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom_configMapKeyRef; /** Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. */ fieldRef?: ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom_fieldRef; /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. */ resourceFieldRef?: ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom_resourceFieldRef; /** Selects a key of a secret in the pod's namespace */ secretKeyRef?: ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom_secretKeyRef; } /** Selects a key of a ConfigMap. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Specifies the output format of the exposed resources, defaults to "1" * @pattern ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ */ divisor?: number | string; /** Required: resource to select */ resource: string; } /** Selects a key of a secret in the pod's namespace */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_envFrom { /** The ConfigMap to select from */ configMapRef?: ScaledJob_spec_jobTargetRef_template_spec_containers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** The Secret to select from */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_containers_envFrom_secretRef; } /** The ConfigMap to select from */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** The Secret to select from */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Actions that the management system should take in response to container lifecycle events. Cannot be updated. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle { /** PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ postStart?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart; /** PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ preStop?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop; } /** PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart_exec; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart_httpGet; /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart_tcpSocket; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop_exec; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop_httpGet; /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop_tcpSocket; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** ContainerPort represents a network port in a single container. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** * Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". * @default TCP */ protocol: string; } /** Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** ContainerResizePolicy represents resource resize policy for the container. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_resizePolicy { /** Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. */ resourceName: string; /** Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. */ restartPolicy: string; } /** Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_resources { /** * Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. * This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. * This field is immutable. It can only be set for containers. */ claims?: ScaledJob_spec_jobTargetRef_template_spec_containers_resources_claims[]; /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** ResourceClaim references one entry in PodSpec.ResourceClaims. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_resources_claims { /** Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. */ name: string; } /** SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. */ allowPrivilegeEscalation?: boolean; /** The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. */ capabilities?: ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsUser?: number; /** The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */ seLinuxOptions?: ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext_seLinuxOptions; /** The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. */ seccompProfile?: ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext_seccompProfile; /** The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ windowsOptions?: ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext_windowsOptions; } /** The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** StartupProbe indicates that the Pod 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 Pod'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 */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface ScaledJob_spec_jobTargetRef_template_spec_containers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. */ interface ScaledJob_spec_jobTargetRef_template_spec_dnsConfig { /** A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed. */ nameservers?: string[]; /** A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that appear in the base DNSPolicy. */ options?: ScaledJob_spec_jobTargetRef_template_spec_dnsConfig_options[]; /** A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed. */ searches?: string[]; } /** PodDNSConfigOption defines DNS resolver options of a pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_dnsConfig_options { /** Required. */ name?: string; /** */ value?: string; } /** * An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation. * To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers { /** Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_envFrom[]; /** Container image name. More info: https://kubernetes.io/docs/concepts/containers/images */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Lifecycle is not allowed for ephemeral containers. */ lifecycle?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle; /** Probes are not allowed for ephemeral containers. */ livenessProbe?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe; /** Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers. */ name: string; /** Ports are not allowed for ephemeral containers. */ ports?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_ports[]; /** Probes are not allowed for ephemeral containers. */ readinessProbe?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe; /** Resources resize policy for the container. */ resizePolicy?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_resizePolicy[]; /** Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. */ resources?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_resources; /** Restart policy for the container to manage the restart behavior of each container within a pod. This may only be set for init containers. You cannot set this field on ephemeral containers. */ restartPolicy?: string; /** Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. */ securityContext?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext; /** Probes are not allowed for ephemeral containers. */ startupProbe?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** * If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the ephemeral container uses the namespaces configured in the Pod spec. * The container runtime must implement support for this feature. If the runtime does not support namespace targeting then the result of setting this field is undefined. */ targetContainerName?: string; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated. */ volumeMounts?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** Source for the environment variable's value. Cannot be used if value is not empty. */ valueFrom?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom; } /** Source for the environment variable's value. Cannot be used if value is not empty. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom { /** Selects a key of a ConfigMap. */ configMapKeyRef?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom_configMapKeyRef; /** Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. */ fieldRef?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom_fieldRef; /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. */ resourceFieldRef?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom_resourceFieldRef; /** Selects a key of a secret in the pod's namespace */ secretKeyRef?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom_secretKeyRef; } /** Selects a key of a ConfigMap. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Specifies the output format of the exposed resources, defaults to "1" * @pattern ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ */ divisor?: number | string; /** Required: resource to select */ resource: string; } /** Selects a key of a secret in the pod's namespace */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_envFrom { /** The ConfigMap to select from */ configMapRef?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** The Secret to select from */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_envFrom_secretRef; } /** The ConfigMap to select from */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** The Secret to select from */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Lifecycle is not allowed for ephemeral containers. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle { /** PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ postStart?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart; /** PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ preStop?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop; } /** PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart_exec; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart_httpGet; /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart_tcpSocket; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop_exec; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop_httpGet; /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop_tcpSocket; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** Probes are not allowed for ephemeral containers. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** ContainerPort represents a network port in a single container. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** * Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". * @default TCP */ protocol: string; } /** Probes are not allowed for ephemeral containers. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** ContainerResizePolicy represents resource resize policy for the container. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_resizePolicy { /** Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. */ resourceName: string; /** Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. */ restartPolicy: string; } /** Resources are not allowed for ephemeral containers. Ephemeral containers use spare resources already allocated to the pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_resources { /** * Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. * This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. * This field is immutable. It can only be set for containers. */ claims?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_resources_claims[]; /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** ResourceClaim references one entry in PodSpec.ResourceClaims. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_resources_claims { /** Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. */ name: string; } /** Optional: SecurityContext defines the security options the ephemeral container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. */ allowPrivilegeEscalation?: boolean; /** The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. */ capabilities?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsUser?: number; /** The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */ seLinuxOptions?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext_seLinuxOptions; /** The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. */ seccompProfile?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext_seccompProfile; /** The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ windowsOptions?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext_windowsOptions; } /** The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** Probes are not allowed for ephemeral containers. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface ScaledJob_spec_jobTargetRef_template_spec_ephemeralContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. */ interface ScaledJob_spec_jobTargetRef_template_spec_hostAliases { /** Hostnames for the above IP address. */ hostnames?: string[]; /** IP address of the host file entry. */ ip?: string; } /** LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. */ interface ScaledJob_spec_jobTargetRef_template_spec_imagePullSecrets { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** A single application container that you want to run within a pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers { /** Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ args?: string[]; /** Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell */ command?: string[]; /** List of environment variables to set in the container. Cannot be updated. */ env?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_env[]; /** List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. */ envFrom?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_envFrom[]; /** Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. */ image?: string; /** Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images */ imagePullPolicy?: string; /** Actions that the management system should take in response to container lifecycle events. Cannot be updated. */ lifecycle?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle; /** Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ livenessProbe?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe; /** Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. */ name: string; /** List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated. */ ports?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_ports[]; /** Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ readinessProbe?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe; /** Resources resize policy for the container. */ resizePolicy?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_resizePolicy[]; /** Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ resources?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_resources; /** RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. */ restartPolicy?: string; /** SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ */ securityContext?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext; /** StartupProbe indicates that the Pod 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 Pod'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 */ startupProbe?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe; /** Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. */ stdin?: boolean; /** Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false */ stdinOnce?: boolean; /** Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. */ terminationMessagePath?: string; /** Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. */ terminationMessagePolicy?: string; /** Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. */ tty?: boolean; /** volumeDevices is the list of block devices to be used by the container. */ volumeDevices?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_volumeDevices[]; /** Pod volumes to mount into the container's filesystem. Cannot be updated. */ volumeMounts?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_volumeMounts[]; /** Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. */ workingDir?: string; } /** EnvVar represents an environment variable present in a Container. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_env { /** Name of the environment variable. Must be a C_IDENTIFIER. */ name: string; /** Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "". */ value?: string; /** Source for the environment variable's value. Cannot be used if value is not empty. */ valueFrom?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom; } /** Source for the environment variable's value. Cannot be used if value is not empty. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom { /** Selects a key of a ConfigMap. */ configMapKeyRef?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom_configMapKeyRef; /** Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. */ fieldRef?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom_fieldRef; /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. */ resourceFieldRef?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom_resourceFieldRef; /** Selects a key of a secret in the pod's namespace */ secretKeyRef?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom_secretKeyRef; } /** Selects a key of a ConfigMap. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom_configMapKeyRef { /** The key to select. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the ConfigMap or its key must be defined */ optional?: boolean; } /** Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['']`, `metadata.annotations['']`, spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Specifies the output format of the exposed resources, defaults to "1" * @pattern ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ */ divisor?: number | string; /** Required: resource to select */ resource: string; } /** Selects a key of a secret in the pod's namespace */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_env_valueFrom_secretKeyRef { /** The key of the secret to select from. Must be a valid secret key. */ key: string; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the Secret or its key must be defined */ optional?: boolean; } /** EnvFromSource represents the source of a set of ConfigMaps */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_envFrom { /** The ConfigMap to select from */ configMapRef?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_envFrom_configMapRef; /** An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. */ prefix?: string; /** The Secret to select from */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_envFrom_secretRef; } /** The ConfigMap to select from */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_envFrom_configMapRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the ConfigMap must be defined */ optional?: boolean; } /** The Secret to select from */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_envFrom_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** Specify whether the Secret must be defined */ optional?: boolean; } /** Actions that the management system should take in response to container lifecycle events. Cannot be updated. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle { /** PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ postStart?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart; /** PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ preStop?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop; } /** PostStart is called immediately after a container is created. If the handler fails, the container is terminated and restarted according to its restart policy. Other management of the container blocks until the hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart_exec; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart_httpGet; /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart_tcpSocket; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_postStart_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** PreStop is called immediately before a container is terminated due to an API request or management event such as liveness/startup probe failure, preemption, resource contention, etc. The handler is not called if the container crashes or exits. The Pod's termination grace period countdown begins before the PreStop hook is executed. Regardless of the outcome of the handler, the container will eventually terminate within the Pod's termination grace period (unless delayed by finalizers). Other management of the container blocks until the hook completes or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop_exec; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop_httpGet; /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop_tcpSocket; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept for the backward compatibility. There are no validation of this field and lifecycle hooks will fail in runtime when tcp handler is specified. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_lifecycle_preStop_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_livenessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** ContainerPort represents a network port in a single container. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_ports { /** * Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. * @format int32 */ containerPort: number; /** What host IP to bind the external port to. */ hostIP?: string; /** * Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this. * @format int32 */ hostPort?: number; /** If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services. */ name?: string; /** * Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". * @default TCP */ protocol: string; } /** Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_readinessProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** ContainerResizePolicy represents resource resize policy for the container. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_resizePolicy { /** Name of the resource to which this resource resize policy applies. Supported values: cpu, memory. */ resourceName: string; /** Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired. */ restartPolicy: string; } /** Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_resources { /** * Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. * This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. * This field is immutable. It can only be set for containers. */ claims?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_resources_claims[]; /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** ResourceClaim references one entry in PodSpec.ResourceClaims. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_resources_claims { /** Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. */ name: string; } /** SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext { /** AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN Note that this field cannot be set when spec.os.name is windows. */ allowPrivilegeEscalation?: boolean; /** The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. */ capabilities?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext_capabilities; /** Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows. */ privileged?: boolean; /** procMount denotes the type of proc mount to use for the containers. The default is DefaultProcMount which uses the container runtime defaults for readonly paths and masked paths. This requires the ProcMountType feature flag to be enabled. Note that this field cannot be set when spec.os.name is windows. */ procMount?: string; /** Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows. */ readOnlyRootFilesystem?: boolean; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsUser?: number; /** The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */ seLinuxOptions?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext_seLinuxOptions; /** The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. */ seccompProfile?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext_seccompProfile; /** The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ windowsOptions?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext_windowsOptions; } /** The capabilities to add/drop when running containers. Defaults to the default set of capabilities granted by the container runtime. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext_capabilities { /** Added capabilities */ add?: string[]; /** Removed capabilities */ drop?: string[]; } /** The SELinux context to be applied to the container. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** The seccomp options to use by this container. If seccomp options are provided at both the pod & container level, the container options override the pod options. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** The Windows specific settings applied to all containers. If unspecified, the options from the PodSecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** StartupProbe indicates that the Pod 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 Pod'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 */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe { /** Exec specifies the action to take. */ exec?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_exec; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. * @format int32 */ failureThreshold?: number; /** GRPC specifies an action involving a GRPC port. */ grpc?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_grpc; /** HTTPGet specifies the http request to perform. */ httpGet?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_httpGet; /** * Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. * @format int32 */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. * @format int32 */ successThreshold?: number; /** TCPSocket specifies an action involving a TCP port. */ tcpSocket?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_tcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod 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. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset. * @format int64 */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes * @format int32 */ timeoutSeconds?: number; } /** Exec specifies the action to take. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_exec { /** Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; } /** GRPC specifies an action involving a GRPC port. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_grpc { /** * Port number of the gRPC service. Number must be in the range 1 to 65535. * @format int32 */ port: number; /** * Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). * If this is not specified, the default behavior is defined by gRPC. */ service?: string; } /** HTTPGet specifies the http request to perform. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_httpGet { /** Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_httpGet_httpHeaders[]; /** Path to access on the HTTP server. */ path?: string; /** Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; /** Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** HTTPHeader describes a custom header to be used in HTTP probes */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_httpGet_httpHeaders { /** The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header. */ name: string; /** The header field value */ value: string; } /** TCPSocket specifies an action involving a TCP port. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_startupProbe_tcpSocket { /** Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number | string; } /** volumeDevice describes a mapping of a raw block device within a container. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_volumeDevices { /** devicePath is the path inside of the container that the device will be mapped to. */ devicePath: string; /** name must match the name of a persistentVolumeClaim in the pod */ name: string; } /** VolumeMount describes a mounting of a Volume within a container. */ interface ScaledJob_spec_jobTargetRef_template_spec_initContainers_volumeMounts { /** Path within the container at which the volume should be mounted. Must not contain ':'. */ mountPath: string; /** mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. */ mountPropagation?: string; /** This must match the Name of a Volume. */ name: string; /** Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. */ readOnly?: boolean; /** Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. */ subPathExpr?: string; } /** * Specifies the OS of the containers in the pod. Some pod and container fields are restricted if this is set. * If the OS field is set to linux, the following fields must be unset: -securityContext.windowsOptions * If the OS field is set to windows, following fields must be unset: - spec.hostPID - spec.hostIPC - spec.hostUsers - spec.securityContext.seLinuxOptions - spec.securityContext.seccompProfile - spec.securityContext.fsGroup - spec.securityContext.fsGroupChangePolicy - spec.securityContext.sysctls - spec.shareProcessNamespace - spec.securityContext.runAsUser - spec.securityContext.runAsGroup - spec.securityContext.supplementalGroups - spec.containers[*].securityContext.seLinuxOptions - spec.containers[*].securityContext.seccompProfile - spec.containers[*].securityContext.capabilities - spec.containers[*].securityContext.readOnlyRootFilesystem - spec.containers[*].securityContext.privileged - spec.containers[*].securityContext.allowPrivilegeEscalation - spec.containers[*].securityContext.procMount - spec.containers[*].securityContext.runAsUser - spec.containers[*].securityContext.runAsGroup */ interface ScaledJob_spec_jobTargetRef_template_spec_os { /** Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of: https://github.com/opencontainers/runtime-spec/blob/master/config.md#platform-specific-configuration Clients should expect to handle additional values and treat unrecognized values in this field as os: null */ name: string; } /** PodReadinessGate contains the reference to a pod condition */ interface ScaledJob_spec_jobTargetRef_template_spec_readinessGates { /** ConditionType refers to a condition in the pod's condition list with matching type. */ conditionType: string; } /** PodResourceClaim references exactly one ResourceClaim through a ClaimSource. It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name. */ interface ScaledJob_spec_jobTargetRef_template_spec_resourceClaims { /** Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL. */ name: string; /** Source describes where to find the ResourceClaim. */ source?: ScaledJob_spec_jobTargetRef_template_spec_resourceClaims_source; } /** Source describes where to find the ResourceClaim. */ interface ScaledJob_spec_jobTargetRef_template_spec_resourceClaims_source { /** ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod. */ resourceClaimName?: string; /** * ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. * The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses. * This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim. */ resourceClaimTemplateName?: string; } /** PodSchedulingGate is associated to a Pod to guard its scheduling. */ interface ScaledJob_spec_jobTargetRef_template_spec_schedulingGates { /** Name of the scheduling gate. Each scheduling gate must have a unique name field. */ name: string; } /** SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. */ interface ScaledJob_spec_jobTargetRef_template_spec_securityContext { /** * A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: * 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- * If unset, the Kubelet will not modify the ownership and permissions of any volume. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ fsGroup?: number; /** fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir. Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. Note that this field cannot be set when spec.os.name is windows. */ fsGroupChangePolicy?: string; /** * The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsGroup?: number; /** Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsNonRoot?: boolean; /** * The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. * @format int64 */ runAsUser?: number; /** The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. */ seLinuxOptions?: ScaledJob_spec_jobTargetRef_template_spec_securityContext_seLinuxOptions; /** The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. */ seccompProfile?: ScaledJob_spec_jobTargetRef_template_spec_securityContext_seccompProfile; /** A list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. If unspecified, no additional groups are added to any container. Note that group memberships defined in the container image for the uid of the container process are still effective, even if they are not included in this list. Note that this field cannot be set when spec.os.name is windows. */ supplementalGroups?: number[]; /** Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is windows. */ sysctls?: ScaledJob_spec_jobTargetRef_template_spec_securityContext_sysctls[]; /** The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ windowsOptions?: ScaledJob_spec_jobTargetRef_template_spec_securityContext_windowsOptions; } /** The SELinux context to be applied to all containers. If unspecified, the container runtime will allocate a random SELinux context for each container. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence for that container. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_securityContext_seLinuxOptions { /** Level is SELinux level label that applies to the container. */ level?: string; /** Role is a SELinux role label that applies to the container. */ role?: string; /** Type is a SELinux type label that applies to the container. */ type?: string; /** User is a SELinux user label that applies to the container. */ user?: string; } /** The seccomp options to use by the containers in this pod. Note that this field cannot be set when spec.os.name is windows. */ interface ScaledJob_spec_jobTargetRef_template_spec_securityContext_seccompProfile { /** localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's configured seccomp profile location. Must be set if type is "Localhost". Must NOT be set for any other type. */ localhostProfile?: string; /** * type indicates which kind of seccomp profile will be applied. Valid options are: * Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default profile should be used. Unconfined - no profile should be applied. */ type: string; } /** Sysctl defines a kernel parameter to be set */ interface ScaledJob_spec_jobTargetRef_template_spec_securityContext_sysctls { /** Name of a property to set */ name: string; /** Value of a property to set */ value: string; } /** The Windows specific settings applied to all containers. If unspecified, the options within a container's SecurityContext will be used. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. Note that this field cannot be set when spec.os.name is linux. */ interface ScaledJob_spec_jobTargetRef_template_spec_securityContext_windowsOptions { /** GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. */ gmsaCredentialSpec?: string; /** GMSACredentialSpecName is the name of the GMSA credential spec to use. */ gmsaCredentialSpecName?: string; /** HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers). In addition, if HostProcess is true then HostNetwork must also be set to true. */ hostProcess?: boolean; /** The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence. */ runAsUserName?: string; } /** The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator . */ interface ScaledJob_spec_jobTargetRef_template_spec_tolerations { /** Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. */ effect?: string; /** Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category. */ operator?: string; /** * TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system. * @format int64 */ tolerationSeconds?: number; /** Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** TopologySpreadConstraint specifies how to spread matching pods among the given topology. */ interface ScaledJob_spec_jobTargetRef_template_spec_topologySpreadConstraints { /** LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. */ labelSelector?: ScaledJob_spec_jobTargetRef_template_spec_topologySpreadConstraints_labelSelector; /** * MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. * This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default). */ matchLabelKeys?: string[]; /** * MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed. * @format int32 */ maxSkew: number; /** * MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. * For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. * This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default). * @format int32 */ minDomains?: number; /** * NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. * If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeAffinityPolicy?: string; /** * NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. * If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. */ nodeTaintsPolicy?: string; /** TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each as a "bucket", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology. And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology. It's a required field. */ topologyKey: string; /** WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered "Unsatisfiable" for an incoming pod if and only if every possible node assignment for that pod would violate "MaxSkew" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field. */ whenUnsatisfiable: string; } /** LabelSelector is used to find matching pods. Pods that match this label selector are counted to determine the number of pods in their corresponding topology domain. */ interface ScaledJob_spec_jobTargetRef_template_spec_topologySpreadConstraints_labelSelector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_topologySpreadConstraints_labelSelector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_topologySpreadConstraints_labelSelector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** Volume represents a named volume in a pod that may be accessed by any container in the pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes { /** awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ awsElasticBlockStore?: ScaledJob_spec_jobTargetRef_template_spec_volumes_awsElasticBlockStore; /** azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. */ azureDisk?: ScaledJob_spec_jobTargetRef_template_spec_volumes_azureDisk; /** azureFile represents an Azure File Service mount on the host and bind mount to the pod. */ azureFile?: ScaledJob_spec_jobTargetRef_template_spec_volumes_azureFile; /** cephFS represents a Ceph FS mount on the host that shares a pod's lifetime */ cephfs?: ScaledJob_spec_jobTargetRef_template_spec_volumes_cephfs; /** cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ cinder?: ScaledJob_spec_jobTargetRef_template_spec_volumes_cinder; /** configMap represents a configMap that should populate this volume */ configMap?: ScaledJob_spec_jobTargetRef_template_spec_volumes_configMap; /** csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). */ csi?: ScaledJob_spec_jobTargetRef_template_spec_volumes_csi; /** downwardAPI represents downward API about the pod that should populate this volume */ downwardAPI?: ScaledJob_spec_jobTargetRef_template_spec_volumes_downwardAPI; /** emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ emptyDir?: ScaledJob_spec_jobTargetRef_template_spec_volumes_emptyDir; /** * ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. * Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). * Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. * Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. * A pod can use both types of ephemeral volumes and persistent volumes at the same time. */ ephemeral?: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral; /** fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. */ fc?: ScaledJob_spec_jobTargetRef_template_spec_volumes_fc; /** flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. */ flexVolume?: ScaledJob_spec_jobTargetRef_template_spec_volumes_flexVolume; /** flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running */ flocker?: ScaledJob_spec_jobTargetRef_template_spec_volumes_flocker; /** gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ gcePersistentDisk?: ScaledJob_spec_jobTargetRef_template_spec_volumes_gcePersistentDisk; /** gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ gitRepo?: ScaledJob_spec_jobTargetRef_template_spec_volumes_gitRepo; /** glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md */ glusterfs?: ScaledJob_spec_jobTargetRef_template_spec_volumes_glusterfs; /** hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. */ hostPath?: ScaledJob_spec_jobTargetRef_template_spec_volumes_hostPath; /** iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md */ iscsi?: ScaledJob_spec_jobTargetRef_template_spec_volumes_iscsi; /** name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names */ name: string; /** nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ nfs?: ScaledJob_spec_jobTargetRef_template_spec_volumes_nfs; /** persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */ persistentVolumeClaim?: ScaledJob_spec_jobTargetRef_template_spec_volumes_persistentVolumeClaim; /** photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine */ photonPersistentDisk?: ScaledJob_spec_jobTargetRef_template_spec_volumes_photonPersistentDisk; /** portworxVolume represents a portworx volume attached and mounted on kubelets host machine */ portworxVolume?: ScaledJob_spec_jobTargetRef_template_spec_volumes_portworxVolume; /** projected items for all in one resources secrets, configmaps, and downward API */ projected?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected; /** quobyte represents a Quobyte mount on the host that shares a pod's lifetime */ quobyte?: ScaledJob_spec_jobTargetRef_template_spec_volumes_quobyte; /** rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md */ rbd?: ScaledJob_spec_jobTargetRef_template_spec_volumes_rbd; /** scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. */ scaleIO?: ScaledJob_spec_jobTargetRef_template_spec_volumes_scaleIO; /** secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ secret?: ScaledJob_spec_jobTargetRef_template_spec_volumes_secret; /** storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. */ storageos?: ScaledJob_spec_jobTargetRef_template_spec_volumes_storageos; /** vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine */ vsphereVolume?: ScaledJob_spec_jobTargetRef_template_spec_volumes_vsphereVolume; } /** awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_awsElasticBlockStore { /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine */ fsType?: string; /** * partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). * @format int32 */ partition?: number; /** readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ readOnly?: boolean; /** volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore */ volumeID: string; } /** azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_azureDisk { /** cachingMode is the Host Caching mode: None, Read Only, Read Write. */ cachingMode?: string; /** diskName is the Name of the data disk in the blob storage */ diskName: string; /** diskURI is the URI of data disk in the blob storage */ diskURI: string; /** fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared */ kind?: string; /** readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; } /** azureFile represents an Azure File Service mount on the host and bind mount to the pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_azureFile { /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretName is the name of secret that contains Azure Storage Account Name and Key */ secretName: string; /** shareName is the azure share Name */ shareName: string; } /** cephFS represents a Ceph FS mount on the host that shares a pod's lifetime */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_cephfs { /** monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ monitors: string[]; /** path is Optional: Used as the mounted root, rather than the full Ceph tree, default is / */ path?: string; /** readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ readOnly?: boolean; /** secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ secretFile?: string; /** secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_cephfs_secretRef; /** user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ user?: string; } /** secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_cephfs_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_cinder { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ fsType?: string; /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ readOnly?: boolean; /** secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_cinder_secretRef; /** volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md */ volumeID: string; } /** secretRef is optional: points to a secret object containing parameters used to connect to OpenStack. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_cinder_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** configMap represents a configMap that should populate this volume */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_configMap { /** * defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: ScaledJob_spec_jobTargetRef_template_spec_volumes_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** optional specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_configMap_items { /** key is the key to project. */ key: string; /** * mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_csi { /** driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster. */ driver: string; /** fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply. */ fsType?: string; /** nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. */ nodePublishSecretRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_csi_nodePublishSecretRef; /** readOnly specifies a read-only configuration for the volume. Defaults to false (read/write). */ readOnly?: boolean; /** volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values. */ volumeAttributes?: Record; } /** nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_csi_nodePublishSecretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** downwardAPI represents downward API about the pod that should populate this volume */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_downwardAPI { /** * Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** Items is a list of downward API volume file */ items?: ScaledJob_spec_jobTargetRef_template_spec_volumes_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_downwardAPI_items { /** Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. */ fieldRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. */ resourceFieldRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_downwardAPI_items_resourceFieldRef; } /** Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Specifies the output format of the exposed resources, defaults to "1" * @pattern ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ */ divisor?: number | string; /** Required: resource to select */ resource: string; } /** emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_emptyDir { /** medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir */ medium?: string; /** * sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. The default is nil which means that the limit is undefined. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir * @pattern ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ */ sizeLimit?: number | string; } /** * ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. * Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). * Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. * Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. * A pod can use both types of ephemeral volumes and persistent volumes at the same time. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral { /** * Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). * An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. * This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. * Required, must not be nil. */ volumeClaimTemplate?: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate; } /** * Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be `-` where `` is the name from the `PodSpec.Volumes` array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long). * An existing PVC with that name that is not owned by the pod will *not* be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster. * This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created. * Required, must not be nil. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate { /** May contain labels and annotations that will be copied into the PVC when creating it. No other fields are allowed and will be rejected during validation. */ metadata?: object; /** The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. */ spec: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec; } /** The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec { /** accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 */ accessModes?: string[]; /** dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. */ dataSource?: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_dataSource; /** dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. */ dataSourceRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_dataSourceRef; /** resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources */ resources?: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_resources; /** selector is a label query over volumes to consider for binding. */ selector?: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_selector; /** storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 */ storageClassName?: string; /** volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. */ volumeMode?: string; /** volumeName is the binding reference to the PersistentVolume backing this claim. */ volumeName?: string; } /** dataSource field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_dataSource { /** APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** Kind is the type of resource being referenced */ kind: string; /** Name is the name of resource being referenced */ name: string; } /** dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef: * While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified. * While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_dataSourceRef { /** APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** Kind is the type of resource being referenced */ kind: string; /** Name is the name of resource being referenced */ name: string; /** Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled. */ namespace?: string; } /** resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_resources { /** * Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. * This is an alpha field and requires enabling the DynamicResourceAllocation feature gate. * This field is immutable. It can only be set for containers. */ claims?: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_resources_claims[]; /** Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: Record; /** Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. Requests cannot exceed Limits. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: Record; } /** ResourceClaim references one entry in PodSpec.ResourceClaims. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_resources_claims { /** Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container. */ name: string; } /** selector is a label query over volumes to consider for binding. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_selector { /** matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_selector_matchExpressions[]; /** matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: Record; } /** A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_ephemeral_volumeClaimTemplate_spec_selector_matchExpressions { /** key is the label key that the selector applies to. */ key: string; /** operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_fc { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine */ fsType?: string; /** * lun is Optional: FC target lun number * @format int32 */ lun?: number; /** readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** targetWWNs is Optional: FC target worldwide names (WWNs) */ targetWWNs?: string[]; /** wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. */ wwids?: string[]; } /** flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_flexVolume { /** driver is the name of the driver to use for this volume. */ driver: string; /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. */ fsType?: string; /** options is Optional: this field holds extra command options if any. */ options?: Record; /** readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_flexVolume_secretRef; } /** secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_flexVolume_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_flocker { /** datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated */ datasetName?: string; /** datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset */ datasetUUID?: string; } /** gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_gcePersistentDisk { /** fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine */ fsType?: string; /** * partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk * @format int32 */ partition?: number; /** pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ pdName: string; /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk */ readOnly?: boolean; } /** gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_gitRepo { /** directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */ directory?: string; /** repository is the URL */ repository: string; /** revision is the commit hash for the specified revision. */ revision?: string; } /** glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_glusterfs { /** endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ endpoints: string; /** path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ path: string; /** readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod */ readOnly?: boolean; } /** hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath --- TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_hostPath { /** path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ path: string; /** type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath */ type?: string; } /** iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_iscsi { /** chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication */ chapAuthDiscovery?: boolean; /** chapAuthSession defines whether support iSCSI Session CHAP authentication */ chapAuthSession?: boolean; /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine */ fsType?: string; /** initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the connection. */ initiatorName?: string; /** iqn is the target iSCSI Qualified Name. */ iqn: string; /** iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp). */ iscsiInterface?: string; /** * lun represents iSCSI Target Lun number. * @format int32 */ lun: number; /** portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). */ portals?: string[]; /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. */ readOnly?: boolean; /** secretRef is the CHAP Secret for iSCSI target and initiator authentication */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_iscsi_secretRef; /** targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260). */ targetPortal: string; } /** secretRef is the CHAP Secret for iSCSI target and initiator authentication */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_iscsi_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_nfs { /** path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ path: string; /** readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ readOnly?: boolean; /** server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs */ server: string; } /** persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_persistentVolumeClaim { /** claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims */ claimName: string; /** readOnly Will force the ReadOnly setting in VolumeMounts. Default false. */ readOnly?: boolean; } /** photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_photonPersistentDisk { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** pdID is the ID that identifies Photon Controller persistent disk */ pdID: string; } /** portworxVolume represents a portworx volume attached and mounted on kubelets host machine */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_portworxVolume { /** fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** volumeID uniquely identifies a Portworx volume */ volumeID: string; } /** projected items for all in one resources secrets, configmaps, and downward API */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected { /** * defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** sources is the list of volume projections */ sources?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources[]; } /** Projection that may be projected along with other supported volume types */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources { /** configMap information about the configMap data to project */ configMap?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_configMap; /** downwardAPI information about the downwardAPI data to project */ downwardAPI?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_downwardAPI; /** secret information about the secret data to project */ secret?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_secret; /** serviceAccountToken is information about the serviceAccountToken data to project */ serviceAccountToken?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_serviceAccountToken; } /** configMap information about the configMap data to project */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_configMap { /** items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_configMap_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** optional specify whether the ConfigMap or its keys must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_configMap_items { /** key is the key to project. */ key: string; /** * mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** downwardAPI information about the downwardAPI data to project */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_downwardAPI { /** Items is a list of DownwardAPIVolume file */ items?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_downwardAPI_items[]; } /** DownwardAPIVolumeFile represents information to create the file containing the pod field */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_downwardAPI_items { /** Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. */ fieldRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_downwardAPI_items_fieldRef; /** * Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' */ path: string; /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. */ resourceFieldRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_downwardAPI_items_resourceFieldRef; } /** Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_downwardAPI_items_fieldRef { /** Version of the schema the FieldPath is written in terms of, defaults to "v1". */ apiVersion?: string; /** Path of the field to select in the specified API version. */ fieldPath: string; } /** Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_downwardAPI_items_resourceFieldRef { /** Container name: required for volumes, optional for env vars */ containerName?: string; /** * Specifies the output format of the exposed resources, defaults to "1" * @pattern ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ */ divisor?: number | string; /** Required: resource to select */ resource: string; } /** secret information about the secret data to project */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_secret { /** items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_secret_items[]; /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; /** optional field specify whether the Secret or its key must be defined */ optional?: boolean; } /** Maps a string key to a path within a volume. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_secret_items { /** key is the key to project. */ key: string; /** * mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** serviceAccountToken is information about the serviceAccountToken data to project */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_projected_sources_serviceAccountToken { /** audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver. */ audience?: string; /** * expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes. * @format int64 */ expirationSeconds?: number; /** path is the path relative to the mount point of the file to project the token into. */ path: string; } /** quobyte represents a Quobyte mount on the host that shares a pod's lifetime */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_quobyte { /** group to map volume access to Default is no group */ group?: string; /** readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false. */ readOnly?: boolean; /** registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes */ registry: string; /** tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin */ tenant?: string; /** user to map volume access to Defaults to serivceaccount user */ user?: string; /** volume is a string that references an already created Quobyte volume by name. */ volume: string; } /** rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_rbd { /** fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine */ fsType?: string; /** image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ image: string; /** keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ keyring?: string; /** monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ monitors: string[]; /** pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ pool?: string; /** readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ readOnly?: boolean; /** secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_rbd_secretRef; /** user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ user?: string; } /** secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_rbd_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_scaleIO { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". */ fsType?: string; /** gateway is the host address of the ScaleIO API Gateway. */ gateway: string; /** protectionDomain is the name of the ScaleIO Protection Domain for the configured storage. */ protectionDomain?: string; /** readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. */ secretRef: ScaledJob_spec_jobTargetRef_template_spec_volumes_scaleIO_secretRef; /** sslEnabled Flag enable/disable SSL communication with Gateway, default false */ sslEnabled?: boolean; /** storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned. */ storageMode?: string; /** storagePool is the ScaleIO Storage Pool associated with the protection domain. */ storagePool?: string; /** system is the name of the storage system as configured in ScaleIO. */ system: string; /** volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source. */ volumeName?: string; } /** secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_scaleIO_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_secret { /** * defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ defaultMode?: number; /** items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the Secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the '..' path or start with '..'. */ items?: ScaledJob_spec_jobTargetRef_template_spec_volumes_secret_items[]; /** optional field specify whether the Secret or its keys must be defined */ optional?: boolean; /** secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret */ secretName?: string; } /** Maps a string key to a path within a volume. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_secret_items { /** key is the key to project. */ key: string; /** * mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. * @format int32 */ mode?: number; /** path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'. */ path: string; } /** storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_storageos { /** fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. */ readOnly?: boolean; /** secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. */ secretRef?: ScaledJob_spec_jobTargetRef_template_spec_volumes_storageos_secretRef; /** volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace. */ volumeName?: string; /** volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created. */ volumeNamespace?: string; } /** secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted. */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_storageos_secretRef { /** Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid? */ name?: string; } /** vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine */ interface ScaledJob_spec_jobTargetRef_template_spec_volumes_vsphereVolume { /** fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. */ fsType?: string; /** storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. */ storagePolicyID?: string; /** storagePolicyName is the storage Policy Based Management (SPBM) profile name. */ storagePolicyName?: string; /** volumePath is the path that identifies vSphere volume vmdk */ volumePath: string; } /** Rollout defines the strategy for job rollouts */ interface ScaledJob_spec_rollout { /** */ propagationPolicy?: string; /** */ strategy?: string; } /** ScalingStrategy defines the strategy of Scaling */ interface ScaledJob_spec_scalingStrategy { /** @format int32 */ customScalingQueueLengthDeduction?: number; /** */ customScalingRunningJobPercentage?: string; /** */ multipleScalersCalculation?: string; /** */ pendingPodConditions?: string[]; /** */ strategy?: string; } /** ScaleTriggers reference the scaler that will be used */ interface ScaledJob_spec_triggers { /** AuthenticationRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that is used to authenticate the scaler with the environment */ authenticationRef?: ScaledJob_spec_triggers_authenticationRef; /** */ metadata: Record; /** */ name?: string; /** */ type: string; /** */ useCachedMetrics?: boolean; } /** AuthenticationRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that is used to authenticate the scaler with the environment */ interface ScaledJob_spec_triggers_authenticationRef { /** Kind of the resource being referred to. Defaults to TriggerAuthentication. */ kind?: string; /** */ name: string; } /** ScaledJobStatus defines the observed state of ScaledJob */ interface ScaledJob_status { /** */ Paused?: string; /** Conditions an array representation to store multiple Conditions */ conditions?: ScaledJob_status_conditions[]; /** @format date-time */ lastActiveTime?: string; } /** Condition to store the condition state */ interface ScaledJob_status_conditions { /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of condition */ type: string; } /** ScaledObject is a specification for a ScaledObject resource */ interface ScaledObject { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: object; /** ScaledObjectSpec is the spec for a ScaledObject resource */ spec: ScaledObject_spec; /** ScaledObjectStatus is the status for a ScaledObject resource */ status?: ScaledObject_status; } /** ScaledObjectSpec is the spec for a ScaledObject resource */ interface ScaledObject_spec { /** AdvancedConfig specifies advance scaling options */ advanced?: ScaledObject_spec_advanced; /** @format int32 */ cooldownPeriod?: number; /** Fallback is the spec for fallback options */ fallback?: ScaledObject_spec_fallback; /** @format int32 */ idleReplicaCount?: number; /** @format int32 */ maxReplicaCount?: number; /** @format int32 */ minReplicaCount?: number; /** @format int32 */ pollingInterval?: number; /** ScaleTarget holds the reference to the scale target Object */ scaleTargetRef: ScaledObject_spec_scaleTargetRef; /** */ triggers: ScaledObject_spec_triggers[]; } /** AdvancedConfig specifies advance scaling options */ interface ScaledObject_spec_advanced { /** HorizontalPodAutoscalerConfig specifies horizontal scale config */ horizontalPodAutoscalerConfig?: ScaledObject_spec_advanced_horizontalPodAutoscalerConfig; /** */ restoreToOriginalReplicaCount?: boolean; /** ScalingModifiers describes advanced scaling logic options like formula */ scalingModifiers?: ScaledObject_spec_advanced_scalingModifiers; } /** HorizontalPodAutoscalerConfig specifies horizontal scale config */ interface ScaledObject_spec_advanced_horizontalPodAutoscalerConfig { /** HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). */ behavior?: ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior; /** */ name?: string; } /** HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). */ interface ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior { /** scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). */ scaleDown?: ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior_scaleDown; /** scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * increase no more than 4 pods per 60 seconds * double the number of pods per 60 seconds No stabilization is used. */ scaleUp?: ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior_scaleUp; } /** scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used). */ interface ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior_scaleDown { /** policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid */ policies?: ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior_scaleDown_policies[]; /** selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. */ selectPolicy?: string; /** * stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). * @format int32 */ stabilizationWindowSeconds?: number; } /** HPAScalingPolicy is a single policy which must hold true for a specified past interval. */ interface ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior_scaleDown_policies { /** * periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). * @format int32 */ periodSeconds: number; /** type is used to specify the scaling policy. */ type: string; /** * value contains the amount of change which is permitted by the policy. It must be greater than zero * @format int32 */ value: number; } /** scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of: * increase no more than 4 pods per 60 seconds * double the number of pods per 60 seconds No stabilization is used. */ interface ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior_scaleUp { /** policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid */ policies?: ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior_scaleUp_policies[]; /** selectPolicy is used to specify which policy should be used. If not set, the default value Max is used. */ selectPolicy?: string; /** * stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long). * @format int32 */ stabilizationWindowSeconds?: number; } /** HPAScalingPolicy is a single policy which must hold true for a specified past interval. */ interface ScaledObject_spec_advanced_horizontalPodAutoscalerConfig_behavior_scaleUp_policies { /** * periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min). * @format int32 */ periodSeconds: number; /** type is used to specify the scaling policy. */ type: string; /** * value contains the amount of change which is permitted by the policy. It must be greater than zero * @format int32 */ value: number; } /** ScalingModifiers describes advanced scaling logic options like formula */ interface ScaledObject_spec_advanced_scalingModifiers { /** */ activationTarget?: string; /** */ formula?: string; /** MetricTargetType specifies the type of metric being targeted, and should be either "Value", "AverageValue", or "Utilization" */ metricType?: string; /** */ target?: string; } /** Fallback is the spec for fallback options */ interface ScaledObject_spec_fallback { /** @format int32 */ failureThreshold: number; /** @format int32 */ replicas: number; } /** ScaleTarget holds the reference to the scale target Object */ interface ScaledObject_spec_scaleTargetRef { /** */ apiVersion?: string; /** */ envSourceContainerName?: string; /** */ kind?: string; /** */ name: string; } /** ScaleTriggers reference the scaler that will be used */ interface ScaledObject_spec_triggers { /** AuthenticationRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that is used to authenticate the scaler with the environment */ authenticationRef?: ScaledObject_spec_triggers_authenticationRef; /** */ metadata: Record; /** MetricTargetType specifies the type of metric being targeted, and should be either "Value", "AverageValue", or "Utilization" */ metricType?: string; /** */ name?: string; /** */ type: string; /** */ useCachedMetrics?: boolean; } /** AuthenticationRef points to the TriggerAuthentication or ClusterTriggerAuthentication object that is used to authenticate the scaler with the environment */ interface ScaledObject_spec_triggers_authenticationRef { /** Kind of the resource being referred to. Defaults to TriggerAuthentication. */ kind?: string; /** */ name: string; } /** ScaledObjectStatus is the status for a ScaledObject resource */ interface ScaledObject_status { /** */ compositeScalerName?: string; /** Conditions an array representation to store multiple Conditions */ conditions?: ScaledObject_status_conditions[]; /** */ externalMetricNames?: string[]; /** */ health?: Record; /** */ hpaName?: string; /** @format date-time */ lastActiveTime?: string; /** @format int32 */ originalReplicaCount?: number; /** @format int32 */ pausedReplicaCount?: number; /** */ resourceMetricNames?: string[]; /** GroupVersionKindResource provides unified structure for schema.GroupVersionKind and Resource */ scaleTargetGVKR?: ScaledObject_status_scaleTargetGVKR; /** */ scaleTargetKind?: string; } /** Condition to store the condition state */ interface ScaledObject_status_conditions { /** A human readable message indicating details about the transition. */ message?: string; /** The reason for the condition's last transition. */ reason?: string; /** Status of the condition, one of True, False, Unknown. */ status: string; /** Type of condition */ type: string; } /** HealthStatus is the status for a ScaledObject's health */ interface ScaledObject_status_health { /** @format int32 */ numberOfFailures?: number; /** HealthStatusType is an indication of whether the health status is happy or failing */ status?: string; } /** GroupVersionKindResource provides unified structure for schema.GroupVersionKind and Resource */ interface ScaledObject_status_scaleTargetGVKR { /** */ group: string; /** */ kind: string; /** */ resource: string; /** */ version: string; } /** TriggerAuthentication defines how a trigger can authenticate */ interface TriggerAuthentication { /** APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources */ apiVersion?: string; /** Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */ kind?: string; /** */ metadata?: object; /** TriggerAuthenticationSpec defines the various ways to authenticate */ spec: TriggerAuthentication_spec; /** TriggerAuthenticationStatus defines the observed state of TriggerAuthentication */ status?: TriggerAuthentication_status; } /** TriggerAuthenticationSpec defines the various ways to authenticate */ interface TriggerAuthentication_spec { /** AzureKeyVault is used to authenticate using Azure Key Vault */ azureKeyVault?: TriggerAuthentication_spec_azureKeyVault; /** */ env?: TriggerAuthentication_spec_env[]; /** HashiCorpVault is used to authenticate using Hashicorp Vault */ hashiCorpVault?: TriggerAuthentication_spec_hashiCorpVault; /** AuthPodIdentity allows users to select the platform native identity mechanism */ podIdentity?: TriggerAuthentication_spec_podIdentity; /** */ secretTargetRef?: TriggerAuthentication_spec_secretTargetRef[]; } /** AzureKeyVault is used to authenticate using Azure Key Vault */ interface TriggerAuthentication_spec_azureKeyVault { /** */ cloud?: TriggerAuthentication_spec_azureKeyVault_cloud; /** */ credentials?: TriggerAuthentication_spec_azureKeyVault_credentials; /** AuthPodIdentity allows users to select the platform native identity mechanism */ podIdentity?: TriggerAuthentication_spec_azureKeyVault_podIdentity; /** */ secrets: TriggerAuthentication_spec_azureKeyVault_secrets[]; /** */ vaultUri: string; } /** */ interface TriggerAuthentication_spec_azureKeyVault_cloud { /** */ activeDirectoryEndpoint?: string; /** */ keyVaultResourceURL?: string; /** */ type: string; } /** */ interface TriggerAuthentication_spec_azureKeyVault_credentials { /** */ clientId: string; /** */ clientSecret: TriggerAuthentication_spec_azureKeyVault_credentials_clientSecret; /** */ tenantId: string; } /** */ interface TriggerAuthentication_spec_azureKeyVault_credentials_clientSecret { /** */ valueFrom: TriggerAuthentication_spec_azureKeyVault_credentials_clientSecret_valueFrom; } /** */ interface TriggerAuthentication_spec_azureKeyVault_credentials_clientSecret_valueFrom { /** */ secretKeyRef: TriggerAuthentication_spec_azureKeyVault_credentials_clientSecret_valueFrom_secretKeyRef; } /** */ interface TriggerAuthentication_spec_azureKeyVault_credentials_clientSecret_valueFrom_secretKeyRef { /** */ key: string; /** */ name: string; } /** AuthPodIdentity allows users to select the platform native identity mechanism */ interface TriggerAuthentication_spec_azureKeyVault_podIdentity { /** */ identityId?: string; /** PodIdentityProvider contains the list of providers */ provider: string; } /** */ interface TriggerAuthentication_spec_azureKeyVault_secrets { /** */ name: string; /** */ parameter: string; /** */ version?: string; } /** AuthEnvironment is used to authenticate using environment variables in the destination ScaleTarget spec */ interface TriggerAuthentication_spec_env { /** */ containerName?: string; /** */ name: string; /** */ parameter: string; } /** HashiCorpVault is used to authenticate using Hashicorp Vault */ interface TriggerAuthentication_spec_hashiCorpVault { /** */ address: string; /** VaultAuthentication contains the list of Hashicorp Vault authentication methods */ authentication: string; /** Credential defines the Hashicorp Vault credentials depending on the authentication method */ credential?: TriggerAuthentication_spec_hashiCorpVault_credential; /** */ mount?: string; /** */ namespace?: string; /** */ role?: string; /** */ secrets: TriggerAuthentication_spec_hashiCorpVault_secrets[]; } /** Credential defines the Hashicorp Vault credentials depending on the authentication method */ interface TriggerAuthentication_spec_hashiCorpVault_credential { /** */ serviceAccount?: string; /** */ token?: string; } /** VaultSecret defines the mapping between the path of the secret in Vault to the parameter */ interface TriggerAuthentication_spec_hashiCorpVault_secrets { /** */ key: string; /** */ parameter: string; /** */ path: string; } /** AuthPodIdentity allows users to select the platform native identity mechanism */ interface TriggerAuthentication_spec_podIdentity { /** */ identityId?: string; /** PodIdentityProvider contains the list of providers */ provider: string; } /** AuthSecretTargetRef is used to authenticate using a reference to a secret */ interface TriggerAuthentication_spec_secretTargetRef { /** */ key: string; /** */ name: string; /** */ parameter: string; } /** TriggerAuthenticationStatus defines the observed state of TriggerAuthentication */ interface TriggerAuthentication_status { /** */ scaledjobs?: string; /** */ scaledobjects?: string; } }