diff --git a/Cargo.lock b/Cargo.lock index e9711f16..33b07210 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2115,6 +2115,7 @@ dependencies = [ "serde", "serde_derive", "serde_json", + "serde_yaml", "strum", "strum_macros", "sysinfo", @@ -2965,6 +2966,18 @@ dependencies = [ "serde", ] +[[package]] +name = "serde_yaml" +version = "0.8.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a4a521f2940385c165a24ee286aa8599633d162077a54bdcae2a6fd5a7bfa7a0" +dependencies = [ + "indexmap", + "ryu", + "serde", + "yaml-rust", +] + [[package]] name = "sha-1" version = "0.8.2" @@ -4211,6 +4224,15 @@ version = "0.8.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d2d7d3948613f75c98fd9328cfdcc45acc4d360655289d0a7d4ec931392200a3" +[[package]] +name = "yaml-rust" +version = "0.4.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56c1936c4cc7a1c9ab21a1ebb602eb942ba868cbd44a99cb7cdc5892335e1c85" +dependencies = [ + "linked-hash-map", +] + [[package]] name = "zeroize" version = "1.4.1" diff --git a/Cargo.toml b/Cargo.toml index 5ae0c0e7..d1272877 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -55,6 +55,8 @@ tera = "1.10.0" serde = "1.0.126" serde_json = "1.0.64" serde_derive = "1.0.126" +serde_yaml = "0.8.23" + # AWS deps tokio = { version = "1.10.0", features = ["full"] } rusoto_core = "0.47.0" diff --git a/lib/common/bootstrap/charts/cert-manager/Chart.yaml b/lib/common/bootstrap/charts/cert-manager/Chart.yaml index b91d8ee1..01c64ecf 100644 --- a/lib/common/bootstrap/charts/cert-manager/Chart.yaml +++ b/lib/common/bootstrap/charts/cert-manager/Chart.yaml @@ -1,5 +1,5 @@ apiVersion: v1 -appVersion: v1.1.1 +appVersion: v1.2.0 description: A Helm chart for cert-manager home: https://github.com/jetstack/cert-manager icon: https://raw.githubusercontent.com/jetstack/cert-manager/master/logo/logo.png @@ -14,4 +14,4 @@ maintainers: name: cert-manager sources: - https://github.com/jetstack/cert-manager -version: v1.1.1 +version: v1.2.0 diff --git a/lib/common/bootstrap/charts/cert-manager/README.md b/lib/common/bootstrap/charts/cert-manager/README.md index ec353bba..16e55a87 100644 --- a/lib/common/bootstrap/charts/cert-manager/README.md +++ b/lib/common/bootstrap/charts/cert-manager/README.md @@ -19,16 +19,9 @@ Before installing the chart, you must first install the cert-manager CustomResou This is performed in a separate step to allow you to easily uninstall and reinstall cert-manager without deleting your installed custom resources. ```bash -# Kubernetes 1.15+ -$ kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v1.1.1/cert-manager.crds.yaml - -# Kubernetes <1.15 -$ kubectl apply --validate=false -f https://github.com/jetstack/cert-manager/releases/download/v1.1.1/cert-manager-legacy.crds.yaml +$ kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.2.0/cert-manager.crds.yaml ``` -> **Note**: If you're using a Kubernetes version below `v1.15` you will need to install the legacy version of the custom resource definitions. -> This version does not have API version conversion enabled and only supports `cert-manager.io/v1` API resources. - To install the chart with the release name `my-release`: ```console @@ -72,11 +65,7 @@ If you want to completely uninstall cert-manager from your cluster, you will als delete the previously installed CustomResourceDefinition resources: ```console -# Kubernetes 1.15+ -$ kubectl delete -f https://github.com/jetstack/cert-manager/releases/download/v1.1.1/cert-manager.crds.yaml - -# Kubernetes <1.15 -$ kubectl delete -f https://github.com/jetstack/cert-manager/releases/download/v1.1.1/cert-manager-legacy.crds.yaml +$ kubectl delete -f https://github.com/jetstack/cert-manager/releases/download/v1.2.0/cert-manager.crds.yaml ``` ## Configuration @@ -91,9 +80,12 @@ The following table lists the configurable parameters of the cert-manager chart | `global.podSecurityPolicy.enabled` | If `true`, create and use PodSecurityPolicy (includes sub-charts) | `false` | | `global.podSecurityPolicy.useAppArmor` | If `true`, use Apparmor seccomp profile in PSP | `true` | | `global.leaderElection.namespace` | Override the namespace used to store the ConfigMap for leader election | `kube-system` | +| `global.leaderElection.leaseDuration` | The duration that non-leader candidates will wait after observing a leadership renewal until attempting to acquire leadership of a led but unrenewed leader slot. This is effectively the maximum duration that a leader can be stopped before it is replaced by another candidate | | +| `global.leaderElection.renewDeadline` | The interval between attempts by the acting master to renew a leadership slot before it stops leading. This must be less than or equal to the lease duration | | +| `global.leaderElection.retryPeriod` | The duration the clients should wait between attempting acquisition and renewal of a leadership | | | `installCRDs` | If true, CRD resources will be installed as part of the Helm chart. If enabled, when uninstalling CRD resources will be deleted causing all installed custom resources to be DELETED | `false` | | `image.repository` | Image repository | `quay.io/jetstack/cert-manager-controller` | -| `image.tag` | Image tag | `v1.1.1` | +| `image.tag` | Image tag | `v1.2.0` | | `image.pullPolicy` | Image pull policy | `IfNotPresent` | | `replicaCount` | Number of cert-manager replicas | `1` | | `clusterResourceNamespace` | Override the namespace used to store DNS provider credentials etc. for ClusterIssuer resources | Same namespace as cert-manager pod | @@ -148,7 +140,7 @@ The following table lists the configurable parameters of the cert-manager chart | `webhook.affinity` | Node affinity for webhook pod assignment | `{}` | | `webhook.tolerations` | Node tolerations for webhook pod assignment | `[]` | | `webhook.image.repository` | Webhook image repository | `quay.io/jetstack/cert-manager-webhook` | -| `webhook.image.tag` | Webhook image tag | `v1.1.1` | +| `webhook.image.tag` | Webhook image tag | `v1.2.0` | | `webhook.image.pullPolicy` | Webhook image pull policy | `IfNotPresent` | | `webhook.securePort` | The port that the webhook should listen on for requests. | `10250` | | `webhook.securityContext` | Security context for webhook pod assignment | `{}` | @@ -178,7 +170,7 @@ The following table lists the configurable parameters of the cert-manager chart | `cainjector.affinity` | Node affinity for cainjector pod assignment | `{}` | | `cainjector.tolerations` | Node tolerations for cainjector pod assignment | `[]` | | `cainjector.image.repository` | cainjector image repository | `quay.io/jetstack/cert-manager-cainjector` | -| `cainjector.image.tag` | cainjector image tag | `v1.1.1` | +| `cainjector.image.tag` | cainjector image tag | `v1.2.0` | | `cainjector.image.pullPolicy` | cainjector image pull policy | `IfNotPresent` | | `cainjector.securityContext` | Security context for cainjector pod assignment | `{}` | | `cainjector.containerSecurityContext` | Security context to be set on cainjector component container | `{}` | diff --git a/lib/common/bootstrap/charts/cert-manager/templates/cainjector-deployment.yaml b/lib/common/bootstrap/charts/cert-manager/templates/cainjector-deployment.yaml index 8ac6da01..8944fb4f 100644 --- a/lib/common/bootstrap/charts/cert-manager/templates/cainjector-deployment.yaml +++ b/lib/common/bootstrap/charts/cert-manager/templates/cainjector-deployment.yaml @@ -61,7 +61,18 @@ spec: {{- if .Values.global.logLevel }} - --v={{ .Values.global.logLevel }} {{- end }} - - --leader-election-namespace={{ .Values.global.leaderElection.namespace }} + {{- with .Values.global.leaderElection }} + - --leader-election-namespace={{ .namespace }} + {{- if .leaseDuration }} + - --leader-election-lease-duration={{ .leaseDuration }} + {{- end }} + {{- if .renewDeadline }} + - --leader-election-renew-deadline={{ .renewDeadline }} + {{- end }} + {{- if .retryPeriod }} + - --leader-election-retry-period={{ .retryPeriod }} + {{- end }} + {{- end }} {{- if .Values.cainjector.extraArgs }} {{ toYaml .Values.cainjector.extraArgs | indent 10 }} {{- end }} diff --git a/lib/common/bootstrap/charts/cert-manager/templates/crds.legacy.yaml b/lib/common/bootstrap/charts/cert-manager/templates/crds.legacy.yaml deleted file mode 100644 index 4026fcee..00000000 --- a/lib/common/bootstrap/charts/cert-manager/templates/crds.legacy.yaml +++ /dev/null @@ -1,6257 +0,0 @@ -{{- if (semverCompare "<1.16-0" .Capabilities.KubeVersion.GitVersion) }} -{{- if .Values.installCRDs }} -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - annotations: - cert-manager.io/inject-ca-from-secret: '{{ template "webhook.caRef" . }}' - labels: - app: '{{ template "cert-manager.name" . }}' - app.kubernetes.io/instance: '{{ .Release.Name }}' - app.kubernetes.io/managed-by: '{{ .Release.Service }}' - app.kubernetes.io/name: '{{ template "cert-manager.name" . }}' - helm.sh/chart: '{{ template "cert-manager.chart" . }}' - name: certificaterequests.cert-manager.io -spec: - additionalPrinterColumns: - - JSONPath: .status.conditions[?(@.type=="Ready")].status - name: Ready - type: string - - JSONPath: .spec.issuerRef.name - name: Issuer - priority: 1 - type: string - - JSONPath: .status.conditions[?(@.type=="Ready")].message - name: Status - priority: 1 - type: string - - JSONPath: .metadata.creationTimestamp - description: CreationTimestamp is a timestamp representing the server time when - this object was created. It is not guaranteed to be set in happens-before order - across separate operations. Clients may not set this value. It is represented - in RFC3339 form and is in UTC. - name: Age - type: date - group: cert-manager.io - names: - kind: CertificateRequest - listKind: CertificateRequestList - plural: certificaterequests - shortNames: - - cr - - crs - singular: certificaterequest - scope: Namespaced - subresources: - status: {} - validation: - openAPIV3Schema: - 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." - properties: - apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' - type: string - kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - metadata: - type: object - spec: - description: Desired state of the CertificateRequest resource. - properties: - duration: - description: The requested 'duration' (i.e. lifetime) of the Certificate. - This option may be ignored/overridden by some issuer types. - type: string - 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`. - 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. - 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 - required: - - name - type: object - request: - description: The PEM-encoded x509 certificate signing request to be - submitted to the CA for signing. - format: byte - 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. - 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"' - enum: - - 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 - type: string - type: array - required: - - issuerRef - - request - type: object - status: - description: Status of the CertificateRequest. This is set and managed automatically. - 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. - 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. - format: byte - type: string - conditions: - description: List of status conditions to indicate the status of a CertificateRequest. - Known condition types are `Ready` and `InvalidRequest`. - items: - description: CertificateRequestCondition contains condition information - for a CertificateRequest. - properties: - lastTransitionTime: - description: LastTransitionTime is the timestamp corresponding - to the last status change 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. - type: string - reason: - description: Reason is a brief machine readable explanation for - the condition's last transition. - type: string - status: - 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 ('Ready', - 'InvalidRequest'). - type: string - required: - - status - - type - type: object - type: array - failureTime: - description: FailureTime stores the time that this CertificateRequest - failed. This is used to influence garbage collection and back-off. - format: date-time - type: string - type: object - required: - - spec - version: v1 - versions: - - name: v1 - served: true - storage: true -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - annotations: - cert-manager.io/inject-ca-from-secret: '{{ template "webhook.caRef" . }}' - labels: - app: '{{ template "cert-manager.name" . }}' - app.kubernetes.io/instance: '{{ .Release.Name }}' - app.kubernetes.io/managed-by: '{{ .Release.Service }}' - app.kubernetes.io/name: '{{ template "cert-manager.name" . }}' - helm.sh/chart: '{{ template "cert-manager.chart" . }}' - name: certificates.cert-manager.io -spec: - additionalPrinterColumns: - - JSONPath: .status.conditions[?(@.type=="Ready")].status - name: Ready - type: string - - JSONPath: .spec.secretName - name: Secret - type: string - - JSONPath: .spec.issuerRef.name - name: Issuer - priority: 1 - type: string - - JSONPath: .status.conditions[?(@.type=="Ready")].message - name: Status - priority: 1 - type: string - - JSONPath: .metadata.creationTimestamp - description: CreationTimestamp is a timestamp representing the server time when - this object was created. It is not guaranteed to be set in happens-before order - across separate operations. Clients may not set this value. It is represented - in RFC3339 form and is in UTC. - name: Age - type: date - group: cert-manager.io - names: - kind: Certificate - listKind: CertificateList - plural: certificates - shortNames: - - cert - - certs - singular: certificate - scope: Namespaced - subresources: - status: {} - validation: - openAPIV3Schema: - 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`)." - properties: - apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' - type: string - kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - metadata: - type: object - spec: - description: Desired state of the Certificate resource. - properties: - 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' - type: string - dnsNames: - description: DNSNames is a list of DNS subjectAltNames to be set on - the Certificate. - 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 overridden - and `renewBefore` is greater than the actual certificate duration, - the certificate will be automatically renewed 2/3rds of the way through - the certificate's duration. - type: string - emailAddresses: - description: EmailAddresses is a list of email subjectAltNames to be - set on the Certificate. - items: - type: string - type: array - encodeUsagesInRequest: - description: EncodeUsagesInRequest controls whether key usages should - be present in the CertificateRequest - type: boolean - ipAddresses: - description: IPAddresses is a list of IP address subjectAltNames to - be set on the Certificate. - 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`. - 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. - 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 - required: - - name - type: object - keystores: - description: Keystores configures additional keystore output formats - stored in the `secretName` Secret resource. - 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. - type: boolean - passwordSecretRef: - description: PasswordSecretRef is a reference to a key in a - Secret resource containing the password used to encrypt the - JKS keystore. - 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 - required: - - create - - passwordSecretRef - type: object - pkcs12: - 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. - type: boolean - passwordSecretRef: - description: PasswordSecretRef is a reference to a key in a - Secret resource containing the password used to encrypt the - PKCS12 keystore. - 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 - required: - - create - - passwordSecretRef - type: object - type: object - privateKey: - description: Options to control private keys used for the Certificate. - properties: - algorithm: - description: Algorithm is the private key algorithm of the corresponding - private key for this certificate. If provided, allowed values - are either "rsa" 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. - enum: - - RSA - - ECDSA - 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 PKCS#1 if not specified. - enum: - - PKCS1 - - PKCS8 - 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. - 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. - No other values are allowed. - type: integer - type: object - renewBefore: - description: The amount of time before the currently issued certificate's - `notAfter` time that cert-manager will begin to attempt to renew the - certificate. If this value is greater than the total duration of the - certificate (i.e. notAfter - notBefore), it will be automatically - renewed 2/3rds of the way through the certificate's duration. - type: string - 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. - type: string - subject: - description: Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name). - properties: - countries: - description: Countries to be used on the Certificate. - items: - type: string - type: array - localities: - description: Cities to be used on the Certificate. - items: - type: string - type: array - organizationalUnits: - description: Organizational Units to be used on the Certificate. - items: - type: string - type: array - organizations: - description: Organizations to be used on the Certificate. - items: - type: string - type: array - postalCodes: - description: Postal codes to be used on the Certificate. - items: - type: string - type: array - provinces: - description: State/Provinces to be used on the Certificate. - items: - type: string - type: array - serialNumber: - description: Serial number to be used on the Certificate. - type: string - streetAddresses: - description: Street addresses to be used on the Certificate. - items: - type: string - type: array - type: object - uris: - description: URIs is a list of URI subjectAltNames to be set on the - Certificate. - 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. - 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"' - enum: - - 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 - type: string - type: array - required: - - issuerRef - - secretName - type: object - status: - description: Status of the Certificate. This is set and managed automatically. - properties: - conditions: - description: List of status conditions to indicate the status of certificates. - Known condition types are `Ready` and `Issuing`. - items: - description: CertificateCondition contains condition information for - an Certificate. - properties: - lastTransitionTime: - description: LastTransitionTime is the timestamp corresponding - to the last status change 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. - type: string - reason: - description: Reason is a brief machine readable explanation for - the condition's last transition. - type: string - status: - 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 ('Ready', - `Issuing`). - type: string - required: - - status - - type - type: object - type: array - 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. - format: date-time - type: string - nextPrivateKeySecretName: - description: The name of the Secret resource containing the private - key to be used for the next certificate iteration. The keymanager - controller will automatically set this field if the `Issuing` condition - is set to `True`. It will automatically unset this field when the - Issuing condition is not set or False. - type: string - notAfter: - description: The expiration time of the certificate stored in the secret - named by this resource in `spec.secretName`. - format: date-time - type: string - notBefore: - 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 - renewalTime: - description: RenewalTime is the time at which the certificate will be - next renewed. If not set, no upcoming renewal is scheduled. - format: date-time - type: string - revision: - description: "The current 'revision' of the certificate as issued. \n - When a CertificateRequest resource is created, it will have the `cert-manager.io/certificate-revision` - set to one greater than the current value of this field. \n Upon issuance, - this field will be set to the value of the annotation on the CertificateRequest - resource used to issue the certificate. \n Persisting the value on - the CertificateRequest resource allows the certificates controller - to know whether a request is part of an old issuance or if it is part - of the ongoing revision's issuance by checking if the revision value - in the annotation is greater than this field." - type: integer - type: object - required: - - spec - version: v1 - versions: - - name: v1 - served: true - storage: true -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - annotations: - cert-manager.io/inject-ca-from-secret: '{{ template "webhook.caRef" . }}' - labels: - app: '{{ template "cert-manager.name" . }}' - app.kubernetes.io/instance: '{{ .Release.Name }}' - app.kubernetes.io/managed-by: '{{ .Release.Service }}' - app.kubernetes.io/name: '{{ template "cert-manager.name" . }}' - helm.sh/chart: '{{ template "cert-manager.chart" . }}' - name: challenges.acme.cert-manager.io -spec: - additionalPrinterColumns: - - JSONPath: .status.state - name: State - type: string - - JSONPath: .spec.dnsName - name: Domain - type: string - - JSONPath: .status.reason - name: Reason - priority: 1 - type: string - - JSONPath: .metadata.creationTimestamp - description: CreationTimestamp is a timestamp representing the server time when - this object was created. It is not guaranteed to be set in happens-before order - across separate operations. Clients may not set this value. It is represented - in RFC3339 form and is in UTC. - name: Age - type: date - group: acme.cert-manager.io - names: - kind: Challenge - listKind: ChallengeList - plural: challenges - singular: challenge - scope: Namespaced - subresources: - status: {} - validation: - openAPIV3Schema: - description: Challenge is a type to represent a Challenge request with an ACME - server - 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: - 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. - 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 - required: - - name - type: object - 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. - properties: - dns01: - description: Configures cert-manager to attempt to complete authorizations - by performing the DNS01 challenge flow. - properties: - acmeDNS: - description: Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) - API to manage DNS01 challenge records. - properties: - accountSecretRef: - description: A reference to a specific 'key' within a Secret - resource. In some instances, `key` is a required field. - 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 - host: - type: string - required: - - accountSecretRef - - host - type: object - akamai: - description: Use the Akamai DNS zone management API to manage - DNS01 challenge records. - properties: - accessTokenSecretRef: - description: A reference to a specific 'key' within a Secret - resource. In some instances, `key` is a required field. - 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 - clientSecretSecretRef: - description: A reference to a specific 'key' within a Secret - resource. In some instances, `key` is a required field. - 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 - clientTokenSecretRef: - description: A reference to a specific 'key' within a Secret - resource. In some instances, `key` is a required field. - 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 - serviceConsumerDomain: - type: string - required: - - accessTokenSecretRef - - clientSecretSecretRef - - clientTokenSecretRef - - serviceConsumerDomain - type: object - 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 - type: string - clientSecretSecretRef: - description: if both this and ClientID are left unset MSI - will be used - 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 - environment: - enum: - - AzurePublicCloud - - AzureChinaCloud - - AzureGermanCloud - - AzureUSGovernmentCloud - type: string - hostedZoneName: - type: string - resourceGroupName: - type: string - subscriptionID: - type: string - tenantID: - description: when specifying ClientID and ClientSecret then - this field is also needed - type: string - required: - - resourceGroupName - - subscriptionID - type: object - cloudDNS: - description: Use the Google Cloud DNS API to manage DNS01 challenge - records. - 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. - 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 - required: - - project - type: object - cloudflare: - description: Use the Cloudflare API to manage DNS01 challenge - records. - 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.' - 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 - apiTokenSecretRef: - description: API token used to authenticate with Cloudflare. - 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 - email: - description: Email of the account, only required when using - API key based authentication. - type: string - type: object - cnameStrategy: - description: CNAMEStrategy configures how the DNS01 provider - should handle CNAME records when found in DNS zones. - enum: - - None - - Follow - type: string - digitalocean: - description: Use the DigitalOcean DNS API to manage DNS01 challenge - records. - properties: - tokenSecretRef: - description: A reference to a specific 'key' within a Secret - resource. In some instances, `key` is a required field. - 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 - required: - - tokenSecretRef - type: object - 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. - 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. - 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 - required: - - nameserver - type: object - route53: - 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' - type: string - 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 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 - 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 - required: - - region - type: object - webhook: - description: Configure an external webhook based DNS01 challenge - solver to manage DNS01 challenge records. - 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. - 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 - required: - - groupName - - solverName - type: object - type: object - 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. - properties: - 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. - type: string - ingressTemplate: - description: Optional ingress template used to configure - the ACME challenge solver ingress used for HTTP01 challenges - 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. - properties: - annotations: - additionalProperties: - type: string - description: Annotations that should be added to - the created ACME HTTP01 solver ingress. - type: object - labels: - additionalProperties: - type: string - description: Labels that should be added to the - created ACME HTTP01 solver ingress. - type: object - type: object - type: object - 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 - 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. - properties: - annotations: - additionalProperties: - type: string - description: Annotations that should be added to - the create ACME HTTP01 solver pods. - type: object - labels: - additionalProperties: - type: string - description: Labels that should be added to the - created ACME HTTP01 solver pods. - type: object - type: object - 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. - properties: - affinity: - description: If specified, the pod's scheduling - constraints - properties: - nodeAffinity: - description: Describes node affinity scheduling - rules for the pod. - 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. - 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). - properties: - preference: - description: A node selector term, - associated with the corresponding - weight. - properties: - matchExpressions: - description: A list of node selector - requirements by node's labels. - items: - description: A node selector - requirement is a selector - that contains values, a key, - and an operator that relates - the key and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchFields: - description: A list of node selector - requirements by node's fields. - items: - description: A node selector - requirement is a selector - that contains values, a key, - and an operator that relates - the key and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - type: object - weight: - description: Weight associated with - matching the corresponding nodeSelectorTerm, - in the range 1-100. - format: int32 - type: integer - required: - - preference - - weight - type: object - 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. - properties: - nodeSelectorTerms: - description: Required. A list of node - selector terms. The terms are ORed. - 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. - properties: - matchExpressions: - description: A list of node selector - requirements by node's labels. - items: - description: A node selector - requirement is a selector - that contains values, a key, - and an operator that relates - the key and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchFields: - description: A list of node selector - requirements by node's fields. - items: - description: A node selector - requirement is a selector - that contains values, a key, - and an operator that relates - the key and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - type: object - type: array - required: - - nodeSelectorTerms - type: object - type: object - podAffinity: - description: Describes pod affinity scheduling - rules (e.g. co-locate this pod in the same - node, zone, etc. as some other pod(s)). - 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. - items: - description: The weights of all of the - matched WeightedPodAffinityTerm fields - are added per-node to find the most - preferred node(s) - properties: - podAffinityTerm: - 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. - 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 relates the key and - values. - properties: - key: - description: key is - the label key that - the selector applies - to. - type: string - operator: - description: operator - represents a key's - relationship to a - set of values. Valid - operators are In, - NotIn, Exists and - DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels is - a map of {key,value} pairs. - A single {key,value} in - the matchLabels map is equivalent - to an element of matchExpressions, - whose key field is "key", - the operator is "In", and - the values array contains - only "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces specifies - which namespaces the labelSelector - applies to (matches against); - null or empty list means "this - pod's namespace" - 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 - weight: - description: weight associated with - matching the corresponding podAffinityTerm, - in the range 1-100. - format: int32 - type: integer - required: - - podAffinityTerm - - weight - type: object - 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 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. - 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 relates - the key and values. - properties: - key: - description: key is the - label key that the selector - applies to. - type: string - operator: - description: operator represents - a key's relationship to - a set of values. Valid - operators are In, NotIn, - Exists and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels is a - map of {key,value} pairs. A - single {key,value} in the matchLabels - map is equivalent to an element - of matchExpressions, whose key - field is "key", the operator - is "In", and the values array - contains only "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces specifies - which namespaces the labelSelector - applies to (matches against); null - or empty list means "this pod's - namespace" - 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 - type: array - type: object - 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)). - 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. - items: - description: The weights of all of the - matched WeightedPodAffinityTerm fields - are added per-node to find the most - preferred node(s) - properties: - podAffinityTerm: - 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. - 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 relates the key and - values. - properties: - key: - description: key is - the label key that - the selector applies - to. - type: string - operator: - description: operator - represents a key's - relationship to a - set of values. Valid - operators are In, - NotIn, Exists and - DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels is - a map of {key,value} pairs. - A single {key,value} in - the matchLabels map is equivalent - to an element of matchExpressions, - whose key field is "key", - the operator is "In", and - the values array contains - only "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces specifies - which namespaces the labelSelector - applies to (matches against); - null or empty list means "this - pod's namespace" - 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 - weight: - description: weight associated with - matching the corresponding podAffinityTerm, - in the range 1-100. - format: int32 - type: integer - required: - - podAffinityTerm - - weight - type: object - 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 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. - 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 relates - the key and values. - properties: - key: - description: key is the - label key that the selector - applies to. - type: string - operator: - description: operator represents - a key's relationship to - a set of values. Valid - operators are In, NotIn, - Exists and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels is a - map of {key,value} pairs. A - single {key,value} in the matchLabels - map is equivalent to an element - of matchExpressions, whose key - field is "key", the operator - is "In", and the values array - contains only "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces specifies - which namespaces the labelSelector - applies to (matches against); null - or empty list means "this pod's - namespace" - 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 - type: array - type: object - type: object - nodeSelector: - 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. - type: string - serviceAccountName: - description: If specified, the pod's service account - type: string - tolerations: - description: If specified, the pod's tolerations. - items: - 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. - 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. - 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 - type: array - type: object - type: object - serviceType: - description: Optional service type for Kubernetes solver - service - type: string - type: object - type: object - 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. - 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. - 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. - items: - type: string - type: array - matchLabels: - 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 - type: object - 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". - enum: - - HTTP-01 - - DNS-01 - type: string - 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 - required: - - authorizationURL - - dnsName - - issuerRef - - key - - solver - - token - - type - - url - type: object - status: - 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. - enum: - - valid - - ready - - pending - - processing - - invalid - - expired - - errored - type: string - type: object - required: - - metadata - - spec - version: v1 - versions: - - name: v1 - served: true - storage: true -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - annotations: - cert-manager.io/inject-ca-from-secret: '{{ template "webhook.caRef" . }}' - labels: - app: '{{ template "cert-manager.name" . }}' - app.kubernetes.io/instance: '{{ .Release.Name }}' - app.kubernetes.io/managed-by: '{{ .Release.Service }}' - app.kubernetes.io/name: '{{ template "cert-manager.name" . }}' - helm.sh/chart: '{{ template "cert-manager.chart" . }}' - name: clusterissuers.cert-manager.io -spec: - additionalPrinterColumns: - - JSONPath: .status.conditions[?(@.type=="Ready")].status - name: Ready - type: string - - JSONPath: .status.conditions[?(@.type=="Ready")].message - name: Status - priority: 1 - type: string - - JSONPath: .metadata.creationTimestamp - description: CreationTimestamp is a timestamp representing the server time when - this object was created. It is not guaranteed to be set in happens-before order - across separate operations. Clients may not set this value. It is represented - in RFC3339 form and is in UTC. - name: Age - type: date - group: cert-manager.io - names: - kind: ClusterIssuer - listKind: ClusterIssuerList - plural: clusterissuers - singular: clusterissuer - scope: Cluster - subresources: - status: {} - validation: - openAPIV3Schema: - description: A ClusterIssuer represents a certificate issuing authority which - can be referenced as part of `issuerRef` fields. It is similar to an Issuer, - however it is cluster-scoped and therefore can be referenced by resources - that exist in *any* namespace, not just the same namespace as the referent. - properties: - apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' - type: string - kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - metadata: - type: object - spec: - description: Desired state of the ClusterIssuer resource. - properties: - acme: - description: ACME configures this issuer to communicate with a RFC8555 - (ACME) server to obtain signed x509 certificates. - properties: - 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 - email: - description: Email is the email address to be associated with the - ACME account. This field is optional, but it is strongly recommended - to be set. It will be used to contact you in case of issues with - your account or certificates, including expiry notification emails. - This field may be updated after the account is initially registered. - type: string - enableDurationFeature: - description: Enables requesting a Not After date on certificates - that matches the duration of the certificate. This is not supported - by all ACME servers like Let's Encrypt. If set to true when the - ACME server does not support it it will create an error on the - Order. Defaults to false. - type: boolean - 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. - properties: - keyAlgorithm: - description: keyAlgorithm is the MAC key algorithm that the - key is used for. Valid values are "HS256", "HS384" and "HS512". - enum: - - HS256 - - HS384 - - HS512 - type: string - keyID: - description: keyID is the ID of the CA key that the External - Account is bound to. - type: string - 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. - 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 - required: - - keyAlgorithm - - keyID - - keySecretRef - type: object - 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' - 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. - 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 - 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. - type: boolean - 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/' - items: - description: Configures an issuer to solve challenges using the - specified options. Only one of HTTP01 or DNS01 may be provided. - properties: - dns01: - description: Configures cert-manager to attempt to complete - authorizations by performing the DNS01 challenge flow. - properties: - acmeDNS: - description: Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) - API to manage DNS01 challenge records. - properties: - accountSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - host: - type: string - required: - - accountSecretRef - - host - type: object - akamai: - description: Use the Akamai DNS zone management API to - manage DNS01 challenge records. - properties: - accessTokenSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - clientSecretSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - clientTokenSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - serviceConsumerDomain: - type: string - required: - - accessTokenSecretRef - - clientSecretSecretRef - - clientTokenSecretRef - - serviceConsumerDomain - type: object - 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 - type: string - clientSecretSecretRef: - description: if both this and ClientID are left unset - MSI will be used - 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 - environment: - enum: - - AzurePublicCloud - - AzureChinaCloud - - AzureGermanCloud - - AzureUSGovernmentCloud - type: string - hostedZoneName: - type: string - resourceGroupName: - type: string - subscriptionID: - type: string - tenantID: - description: when specifying ClientID and ClientSecret - then this field is also needed - type: string - required: - - resourceGroupName - - subscriptionID - type: object - cloudDNS: - description: Use the Google Cloud DNS API to manage DNS01 - challenge records. - 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. - 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 - required: - - project - type: object - cloudflare: - description: Use the Cloudflare API to manage DNS01 challenge - records. - 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.' - 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 - apiTokenSecretRef: - description: API token used to authenticate with Cloudflare. - 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 - email: - description: Email of the account, only required when - using API key based authentication. - type: string - type: object - cnameStrategy: - description: CNAMEStrategy configures how the DNS01 provider - should handle CNAME records when found in DNS zones. - enum: - - None - - Follow - type: string - digitalocean: - description: Use the DigitalOcean DNS API to manage DNS01 - challenge records. - properties: - tokenSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - required: - - tokenSecretRef - type: object - 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. - 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. - 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 - required: - - nameserver - type: object - route53: - 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' - type: string - 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 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 - 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 - required: - - region - type: object - webhook: - description: Configure an external webhook based DNS01 - challenge solver to manage DNS01 challenge records. - 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. - 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 - required: - - groupName - - solverName - type: object - type: object - 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. - properties: - 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. - type: string - ingressTemplate: - description: Optional ingress template used to configure - the ACME challenge solver ingress used for HTTP01 - challenges - 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. - properties: - annotations: - additionalProperties: - type: string - description: Annotations that should be added - to the created ACME HTTP01 solver ingress. - type: object - labels: - additionalProperties: - type: string - description: Labels that should be added to - the created ACME HTTP01 solver ingress. - type: object - type: object - type: object - 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 - 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. - properties: - annotations: - additionalProperties: - type: string - description: Annotations that should be added - to the create ACME HTTP01 solver pods. - type: object - labels: - additionalProperties: - type: string - description: Labels that should be added to - the created ACME HTTP01 solver pods. - type: object - type: object - 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. - properties: - affinity: - description: If specified, the pod's scheduling - constraints - properties: - nodeAffinity: - description: Describes node affinity scheduling - rules for the pod. - 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. - 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). - properties: - preference: - description: A node selector - term, associated with the - corresponding weight. - properties: - matchExpressions: - description: A list of node - selector requirements - by node's labels. - items: - description: A node selector - requirement is a selector - that contains values, - a key, and an operator - that relates the key - and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchFields: - description: A list of node - selector requirements - by node's fields. - items: - description: A node selector - requirement is a selector - that contains values, - a key, and an operator - that relates the key - and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - type: object - weight: - description: Weight associated - with matching the corresponding - nodeSelectorTerm, in the range - 1-100. - format: int32 - type: integer - required: - - preference - - weight - type: object - 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. - properties: - nodeSelectorTerms: - description: Required. A list - of node selector terms. The - terms are ORed. - 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. - properties: - matchExpressions: - description: A list of node - selector requirements - by node's labels. - items: - description: A node selector - requirement is a selector - that contains values, - a key, and an operator - that relates the key - and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchFields: - description: A list of node - selector requirements - by node's fields. - items: - description: A node selector - requirement is a selector - that contains values, - a key, and an operator - that relates the key - and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - type: object - type: array - required: - - nodeSelectorTerms - type: object - type: object - podAffinity: - description: Describes pod affinity scheduling - rules (e.g. co-locate this pod in the - same node, zone, etc. as some other - pod(s)). - 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. - items: - description: The weights of all - of the matched WeightedPodAffinityTerm - fields are added per-node to find - the most preferred node(s) - properties: - podAffinityTerm: - 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. - 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 relates the - key and values. - properties: - key: - description: key - is the label - key that the - selector applies - to. - type: string - operator: - description: operator - represents a - key's relationship - to a set of - values. Valid - operators are - In, NotIn, Exists - and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels - is a map of {key,value} - pairs. A single {key,value} - in the matchLabels - map is equivalent - to an element of matchExpressions, - whose key field is - "key", the operator - is "In", and the values - array contains only - "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces - specifies which namespaces - the labelSelector applies - to (matches against); - null or empty list means - "this pod's namespace" - 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 - weight: - description: weight associated - with matching the corresponding - podAffinityTerm, in the range - 1-100. - format: int32 - type: integer - required: - - podAffinityTerm - - weight - type: object - 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 - 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. - 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 relates the key - and values. - properties: - key: - description: key is - the label key that - the selector applies - to. - type: string - operator: - description: operator - represents a key's - relationship to - a set of values. - Valid operators - are In, NotIn, Exists - and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels - is a map of {key,value} - pairs. A single {key,value} - in the matchLabels map - is equivalent to an element - of matchExpressions, whose - key field is "key", the - operator is "In", and - the values array contains - only "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces specifies - which namespaces the labelSelector - applies to (matches against); - null or empty list means "this - pod's namespace" - 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 - type: array - type: object - 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)). - 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. - items: - description: The weights of all - of the matched WeightedPodAffinityTerm - fields are added per-node to find - the most preferred node(s) - properties: - podAffinityTerm: - 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. - 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 relates the - key and values. - properties: - key: - description: key - is the label - key that the - selector applies - to. - type: string - operator: - description: operator - represents a - key's relationship - to a set of - values. Valid - operators are - In, NotIn, Exists - and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels - is a map of {key,value} - pairs. A single {key,value} - in the matchLabels - map is equivalent - to an element of matchExpressions, - whose key field is - "key", the operator - is "In", and the values - array contains only - "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces - specifies which namespaces - the labelSelector applies - to (matches against); - null or empty list means - "this pod's namespace" - 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 - weight: - description: weight associated - with matching the corresponding - podAffinityTerm, in the range - 1-100. - format: int32 - type: integer - required: - - podAffinityTerm - - weight - type: object - 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 - 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. - 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 relates the key - and values. - properties: - key: - description: key is - the label key that - the selector applies - to. - type: string - operator: - description: operator - represents a key's - relationship to - a set of values. - Valid operators - are In, NotIn, Exists - and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels - is a map of {key,value} - pairs. A single {key,value} - in the matchLabels map - is equivalent to an element - of matchExpressions, whose - key field is "key", the - operator is "In", and - the values array contains - only "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces specifies - which namespaces the labelSelector - applies to (matches against); - null or empty list means "this - pod's namespace" - 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 - type: array - type: object - type: object - nodeSelector: - 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. - type: string - serviceAccountName: - description: If specified, the pod's service - account - type: string - tolerations: - description: If specified, the pod's tolerations. - items: - 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. - 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. - 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 - type: array - type: object - type: object - serviceType: - description: Optional service type for Kubernetes - solver service - type: string - type: object - type: object - 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. - 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. - 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. - items: - type: string - type: array - matchLabels: - 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 - type: object - type: array - required: - - privateKeySecretRef - - server - type: object - 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. - 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. - 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 - selfSigned: - description: SelfSigned configures this issuer to 'self sign' certificates - using the private key used to create the CertificateRequest 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. - items: - type: string - type: array - type: object - vault: - description: Vault configures this issuer to sign certificates using - a HashiCorp Vault PKI backend. - properties: - auth: - description: Auth configures how cert-manager authenticates with - the Vault server. - properties: - appRole: - description: AppRole authenticates with Vault using the App - Role auth mechanism, with the role and secret stored in a - Kubernetes Secret resource. - properties: - path: - description: 'Path where the App Role authentication backend - is mounted in Vault, e.g: "approle"' - type: string - roleId: - description: RoleID configured in the App Role authentication - backend when setting up the authentication backend in - Vault. - type: string - 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. - 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 - required: - - path - - roleId - - secretRef - type: object - kubernetes: - description: Kubernetes authenticates with Vault by passing - the ServiceAccount token stored in the named Secret resource - to the Vault server. - 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. - type: string - role: - description: A required field containing the Vault Role - to assume. A Role binds a Kubernetes ServiceAccount with - a set of Vault policies. - type: string - secretRef: - description: The required Secret field containing a Kubernetes - ServiceAccount JWT used for authenticating with Vault. - Use of 'ambient credentials' is not supported. - 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 - required: - - role - - secretRef - type: object - tokenSecretRef: - description: TokenSecretRef authenticates with Vault by presenting - a token. - 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 - type: object - caBundle: - description: PEM encoded CA bundle 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. - format: byte - type: string - 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' - type: string - path: - description: 'Path is the mount path of the Vault PKI backend''s - `sign` endpoint, e.g: "my_pki_mount/sign/my-role-name".' - type: string - server: - description: 'Server is the connection address for the Vault server, - e.g: "https://vault.example.com:8200".' - type: string - required: - - auth - - path - - server - type: object - venafi: - description: Venafi configures this issuer to sign certificates using - a Venafi TPP or Venafi Cloud policy zone. - properties: - cloud: - description: Cloud specifies the Venafi cloud configuration settings. - Only one of TPP or Cloud may be specified. - properties: - apiTokenSecretRef: - description: APITokenSecretRef is a secret key selector for - the Venafi Cloud API token. - 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 - url: - description: URL is the base URL for Venafi Cloud. Defaults - to "https://api.venafi.cloud/v1". - type: string - required: - - apiTokenSecretRef - type: object - 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. - 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'. - 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 - url: - description: 'URL is the base URL for the vedsdk endpoint of - the Venafi TPP instance, for example: "https://tpp.example.com/vedsdk".' - type: string - required: - - credentialsRef - - url - type: object - 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. - type: string - required: - - zone - type: object - type: object - status: - description: Status of the ClusterIssuer. This is set and managed automatically. - 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. - properties: - 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 - uri: - description: URI is the unique account identifier, which can also - be used to retrieve account details from the CA - type: string - type: object - conditions: - description: List of status conditions to indicate the status of a CertificateRequest. - Known condition types are `Ready`. - items: - description: IssuerCondition contains condition information for an - Issuer. - properties: - lastTransitionTime: - description: LastTransitionTime is the timestamp corresponding - to the last status change 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. - type: string - reason: - description: Reason is a brief machine readable explanation for - the condition's last transition. - type: string - status: - 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 ('Ready'). - type: string - required: - - status - - type - type: object - type: array - type: object - required: - - spec - version: v1 - versions: - - name: v1 - served: true - storage: true -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - annotations: - cert-manager.io/inject-ca-from-secret: '{{ template "webhook.caRef" . }}' - labels: - app: '{{ template "cert-manager.name" . }}' - app.kubernetes.io/instance: '{{ .Release.Name }}' - app.kubernetes.io/managed-by: '{{ .Release.Service }}' - app.kubernetes.io/name: '{{ template "cert-manager.name" . }}' - helm.sh/chart: '{{ template "cert-manager.chart" . }}' - name: issuers.cert-manager.io -spec: - additionalPrinterColumns: - - JSONPath: .status.conditions[?(@.type=="Ready")].status - name: Ready - type: string - - JSONPath: .status.conditions[?(@.type=="Ready")].message - name: Status - priority: 1 - type: string - - JSONPath: .metadata.creationTimestamp - description: CreationTimestamp is a timestamp representing the server time when - this object was created. It is not guaranteed to be set in happens-before order - across separate operations. Clients may not set this value. It is represented - in RFC3339 form and is in UTC. - name: Age - type: date - group: cert-manager.io - names: - kind: Issuer - listKind: IssuerList - plural: issuers - singular: issuer - scope: Namespaced - subresources: - status: {} - validation: - openAPIV3Schema: - 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. - properties: - apiVersion: - description: 'APIVersion defines the versioned schema of this representation - of an object. Servers should convert recognized schemas to the latest - internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' - type: string - kind: - description: 'Kind is a string value representing the REST resource this - object represents. Servers may infer this from the endpoint the client - submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - metadata: - type: object - spec: - description: Desired state of the Issuer resource. - properties: - acme: - description: ACME configures this issuer to communicate with a RFC8555 - (ACME) server to obtain signed x509 certificates. - properties: - 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 - email: - description: Email is the email address to be associated with the - ACME account. This field is optional, but it is strongly recommended - to be set. It will be used to contact you in case of issues with - your account or certificates, including expiry notification emails. - This field may be updated after the account is initially registered. - type: string - enableDurationFeature: - description: Enables requesting a Not After date on certificates - that matches the duration of the certificate. This is not supported - by all ACME servers like Let's Encrypt. If set to true when the - ACME server does not support it it will create an error on the - Order. Defaults to false. - type: boolean - 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. - properties: - keyAlgorithm: - description: keyAlgorithm is the MAC key algorithm that the - key is used for. Valid values are "HS256", "HS384" and "HS512". - enum: - - HS256 - - HS384 - - HS512 - type: string - keyID: - description: keyID is the ID of the CA key that the External - Account is bound to. - type: string - 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. - 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 - required: - - keyAlgorithm - - keyID - - keySecretRef - type: object - 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' - 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. - 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 - 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. - type: boolean - 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/' - items: - description: Configures an issuer to solve challenges using the - specified options. Only one of HTTP01 or DNS01 may be provided. - properties: - dns01: - description: Configures cert-manager to attempt to complete - authorizations by performing the DNS01 challenge flow. - properties: - acmeDNS: - description: Use the 'ACME DNS' (https://github.com/joohoi/acme-dns) - API to manage DNS01 challenge records. - properties: - accountSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - host: - type: string - required: - - accountSecretRef - - host - type: object - akamai: - description: Use the Akamai DNS zone management API to - manage DNS01 challenge records. - properties: - accessTokenSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - clientSecretSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - clientTokenSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - serviceConsumerDomain: - type: string - required: - - accessTokenSecretRef - - clientSecretSecretRef - - clientTokenSecretRef - - serviceConsumerDomain - type: object - 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 - type: string - clientSecretSecretRef: - description: if both this and ClientID are left unset - MSI will be used - 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 - environment: - enum: - - AzurePublicCloud - - AzureChinaCloud - - AzureGermanCloud - - AzureUSGovernmentCloud - type: string - hostedZoneName: - type: string - resourceGroupName: - type: string - subscriptionID: - type: string - tenantID: - description: when specifying ClientID and ClientSecret - then this field is also needed - type: string - required: - - resourceGroupName - - subscriptionID - type: object - cloudDNS: - description: Use the Google Cloud DNS API to manage DNS01 - challenge records. - 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. - 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 - required: - - project - type: object - cloudflare: - description: Use the Cloudflare API to manage DNS01 challenge - records. - 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.' - 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 - apiTokenSecretRef: - description: API token used to authenticate with Cloudflare. - 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 - email: - description: Email of the account, only required when - using API key based authentication. - type: string - type: object - cnameStrategy: - description: CNAMEStrategy configures how the DNS01 provider - should handle CNAME records when found in DNS zones. - enum: - - None - - Follow - type: string - digitalocean: - description: Use the DigitalOcean DNS API to manage DNS01 - challenge records. - properties: - tokenSecretRef: - description: A reference to a specific 'key' within - a Secret resource. In some instances, `key` is a - required field. - 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 - required: - - tokenSecretRef - type: object - 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. - 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. - 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 - required: - - nameserver - type: object - route53: - 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' - type: string - 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 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 - 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 - required: - - region - type: object - webhook: - description: Configure an external webhook based DNS01 - challenge solver to manage DNS01 challenge records. - 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. - 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 - required: - - groupName - - solverName - type: object - type: object - 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. - properties: - 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. - type: string - ingressTemplate: - description: Optional ingress template used to configure - the ACME challenge solver ingress used for HTTP01 - challenges - 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. - properties: - annotations: - additionalProperties: - type: string - description: Annotations that should be added - to the created ACME HTTP01 solver ingress. - type: object - labels: - additionalProperties: - type: string - description: Labels that should be added to - the created ACME HTTP01 solver ingress. - type: object - type: object - type: object - 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 - 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. - properties: - annotations: - additionalProperties: - type: string - description: Annotations that should be added - to the create ACME HTTP01 solver pods. - type: object - labels: - additionalProperties: - type: string - description: Labels that should be added to - the created ACME HTTP01 solver pods. - type: object - type: object - 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. - properties: - affinity: - description: If specified, the pod's scheduling - constraints - properties: - nodeAffinity: - description: Describes node affinity scheduling - rules for the pod. - 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. - 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). - properties: - preference: - description: A node selector - term, associated with the - corresponding weight. - properties: - matchExpressions: - description: A list of node - selector requirements - by node's labels. - items: - description: A node selector - requirement is a selector - that contains values, - a key, and an operator - that relates the key - and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchFields: - description: A list of node - selector requirements - by node's fields. - items: - description: A node selector - requirement is a selector - that contains values, - a key, and an operator - that relates the key - and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - type: object - weight: - description: Weight associated - with matching the corresponding - nodeSelectorTerm, in the range - 1-100. - format: int32 - type: integer - required: - - preference - - weight - type: object - 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. - properties: - nodeSelectorTerms: - description: Required. A list - of node selector terms. The - terms are ORed. - 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. - properties: - matchExpressions: - description: A list of node - selector requirements - by node's labels. - items: - description: A node selector - requirement is a selector - that contains values, - a key, and an operator - that relates the key - and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchFields: - description: A list of node - selector requirements - by node's fields. - items: - description: A node selector - requirement is a selector - that contains values, - a key, and an operator - that relates the key - and values. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - type: object - type: array - required: - - nodeSelectorTerms - type: object - type: object - podAffinity: - description: Describes pod affinity scheduling - rules (e.g. co-locate this pod in the - same node, zone, etc. as some other - pod(s)). - 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. - items: - description: The weights of all - of the matched WeightedPodAffinityTerm - fields are added per-node to find - the most preferred node(s) - properties: - podAffinityTerm: - 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. - 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 relates the - key and values. - properties: - key: - description: key - is the label - key that the - selector applies - to. - type: string - operator: - description: operator - represents a - key's relationship - to a set of - values. Valid - operators are - In, NotIn, Exists - and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels - is a map of {key,value} - pairs. A single {key,value} - in the matchLabels - map is equivalent - to an element of matchExpressions, - whose key field is - "key", the operator - is "In", and the values - array contains only - "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces - specifies which namespaces - the labelSelector applies - to (matches against); - null or empty list means - "this pod's namespace" - 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 - weight: - description: weight associated - with matching the corresponding - podAffinityTerm, in the range - 1-100. - format: int32 - type: integer - required: - - podAffinityTerm - - weight - type: object - 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 - 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. - 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 relates the key - and values. - properties: - key: - description: key is - the label key that - the selector applies - to. - type: string - operator: - description: operator - represents a key's - relationship to - a set of values. - Valid operators - are In, NotIn, Exists - and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels - is a map of {key,value} - pairs. A single {key,value} - in the matchLabels map - is equivalent to an element - of matchExpressions, whose - key field is "key", the - operator is "In", and - the values array contains - only "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces specifies - which namespaces the labelSelector - applies to (matches against); - null or empty list means "this - pod's namespace" - 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 - type: array - type: object - 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)). - 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. - items: - description: The weights of all - of the matched WeightedPodAffinityTerm - fields are added per-node to find - the most preferred node(s) - properties: - podAffinityTerm: - 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. - 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 relates the - key and values. - properties: - key: - description: key - is the label - key that the - selector applies - to. - type: string - operator: - description: operator - represents a - key's relationship - to a set of - values. Valid - operators are - In, NotIn, Exists - and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels - is a map of {key,value} - pairs. A single {key,value} - in the matchLabels - map is equivalent - to an element of matchExpressions, - whose key field is - "key", the operator - is "In", and the values - array contains only - "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces - specifies which namespaces - the labelSelector applies - to (matches against); - null or empty list means - "this pod's namespace" - 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 - weight: - description: weight associated - with matching the corresponding - podAffinityTerm, in the range - 1-100. - format: int32 - type: integer - required: - - podAffinityTerm - - weight - type: object - 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 - 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. - 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 relates the key - and values. - properties: - key: - description: key is - the label key that - the selector applies - to. - type: string - operator: - description: operator - represents a key's - relationship to - a set of values. - Valid operators - are In, NotIn, Exists - and DoesNotExist. - 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. - items: - type: string - type: array - required: - - key - - operator - type: object - type: array - matchLabels: - additionalProperties: - type: string - description: matchLabels - is a map of {key,value} - pairs. A single {key,value} - in the matchLabels map - is equivalent to an element - of matchExpressions, whose - key field is "key", the - operator is "In", and - the values array contains - only "value". The requirements - are ANDed. - type: object - type: object - namespaces: - description: namespaces specifies - which namespaces the labelSelector - applies to (matches against); - null or empty list means "this - pod's namespace" - 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 - type: array - type: object - type: object - nodeSelector: - 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. - type: string - serviceAccountName: - description: If specified, the pod's service - account - type: string - tolerations: - description: If specified, the pod's tolerations. - items: - 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. - 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. - 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 - type: array - type: object - type: object - serviceType: - description: Optional service type for Kubernetes - solver service - type: string - type: object - type: object - 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. - 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. - 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. - items: - type: string - type: array - matchLabels: - 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 - type: object - type: array - required: - - privateKeySecretRef - - server - type: object - 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. - 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. - 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 - selfSigned: - description: SelfSigned configures this issuer to 'self sign' certificates - using the private key used to create the CertificateRequest 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. - items: - type: string - type: array - type: object - vault: - description: Vault configures this issuer to sign certificates using - a HashiCorp Vault PKI backend. - properties: - auth: - description: Auth configures how cert-manager authenticates with - the Vault server. - properties: - appRole: - description: AppRole authenticates with Vault using the App - Role auth mechanism, with the role and secret stored in a - Kubernetes Secret resource. - properties: - path: - description: 'Path where the App Role authentication backend - is mounted in Vault, e.g: "approle"' - type: string - roleId: - description: RoleID configured in the App Role authentication - backend when setting up the authentication backend in - Vault. - type: string - 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. - 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 - required: - - path - - roleId - - secretRef - type: object - kubernetes: - description: Kubernetes authenticates with Vault by passing - the ServiceAccount token stored in the named Secret resource - to the Vault server. - 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. - type: string - role: - description: A required field containing the Vault Role - to assume. A Role binds a Kubernetes ServiceAccount with - a set of Vault policies. - type: string - secretRef: - description: The required Secret field containing a Kubernetes - ServiceAccount JWT used for authenticating with Vault. - Use of 'ambient credentials' is not supported. - 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 - required: - - role - - secretRef - type: object - tokenSecretRef: - description: TokenSecretRef authenticates with Vault by presenting - a token. - 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 - type: object - caBundle: - description: PEM encoded CA bundle 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. - format: byte - type: string - 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' - type: string - path: - description: 'Path is the mount path of the Vault PKI backend''s - `sign` endpoint, e.g: "my_pki_mount/sign/my-role-name".' - type: string - server: - description: 'Server is the connection address for the Vault server, - e.g: "https://vault.example.com:8200".' - type: string - required: - - auth - - path - - server - type: object - venafi: - description: Venafi configures this issuer to sign certificates using - a Venafi TPP or Venafi Cloud policy zone. - properties: - cloud: - description: Cloud specifies the Venafi cloud configuration settings. - Only one of TPP or Cloud may be specified. - properties: - apiTokenSecretRef: - description: APITokenSecretRef is a secret key selector for - the Venafi Cloud API token. - 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 - url: - description: URL is the base URL for Venafi Cloud. Defaults - to "https://api.venafi.cloud/v1". - type: string - required: - - apiTokenSecretRef - type: object - 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. - 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'. - 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 - url: - description: 'URL is the base URL for the vedsdk endpoint of - the Venafi TPP instance, for example: "https://tpp.example.com/vedsdk".' - type: string - required: - - credentialsRef - - url - type: object - 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. - type: string - required: - - zone - type: object - type: object - status: - description: Status of the Issuer. This is set and managed automatically. - 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. - properties: - 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 - uri: - description: URI is the unique account identifier, which can also - be used to retrieve account details from the CA - type: string - type: object - conditions: - description: List of status conditions to indicate the status of a CertificateRequest. - Known condition types are `Ready`. - items: - description: IssuerCondition contains condition information for an - Issuer. - properties: - lastTransitionTime: - description: LastTransitionTime is the timestamp corresponding - to the last status change 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. - type: string - reason: - description: Reason is a brief machine readable explanation for - the condition's last transition. - type: string - status: - 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 ('Ready'). - type: string - required: - - status - - type - type: object - type: array - type: object - required: - - spec - version: v1 - versions: - - name: v1 - served: true - storage: true -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1beta1 -kind: CustomResourceDefinition -metadata: - annotations: - cert-manager.io/inject-ca-from-secret: '{{ template "webhook.caRef" . }}' - labels: - app: '{{ template "cert-manager.name" . }}' - app.kubernetes.io/instance: '{{ .Release.Name }}' - app.kubernetes.io/managed-by: '{{ .Release.Service }}' - app.kubernetes.io/name: '{{ template "cert-manager.name" . }}' - helm.sh/chart: '{{ template "cert-manager.chart" . }}' - name: orders.acme.cert-manager.io -spec: - additionalPrinterColumns: - - JSONPath: .status.state - name: State - type: string - - JSONPath: .spec.issuerRef.name - name: Issuer - priority: 1 - type: string - - JSONPath: .status.reason - name: Reason - priority: 1 - type: string - - JSONPath: .metadata.creationTimestamp - description: CreationTimestamp is a timestamp representing the server time when - this object was created. It is not guaranteed to be set in happens-before order - across separate operations. Clients may not set this value. It is represented - in RFC3339 form and is in UTC. - name: Age - type: date - group: acme.cert-manager.io - names: - kind: Order - listKind: OrderList - plural: orders - singular: order - scope: Namespaced - subresources: - status: {} - validation: - openAPIV3Schema: - description: Order is a type to represent an Order with an ACME server - 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: - 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. - items: - type: string - type: array - 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. - items: - type: string - type: array - 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. - 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 - required: - - name - type: object - 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. - format: byte - type: string - required: - - issuerRef - - request - type: object - status: - 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. - 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. - 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. - 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. - 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 - required: - - token - - type - - url - type: object - type: array - 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. - enum: - - valid - - ready - - pending - - processing - - invalid - - expired - - errored - type: string - 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 - required: - - url - type: object - type: array - 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. - format: byte - type: string - failureTime: - description: FailureTime stores the time that this order failed. This - is used to influence garbage collection and back-off. - format: date-time - type: string - 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' - enum: - - valid - - ready - - pending - - processing - - invalid - - expired - - errored - type: string - 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 - type: object - required: - - metadata - - spec - version: v1 - versions: - - name: v1 - served: true - storage: true -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] - -{{- end }} -{{- end }} diff --git a/lib/common/bootstrap/charts/cert-manager/templates/crds.yaml b/lib/common/bootstrap/charts/cert-manager/templates/crds.yaml index 778efb2a..80110d79 100644 --- a/lib/common/bootstrap/charts/cert-manager/templates/crds.yaml +++ b/lib/common/bootstrap/charts/cert-manager/templates/crds.yaml @@ -1,4 +1,3 @@ -{{- if (semverCompare ">=1.16-0" .Capabilities.KubeVersion.GitVersion) }} {{- if .Values.installCRDs }} apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition @@ -22,6 +21,8 @@ spec: - cr - crs singular: certificaterequest + categories: + - cert-manager scope: Namespaced conversion: # a Webhook strategy instruct API server to call an external webhook for any conversion between custom resources. @@ -56,7 +57,7 @@ spec: type: date schema: openAPIV3Schema: - 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 `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." type: object properties: apiVersion: @@ -85,7 +86,7 @@ spec: 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`. 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: 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. type: object required: - name @@ -162,14 +163,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready', 'InvalidRequest'). + description: Type of the condition, known values are (`Ready`, `InvalidRequest`). type: string failureTime: description: FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. @@ -198,7 +199,7 @@ spec: type: date schema: openAPIV3Schema: - 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 `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." type: object properties: apiVersion: @@ -227,7 +228,7 @@ spec: 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`. 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: 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. type: object required: - name @@ -304,14 +305,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready', 'InvalidRequest'). + description: Type of the condition, known values are (`Ready`, `InvalidRequest`). type: string failureTime: description: FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. @@ -340,7 +341,7 @@ spec: type: date schema: openAPIV3Schema: - 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 `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." type: object required: - spec @@ -367,7 +368,7 @@ spec: 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`. 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: 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. type: object required: - name @@ -448,14 +449,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready', 'InvalidRequest'). + description: Type of the condition, known values are (`Ready`, `InvalidRequest`). type: string failureTime: description: FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. @@ -484,7 +485,7 @@ spec: type: date schema: openAPIV3Schema: - 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 `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." type: object required: - spec @@ -511,7 +512,7 @@ spec: 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`. 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: 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. type: object required: - name @@ -592,14 +593,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready', 'InvalidRequest'). + description: Type of the condition, known values are (`Ready`, `InvalidRequest`). type: string failureTime: description: FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off. @@ -636,6 +637,8 @@ spec: - cert - certs singular: certificate + categories: + - cert-manager scope: Namespaced conversion: # a Webhook strategy instruct API server to call an external webhook for any conversion between custom resources. @@ -719,7 +722,7 @@ spec: description: IsCA will mark this Certificate as valid for certificate signing. This will automatically add the `cert sign` usage to the list of `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: 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. type: object required: - name @@ -734,19 +737,19 @@ spec: description: Name of the resource being referred to. type: string keyAlgorithm: - description: KeyAlgorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either "rsa" or "ecdsa" If `keyAlgorithm` is specified and `keySize` 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. + description: KeyAlgorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either `rsa` or `ecdsa` If `keyAlgorithm` is specified and `keySize` 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. type: string enum: - rsa - ecdsa keyEncoding: - description: KeyEncoding is the private key cryptography standards (PKCS) 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. If KeyEncoding is not specified, then PKCS#1 will be used by default. + description: KeyEncoding is the private key cryptography standards (PKCS) 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. If KeyEncoding is not specified, then `pkcs1` will be used by default. type: string enum: - pkcs1 - pkcs8 keySize: - description: KeySize is the key bit size of the corresponding private key for this certificate. If `keyAlgorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `keyAlgorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. No other values are allowed. + description: KeySize is the key bit size of the corresponding private key for this certificate. If `keyAlgorithm` is set to `rsa`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `keyAlgorithm` is set to `ecdsa`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. No other values are allowed. type: integer keystores: description: Keystores configures additional keystore output formats stored in the `secretName` Secret resource. @@ -911,14 +914,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready', `Issuing`). + description: Type of the condition, known values are (`Ready`, `Issuing`). type: string 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. @@ -1014,7 +1017,7 @@ spec: description: IsCA will mark this Certificate as valid for certificate signing. This will automatically add the `cert sign` usage to the list of `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: 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. type: object required: - name @@ -1029,19 +1032,19 @@ spec: description: Name of the resource being referred to. type: string keyAlgorithm: - description: KeyAlgorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either "rsa" or "ecdsa" If `keyAlgorithm` is specified and `keySize` 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. + description: KeyAlgorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either `rsa` or `ecdsa` If `keyAlgorithm` is specified and `keySize` 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. type: string enum: - rsa - ecdsa keyEncoding: - description: KeyEncoding is the private key cryptography standards (PKCS) 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. If KeyEncoding is not specified, then PKCS#1 will be used by default. + description: KeyEncoding is the private key cryptography standards (PKCS) 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. If KeyEncoding is not specified, then `pkcs1` will be used by default. type: string enum: - pkcs1 - pkcs8 keySize: - description: KeySize is the key bit size of the corresponding private key for this certificate. If `keyAlgorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `keyAlgorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. No other values are allowed. + description: KeySize is the key bit size of the corresponding private key for this certificate. If `keyAlgorithm` is set to `rsa`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `keyAlgorithm` is set to `ecdsa`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. No other values are allowed. type: integer keystores: description: Keystores configures additional keystore output formats stored in the `secretName` Secret resource. @@ -1055,7 +1058,7 @@ spec: - passwordSecretRef 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. + 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. type: boolean passwordSecretRef: description: PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore. @@ -1077,7 +1080,7 @@ spec: - passwordSecretRef 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. + 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. type: boolean passwordSecretRef: description: PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore. @@ -1206,14 +1209,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready', `Issuing`). + description: Type of the condition, known values are (`Ready`, `Issuing`). type: string 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. @@ -1311,7 +1314,7 @@ spec: description: IsCA will mark this Certificate as valid for certificate signing. This will automatically add the `cert sign` usage to the list of `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: 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. type: object required: - name @@ -1378,13 +1381,13 @@ spec: type: object properties: algorithm: - description: Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either "rsa" 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. + description: Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either `RSA` 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. type: string enum: - RSA - ECDSA 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 PKCS#1 if not specified. + 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. type: string enum: - PKCS1 @@ -1503,14 +1506,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready', `Issuing`). + description: Type of the condition, known values are (`Ready`, `Issuing`). type: string 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. @@ -1608,7 +1611,7 @@ spec: description: IsCA will mark this Certificate as valid for certificate signing. This will automatically add the `cert sign` usage to the list of `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: 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. type: object required: - name @@ -1634,7 +1637,7 @@ spec: - passwordSecretRef 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. + 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 type: boolean passwordSecretRef: description: PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore. @@ -1656,7 +1659,7 @@ spec: - passwordSecretRef 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. + 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 type: boolean passwordSecretRef: description: PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore. @@ -1675,13 +1678,13 @@ spec: type: object properties: algorithm: - description: Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either "rsa" 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. + description: Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either `RSA` 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. type: string enum: - RSA - ECDSA 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 PKCS#1 if not specified. + 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. type: string enum: - PKCS1 @@ -1800,14 +1803,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready', `Issuing`). + description: Type of the condition, known values are (`Ready`, `Issuing`). type: string 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. @@ -1859,6 +1862,9 @@ spec: listKind: ChallengeList plural: challenges singular: challenge + categories: + - cert-manager + - cert-manager-acme scope: Namespaced conversion: # a Webhook strategy instruct API server to call an external webhook for any conversion between custom resources. @@ -5200,6 +5206,8 @@ spec: listKind: ClusterIssuerList plural: clusterissuers singular: clusterissuer + categories: + - cert-manager scope: Cluster conversion: # a Webhook strategy instruct API server to call an external webhook for any conversion between custom resources. @@ -6043,6 +6051,11 @@ spec: type: array items: type: string + 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 wil 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 secretName: description: SecretName is the name of the secret used to sign Certificates issued by this Issuer. type: string @@ -6231,14 +6244,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready'). + description: Type of the condition, known values are (`Ready`). type: string served: true storage: false @@ -7072,6 +7085,11 @@ spec: type: array items: type: string + 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 wil 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 secretName: description: SecretName is the name of the secret used to sign Certificates issued by this Issuer. type: string @@ -7260,14 +7278,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready'). + description: Type of the condition, known values are (`Ready`). type: string served: true storage: false @@ -8103,6 +8121,11 @@ spec: type: array items: type: string + 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 wil 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 secretName: description: SecretName is the name of the secret used to sign Certificates issued by this Issuer. type: string @@ -8291,14 +8314,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready'). + description: Type of the condition, known values are (`Ready`). type: string served: true storage: false @@ -9134,6 +9157,11 @@ spec: type: array items: type: string + 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 wil 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 secretName: description: SecretName is the name of the secret used to sign Certificates issued by this Issuer. type: string @@ -9322,14 +9350,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready'). + description: Type of the condition, known values are (`Ready`). type: string served: true storage: true @@ -9359,6 +9387,8 @@ spec: listKind: IssuerList plural: issuers singular: issuer + categories: + - cert-manager scope: Namespaced conversion: # a Webhook strategy instruct API server to call an external webhook for any conversion between custom resources. @@ -10202,6 +10232,11 @@ spec: type: array items: type: string + 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 wil 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 secretName: description: SecretName is the name of the secret used to sign Certificates issued by this Issuer. type: string @@ -10390,14 +10425,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready'). + description: Type of the condition, known values are (`Ready`). type: string served: true storage: false @@ -11231,6 +11266,11 @@ spec: type: array items: type: string + 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 wil 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 secretName: description: SecretName is the name of the secret used to sign Certificates issued by this Issuer. type: string @@ -11419,14 +11459,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready'). + description: Type of the condition, known values are (`Ready`). type: string served: true storage: false @@ -12262,6 +12302,11 @@ spec: type: array items: type: string + 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 wil 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 secretName: description: SecretName is the name of the secret used to sign Certificates issued by this Issuer. type: string @@ -12450,14 +12495,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready'). + description: Type of the condition, known values are (`Ready`). type: string served: true storage: false @@ -13293,6 +13338,11 @@ spec: type: array items: type: string + 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 wil 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 secretName: description: SecretName is the name of the secret used to sign Certificates issued by this Issuer. type: string @@ -13481,14 +13531,14 @@ spec: description: Reason is a brief machine readable explanation for the condition's last transition. type: string status: - description: Status of the condition, one of ('True', 'False', 'Unknown'). + description: Status of the condition, one of (`True`, `False`, `Unknown`). type: string enum: - "True" - "False" - Unknown type: - description: Type of the condition, known values are ('Ready'). + description: Type of the condition, known values are (`Ready`). type: string served: true storage: true @@ -13518,6 +13568,9 @@ spec: listKind: OrderList plural: orders singular: order + categories: + - cert-manager + - cert-manager-acme scope: Namespaced conversion: # a Webhook strategy instruct API server to call an external webhook for any conversion between custom resources. @@ -14169,4 +14222,3 @@ status: storedVersions: [] --- {{- end }} -{{- end }} diff --git a/lib/common/bootstrap/charts/cert-manager/templates/deployment.yaml b/lib/common/bootstrap/charts/cert-manager/templates/deployment.yaml index 3daeaff2..39a69185 100644 --- a/lib/common/bootstrap/charts/cert-manager/templates/deployment.yaml +++ b/lib/common/bootstrap/charts/cert-manager/templates/deployment.yaml @@ -86,7 +86,18 @@ spec: {{- else }} - --cluster-resource-namespace=$(POD_NAMESPACE) {{- end }} - - --leader-election-namespace={{ .Values.global.leaderElection.namespace }} + {{- with .Values.global.leaderElection }} + - --leader-election-namespace={{ .namespace }} + {{- if .leaseDuration }} + - --leader-election-lease-duration={{ .leaseDuration }} + {{- end }} + {{- if .renewDeadline }} + - --leader-election-renew-deadline={{ .renewDeadline }} + {{- end }} + {{- if .retryPeriod }} + - --leader-election-retry-period={{ .retryPeriod }} + {{- end }} + {{- end }} {{- if .Values.extraArgs }} {{ toYaml .Values.extraArgs | indent 10 }} {{- end }} diff --git a/lib/common/bootstrap/charts/cert-manager/templates/rbac.yaml b/lib/common/bootstrap/charts/cert-manager/templates/rbac.yaml index c7244595..a9b85392 100644 --- a/lib/common/bootstrap/charts/cert-manager/templates/rbac.yaml +++ b/lib/common/bootstrap/charts/cert-manager/templates/rbac.yaml @@ -220,7 +220,7 @@ rules: - apiGroups: [""] resources: ["pods", "services"] verbs: ["get", "list", "watch", "create", "delete"] - - apiGroups: ["extensions"] + - apiGroups: ["networking.k8s.io"] resources: ["ingresses"] verbs: ["get", "list", "watch", "create", "delete", "update"] # We require the ability to specify a custom hostname when we are creating @@ -261,13 +261,13 @@ rules: - apiGroups: ["cert-manager.io"] resources: ["certificates", "certificaterequests", "issuers", "clusterissuers"] verbs: ["get", "list", "watch"] - - apiGroups: ["extensions"] + - apiGroups: ["networking.k8s.io"] resources: ["ingresses"] verbs: ["get", "list", "watch"] # We require these rules to support users with the OwnerReferencesPermissionEnforcement # admission controller enabled: # https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#ownerreferencespermissionenforcement - - apiGroups: ["extensions"] + - apiGroups: ["networking.k8s.io"] resources: ["ingresses/finalizers"] verbs: ["update"] - apiGroups: [""] diff --git a/lib/common/bootstrap/charts/cert-manager/templates/webhook-mutating-webhook.yaml b/lib/common/bootstrap/charts/cert-manager/templates/webhook-mutating-webhook.yaml index 56ff07b7..99309c0e 100644 --- a/lib/common/bootstrap/charts/cert-manager/templates/webhook-mutating-webhook.yaml +++ b/lib/common/bootstrap/charts/cert-manager/templates/webhook-mutating-webhook.yaml @@ -1,10 +1,4 @@ -{{- $isV1AdmissionRegistration := false -}} -{{- if (or (not (.Capabilities.APIVersions.Has "admissionregistration.k8s.io/v1")) (.Capabilities.APIVersions.Has "hacking-helm.i-wish-this-wasnt-required.cert-manager.io/force-v1beta1-webhooks") ) }} -apiVersion: admissionregistration.k8s.io/v1beta1 -{{- else }} -{{- $isV1AdmissionRegistration = true -}} apiVersion: admissionregistration.k8s.io/v1 -{{- end }} kind: MutatingWebhookConfiguration metadata: name: {{ include "webhook.fullname" . }} @@ -33,21 +27,12 @@ webhooks: - UPDATE resources: - "*/*" - {{- if $isV1AdmissionRegistration }} admissionReviewVersions: ["v1", "v1beta1"] timeoutSeconds: {{ .Values.webhook.timeoutSeconds }} - {{- end }} failurePolicy: Fail -{{- if (semverCompare ">=1.12-0" .Capabilities.KubeVersion.GitVersion) }} # Only include 'sideEffects' field in Kubernetes 1.12+ sideEffects: None -{{- end }} clientConfig: -{{- if (semverCompare "<=1.12-0" .Capabilities.KubeVersion.GitVersion) }} - # Set caBundle to empty to avoid https://github.com/kubernetes/kubernetes/pull/70138 - # in Kubernetes 1.12 and below. - caBundle: "" -{{- end }} service: name: {{ template "webhook.fullname" . }} namespace: {{ .Release.Namespace | quote }} diff --git a/lib/common/bootstrap/charts/cert-manager/templates/webhook-validating-webhook.yaml b/lib/common/bootstrap/charts/cert-manager/templates/webhook-validating-webhook.yaml index c45461e0..64c8d73d 100644 --- a/lib/common/bootstrap/charts/cert-manager/templates/webhook-validating-webhook.yaml +++ b/lib/common/bootstrap/charts/cert-manager/templates/webhook-validating-webhook.yaml @@ -1,10 +1,4 @@ -{{- $isV1AdmissionRegistration := false -}} -{{- if (or (not (.Capabilities.APIVersions.Has "admissionregistration.k8s.io/v1")) (.Capabilities.APIVersions.Has "hacking-helm.i-wish-this-wasnt-required.cert-manager.io/force-v1beta1-webhooks") ) }} -apiVersion: admissionregistration.k8s.io/v1beta1 -{{- else }} -{{- $isV1AdmissionRegistration = true -}} apiVersion: admissionregistration.k8s.io/v1 -{{- end }} kind: ValidatingWebhookConfiguration metadata: name: {{ include "webhook.fullname" . }} @@ -43,21 +37,11 @@ webhooks: - UPDATE resources: - "*/*" - {{- if $isV1AdmissionRegistration }} admissionReviewVersions: ["v1", "v1beta1"] timeoutSeconds: {{ .Values.webhook.timeoutSeconds }} - {{- end }} failurePolicy: Fail -{{- if (semverCompare ">=1.12-0" .Capabilities.KubeVersion.GitVersion) }} - # Only include 'sideEffects' field in Kubernetes 1.12+ sideEffects: None -{{- end }} clientConfig: -{{- if (semverCompare "<=1.12-0" .Capabilities.KubeVersion.GitVersion) }} - # Set caBundle to empty to avoid https://github.com/kubernetes/kubernetes/pull/70138 - # in Kubernetes 1.12 and below. - caBundle: "" -{{- end }} service: name: {{ template "webhook.fullname" . }} namespace: {{ .Release.Namespace | quote }} diff --git a/lib/common/bootstrap/charts/cert-manager/values.yaml b/lib/common/bootstrap/charts/cert-manager/values.yaml index e7f0f09f..9f5bb85c 100644 --- a/lib/common/bootstrap/charts/cert-manager/values.yaml +++ b/lib/common/bootstrap/charts/cert-manager/values.yaml @@ -24,6 +24,21 @@ global: # Override the namespace used to store the ConfigMap for leader election namespace: "kube-system" + # The duration that non-leader candidates will wait after observing a + # leadership renewal until attempting to acquire leadership of a led but + # unrenewed leader slot. This is effectively the maximum duration that a + # leader can be stopped before it is replaced by another candidate. + # leaseDuration: 60s + + # The interval between attempts by the acting master to renew a leadership + # slot before it stops leading. This must be less than or equal to the + # lease duration. + # renewDeadline: 40s + + # The duration the clients should wait between attempting acquisition and + # renewal of a leadership. + # retryPeriod: 15s + installCRDs: false replicaCount: 1 diff --git a/lib/helm-freeze.yaml b/lib/helm-freeze.yaml index c55f287e..c9b70c2a 100644 --- a/lib/helm-freeze.yaml +++ b/lib/helm-freeze.yaml @@ -1,6 +1,6 @@ charts: - name: cert-manager - version: v1.1.1 + version: v1.2.0 repo_name: jetstack - name: external-dns repo_name: bitnami diff --git a/src/cloud_provider/aws/kubernetes/helm_charts.rs b/src/cloud_provider/aws/kubernetes/helm_charts.rs index 59d919a5..89f98bfe 100644 --- a/src/cloud_provider/aws/kubernetes/helm_charts.rs +++ b/src/cloud_provider/aws/kubernetes/helm_charts.rs @@ -795,6 +795,7 @@ datasources: name: "cert-manager-configs".to_string(), path: chart_path("common/charts/cert-manager-configs"), namespace: HelmChartNamespaces::CertManager, + backup_resources: Some(vec!["cert".to_string(), "issuer".to_string(), "clusterissuer".to_string()]), values: vec![ ChartSetValue { key: "externalDnsProvider".to_string(), diff --git a/src/cloud_provider/digitalocean/kubernetes/helm_charts.rs b/src/cloud_provider/digitalocean/kubernetes/helm_charts.rs index f6db1401..3e9f733e 100644 --- a/src/cloud_provider/digitalocean/kubernetes/helm_charts.rs +++ b/src/cloud_provider/digitalocean/kubernetes/helm_charts.rs @@ -611,6 +611,7 @@ datasources: name: "cert-manager-configs".to_string(), path: chart_path("common/charts/cert-manager-configs"), namespace: HelmChartNamespaces::CertManager, + backup_resources: Some(vec!["cert".to_string(), "issuer".to_string(), "clusterissuer".to_string()]), values: vec![ ChartSetValue { key: "externalDnsProvider".to_string(), diff --git a/src/cloud_provider/helm.rs b/src/cloud_provider/helm.rs index 8e252bff..5f8e1702 100644 --- a/src/cloud_provider/helm.rs +++ b/src/cloud_provider/helm.rs @@ -2,6 +2,9 @@ use crate::cloud_provider::helm::HelmAction::Deploy; use crate::cloud_provider::helm::HelmChartNamespaces::KubeSystem; use crate::cloud_provider::qovery::{get_qovery_app_version, EngineLocation, QoveryAppName, QoveryShellAgent}; use crate::cmd::helm::{to_command_error, Helm}; +use crate::cmd::helm_utils::{ + apply_chart_backup, delete_unused_chart_backup, prepare_chart_backup_on_upgrade, BackupStatus, +}; use crate::cmd::kubectl::{ kubectl_delete_crash_looping_pods, kubectl_exec_delete_crd, kubectl_exec_get_configmap, kubectl_exec_get_events, kubectl_exec_rollout_restart_deployment, kubectl_exec_with_output, @@ -12,7 +15,7 @@ use crate::utilities::calculate_hash; use semver::Version; use std::collections::HashMap; use std::fmt::{Display, Formatter}; -use std::path::Path; +use std::path::{Path, PathBuf}; use std::{fs, thread}; use thread::spawn; use tracing::{span, Level}; @@ -82,6 +85,7 @@ pub struct ChartInfo { pub yaml_files_content: Vec, pub parse_stderr_for_error: bool, pub k8s_selector: Option, + pub backup_resources: Option>, } impl ChartInfo { @@ -146,6 +150,7 @@ impl Default for ChartInfo { yaml_files_content: vec![], parse_stderr_for_error: true, k8s_selector: None, + backup_resources: None, } } } @@ -232,7 +237,61 @@ pub trait HelmChart: Send { ); } - helm.upgrade(chart_info, &[]).map_err(to_command_error)?; + let installed_version = match helm.get_chart_version( + chart_info.name.clone(), + Some(chart_info.get_namespace_string().as_str()), + environment_variables.as_slice(), + ) { + Ok(version) => version, + Err(e) => { + warn!("error while trying to get installed version: {:?}", e); + None + } + }; + + let upgrade_status = match prepare_chart_backup_on_upgrade( + kubernetes_config, + chart_info.clone(), + environment_variables.as_slice(), + installed_version, + ) { + Ok(status) => status, + Err(e) => { + warn!("error while trying to prepare backup: {:?}", e); + BackupStatus { + is_backupable: false, + backup_path: PathBuf::new(), + } + } + }; + + match helm.upgrade(chart_info, &[]).map_err(to_command_error) { + Ok(_) => { + if upgrade_status.is_backupable { + if let Err(e) = apply_chart_backup( + kubernetes_config, + upgrade_status.backup_path.as_path(), + environment_variables.as_slice(), + chart_info, + ) { + warn!("error while trying to apply backup: {:?}", e); + }; + } + } + Err(e) => { + if upgrade_status.is_backupable { + if let Err(e) = delete_unused_chart_backup( + kubernetes_config, + environment_variables.as_slice(), + chart_info, + ) { + warn!("error while trying to delete backup: {:?}", e); + } + } + + return Err(e); + } + } } HelmAction::Destroy => { let chart_info = self.get_chart_info(); @@ -358,7 +417,7 @@ pub fn deploy_charts_levels( // Common charts // -#[derive(Default)] +#[derive(Default, Clone)] pub struct CommonChart { pub chart_info: ChartInfo, } diff --git a/src/cloud_provider/scaleway/kubernetes/helm_charts.rs b/src/cloud_provider/scaleway/kubernetes/helm_charts.rs index 75682e0a..c35e17b4 100644 --- a/src/cloud_provider/scaleway/kubernetes/helm_charts.rs +++ b/src/cloud_provider/scaleway/kubernetes/helm_charts.rs @@ -560,6 +560,7 @@ datasources: name: "cert-manager-configs".to_string(), path: chart_path("common/charts/cert-manager-configs"), namespace: HelmChartNamespaces::CertManager, + backup_resources: Some(vec!["cert".to_string(), "issuer".to_string(), "clusterissuer".to_string()]), values: vec![ ChartSetValue { key: "externalDnsProvider".to_string(), diff --git a/src/cmd/helm.rs b/src/cmd/helm.rs index bb0aca91..b63e5486 100644 --- a/src/cmd/helm.rs +++ b/src/cmd/helm.rs @@ -504,40 +504,38 @@ impl Helm { }, ); - match helm_ret { - // Ok is ok - Ok(_) => Ok(()), - Err(err) => { - error!("Helm error: {:?}", err); + if let Err(err) = helm_ret { + error!("Helm error: {:?}", err); - // Try do define/specify a bit more the message - let stderr_msg: String = error_message.into_iter().collect(); - let stderr_msg = format!( - "{}: {}", - stderr_msg, - err.message(ErrorMessageVerbosity::FullDetailsWithoutEnvVars) - ); - let error = if stderr_msg.contains("another operation (install/upgrade/rollback) is in progress") { - HelmError::ReleaseLocked(chart.name.clone()) - } else if stderr_msg.contains("has been rolled back") { - HelmError::Rollbacked(chart.name.clone(), UPGRADE) - } else if stderr_msg.contains("timed out waiting") { - HelmError::Timeout(chart.name.clone(), UPGRADE, stderr_msg) - } else { - CmdError( - chart.name.clone(), - HelmCommand::UPGRADE, - CommandError::new( - "Helm error".to_string(), - Some(stderr_msg), - Some(envs.iter().map(|(k, v)| (k.to_string(), v.to_string())).collect()), - ), - ) - }; + // Try do define/specify a bit more the message + let stderr_msg: String = error_message.into_iter().collect(); + let stderr_msg = format!( + "{}: {}", + stderr_msg, + err.message(ErrorMessageVerbosity::FullDetailsWithoutEnvVars) + ); + let error = if stderr_msg.contains("another operation (install/upgrade/rollback) is in progress") { + HelmError::ReleaseLocked(chart.name.clone()) + } else if stderr_msg.contains("has been rolled back") { + HelmError::Rollbacked(chart.name.clone(), UPGRADE) + } else if stderr_msg.contains("timed out waiting") { + HelmError::Timeout(chart.name.clone(), UPGRADE, stderr_msg) + } else { + CmdError( + chart.name.clone(), + HelmCommand::UPGRADE, + CommandError::new( + "Helm error".to_string(), + Some(stderr_msg), + Some(envs.iter().map(|(k, v)| (k.to_string(), v.to_string())).collect()), + ), + ) + }; - Err(error) - } - } + return Err(error); + }; + + Ok(()) } pub fn uninstall_chart_if_breaking_version( @@ -612,17 +610,19 @@ mod tests { struct HelmTestCtx { helm: Helm, - chart: ChartInfo, + charts: Vec, } impl HelmTestCtx { fn cleanup(&self) { - let ret = self.helm.uninstall(&self.chart, &[]); - assert!(ret.is_ok()) + for chart in &self.charts { + let ret = self.helm.uninstall(chart, &vec![]); + assert!(ret.is_ok()) + } } fn new(release_name: &str) -> HelmTestCtx { - let chart = ChartInfo::new_from_custom_namespace( + let charts = vec![ChartInfo::new_from_custom_namespace( release_name.to_string(), "tests/helm/simple_nginx".to_string(), "default".to_string(), @@ -630,12 +630,12 @@ mod tests { vec![], false, None, - ); + )]; let mut kube_config = dirs::home_dir().unwrap(); kube_config.push(".kube/config"); - let helm = Helm::new(kube_config.to_str().unwrap(), &[]).unwrap(); + let helm = Helm::new(kube_config.to_str().unwrap(), &vec![]).unwrap(); - let cleanup = HelmTestCtx { helm, chart }; + let cleanup = HelmTestCtx { helm, charts }; cleanup.cleanup(); cleanup } @@ -656,26 +656,26 @@ mod tests { #[test] fn test_release_exist() { - let HelmTestCtx { ref helm, ref chart } = HelmTestCtx::new("test-release-exist"); - let ret = helm.check_release_exist(chart, &[]); + let HelmTestCtx { ref helm, ref charts } = HelmTestCtx::new("test-release-exist"); + let ret = helm.check_release_exist(&charts[0], &vec![]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)) + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)) } #[test] fn test_list_release() { let HelmTestCtx { ref helm, - ref mut chart, + ref mut charts, } = HelmTestCtx::new("test-list-release"); - chart.custom_namespace = Some("hello-my-friend-this-is-a-test".to_string()); + charts[0].custom_namespace = Some("hello-my-friend-this-is-a-test".to_string()); // no existing namespace should return an empty array let ret = helm.list_release(Some("tsdfsfsdf"), &[]); assert!(matches!(ret, Ok(vec) if vec.is_empty())); // install something - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // We should have at least one release in all the release @@ -683,69 +683,69 @@ mod tests { assert!(matches!(ret, Ok(vec) if !vec.is_empty())); // We should have at least one release in all the release - let ret = helm.list_release(Some(&chart.get_namespace_string()), &[]); + let ret = helm.list_release(Some(&charts[0].get_namespace_string()), &vec![]); assert!(matches!(ret, Ok(vec) if vec.len() == 1)); // Install a second stuff let HelmTestCtx { ref helm, - ref mut chart, + ref mut charts, } = HelmTestCtx::new("test-list-release-2"); - chart.custom_namespace = Some("hello-my-friend-this-is-a-test".to_string()); - let ret = helm.upgrade(chart, &[]); + charts[0].custom_namespace = Some("hello-my-friend-this-is-a-test".to_string()); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); - let ret = helm.list_release(Some(&chart.get_namespace_string()), &[]); + let ret = helm.list_release(Some(&charts[0].get_namespace_string()), &vec![]); assert!(matches!(ret, Ok(vec) if vec.len() == 2)); } #[test] fn test_upgrade_diff() { - let HelmTestCtx { ref helm, ref chart } = HelmTestCtx::new("test-upgrade-diff"); + let HelmTestCtx { ref helm, ref charts } = HelmTestCtx::new("test-upgrade-diff"); - let ret = helm.upgrade_diff(chart, &[]); + let ret = helm.upgrade_diff(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); } #[test] fn test_rollback() { - let HelmTestCtx { ref helm, ref chart } = HelmTestCtx::new("test-rollback"); + let HelmTestCtx { ref helm, ref charts } = HelmTestCtx::new("test-rollback"); // check release does not exist yet - let ret = helm.rollback(chart, &[]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)); + let ret = helm.rollback(&charts[0], &vec![]); + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)); // install it - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // First revision cannot be rollback - let ret = helm.rollback(chart, &[]); + let ret = helm.rollback(&charts[0], &vec![]); assert!(matches!(ret, Err(HelmError::CannotRollback(_)))); // 2nd upgrade - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // Rollback should be ok now - let ret = helm.rollback(chart, &[]); + let ret = helm.rollback(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); } #[test] fn test_upgrade() { - let HelmTestCtx { ref helm, ref chart } = HelmTestCtx::new("test-upgrade"); + let HelmTestCtx { ref helm, ref charts } = HelmTestCtx::new("test-upgrade"); // check release does not exist yet - let ret = helm.check_release_exist(chart, &[]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)); + let ret = helm.check_release_exist(&charts[0], &vec![]); + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)); // install it - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // check now it exists - let ret = helm.check_release_exist(chart, &[]); + let ret = helm.check_release_exist(&charts[0], &vec![]); assert!(matches!(ret, Ok(_))); } @@ -753,37 +753,37 @@ mod tests { fn test_upgrade_timeout() { let HelmTestCtx { ref helm, - ref mut chart, + ref mut charts, } = HelmTestCtx::new("test-upgrade-timeout"); - chart.timeout_in_seconds = 1; + charts[0].timeout_in_seconds = 1; // check release does not exist yet - let ret = helm.check_release_exist(chart, &[]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)); + let ret = helm.check_release_exist(&charts[0], &vec![]); + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)); // install it - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Err(HelmError::Timeout(_, _, _)))); // Release should not exist if it fails - let ret = helm.check_release_exist(chart, &[]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)); + let ret = helm.check_release_exist(&charts[0], &vec![]); + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)); } #[test] fn test_upgrade_with_lock_during_install() { // We want to check that we manage to install a chart even if a lock is present while it was the first installation - let HelmTestCtx { ref helm, ref chart } = HelmTestCtx::new("test-upgrade-with-lock-install"); + let HelmTestCtx { ref helm, ref charts } = HelmTestCtx::new("test-upgrade-with-lock-install"); // check release does not exist yet - let ret = helm.check_release_exist(chart, &[]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)); + let ret = helm.check_release_exist(&charts[0], &vec![]); + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)); // Spawn our task killer let barrier = Arc::new(Barrier::new(2)); std::thread::spawn({ let barrier = barrier.clone(); - let chart_name = chart.name.clone(); + let chart_name = charts[0].name.clone(); move || { barrier.wait(); thread::sleep(Duration::from_millis(3000)); @@ -794,19 +794,19 @@ mod tests { // install it barrier.wait(); - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Err(_))); // Release should be locked - let ret = helm.check_release_exist(chart, &[]); + let ret = helm.check_release_exist(&charts[0], &vec![]); assert!(matches!(ret, Ok(release) if release.is_locked())); // New installation should work even if a lock is present - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // Release should not be locked anymore - let ret = helm.check_release_exist(chart, &[]); + let ret = helm.check_release_exist(&charts[0], &vec![]); assert!(matches!(ret, Ok(release) if !release.is_locked())); } @@ -815,22 +815,22 @@ mod tests { // We want to check that we manage to install a chart even if a lock is present while it not the first installation let HelmTestCtx { ref helm, - ref mut chart, + ref mut charts, } = HelmTestCtx::new("test-upgrade-with-lock-upgrade"); // check release does not exist yet - let ret = helm.check_release_exist(chart, &[]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)); + let ret = helm.check_release_exist(&charts[0], &vec![]); + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)); // First install - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // Spawn our task killer let barrier = Arc::new(Barrier::new(2)); std::thread::spawn({ let barrier = barrier.clone(); - let chart_name = chart.name.clone(); + let chart_name = charts[0].name.clone(); move || { barrier.wait(); thread::sleep(Duration::from_millis(3000)); @@ -839,64 +839,64 @@ mod tests { } }); - chart.values = vec![ChartSetValue { + charts[0].values = vec![ChartSetValue { key: "initialDelaySeconds".to_string(), value: "6".to_string(), }]; barrier.wait(); - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Err(_))); // Release should be locked - let ret = helm.check_release_exist(chart, &[]); + let ret = helm.check_release_exist(&charts[0], &vec![]); assert!(matches!(ret, Ok(release) if release.is_locked() && release.version == 2)); // New installation should work even if a lock is present - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // Release should not be locked anymore - let ret = helm.check_release_exist(chart, &[]); + let ret = helm.check_release_exist(&charts[0], &vec![]); assert!(matches!(ret, Ok(release) if !release.is_locked() && release.version == 4)); } #[test] fn test_uninstall() { - let HelmTestCtx { ref helm, ref chart } = HelmTestCtx::new("test-uninstall"); + let HelmTestCtx { ref helm, ref charts } = HelmTestCtx::new("test-uninstall"); // check release does not exist yet - let ret = helm.check_release_exist(chart, &[]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)); + let ret = helm.check_release_exist(&charts[0], &vec![]); + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)); // deleting something that does not exist should not be an issue - let ret = helm.uninstall(chart, &[]); + let ret = helm.uninstall(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // install it - let ret = helm.upgrade(chart, &[]); + let ret = helm.upgrade(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // check now it exists - let ret = helm.check_release_exist(chart, &[]); + let ret = helm.check_release_exist(&charts[0], &vec![]); assert!(matches!(ret, Ok(_))); // Delete it - let ret = helm.uninstall(chart, &[]); + let ret = helm.uninstall(&charts[0], &vec![]); assert!(matches!(ret, Ok(()))); // check release does not exist anymore - let ret = helm.check_release_exist(chart, &[]); - assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == chart.name)); + let ret = helm.check_release_exist(&charts[0], &vec![]); + assert!(matches!(ret, Err(HelmError::ReleaseDoesNotExist(test)) if test == charts[0].name)); } #[test] fn test_getting_version() { let HelmTestCtx { ref helm, - ref mut chart, + ref mut charts, } = HelmTestCtx::new("test-version-release"); - let _ = helm.upgrade(chart, &[]); - let releases = helm.list_release(Some(&chart.get_namespace_string()), &[]).unwrap(); + let _ = helm.upgrade(&charts[0], &[]); + let releases = helm.list_release(Some(&charts[0].get_namespace_string()), &[]).unwrap(); assert_eq!(releases[0].clone().version.unwrap(), Version::new(0, 1, 0)) } } diff --git a/src/cmd/helm_utils.rs b/src/cmd/helm_utils.rs new file mode 100644 index 00000000..2d894b0f --- /dev/null +++ b/src/cmd/helm_utils.rs @@ -0,0 +1,411 @@ +use crate::cloud_provider::helm::ChartInfo; +use crate::cmd::helm::HelmError::CmdError; +use crate::cmd::helm::{HelmCommand, HelmError}; +use crate::cmd::kubectl::{ + kubectl_apply_with_path, kubectl_create_secret_from_file, kubectl_delete_secret, kubectl_exec_get_secrets, + kubectl_get_resource_yaml, +}; +use crate::errors::CommandError; +use crate::fs::{ + create_yaml_backup_file, create_yaml_file_from_secret, indent_file, remove_lines_starting_with, + truncate_file_from_word, +}; +use semver::Version; +use serde_derive::Deserialize; +use std::fs::OpenOptions; +use std::io::{BufReader, Read}; +use std::path::{Path, PathBuf}; + +#[derive(Debug, Clone, Deserialize, Default)] +pub struct Backup { + pub name: String, + pub content: String, +} + +#[derive(Debug, Clone, Deserialize, Default)] +pub struct BackupInfos { + pub name: String, + pub path: String, +} + +#[derive(Debug, Clone, Deserialize, Default)] +#[serde(rename_all = "camelCase")] +pub struct ChartYAML { + #[serde(default)] + pub version: String, + #[serde(default)] + pub app_version: String, +} + +#[derive(Debug, Clone, Deserialize, Default)] +pub struct BackupStatus { + pub is_backupable: bool, + pub backup_path: PathBuf, +} + +pub fn prepare_chart_backup( + kubernetes_config: P, + workspace_root_dir: T, + chart: &ChartInfo, + envs: &[(&str, &str)], + backup_resources: Vec, +) -> Result, HelmError> +where + P: AsRef, + T: AsRef, +{ + let mut backups: Vec = vec![]; + for backup_resource in backup_resources { + match kubectl_get_resource_yaml( + &kubernetes_config, + envs.to_vec(), + backup_resource.as_str(), + Some(chart.get_namespace_string().as_str()), + ) { + Ok(content) => { + if !content.to_lowercase().contains("no resources found") { + backups.push(Backup { + name: backup_resource, + content, + }); + }; + } + Err(e) => { + error!("Kubectl error: {:?}", e.message_safe()) + } + }; + } + + let mut backup_infos: Vec = vec![]; + + if backups.is_empty() { + return Ok(backup_infos); + } + + for backup in backups.clone() { + if !backup.content.is_empty() && !backup.content.contains("items: []") { + match create_yaml_backup_file( + workspace_root_dir.as_ref(), + chart.name.to_string(), + Some(backup.name.clone()), + backup.content, + ) { + Ok(path) => { + backup_infos.push(BackupInfos { + name: backup.name, + path, + }); + } + Err(e) => { + return Err(CmdError( + chart.name.clone(), + HelmCommand::UPGRADE, + CommandError::new( + format!("Error while creating YAML backup file for {}.", backup.name), + Some(e.to_string()), + None, + ), + )) + } + } + } + } + + for backup_info in backup_infos.clone() { + if let Err(e) = remove_lines_starting_with( + backup_info.path.clone(), + vec!["resourceVersion", "uid", "apiVersion: v1", "items", "kind: List"], + ) { + return Err(CmdError( + chart.name.clone(), + HelmCommand::UPGRADE, + CommandError::new( + format!("Error while editing YAML backup file {}.", backup_info.name), + Some(e.to_string()), + None, + ), + )); + } + + if let Err(e) = truncate_file_from_word(backup_info.path.clone(), "metadata") { + return Err(CmdError( + chart.name.clone(), + HelmCommand::UPGRADE, + CommandError::new( + format!("Error while editing YAML backup file {}.", backup_info.name), + Some(e.to_string()), + None, + ), + )); + } + + if let Err(e) = indent_file(backup_info.path.clone()) { + return Err(CmdError( + chart.name.clone(), + HelmCommand::UPGRADE, + CommandError::new( + format!("Error while editing YAML backup file {}.", backup_info.name), + Some(e.to_string()), + None, + ), + )); + } + + let backup_name = format!("{}-{}-q-backup", chart.name, backup_info.name); + if let Err(e) = kubectl_create_secret_from_file( + &kubernetes_config, + envs.to_vec(), + Some(chart.namespace.to_string().as_str()), + backup_name, + backup_info.name, + backup_info.path, + ) { + return Err(CmdError( + chart.name.clone(), + HelmCommand::UPGRADE, + CommandError::new(e.message_safe(), e.message_raw(), None), + )); + } + } + + Ok(backup_infos) +} + +pub fn apply_chart_backup

( + kubernetes_config: P, + workspace_root_dir: P, + envs: &[(&str, &str)], + chart: &ChartInfo, +) -> Result<(), HelmError> +where + P: AsRef, +{ + let secrets = kubectl_exec_get_secrets( + &kubernetes_config, + chart.clone().namespace.to_string().as_str(), + "", + envs.to_vec(), + ) + .map_err(|e| { + CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new(e.message_safe(), e.message_raw(), None), + ) + })? + .items; + + for secret in secrets { + if secret.metadata.name.contains("-q-backup") { + let path = match create_yaml_file_from_secret(&workspace_root_dir, secret.clone()) { + Ok(path) => path, + Err(e) => match e.message_safe().to_lowercase().contains("no content") { + true => match kubectl_delete_secret( + &kubernetes_config, + envs.to_vec(), + Some(chart.clone().namespace.to_string().as_str()), + secret.metadata.name, + ) { + Ok(_) => continue, + Err(e) => { + return Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new(e.message_safe(), e.message_raw(), None), + )) + } + }, + false => { + return Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new(e.message_safe(), e.message_raw(), None), + )) + } + }, + }; + + if let Err(e) = kubectl_apply_with_path(&kubernetes_config, envs.to_vec(), path.as_str()) { + return Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new(e.message_safe(), e.message_raw(), None), + )); + }; + + if let Err(e) = kubectl_delete_secret( + &kubernetes_config, + envs.to_vec(), + Some(chart.clone().namespace.to_string().as_str()), + secret.metadata.name, + ) { + return Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new(e.message_safe(), e.message_raw(), None), + )); + }; + } + } + + Ok(()) +} + +pub fn delete_unused_chart_backup

( + kubernetes_config: P, + envs: &[(&str, &str)], + chart: &ChartInfo, +) -> Result<(), HelmError> +where + P: AsRef, +{ + let secrets = kubectl_exec_get_secrets( + &kubernetes_config, + chart.clone().namespace.to_string().as_str(), + "", + envs.to_vec(), + ) + .map_err(|e| { + CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new(e.message_safe(), e.message_raw(), None), + ) + })? + .items; + + for secret in secrets { + if secret.metadata.name.contains("-q-backup") { + if let Err(e) = kubectl_delete_secret( + &kubernetes_config, + envs.to_vec(), + Some(chart.clone().namespace.to_string().as_str()), + secret.metadata.name, + ) { + return Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new(e.message_safe(), e.message_raw(), None), + )); + }; + } + } + + Ok(()) +} + +pub fn get_common_helm_chart_infos(chart: &ChartInfo) -> Result { + let string_path = format!("{}/Chart.yaml", chart.path); + let file = OpenOptions::new().read(true).open(string_path.as_str()).map_err(|e| { + CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new( + format!("Unable to get chart infos for {}.", chart.name.clone()), + Some(e.to_string()), + None, + ), + ) + })?; + let mut content = String::new(); + let _ = BufReader::new(file).read_to_string(&mut content); + match serde_yaml::from_str::(content.as_str()) { + Ok(chart_yaml) => Ok(chart_yaml), + Err(e) => Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new( + format!("Unable to get chart infos for {}.", chart.name.clone()), + Some(e.to_string()), + None, + ), + )), + } +} + +pub fn get_common_helm_chart_version(chart: &ChartInfo) -> Result, HelmError> { + let chart_yaml = match get_common_helm_chart_infos(chart) { + Ok(chart_yaml) => chart_yaml, + Err(e) => { + return Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new( + format!("Unable to get chart version for {}.", chart.name.clone()), + Some(e.to_string()), + None, + ), + )) + } + }; + + if !chart_yaml.app_version.is_empty() { + return match Version::parse(chart_yaml.app_version.as_str()) { + Ok(version) => Ok(Some(version)), + Err(e) => Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new( + format!("Unable to get chart version for {}.", chart.name.clone()), + Some(e.to_string()), + None, + ), + )), + }; + } + + if !chart_yaml.version.is_empty() { + return match Version::parse(chart_yaml.version.as_str()) { + Ok(version) => Ok(Some(version)), + Err(e) => Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new( + format!("Unable to get chart version for {}.", chart.name.clone()), + Some(e.to_string()), + None, + ), + )), + }; + } + + Err(CmdError( + chart.clone().name, + HelmCommand::UPGRADE, + CommandError::new_from_safe_message(format!("Unable to get chart version for {}.", chart.name.clone())), + )) +} + +pub fn prepare_chart_backup_on_upgrade

( + kubernetes_config: P, + chart: ChartInfo, + envs: &[(&str, &str)], + installed_version: Option, +) -> Result +where + P: AsRef, +{ + let mut need_backup = false; + let root_dir_path = std::env::temp_dir(); + + if chart.backup_resources.is_some() { + if installed_version.le(&get_common_helm_chart_version(&chart)?) { + if let Err(e) = prepare_chart_backup( + kubernetes_config, + root_dir_path.as_path(), + &chart, + envs, + chart.backup_resources.as_ref().unwrap().to_vec(), + ) { + return Err(e); + }; + + need_backup = true; + } + } + + Ok(BackupStatus { + is_backupable: need_backup, + backup_path: root_dir_path, + }) +} diff --git a/src/cmd/kubectl.rs b/src/cmd/kubectl.rs index 339a8261..8f9a8363 100644 --- a/src/cmd/kubectl.rs +++ b/src/cmd/kubectl.rs @@ -1,3 +1,6 @@ +use std::fmt::Debug; +use std::fs::File; +use std::io::Read; use std::path::Path; use retry::delay::Fibonacci; @@ -1204,6 +1207,30 @@ where Ok(result) } +fn kubectl_exec_raw_output

( + args: Vec<&str>, + kubernetes_config: P, + envs: Vec<(&str, &str)>, + keep_format: bool, +) -> Result +where + P: AsRef, +{ + let mut _envs = Vec::with_capacity(envs.len() + 1); + _envs.push((KUBECONFIG, kubernetes_config.as_ref().to_str().unwrap())); + _envs.extend(envs); + + let mut output_vec: Vec = Vec::with_capacity(50); + let _ = kubectl_exec_with_output(args.clone(), _envs.clone(), &mut |line| output_vec.push(line), &mut |line| { + error!("{}", line) + })?; + + match keep_format { + true => Ok(output_vec.join("\n")), + false => Ok(output_vec.join("")), + } +} + pub fn kubernetes_get_all_pdbs

( kubernetes_config: P, envs: Vec<(&str, &str)>, @@ -1245,3 +1272,98 @@ where kubectl_exec::(cmd_args, kubernetes_config, envs) } + +pub fn kubectl_get_resource_yaml

( + kubernetes_config: P, + envs: Vec<(&str, &str)>, + resource: &str, + namespace: Option<&str>, +) -> Result +where + P: AsRef, +{ + let mut cmd_args = vec!["get", resource, "-oyaml"]; + match namespace { + Some(n) => { + cmd_args.push("-n"); + cmd_args.push(n); + } + None => cmd_args.push("--all-namespaces"), + } + + kubectl_exec_raw_output(cmd_args, kubernetes_config, envs, true) +} + +pub fn kubectl_apply_with_path

( + kubernetes_config: P, + envs: Vec<(&str, &str)>, + file_path: &str, +) -> Result +where + P: AsRef, +{ + kubectl_exec_raw_output::

(vec!["apply", "-f", file_path], kubernetes_config, envs, false) +} + +pub fn kubectl_create_secret

( + kubernetes_config: P, + envs: Vec<(&str, &str)>, + namespace: Option<&str>, + secret_name: String, + key: String, + value: String, +) -> Result +where + P: AsRef, +{ + let secret_arg = format!("--from-literal={}=\"{}\"", key, value); + let mut cmd_args = vec!["create", "secret", "generic", secret_name.as_str(), secret_arg.as_str()]; + match namespace { + Some(n) => { + cmd_args.push("-n"); + cmd_args.push(n); + } + None => cmd_args.push("--all-namespaces"), + } + + kubectl_exec_raw_output(cmd_args, kubernetes_config, envs, false) +} + +pub fn kubectl_delete_secret

( + kubernetes_config: P, + envs: Vec<(&str, &str)>, + namespace: Option<&str>, + secret_name: String, +) -> Result +where + P: AsRef, +{ + let mut cmd_args = vec!["delete", "secret", secret_name.as_str()]; + match namespace { + Some(n) => { + cmd_args.push("-n"); + cmd_args.push(n); + } + None => cmd_args.push("--all-namespaces"), + } + + kubectl_exec_raw_output(cmd_args, kubernetes_config, envs, false) +} + +pub fn kubectl_create_secret_from_file

( + kubernetes_config: P, + envs: Vec<(&str, &str)>, + namespace: Option<&str>, + backup_name: String, + key: String, + file_path: String, +) -> Result +where + P: AsRef, +{ + let mut file = File::open(file_path.as_str()).unwrap(); + let mut content = String::new(); + let _ = file.read_to_string(&mut content); + + kubectl_create_secret(kubernetes_config, envs, namespace, backup_name, key, content) +} diff --git a/src/cmd/mod.rs b/src/cmd/mod.rs index 153aab46..d7ff53ec 100644 --- a/src/cmd/mod.rs +++ b/src/cmd/mod.rs @@ -1,6 +1,7 @@ pub mod command; pub mod docker; pub mod helm; +pub mod helm_utils; pub mod kubectl; pub mod structs; pub mod terraform; diff --git a/src/cmd/structs.rs b/src/cmd/structs.rs index 238024eb..0e6135a8 100644 --- a/src/cmd/structs.rs +++ b/src/cmd/structs.rs @@ -42,6 +42,7 @@ pub struct SecretItem { pub api_version: String, pub kind: String, pub metadata: SecretMetadata, + pub data: HashMap, } #[derive(Default, Debug, Clone, PartialEq, Deserialize)] diff --git a/src/fs.rs b/src/fs.rs index 7a68a48f..e35deca8 100644 --- a/src/fs.rs +++ b/src/fs.rs @@ -1,11 +1,16 @@ use std::collections::HashSet; use std::fs; -use std::fs::{create_dir_all, File}; -use std::io::{Error, ErrorKind}; +use std::fs::{create_dir_all, File, OpenOptions}; +use std::io::{BufRead, BufReader, Error, ErrorKind, Write}; use std::path::Path; +use crate::cmd::structs::SecretItem; +use crate::errors::CommandError; +use base64::decode; use flate2::write::GzEncoder; use flate2::Compression; +use itertools::Itertools; +use serde::__private::from_utf8_lossy; use std::ffi::OsStr; use walkdir::WalkDir; @@ -151,6 +156,232 @@ pub fn create_workspace_archive(working_root_dir: &str, execution_id: &str) -> R } } +pub fn create_yaml_backup_file

( + working_root_dir: P, + chart_name: String, + resource_name: Option, + content: String, +) -> Result +where + P: AsRef, +{ + let dir = working_root_dir.as_ref().join("backups"); + + if let Err(e) = create_dir_all(&dir) { + return Err(CommandError::new( + "Unable to create root dir path.".to_string(), + Some(e.to_string()), + None, + )); + } + + let root_path = dir + .to_str() + .map(|e| e.to_string()) + .ok_or_else(|| CommandError::new_from_safe_message("Unable to get backups root dir path.".to_string())); + + let string_path = match resource_name.is_some() { + true => format!( + "{}/{}-{}-q-backup.yaml", + root_path?, + chart_name, + resource_name.as_ref().unwrap() + ), + false => format!("{}/{}.yaml", root_path?, chart_name), + }; + let str_path = string_path.as_str(); + let path = Path::new(str_path); + + let mut file = match File::create(&path) { + Err(e) => { + return Err(CommandError::new( + format!("Unable to create YAML backup file for chart {}.", chart_name), + Some(e.to_string()), + None, + )) + } + Ok(file) => file, + }; + + match file.write(content.as_bytes()) { + Err(e) => Err(CommandError::new( + format!("Unable to edit YAML backup file for chart {}.", chart_name), + Some(e.to_string()), + None, + )), + Ok(_) => Ok(path.to_str().map(|e| e.to_string()).ok_or_else(|| { + CommandError::new_from_safe_message(format!( + "Unable to get YAML backup file path for chart {}.", + chart_name + )) + })?), + } +} + +pub fn remove_lines_starting_with(path: String, starters: Vec<&str>) -> Result { + let file = OpenOptions::new().read(true).open(path.as_str()).map_err(|e| { + CommandError::new(format!("Unable to open YAML backup file {}.", path), Some(e.to_string()), None) + })?; + + let mut content = BufReader::new(file.try_clone().unwrap()) + .lines() + .map(|line| line.unwrap()) + .collect::>(); + + for starter in starters { + content = content + .into_iter() + .filter(|line| !line.contains(starter)) + .collect::>() + } + + let mut file = OpenOptions::new() + .write(true) + .truncate(true) + .open(path.as_str()) + .map_err(|e| { + CommandError::new(format!("Unable to edit YAML backup file {}.", path), Some(e.to_string()), None) + })?; + + match file.write(content.join("\n").as_bytes()) { + Err(e) => Err(CommandError::new( + format!("Unable to edit YAML backup file {}.", path), + Some(e.to_string()), + None, + )), + Ok(_) => Ok(path), + } +} + +pub fn truncate_file_from_word(path: String, truncate_from: &str) -> Result { + let file = OpenOptions::new().read(true).open(path.as_str()).map_err(|e| { + CommandError::new(format!("Unable to open YAML backup file {}.", path), Some(e.to_string()), None) + })?; + + let content_vec = BufReader::new(file.try_clone().unwrap()) + .lines() + .map(|line| line.unwrap()) + .collect::>(); + + let truncate_from_index = match content_vec.iter().rposition(|line| line.contains(truncate_from)) { + None => content_vec.len(), + Some(index) => index, + }; + + let content = Vec::from(&content_vec[..truncate_from_index]).join("\n"); + + let mut file = OpenOptions::new() + .write(true) + .truncate(true) + .open(path.as_str()) + .map_err(|e| { + CommandError::new(format!("Unable to edit YAML backup file {}.", path), Some(e.to_string()), None) + })?; + + match file.write(content.as_bytes()) { + Err(e) => Err(CommandError::new( + format!("Unable to edit YAML backup file {}.", path), + Some(e.to_string()), + None, + )), + Ok(_) => Ok(path), + } +} + +pub fn indent_file(path: String) -> Result { + let file = OpenOptions::new().read(true).open(path.as_str()).map_err(|e| { + CommandError::new(format!("Unable to open YAML backup file {}.", path), Some(e.to_string()), None) + })?; + + let file_content = BufReader::new(file.try_clone().unwrap()) + .lines() + .map(|line| line.unwrap()) + .collect::>(); + + let content = file_content.iter().map(|line| line[2..].to_string()).join("\n"); + + let mut file = OpenOptions::new() + .write(true) + .truncate(true) + .open(path.as_str()) + .map_err(|e| { + CommandError::new(format!("Unable to edit YAML backup file {}.", path), Some(e.to_string()), None) + })?; + + match file.write(content.as_bytes()) { + Err(e) => Err(CommandError::new( + format!("Unable to edit YAML backup file {}.", path), + Some(e.to_string()), + None, + )), + Ok(_) => Ok(path), + } +} + +pub fn list_yaml_backup_files

(working_root_dir: P) -> Result, CommandError> +where + P: AsRef, +{ + let files = WalkDir::new(working_root_dir) + .follow_links(true) + .into_iter() + .filter_map(|e| e.ok()); + let mut backup_paths: Vec = vec![]; + for file in files { + if file + .file_name() + .to_str() + .ok_or_else(|| { + CommandError::new_from_safe_message(format!("Unable to get YAML backup file name {:?}.", file)) + })? + .to_string() + .contains("-q-backup.yaml") + { + backup_paths.push( + file.path() + .to_str() + .ok_or_else(|| { + CommandError::new_from_safe_message(format!("Unable to get YAML backup file name {:?}.", file)) + })? + .to_string(), + ) + } + } + + if backup_paths.is_empty() { + return Err(CommandError::new_from_safe_message( + "Unable to get YAML backup files".to_string(), + )); + } + + Ok(backup_paths) +} + +pub fn create_yaml_file_from_secret

(working_root_dir: P, secret: SecretItem) -> Result +where + P: AsRef, +{ + let message = format!("Unable to decode secret {}", secret.metadata.name); + let secret_data = secret.data.values().next(); + let secret_content = match secret_data.is_some() { + true => secret_data.unwrap().to_string(), + false => return Err(CommandError::new_from_safe_message(message)), + }; + + let content = match decode(secret_content) { + Ok(bytes) => from_utf8_lossy(&bytes[1..bytes.len() - 1]).to_string(), + Err(e) => return Err(CommandError::new(message, Some(e.to_string()), None)), + }; + match create_yaml_backup_file(working_root_dir.as_ref(), secret.metadata.name.clone(), None, content) { + Ok(path) => Ok(path), + Err(e) => Err(CommandError::new( + format!("Unable to create backup file from secret {}", secret.metadata.name), + Some(e.to_string()), + None, + )), + } +} + #[cfg(test)] mod tests { extern crate tempdir; @@ -159,7 +390,6 @@ mod tests { use flate2::read::GzDecoder; use std::collections::HashSet; use std::fs::File; - use std::io::prelude::*; use std::io::BufReader; use tempdir::TempDir; @@ -252,4 +482,102 @@ mod tests { tmp_files.into_iter().for_each(drop); tmp_dir.close().expect("error closing temporary directory"); } + + #[test] + fn test_backup_cleaning() { + let content = r#" + apiVersion: cert-manager.io/v1 + kind: Certificate + metadata: + annotations: + meta.helm.sh/release-name: cert-manager-configs + meta.helm.sh/release-namespace: cert-manager + creationTimestamp: "2021-11-04T10:26:27Z" + generation: 2 + labels: + app.kubernetes.io/managed-by: Helm + name: qovery + namespace: qovery + resourceVersion: "28347460" + uid: 509aad5f-db2d-44c3-b03b-beaf144118e2 + spec: + dnsNames: + - 'qovery' + issuerRef: + kind: ClusterIssuer + name: qovery + secretName: qovery + status: + conditions: + - lastTransitionTime: "2021-11-30T15:33:03Z" + message: Certificate is up to date and has not expired + reason: Ready + status: "True" + type: Ready + notAfter: "2022-04-29T13:34:51Z" + notBefore: "2022-01-29T13:34:52Z" + renewalTime: "2022-03-30T13:34:51Z" + revision: 3 + "#; + + let tmp_dir = TempDir::new("workspace_directory").expect("error creating temporary dir"); + let mut file_path = create_yaml_backup_file( + tmp_dir.path().to_str().unwrap(), + "test".to_string(), + Some("test".to_string()), + content.to_string(), + ) + .expect("No such file"); + file_path = remove_lines_starting_with(file_path, vec!["resourceVersion", "uid"]).unwrap(); + + let file = OpenOptions::new() + .read(true) + .write(true) + .open(file_path) + .expect("file doesn't exist"); + + let result = BufReader::new(file.try_clone().unwrap()) + .lines() + .map(|line| line.unwrap()) + .collect::>() + .join("\n"); + + let new_content = r#" + apiVersion: cert-manager.io/v1 + kind: Certificate + metadata: + annotations: + meta.helm.sh/release-name: cert-manager-configs + meta.helm.sh/release-namespace: cert-manager + creationTimestamp: "2021-11-04T10:26:27Z" + generation: 2 + labels: + app.kubernetes.io/managed-by: Helm + name: qovery + namespace: qovery + spec: + dnsNames: + - 'qovery' + issuerRef: + kind: ClusterIssuer + name: qovery + secretName: qovery + status: + conditions: + - lastTransitionTime: "2021-11-30T15:33:03Z" + message: Certificate is up to date and has not expired + reason: Ready + status: "True" + type: Ready + notAfter: "2022-04-29T13:34:51Z" + notBefore: "2022-01-29T13:34:52Z" + renewalTime: "2022-03-30T13:34:51Z" + revision: 3 + "# + .to_string(); + + assert_eq!(result, new_content); + drop(file); + tmp_dir.close().expect("error closing temporary directory"); + } } diff --git a/tests/helm/cert_manager.rs b/tests/helm/cert_manager.rs new file mode 100644 index 00000000..f356bc21 --- /dev/null +++ b/tests/helm/cert_manager.rs @@ -0,0 +1,348 @@ +use base64::decode; +use qovery_engine::cloud_provider::helm::{ + deploy_charts_levels, ChartInfo, ChartSetValue, CommonChart, HelmChart, HelmChartNamespaces, +}; +use qovery_engine::cmd::helm::Helm; +use qovery_engine::cmd::kubectl::{kubectl_exec_delete_namespace, kubectl_exec_get_secrets, kubectl_get_resource_yaml}; +use qovery_engine::cmd::structs::SecretItem; +use qovery_engine::fs::list_yaml_backup_files; +use serde_derive::Deserialize; +use serde_derive::Serialize; +use std::fs; +use std::fs::OpenOptions; +use std::io::{BufRead, BufReader}; +use std::path::{Path, PathBuf}; +use std::str::from_utf8; +use std::thread::sleep; +use std::time::Duration; +use tempdir::TempDir; +use test_utilities::utilities::FuncTestsSecrets; + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Certificate { + pub api_version: String, + pub items: Vec, + pub kind: String, + pub metadata: Metadata2, +} + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Item { + pub api_version: String, + pub kind: String, + pub metadata: Metadata, + pub spec: Spec, + pub status: Status, +} + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Metadata { + pub annotations: Annotations, + pub creation_timestamp: String, + pub generation: i64, + pub labels: Labels, + pub name: String, + pub namespace: String, +} + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Annotations { + #[serde(rename = "meta.helm.sh/release-name")] + pub meta_helm_sh_release_name: String, + #[serde(rename = "meta.helm.sh/release-namespace")] + pub meta_helm_sh_release_namespace: String, + #[serde(default, rename = "kubectl.kubernetes.io/last-applied-configuration")] + pub last_applied_configuration: String, +} + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Labels { + #[serde(rename = "app.kubernetes.io/managed-by")] + pub app_kubernetes_io_managed_by: String, +} + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Spec { + pub dns_names: Vec, + pub issuer_ref: IssuerRef, + pub secret_name: String, +} + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct IssuerRef { + pub kind: String, + pub name: String, +} + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Status {} + +#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Metadata2 { + pub self_link: String, +} + +fn cert_manager_conf() -> (Helm, PathBuf, CommonChart, CommonChart) { + let vault_secrets = FuncTestsSecrets::new(); + let mut kube_config = dirs::home_dir().unwrap(); + kube_config.push(".kube/config"); + let helm = Helm::new(kube_config.to_str().unwrap(), &[]).unwrap(); + let cert_manager = CommonChart { + chart_info: ChartInfo { + name: "cert-manager".to_string(), + path: "lib/common/bootstrap/charts/cert-manager".to_string(), + namespace: HelmChartNamespaces::CertManager, + values: vec![ + ChartSetValue { + key: "installCRDs".to_string(), + value: "true".to_string(), + }, + ChartSetValue { + key: "replicaCount".to_string(), + value: "1".to_string(), + }, + // https://cert-manager.io/docs/configuration/acme/dns01/#setting-nameservers-for-dns01-self-check + ChartSetValue { + key: "extraArgs".to_string(), + value: "{--dns01-recursive-nameservers-only,--dns01-recursive-nameservers=1.1.1.1:53\\,8.8.8.8:53}" + .to_string(), + }, + ChartSetValue { + key: "prometheus.servicemonitor.enabled".to_string(), + // Due to cycle, prometheus need tls certificate from cert manager, and enabling this will require + // prometheus to be already installed + value: "false".to_string(), + }, + ChartSetValue { + key: "prometheus.servicemonitor.prometheusInstance".to_string(), + value: "qovery".to_string(), + }, + ], + ..Default::default() + }, + }; + + let cert_manager_config = CommonChart { + chart_info: ChartInfo { + name: "cert-manager-configs".to_string(), + path: "lib/common/bootstrap/charts/cert-manager-configs".to_string(), + namespace: HelmChartNamespaces::CertManager, + values: vec![ + ChartSetValue { + key: "externalDnsProvider".to_string(), + value: "cloudflare".to_string(), + }, + ChartSetValue { + key: "provider.cloudflare.apiToken".to_string(), + value: vault_secrets.CLOUDFLARE_TOKEN.unwrap().to_string(), + }, + ChartSetValue { + key: "provider.cloudflare.email".to_string(), + value: vault_secrets.CLOUDFLARE_ID.as_ref().unwrap().to_string(), + }, + ChartSetValue { + key: "acme.letsEncrypt.emailReport".to_string(), + value: vault_secrets.CLOUDFLARE_ID.unwrap().to_string(), + }, + ChartSetValue { + key: "acme.letsEncrypt.acmeUrl".to_string(), + value: "https://acme-staging-v02.api.letsencrypt.org/directory".to_string(), + }, + ], + ..Default::default() + }, + }; + + (helm, kube_config, cert_manager, cert_manager_config) +} + +#[cfg(feature = "test-with-kube")] +#[test] +fn test_create_chart_backup() { + let (helm, kube_config, cert_manager, cert_manager_config) = cert_manager_conf(); + + let lvl_1: Vec> = vec![Box::new(cert_manager.clone())]; + let lvl_2: Vec> = vec![Box::new(cert_manager_config.clone())]; + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_1], false).map_err(|_| assert!(false)); + + sleep(Duration::from_secs(30)); + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_2], false).map_err(|_| assert!(false)); + + let tmp_dir = TempDir::new("workspace_directory").expect("error creating temporary dir"); + let root_dir_path = Path::new(tmp_dir.path()); + let backup_infos = helm + .prepare_chart_backup(root_dir_path, &cert_manager.chart_info, &vec![], vec!["cert".to_string()]) + .unwrap(); + let secrets = kubectl_exec_get_secrets( + kube_config.as_path(), + cert_manager.chart_info.namespace.to_string().as_str(), + "", + vec![], + ) + .unwrap(); + assert_eq!(backup_infos.len(), 1); + + for backup_info in backup_infos { + let backup_name = format!("{}-{}-q-backup", &cert_manager.chart_info.name, backup_info.name.clone()); + assert!(Path::new(backup_info.path.as_str()).exists()); + let secret = secrets + .items + .clone() + .into_iter() + .filter(|secret| secret.metadata.name == backup_name) + .collect::>(); + let secret_content = decode(secret[0].data[&backup_info.name].clone()).unwrap(); + let content = from_utf8(secret_content.as_slice()).unwrap().to_string(); + let file = OpenOptions::new().read(true).open(backup_info.path.as_str()).unwrap(); + let file_content = BufReader::new(file.try_clone().unwrap()) + .lines() + .map(|line| line.unwrap()) + .collect::>() + .join("\n"); + assert_ne!(content.len(), 0); + assert_ne!(file_content.len(), 0); + assert!(content.contains(&file_content)); + } + + let _ = kubectl_exec_delete_namespace(kube_config.as_path(), "cert-manager", vec![]); +} + +#[cfg(feature = "test-with-kube")] +#[test] +fn test_apply_chart_backup() { + let (helm, kube_config, cert_manager, cert_manager_config) = cert_manager_conf(); + + let lvl_1: Vec> = vec![Box::new(cert_manager.clone())]; + let lvl_2: Vec> = vec![Box::new(cert_manager_config.clone())]; + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_1], false).map_err(|_| assert!(false)); + + sleep(Duration::from_secs(30)); + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_2], false).map_err(|_| assert!(false)); + + let tmp_dir = TempDir::new("workspace_directory").expect("error creating temporary dir"); + let root_dir_path = Path::new(tmp_dir.path()); + let _ = helm + .prepare_chart_backup( + root_dir_path, + cert_manager_config.get_chart_info(), + &vec![], + vec!["cert".to_string()], + ) + .unwrap(); + + match helm.apply_chart_backup(root_dir_path, &vec![], cert_manager_config.get_chart_info()) { + Err(_) => { + assert!(false) + } + Ok(..) => { + let string_path = list_yaml_backup_files(root_dir_path).unwrap().first().unwrap().clone(); + let str_path = string_path.as_str(); + let path = Path::new(str_path); + let backup_string = fs::read_to_string(path).unwrap(); + let cert_string = kubectl_get_resource_yaml( + kube_config.as_path(), + vec![], + "cert", + Some(cert_manager_config.namespace().as_str()), + ) + .unwrap(); + let backup_cert = serde_yaml::from_str::(backup_string.as_str()).unwrap(); + let cert = serde_yaml::from_str::(cert_string.as_str()).unwrap(); + assert_eq!(backup_cert.items.first().unwrap().spec, cert.items.first().unwrap().spec) + } + }; + + let _ = kubectl_exec_delete_namespace(kube_config.as_path(), "cert-manager", vec![]); +} + +#[cfg(feature = "test-with-kube")] +#[test] +fn test_should_not_create_chart_backup() { + let (helm, kube_config, cert_manager, cert_manager_config) = cert_manager_conf(); + + let lvl_1: Vec> = vec![Box::new(cert_manager.clone())]; + let lvl_2: Vec> = vec![Box::new(cert_manager_config.clone())]; + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_1], false).map_err(|_| assert!(false)); + + sleep(Duration::from_secs(30)); + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_2], false).map_err(|_| assert!(false)); + + let tmp_dir = TempDir::new("workspace_directory").expect("error creating temporary dir"); + let root_dir_path = Path::new(tmp_dir.path()); + + // trying to create a backup from an unknown (toto) resource + let backup_infos = helm + .prepare_chart_backup(root_dir_path, &cert_manager.chart_info, &vec![], vec!["toto".to_string()]) + .unwrap(); + + assert_eq!(backup_infos.len(), 0); + + let _ = kubectl_exec_delete_namespace(kube_config.as_path(), "cert-manager", vec![]); +} + +#[cfg(feature = "test-with-kube")] +#[test] +fn test_should_apply_chart_backup() { + let (helm, kube_config, cert_manager, mut cert_manager_config) = cert_manager_conf(); + + let lvl_1: Vec> = vec![Box::new(cert_manager.clone())]; + let lvl_2: Vec> = vec![Box::new(cert_manager_config.clone())]; + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_1], false).map_err(|_| assert!(false)); + + sleep(Duration::from_secs(30)); + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_2], false).map_err(|_| assert!(false)); + + sleep(Duration::from_secs(30)); + + cert_manager_config.chart_info.backup_resources = Some(vec!["cert".to_string()]); + + let lvl_2_bis: Vec> = vec![Box::new(cert_manager_config.clone())]; + + let _ = deploy_charts_levels(kube_config.as_path(), &vec![], vec![lvl_2_bis], false).map_err(|_| assert!(false)); + + let secrets = kubectl_exec_get_secrets( + kube_config.as_path(), + cert_manager.chart_info.namespace.to_string().as_str(), + "", + vec![], + ) + .unwrap(); + + let cert_secret = secrets + .items + .into_iter() + .filter(|secret| secret.metadata.name == "cert-manager-configs-cert-q-backup") + .collect::>(); + + assert_eq!(cert_secret.len(), 0); + + let cert_string = kubectl_get_resource_yaml( + kube_config.as_path(), + vec![], + "cert", + Some(cert_manager_config.namespace().as_str()), + ) + .unwrap(); + let cert = serde_yaml::from_str::(cert_string.as_str()).unwrap(); + + assert_ne!(cert.items[0].metadata.annotations.last_applied_configuration, ""); + + let _ = kubectl_exec_delete_namespace(kube_config.as_path(), "cert-manager", vec![]); +} diff --git a/tests/helm/mod.rs b/tests/helm/mod.rs new file mode 100644 index 00000000..3a720572 --- /dev/null +++ b/tests/helm/mod.rs @@ -0,0 +1 @@ +mod cert_manager; diff --git a/tests/lib.rs b/tests/lib.rs index bbc13eb3..48aaa913 100644 --- a/tests/lib.rs +++ b/tests/lib.rs @@ -3,4 +3,5 @@ extern crate maplit; mod aws; mod digitalocean; +mod helm; mod scaleway;