diff --git a/acme.cert-manager.io/challenge_v1.json b/acme.cert-manager.io/challenge_v1.json index 237786fb..251a0ca7 100644 --- a/acme.cert-manager.io/challenge_v1.json +++ b/acme.cert-manager.io/challenge_v1.json @@ -160,11 +160,11 @@ "description": "Use the Microsoft Azure DNS API to manage DNS01 challenge records.", "properties": { "clientID": { - "description": "if both this and ClientSecret are left unset MSI will be used", + "description": "Auth: Azure Service Principal: The ClientID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientSecret and TenantID must also be set.", "type": "string" }, "clientSecretSecretRef": { - "description": "if both this and ClientID are left unset MSI will be used", + "description": "Auth: Azure Service Principal: A reference to a Secret containing the password associated with the Service Principal. If set, ClientID and TenantID must also be set.", "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -196,14 +196,14 @@ "type": "string" }, "managedIdentity": { - "description": "managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID", + "description": "Auth: Azure Workload Identity or Azure Managed Service Identity: Settings to enable Azure Workload Identity or Azure Managed Service Identity If set, ClientID, ClientSecret and TenantID must not be set.", "properties": { "clientID": { "description": "client ID of the managed identity, can not be used at the same time as resourceID", "type": "string" }, "resourceID": { - "description": "resource ID of the managed identity, can not be used at the same time as clientID", + "description": "resource ID of the managed identity, can not be used at the same time as clientID Cannot be used for Azure Managed Service Identity", "type": "string" } }, @@ -219,7 +219,7 @@ "type": "string" }, "tenantID": { - "description": "when specifying ClientID and ClientSecret then this field is also needed", + "description": "Auth: Azure Service Principal: The TenantID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientID and ClientSecret must also be set.", "type": "string" } }, @@ -392,9 +392,27 @@ "description": "Use the AWS Route53 API to manage DNS01 challenge records.", "properties": { "accessKeyID": { - "description": "The AccessKeyID is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", + "description": "The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", "type": "string" }, + "accessKeyIDSecretRef": { + "description": "The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", + "properties": { + "key": { + "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", + "type": "string" + }, + "name": { + "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false + }, "hostedZoneID": { "description": "If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.", "type": "string" @@ -408,7 +426,7 @@ "type": "string" }, "secretAccessKeySecretRef": { - "description": "The SecretAccessKey is used for authentication. If not set we fall-back to using env vars, shared credentials file or AWS Instance metadata https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", + "description": "The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -473,20 +491,20 @@ "type": "object" }, "parentRefs": { - "description": "When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/v1alpha2/api-types/httproute/#attaching-to-gateways", + "description": "When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways", "items": { - "description": "ParentRef identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). The only kind of parent resource with \"Core\" support is Gateway. This API may be extended in the future to support additional kinds of parent resources, such as HTTPRoute. \n The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid. \n References to objects with invalid Group and Kind are not valid, and must be rejected by the implementation, with appropriate Conditions set on the containing object.", + "description": "ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). There are two kinds of parent resources with \"Core\" support: \n * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) \n This API may be extended in the future to support additional kinds of parent resources. \n The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.", "properties": { "group": { "default": "gateway.networking.k8s.io", - "description": "Group is the group of the referent. \n Support: Core", + "description": "Group is the group of the referent. When unspecified, \"gateway.networking.k8s.io\" is inferred. To set the core API group (such as for a \"Service\" kind referent), Group must be explicitly set to \"\" (empty string). \n Support: Core", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "kind": { "default": "Gateway", - "description": "Kind is kind of the referent. \n Support: Core (Gateway) Support: Custom (Other Resources)", + "description": "Kind is kind of the referent. \n There are two kinds of parent resources with \"Core\" support: \n * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) \n Support for other resources is Implementation-Specific.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", @@ -499,14 +517,21 @@ "type": "string" }, "namespace": { - "description": "Namespace is the namespace of the referent. When unspecified (or empty string), this refers to the local namespace of the Route. \n Support: Core", + "description": "Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. \n Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. \n ParentRefs from a Route to a Service in the same namespace are \"producer\" routes, which apply default routing rules to inbound connections from any namespace to the Service. \n ParentRefs from a Route to a Service in a different namespace are \"consumer\" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. \n Support: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, + "port": { + "description": "Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. \n When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. \n When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. \n Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. \n For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Extended \n ", + "format": "int32", + "maximum": 65535, + "minimum": 1, + "type": "integer" + }, "sectionName": { - "description": "SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name \n Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. \n When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Core", + "description": "SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. \n Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. \n When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Core", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", @@ -533,7 +558,11 @@ "description": "The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed.", "properties": { "class": { - "description": "The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of 'class' or 'name' may be specified.", + "description": "This field configures the annotation `kubernetes.io/ingress.class` when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of `class`, `name` or `ingressClassName` may be specified.", + "type": "string" + }, + "ingressClassName": { + "description": "This field configures the field `ingressClassName` on the created Ingress resources used to solve ACME challenges that use this challenge solver. This is the recommended way of configuring the ingress class. Only one of `class`, `name` or `ingressClassName` may be specified.", "type": "string" }, "ingressTemplate": { @@ -565,7 +594,7 @@ "additionalProperties": false }, "name": { - "description": "The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources.", + "description": "The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. Only one of `class`, `name` or `ingressClassName` may be specified.", "type": "string" }, "podTemplate": { @@ -593,7 +622,7 @@ "additionalProperties": false }, "spec": { - "description": "PodSpec defines overrides for the HTTP01 challenge solver pod. Only the 'priorityClassName', 'nodeSelector', 'affinity', 'serviceAccountName' and 'tolerations' fields are supported currently. All other fields will be ignored.", + "description": "PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored.", "properties": { "affinity": { "description": "If specified, the pod's scheduling constraints", @@ -671,6 +700,7 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "weight": { @@ -758,6 +788,7 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "type": "array" @@ -767,6 +798,7 @@ "nodeSelectorTerms" ], "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false } }, @@ -785,7 +817,7 @@ "description": "Required. A pod affinity term, associated with the corresponding weight.", "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -826,10 +858,27 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "namespaceSelector": { - "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.", + "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -870,10 +919,11 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { - "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"", + "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, @@ -911,7 +961,7 @@ "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -952,10 +1002,27 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "namespaceSelector": { - "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.", + "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -996,10 +1063,11 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { - "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"", + "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, @@ -1034,7 +1102,7 @@ "description": "Required. A pod affinity term, associated with the corresponding weight.", "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -1075,10 +1143,27 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "namespaceSelector": { - "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.", + "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -1119,10 +1204,11 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { - "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"", + "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, @@ -1160,7 +1246,7 @@ "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -1201,10 +1287,27 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "namespaceSelector": { - "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces. This field is beta-level and is only honored when PodAffinityNamespaceSelector feature is enabled.", + "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -1245,10 +1348,11 @@ } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { - "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\"", + "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, @@ -1275,6 +1379,22 @@ "type": "object", "additionalProperties": false }, + "imagePullSecrets": { + "description": "If specified, the pod's imagePullSecrets", + "items": { + "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?", + "type": "string" + } + }, + "type": "object", + "x-kubernetes-map-type": "atomic", + "additionalProperties": false + }, + "type": "array" + }, "nodeSelector": { "additionalProperties": { "type": "string" diff --git a/cert-manager.io/certificate_v1.json b/cert-manager.io/certificate_v1.json index 06437429..5380cb35 100644 --- a/cert-manager.io/certificate_v1.json +++ b/cert-manager.io/certificate_v1.json @@ -1,5 +1,5 @@ { - "description": "A Certificate resource should be created to ensure an up to date and signed x509 certificate is stored in the Kubernetes Secret resource named in `spec.secretName`. \n The stored certificate will be renewed before it expires (as configured by `spec.renewBefore`).", + "description": "A Certificate resource should be created to ensure an up to date and signed X.509 certificate is stored in the Kubernetes Secret resource named in `spec.secretName`. \n The stored certificate will be renewed before it expires (as configured by `spec.renewBefore`).", "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", @@ -13,10 +13,10 @@ "type": "object" }, "spec": { - "description": "Desired state of the Certificate resource.", + "description": "Specification of the desired state of the Certificate resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "additionalOutputFormats": { - "description": "AdditionalOutputFormats defines extra output formats of the private key and signed certificate chain to be written to this Certificate's target Secret. This is an Alpha Feature and is only enabled with the `--feature-gates=AdditionalCertificateOutputFormats=true` option on both the controller and webhook components.", + "description": "Defines extra output formats of the private key and signed certificate chain to be written to this Certificate's target Secret. \n This is an Alpha Feature and is only enabled with the `--feature-gates=AdditionalCertificateOutputFormats=true` option set on both the controller and webhook components.", "items": { "description": "CertificateAdditionalOutputFormat defines an additional output format of a Certificate resource. These contain supplementary data formats of the signed certificate chain and paired private key.", "properties": { @@ -38,44 +38,44 @@ "type": "array" }, "commonName": { - "description": "CommonName is a common name to be used on the Certificate. The CommonName should have a length of 64 characters or fewer to avoid generating invalid CSRs. This value is ignored by TLS clients when any subject alt name is set. This is x509 behaviour: https://tools.ietf.org/html/rfc6125#section-6.4.4", + "description": "Requested common name X509 certificate subject attribute. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 NOTE: TLS clients will ignore this value when any subject alternative name is set (see https://tools.ietf.org/html/rfc6125#section-6.4.4). \n Should have a length of 64 characters or fewer to avoid generating invalid CSRs. Cannot be set if the `literalSubject` field is set.", "type": "string" }, "dnsNames": { - "description": "DNSNames is a list of DNS subjectAltNames to be set on the Certificate.", + "description": "Requested DNS subject alternative names.", "items": { "type": "string" }, "type": "array" }, "duration": { - "description": "The requested 'duration' (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If unset this defaults to 90 days. Certificate will be renewed either 2/3 through its duration or `renewBefore` period before its expiry, whichever is later. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration", + "description": "Requested 'duration' (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute. \n If unset, this defaults to 90 days. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.", "type": "string" }, "emailAddresses": { - "description": "EmailAddresses is a list of email subjectAltNames to be set on the Certificate.", + "description": "Requested email subject alternative names.", "items": { "type": "string" }, "type": "array" }, "encodeUsagesInRequest": { - "description": "EncodeUsagesInRequest controls whether key usages should be present in the CertificateRequest", + "description": "Whether the KeyUsage and ExtKeyUsage extensions should be set in the encoded CSR. \n This option defaults to true, and should only be disabled if the target issuer does not support CSRs with these X509 KeyUsage/ ExtKeyUsage extensions.", "type": "boolean" }, "ipAddresses": { - "description": "IPAddresses is a list of IP address subjectAltNames to be set on the Certificate.", + "description": "Requested IP address subject alternative names.", "items": { "type": "string" }, "type": "array" }, "isCA": { - "description": "IsCA will mark this Certificate as valid for certificate signing. This will automatically add the `cert sign` usage to the list of `usages`.", + "description": "Requested basic constraints isCA value. The isCA value is used to set the `isCA` field on the created CertificateRequest resources. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute. \n If true, this will automatically add the `cert sign` usage to the list of requested `usages`.", "type": "boolean" }, "issuerRef": { - "description": "IssuerRef is a reference to the issuer for this certificate. If the `kind` field is not set, or set to `Issuer`, an Issuer resource with the given name in the same namespace as the Certificate will be used. If the `kind` field is set to `ClusterIssuer`, a ClusterIssuer with the provided name will be used. The `name` field in this stanza is required at all times.", + "description": "Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace. \n The `name` field of the reference must always be specified.", "properties": { "group": { "description": "Group of the resource being referred to.", @@ -97,13 +97,13 @@ "additionalProperties": false }, "keystores": { - "description": "Keystores configures additional keystore output formats stored in the `secretName` Secret resource.", + "description": "Additional keystore output formats to be stored in the Certificate's Secret.", "properties": { "jks": { "description": "JKS configures options for storing a JKS keystore in the `spec.secretName` Secret resource.", "properties": { "create": { - "description": "Create enables JKS keystore creation for the Certificate. If true, a file named `keystore.jks` will be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef`. The keystore file will only be updated upon re-issuance. A file named `truststore.jks` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority", + "description": "Create enables JKS keystore creation for the Certificate. If true, a file named `keystore.jks` will be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef`. The keystore file will be updated immediately. If the issuer provided a CA certificate, a file named `truststore.jks` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority", "type": "boolean" }, "passwordSecretRef": { @@ -136,7 +136,7 @@ "description": "PKCS12 configures options for storing a PKCS12 keystore in the `spec.secretName` Secret resource.", "properties": { "create": { - "description": "Create enables PKCS12 keystore creation for the Certificate. If true, a file named `keystore.p12` will be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef`. The keystore file will only be updated upon re-issuance. A file named `truststore.p12` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority", + "description": "Create enables PKCS12 keystore creation for the Certificate. If true, a file named `keystore.p12` will be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef`. The keystore file will be updated immediately. If the issuer provided a CA certificate, a file named `truststore.p12` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority", "type": "boolean" }, "passwordSecretRef": { @@ -156,6 +156,15 @@ ], "type": "object", "additionalProperties": false + }, + "profile": { + "description": "Profile specifies the key and certificate encryption algorithms and the HMAC algorithm used to create the PKCS12 keystore. Default value is `LegacyRC2` for backward compatibility. \n If provided, allowed values are: `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20. `LegacyDES`: Less secure algorithm. Use this option for maximal compatibility. `Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms (eg. because of company policy). Please note that the security of the algorithm is not that important in reality, because the unencrypted certificate and private key are also stored in the Secret.", + "enum": [ + "LegacyRC2", + "LegacyDES", + "Modern2023" + ], + "type": "string" } }, "required": [ @@ -169,11 +178,114 @@ "type": "object", "additionalProperties": false }, + "literalSubject": { + "description": "Requested X.509 certificate subject, represented using the LDAP \"String Representation of a Distinguished Name\" [1]. Important: the LDAP string format also specifies the order of the attributes in the subject, this is important when issuing certs for LDAP authentication. Example: `CN=foo,DC=corp,DC=example,DC=com` More info [1]: https://datatracker.ietf.org/doc/html/rfc4514 More info: https://github.com/cert-manager/cert-manager/issues/3203 More info: https://github.com/cert-manager/cert-manager/issues/4424 \n Cannot be set if the `subject` or `commonName` field is set. This is an Alpha Feature and is only enabled with the `--feature-gates=LiteralCertificateSubject=true` option set on both the controller and webhook components.", + "type": "string" + }, + "nameConstraints": { + "description": "x.509 certificate NameConstraint extension which MUST NOT be used in a non-CA certificate. More Info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.10 \n This is an Alpha Feature and is only enabled with the `--feature-gates=NameConstraints=true` option set on both the controller and webhook components.", + "properties": { + "critical": { + "description": "if true then the name constraints are marked critical.", + "type": "boolean" + }, + "excluded": { + "description": "Excluded contains the constraints which must be disallowed. Any name matching a restriction in the excluded field is invalid regardless of information appearing in the permitted", + "properties": { + "dnsDomains": { + "description": "DNSDomains is a list of DNS domains that are permitted or excluded.", + "items": { + "type": "string" + }, + "type": "array" + }, + "emailAddresses": { + "description": "EmailAddresses is a list of Email Addresses that are permitted or excluded.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ipRanges": { + "description": "IPRanges is a list of IP Ranges that are permitted or excluded. This should be a valid CIDR notation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "uriDomains": { + "description": "URIDomains is a list of URI domains that are permitted or excluded.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object", + "additionalProperties": false + }, + "permitted": { + "description": "Permitted contains the constraints in which the names must be located.", + "properties": { + "dnsDomains": { + "description": "DNSDomains is a list of DNS domains that are permitted or excluded.", + "items": { + "type": "string" + }, + "type": "array" + }, + "emailAddresses": { + "description": "EmailAddresses is a list of Email Addresses that are permitted or excluded.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ipRanges": { + "description": "IPRanges is a list of IP Ranges that are permitted or excluded. This should be a valid CIDR notation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "uriDomains": { + "description": "URIDomains is a list of URI domains that are permitted or excluded.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object", + "additionalProperties": false + } + }, + "type": "object", + "additionalProperties": false + }, + "otherNames": { + "description": "`otherNames` is an escape hatch for SAN that allows any type. We currently restrict the support to string like otherNames, cf RFC 5280 p 37 Any UTF8 String valued otherName can be passed with by setting the keys oid: x.x.x.x and UTF8Value: somevalue for `otherName`. Most commonly this would be UPN set with oid: 1.3.6.1.4.1.311.20.2.3 You should ensure that any OID passed is valid for the UTF8String type as we do not explicitly validate this.", + "items": { + "properties": { + "oid": { + "description": "OID is the object identifier for the otherName SAN. The object identifier must be expressed as a dotted string, for example, \"1.2.840.113556.1.4.221\".", + "type": "string" + }, + "utf8Value": { + "description": "utf8Value is the string value of the otherName SAN. The utf8Value accepts any valid UTF8 string to set as value for the otherName SAN.", + "type": "string" + } + }, + "type": "object", + "additionalProperties": false + }, + "type": "array" + }, "privateKey": { - "description": "Options to control private keys used for the Certificate.", + "description": "Private key options. These include the key algorithm and size, the used encoding and the rotation policy.", "properties": { "algorithm": { - "description": "Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either `RSA`,`Ed25519` or `ECDSA` If `algorithm` is specified and `size` is not provided, key size of 256 will be used for `ECDSA` key algorithm and key size of 2048 will be used for `RSA` key algorithm. key size is ignored when using the `Ed25519` key algorithm.", + "description": "Algorithm is the private key algorithm of the corresponding private key for this certificate. \n If provided, allowed values are either `RSA`, `ECDSA` or `Ed25519`. If `algorithm` is specified and `size` is not provided, key size of 2048 will be used for `RSA` key algorithm and key size of 256 will be used for `ECDSA` key algorithm. key size is ignored when using the `Ed25519` key algorithm.", "enum": [ "RSA", "ECDSA", @@ -182,7 +294,7 @@ "type": "string" }, "encoding": { - "description": "The private key cryptography standards (PKCS) encoding for this certificate's private key to be encoded in. If provided, allowed values are `PKCS1` and `PKCS8` standing for PKCS#1 and PKCS#8, respectively. Defaults to `PKCS1` if not specified.", + "description": "The private key cryptography standards (PKCS) encoding for this certificate's private key to be encoded in. \n If provided, allowed values are `PKCS1` and `PKCS8` standing for PKCS#1 and PKCS#8, respectively. Defaults to `PKCS1` if not specified.", "enum": [ "PKCS1", "PKCS8" @@ -190,7 +302,7 @@ "type": "string" }, "rotationPolicy": { - "description": "RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. If set to Never, a private key will only be generated if one does not already exist in the target `spec.secretName`. If one does exists but it does not have the correct algorithm or size, a warning will be raised to await user intervention. If set to Always, a private key matching the specified requirements will be generated whenever a re-issuance occurs. Default is 'Never' for backward compatibility.", + "description": "RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. \n If set to `Never`, a private key will only be generated if one does not already exist in the target `spec.secretName`. If one does exists but it does not have the correct algorithm or size, a warning will be raised to await user intervention. If set to `Always`, a private key matching the specified requirements will be generated whenever a re-issuance occurs. Default is `Never` for backward compatibility.", "enum": [ "Never", "Always" @@ -198,7 +310,7 @@ "type": "string" }, "size": { - "description": "Size is the key bit size of the corresponding private key for this certificate. If `algorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `algorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. If `algorithm` is set to `Ed25519`, Size is ignored. No other values are allowed.", + "description": "Size is the key bit size of the corresponding private key for this certificate. \n If `algorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `algorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. If `algorithm` is set to `Ed25519`, Size is ignored. No other values are allowed.", "type": "integer" } }, @@ -206,20 +318,20 @@ "additionalProperties": false }, "renewBefore": { - "description": "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. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration", + "description": "How long before the currently issued certificate's expiry cert-manager should renew the certificate. For example, if a certificate is valid for 60 minutes, and `renewBefore=10m`, cert-manager will begin to attempt to renew the certificate 50 minutes after it was issued (i.e. when there are 10 minutes remaining until the certificate is no longer valid). \n NOTE: The actual lifetime of the issued certificate is used to determine the renewal time. If an issuer returns a certificate with a different lifetime than the one requested, cert-manager will use the lifetime of the issued certificate. \n If unset, this defaults to 1/3 of the issued certificate's lifetime. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.", "type": "string" }, "revisionHistoryLimit": { - "description": "revisionHistoryLimit is the maximum number of CertificateRequest revisions that are maintained in the Certificate's history. Each revision represents a single `CertificateRequest` created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number. If set, revisionHistoryLimit must be a value of `1` or greater. If unset (`nil`), revisions will not be garbage collected. Default value is `nil`.", + "description": "The maximum number of CertificateRequest revisions that are maintained in the Certificate's history. Each revision represents a single `CertificateRequest` created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number. \n If set, revisionHistoryLimit must be a value of `1` or greater. If unset (`nil`), revisions will not be garbage collected. Default value is `nil`.", "format": "int32", "type": "integer" }, "secretName": { - "description": "SecretName is the name of the secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer.", + "description": "Name of the Secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer. The Secret resource lives in the same namespace as the Certificate resource.", "type": "string" }, "secretTemplate": { - "description": "SecretTemplate defines annotations and labels to be copied to the Certificate's Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate's Secret.", + "description": "Defines annotations and labels to be copied to the Certificate's Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate's Secret.", "properties": { "annotations": { "additionalProperties": { @@ -240,7 +352,7 @@ "additionalProperties": false }, "subject": { - "description": "Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name).", + "description": "Requested set of X509 certificate subject attributes. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 \n The common name attribute is specified separately in the `commonName` field. Cannot be set if the `literalSubject` field is set.", "properties": { "countries": { "description": "Countries to be used on the Certificate.", @@ -300,16 +412,16 @@ "additionalProperties": false }, "uris": { - "description": "URIs is a list of URI subjectAltNames to be set on the Certificate.", + "description": "Requested URI subject alternative names.", "items": { "type": "string" }, "type": "array" }, "usages": { - "description": "Usages is the set of x509 usages that are requested for the certificate. Defaults to `digital signature` and `key encipherment` if not specified.", + "description": "Requested key usages and extended key usages. These usages are used to set the `usages` field on the created CertificateRequest resources. If `encodeUsagesInRequest` is unset or set to `true`, the usages will additionally be encoded in the `request` field which contains the CSR blob. \n If unset, defaults to `digital signature` and `key encipherment`.", "items": { - "description": "KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 Valid KeyUsage values are as follows: \"signing\", \"digital signature\", \"content commitment\", \"key encipherment\", \"key agreement\", \"data encipherment\", \"cert sign\", \"crl sign\", \"encipher only\", \"decipher only\", \"any\", \"server auth\", \"client auth\", \"code signing\", \"email protection\", \"s/mime\", \"ipsec end system\", \"ipsec tunnel\", \"ipsec user\", \"timestamping\", \"ocsp signing\", \"microsoft sgc\", \"netscape sgc\"", + "description": "KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 \n Valid KeyUsage values are as follows: \"signing\", \"digital signature\", \"content commitment\", \"key encipherment\", \"key agreement\", \"data encipherment\", \"cert sign\", \"crl sign\", \"encipher only\", \"decipher only\", \"any\", \"server auth\", \"client auth\", \"code signing\", \"email protection\", \"s/mime\", \"ipsec end system\", \"ipsec tunnel\", \"ipsec user\", \"timestamping\", \"ocsp signing\", \"microsoft sgc\", \"netscape sgc\"", "enum": [ "signing", "digital signature", @@ -348,7 +460,7 @@ "additionalProperties": false }, "status": { - "description": "Status of the Certificate. This is set and managed automatically.", + "description": "Status of the Certificate. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "conditions": { "description": "List of status conditions to indicate the status of certificates. Known condition types are `Ready` and `Issuing`.", @@ -405,7 +517,7 @@ "type": "integer" }, "lastFailureTime": { - "description": "LastFailureTime is the time as recorded by the Certificate controller of the most recent failure to complete a CertificateRequest for this Certificate resource. If set, cert-manager will not re-request another Certificate until 1 hour has elapsed from this time.", + "description": "LastFailureTime is set only if the lastest issuance for this Certificate failed and contains the time of the failure. If an issuance has failed, the delay till the next issuance will be calculated using formula time.Hour * 2 ^ (failedIssuanceAttempts - 1). If the latest issuance has succeeded this field will be unset.", "format": "date-time", "type": "string" }, @@ -419,7 +531,7 @@ "type": "string" }, "notBefore": { - "description": "The time after which the certificate stored in the secret named by this resource in spec.secretName is valid.", + "description": "The time after which the certificate stored in the secret named by this resource in `spec.secretName` is valid.", "format": "date-time", "type": "string" }, @@ -437,8 +549,5 @@ "additionalProperties": false } }, - "required": [ - "spec" - ], "type": "object" } diff --git a/cert-manager.io/certificaterequest_v1.json b/cert-manager.io/certificaterequest_v1.json index 6fa6b172..08bc250b 100644 --- a/cert-manager.io/certificaterequest_v1.json +++ b/cert-manager.io/certificaterequest_v1.json @@ -1,5 +1,5 @@ { - "description": "A CertificateRequest is used to request a signed certificate from one of the configured issuers. \n All fields within the CertificateRequest's `spec` are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its `status.state` field. \n A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used.", + "description": "A CertificateRequest is used to request a signed certificate from one of the configured issuers. \n All fields within the CertificateRequest's `spec` are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its `Ready` status condition and its `status.failureTime` field. \n A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used.", "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", @@ -13,10 +13,10 @@ "type": "object" }, "spec": { - "description": "Desired state of the CertificateRequest resource.", + "description": "Specification of the desired state of the CertificateRequest resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "duration": { - "description": "The requested 'duration' (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types.", + "description": "Requested 'duration' (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute.", "type": "string" }, "extra": { @@ -38,11 +38,11 @@ "x-kubernetes-list-type": "atomic" }, "isCA": { - "description": "IsCA will request to mark the certificate as valid for certificate signing when submitting to the issuer. This will automatically add the `cert sign` usage to the list of `usages`.", + "description": "Requested basic constraints isCA value. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute. \n NOTE: If the CSR in the `Request` field has a BasicConstraints extension, it must have the same isCA value as specified here. \n If true, this will automatically add the `cert sign` usage to the list of requested `usages`.", "type": "boolean" }, "issuerRef": { - "description": "IssuerRef is a reference to the issuer for this CertificateRequest. If the `kind` field is not set, or set to `Issuer`, an Issuer resource with the given name in the same namespace as the CertificateRequest will be used. If the `kind` field is set to `ClusterIssuer`, a ClusterIssuer with the provided name will be used. The `name` field in this stanza is required at all times. The group field refers to the API group of the issuer which defaults to `cert-manager.io` if empty.", + "description": "Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace. \n The `name` field of the reference must always be specified.", "properties": { "group": { "description": "Group of the resource being referred to.", @@ -64,7 +64,7 @@ "additionalProperties": false }, "request": { - "description": "The PEM-encoded x509 certificate signing request to be submitted to the CA for signing.", + "description": "The PEM-encoded X.509 certificate signing request to be submitted to the issuer for signing. \n If the CSR has a BasicConstraints extension, its isCA attribute must match the `isCA` value of this CertificateRequest. If the CSR has a KeyUsage extension, its key usages must match the key usages in the `usages` field of this CertificateRequest. If the CSR has a ExtKeyUsage extension, its extended key usages must match the extended key usages in the `usages` field of this CertificateRequest.", "format": "byte", "type": "string" }, @@ -73,9 +73,9 @@ "type": "string" }, "usages": { - "description": "Usages is the set of x509 usages that are requested for the certificate. If usages are set they SHOULD be encoded inside the CSR spec Defaults to `digital signature` and `key encipherment` if not specified.", + "description": "Requested key usages and extended key usages. \n NOTE: If the CSR in the `Request` field has uses the KeyUsage or ExtKeyUsage extension, these extensions must have the same values as specified here without any additional values. \n If unset, defaults to `digital signature` and `key encipherment`.", "items": { - "description": "KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 Valid KeyUsage values are as follows: \"signing\", \"digital signature\", \"content commitment\", \"key encipherment\", \"key agreement\", \"data encipherment\", \"cert sign\", \"crl sign\", \"encipher only\", \"decipher only\", \"any\", \"server auth\", \"client auth\", \"code signing\", \"email protection\", \"s/mime\", \"ipsec end system\", \"ipsec tunnel\", \"ipsec user\", \"timestamping\", \"ocsp signing\", \"microsoft sgc\", \"netscape sgc\"", + "description": "KeyUsage specifies valid usage contexts for keys. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 \n Valid KeyUsage values are as follows: \"signing\", \"digital signature\", \"content commitment\", \"key encipherment\", \"key agreement\", \"data encipherment\", \"cert sign\", \"crl sign\", \"encipher only\", \"decipher only\", \"any\", \"server auth\", \"client auth\", \"code signing\", \"email protection\", \"s/mime\", \"ipsec end system\", \"ipsec tunnel\", \"ipsec user\", \"timestamping\", \"ocsp signing\", \"microsoft sgc\", \"netscape sgc\"", "enum": [ "signing", "digital signature", @@ -118,20 +118,20 @@ "additionalProperties": false }, "status": { - "description": "Status of the CertificateRequest. This is set and managed automatically.", + "description": "Status of the CertificateRequest. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "ca": { - "description": "The PEM encoded x509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available.", + "description": "The PEM encoded X.509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available.", "format": "byte", "type": "string" }, "certificate": { - "description": "The PEM encoded x509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the `conditions` field.", + "description": "The PEM encoded X.509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the `conditions` field.", "format": "byte", "type": "string" }, "conditions": { - "description": "List of status conditions to indicate the status of a CertificateRequest. Known condition types are `Ready` and `InvalidRequest`.", + "description": "List of status conditions to indicate the status of a CertificateRequest. Known condition types are `Ready`, `InvalidRequest`, `Approved` and `Denied`.", "items": { "description": "CertificateRequestCondition contains condition information for a CertificateRequest.", "properties": { @@ -185,8 +185,5 @@ "additionalProperties": false } }, - "required": [ - "spec" - ], "type": "object" } diff --git a/cert-manager.io/challenge_v1.json b/cert-manager.io/challenge_v1.json deleted file mode 100644 index 3292f45d..00000000 --- a/cert-manager.io/challenge_v1.json +++ /dev/null @@ -1,1484 +0,0 @@ -{ - "description": "Challenge is a type to represent a Challenge request with an ACME server", - "type": "object", - "required": [ - "metadata", - "spec" - ], - "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": { - "type": "object", - "required": [ - "authorizationURL", - "dnsName", - "issuerRef", - "key", - "solver", - "token", - "type", - "url" - ], - "properties": { - "authorizationURL": { - "description": "The URL to the ACME Authorization resource that this challenge is a part of.", - "type": "string" - }, - "dnsName": { - "description": "dnsName is the identifier that this challenge is for, e.g. example.com. If the requested DNSName is a 'wildcard', this field MUST be set to the non-wildcard domain, e.g. for `*.example.com`, it must be `example.com`.", - "type": "string" - }, - "issuerRef": { - "description": "References a properly configured ACME-type Issuer which should be used to create this Challenge. If the Issuer does not exist, processing will be retried. If the Issuer is not an 'ACME' Issuer, an error will be returned and the Challenge will be marked as failed.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "group": { - "description": "Group of the resource being referred to.", - "type": "string" - }, - "kind": { - "description": "Kind of the resource being referred to.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to.", - "type": "string" - } - }, - "additionalProperties": false - }, - "key": { - "description": "The ACME challenge key for this challenge For HTTP01 challenges, this is the value that must be responded with to complete the HTTP01 challenge in the format: `.`. For DNS01 challenges, this is the base64 encoded SHA256 sum of the `.` text that must be set as the TXT record content.", - "type": "string" - }, - "solver": { - "description": "Contains the domain solving configuration that should be used to solve this challenge resource.", - "type": "object", - "properties": { - "dns01": { - "description": "Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow.", - "type": "object", - "properties": { - "acmeDNS": { - "description": "Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "accountSecretRef", - "host" - ], - "properties": { - "accountSecretRef": { - "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - }, - "host": { - "type": "string" - } - }, - "additionalProperties": false - }, - "akamai": { - "description": "Use the Akamai DNS zone management API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "accessTokenSecretRef", - "clientSecretSecretRef", - "clientTokenSecretRef", - "serviceConsumerDomain" - ], - "properties": { - "accessTokenSecretRef": { - "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - }, - "clientSecretSecretRef": { - "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - }, - "clientTokenSecretRef": { - "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - }, - "serviceConsumerDomain": { - "type": "string" - } - }, - "additionalProperties": false - }, - "azureDNS": { - "description": "Use the Microsoft Azure DNS API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "resourceGroupName", - "subscriptionID" - ], - "properties": { - "clientID": { - "description": "if both this and ClientSecret are left unset MSI will be used", - "type": "string" - }, - "clientSecretSecretRef": { - "description": "if both this and ClientID are left unset MSI will be used", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - }, - "environment": { - "description": "name of the Azure environment (default AzurePublicCloud)", - "type": "string", - "enum": [ - "AzurePublicCloud", - "AzureChinaCloud", - "AzureGermanCloud", - "AzureUSGovernmentCloud" - ] - }, - "hostedZoneName": { - "description": "name of the DNS zone that should be used", - "type": "string" - }, - "managedIdentity": { - "description": "managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID", - "type": "object", - "properties": { - "clientID": { - "description": "client ID of the managed identity, can not be used at the same time as resourceID", - "type": "string" - }, - "resourceID": { - "description": "resource ID of the managed identity, can not be used at the same time as clientID", - "type": "string" - } - }, - "additionalProperties": false - }, - "resourceGroupName": { - "description": "resource group the DNS zone is located in", - "type": "string" - }, - "subscriptionID": { - "description": "ID of the Azure subscription", - "type": "string" - }, - "tenantID": { - "description": "when specifying ClientID and ClientSecret then this field is also needed", - "type": "string" - } - }, - "additionalProperties": false - }, - "cloudDNS": { - "description": "Use the Google Cloud DNS API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "project" - ], - "properties": { - "hostedZoneName": { - "description": "HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone.", - "type": "string" - }, - "project": { - "type": "string" - }, - "serviceAccountSecretRef": { - "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "cloudflare": { - "description": "Use the Cloudflare API to manage DNS01 challenge records.", - "type": "object", - "properties": { - "apiKeySecretRef": { - "description": "API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - }, - "apiTokenSecretRef": { - "description": "API token used to authenticate with Cloudflare.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - }, - "email": { - "description": "Email of the account, only required when using API key based authentication.", - "type": "string" - } - }, - "additionalProperties": false - }, - "cnameStrategy": { - "description": "CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.", - "type": "string", - "enum": [ - "None", - "Follow" - ] - }, - "digitalocean": { - "description": "Use the DigitalOcean DNS API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "tokenSecretRef" - ], - "properties": { - "tokenSecretRef": { - "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "rfc2136": { - "description": "Use RFC2136 (\"Dynamic Updates in the Domain Name System\") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records.", - "type": "object", - "required": [ - "nameserver" - ], - "properties": { - "nameserver": { - "description": "The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1])\u00a0; port is optional. This field is required.", - "type": "string" - }, - "tsigAlgorithm": { - "description": "The TSIG Algorithm configured in the DNS supporting RFC2136. Used only when ``tsigSecretSecretRef`` and ``tsigKeyName`` are defined. Supported values are (case-insensitive): ``HMACMD5`` (default), ``HMACSHA1``, ``HMACSHA256`` or ``HMACSHA512``.", - "type": "string" - }, - "tsigKeyName": { - "description": "The TSIG Key name configured in the DNS. If ``tsigSecretSecretRef`` is defined, this field is required.", - "type": "string" - }, - "tsigSecretSecretRef": { - "description": "The name of the secret containing the TSIG value. If ``tsigKeyName`` is defined, this field is required.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "route53": { - "description": "Use the AWS Route53 API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "region" - ], - "properties": { - "accessKeyID": { - "description": "The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", - "type": "string" - }, - "accessKeyIDSecretRef": { - "description": "The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - }, - "hostedZoneID": { - "description": "If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.", - "type": "string" - }, - "region": { - "description": "Always set the region when using AccessKeyID and SecretAccessKey", - "type": "string" - }, - "role": { - "description": "Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata", - "type": "string" - }, - "secretAccessKeySecretRef": { - "description": "The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", - "type": "object", - "required": [ - "name" - ], - "properties": { - "key": { - "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "webhook": { - "description": "Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.", - "type": "object", - "required": [ - "groupName", - "solverName" - ], - "properties": { - "config": { - "description": "Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation's documentation.", - "x-kubernetes-preserve-unknown-fields": true - }, - "groupName": { - "description": "The API group name that should be used when POSTing ChallengePayload resources to the webhook apiserver. This should be the same as the GroupName specified in the webhook provider implementation.", - "type": "string" - }, - "solverName": { - "description": "The name of the solver to use, as defined in the webhook provider implementation. This will typically be the name of the provider, e.g. 'cloudflare'.", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "http01": { - "description": "Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism.", - "type": "object", - "properties": { - "gatewayHTTPRoute": { - "description": "The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future.", - "type": "object", - "properties": { - "labels": { - "description": "Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "parentRefs": { - "description": "When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways", - "type": "array", - "items": { - "description": "ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). The only kind of parent resource with \"Core\" support is Gateway. This API may be extended in the future to support additional kinds of parent resources, such as HTTPRoute. \n The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "group": { - "description": "Group is the group of the referent. When unspecified, \"gateway.networking.k8s.io\" is inferred. To set the core API group (such as for a \"Service\" kind referent), Group must be explicitly set to \"\" (empty string). \n Support: Core", - "type": "string", - "default": "gateway.networking.k8s.io", - "maxLength": 253, - "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" - }, - "kind": { - "description": "Kind is kind of the referent. \n Support: Core (Gateway) \n Support: Implementation-specific (Other Resources)", - "type": "string", - "default": "Gateway", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$" - }, - "name": { - "description": "Name is the name of the referent. \n Support: Core", - "type": "string", - "maxLength": 253, - "minLength": 1 - }, - "namespace": { - "description": "Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. \n Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. \n Support: Core", - "type": "string", - "maxLength": 63, - "minLength": 1, - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" - }, - "port": { - "description": "Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. \n When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. \n Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. \n For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Extended \n ", - "type": "integer", - "format": "int32", - "maximum": 65535, - "minimum": 1 - }, - "sectionName": { - "description": "SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. \n Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. \n When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Core", - "type": "string", - "maxLength": 253, - "minLength": 1, - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" - } - }, - "additionalProperties": false - } - }, - "serviceType": { - "description": "Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.", - "type": "string" - } - }, - "additionalProperties": false - }, - "ingress": { - "description": "The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed.", - "type": "object", - "properties": { - "class": { - "description": "The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of 'class' or 'name' may be specified.", - "type": "string" - }, - "ingressTemplate": { - "description": "Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges.", - "type": "object", - "properties": { - "metadata": { - "description": "ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.", - "type": "object", - "properties": { - "annotations": { - "description": "Annotations that should be added to the created ACME HTTP01 solver ingress.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "labels": { - "description": "Labels that should be added to the created ACME HTTP01 solver ingress.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "name": { - "description": "The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources.", - "type": "string" - }, - "podTemplate": { - "description": "Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges.", - "type": "object", - "properties": { - "metadata": { - "description": "ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.", - "type": "object", - "properties": { - "annotations": { - "description": "Annotations that should be added to the create ACME HTTP01 solver pods.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "labels": { - "description": "Labels that should be added to the created ACME HTTP01 solver pods.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "additionalProperties": false - }, - "spec": { - "description": "PodSpec defines overrides for the HTTP01 challenge solver pod. Only the 'priorityClassName', 'nodeSelector', 'affinity', 'serviceAccountName' and 'tolerations' fields are supported currently. All other fields will be ignored.", - "type": "object", - "properties": { - "affinity": { - "description": "If specified, the pod's scheduling constraints", - "type": "object", - "properties": { - "nodeAffinity": { - "description": "Describes node affinity scheduling rules for the pod.", - "type": "object", - "properties": { - "preferredDuringSchedulingIgnoredDuringExecution": { - "description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.", - "type": "array", - "items": { - "description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).", - "type": "object", - "required": [ - "preference", - "weight" - ], - "properties": { - "preference": { - "description": "A node selector term, associated with the corresponding weight.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "A list of node selector requirements by node's labels.", - "type": "array", - "items": { - "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "properties": { - "key": { - "description": "The label key that the selector applies to.", - "type": "string" - }, - "operator": { - "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", - "type": "string" - }, - "values": { - "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchFields": { - "description": "A list of node selector requirements by node's fields.", - "type": "array", - "items": { - "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "properties": { - "key": { - "description": "The label key that the selector applies to.", - "type": "string" - }, - "operator": { - "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", - "type": "string" - }, - "values": { - "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "weight": { - "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", - "type": "integer", - "format": "int32" - } - }, - "additionalProperties": false - } - }, - "requiredDuringSchedulingIgnoredDuringExecution": { - "description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.", - "type": "object", - "required": [ - "nodeSelectorTerms" - ], - "properties": { - "nodeSelectorTerms": { - "description": "Required. A list of node selector terms. The terms are ORed.", - "type": "array", - "items": { - "description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "A list of node selector requirements by node's labels.", - "type": "array", - "items": { - "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "properties": { - "key": { - "description": "The label key that the selector applies to.", - "type": "string" - }, - "operator": { - "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", - "type": "string" - }, - "values": { - "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchFields": { - "description": "A list of node selector requirements by node's fields.", - "type": "array", - "items": { - "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "properties": { - "key": { - "description": "The label key that the selector applies to.", - "type": "string" - }, - "operator": { - "description": "Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", - "type": "string" - }, - "values": { - "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "podAffinity": { - "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).", - "type": "object", - "properties": { - "preferredDuringSchedulingIgnoredDuringExecution": { - "description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.", - "type": "array", - "items": { - "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", - "type": "object", - "required": [ - "podAffinityTerm", - "weight" - ], - "properties": { - "podAffinityTerm": { - "description": "Required. A pod affinity term, associated with the corresponding weight.", - "type": "object", - "required": [ - "topologyKey" - ], - "properties": { - "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", - "items": { - "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "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.", - "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 merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchLabels": { - "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", - "additionalProperties": { - "type": "string" - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "namespaceSelector": { - "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", - "items": { - "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "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.", - "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 merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchLabels": { - "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", - "additionalProperties": { - "type": "string" - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "namespaces": { - "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", - "type": "array", - "items": { - "type": "string" - } - }, - "topologyKey": { - "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", - "type": "string" - } - }, - "additionalProperties": false - }, - "weight": { - "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", - "type": "integer", - "format": "int32" - } - }, - "additionalProperties": false - } - }, - "requiredDuringSchedulingIgnoredDuringExecution": { - "description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.", - "type": "array", - "items": { - "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", - "type": "object", - "required": [ - "topologyKey" - ], - "properties": { - "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", - "items": { - "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "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.", - "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 merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchLabels": { - "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", - "additionalProperties": { - "type": "string" - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "namespaceSelector": { - "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", - "items": { - "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "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.", - "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 merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchLabels": { - "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", - "additionalProperties": { - "type": "string" - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "namespaces": { - "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", - "type": "array", - "items": { - "type": "string" - } - }, - "topologyKey": { - "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", - "type": "string" - } - }, - "additionalProperties": false - } - } - }, - "additionalProperties": false - }, - "podAntiAffinity": { - "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).", - "type": "object", - "properties": { - "preferredDuringSchedulingIgnoredDuringExecution": { - "description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.", - "type": "array", - "items": { - "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", - "type": "object", - "required": [ - "podAffinityTerm", - "weight" - ], - "properties": { - "podAffinityTerm": { - "description": "Required. A pod affinity term, associated with the corresponding weight.", - "type": "object", - "required": [ - "topologyKey" - ], - "properties": { - "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", - "items": { - "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "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.", - "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 merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchLabels": { - "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", - "additionalProperties": { - "type": "string" - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "namespaceSelector": { - "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", - "items": { - "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "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.", - "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 merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchLabels": { - "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", - "additionalProperties": { - "type": "string" - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "namespaces": { - "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", - "type": "array", - "items": { - "type": "string" - } - }, - "topologyKey": { - "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", - "type": "string" - } - }, - "additionalProperties": false - }, - "weight": { - "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", - "type": "integer", - "format": "int32" - } - }, - "additionalProperties": false - } - }, - "requiredDuringSchedulingIgnoredDuringExecution": { - "description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.", - "type": "array", - "items": { - "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", - "type": "object", - "required": [ - "topologyKey" - ], - "properties": { - "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", - "items": { - "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "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.", - "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 merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchLabels": { - "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", - "additionalProperties": { - "type": "string" - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "namespaceSelector": { - "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", - "type": "object", - "properties": { - "matchExpressions": { - "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", - "items": { - "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], - "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.", - "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 merge patch.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "matchLabels": { - "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", - "additionalProperties": { - "type": "string" - } - } - }, - "x-kubernetes-map-type": "atomic", - "additionalProperties": false - }, - "namespaces": { - "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", - "type": "array", - "items": { - "type": "string" - } - }, - "topologyKey": { - "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", - "type": "string" - } - }, - "additionalProperties": false - } - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "nodeSelector": { - "description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "priorityClassName": { - "description": "If specified, the pod's priorityClassName.", - "type": "string" - }, - "serviceAccountName": { - "description": "If specified, the pod's service account", - "type": "string" - }, - "tolerations": { - "description": "If specified, the pod's tolerations.", - "type": "array", - "items": { - "description": "The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .", - "type": "object", - "properties": { - "effect": { - "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.", - "type": "string" - }, - "key": { - "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.", - "type": "string" - }, - "operator": { - "description": "Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.", - "type": "string" - }, - "tolerationSeconds": { - "description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.", - "type": "integer", - "format": "int64" - }, - "value": { - "description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.", - "type": "string" - } - }, - "additionalProperties": false - } - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "serviceType": { - "description": "Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "selector": { - "description": "Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead.", - "type": "object", - "properties": { - "dnsNames": { - "description": "List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.", - "type": "array", - "items": { - "type": "string" - } - }, - "dnsZones": { - "description": "List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.", - "type": "array", - "items": { - "type": "string" - } - }, - "matchLabels": { - "description": "A label selector that is used to refine the set of certificate's that this challenge solver will apply to.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "additionalProperties": false - } - }, - "additionalProperties": false - }, - "token": { - "description": "The ACME challenge token for this challenge. This is the raw value returned from the ACME server.", - "type": "string" - }, - "type": { - "description": "The type of ACME challenge this resource represents. One of \"HTTP-01\" or \"DNS-01\".", - "type": "string", - "enum": [ - "HTTP-01", - "DNS-01" - ] - }, - "url": { - "description": "The URL of the ACME Challenge resource for this challenge. This can be used to lookup details about the status of this challenge.", - "type": "string" - }, - "wildcard": { - "description": "wildcard will be true if this challenge is for a wildcard identifier, for example '*.example.com'.", - "type": "boolean" - } - }, - "additionalProperties": false - }, - "status": { - "type": "object", - "properties": { - "presented": { - "description": "presented will be set to true if the challenge values for this challenge are currently 'presented'. This *does not* imply the self check is passing. Only that the values have been 'submitted' for the appropriate challenge mechanism (i.e. the DNS01 TXT record has been presented, or the HTTP01 configuration has been configured).", - "type": "boolean" - }, - "processing": { - "description": "Used to denote whether this challenge should be processed or not. This field will only be set to true by the 'scheduling' component. It will only be set to false by the 'challenges' controller, after the challenge has reached a final state or timed out. If this field is set to false, the challenge controller will not take any more action.", - "type": "boolean" - }, - "reason": { - "description": "Contains human readable information on why the Challenge is in the current state.", - "type": "string" - }, - "state": { - "description": "Contains the current 'state' of the challenge. If not set, the state of the challenge is unknown.", - "type": "string", - "enum": [ - "valid", - "ready", - "pending", - "processing", - "invalid", - "expired", - "errored" - ] - } - }, - "additionalProperties": false - } - } -} diff --git a/cert-manager.io/clusterissuer_v1.json b/cert-manager.io/clusterissuer_v1.json index d175dfd4..6943450c 100644 --- a/cert-manager.io/clusterissuer_v1.json +++ b/cert-manager.io/clusterissuer_v1.json @@ -18,6 +18,11 @@ "acme": { "description": "ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates.", "properties": { + "caBundle": { + "description": "Base64-encoded bundle of PEM CAs which can be used to validate the certificate chain presented by the ACME server. Mutually exclusive with SkipTLSVerify; prefer using CABundle to prevent various kinds of security vulnerabilities. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection.", + "format": "byte", + "type": "string" + }, "disableAccountKeyGeneration": { "description": "Enables or disables generating a new ACME account key. If true, the Issuer resource will *not* request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false.", "type": "boolean" @@ -61,14 +66,16 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, "required": [ "keyID", "keySecretRef" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "preferredChain": { "description": "PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let's Encrypt's DST crosssign you would use: \"DST Root CA X3\" or \"ISRG Root X1\" for the newer Let's Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer's CN", @@ -90,14 +97,15 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "server": { "description": "Server is the URL used to access the ACME server's 'directory' endpoint. For example, for Let's Encrypt's staging endpoint, you would use: \"https://acme-staging-v02.api.letsencrypt.org/directory\". Only ACME v2 endpoints (i.e. RFC 8555) are supported.", "type": "string" }, "skipTLSVerify": { - "description": "Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have their TLS certificate validated (i.e. insecure connections will be allowed). Only enable this option in development environments. The cert-manager system installed roots will be used to verify connections to the ACME server if this is false. Defaults to false.", + "description": "INSECURE: Enables or disables validation of the ACME server TLS certificate. If true, requests to the ACME server will not have the TLS certificate chain validated. Mutually exclusive with CABundle; prefer using CABundle to prevent various kinds of security vulnerabilities. Only enable this option in development environments. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection. Defaults to false.", "type": "boolean" }, "solvers": { @@ -126,7 +134,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "host": { "type": "string" @@ -136,7 +145,8 @@ "accountSecretRef", "host" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "akamai": { "description": "Use the Akamai DNS zone management API to manage DNS01 challenge records.", @@ -156,7 +166,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "clientSecretSecretRef": { "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", @@ -173,7 +184,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "clientTokenSecretRef": { "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", @@ -190,7 +202,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "serviceConsumerDomain": { "type": "string" @@ -202,17 +215,18 @@ "clientTokenSecretRef", "serviceConsumerDomain" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "azureDNS": { "description": "Use the Microsoft Azure DNS API to manage DNS01 challenge records.", "properties": { "clientID": { - "description": "if both this and ClientSecret are left unset MSI will be used", + "description": "Auth: Azure Service Principal: The ClientID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientSecret and TenantID must also be set.", "type": "string" }, "clientSecretSecretRef": { - "description": "if both this and ClientID are left unset MSI will be used", + "description": "Auth: Azure Service Principal: A reference to a Secret containing the password associated with the Service Principal. If set, ClientID and TenantID must also be set.", "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -226,7 +240,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "environment": { "description": "name of the Azure environment (default AzurePublicCloud)", @@ -243,18 +258,19 @@ "type": "string" }, "managedIdentity": { - "description": "managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID", + "description": "Auth: Azure Workload Identity or Azure Managed Service Identity: Settings to enable Azure Workload Identity or Azure Managed Service Identity If set, ClientID, ClientSecret and TenantID must not be set.", "properties": { "clientID": { "description": "client ID of the managed identity, can not be used at the same time as resourceID", "type": "string" }, "resourceID": { - "description": "resource ID of the managed identity, can not be used at the same time as clientID", + "description": "resource ID of the managed identity, can not be used at the same time as clientID Cannot be used for Azure Managed Service Identity", "type": "string" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "resourceGroupName": { "description": "resource group the DNS zone is located in", @@ -265,7 +281,7 @@ "type": "string" }, "tenantID": { - "description": "when specifying ClientID and ClientSecret then this field is also needed", + "description": "Auth: Azure Service Principal: The TenantID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientID and ClientSecret must also be set.", "type": "string" } }, @@ -273,7 +289,8 @@ "resourceGroupName", "subscriptionID" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "cloudDNS": { "description": "Use the Google Cloud DNS API to manage DNS01 challenge records.", @@ -300,13 +317,15 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, "required": [ "project" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "cloudflare": { "description": "Use the Cloudflare API to manage DNS01 challenge records.", @@ -326,7 +345,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "apiTokenSecretRef": { "description": "API token used to authenticate with Cloudflare.", @@ -343,14 +363,16 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "email": { "description": "Email of the account, only required when using API key based authentication.", "type": "string" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "cnameStrategy": { "description": "CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.", @@ -378,19 +400,21 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, "required": [ "tokenSecretRef" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "rfc2136": { "description": "Use RFC2136 (\"Dynamic Updates in the Domain Name System\") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records.", "properties": { "nameserver": { - "description": "The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1]) ; port is optional. This field is required.", + "description": "The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1])\u00a0; port is optional. This field is required.", "type": "string" }, "tsigAlgorithm": { @@ -416,13 +440,15 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, "required": [ "nameserver" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "route53": { "description": "Use the AWS Route53 API to manage DNS01 challenge records.", @@ -446,7 +472,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "hostedZoneID": { "description": "If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.", @@ -475,13 +502,15 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, "required": [ "region" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "webhook": { "description": "Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.", @@ -503,10 +532,12 @@ "groupName", "solverName" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "http01": { "description": "Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism.", @@ -522,20 +553,20 @@ "type": "object" }, "parentRefs": { - "description": "When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/v1alpha2/api-types/httproute/#attaching-to-gateways", + "description": "When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways", "items": { - "description": "ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). The only kind of parent resource with \"Core\" support is Gateway. This API may be extended in the future to support additional kinds of parent resources, such as HTTPRoute. \n The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.", + "description": "ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). There are two kinds of parent resources with \"Core\" support: \n * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) \n This API may be extended in the future to support additional kinds of parent resources. \n The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.", "properties": { "group": { "default": "gateway.networking.k8s.io", - "description": "Group is the group of the referent. \n Support: Core", + "description": "Group is the group of the referent. When unspecified, \"gateway.networking.k8s.io\" is inferred. To set the core API group (such as for a \"Service\" kind referent), Group must be explicitly set to \"\" (empty string). \n Support: Core", "maxLength": 253, "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", "type": "string" }, "kind": { "default": "Gateway", - "description": "Kind is kind of the referent. \n Support: Core (Gateway) \n Support: Custom (Other Resources)", + "description": "Kind is kind of the referent. \n There are two kinds of parent resources with \"Core\" support: \n * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) \n Support for other resources is Implementation-Specific.", "maxLength": 63, "minLength": 1, "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", @@ -548,21 +579,21 @@ "type": "string" }, "namespace": { - "description": "Namespace is the namespace of the referent. When unspecified (or empty string), this refers to the local namespace of the Route. \n Support: Core", + "description": "Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. \n Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. \n ParentRefs from a Route to a Service in the same namespace are \"producer\" routes, which apply default routing rules to inbound connections from any namespace to the Service. \n ParentRefs from a Route to a Service in a different namespace are \"consumer\" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. \n Support: Core", "maxLength": 63, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type": "string" }, "port": { - "description": "Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. \n When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. \n Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. \n For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Extended \n \\u003cgateway:experimental\\u003e", + "description": "Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. \n When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. \n When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. \n Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. \n For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Extended \n ", "format": "int32", "maximum": 65535, "minimum": 1, "type": "integer" }, "sectionName": { - "description": "SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. \n Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. \n When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Core", + "description": "SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. \n Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. \n When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Core", "maxLength": 253, "minLength": 1, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", @@ -572,7 +603,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -581,13 +613,18 @@ "type": "string" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "ingress": { "description": "The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed.", "properties": { "class": { - "description": "The ingress class to use when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of 'class' or 'name' may be specified.", + "description": "This field configures the annotation `kubernetes.io/ingress.class` when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of `class`, `name` or `ingressClassName` may be specified.", + "type": "string" + }, + "ingressClassName": { + "description": "This field configures the field `ingressClassName` on the created Ingress resources used to solve ACME challenges that use this challenge solver. This is the recommended way of configuring the ingress class. Only one of `class`, `name` or `ingressClassName` may be specified.", "type": "string" }, "ingressTemplate": { @@ -611,13 +648,15 @@ "type": "object" } }, - "type": "object" + "type": "object", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "name": { - "description": "The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources.", + "description": "The name of the ingress resource that should have ACME challenge solving routes inserted into it in order to solve HTTP01 challenges. This is typically used in conjunction with ingress controllers like ingress-gce, which maintains a 1:1 mapping between external IPs and ingress resources. Only one of `class`, `name` or `ingressClassName` may be specified.", "type": "string" }, "podTemplate": { @@ -641,10 +680,11 @@ "type": "object" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "spec": { - "description": "PodSpec defines overrides for the HTTP01 challenge solver pod. Only the 'priorityClassName', 'nodeSelector', 'affinity', 'serviceAccountName' and 'tolerations' fields are supported currently. All other fields will be ignored.", + "description": "PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored.", "properties": { "affinity": { "description": "If specified, the pod's scheduling constraints", @@ -685,7 +725,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -714,13 +755,15 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false }, "weight": { "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", @@ -732,7 +775,8 @@ "preference", "weight" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -769,7 +813,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -798,13 +843,15 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false }, "type": "array" } @@ -813,10 +860,12 @@ "nodeSelectorTerms" ], "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "podAffinity": { "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).", @@ -830,7 +879,7 @@ "description": "Required. A pod affinity term, associated with the corresponding weight.", "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -857,7 +906,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -870,7 +920,24 @@ } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false + }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", @@ -900,7 +967,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -913,7 +981,8 @@ } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", @@ -930,7 +999,8 @@ "required": [ "topologyKey" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", @@ -942,17 +1012,18 @@ "podAffinityTerm", "weight" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.", "items": { - "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key \\u003ctopologyKey\\u003e matches that of any node on which a pod of the set of pods is running", + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -979,7 +1050,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -992,7 +1064,24 @@ } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false + }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", @@ -1022,7 +1111,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -1035,7 +1125,8 @@ } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", @@ -1052,12 +1143,14 @@ "required": [ "topologyKey" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "podAntiAffinity": { "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).", @@ -1071,7 +1164,7 @@ "description": "Required. A pod affinity term, associated with the corresponding weight.", "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -1098,7 +1191,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -1111,7 +1205,24 @@ } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false + }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", @@ -1141,7 +1252,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -1154,7 +1266,8 @@ } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", @@ -1171,7 +1284,8 @@ "required": [ "topologyKey" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", @@ -1183,17 +1297,18 @@ "podAffinityTerm", "weight" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.", "items": { - "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key \\u003ctopologyKey\\u003e matches that of any node on which a pod of the set of pods is running", + "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -1220,7 +1335,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -1233,7 +1349,24 @@ } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false + }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", @@ -1263,7 +1396,8 @@ "key", "operator" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" }, @@ -1276,7 +1410,8 @@ } }, "type": "object", - "x-kubernetes-map-type": "atomic" + "x-kubernetes-map-type": "atomic", + "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", @@ -1293,15 +1428,34 @@ "required": [ "topologyKey" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" } }, - "type": "object" + "type": "object", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false + }, + "imagePullSecrets": { + "description": "If specified, the pod's imagePullSecrets", + "items": { + "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?", + "type": "string" + } + }, + "type": "object", + "x-kubernetes-map-type": "atomic", + "additionalProperties": false + }, + "type": "array" }, "nodeSelector": { "additionalProperties": { @@ -1321,7 +1475,7 @@ "tolerations": { "description": "If specified, the pod's tolerations.", "items": { - "description": "The pod this Toleration is attached to tolerates any taint that matches the triple \\u003ckey,value,effect\\u003e using the matching operator \\u003coperator\\u003e.", + "description": "The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .", "properties": { "effect": { "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.", @@ -1345,25 +1499,30 @@ "type": "string" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" } }, - "type": "object" + "type": "object", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "serviceType": { "description": "Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.", "type": "string" } }, - "type": "object" + "type": "object", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "selector": { "description": "Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead.", @@ -1390,10 +1549,12 @@ "type": "object" } }, - "type": "object" + "type": "object", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array" } @@ -1402,7 +1563,8 @@ "privateKeySecretRef", "server" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "ca": { "description": "CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager.", @@ -1414,6 +1576,13 @@ }, "type": "array" }, + "issuingCertificateURLs": { + "description": "IssuingCertificateURLs is a list of URLs which this issuer should embed into certificates it creates. See https://www.rfc-editor.org/rfc/rfc5280#section-4.2.2.1 for more details. As an example, such a URL might be \"http://ca.domain.com/ca.crt\".", + "items": { + "type": "string" + }, + "type": "array" + }, "ocspServers": { "description": "The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be \"http://ocsp.int-x3.letsencrypt.org\".", "items": { @@ -1429,7 +1598,8 @@ "required": [ "secretName" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "selfSigned": { "description": "SelfSigned configures this issuer to 'self sign' certificates using the private key used to create the CertificateRequest object.", @@ -1442,7 +1612,8 @@ "type": "array" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "vault": { "description": "Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend.", @@ -1476,7 +1647,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, "required": [ @@ -1484,7 +1656,8 @@ "roleId", "secretRef" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "kubernetes": { "description": "Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server.", @@ -1512,14 +1685,29 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false + }, + "serviceAccountRef": { + "description": "A reference to a service account that will be used to request a bound token (also known as \"projected token\"). Compared to using \"secretRef\", using this field means that you don't rely on statically bound tokens. To use this field, you must configure an RBAC rule to let cert-manager request a token.", + "properties": { + "name": { + "description": "Name of the ServiceAccount used to request a token.", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object", + "additionalProperties": false } }, "required": [ - "role", - "secretRef" + "role" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "tokenSecretRef": { "description": "TokenSecretRef authenticates with Vault by presenting a token.", @@ -1536,18 +1724,20 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "caBundle": { - "description": "PEM-encoded CA bundle (base64-encoded) used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection. Mutually exclusive with CABundleSecretRef. If neither CABundle nor CABundleSecretRef are defined, the cert-manager controller system root certificates are used to validate the TLS connection.", + "description": "Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by Vault. Only used if using HTTPS to connect to Vault and ignored for HTTP connections. Mutually exclusive with CABundleSecretRef. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection.", "format": "byte", "type": "string" }, "caBundleSecretRef": { - "description": "CABundleSecretRef is a reference to a Secret which contains the CABundle which will be used when connecting to Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundleSecretRef nor CABundle are defined, the cert-manager controller system root certificates are used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to 'ca.crt'.", + "description": "Reference to a Secret containing a bundle of PEM-encoded CAs to use when verifying the certificate chain presented by Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to 'ca.crt'.", "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -1561,7 +1751,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "namespace": { "description": "Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: \"ns1\" More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces", @@ -1581,7 +1772,8 @@ "path", "server" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "venafi": { "description": "Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone.", @@ -1604,7 +1796,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "url": { "description": "URL is the base URL for Venafi Cloud. Defaults to \"https://api.venafi.cloud/v1\".", @@ -1614,13 +1807,14 @@ "required": [ "apiTokenSecretRef" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "tpp": { "description": "TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.", "properties": { "caBundle": { - "description": "CABundle is a PEM encoded TLS certificate to use to verify connections to the TPP instance. If specified, system roots will not be used and the issuing CA for the TPP instance must be verifiable using the provided root. If not specified, the connection will be verified using the cert-manager system root certificates.", + "description": "Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by the TPP server. Only used if using HTTPS; ignored for HTTP. If undefined, the certificate bundle in the cert-manager controller container is used to validate the chain.", "format": "byte", "type": "string" }, @@ -1635,7 +1829,8 @@ "required": [ "name" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "url": { "description": "URL is the base URL for the vedsdk endpoint of the Venafi TPP instance, for example: \"https://tpp.example.com/vedsdk\".", @@ -1646,7 +1841,8 @@ "credentialsRef", "url" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "zone": { "description": "Zone is the Venafi Policy Zone to use for this issuer. All requests made to the Venafi platform will be restricted by the named zone policy. This field is required.", @@ -1656,10 +1852,12 @@ "required": [ "zone" ], - "type": "object" + "type": "object", + "additionalProperties": false } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "status": { "description": "Status of the ClusterIssuer. This is set and managed automatically.", @@ -1667,6 +1865,10 @@ "acme": { "description": "ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates.", "properties": { + "lastPrivateKeyHash": { + "description": "LastPrivateKeyHash is a hash of the private key associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer", + "type": "string" + }, "lastRegisteredEmail": { "description": "LastRegisteredEmail is the email associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer", "type": "string" @@ -1676,7 +1878,8 @@ "type": "string" } }, - "type": "object" + "type": "object", + "additionalProperties": false }, "conditions": { "description": "List of status conditions to indicate the status of a CertificateRequest. Known condition types are `Ready`.", @@ -1719,7 +1922,8 @@ "status", "type" ], - "type": "object" + "type": "object", + "additionalProperties": false }, "type": "array", "x-kubernetes-list-map-keys": [ @@ -1728,11 +1932,12 @@ "x-kubernetes-list-type": "map" } }, - "type": "object" + "type": "object", + "additionalProperties": false } }, "required": [ "spec" ], "type": "object" -} \ No newline at end of file +} diff --git a/cert-manager.io/issuer_v1.json b/cert-manager.io/issuer_v1.json index cbcd2aaa..7535da37 100644 --- a/cert-manager.io/issuer_v1.json +++ b/cert-manager.io/issuer_v1.json @@ -1,9 +1,5 @@ { "description": "An Issuer represents a certificate issuing authority which can be referenced as part of `issuerRef` fields. It is scoped to a single namespace and can therefore only be referenced by resources within the same namespace.", - "type": "object", - "required": [ - "spec" - ], "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", @@ -18,20 +14,14 @@ }, "spec": { "description": "Desired state of the Issuer resource.", - "type": "object", "properties": { "acme": { "description": "ACME configures this issuer to communicate with a RFC8555 (ACME) server to obtain signed x509 certificates.", - "type": "object", - "required": [ - "privateKeySecretRef", - "server" - ], "properties": { "caBundle": { "description": "Base64-encoded bundle of PEM CAs which can be used to validate the certificate chain presented by the ACME server. Mutually exclusive with SkipTLSVerify; prefer using CABundle to prevent various kinds of security vulnerabilities. If CABundle and SkipTLSVerify are unset, the system certificate bundle inside the container is used to validate the TLS connection.", - "type": "string", - "format": "byte" + "format": "byte", + "type": "string" }, "disableAccountKeyGeneration": { "description": "Enables or disables generating a new ACME account key. If true, the Issuer resource will *not* request a new account but will expect the account key to be supplied via an existing secret. If false, the cert-manager system will generate a new ACME account key for the Issuer. Defaults to false.", @@ -47,20 +37,15 @@ }, "externalAccountBinding": { "description": "ExternalAccountBinding is a reference to a CA external account of the ACME server. If set, upon registration cert-manager will attempt to associate the given external account credentials with the registered ACME account.", - "type": "object", - "required": [ - "keyID", - "keySecretRef" - ], "properties": { "keyAlgorithm": { "description": "Deprecated: keyAlgorithm field exists for historical compatibility reasons and should not be used. The algorithm is now hardcoded to HS256 in golang/x/crypto/acme.", - "type": "string", "enum": [ "HS256", "HS384", "HS512" - ] + ], + "type": "string" }, "keyID": { "description": "keyID is the ID of the CA key that the External Account is bound to.", @@ -68,10 +53,6 @@ }, "keySecretRef": { "description": "keySecretRef is a Secret Key Selector referencing a data item in a Kubernetes Secret which holds the symmetric MAC key of the External Account Binding. The `key` is the index string that is paired with the key data in the Secret and should not be confused with the key data itself, or indeed with the External Account Binding keyID above. The secret key stored in the Secret **must** be un-padded, base64 URL encoded data.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -82,22 +63,27 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false } }, + "required": [ + "keyID", + "keySecretRef" + ], + "type": "object", "additionalProperties": false }, "preferredChain": { "description": "PreferredChain is the chain to use if the ACME server outputs multiple. PreferredChain is no guarantee that this one gets delivered by the ACME endpoint. For example, for Let's Encrypt's DST crosssign you would use: \"DST Root CA X3\" or \"ISRG Root X1\" for the newer Let's Encrypt root CA. This value picks the first certificate bundle in the ACME alternative chains that has a certificate with this value as its issuer's CN", - "type": "string", - "maxLength": 64 + "maxLength": 64, + "type": "string" }, "privateKeySecretRef": { "description": "PrivateKey is the name of a Kubernetes Secret resource that will be used to store the automatically generated ACME account private key. Optionally, a `key` may be specified to select a specific entry within the named Secret resource. If `key` is not specified, a default of `tls.key` will be used.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -108,6 +94,10 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "server": { @@ -120,29 +110,17 @@ }, "solvers": { "description": "Solvers is a list of challenge solvers that will be used to solve ACME challenges for the matching domains. Solver configurations must be provided in order to obtain certificates from an ACME server. For more information, see: https://cert-manager.io/docs/configuration/acme/", - "type": "array", "items": { "description": "An ACMEChallengeSolver describes how to solve ACME challenges for the issuer it is part of. A selector may be provided to use different solving strategies for different DNS names. Only one of HTTP01 or DNS01 must be provided.", - "type": "object", "properties": { "dns01": { "description": "Configures cert-manager to attempt to complete authorizations by performing the DNS01 challenge flow.", - "type": "object", "properties": { "acmeDNS": { "description": "Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "accountSecretRef", - "host" - ], "properties": { "accountSecretRef": { "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -153,30 +131,28 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "host": { "type": "string" } }, + "required": [ + "accountSecretRef", + "host" + ], + "type": "object", "additionalProperties": false }, "akamai": { "description": "Use the Akamai DNS zone management API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "accessTokenSecretRef", - "clientSecretSecretRef", - "clientTokenSecretRef", - "serviceConsumerDomain" - ], "properties": { "accessTokenSecretRef": { "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -187,14 +163,14 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "clientSecretSecretRef": { "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -205,14 +181,14 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "clientTokenSecretRef": { "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -223,32 +199,34 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "serviceConsumerDomain": { "type": "string" } }, + "required": [ + "accessTokenSecretRef", + "clientSecretSecretRef", + "clientTokenSecretRef", + "serviceConsumerDomain" + ], + "type": "object", "additionalProperties": false }, "azureDNS": { "description": "Use the Microsoft Azure DNS API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "resourceGroupName", - "subscriptionID" - ], "properties": { "clientID": { - "description": "if both this and ClientSecret are left unset MSI will be used", + "description": "Auth: Azure Service Principal: The ClientID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientSecret and TenantID must also be set.", "type": "string" }, "clientSecretSecretRef": { - "description": "if both this and ClientID are left unset MSI will be used", - "type": "object", - "required": [ - "name" - ], + "description": "Auth: Azure Service Principal: A reference to a Secret containing the password associated with the Service Principal. If set, ClientID and TenantID must also be set.", "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -259,35 +237,39 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "environment": { "description": "name of the Azure environment (default AzurePublicCloud)", - "type": "string", "enum": [ "AzurePublicCloud", "AzureChinaCloud", "AzureGermanCloud", "AzureUSGovernmentCloud" - ] + ], + "type": "string" }, "hostedZoneName": { "description": "name of the DNS zone that should be used", "type": "string" }, "managedIdentity": { - "description": "managed identity configuration, can not be used at the same time as clientID, clientSecretSecretRef or tenantID", - "type": "object", + "description": "Auth: Azure Workload Identity or Azure Managed Service Identity: Settings to enable Azure Workload Identity or Azure Managed Service Identity If set, ClientID, ClientSecret and TenantID must not be set.", "properties": { "clientID": { "description": "client ID of the managed identity, can not be used at the same time as resourceID", "type": "string" }, "resourceID": { - "description": "resource ID of the managed identity, can not be used at the same time as clientID", + "description": "resource ID of the managed identity, can not be used at the same time as clientID Cannot be used for Azure Managed Service Identity", "type": "string" } }, + "type": "object", "additionalProperties": false }, "resourceGroupName": { @@ -299,18 +281,19 @@ "type": "string" }, "tenantID": { - "description": "when specifying ClientID and ClientSecret then this field is also needed", + "description": "Auth: Azure Service Principal: The TenantID of the Azure Service Principal used to authenticate with Azure DNS. If set, ClientID and ClientSecret must also be set.", "type": "string" } }, + "required": [ + "resourceGroupName", + "subscriptionID" + ], + "type": "object", "additionalProperties": false }, "cloudDNS": { "description": "Use the Google Cloud DNS API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "project" - ], "properties": { "hostedZoneName": { "description": "HostedZoneName is an optional field that tells cert-manager in which Cloud DNS zone the challenge record has to be created. If left empty cert-manager will automatically choose a zone.", @@ -321,10 +304,6 @@ }, "serviceAccountSecretRef": { "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -335,21 +314,24 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false } }, + "required": [ + "project" + ], + "type": "object", "additionalProperties": false }, "cloudflare": { "description": "Use the Cloudflare API to manage DNS01 challenge records.", - "type": "object", "properties": { "apiKeySecretRef": { "description": "API key to use to authenticate with Cloudflare. Note: using an API token to authenticate is now the recommended method as it allows greater control of permissions.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -360,14 +342,14 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "apiTokenSecretRef": { "description": "API token used to authenticate with Cloudflare.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -378,6 +360,10 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "email": { @@ -385,29 +371,22 @@ "type": "string" } }, + "type": "object", "additionalProperties": false }, "cnameStrategy": { "description": "CNAMEStrategy configures how the DNS01 provider should handle CNAME records when found in DNS zones.", - "type": "string", "enum": [ "None", "Follow" - ] + ], + "type": "string" }, "digitalocean": { "description": "Use the DigitalOcean DNS API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "tokenSecretRef" - ], "properties": { "tokenSecretRef": { "description": "A reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -418,17 +397,21 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false } }, + "required": [ + "tokenSecretRef" + ], + "type": "object", "additionalProperties": false }, "rfc2136": { "description": "Use RFC2136 (\"Dynamic Updates in the Domain Name System\") (https://datatracker.ietf.org/doc/rfc2136/) to manage DNS01 challenge records.", - "type": "object", - "required": [ - "nameserver" - ], "properties": { "nameserver": { "description": "The IP address or hostname of an authoritative DNS server supporting RFC2136 in the form host:port. If the host is an IPv6 address it must be enclosed in square brackets (e.g [2001:db8::1])\u00a0; port is optional. This field is required.", @@ -444,10 +427,6 @@ }, "tsigSecretSecretRef": { "description": "The name of the secret containing the TSIG value. If ``tsigKeyName`` is defined, this field is required.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -458,17 +437,21 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false } }, + "required": [ + "nameserver" + ], + "type": "object", "additionalProperties": false }, "route53": { "description": "Use the AWS Route53 API to manage DNS01 challenge records.", - "type": "object", - "required": [ - "region" - ], "properties": { "accessKeyID": { "description": "The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", @@ -476,10 +459,6 @@ }, "accessKeyIDSecretRef": { "description": "The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -490,6 +469,10 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "hostedZoneID": { @@ -506,10 +489,6 @@ }, "secretAccessKeySecretRef": { "description": "The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -520,18 +499,21 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false } }, + "required": [ + "region" + ], + "type": "object", "additionalProperties": false }, "webhook": { "description": "Configure an external webhook based DNS01 challenge solver to manage DNS01 challenge records.", - "type": "object", - "required": [ - "groupName", - "solverName" - ], "properties": { "config": { "description": "Additional configuration that should be passed to the webhook apiserver when challenges are processed. This can contain arbitrary JSON data. Secret values should not be specified in this stanza. If secret values are needed (e.g. credentials for a DNS service), you should use a SecretKeySelector to reference a Secret resource. For details on the schema of this field, consult the webhook provider implementation's documentation.", @@ -546,92 +528,96 @@ "type": "string" } }, + "required": [ + "groupName", + "solverName" + ], + "type": "object", "additionalProperties": false } }, + "type": "object", "additionalProperties": false }, "http01": { "description": "Configures cert-manager to attempt to complete authorizations by performing the HTTP01 challenge flow. It is not possible to obtain certificates for wildcard domain names (e.g. `*.example.com`) using the HTTP01 challenge mechanism.", - "type": "object", "properties": { "gatewayHTTPRoute": { "description": "The Gateway API is a sig-network community API that models service networking in Kubernetes (https://gateway-api.sigs.k8s.io/). The Gateway solver will create HTTPRoutes with the specified labels in the same namespace as the challenge. This solver is experimental, and fields / behaviour may change in the future.", - "type": "object", "properties": { "labels": { - "description": "Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Custom labels that will be applied to HTTPRoutes created by cert-manager while solving HTTP-01 challenges.", + "type": "object" }, "parentRefs": { "description": "When solving an HTTP-01 challenge, cert-manager creates an HTTPRoute. cert-manager needs to know which parentRefs should be used when creating the HTTPRoute. Usually, the parentRef references a Gateway. See: https://gateway-api.sigs.k8s.io/api-types/httproute/#attaching-to-gateways", - "type": "array", "items": { - "description": "ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). The only kind of parent resource with \"Core\" support is Gateway. This API may be extended in the future to support additional kinds of parent resources, such as HTTPRoute. \n The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.", - "type": "object", - "required": [ - "name" - ], + "description": "ParentReference identifies an API object (usually a Gateway) that can be considered a parent of this resource (usually a route). There are two kinds of parent resources with \"Core\" support: \n * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) \n This API may be extended in the future to support additional kinds of parent resources. \n The API object must be valid in the cluster; the Group and Kind must be registered in the cluster for this reference to be valid.", "properties": { "group": { - "description": "Group is the group of the referent. When unspecified, \"gateway.networking.k8s.io\" is inferred. To set the core API group (such as for a \"Service\" kind referent), Group must be explicitly set to \"\" (empty string). \n Support: Core", - "type": "string", "default": "gateway.networking.k8s.io", + "description": "Group is the group of the referent. When unspecified, \"gateway.networking.k8s.io\" is inferred. To set the core API group (such as for a \"Service\" kind referent), Group must be explicitly set to \"\" (empty string). \n Support: Core", "maxLength": 253, - "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" + "pattern": "^$|^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", + "type": "string" }, "kind": { - "description": "Kind is kind of the referent. \n Support: Core (Gateway) \n Support: Implementation-specific (Other Resources)", - "type": "string", "default": "Gateway", + "description": "Kind is kind of the referent. \n There are two kinds of parent resources with \"Core\" support: \n * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) \n Support for other resources is Implementation-Specific.", "maxLength": 63, "minLength": 1, - "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$" + "pattern": "^[a-zA-Z]([-a-zA-Z0-9]*[a-zA-Z0-9])?$", + "type": "string" }, "name": { "description": "Name is the name of the referent. \n Support: Core", - "type": "string", "maxLength": 253, - "minLength": 1 + "minLength": 1, + "type": "string" }, "namespace": { - "description": "Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. \n Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. \n Support: Core", - "type": "string", + "description": "Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. \n Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. \n ParentRefs from a Route to a Service in the same namespace are \"producer\" routes, which apply default routing rules to inbound connections from any namespace to the Service. \n ParentRefs from a Route to a Service in a different namespace are \"consumer\" routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. \n Support: Core", "maxLength": 63, "minLength": 1, - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$", + "type": "string" }, "port": { - "description": "Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. \n When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. \n Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. \n For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Extended \n ", - "type": "integer", + "description": "Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. \n When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set `Port` unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. \n When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. \n Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. \n For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Extended \n ", "format": "int32", "maximum": 65535, - "minimum": 1 + "minimum": 1, + "type": "integer" }, "sectionName": { - "description": "SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. \n Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. \n When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Core", - "type": "string", + "description": "SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: \n * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. \n Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. \n When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. \n Support: Core", "maxLength": 253, "minLength": 1, - "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$" + "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$", + "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "serviceType": { "description": "Optional service type for Kubernetes solver service. Supported values are NodePort or ClusterIP. If unset, defaults to NodePort.", "type": "string" } }, + "type": "object", "additionalProperties": false }, "ingress": { "description": "The ingress based HTTP01 challenge solver will solve challenges by creating or modifying Ingress resources in order to route requests for '/.well-known/acme-challenge/XYZ' to 'challenge solver' pods that are provisioned by cert-manager for each Challenge to be completed.", - "type": "object", "properties": { "class": { "description": "This field configures the annotation `kubernetes.io/ingress.class` when creating Ingress resources to solve ACME challenges that use this challenge solver. Only one of `class`, `name` or `ingressClassName` may be specified.", @@ -643,30 +629,30 @@ }, "ingressTemplate": { "description": "Optional ingress template used to configure the ACME challenge solver ingress used for HTTP01 challenges.", - "type": "object", "properties": { "metadata": { "description": "ObjectMeta overrides for the ingress used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.", - "type": "object", "properties": { "annotations": { - "description": "Annotations that should be added to the created ACME HTTP01 solver ingress.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Annotations that should be added to the created ACME HTTP01 solver ingress.", + "type": "object" }, "labels": { - "description": "Labels that should be added to the created ACME HTTP01 solver ingress.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Labels that should be added to the created ACME HTTP01 solver ingress.", + "type": "object" } }, + "type": "object", "additionalProperties": false } }, + "type": "object", "additionalProperties": false }, "name": { @@ -675,66 +661,49 @@ }, "podTemplate": { "description": "Optional pod template used to configure the ACME challenge solver pods used for HTTP01 challenges.", - "type": "object", "properties": { "metadata": { "description": "ObjectMeta overrides for the pod used to solve HTTP01 challenges. Only the 'labels' and 'annotations' fields may be set. If labels or annotations overlap with in-built values, the values here will override the in-built values.", - "type": "object", "properties": { "annotations": { - "description": "Annotations that should be added to the create ACME HTTP01 solver pods.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Annotations that should be added to the create ACME HTTP01 solver pods.", + "type": "object" }, "labels": { - "description": "Labels that should be added to the created ACME HTTP01 solver pods.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Labels that should be added to the created ACME HTTP01 solver pods.", + "type": "object" } }, + "type": "object", "additionalProperties": false }, "spec": { "description": "PodSpec defines overrides for the HTTP01 challenge solver pod. Check ACMEChallengeSolverHTTP01IngressPodSpec to find out currently supported fields. All other fields will be ignored.", - "type": "object", "properties": { "affinity": { "description": "If specified, the pod's scheduling constraints", - "type": "object", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.", - "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node matches the corresponding matchExpressions; the node(s) with the highest sum are the most preferred.", - "type": "array", "items": { "description": "An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).", - "type": "object", - "required": [ - "preference", - "weight" - ], "properties": { "preference": { "description": "A node selector term, associated with the corresponding weight.", - "type": "object", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.", - "type": "array", "items": { "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "The label key that the selector applies to.", @@ -746,25 +715,25 @@ }, "values": { "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchFields": { "description": "A list of node selector requirements by node's fields.", - "type": "array", "items": { "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "The label key that the selector applies to.", @@ -776,52 +745,53 @@ }, "values": { "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "weight": { "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" } }, + "required": [ + "preference", + "weight" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to an update), the system may or may not try to eventually evict the pod from its node.", - "type": "object", - "required": [ - "nodeSelectorTerms" - ], "properties": { "nodeSelectorTerms": { "description": "Required. A list of node selector terms. The terms are ORed.", - "type": "array", "items": { "description": "A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.", - "type": "object", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.", - "type": "array", "items": { "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "The label key that the selector applies to.", @@ -833,25 +803,25 @@ }, "values": { "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchFields": { "description": "A list of node selector requirements by node's fields.", - "type": "array", "items": { "description": "A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "The label key that the selector applies to.", @@ -863,63 +833,58 @@ }, "values": { "description": "An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false - } + }, + "type": "array" } }, + "required": [ + "nodeSelectorTerms" + ], + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false } }, + "type": "object", "additionalProperties": false }, "podAffinity": { "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).", - "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.", - "type": "array", "items": { "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", - "type": "object", - "required": [ - "podAffinityTerm", - "weight" - ], "properties": { "podAffinityTerm": { "description": "Required. A pod affinity term, associated with the corresponding weight.", - "type": "object", - "required": [ - "topologyKey" - ], "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", - "type": "object", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "key is the label key that the selector applies to.", @@ -931,40 +896,56 @@ }, "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 merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchLabels": { - "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", "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.", + "type": "object" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", - "type": "object", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "key is the label key that the selector applies to.", @@ -976,73 +957,78 @@ }, "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 merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchLabels": { - "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", "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.", + "type": "object" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", "type": "string" } }, + "required": [ + "topologyKey" + ], + "type": "object", "additionalProperties": false }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" } }, + "required": [ + "podAffinityTerm", + "weight" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.", - "type": "array", "items": { "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", - "type": "object", - "required": [ - "topologyKey" - ], "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", - "type": "object", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "key is the label key that the selector applies to.", @@ -1054,40 +1040,56 @@ }, "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 merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchLabels": { - "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", "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.", + "type": "object" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", - "type": "object", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "key is the label key that the selector applies to.", @@ -1099,80 +1101,75 @@ }, "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 merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchLabels": { - "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", "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.", + "type": "object" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", "type": "string" } }, + "required": [ + "topologyKey" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" } }, + "type": "object", "additionalProperties": false }, "podAntiAffinity": { "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).", - "type": "object", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that is most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), compute a sum by iterating through the elements of this field and adding \"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred.", - "type": "array", "items": { "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", - "type": "object", - "required": [ - "podAffinityTerm", - "weight" - ], "properties": { "podAffinityTerm": { "description": "Required. A pod affinity term, associated with the corresponding weight.", - "type": "object", - "required": [ - "topologyKey" - ], "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", - "type": "object", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "key is the label key that the selector applies to.", @@ -1184,40 +1181,56 @@ }, "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 merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchLabels": { - "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", "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.", + "type": "object" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", - "type": "object", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "key is the label key that the selector applies to.", @@ -1229,73 +1242,78 @@ }, "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 merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchLabels": { - "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", "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.", + "type": "object" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", "type": "string" } }, + "required": [ + "topologyKey" + ], + "type": "object", "additionalProperties": false }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm, in the range 1-100.", - "type": "integer", - "format": "int32" + "format": "int32", + "type": "integer" } }, + "required": [ + "podAffinityTerm", + "weight" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to a pod label update), the system may or may not try to eventually evict the pod from its node. When there are multiple elements, the lists of nodes corresponding to each podAffinityTerm are intersected, i.e. all terms must be satisfied.", - "type": "array", "items": { "description": "Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running", - "type": "object", - "required": [ - "topologyKey" - ], "properties": { "labelSelector": { - "description": "A label query over a set of resources, in this case pods.", - "type": "object", + "description": "A label query over a set of resources, in this case pods. If it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "key is the label key that the selector applies to.", @@ -1307,40 +1325,56 @@ }, "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 merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchLabels": { - "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", "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.", + "type": "object" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, + "matchLabelKeys": { + "description": "MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key in (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. Also, MatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, + "mismatchLabelKeys": { + "description": "MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged with `LabelSelector` as `key notin (value)` to select the group of existing pods which pods will be taken into consideration for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both MismatchLabelKeys and LabelSelector. Also, MismatchLabelKeys cannot be set when LabelSelector isn't set. This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "namespaceSelector": { "description": "A label query over the set of namespaces that the term applies to. The term is applied to the union of the namespaces selected by this field and the ones listed in the namespaces field. null selector and null or empty namespaces list means \"this pod's namespace\". An empty selector ({}) matches all namespaces.", - "type": "object", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", - "type": "array", "items": { "description": "A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.", - "type": "object", - "required": [ - "key", - "operator" - ], "properties": { "key": { "description": "key is the label key that the selector applies to.", @@ -1352,69 +1386,83 @@ }, "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 merge patch.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "required": [ + "key", + "operator" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" }, "matchLabels": { - "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", "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.", + "type": "object" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector. null or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.", "type": "string" } }, + "required": [ + "topologyKey" + ], + "type": "object", "additionalProperties": false - } + }, + "type": "array" } }, + "type": "object", "additionalProperties": false } }, + "type": "object", "additionalProperties": false }, "imagePullSecrets": { "description": "If specified, the pod's imagePullSecrets", - "type": "array", "items": { "description": "LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.", - "type": "object", "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?", "type": "string" } }, + "type": "object", "x-kubernetes-map-type": "atomic", "additionalProperties": false - } + }, + "type": "array" }, "nodeSelector": { - "description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/", + "type": "object" }, "priorityClassName": { "description": "If specified, the pod's priorityClassName.", @@ -1426,10 +1474,8 @@ }, "tolerations": { "description": "If specified, the pod's tolerations.", - "type": "array", "items": { "description": "The pod this Toleration is attached to tolerates any taint that matches the triple using the matching operator .", - "type": "object", "properties": { "effect": { "description": "Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.", @@ -1445,21 +1491,25 @@ }, "tolerationSeconds": { "description": "TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.", - "type": "integer", - "format": "int64" + "format": "int64", + "type": "integer" }, "value": { "description": "Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.", "type": "string" } }, + "type": "object", "additionalProperties": false - } + }, + "type": "array" } }, + "type": "object", "additionalProperties": false } }, + "type": "object", "additionalProperties": false }, "serviceType": { @@ -1467,109 +1517,112 @@ "type": "string" } }, + "type": "object", "additionalProperties": false } }, + "type": "object", "additionalProperties": false }, "selector": { "description": "Selector selects a set of DNSNames on the Certificate resource that should be solved using this challenge solver. If not specified, the solver will be treated as the 'default' solver with the lowest priority, i.e. if any other solver has a more specific match, it will be used instead.", - "type": "object", "properties": { "dnsNames": { "description": "List of DNSNames that this solver will be used to solve. If specified and a match is found, a dnsNames selector will take precedence over a dnsZones selector. If multiple solvers match with the same dnsNames value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" }, "dnsZones": { "description": "List of DNSZones that this solver will be used to solve. The most specific DNS zone match specified here will take precedence over other DNS zone matches, so a solver specifying sys.example.com will be selected over one specifying example.com for the domain www.sys.example.com. If multiple solvers match with the same dnsZones value, the solver with the most matching labels in matchLabels will be selected. If neither has more matches, the solver defined earlier in the list will be selected.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" }, "matchLabels": { - "description": "A label selector that is used to refine the set of certificate's that this challenge solver will apply to.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "A label selector that is used to refine the set of certificate's that this challenge solver will apply to.", + "type": "object" } }, + "type": "object", "additionalProperties": false } }, + "type": "object", "additionalProperties": false - } + }, + "type": "array" } }, + "required": [ + "privateKeySecretRef", + "server" + ], + "type": "object", "additionalProperties": false }, "ca": { "description": "CA configures this issuer to sign certificates using a signing CA keypair stored in a Secret resource. This is used to build internal PKIs that are managed by cert-manager.", - "type": "object", - "required": [ - "secretName" - ], "properties": { "crlDistributionPoints": { "description": "The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set, certificates will be issued without distribution points set.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" + }, + "issuingCertificateURLs": { + "description": "IssuingCertificateURLs is a list of URLs which this issuer should embed into certificates it creates. See https://www.rfc-editor.org/rfc/rfc5280#section-4.2.2.1 for more details. As an example, such a URL might be \"http://ca.domain.com/ca.crt\".", + "items": { + "type": "string" + }, + "type": "array" }, "ocspServers": { "description": "The OCSP server list is an X.509 v3 extension that defines a list of URLs of OCSP responders. The OCSP responders can be queried for the revocation status of an issued certificate. If not set, the certificate will be issued with no OCSP servers set. For example, an OCSP server URL could be \"http://ocsp.int-x3.letsencrypt.org\".", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" }, "secretName": { "description": "SecretName is the name of the secret used to sign Certificates issued by this Issuer.", "type": "string" } }, + "required": [ + "secretName" + ], + "type": "object", "additionalProperties": false }, "selfSigned": { "description": "SelfSigned configures this issuer to 'self sign' certificates using the private key used to create the CertificateRequest object.", - "type": "object", "properties": { "crlDistributionPoints": { "description": "The CRL distribution points is an X.509 v3 certificate extension which identifies the location of the CRL from which the revocation of this certificate can be checked. If not set certificate will be issued without CDP. Values are strings.", - "type": "array", "items": { "type": "string" - } + }, + "type": "array" } }, + "type": "object", "additionalProperties": false }, "vault": { "description": "Vault configures this issuer to sign certificates using a HashiCorp Vault PKI backend.", - "type": "object", - "required": [ - "auth", - "path", - "server" - ], "properties": { "auth": { "description": "Auth configures how cert-manager authenticates with the Vault server.", - "type": "object", "properties": { "appRole": { "description": "AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.", - "type": "object", - "required": [ - "path", - "roleId", - "secretRef" - ], "properties": { "path": { "description": "Path where the App Role authentication backend is mounted in Vault, e.g: \"approle\"", @@ -1581,10 +1634,6 @@ }, "secretRef": { "description": "Reference to a key in a Secret that contains the App Role secret used to authenticate with Vault. The `key` field must be specified and denotes which entry within the Secret resource is used as the app role secret.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -1595,17 +1644,23 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false } }, + "required": [ + "path", + "roleId", + "secretRef" + ], + "type": "object", "additionalProperties": false }, "kubernetes": { "description": "Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server.", - "type": "object", - "required": [ - "role" - ], "properties": { "mountPath": { "description": "The Vault mountPath here is the mount path to use when authenticating with Vault. For example, setting a value to `/v1/auth/foo`, will use the path `/v1/auth/foo/login` to authenticate with Vault. If unspecified, the default value \"/v1/auth/kubernetes\" will be used.", @@ -1617,10 +1672,6 @@ }, "secretRef": { "description": "The required Secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. Use of 'ambient credentials' is not supported.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -1631,31 +1682,35 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "serviceAccountRef": { "description": "A reference to a service account that will be used to request a bound token (also known as \"projected token\"). Compared to using \"secretRef\", using this field means that you don't rely on statically bound tokens. To use this field, you must configure an RBAC rule to let cert-manager request a token.", - "type": "object", - "required": [ - "name" - ], "properties": { "name": { "description": "Name of the ServiceAccount used to request a token.", "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false } }, + "required": [ + "role" + ], + "type": "object", "additionalProperties": false }, "tokenSecretRef": { "description": "TokenSecretRef authenticates with Vault by presenting a token.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -1666,22 +1721,23 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false } }, + "type": "object", "additionalProperties": false }, "caBundle": { "description": "Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by Vault. Only used if using HTTPS to connect to Vault and ignored for HTTP connections. Mutually exclusive with CABundleSecretRef. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection.", - "type": "string", - "format": "byte" + "format": "byte", + "type": "string" }, "caBundleSecretRef": { "description": "Reference to a Secret containing a bundle of PEM-encoded CAs to use when verifying the certificate chain presented by Vault when using HTTPS. Mutually exclusive with CABundle. If neither CABundle nor CABundleSecretRef are defined, the certificate bundle in the cert-manager controller container is used to validate the TLS connection. If no key for the Secret is specified, cert-manager will default to 'ca.crt'.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -1692,6 +1748,10 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "namespace": { @@ -1707,28 +1767,22 @@ "type": "string" } }, + "required": [ + "auth", + "path", + "server" + ], + "type": "object", "additionalProperties": false }, "venafi": { "description": "Venafi configures this issuer to sign certificates using a Venafi TPP or Venafi Cloud policy zone.", - "type": "object", - "required": [ - "zone" - ], "properties": { "cloud": { "description": "Cloud specifies the Venafi cloud configuration settings. Only one of TPP or Cloud may be specified.", - "type": "object", - "required": [ - "apiTokenSecretRef" - ], "properties": { "apiTokenSecretRef": { "description": "APITokenSecretRef is a secret key selector for the Venafi Cloud API token.", - "type": "object", - "required": [ - "name" - ], "properties": { "key": { "description": "The key of the entry in the Secret resource's `data` field to be used. Some instances of this field may be defaulted, in others it may be required.", @@ -1739,6 +1793,10 @@ "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "url": { @@ -1746,33 +1804,32 @@ "type": "string" } }, + "required": [ + "apiTokenSecretRef" + ], + "type": "object", "additionalProperties": false }, "tpp": { "description": "TPP specifies Trust Protection Platform configuration settings. Only one of TPP or Cloud may be specified.", - "type": "object", - "required": [ - "credentialsRef", - "url" - ], "properties": { "caBundle": { "description": "Base64-encoded bundle of PEM CAs which will be used to validate the certificate chain presented by the TPP server. Only used if using HTTPS; ignored for HTTP. If undefined, the certificate bundle in the cert-manager controller container is used to validate the chain.", - "type": "string", - "format": "byte" + "format": "byte", + "type": "string" }, "credentialsRef": { "description": "CredentialsRef is a reference to a Secret containing the username and password for the TPP server. The secret must contain two keys, 'username' and 'password'.", - "type": "object", - "required": [ - "name" - ], "properties": { "name": { "description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" } }, + "required": [ + "name" + ], + "type": "object", "additionalProperties": false }, "url": { @@ -1780,6 +1837,11 @@ "type": "string" } }, + "required": [ + "credentialsRef", + "url" + ], + "type": "object", "additionalProperties": false }, "zone": { @@ -1787,18 +1849,21 @@ "type": "string" } }, + "required": [ + "zone" + ], + "type": "object", "additionalProperties": false } }, + "type": "object", "additionalProperties": false }, "status": { "description": "Status of the Issuer. This is set and managed automatically.", - "type": "object", "properties": { "acme": { "description": "ACME specific status options. This field should only be set if the Issuer is configured to use an ACME server to issue certificates.", - "type": "object", "properties": { "lastPrivateKeyHash": { "description": "LastPrivateKeyHash is a hash of the private key associated with the latest registered ACME account, in order to track changes made to registered account associated with the Issuer", @@ -1813,23 +1878,18 @@ "type": "string" } }, + "type": "object", "additionalProperties": false }, "conditions": { "description": "List of status conditions to indicate the status of a CertificateRequest. Known condition types are `Ready`.", - "type": "array", "items": { "description": "IssuerCondition contains condition information for an Issuer.", - "type": "object", - "required": [ - "status", - "type" - ], "properties": { "lastTransitionTime": { "description": "LastTransitionTime is the timestamp corresponding to the last status change of this condition.", - "type": "string", - "format": "date-time" + "format": "date-time", + "type": "string" }, "message": { "description": "Message is a human readable description of the details of the last transition, complementing reason.", @@ -1837,8 +1897,8 @@ }, "observedGeneration": { "description": "If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Issuer.", - "type": "integer", - "format": "int64" + "format": "int64", + "type": "integer" }, "reason": { "description": "Reason is a brief machine readable explanation for the condition's last transition.", @@ -1846,27 +1906,38 @@ }, "status": { "description": "Status of the condition, one of (`True`, `False`, `Unknown`).", - "type": "string", "enum": [ "True", "False", "Unknown" - ] + ], + "type": "string" }, "type": { "description": "Type of the condition, known values are (`Ready`).", "type": "string" } }, + "required": [ + "status", + "type" + ], + "type": "object", "additionalProperties": false }, + "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" } }, + "type": "object", "additionalProperties": false } - } + }, + "required": [ + "spec" + ], + "type": "object" } diff --git a/cert-manager.io/order_v1.json b/cert-manager.io/order_v1.json deleted file mode 100644 index 3f8f7a7c..00000000 --- a/cert-manager.io/order_v1.json +++ /dev/null @@ -1,188 +0,0 @@ -{ - "description": "Order is a type to represent an Order with an ACME server", - "type": "object", - "required": [ - "metadata", - "spec" - ], - "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": { - "type": "object", - "required": [ - "issuerRef", - "request" - ], - "properties": { - "commonName": { - "description": "CommonName is the common name as specified on the DER encoded CSR. If specified, this value must also be present in `dnsNames` or `ipAddresses`. This field must match the corresponding field on the DER encoded CSR.", - "type": "string" - }, - "dnsNames": { - "description": "DNSNames is a list of DNS names that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR.", - "type": "array", - "items": { - "type": "string" - } - }, - "duration": { - "description": "Duration is the duration for the not after date for the requested certificate. this is set on order creation as pe the ACME spec.", - "type": "string" - }, - "ipAddresses": { - "description": "IPAddresses is a list of IP addresses that should be included as part of the Order validation process. This field must match the corresponding field on the DER encoded CSR.", - "type": "array", - "items": { - "type": "string" - } - }, - "issuerRef": { - "description": "IssuerRef references a properly configured ACME-type Issuer which should be used to create this Order. If the Issuer does not exist, processing will be retried. If the Issuer is not an 'ACME' Issuer, an error will be returned and the Order will be marked as failed.", - "type": "object", - "required": [ - "name" - ], - "properties": { - "group": { - "description": "Group of the resource being referred to.", - "type": "string" - }, - "kind": { - "description": "Kind of the resource being referred to.", - "type": "string" - }, - "name": { - "description": "Name of the resource being referred to.", - "type": "string" - } - }, - "additionalProperties": false - }, - "request": { - "description": "Certificate signing request bytes in DER encoding. This will be used when finalizing the order. This field must be set on the order.", - "type": "string", - "format": "byte" - } - }, - "additionalProperties": false - }, - "status": { - "type": "object", - "properties": { - "authorizations": { - "description": "Authorizations contains data returned from the ACME server on what authorizations must be completed in order to validate the DNS names specified on the Order.", - "type": "array", - "items": { - "description": "ACMEAuthorization contains data returned from the ACME server on an authorization that must be completed in order validate a DNS name on an ACME Order resource.", - "type": "object", - "required": [ - "url" - ], - "properties": { - "challenges": { - "description": "Challenges specifies the challenge types offered by the ACME server. One of these challenge types will be selected when validating the DNS name and an appropriate Challenge resource will be created to perform the ACME challenge process.", - "type": "array", - "items": { - "description": "Challenge specifies a challenge offered by the ACME server for an Order. An appropriate Challenge resource can be created to perform the ACME challenge process.", - "type": "object", - "required": [ - "token", - "type", - "url" - ], - "properties": { - "token": { - "description": "Token is the token that must be presented for this challenge. This is used to compute the 'key' that must also be presented.", - "type": "string" - }, - "type": { - "description": "Type is the type of challenge being offered, e.g. 'http-01', 'dns-01', 'tls-sni-01', etc. This is the raw value retrieved from the ACME server. Only 'http-01' and 'dns-01' are supported by cert-manager, other values will be ignored.", - "type": "string" - }, - "url": { - "description": "URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.", - "type": "string" - } - }, - "additionalProperties": false - } - }, - "identifier": { - "description": "Identifier is the DNS name to be validated as part of this authorization", - "type": "string" - }, - "initialState": { - "description": "InitialState is the initial state of the ACME authorization when first fetched from the ACME server. If an Authorization is already 'valid', the Order controller will not create a Challenge resource for the authorization. This will occur when working with an ACME server that enables 'authz reuse' (such as Let's Encrypt's production endpoint). If not set and 'identifier' is set, the state is assumed to be pending and a Challenge will be created.", - "type": "string", - "enum": [ - "valid", - "ready", - "pending", - "processing", - "invalid", - "expired", - "errored" - ] - }, - "url": { - "description": "URL is the URL of the Authorization that must be completed", - "type": "string" - }, - "wildcard": { - "description": "Wildcard will be true if this authorization is for a wildcard DNS name. If this is true, the identifier will be the *non-wildcard* version of the DNS name. For example, if '*.example.com' is the DNS name being validated, this field will be 'true' and the 'identifier' field will be 'example.com'.", - "type": "boolean" - } - }, - "additionalProperties": false - } - }, - "certificate": { - "description": "Certificate is a copy of the PEM encoded certificate for this Order. This field will be populated after the order has been successfully finalized with the ACME server, and the order has transitioned to the 'valid' state.", - "type": "string", - "format": "byte" - }, - "failureTime": { - "description": "FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off.", - "type": "string", - "format": "date-time" - }, - "finalizeURL": { - "description": "FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed.", - "type": "string" - }, - "reason": { - "description": "Reason optionally provides more information about a why the order is in the current state.", - "type": "string" - }, - "state": { - "description": "State contains the current state of this Order resource. States 'success' and 'expired' are 'final'", - "type": "string", - "enum": [ - "valid", - "ready", - "pending", - "processing", - "invalid", - "expired", - "errored" - ] - }, - "url": { - "description": "URL of the Order. This will initially be empty when the resource is first created. The Order controller will populate this field when the Order is first processed. This field will be immutable after it is initially set.", - "type": "string" - } - }, - "additionalProperties": false - } - } -} diff --git a/trust.cert-manager.io/bundle_v1alpha1.json b/trust.cert-manager.io/bundle_v1alpha1.json index 20277460..29882f54 100644 --- a/trust.cert-manager.io/bundle_v1alpha1.json +++ b/trust.cert-manager.io/bundle_v1alpha1.json @@ -1,11 +1,11 @@ { "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.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore 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.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { @@ -17,25 +17,75 @@ "sources": { "description": "Sources is a set of references to data whose data will sync to the target.", "items": { - "description": "BundleSource is the set of sources whose data will be appended and synced to the BundleTarget in all Namespaces.", + "description": "BundleSource is the set of sources whose data will be appended and synced to\nthe BundleTarget in all Namespaces.", "properties": { "configMap": { - "description": "ConfigMap is a reference to a ConfigMap's `data` key, in the trust Namespace.", + "description": "ConfigMap is a reference (by name) to a ConfigMap's `data` key(s), or to a\nlist of ConfigMap's `data` key(s) using label selector, in the trust Namespace.", "properties": { + "includeAllKeys": { + "description": "IncludeAllKeys is a flag to include all keys in the object's `data` field to be used. False by default.\nThis field must not be true when `Key` is set.", + "type": "boolean" + }, "key": { - "description": "Key is the key of the entry in the object's `data` field to be used.", + "description": "Key of the entry in the object's `data` field to be used.", + "minLength": 1, "type": "string" }, "name": { - "description": "Name is the name of the source object in the trust Namespace.", + "description": "Name is the name of the source object in the trust Namespace.\nThis field must be left empty when `selector` is set", + "minLength": 1, "type": "string" + }, + "selector": { + "description": "Selector is the label selector to use to fetch a list of objects. Must not be set\nwhen `Name` is set.", + "properties": { + "matchExpressions": { + "description": "matchExpressions is a list of 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\nrelates 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.\nValid 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,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + } + }, + "required": [ + "key", + "operator" + ], + "type": "object", + "additionalProperties": false + }, + "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\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", + "type": "object" + } + }, + "type": "object", + "x-kubernetes-map-type": "atomic", + "additionalProperties": false } }, - "required": [ - "key", - "name" - ], "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "inLine": { @@ -43,33 +93,87 @@ "type": "string" }, "secret": { - "description": "Secret is a reference to a Secrets's `data` key, in the trust Namespace.", + "description": "Secret is a reference (by name) to a Secret's `data` key(s), or to a\nlist of Secret's `data` key(s) using label selector, in the trust Namespace.", "properties": { + "includeAllKeys": { + "description": "IncludeAllKeys is a flag to include all keys in the object's `data` field to be used. False by default.\nThis field must not be true when `Key` is set.", + "type": "boolean" + }, "key": { - "description": "Key is the key of the entry in the object's `data` field to be used.", + "description": "Key of the entry in the object's `data` field to be used.", + "minLength": 1, "type": "string" }, "name": { - "description": "Name is the name of the source object in the trust Namespace.", + "description": "Name is the name of the source object in the trust Namespace.\nThis field must be left empty when `selector` is set", + "minLength": 1, "type": "string" + }, + "selector": { + "description": "Selector is the label selector to use to fetch a list of objects. Must not be set\nwhen `Name` is set.", + "properties": { + "matchExpressions": { + "description": "matchExpressions is a list of 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\nrelates 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.\nValid 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,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + } + }, + "required": [ + "key", + "operator" + ], + "type": "object", + "additionalProperties": false + }, + "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\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", + "type": "object" + } + }, + "type": "object", + "x-kubernetes-map-type": "atomic", + "additionalProperties": false } }, - "required": [ - "key", - "name" - ], "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, "useDefaultCAs": { - "description": "UseDefaultCAs, when true, requests the default CA bundle to be used as a source. Default CAs are available if trust-manager was installed via Helm or was otherwise set up to include a package-injecting init container by using the \"--default-package-location\" flag when starting the trust-manager controller. If default CAs were not configured at start-up, any request to use the default CAs will fail. The version of the default CA package which is used for a Bundle is stored in the defaultCAPackageVersion field of the Bundle's status field.", + "description": "UseDefaultCAs, when true, requests the default CA bundle to be used as a source.\nDefault CAs are available if trust-manager was installed via Helm\nor was otherwise set up to include a package-injecting init container by using the\n\"--default-package-location\" flag when starting the trust-manager controller.\nIf default CAs were not configured at start-up, any request to use the default\nCAs will fail.\nThe version of the default CA package which is used for a Bundle is stored in the\ndefaultCAPackageVersion field of the Bundle's status field.", "type": "boolean" } }, "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false }, - "type": "array" + "maxItems": 100, + "minItems": 1, + "type": "array", + "x-kubernetes-list-type": "atomic" }, "target": { "description": "Target is the target location in all namespaces to sync source data to.", @@ -78,10 +182,40 @@ "description": "AdditionalFormats specifies any additional formats to write to the target", "properties": { "jks": { - "description": "KeySelector is a reference to a key for some map data object.", + "description": "JKS requests a JKS-formatted binary trust bundle to be written to the target.\nThe bundle has \"changeit\" as the default password.\nFor more information refer to this link https://cert-manager.io/docs/faq/#keystore-passwords", + "properties": { + "key": { + "description": "Key is the key of the entry in the object's `data` field to be used.", + "minLength": 1, + "type": "string" + }, + "password": { + "default": "changeit", + "description": "Password for JKS trust store", + "maxLength": 128, + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object", + "x-kubernetes-map-type": "atomic", + "additionalProperties": false + }, + "pkcs12": { + "description": "PKCS12 requests a PKCS12-formatted binary trust bundle to be written to the target.\nThe bundle is by default created without a password.", "properties": { "key": { "description": "Key is the key of the entry in the object's `data` field to be used.", + "minLength": 1, + "type": "string" + }, + "password": { + "default": "", + "description": "Password for PKCS12 trust store", + "maxLength": 128, "type": "string" } }, @@ -89,6 +223,7 @@ "key" ], "type": "object", + "x-kubernetes-map-type": "atomic", "additionalProperties": false } }, @@ -96,10 +231,11 @@ "additionalProperties": false }, "configMap": { - "description": "ConfigMap is the target ConfigMap in Namespaces that all Bundle source data will be synced to.", + "description": "ConfigMap is the target ConfigMap in Namespaces that all Bundle source\ndata will be synced to.", "properties": { "key": { "description": "Key is the key of the entry in the object's `data` field to be used.", + "minLength": 1, "type": "string" } }, @@ -110,17 +246,65 @@ "additionalProperties": false }, "namespaceSelector": { - "description": "NamespaceSelector will, if set, only sync the target resource in Namespaces which match the selector.", + "description": "NamespaceSelector will, if set, only sync the target resource in\nNamespaces which match the selector.", "properties": { + "matchExpressions": { + "description": "matchExpressions is a list of 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\nrelates 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.\nValid 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,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", + "items": { + "type": "string" + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + } + }, + "required": [ + "key", + "operator" + ], + "type": "object", + "additionalProperties": false + }, + "type": "array", + "x-kubernetes-list-type": "atomic" + }, "matchLabels": { "additionalProperties": { "type": "string" }, - "description": "MatchLabels matches on the set of labels that must be present on a Namespace for the Bundle target to be synced there.", + "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": "object" } }, "type": "object", + "x-kubernetes-map-type": "atomic", + "additionalProperties": false + }, + "secret": { + "description": "Secret is the target Secret that all Bundle source data will be synced to.\nUsing Secrets as targets is only supported if enabled at trust-manager startup.\nBy default, trust-manager has no permissions for writing to secrets and can only read secrets in the trust namespace.", + "properties": { + "key": { + "description": "Key is the key of the entry in the object's `data` field to be used.", + "minLength": 1, + "type": "string" + } + }, + "required": [ + "key" + ], + "type": "object", "additionalProperties": false } }, @@ -139,105 +323,67 @@ "description": "Status of the Bundle. This is set and managed automatically.", "properties": { "conditions": { - "description": "List of status conditions to indicate the status of the Bundle. Known condition types are `Bundle`.", + "description": "List of status conditions to indicate the status of the Bundle.\nKnown condition types are `Bundle`.", "items": { "description": "BundleCondition contains condition information for a Bundle.", "properties": { "lastTransitionTime": { - "description": "LastTransitionTime is the timestamp corresponding to the last status change of this condition.", + "description": "LastTransitionTime is the timestamp corresponding to the last status\nchange of this condition.", "format": "date-time", "type": "string" }, "message": { - "description": "Message is a human readable description of the details of the last transition, complementing reason.", + "description": "Message is a human-readable description of the details of the last\ntransition, complementing reason.", + "maxLength": 32768, "type": "string" }, "observedGeneration": { - "description": "If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Bundle.", + "description": "If set, this represents the .metadata.generation that the condition was\nset based upon.\nFor instance, if .metadata.generation is currently 12, but the\n.status.condition[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the Bundle.", "format": "int64", + "minimum": 0, "type": "integer" }, "reason": { - "description": "Reason is a brief machine readable explanation for the condition's last transition.", + "description": "Reason is a brief machine-readable explanation for the condition's last\ntransition.\nThe value should be a CamelCase string.\nThis field may not be empty.", + "maxLength": 1024, + "minLength": 1, + "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { - "description": "Status of the condition, one of ('True', 'False', 'Unknown').", + "description": "Status of the condition, one of True, False, Unknown.", + "enum": [ + "True", + "False", + "Unknown" + ], "type": "string" }, "type": { "description": "Type of the condition, known values are (`Synced`).", + "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" } }, "required": [ + "lastTransitionTime", + "reason", "status", "type" ], "type": "object", "additionalProperties": false }, - "type": "array" + "type": "array", + "x-kubernetes-list-map-keys": [ + "type" + ], + "x-kubernetes-list-type": "map" }, "defaultCAVersion": { - "description": "DefaultCAPackageVersion, if set and non-empty, indicates the version information which was retrieved when the set of default CAs was requested in the bundle source. This should only be set if useDefaultCAs was set to \"true\" on a source, and will be the same for the same version of a bundle with identical certificates.", + "description": "DefaultCAPackageVersion, if set and non-empty, indicates the version information\nwhich was retrieved when the set of default CAs was requested in the bundle\nsource. This should only be set if useDefaultCAs was set to \"true\" on a source,\nand will be the same for the same version of a bundle with identical certificates.", "type": "string" - }, - "target": { - "description": "Target is the current Target that the Bundle is attempting or has completed syncing the source data to.", - "properties": { - "additionalFormats": { - "description": "AdditionalFormats specifies any additional formats to write to the target", - "properties": { - "jks": { - "description": "KeySelector is a reference to a key for some map data object.", - "properties": { - "key": { - "description": "Key is the key of the entry in the object's `data` field to be used.", - "type": "string" - } - }, - "required": [ - "key" - ], - "type": "object", - "additionalProperties": false - } - }, - "type": "object", - "additionalProperties": false - }, - "configMap": { - "description": "ConfigMap is the target ConfigMap in Namespaces that all Bundle source data will be synced to.", - "properties": { - "key": { - "description": "Key is the key of the entry in the object's `data` field to be used.", - "type": "string" - } - }, - "required": [ - "key" - ], - "type": "object", - "additionalProperties": false - }, - "namespaceSelector": { - "description": "NamespaceSelector will, if set, only sync the target resource in Namespaces which match the selector.", - "properties": { - "matchLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "MatchLabels matches on the set of labels that must be present on a Namespace for the Bundle target to be synced there.", - "type": "object" - } - }, - "type": "object", - "additionalProperties": false - } - }, - "type": "object", - "additionalProperties": false } }, "type": "object",