diff --git a/VERSION b/VERSION index 47d04a52..3f46c4d1 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.18.0 \ No newline at end of file +0.19.0 \ No newline at end of file diff --git a/bundle/manifests/temporal-operator.clusterserviceversion.yaml b/bundle/manifests/temporal-operator.clusterserviceversion.yaml index 1bf9b2bf..9b72c423 100644 --- a/bundle/manifests/temporal-operator.clusterserviceversion.yaml +++ b/bundle/manifests/temporal-operator.clusterserviceversion.yaml @@ -74,15 +74,48 @@ metadata: "description": "Accounting team namespace", "retentionPeriod": "168h" } + }, + { + "apiVersion": "temporal.io/v1beta1", + "kind": "TemporalSchedule", + "metadata": { + "name": "demo", + "namespace": "demo" + }, + "spec": { + "allowDeletion": true, + "namespaceRef": { + "name": "demo" + }, + "schedule": { + "action": { + "workflow": { + "id": "Demo", + "taskQueue": "SomeWorkflowQueue", + "type": "SomeWorkflow" + } + }, + "spec": { + "intervals": [ + { + "every": "10m" + } + ] + }, + "state": { + "paused": false + } + } + } } ] capabilities: Seamless Upgrades categories: Application Runtime, Developer Tools, AI/Machine Learning containerImage: ghcr.io/alexandrevilain/temporal-operator - createdAt: "2024-04-30T10:06:00Z" + createdAt: "2024-06-13T10:47:21Z" operators.operatorframework.io/builder: operator-sdk-v1.30.0 operators.operatorframework.io/project_layout: go.kubebuilder.io/v3 - name: temporal-operator.v0.18.0 + name: temporal-operator.v0.19.0 namespace: placeholder spec: apiservicedefinitions: {} @@ -105,6 +138,9 @@ spec: kind: TemporalNamespace name: temporalnamespaces.temporal.io version: v1beta1 + - kind: TemporalSchedule + name: temporalschedules.temporal.io + version: v1beta1 description: | ## Temporal Temporal is a durable workflow execution environment for applications. The Temporal operator will deploy all required Temporal server services and dependencies. You will need to deploy database, elasticsearch (optional) and prometheus/grafana (optional) separately. Temporal supports native MySQL, PostgreSQL or Cassandra databases. @@ -176,6 +212,7 @@ spec: - configmaps verbs: - create + - delete - get - list - update @@ -376,6 +413,32 @@ spec: - get - patch - update + - apiGroups: + - temporal.io + resources: + - temporalschedules + verbs: + - create + - delete + - get + - list + - patch + - update + - watch + - apiGroups: + - temporal.io + resources: + - temporalschedules/finalizers + verbs: + - update + - apiGroups: + - temporal.io + resources: + - temporalschedules/status + verbs: + - get + - patch + - update serviceAccountName: temporal-operator-controller-manager deployments: - label: @@ -399,7 +462,7 @@ spec: - --leader-elect command: - /manager - image: ghcr.io/alexandrevilain/temporal-operator:v0.18.0 + image: ghcr.io/alexandrevilain/temporal-operator:v0.19.0 livenessProbe: httpGet: path: /healthz @@ -503,8 +566,8 @@ spec: provider: name: Temporal Community url: https://temporal.io/ - replaces: temporal-operator.v0.17.0 - version: 0.18.0 + replaces: temporal-operator.v0.18.0 + version: 0.19.0 webhookdefinitions: - admissionReviewVersions: - v1 diff --git a/bundle/manifests/temporal.io_temporalclusterclients.yaml b/bundle/manifests/temporal.io_temporalclusterclients.yaml index 739296ba..99a41696 100644 --- a/bundle/manifests/temporal.io_temporalclusterclients.yaml +++ b/bundle/manifests/temporal.io_temporalclusterclients.yaml @@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.11.3 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null name: temporalclusterclients.temporal.io spec: @@ -21,14 +21,19 @@ spec: temporal cluster. properties: apiVersion: - description: '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' + description: |- + 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 type: string kind: - description: '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' + description: |- + 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 type: string metadata: type: object @@ -40,10 +45,11 @@ spec: access to. properties: name: - description: The name of the TemporalCluster to reference. + description: The name of the temporal object to reference. type: string namespace: - description: The namespace of the TemporalCluster to reference. + description: |- + The namespace of the temporal object to reference. Defaults to the namespace of the requested resource if omitted. type: string type: object @@ -59,8 +65,15 @@ spec: for the client. properties: name: - description: '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?' + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string type: object x-kubernetes-map-type: atomic diff --git a/bundle/manifests/temporal.io_temporalclusters.yaml b/bundle/manifests/temporal.io_temporalclusters.yaml index fdda96f1..9c9baf2f 100644 --- a/bundle/manifests/temporal.io_temporalclusters.yaml +++ b/bundle/manifests/temporal.io_temporalclusters.yaml @@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.11.3 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null name: temporalclusters.temporal.io spec: @@ -30,14 +30,19 @@ spec: description: TemporalCluster defines a temporal cluster deployment. properties: apiVersion: - description: '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' + description: |- + 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 type: string kind: - description: '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' + description: |- + 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 type: string metadata: type: object @@ -65,23 +70,23 @@ spec: Deployment. properties: metadata: - description: ObjectMetaOverride provides the ability to - override an object metadata. It's a subset of the fields - included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured key value - map stored with a resource that may be set by external - tools to store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that can - be used to organize and categorize (scope and select) - objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object spec: @@ -93,53 +98,57 @@ spec: be created. properties: metadata: - description: ObjectMetaOverride provides the ability - to override an object metadata. It's a subset - of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured - key value map stored with a resource that - may be set by external tools to store and - retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values - that can be used to organize and categorize + description: |- + Map of string keys and values that can be used to organize and categorize (scope and select) objects. type: object type: object spec: description: Specification of the desired behavior of the pod. - type: object x-kubernetes-preserve-unknown-fields: true type: object type: object type: object type: object resources: - description: 'Compute Resources required by the ui. More info: - https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Compute Resources required by the ui. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ properties: claims: - description: "Claims lists the names of resources, defined - in spec.resourceClaims, that are used by this container. - \n This is an alpha field and requires enabling the DynamicResourceAllocation - feature gate. \n This field is immutable. It can only be - set for containers." + description: |- + 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. items: description: ResourceClaim references one entry in PodSpec.ResourceClaims. properties: name: - description: 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. + description: |- + 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. type: string required: - name @@ -155,8 +164,9 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ type: object requests: additionalProperties: @@ -165,11 +175,11 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: '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/' + description: |- + 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/ type: object type: object type: object @@ -192,9 +202,9 @@ spec: type: boolean enabled: default: false - description: Enabled defines if the archival is enabled by - default for all namespaces or for a particular namespace - (depends if it's for a TemporalCluster or a TemporalNamespace). + description: |- + Enabled defines if the archival is enabled by default for all namespaces + or for a particular namespace (depends if it's for a TemporalCluster or a TemporalNamespace). type: boolean path: description: Path is ... @@ -209,9 +219,10 @@ spec: - paused type: object provider: - description: Provider defines the archival provider for the cluster. - The same provider is used for both history and visibility, but - some config can be changed using spec.archival.[history|visibility].config. + description: |- + Provider defines the archival provider for the cluster. + The same provider is used for both history and visibility, + but some config can be changed using spec.archival.[history|visibility].config. properties: filestore: description: FilestoreArchiver is the file store archival @@ -219,17 +230,15 @@ spec: properties: dirPermissions: default: "0766" - description: DirPermissions sets the directory permissions - of the archive directory. It's recommend to leave it - empty and use the default value of "0766" to avoid read/write - issues. + description: |- + DirPermissions sets the directory permissions of the archive directory. + It's recommend to leave it empty and use the default value of "0766" to avoid read/write issues. type: string filePermissions: default: "0666" - description: FilePermissions sets the file permissions - of the archived files. It's recommend to leave it empty - and use the default value of "0666" to avoid read/write - issues. + description: |- + FilePermissions sets the file permissions of the archived files. + It's recommend to leave it empty and use the default value of "0666" to avoid read/write issues. type: string required: - dirPermissions @@ -247,9 +256,15 @@ spec: be a valid secret key. type: string name: - description: '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?' + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the Secret or its key @@ -278,10 +293,15 @@ spec: be a valid secret key. type: string name: - description: '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?' + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the Secret or its @@ -300,10 +320,15 @@ spec: be a valid secret key. type: string name: - description: '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?' + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the Secret or its @@ -325,9 +350,9 @@ spec: description: Region is the aws s3 region. type: string roleName: - description: Use RoleName if you want the temporal service - account to assume an AWS Identity and Access Management - (IAM) role. + description: |- + Use RoleName if you want the temporal service account + to assume an AWS Identity and Access Management (IAM) role. type: string s3ForcePathStyle: description: Use s3ForcePathStyle if you want to use s3 @@ -347,9 +372,9 @@ spec: type: boolean enabled: default: false - description: Enabled defines if the archival is enabled by - default for all namespaces or for a particular namespace - (depends if it's for a TemporalCluster or a TemporalNamespace). + description: |- + Enabled defines if the archival is enabled by default for all namespaces + or for a particular namespace (depends if it's for a TemporalCluster or a TemporalNamespace). type: boolean path: description: Path is ... @@ -369,33 +394,31 @@ spec: the temporal cluster. properties: authorizer: - description: Authorizer defines the authorization mechanism to - be used. It can be left as an empty string to use a no-operation - authorizer (noopAuthorizer), or set to "default" to use the - temporal's default authorizer (defaultAuthorizer). + description: |- + Authorizer defines the authorization mechanism to be used. It can be left as an empty string to + use a no-operation authorizer (noopAuthorizer), or set to "default" to use the temporal's default + authorizer (defaultAuthorizer). type: string claimMapper: - description: ClaimMapper specifies the claim mapping mechanism - used for handling JWT claims. Similar to the Authorizer, it - can be left as an empty string to use a no-operation claim mapper - (noopClaimMapper), or set to "default" to use the default JWT - claim mapper (defaultJWTClaimMapper). + description: |- + ClaimMapper specifies the claim mapping mechanism used for handling JWT claims. Similar to the Authorizer, + it can be left as an empty string to use a no-operation claim mapper (noopClaimMapper), or set to "default" + to use the default JWT claim mapper (defaultJWTClaimMapper). type: string jwtKeyProvider: description: JWTKeyProvider specifies the signing key provider used for validating JWT tokens. properties: keySourceURIs: - description: KeySourceURIs is a list of URIs where the JWT - signing keys can be obtained. These URIs are used by the - authorization system to fetch the public keys necessary - for validating JWT tokens. + description: |- + KeySourceURIs is a list of URIs where the JWT signing keys can be obtained. These URIs are used by the + authorization system to fetch the public keys necessary for validating JWT tokens. items: type: string type: array refreshInterval: - description: RefreshInterval defines the time interval at - which temporal should refresh the JWT signing keys from + description: |- + RefreshInterval defines the time interval at which temporal should refresh the JWT signing keys from the specified URIs. type: string type: object @@ -409,8 +432,9 @@ spec: cluster. properties: pollInterval: - description: PollInterval defines how often the config should - be updated by checking provided values. Defaults to 10s. + description: |- + PollInterval defines how often the config should be updated by checking provided values. + Defaults to 10s. type: string values: additionalProperties: @@ -436,10 +460,10 @@ spec: type: string type: object value: - description: 'Value is the value for the configuration - key. The type of the Value field depends on the key. - Acceptable types will be one of: int, float64, bool, - string, map[string]any, time.Duration' + description: |- + Value is the value for the configuration key. + The type of the Value field depends on the key. + Acceptable types will be one of: int, float64, bool, string, map[string]any, time.Duration x-kubernetes-preserve-unknown-fields: true required: - value @@ -456,15 +480,24 @@ spec: should use for each services. type: string imagePullSecrets: - description: An optional list of references to secrets in the same - namespace to use for pulling temporal images from registries. + description: |- + An optional list of references to secrets in the same namespace + to use for pulling temporal images from registries. items: - description: LocalObjectReference contains enough information to - let you locate the referenced object inside the same namespace. + description: |- + LocalObjectReference contains enough information to let you locate the + referenced object inside the same namespace. properties: name: - description: '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?' + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string type: object x-kubernetes-map-type: atomic @@ -482,18 +515,24 @@ spec: description: JobResources allows set resources for setup/update jobs. properties: claims: - description: "Claims lists the names of resources, defined in - spec.resourceClaims, that are used by this container. \n This - is an alpha field and requires enabling the DynamicResourceAllocation - feature gate. \n This field is immutable. It can only be set - for containers." + description: |- + 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. items: description: ResourceClaim references one entry in PodSpec.ResourceClaims. properties: name: - description: 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. + description: |- + 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. type: string required: - name @@ -509,8 +548,9 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute resources - allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ type: object requests: additionalProperties: @@ -519,17 +559,18 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: '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/' + description: |- + 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/ type: object type: object jobTtlSecondsAfterFinished: default: 300 - description: JobTTLSecondsAfterFinished is amount of time to keep - job pods after jobs are completed. Defaults to 300 seconds. + description: |- + JobTTLSecondsAfterFinished is amount of time to keep job pods after jobs are completed. + Defaults to 300 seconds. format: int32 minimum: 1 type: integer @@ -538,15 +579,16 @@ spec: properties: development: default: false - description: Development determines whether the logger is run - in Development (== Test) or in Production mode. Default is - Production. Production-stage disables panics from DPanic logging. + description: |- + Development determines whether the logger is run in Development (== Test) or in + Production mode. Default is Production. Production-stage disables panics from + DPanic logging. type: boolean format: default: json - description: Format determines the format of each log file printed - to the output. Use "console" if you want stack traces to appear - on multiple lines. + description: |- + Format determines the format of each log file printed to the output. + Use "console" if you want stack traces to appear on multiple lines. enum: - json - console @@ -577,55 +619,59 @@ spec: for the cluster. properties: certificatesDuration: - description: CertificatesDuration allows configuration of maximum - certificates lifetime. Useless if mTLS provider is not cert-manager. + description: |- + CertificatesDuration allows configuration of maximum certificates lifetime. + Useless if mTLS provider is not cert-manager. properties: clientCertificates: - description: ClientCertificates is the 'duration' (i.e. lifetime) - of the client certificates. It defaults to 1 year. + description: |- + ClientCertificates is the 'duration' (i.e. lifetime) of the client certificates. + It defaults to 1 year. type: string frontendCertificate: - description: FrontendCertificate is the 'duration' (i.e. lifetime) - of the frontend certificate. It defaults to 1 year. + description: |- + FrontendCertificate is the 'duration' (i.e. lifetime) of the frontend certificate. + It defaults to 1 year. type: string intermediateCAsCertificates: - description: IntermediateCACertificates is the 'duration' - (i.e. lifetime) of the intermediate CAs Certificates. It - defaults to 5 years. + description: |- + IntermediateCACertificates is the 'duration' (i.e. lifetime) of the intermediate CAs Certificates. + It defaults to 5 years. type: string internodeCertificate: - description: InternodeCertificate is the 'duration' (i.e. - lifetime) of the internode certificate. It defaults to 1 - year. + description: |- + InternodeCertificate is the 'duration' (i.e. lifetime) of the internode certificate. + It defaults to 1 year. type: string rootCACertificate: - description: RootCACertificate is the 'duration' (i.e. lifetime) - of the Root CA Certificate. It defaults to 10 years. + description: |- + RootCACertificate is the 'duration' (i.e. lifetime) of the Root CA Certificate. + It defaults to 10 years. type: string type: object frontend: - description: Frontend allows configuration of the frontend's public - endpoint traffic encryption. Useless if mTLS provider is not - cert-manager. + description: |- + Frontend allows configuration of the frontend's public endpoint traffic encryption. + Useless if mTLS provider is not cert-manager. properties: enabled: description: Enabled defines if the operator should enable mTLS for cluster's public endpoints. type: boolean extraDnsNames: - description: ExtraDNSNames is a list of additional DNS names - associated with the TemporalCluster. These DNS names can - be used for accessing the TemporalCluster from external - services. The DNS names specified here will be added to - the TLS certificate for secure communication. + description: |- + ExtraDNSNames is a list of additional DNS names associated with the TemporalCluster. + These DNS names can be used for accessing the TemporalCluster from external services. + The DNS names specified here will be added to the TLS certificate for secure communication. items: type: string nullable: true type: array type: object internode: - description: Internode allows configuration of the internode traffic - encryption. Useless if mTLS provider is not cert-manager. + description: |- + Internode allows configuration of the internode traffic encryption. + Useless if mTLS provider is not cert-manager. properties: enabled: description: Enabled defines if the operator should enable @@ -641,16 +687,17 @@ spec: - istio type: string refreshInterval: - description: RefreshInterval defines interval between refreshes - of certificates in the cluster components. Defaults to 1 hour. + description: |- + RefreshInterval defines interval between refreshes of certificates in the cluster components. + Defaults to 1 hour. Useless if mTLS provider is not cert-manager. type: string renewBefore: - description: RenewBefore is defines how long before the currently - issued certificate's expiry cert-manager should renew the certificate. - The default is 2/3 of the issued certificate's duration. Minimum - accepted value is 5 minutes. Useless if mTLS provider is not - cert-manager. + description: |- + RenewBefore is defines how long before the currently issued certificate's expiry + cert-manager should renew the certificate. The default is 2/3 of the + issued certificate's duration. Minimum accepted value is 5 minutes. + Useless if mTLS provider is not cert-manager. type: string type: object metrics: @@ -666,20 +713,25 @@ spec: items: type: string type: array - description: ExcludeTags is a map from tag name string to tag - values string list. Each value present in keys will have relevant - tag value replaced with "_tag_excluded_" Each value in values - list will white-list tag values to be reported as usual. + description: |- + ExcludeTags is a map from tag name string to tag values string list. + Each value present in keys will have relevant tag value replaced with "_tag_excluded_" + Each value in values list will white-list tag values to be reported as usual. type: object perUnitHistogramBoundaries: additionalProperties: items: type: string type: array - description: "PerUnitHistogramBoundaries defines the default histogram - bucket boundaries. Configuration of histogram boundaries for - given metric unit. \n Supported values: - \"dimensionless\" - - \"milliseconds\" - \"bytes\"" + description: |- + PerUnitHistogramBoundaries defines the default histogram bucket boundaries. + Configuration of histogram boundaries for given metric unit. + + + Supported values: + - "dimensionless" + - "milliseconds" + - "bytes" type: object prefix: description: Prefix sets the prefix to all outgoing metrics @@ -719,18 +771,24 @@ spec: description: MetricRelabelConfigs to apply to samples before ingestion. items: - description: "RelabelConfig allows dynamic rewriting - of the label set for targets, alerts, scraped - samples and remote write samples. \n More info: - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + description: |- + RelabelConfig allows dynamic rewriting of the label set for targets, alerts, + scraped samples and remote write samples. + + + More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config properties: action: default: replace - description: "Action to perform based on the - regex matching. \n `Uppercase` and `Lowercase` - actions require Prometheus >= v2.36.0. `DropEqual` - and `KeepEqual` actions require Prometheus - >= v2.41.0. \n Default: \"Replace\"" + description: |- + Action to perform based on the regex matching. + + + `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. + `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. + + + Default: "Replace" enum: - replace - Replace @@ -756,9 +814,11 @@ spec: - DropEqual type: string modulus: - description: "Modulus to take of the hash of - the source label values. \n Only applicable - when the action is `HashMod`." + description: |- + Modulus to take of the hash of the source label values. + + + Only applicable when the action is `HashMod`. format: int64 type: integer regex: @@ -766,71 +826,84 @@ spec: the extracted value is matched. type: string replacement: - description: "Replacement value against which - a Replace action is performed if the regular - expression matches. \n Regex capture groups - are available." + description: |- + Replacement value against which a Replace action is performed if the + regular expression matches. + + + Regex capture groups are available. type: string separator: description: Separator is the string between concatenated SourceLabels. type: string sourceLabels: - description: The source labels select values - from existing labels. Their content is concatenated - using the configured Separator and matched - against the configured regular expression. + description: |- + The source labels select values from existing labels. Their content is + concatenated using the configured Separator and matched against the + configured regular expression. items: - description: LabelName is a valid Prometheus - label name which may only contain ASCII + description: |- + LabelName is a valid Prometheus label name which may only contain ASCII letters, numbers, as well as underscores. pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string type: array targetLabel: - description: "Label to which the resulting string - is written in a replacement. \n It is mandatory - for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, - `KeepEqual` and `DropEqual` actions. \n Regex - capture groups are available." + description: |- + Label to which the resulting string is written in a replacement. + + + It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, + `KeepEqual` and `DropEqual` actions. + + + Regex capture groups are available. type: string type: object type: array override: - description: Override allows customization of the - created ServiceMonitor. All fields can be overwritten - except "endpoints", "selector" and "namespaceSelector". + description: |- + Override allows customization of the created ServiceMonitor. + All fields can be overwritten except "endpoints", "selector" and "namespaceSelector". properties: attachMetadata: - description: "`attachMetadata` defines additional - metadata which is added to the discovered targets. - \n It requires Prometheus >= v2.37.0." + description: |- + `attachMetadata` defines additional metadata which is added to the + discovered targets. + + + It requires Prometheus >= v2.37.0. properties: node: - description: When set to true, Prometheus - must have the `get` permission on the `Nodes` - objects. + description: |- + When set to true, Prometheus must have the `get` permission on the + `Nodes` objects. type: boolean type: object bodySizeLimit: - description: "When defined, bodySizeLimit specifies - a job level limit on the size of uncompressed - response body that will be accepted by Prometheus. - \n It requires Prometheus >= v2.28.0." + description: |- + When defined, bodySizeLimit specifies a job level limit on the size + of uncompressed response body that will be accepted by Prometheus. + + + It requires Prometheus >= v2.28.0. pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$ type: string endpoints: description: List of endpoints part of this ServiceMonitor. items: - description: Endpoint defines an endpoint serving - Prometheus metrics to be scraped by Prometheus. + description: |- + Endpoint defines an endpoint serving Prometheus metrics to be scraped by + Prometheus. properties: authorization: - description: "`authorization` configures - the Authorization header credentials to - use when scraping the target. \n Cannot - be set at the same time as `basicAuth`, - or `oauth2`." + description: |- + `authorization` configures the Authorization header credentials to use when + scraping the target. + + + Cannot be set at the same time as `basicAuth`, or `oauth2`. properties: credentials: description: Selects a key of a Secret @@ -843,10 +916,15 @@ spec: secret key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the @@ -857,23 +935,28 @@ spec: type: object x-kubernetes-map-type: atomic type: - description: "Defines the authentication - type. The value is case-insensitive. - \n \"Basic\" is not a supported value. - \n Default: \"Bearer\"" + description: |- + Defines the authentication type. The value is case-insensitive. + + + "Basic" is not a supported value. + + + Default: "Bearer" type: string type: object basicAuth: - description: "`basicAuth` configures the - Basic Authentication credentials to use - when scraping the target. \n Cannot be - set at the same time as `authorization`, - or `oauth2`." + description: |- + `basicAuth` configures the Basic Authentication credentials to use when + scraping the target. + + + Cannot be set at the same time as `authorization`, or `oauth2`. properties: password: - description: '`password` specifies a - key of a Secret containing the password - for authentication.' + description: |- + `password` specifies a key of a Secret containing the password for + authentication. properties: key: description: The key of the secret @@ -881,10 +964,15 @@ spec: secret key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the @@ -895,9 +983,9 @@ spec: type: object x-kubernetes-map-type: atomic username: - description: '`username` specifies a - key of a Secret containing the username - for authentication.' + description: |- + `username` specifies a key of a Secret containing the username for + authentication. properties: key: description: The key of the secret @@ -905,10 +993,15 @@ spec: secret key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the @@ -920,18 +1013,20 @@ spec: x-kubernetes-map-type: atomic type: object bearerTokenFile: - description: "File to read bearer token - for scraping the target. \n Deprecated: - use `authorization` instead." + description: |- + File to read bearer token for scraping the target. + + + Deprecated: use `authorization` instead. type: string bearerTokenSecret: - description: "`bearerTokenSecret` specifies - a key of a Secret containing the bearer - token for scraping targets. The secret - needs to be in the same namespace as the - ServiceMonitor object and readable by - the Prometheus Operator. \n Deprecated: - use `authorization` instead." + description: |- + `bearerTokenSecret` specifies a key of a Secret containing the bearer + token for scraping targets. The secret needs to be in the same namespace + as the ServiceMonitor object and readable by the Prometheus Operator. + + + Deprecated: use `authorization` instead. properties: key: description: The key of the secret to @@ -939,10 +1034,15 @@ spec: key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, - kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the Secret @@ -957,53 +1057,62 @@ spec: to disable HTTP2 when scraping the target.' type: boolean filterRunning: - description: "When true, the pods which - are not running (e.g. either in Failed - or Succeeded state) are dropped during - the target discovery. \n If unset, the - filtering is enabled. \n More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase" + description: |- + When true, the pods which are not running (e.g. either in Failed or + Succeeded state) are dropped during the target discovery. + + + If unset, the filtering is enabled. + + + More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase type: boolean followRedirects: - description: '`followRedirects` defines - whether the scrape requests should follow - HTTP 3xx redirects.' + description: |- + `followRedirects` defines whether the scrape requests should follow HTTP + 3xx redirects. type: boolean honorLabels: - description: When true, `honorLabels` preserves - the metric's labels when they collide + description: |- + When true, `honorLabels` preserves the metric's labels when they collide with the target's labels. type: boolean honorTimestamps: - description: '`honorTimestamps` controls - whether Prometheus preserves the timestamps - when exposed by the target.' + description: |- + `honorTimestamps` controls whether Prometheus preserves the timestamps + when exposed by the target. type: boolean interval: - description: "Interval at which Prometheus - scrapes the metrics from the target. \n - If empty, Prometheus uses the global scrape - interval." + description: |- + Interval at which Prometheus scrapes the metrics from the target. + + + If empty, Prometheus uses the global scrape interval. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string metricRelabelings: - description: '`metricRelabelings` configures - the relabeling rules to apply to the samples - before ingestion.' + description: |- + `metricRelabelings` configures the relabeling rules to apply to the + samples before ingestion. items: - description: "RelabelConfig allows dynamic - rewriting of the label set for targets, - alerts, scraped samples and remote write - samples. \n More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + description: |- + RelabelConfig allows dynamic rewriting of the label set for targets, alerts, + scraped samples and remote write samples. + + + More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config properties: action: default: replace - description: "Action to perform based - on the regex matching. \n `Uppercase` - and `Lowercase` actions require - Prometheus >= v2.36.0. `DropEqual` - and `KeepEqual` actions require - Prometheus >= v2.41.0. \n Default: - \"Replace\"" + description: |- + Action to perform based on the regex matching. + + + `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. + `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. + + + Default: "Replace" enum: - replace - Replace @@ -1029,10 +1138,11 @@ spec: - DropEqual type: string modulus: - description: "Modulus to take of the - hash of the source label values. - \n Only applicable when the action - is `HashMod`." + description: |- + Modulus to take of the hash of the source label values. + + + Only applicable when the action is `HashMod`. format: int64 type: integer regex: @@ -1040,50 +1150,56 @@ spec: which the extracted value is matched. type: string replacement: - description: "Replacement value against - which a Replace action is performed - if the regular expression matches. - \n Regex capture groups are available." + description: |- + Replacement value against which a Replace action is performed if the + regular expression matches. + + + Regex capture groups are available. type: string separator: description: Separator is the string between concatenated SourceLabels. type: string sourceLabels: - description: The source labels select - values from existing labels. Their - content is concatenated using the - configured Separator and matched - against the configured regular expression. + description: |- + The source labels select values from existing labels. Their content is + concatenated using the configured Separator and matched against the + configured regular expression. items: - description: LabelName is a valid - Prometheus label name which may - only contain ASCII letters, numbers, - as well as underscores. + description: |- + LabelName is a valid Prometheus label name which may only contain ASCII + letters, numbers, as well as underscores. pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string type: array targetLabel: - description: "Label to which the resulting - string is written in a replacement. - \n It is mandatory for `Replace`, - `HashMod`, `Lowercase`, `Uppercase`, + description: |- + Label to which the resulting string is written in a replacement. + + + It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. - \n Regex capture groups are available." + + + Regex capture groups are available. type: string type: object type: array oauth2: - description: "`oauth2` configures the OAuth2 - settings to use when scraping the target. - \n It requires Prometheus >= 2.27.0. \n - Cannot be set at the same time as `authorization`, - or `basicAuth`." + description: |- + `oauth2` configures the OAuth2 settings to use when scraping the target. + + + It requires Prometheus >= 2.27.0. + + + Cannot be set at the same time as `authorization`, or `basicAuth`. properties: clientId: - description: '`clientId` specifies a - key of a Secret or ConfigMap containing - the OAuth2 client''s ID.' + description: |- + `clientId` specifies a key of a Secret or ConfigMap containing the + OAuth2 client's ID. properties: configMap: description: ConfigMap containing @@ -1093,10 +1209,15 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether @@ -1117,10 +1238,15 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether @@ -1133,9 +1259,9 @@ spec: x-kubernetes-map-type: atomic type: object clientSecret: - description: '`clientSecret` specifies - a key of a Secret containing the OAuth2 - client''s secret.' + description: |- + `clientSecret` specifies a key of a Secret containing the OAuth2 + client's secret. properties: key: description: The key of the secret @@ -1143,10 +1269,15 @@ spec: secret key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the @@ -1159,9 +1290,9 @@ spec: endpointParams: additionalProperties: type: string - description: '`endpointParams` configures - the HTTP parameters to append to the - token URL.' + description: |- + `endpointParams` configures the HTTP parameters to append to the token + URL. type: object scopes: description: '`scopes` defines the OAuth2 @@ -1188,43 +1319,56 @@ spec: URL parameters. type: object path: - description: "HTTP path from which to scrape - for metrics. \n If empty, Prometheus uses - the default value (e.g. `/metrics`)." + description: |- + HTTP path from which to scrape for metrics. + + + If empty, Prometheus uses the default value (e.g. `/metrics`). type: string port: - description: "Name of the Service port which - this endpoint refers to. \n It takes precedence - over `targetPort`." + description: |- + Name of the Service port which this endpoint refers to. + + + It takes precedence over `targetPort`. type: string proxyUrl: - description: '`proxyURL` configures the - HTTP Proxy URL (e.g. "http://proxyserver:2195") - to go through when scraping the target.' + description: |- + `proxyURL` configures the HTTP Proxy URL (e.g. + "http://proxyserver:2195") to go through when scraping the target. type: string relabelings: - description: "`relabelings` configures the - relabeling rules to apply the target's - metadata labels. \n The Operator automatically - adds relabelings for a few standard Kubernetes - fields. \n The original scrape job's name - is available via the `__tmp_prometheus_job_name` - label. \n More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + description: |- + `relabelings` configures the relabeling rules to apply the target's + metadata labels. + + + The Operator automatically adds relabelings for a few standard Kubernetes fields. + + + The original scrape job's name is available via the `__tmp_prometheus_job_name` label. + + + More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config items: - description: "RelabelConfig allows dynamic - rewriting of the label set for targets, - alerts, scraped samples and remote write - samples. \n More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + description: |- + RelabelConfig allows dynamic rewriting of the label set for targets, alerts, + scraped samples and remote write samples. + + + More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config properties: action: default: replace - description: "Action to perform based - on the regex matching. \n `Uppercase` - and `Lowercase` actions require - Prometheus >= v2.36.0. `DropEqual` - and `KeepEqual` actions require - Prometheus >= v2.41.0. \n Default: - \"Replace\"" + description: |- + Action to perform based on the regex matching. + + + `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. + `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. + + + Default: "Replace" enum: - replace - Replace @@ -1250,10 +1394,11 @@ spec: - DropEqual type: string modulus: - description: "Modulus to take of the - hash of the source label values. - \n Only applicable when the action - is `HashMod`." + description: |- + Modulus to take of the hash of the source label values. + + + Only applicable when the action is `HashMod`. format: int64 type: integer regex: @@ -1261,66 +1406,72 @@ spec: which the extracted value is matched. type: string replacement: - description: "Replacement value against - which a Replace action is performed - if the regular expression matches. - \n Regex capture groups are available." + description: |- + Replacement value against which a Replace action is performed if the + regular expression matches. + + + Regex capture groups are available. type: string separator: description: Separator is the string between concatenated SourceLabels. type: string sourceLabels: - description: The source labels select - values from existing labels. Their - content is concatenated using the - configured Separator and matched - against the configured regular expression. + description: |- + The source labels select values from existing labels. Their content is + concatenated using the configured Separator and matched against the + configured regular expression. items: - description: LabelName is a valid - Prometheus label name which may - only contain ASCII letters, numbers, - as well as underscores. + description: |- + LabelName is a valid Prometheus label name which may only contain ASCII + letters, numbers, as well as underscores. pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string type: array targetLabel: - description: "Label to which the resulting - string is written in a replacement. - \n It is mandatory for `Replace`, - `HashMod`, `Lowercase`, `Uppercase`, + description: |- + Label to which the resulting string is written in a replacement. + + + It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. - \n Regex capture groups are available." + + + Regex capture groups are available. type: string type: object type: array scheme: - description: "HTTP scheme to use for scraping. - \n `http` and `https` are the expected - values unless you rewrite the `__scheme__` - label via relabeling. \n If empty, Prometheus - uses the default value `http`." + description: |- + HTTP scheme to use for scraping. + + + `http` and `https` are the expected values unless you rewrite the + `__scheme__` label via relabeling. + + + If empty, Prometheus uses the default value `http`. enum: - http - https type: string scrapeTimeout: - description: "Timeout after which Prometheus - considers the scrape to be failed. \n - If empty, Prometheus uses the global scrape - timeout unless it is less than the target's - scrape interval value in which the latter - is used." + description: |- + Timeout after which Prometheus considers the scrape to be failed. + + + If empty, Prometheus uses the global scrape timeout unless it is less + than the target's scrape interval value in which the latter is used. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string targetPort: anyOf: - type: integer - type: string - description: Name or number of the target - port of the `Pod` object behind the Service. - The port must be specified with the container's - port property. + description: |- + Name or number of the target port of the `Pod` object behind the + Service. The port must be specified with the container's port property. x-kubernetes-int-or-string: true tlsConfig: description: TLS configuration to use when @@ -1338,10 +1489,15 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether @@ -1362,10 +1518,15 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether @@ -1394,10 +1555,15 @@ spec: description: The key to select. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether @@ -1418,10 +1584,15 @@ spec: be a valid secret key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether @@ -1457,10 +1628,15 @@ spec: secret key. type: string name: - description: 'Name of the referent. + default: "" + description: |- + Name of the referent. + This field is effectively required, but due to backwards compatibility is + allowed to be empty. Instances of this type with an empty value here are + almost certainly wrong. + TODO: Add other useful fields. apiVersion, kind, uid? More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. - apiVersion, kind, uid?' + TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896. type: string optional: description: Specify whether the @@ -1476,61 +1652,72 @@ spec: type: string type: object trackTimestampsStaleness: - description: "`trackTimestampsStaleness` - defines whether Prometheus tracks staleness - of the metrics that have an explicit timestamp - present in scraped data. Has no effect - if `honorTimestamps` is false. \n It requires - Prometheus >= v2.48.0." + description: |- + `trackTimestampsStaleness` defines whether Prometheus tracks staleness of + the metrics that have an explicit timestamp present in scraped data. + Has no effect if `honorTimestamps` is false. + + + It requires Prometheus >= v2.48.0. type: boolean type: object type: array jobLabel: - description: "`jobLabel` selects the label from - the associated Kubernetes `Service` object which - will be used as the `job` label for all metrics. - \n For example if `jobLabel` is set to `foo` - and the Kubernetes `Service` object is labeled - with `foo: bar`, then Prometheus adds the `job=\"bar\"` - label to all ingested metrics. \n If the value - of this field is empty or if the label doesn't - exist for the given Service, the `job` label - of the metrics defaults to the name of the associated - Kubernetes `Service`." + description: |- + `jobLabel` selects the label from the associated Kubernetes `Service` + object which will be used as the `job` label for all metrics. + + + For example if `jobLabel` is set to `foo` and the Kubernetes `Service` + object is labeled with `foo: bar`, then Prometheus adds the `job="bar"` + label to all ingested metrics. + + + If the value of this field is empty or if the label doesn't exist for + the given Service, the `job` label of the metrics defaults to the name + of the associated Kubernetes `Service`. type: string keepDroppedTargets: - description: "Per-scrape limit on the number of - targets dropped by relabeling that will be kept - in memory. 0 means no limit. \n It requires - Prometheus >= v2.47.0." + description: |- + Per-scrape limit on the number of targets dropped by relabeling + that will be kept in memory. 0 means no limit. + + + It requires Prometheus >= v2.47.0. format: int64 type: integer labelLimit: - description: "Per-scrape limit on number of labels - that will be accepted for a sample. \n It requires - Prometheus >= v2.27.0." + description: |- + Per-scrape limit on number of labels that will be accepted for a sample. + + + It requires Prometheus >= v2.27.0. format: int64 type: integer labelNameLengthLimit: - description: "Per-scrape limit on length of labels - name that will be accepted for a sample. \n - It requires Prometheus >= v2.27.0." + description: |- + Per-scrape limit on length of labels name that will be accepted for a sample. + + + It requires Prometheus >= v2.27.0. format: int64 type: integer labelValueLengthLimit: - description: "Per-scrape limit on length of labels - value that will be accepted for a sample. \n - It requires Prometheus >= v2.27.0." + description: |- + Per-scrape limit on length of labels value that will be accepted for a sample. + + + It requires Prometheus >= v2.27.0. format: int64 type: integer namespaceSelector: - description: Selector to select which namespaces - the Kubernetes `Endpoints` objects are discovered - from. + description: |- + Selector to select which namespaces the Kubernetes `Endpoints` objects + are discovered from. properties: any: - description: Boolean describing whether all - namespaces are selected in contrast to a + description: |- + Boolean describing whether all namespaces are selected in contrast to a list restricting them. type: boolean matchNames: @@ -1541,16 +1728,16 @@ spec: type: array type: object podTargetLabels: - description: '`podTargetLabels` defines the labels - which are transferred from the associated Kubernetes - `Pod` object onto the ingested metrics.' + description: |- + `podTargetLabels` defines the labels which are transferred from the + associated Kubernetes `Pod` object onto the ingested metrics. items: type: string type: array sampleLimit: - description: '`sampleLimit` defines a per-scrape - limit on the number of scraped samples that - will be accepted.' + description: |- + `sampleLimit` defines a per-scrape limit on the number of scraped samples + that will be accepted. format: int64 type: integer scrapeClass: @@ -1558,17 +1745,23 @@ spec: minLength: 1 type: string scrapeProtocols: - description: "`scrapeProtocols` defines the protocols - to negotiate during a scrape. It tells clients - the protocols supported by Prometheus in order - of preference (from most to least preferred). - \n If unset, Prometheus uses its default value. - \n It requires Prometheus >= v2.49.0." + description: |- + `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the + protocols supported by Prometheus in order of preference (from most to least preferred). + + + If unset, Prometheus uses its default value. + + + It requires Prometheus >= v2.49.0. items: - description: 'ScrapeProtocol represents a protocol - used by Prometheus for scraping metrics. Supported - values are: * `OpenMetricsText0.0.1` * `OpenMetricsText1.0.0` - * `PrometheusProto` * `PrometheusText0.0.4`' + description: |- + ScrapeProtocol represents a protocol used by Prometheus for scraping metrics. + Supported values are: + * `OpenMetricsText0.0.1` + * `OpenMetricsText1.0.0` + * `PrometheusProto` + * `PrometheusText0.0.4` enum: - PrometheusProto - OpenMetricsText0.0.1 @@ -1586,59 +1779,56 @@ spec: label selector requirements. The requirements are ANDed. items: - description: A label selector requirement - is a selector that contains values, a - key, and an operator that relates the - key and values. + description: |- + A label selector requirement is a selector that contains values, a key, and an operator that + relates the key and values. properties: key: description: key is the label key that the selector applies to. type: string operator: - description: operator represents a key's - relationship to a set of values. Valid - operators are In, NotIn, Exists and - DoesNotExist. + description: |- + operator represents a key's relationship to a set of values. + Valid operators are In, NotIn, Exists and DoesNotExist. type: string values: - description: 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 + description: |- + 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. items: type: string type: array + x-kubernetes-list-type: atomic required: - key - operator type: object type: array + x-kubernetes-list-type: atomic matchLabels: additionalProperties: type: string - description: 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. + description: |- + 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. type: object type: object x-kubernetes-map-type: atomic targetLabels: - description: '`targetLabels` defines the labels - which are transferred from the associated Kubernetes - `Service` object onto the ingested metrics.' + description: |- + `targetLabels` defines the labels which are transferred from the + associated Kubernetes `Service` object onto the ingested metrics. items: type: string type: array targetLimit: - description: '`targetLimit` defines a limit on - the number of scraped targets that will be accepted.' + description: |- + `targetLimit` defines a limit on the number of scraped targets that will + be accepted. format: int64 type: integer required: @@ -1651,7 +1841,8 @@ spec: - enabled type: object numHistoryShards: - description: NumHistoryShards is the desired number of history shards. + description: |- + NumHistoryShards is the desired number of history shards. This field is immutable. format: int32 minimum: 1 @@ -1664,9 +1855,9 @@ spec: datastore specs. properties: cassandra: - description: Cassandra holds all connection parameters for - Cassandra datastore. Note that cassandra is now deprecated - for visibility store. + description: |- + Cassandra holds all connection parameters for Cassandra datastore. + Note that cassandra is now deprecated for visibility store. properties: connectTimeout: description: ConnectTimeout is a timeout for initial dial @@ -1676,9 +1867,9 @@ spec: description: Consistency configuration. properties: consistency: - description: Consistency sets the default consistency - level. Values identical to gocql Consistency values. - (defaults to LOCAL_QUORUM if not set). + description: |- + Consistency sets the default consistency level. + Values identical to gocql Consistency values. (defaults to LOCAL_QUORUM if not set). enum: - ANY - ONE @@ -1691,10 +1882,9 @@ spec: - LOCAL_ONE type: integer serialConsistency: - description: SerialConsistency sets the consistency - for the serial prtion of queries. Values identical - to gocql SerialConsistency values. (defaults to - LOCAL_SERIAL if not set) + description: |- + SerialConsistency sets the consistency for the serial prtion of queries. Values identical to gocql SerialConsistency values. + (defaults to LOCAL_SERIAL if not set) enum: - SERIAL - LOCAL_SERIAL @@ -1790,12 +1980,12 @@ spec: - version type: object name: - description: Name is the name of the datastore. It should - be unique and will be referenced within the persistence - spec. Defaults to "default" for default sore, "visibility" - for visibility store, "secondaryVisibility" for secondary - visibility store and "advancedVisibility" for advanced visibility - store. + description: |- + Name is the name of the datastore. + It should be unique and will be referenced within the persistence spec. + Defaults to "default" for default sore, "visibility" for visibility store, + "secondaryVisibility" for secondary visibility store and + "advancedVisibility" for advanced visibility store. type: string passwordSecretRef: description: PasswordSecret is the reference to the secret @@ -1936,9 +2126,9 @@ spec: description: DefaultStore holds the default datastore specs. properties: cassandra: - description: Cassandra holds all connection parameters for - Cassandra datastore. Note that cassandra is now deprecated - for visibility store. + description: |- + Cassandra holds all connection parameters for Cassandra datastore. + Note that cassandra is now deprecated for visibility store. properties: connectTimeout: description: ConnectTimeout is a timeout for initial dial @@ -1948,9 +2138,9 @@ spec: description: Consistency configuration. properties: consistency: - description: Consistency sets the default consistency - level. Values identical to gocql Consistency values. - (defaults to LOCAL_QUORUM if not set). + description: |- + Consistency sets the default consistency level. + Values identical to gocql Consistency values. (defaults to LOCAL_QUORUM if not set). enum: - ANY - ONE @@ -1963,10 +2153,9 @@ spec: - LOCAL_ONE type: integer serialConsistency: - description: SerialConsistency sets the consistency - for the serial prtion of queries. Values identical - to gocql SerialConsistency values. (defaults to - LOCAL_SERIAL if not set) + description: |- + SerialConsistency sets the consistency for the serial prtion of queries. Values identical to gocql SerialConsistency values. + (defaults to LOCAL_SERIAL if not set) enum: - SERIAL - LOCAL_SERIAL @@ -2062,12 +2251,12 @@ spec: - version type: object name: - description: Name is the name of the datastore. It should - be unique and will be referenced within the persistence - spec. Defaults to "default" for default sore, "visibility" - for visibility store, "secondaryVisibility" for secondary - visibility store and "advancedVisibility" for advanced visibility - store. + description: |- + Name is the name of the datastore. + It should be unique and will be referenced within the persistence spec. + Defaults to "default" for default sore, "visibility" for visibility store, + "secondaryVisibility" for secondary visibility store and + "advancedVisibility" for advanced visibility store. type: string passwordSecretRef: description: PasswordSecret is the reference to the secret @@ -2205,13 +2394,14 @@ spec: type: object type: object secondaryVisibilityStore: - description: SecondaryVisibilityStore holds the secondary visibility - datastore specs. Feature only available for clusters >= 1.21.0. + description: |- + SecondaryVisibilityStore holds the secondary visibility datastore specs. + Feature only available for clusters >= 1.21.0. properties: cassandra: - description: Cassandra holds all connection parameters for - Cassandra datastore. Note that cassandra is now deprecated - for visibility store. + description: |- + Cassandra holds all connection parameters for Cassandra datastore. + Note that cassandra is now deprecated for visibility store. properties: connectTimeout: description: ConnectTimeout is a timeout for initial dial @@ -2221,9 +2411,9 @@ spec: description: Consistency configuration. properties: consistency: - description: Consistency sets the default consistency - level. Values identical to gocql Consistency values. - (defaults to LOCAL_QUORUM if not set). + description: |- + Consistency sets the default consistency level. + Values identical to gocql Consistency values. (defaults to LOCAL_QUORUM if not set). enum: - ANY - ONE @@ -2236,10 +2426,9 @@ spec: - LOCAL_ONE type: integer serialConsistency: - description: SerialConsistency sets the consistency - for the serial prtion of queries. Values identical - to gocql SerialConsistency values. (defaults to - LOCAL_SERIAL if not set) + description: |- + SerialConsistency sets the consistency for the serial prtion of queries. Values identical to gocql SerialConsistency values. + (defaults to LOCAL_SERIAL if not set) enum: - SERIAL - LOCAL_SERIAL @@ -2335,12 +2524,12 @@ spec: - version type: object name: - description: Name is the name of the datastore. It should - be unique and will be referenced within the persistence - spec. Defaults to "default" for default sore, "visibility" - for visibility store, "secondaryVisibility" for secondary - visibility store and "advancedVisibility" for advanced visibility - store. + description: |- + Name is the name of the datastore. + It should be unique and will be referenced within the persistence spec. + Defaults to "default" for default sore, "visibility" for visibility store, + "secondaryVisibility" for secondary visibility store and + "advancedVisibility" for advanced visibility store. type: string passwordSecretRef: description: PasswordSecret is the reference to the secret @@ -2481,9 +2670,9 @@ spec: description: VisibilityStore holds the visibility datastore specs. properties: cassandra: - description: Cassandra holds all connection parameters for - Cassandra datastore. Note that cassandra is now deprecated - for visibility store. + description: |- + Cassandra holds all connection parameters for Cassandra datastore. + Note that cassandra is now deprecated for visibility store. properties: connectTimeout: description: ConnectTimeout is a timeout for initial dial @@ -2493,9 +2682,9 @@ spec: description: Consistency configuration. properties: consistency: - description: Consistency sets the default consistency - level. Values identical to gocql Consistency values. - (defaults to LOCAL_QUORUM if not set). + description: |- + Consistency sets the default consistency level. + Values identical to gocql Consistency values. (defaults to LOCAL_QUORUM if not set). enum: - ANY - ONE @@ -2508,10 +2697,9 @@ spec: - LOCAL_ONE type: integer serialConsistency: - description: SerialConsistency sets the consistency - for the serial prtion of queries. Values identical - to gocql SerialConsistency values. (defaults to - LOCAL_SERIAL if not set) + description: |- + SerialConsistency sets the consistency for the serial prtion of queries. Values identical to gocql SerialConsistency values. + (defaults to LOCAL_SERIAL if not set) enum: - SERIAL - LOCAL_SERIAL @@ -2607,12 +2795,12 @@ spec: - version type: object name: - description: Name is the name of the datastore. It should - be unique and will be referenced within the persistence - spec. Defaults to "default" for default sore, "visibility" - for visibility store, "secondaryVisibility" for secondary - visibility store and "advancedVisibility" for advanced visibility - store. + description: |- + Name is the name of the datastore. + It should be unique and will be referenced within the persistence spec. + Defaults to "default" for default sore, "visibility" for visibility store, + "secondaryVisibility" for secondary visibility store and + "advancedVisibility" for advanced visibility store. type: string passwordSecretRef: description: PasswordSecret is the reference to the secret @@ -2761,8 +2949,10 @@ spec: description: Frontend service custom specifications. properties: httpPort: - description: 'HTTPPort defines a custom http port for the - service. Default values are: 7243 for Frontend service' + description: |- + HTTPPort defines a custom http port for the service. + Default values are: + 7243 for Frontend service type: integer initContainers: description: InitContainers adds a list of init containers @@ -2774,39 +2964,41 @@ spec: x-kubernetes-preserve-unknown-fields: true type: array membershipPort: - description: 'MembershipPort defines a custom membership port - for the service. Default values are: 6933 for Frontend service - 6934 for History service 6935 for Matching service 6939 - for Worker service' + description: |- + MembershipPort defines a custom membership port for the service. + Default values are: + 6933 for Frontend service + 6934 for History service + 6935 for Matching service + 6939 for Worker service type: integer overrides: - description: Overrides adds some overrides to the resources - deployed for the service. Those overrides takes precedence - over spec.services.overrides. + description: |- + Overrides adds some overrides to the resources deployed for the service. + Those overrides takes precedence over spec.services.overrides. properties: deployment: description: Override configuration for the temporal service Deployment. properties: metadata: - description: ObjectMetaOverride provides the ability - to override an object metadata. It's a subset of - the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured key - value map stored with a resource that may be - set by external tools to store and retrieve - arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that - can be used to organize and categorize (scope - and select) objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object spec: @@ -2818,40 +3010,41 @@ spec: will be created. properties: metadata: - description: ObjectMetaOverride provides the - ability to override an object metadata. - It's a subset of the fields included in - k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured - key value map stored with a resource - that may be set by external tools to - store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values - that can be used to organize and categorize + description: |- + Map of string keys and values that can be used to organize and categorize (scope and select) objects. type: object type: object spec: description: Specification of the desired behavior of the pod. - type: object x-kubernetes-preserve-unknown-fields: true type: object type: object type: object type: object port: - description: 'Port defines a custom gRPC port for the service. - Default values are: 7233 for Frontend service 7234 for History - service 7235 for Matching service 7239 for Worker service' + description: |- + Port defines a custom gRPC port for the service. + Default values are: + 7233 for Frontend service + 7234 for History service + 7235 for Matching service + 7239 for Worker service type: integer replicas: description: Number of desired replicas for the service. Default @@ -2860,22 +3053,28 @@ spec: minimum: 1 type: integer resources: - description: 'Compute Resources required by this service. - More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Compute Resources required by this service. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ properties: claims: - description: "Claims lists the names of resources, defined - in spec.resourceClaims, that are used by this container. - \n This is an alpha field and requires enabling the - DynamicResourceAllocation feature gate. \n This field - is immutable. It can only be set for containers." + description: |- + 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. items: description: ResourceClaim references one entry in PodSpec.ResourceClaims. properties: name: - description: 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 + description: |- + 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. type: string required: @@ -2892,8 +3091,9 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ type: object requests: additionalProperties: @@ -2902,11 +3102,11 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: '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/' + description: |- + 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/ type: object type: object type: object @@ -2914,8 +3114,10 @@ spec: description: History service custom specifications. properties: httpPort: - description: 'HTTPPort defines a custom http port for the - service. Default values are: 7243 for Frontend service' + description: |- + HTTPPort defines a custom http port for the service. + Default values are: + 7243 for Frontend service type: integer initContainers: description: InitContainers adds a list of init containers @@ -2927,39 +3129,41 @@ spec: x-kubernetes-preserve-unknown-fields: true type: array membershipPort: - description: 'MembershipPort defines a custom membership port - for the service. Default values are: 6933 for Frontend service - 6934 for History service 6935 for Matching service 6939 - for Worker service' + description: |- + MembershipPort defines a custom membership port for the service. + Default values are: + 6933 for Frontend service + 6934 for History service + 6935 for Matching service + 6939 for Worker service type: integer overrides: - description: Overrides adds some overrides to the resources - deployed for the service. Those overrides takes precedence - over spec.services.overrides. + description: |- + Overrides adds some overrides to the resources deployed for the service. + Those overrides takes precedence over spec.services.overrides. properties: deployment: description: Override configuration for the temporal service Deployment. properties: metadata: - description: ObjectMetaOverride provides the ability - to override an object metadata. It's a subset of - the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured key - value map stored with a resource that may be - set by external tools to store and retrieve - arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that - can be used to organize and categorize (scope - and select) objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object spec: @@ -2971,40 +3175,41 @@ spec: will be created. properties: metadata: - description: ObjectMetaOverride provides the - ability to override an object metadata. - It's a subset of the fields included in - k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured - key value map stored with a resource - that may be set by external tools to - store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values - that can be used to organize and categorize + description: |- + Map of string keys and values that can be used to organize and categorize (scope and select) objects. type: object type: object spec: description: Specification of the desired behavior of the pod. - type: object x-kubernetes-preserve-unknown-fields: true type: object type: object type: object type: object port: - description: 'Port defines a custom gRPC port for the service. - Default values are: 7233 for Frontend service 7234 for History - service 7235 for Matching service 7239 for Worker service' + description: |- + Port defines a custom gRPC port for the service. + Default values are: + 7233 for Frontend service + 7234 for History service + 7235 for Matching service + 7239 for Worker service type: integer replicas: description: Number of desired replicas for the service. Default @@ -3013,22 +3218,28 @@ spec: minimum: 1 type: integer resources: - description: 'Compute Resources required by this service. - More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Compute Resources required by this service. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ properties: claims: - description: "Claims lists the names of resources, defined - in spec.resourceClaims, that are used by this container. - \n This is an alpha field and requires enabling the - DynamicResourceAllocation feature gate. \n This field - is immutable. It can only be set for containers." + description: |- + 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. items: description: ResourceClaim references one entry in PodSpec.ResourceClaims. properties: name: - description: 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 + description: |- + 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. type: string required: @@ -3045,8 +3256,9 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ type: object requests: additionalProperties: @@ -3055,16 +3267,17 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: '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/' + description: |- + 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/ type: object type: object type: object internalFrontend: - description: Internal Frontend service custom specifications. + description: |- + Internal Frontend service custom specifications. Only compatible with temporal >= 1.20.0 properties: enabled: @@ -3073,8 +3286,10 @@ spec: frontend service. type: boolean httpPort: - description: 'HTTPPort defines a custom http port for the - service. Default values are: 7243 for Frontend service' + description: |- + HTTPPort defines a custom http port for the service. + Default values are: + 7243 for Frontend service type: integer initContainers: description: InitContainers adds a list of init containers @@ -3086,39 +3301,41 @@ spec: x-kubernetes-preserve-unknown-fields: true type: array membershipPort: - description: 'MembershipPort defines a custom membership port - for the service. Default values are: 6933 for Frontend service - 6934 for History service 6935 for Matching service 6939 - for Worker service' + description: |- + MembershipPort defines a custom membership port for the service. + Default values are: + 6933 for Frontend service + 6934 for History service + 6935 for Matching service + 6939 for Worker service type: integer overrides: - description: Overrides adds some overrides to the resources - deployed for the service. Those overrides takes precedence - over spec.services.overrides. + description: |- + Overrides adds some overrides to the resources deployed for the service. + Those overrides takes precedence over spec.services.overrides. properties: deployment: description: Override configuration for the temporal service Deployment. properties: metadata: - description: ObjectMetaOverride provides the ability - to override an object metadata. It's a subset of - the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured key - value map stored with a resource that may be - set by external tools to store and retrieve - arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that - can be used to organize and categorize (scope - and select) objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object spec: @@ -3130,40 +3347,41 @@ spec: will be created. properties: metadata: - description: ObjectMetaOverride provides the - ability to override an object metadata. - It's a subset of the fields included in - k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured - key value map stored with a resource - that may be set by external tools to - store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values - that can be used to organize and categorize + description: |- + Map of string keys and values that can be used to organize and categorize (scope and select) objects. type: object type: object spec: description: Specification of the desired behavior of the pod. - type: object x-kubernetes-preserve-unknown-fields: true type: object type: object type: object type: object port: - description: 'Port defines a custom gRPC port for the service. - Default values are: 7233 for Frontend service 7234 for History - service 7235 for Matching service 7239 for Worker service' + description: |- + Port defines a custom gRPC port for the service. + Default values are: + 7233 for Frontend service + 7234 for History service + 7235 for Matching service + 7239 for Worker service type: integer replicas: description: Number of desired replicas for the service. Default @@ -3172,22 +3390,28 @@ spec: minimum: 1 type: integer resources: - description: 'Compute Resources required by this service. - More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Compute Resources required by this service. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ properties: claims: - description: "Claims lists the names of resources, defined - in spec.resourceClaims, that are used by this container. - \n This is an alpha field and requires enabling the - DynamicResourceAllocation feature gate. \n This field - is immutable. It can only be set for containers." + description: |- + 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. items: description: ResourceClaim references one entry in PodSpec.ResourceClaims. properties: name: - description: 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 + description: |- + 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. type: string required: @@ -3204,8 +3428,9 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ type: object requests: additionalProperties: @@ -3214,11 +3439,11 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: '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/' + description: |- + 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/ type: object type: object type: object @@ -3226,8 +3451,10 @@ spec: description: Matching service custom specifications. properties: httpPort: - description: 'HTTPPort defines a custom http port for the - service. Default values are: 7243 for Frontend service' + description: |- + HTTPPort defines a custom http port for the service. + Default values are: + 7243 for Frontend service type: integer initContainers: description: InitContainers adds a list of init containers @@ -3239,39 +3466,41 @@ spec: x-kubernetes-preserve-unknown-fields: true type: array membershipPort: - description: 'MembershipPort defines a custom membership port - for the service. Default values are: 6933 for Frontend service - 6934 for History service 6935 for Matching service 6939 - for Worker service' + description: |- + MembershipPort defines a custom membership port for the service. + Default values are: + 6933 for Frontend service + 6934 for History service + 6935 for Matching service + 6939 for Worker service type: integer overrides: - description: Overrides adds some overrides to the resources - deployed for the service. Those overrides takes precedence - over spec.services.overrides. + description: |- + Overrides adds some overrides to the resources deployed for the service. + Those overrides takes precedence over spec.services.overrides. properties: deployment: description: Override configuration for the temporal service Deployment. properties: metadata: - description: ObjectMetaOverride provides the ability - to override an object metadata. It's a subset of - the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured key - value map stored with a resource that may be - set by external tools to store and retrieve - arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that - can be used to organize and categorize (scope - and select) objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object spec: @@ -3283,40 +3512,41 @@ spec: will be created. properties: metadata: - description: ObjectMetaOverride provides the - ability to override an object metadata. - It's a subset of the fields included in - k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured - key value map stored with a resource - that may be set by external tools to - store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values - that can be used to organize and categorize + description: |- + Map of string keys and values that can be used to organize and categorize (scope and select) objects. type: object type: object spec: description: Specification of the desired behavior of the pod. - type: object x-kubernetes-preserve-unknown-fields: true type: object type: object type: object type: object port: - description: 'Port defines a custom gRPC port for the service. - Default values are: 7233 for Frontend service 7234 for History - service 7235 for Matching service 7239 for Worker service' + description: |- + Port defines a custom gRPC port for the service. + Default values are: + 7233 for Frontend service + 7234 for History service + 7235 for Matching service + 7239 for Worker service type: integer replicas: description: Number of desired replicas for the service. Default @@ -3325,22 +3555,28 @@ spec: minimum: 1 type: integer resources: - description: 'Compute Resources required by this service. - More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Compute Resources required by this service. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ properties: claims: - description: "Claims lists the names of resources, defined - in spec.resourceClaims, that are used by this container. - \n This is an alpha field and requires enabling the - DynamicResourceAllocation feature gate. \n This field - is immutable. It can only be set for containers." + description: |- + 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. items: description: ResourceClaim references one entry in PodSpec.ResourceClaims. properties: name: - description: 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 + description: |- + 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. type: string required: @@ -3357,8 +3593,9 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ type: object requests: additionalProperties: @@ -3367,41 +3604,41 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: '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/' + description: |- + 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/ type: object type: object type: object overrides: - description: Overrides adds some overrides to the resources deployed - for all temporal services services. Those overrides can be customized - per service using spec.services..overrides. + description: |- + Overrides adds some overrides to the resources deployed for all temporal services services. + Those overrides can be customized per service using spec.services..overrides. properties: deployment: description: Override configuration for the temporal service Deployment. properties: metadata: - description: ObjectMetaOverride provides the ability to - override an object metadata. It's a subset of the fields - included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured key value - map stored with a resource that may be set by external - tools to store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that can - be used to organize and categorize (scope and select) - objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object spec: @@ -3413,30 +3650,28 @@ spec: be created. properties: metadata: - description: ObjectMetaOverride provides the ability - to override an object metadata. It's a subset - of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured - key value map stored with a resource that - may be set by external tools to store and - retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values - that can be used to organize and categorize + description: |- + Map of string keys and values that can be used to organize and categorize (scope and select) objects. type: object type: object spec: description: Specification of the desired behavior of the pod. - type: object x-kubernetes-preserve-unknown-fields: true type: object type: object @@ -3446,8 +3681,10 @@ spec: description: Worker service custom specifications. properties: httpPort: - description: 'HTTPPort defines a custom http port for the - service. Default values are: 7243 for Frontend service' + description: |- + HTTPPort defines a custom http port for the service. + Default values are: + 7243 for Frontend service type: integer initContainers: description: InitContainers adds a list of init containers @@ -3459,39 +3696,41 @@ spec: x-kubernetes-preserve-unknown-fields: true type: array membershipPort: - description: 'MembershipPort defines a custom membership port - for the service. Default values are: 6933 for Frontend service - 6934 for History service 6935 for Matching service 6939 - for Worker service' + description: |- + MembershipPort defines a custom membership port for the service. + Default values are: + 6933 for Frontend service + 6934 for History service + 6935 for Matching service + 6939 for Worker service type: integer overrides: - description: Overrides adds some overrides to the resources - deployed for the service. Those overrides takes precedence - over spec.services.overrides. + description: |- + Overrides adds some overrides to the resources deployed for the service. + Those overrides takes precedence over spec.services.overrides. properties: deployment: description: Override configuration for the temporal service Deployment. properties: metadata: - description: ObjectMetaOverride provides the ability - to override an object metadata. It's a subset of - the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured key - value map stored with a resource that may be - set by external tools to store and retrieve - arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that - can be used to organize and categorize (scope - and select) objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object spec: @@ -3503,40 +3742,41 @@ spec: will be created. properties: metadata: - description: ObjectMetaOverride provides the - ability to override an object metadata. - It's a subset of the fields included in - k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured - key value map stored with a resource - that may be set by external tools to - store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values - that can be used to organize and categorize + description: |- + Map of string keys and values that can be used to organize and categorize (scope and select) objects. type: object type: object spec: description: Specification of the desired behavior of the pod. - type: object x-kubernetes-preserve-unknown-fields: true type: object type: object type: object type: object port: - description: 'Port defines a custom gRPC port for the service. - Default values are: 7233 for Frontend service 7234 for History - service 7235 for Matching service 7239 for Worker service' + description: |- + Port defines a custom gRPC port for the service. + Default values are: + 7233 for Frontend service + 7234 for History service + 7235 for Matching service + 7239 for Worker service type: integer replicas: description: Number of desired replicas for the service. Default @@ -3545,22 +3785,28 @@ spec: minimum: 1 type: integer resources: - description: 'Compute Resources required by this service. - More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Compute Resources required by this service. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ properties: claims: - description: "Claims lists the names of resources, defined - in spec.resourceClaims, that are used by this container. - \n This is an alpha field and requires enabling the - DynamicResourceAllocation feature gate. \n This field - is immutable. It can only be set for containers." + description: |- + 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. items: description: ResourceClaim references one entry in PodSpec.ResourceClaims. properties: name: - description: 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 + description: |- + 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. type: string required: @@ -3577,8 +3823,9 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ type: object requests: additionalProperties: @@ -3587,11 +3834,11 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: '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/' + description: |- + 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/ type: object type: object type: object @@ -3609,9 +3856,9 @@ spec: should run. type: string ingress: - description: Ingress is an optional ingress configuration for - the UI. If lived empty, no ingress configuration will be created - and the UI will only by available trough ClusterIP service. + description: |- + Ingress is an optional ingress configuration for the UI. + If lived empty, no ingress configuration will be created and the UI will only by available trough ClusterIP service. properties: annotations: additionalProperties: @@ -3635,23 +3882,22 @@ spec: associated with an ingress. properties: hosts: - description: 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. + description: |- + 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. items: type: string type: array x-kubernetes-list-type: atomic secretName: - description: 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. + description: |- + 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. type: string type: object type: array @@ -3667,23 +3913,23 @@ spec: Deployment. properties: metadata: - description: ObjectMetaOverride provides the ability to - override an object metadata. It's a subset of the fields - included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured key value - map stored with a resource that may be set by external - tools to store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that can - be used to organize and categorize (scope and select) - objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object spec: @@ -3695,30 +3941,28 @@ spec: be created. properties: metadata: - description: ObjectMetaOverride provides the ability - to override an object metadata. It's a subset - of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. + description: |- + ObjectMetaOverride provides the ability to override an object metadata. + It's a subset of the fields included in k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. properties: annotations: additionalProperties: type: string - description: Annotations is an unstructured - key value map stored with a resource that - may be set by external tools to store and - retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values - that can be used to organize and categorize + description: |- + Map of string keys and values that can be used to organize and categorize (scope and select) objects. type: object type: object spec: description: Specification of the desired behavior of the pod. - type: object x-kubernetes-preserve-unknown-fields: true type: object type: object @@ -3731,23 +3975,29 @@ spec: minimum: 1 type: integer resources: - description: 'Compute Resources required by the ui. More info: - https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Compute Resources required by the ui. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ properties: claims: - description: "Claims lists the names of resources, defined - in spec.resourceClaims, that are used by this container. - \n This is an alpha field and requires enabling the DynamicResourceAllocation - feature gate. \n This field is immutable. It can only be - set for containers." + description: |- + 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. items: description: ResourceClaim references one entry in PodSpec.ResourceClaims. properties: name: - description: 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. + description: |- + 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. type: string required: - name @@ -3763,8 +4013,9 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: 'Limits describes the maximum amount of compute - resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/' + description: |- + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ type: object requests: additionalProperties: @@ -3773,11 +4024,11 @@ spec: - type: string pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true - description: '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/' + description: |- + 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/ type: object type: object service: @@ -3787,15 +4038,16 @@ spec: annotations: additionalProperties: type: string - description: Annotations is an unstructured key value map - stored with a resource that may be set by external tools - to store and retrieve arbitrary metadata. + description: |- + Annotations is an unstructured key value map stored with a resource that may be + set by external tools to store and retrieve arbitrary metadata. type: object labels: additionalProperties: type: string - description: Map of string keys and values that can be used - to organize and categorize (scope and select) objects. + description: |- + Map of string keys and values that can be used to organize and categorize + (scope and select) objects. type: object type: object version: @@ -3804,9 +4056,9 @@ spec: type: string type: object version: - description: Version defines the temporal version the cluster to be - deployed. This version impacts the underlying persistence schemas - versions. + description: |- + Version defines the temporal version the cluster to be deployed. + This version impacts the underlying persistence schemas versions. type: string required: - numHistoryShards @@ -3820,42 +4072,42 @@ spec: of the Cluster state. items: description: "Condition contains details for one aspect of the current - state of this API Resource. --- This struct is intended for direct - use as an array at the field path .status.conditions. For example, - \n type FooStatus struct{ // Represents the observations of a - foo's current state. // Known .status.conditions.type are: \"Available\", - \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge - // +listType=map // +listMapKey=type Conditions []metav1.Condition - `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" - protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }" + state of this API Resource.\n---\nThis struct is intended for + direct use as an array at the field path .status.conditions. For + example,\n\n\n\ttype FooStatus struct{\n\t // Represents the + observations of a foo's current state.\n\t // Known .status.conditions.type + are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // + +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t + \ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" + patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t + \ // other fields\n\t}" properties: lastTransitionTime: - description: 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. + description: |- + 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. format: date-time type: string message: - description: message is a human readable message indicating - details about the transition. This may be an empty string. + description: |- + message is a human readable message indicating details about the transition. + This may be an empty string. maxLength: 32768 type: string observedGeneration: - description: 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. + description: |- + 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 minimum: 0 type: integer reason: - description: 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. + description: |- + 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. maxLength: 1024 minLength: 1 @@ -3869,11 +4121,12 @@ spec: - Unknown type: string type: - description: type of condition in CamelCase or in foo.example.com/CamelCase. - --- Many .condition.type values are consistent across resources - like Available, but because arbitrary conditions can be useful - (see .node.status.conditions), the ability to deconflict is - important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) + description: |- + type of condition in CamelCase or in foo.example.com/CamelCase. + --- + Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be + useful (see .node.status.conditions), the ability to deconflict is important. + The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) maxLength: 316 pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ type: string diff --git a/bundle/manifests/temporal.io_temporalnamespaces.yaml b/bundle/manifests/temporal.io_temporalnamespaces.yaml index e0675930..9fa47c30 100644 --- a/bundle/manifests/temporal.io_temporalnamespaces.yaml +++ b/bundle/manifests/temporal.io_temporalnamespaces.yaml @@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.11.3 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null name: temporalnamespaces.temporal.io spec: @@ -21,14 +21,19 @@ spec: cluster. properties: apiVersion: - description: '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' + description: |- + 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 type: string kind: - description: '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' + description: |- + 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 type: string metadata: type: object @@ -36,16 +41,19 @@ spec: description: TemporalNamespaceSpec defines the desired state of Namespace. properties: activeClusterName: - description: The name of active Temporal Cluster. Only applicable - if the namespace is a global namespace. + description: |- + The name of active Temporal Cluster. + Only applicable if the namespace is a global namespace. type: string allowDeletion: - description: AllowDeletion makes the controller delete the Temporal - namespace if the CRD is deleted. + description: |- + AllowDeletion makes the controller delete the Temporal namespace if the + CRD is deleted. type: boolean archival: - description: Archival is a per-namespace archival configuration. If - not set, the default cluster configuration is used. + description: |- + Archival is a per-namespace archival configuration. + If not set, the default cluster configuration is used. properties: history: description: History is the config for this namespace history @@ -58,9 +66,9 @@ spec: type: boolean enabled: default: false - description: Enabled defines if the archival is enabled by - default for all namespaces or for a particular namespace - (depends if it's for a TemporalCluster or a TemporalNamespace). + description: |- + Enabled defines if the archival is enabled by default for all namespaces + or for a particular namespace (depends if it's for a TemporalCluster or a TemporalNamespace). type: boolean path: description: Path is ... @@ -85,9 +93,9 @@ spec: type: boolean enabled: default: false - description: Enabled defines if the archival is enabled by - default for all namespaces or for a particular namespace - (depends if it's for a TemporalCluster or a TemporalNamespace). + description: |- + Enabled defines if the archival is enabled by default for all namespaces + or for a particular namespace (depends if it's for a TemporalCluster or a TemporalNamespace). type: boolean path: description: Path is ... @@ -107,16 +115,18 @@ spec: be created. properties: name: - description: The name of the TemporalCluster to reference. + description: The name of the temporal object to reference. type: string namespace: - description: The namespace of the TemporalCluster to reference. + description: |- + The namespace of the temporal object to reference. Defaults to the namespace of the requested resource if omitted. type: string type: object clusters: - description: List of clusters names to which the namespace can fail - over. Only applicable if the namespace is a global namespace. + description: |- + List of clusters names to which the namespace can fail over. + Only applicable if the namespace is a global namespace. items: type: string type: array @@ -152,42 +162,42 @@ spec: of the Namespace state. items: description: "Condition contains details for one aspect of the current - state of this API Resource. --- This struct is intended for direct - use as an array at the field path .status.conditions. For example, - \n type FooStatus struct{ // Represents the observations of a - foo's current state. // Known .status.conditions.type are: \"Available\", - \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge - // +listType=map // +listMapKey=type Conditions []metav1.Condition - `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" - protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }" + state of this API Resource.\n---\nThis struct is intended for + direct use as an array at the field path .status.conditions. For + example,\n\n\n\ttype FooStatus struct{\n\t // Represents the + observations of a foo's current state.\n\t // Known .status.conditions.type + are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // + +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t + \ // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" + patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t + \ // other fields\n\t}" properties: lastTransitionTime: - description: 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. + description: |- + 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. format: date-time type: string message: - description: message is a human readable message indicating - details about the transition. This may be an empty string. + description: |- + message is a human readable message indicating details about the transition. + This may be an empty string. maxLength: 32768 type: string observedGeneration: - description: 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. + description: |- + 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 minimum: 0 type: integer reason: - description: 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. + description: |- + 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. maxLength: 1024 minLength: 1 @@ -201,11 +211,12 @@ spec: - Unknown type: string type: - description: type of condition in CamelCase or in foo.example.com/CamelCase. - --- Many .condition.type values are consistent across resources - like Available, but because arbitrary conditions can be useful - (see .node.status.conditions), the ability to deconflict is - important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) + description: |- + type of condition in CamelCase or in foo.example.com/CamelCase. + --- + Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be + useful (see .node.status.conditions), the ability to deconflict is important. + The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) maxLength: 316 pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ type: string diff --git a/bundle/manifests/temporal.io_temporalschedules.yaml b/bundle/manifests/temporal.io_temporalschedules.yaml new file mode 100644 index 00000000..1148ce86 --- /dev/null +++ b/bundle/manifests/temporal.io_temporalschedules.yaml @@ -0,0 +1,1038 @@ +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.15.0 + creationTimestamp: null + name: temporalschedules.temporal.io +spec: + group: temporal.io + names: + kind: TemporalSchedule + listKind: TemporalScheduleList + plural: temporalschedules + singular: temporalschedule + scope: Namespaced + versions: + - additionalPrinterColumns: + - jsonPath: .status.conditions[?(@.type == 'Ready')].status + name: Ready + type: string + - jsonPath: .status.conditions[?(@.type == 'ReconcileSuccess')].status + name: ReconcileSuccess + type: string + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1beta1 + schema: + openAPIV3Schema: + description: A TemporalSchedule creates a schedule in the targeted temporal + cluster. + properties: + apiVersion: + description: |- + 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 + type: string + kind: + description: |- + 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 + type: string + metadata: + type: object + spec: + description: TemporalScheduleSpec defines the desired state of Schedule. + properties: + allowDeletion: + description: |- + AllowDeletion makes the controller delete the Temporal schedule if the + CRD is deleted. + type: boolean + memo: + description: Memo is optional non-indexed info that will be shown + in list workflow. + type: object + x-kubernetes-preserve-unknown-fields: true + namespaceRef: + description: Reference to the temporal namespace the schedule will + be created in. + properties: + name: + description: The name of the temporal object to reference. + type: string + namespace: + description: |- + The namespace of the temporal object to reference. + Defaults to the namespace of the requested resource if omitted. + type: string + type: object + schedule: + description: Schedule contains all fields related to a schedule. + properties: + action: + description: ScheduleAction contains the actions that the schedule + should perform. + properties: + workflow: + description: ScheduleWorkflowAction describes a workflow to + launch. + properties: + executionTimeout: + description: WorkflowExecutionTimeout is the timeout for + duration of workflow execution. + type: string + id: + description: |- + WorkflowID represents the business identifier of the workflow execution. + The WorkflowID of the started workflow may not match this exactly, + it may have a timestamp appended for uniqueness. + Defaults to a uuid. + type: string + inputs: + description: Inputs contains arguments to pass to the + workflow. + x-kubernetes-preserve-unknown-fields: true + memo: + description: Memo is optional non-indexed info that will + be shown in list workflow. + type: object + x-kubernetes-preserve-unknown-fields: true + retryPolicy: + description: |- + RetryPolicy is the retry policy for the workflow. If a retry policy is specified, + in case of workflow failure server will start new workflow execution if + needed based on the retry policy. + properties: + backoffCoefficient: + anyOf: + - type: integer + - type: string + description: |- + Coefficient used to calculate the next retry interval. + The next retry interval is previous interval multiplied by the coefficient. + Must be 1 or larger. + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + initialInterval: + description: Interval of the first retry. If retryBackoffCoefficient + is 1.0 then it is used for all retries. + type: string + maximumAttempts: + description: |- + Maximum number of attempts. When exceeded the retries stop even if not expired yet. + 1 disables retries. 0 means unlimited (up to the timeouts). + format: int32 + type: integer + maximumInterval: + description: |- + Maximum interval between retries. Exponential backoff leads to interval increase. + This value is the cap of the increase. Default is 100x of the initial interval. + type: string + nonRetryableErrorTypes: + description: |- + Non-Retryable errors types. Will stop retrying if the error type matches this list. Note that + this is not a substring match, the error *type* (not message) must match exactly. + items: + type: string + type: array + type: object + runTimeout: + description: WorkflowRunTimeout is the timeout for duration + of a single workflow run. + type: string + searchAttributes: + description: |- + SearchAttributes is optional indexed info that can be used in query of List/Scan/Count workflow APIs. The key + and value type must be registered on Temporal server side. For supported operations on different server versions + see [Visibility]. + + + [Visibility]: https://docs.temporal.io/visibility + type: object + x-kubernetes-preserve-unknown-fields: true + taskQueue: + description: |- + TaskQueue represents a workflow task queue. + This is also the name of the activity task queue on which activities are scheduled. + type: string + taskTimeout: + description: |- + WorkflowTaskTimeout is The timeout for processing workflow task from the time the worker + pulled this task. + type: string + type: + description: |- + WorkflowType represents the identifier used by a workflow author to define the workflow + Workflow type name. + type: string + required: + - taskQueue + - type + type: object + required: + - workflow + type: object + policy: + description: SchedulePolicies represent policies for overlaps, + catchups, pause on failure, and workflow ID. + properties: + catchupWindow: + description: |- + CatchupWindow The Temporal Server might be down or unavailable at the time + when a Schedule should take an Action. When the Server comes back up, + CatchupWindow controls which missed Actions should be taken at that point. + type: string + overlap: + description: |- + Overlap controls what happens when an Action would be started by a + Schedule at the same time that an older Action is still running. + + + Supported values: + + + "skip" - Default. Nothing happens; the Workflow Execution is not started. + + + "bufferOne" - Starts the Workflow Execution as soon as the current one completes. + The buffer is limited to one. If another Workflow Execution is supposed to start, + but one is already in the buffer, only the one in the buffer eventually starts. + + + "bufferAll" - Allows an unlimited number of Workflows to buffer. They are started sequentially. + + + "cancelOther" - Cancels the running Workflow Execution, and then starts the new one + after the old one completes cancellation. + + + "terminateOther" - Terminates the running Workflow Execution and starts the new one immediately. + + + "allowAll" - Starts any number of concurrent Workflow Executions. + With this policy (and only this policy), more than one Workflow Execution, + started by the Schedule, can run simultaneously. + enum: + - skip + - bufferOne + - bufferAll + - cancelOther + - terminateOther + - allowAll + type: string + pauseOnFailure: + description: |- + PauseOnFailure if true, and a workflow run fails or times out, turn on "paused". + This applies after retry policies: the full chain of retries must fail to trigger a pause here. + type: boolean + type: object + spec: + description: ScheduleSpec is a complete description of a set of + absolute timestamps. + properties: + calendars: + description: Calendars represents calendar-based specifications + of times. + items: + description: |- + ScheduleCalendarSpec is an event specification relative to the calendar, similar to a traditional cron specification. + A timestamp matches if at least one range of each field matches the + corresponding fields of the timestamp, except for year: if year is missing, + that means all years match. For all fields besides year, at least one Range must be present to match anything. + properties: + comment: + description: Comment describes the intention of this + schedule. + type: string + dayOfMonth: + default: + - end: 31 + description: |- + DayOfMonth range to match (1-31) + Defaults to match all days. + items: + description: |- + If end < start, then end is interpreted as + equal to start. This means you can use a Range with start set to a value, and + end and step unset to represent a single value. + properties: + end: + description: |- + End of the range (inclusive). + Defaults to start. + format: int32 + maximum: 31 + minimum: 1 + type: integer + start: + default: 1 + description: |- + Start of the range (inclusive). + Defaults to 1. + format: int32 + maximum: 31 + minimum: 1 + type: integer + step: + default: 1 + description: |- + Step to be take between each value. + Defaults to 1. + format: int32 + maximum: 31 + minimum: 1 + type: integer + type: object + type: array + dayOfWeek: + default: + - end: 6 + description: |- + DayOfWeek range to match (0-6; 0 is Sunday) + Defaults to match all days of the week. + items: + description: |- + If end < start, then end is interpreted as + equal to start. This means you can use a Range with start set to a value, and + end and step unset to represent a single value. + properties: + end: + description: |- + End of the range (inclusive). + Defaults to start. + format: int32 + maximum: 6 + minimum: 0 + type: integer + start: + description: |- + Start of the range (inclusive). + Defaults to 0. + format: int32 + maximum: 6 + minimum: 0 + type: integer + step: + default: 1 + description: |- + Step to be take between each value. + Defaults to 1. + format: int32 + maximum: 6 + minimum: 0 + type: integer + type: object + type: array + hour: + default: + - start: 0 + description: |- + Hour range to match (0-23). + Defaults to 0. + items: + description: |- + If end < start, then end is interpreted as + equal to start. This means you can use a Range with start set to a value, and + end and step unset to represent a single value. + properties: + end: + description: |- + End of the range (inclusive). + Defaults to start. + format: int32 + maximum: 23 + minimum: 0 + type: integer + start: + description: |- + Start of the range (inclusive). + Defaults to 0. + format: int32 + maximum: 23 + minimum: 0 + type: integer + step: + default: 1 + description: |- + Step to be take between each value. + Defaults to 1. + format: int32 + maximum: 23 + minimum: 1 + type: integer + type: object + type: array + minute: + default: + - start: 0 + description: |- + Minute range to match (0-59). + Defaults to 0. + items: + description: |- + If end < start, then end is interpreted as + equal to start. This means you can use a Range with start set to a value, and + end and step unset to represent a single value. + properties: + end: + description: |- + End of the range (inclusive). + Defaults to start. + format: int32 + maximum: 59 + minimum: 0 + type: integer + start: + description: |- + Start of the range (inclusive). + Defaults to 0. + format: int32 + maximum: 59 + minimum: 0 + type: integer + step: + default: 1 + description: |- + Step to be take between each value. + Defaults to 1. + format: int32 + maximum: 59 + minimum: 1 + type: integer + type: object + type: array + month: + default: + - end: 12 + description: |- + Month range to match (1-12). + Defaults to match all months. + items: + description: |- + If end < start, then end is interpreted as + equal to start. This means you can use a Range with start set to a value, and + end and step unset to represent a single value. + properties: + end: + description: |- + End of the range (inclusive). + Defaults to start. + format: int32 + maximum: 12 + minimum: 1 + type: integer + start: + default: 1 + description: |- + Start of the range (inclusive). + Defaults to 1. + format: int32 + maximum: 12 + minimum: 1 + type: integer + step: + default: 1 + description: |- + Step to be take between each value. + Defaults to 1. + format: int32 + maximum: 12 + minimum: 1 + type: integer + type: object + type: array + second: + default: + - start: 0 + description: |- + Second range to match (0-59). + Defaults to 0. + items: + description: |- + If end < start, then end is interpreted as + equal to start. This means you can use a Range with start set to a value, and + end and step unset to represent a single value. + properties: + end: + description: |- + End of the range (inclusive). + Defaults to start. + format: int32 + maximum: 59 + minimum: 0 + type: integer + start: + description: |- + Start of the range (inclusive). + Defaults to 0. + format: int32 + maximum: 59 + minimum: 0 + type: integer + step: + default: 1 + description: |- + Step to be take between each value. + Defaults to 1. + format: int32 + maximum: 59 + minimum: 1 + type: integer + type: object + type: array + year: + description: |- + Year range to match. + Defaults to match all years. + items: + description: |- + If end < start, then end is interpreted as + equal to start. This means you can use a Range with start set to a value, and + end and step unset to represent a single value. + properties: + end: + description: |- + End of the range (inclusive). + Defaults to start. + format: int32 + minimum: 1970 + type: integer + start: + description: Start of the range (inclusive). + format: int32 + minimum: 1970 + type: integer + step: + default: 1 + description: |- + Step to be take between each value. + Defaults to 1. + format: int32 + minimum: 1 + type: integer + type: object + type: array + type: object + type: array + crons: + description: "Crons are cron based specifications of times.\nCrons + is provided for easy migration from legacy Cron Workflows. + For new\nuse cases, we recommend using ScheduleSpec.Calendars + or ScheduleSpec.\nIntervals for readability and maintainability. + Once a schedule is created all\nexpressions in Crons will + be translated to ScheduleSpec.Calendars on the server.\n\n\nFor + example, `0 12 * * MON-WED,FRI` is every M/Tu/W/F at noon\n\n\nThe + string can have 5, 6, or 7 fields, separated by spaces, + and they are interpreted in the\nsame way as a ScheduleCalendarSpec:\n\n\n\t- + 5 fields: Minute, Hour, DayOfMonth, Month, DayOfWeek\n\n\n\t- + 6 fields: Minute, Hour, DayOfMonth, Month, DayOfWeek, + Year\n\n\n\t- 7 fields: Second, Minute, Hour, DayOfMonth, + Month, DayOfWeek, Year\n\n\nNotes:\n\t- If Year is not given, + it defaults to *.\n\t- If Second is not given, it defaults + to 0.\n\t- Shorthands @yearly, @monthly, @weekly, @daily, + and @hourly are also\n\t\taccepted instead of the 5-7 time + fields.\n\t- @every [/] is accepted and + gets compiled into an\n\t\tIntervalSpec instead. + and should be a decimal integer\n\t\twith a unit + suffix s, m, h, or d.\n\t- Optionally, the string can be + preceded by CRON_TZ=