github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/package-examples/cert-manager-basic/crds/customresourcedefinition-certificates-cert-manager-io.yaml (about)

     1  # Source: cert-manager/templates/crd-templates.yaml
     2  apiVersion: apiextensions.k8s.io/v1
     3  kind: CustomResourceDefinition
     4  metadata:
     5    name: certificates.cert-manager.io
     6    labels:
     7      app: 'cert-manager'
     8      app.kubernetes.io/name: 'cert-manager'
     9      app.kubernetes.io/instance: 'cert-manager'
    10      # Generated labels
    11      app.kubernetes.io/version: "v1.8.2"
    12  spec:
    13    group: cert-manager.io
    14    names:
    15      kind: Certificate
    16      listKind: CertificateList
    17      plural: certificates
    18      shortNames:
    19        - cert
    20        - certs
    21      singular: certificate
    22      categories:
    23        - cert-manager
    24    scope: Namespaced
    25    versions:
    26      - name: v1
    27        subresources:
    28          status: {}
    29        additionalPrinterColumns:
    30          - jsonPath: .status.conditions[?(@.type=="Ready")].status
    31            name: Ready
    32            type: string
    33          - jsonPath: .spec.secretName
    34            name: Secret
    35            type: string
    36          - jsonPath: .spec.issuerRef.name
    37            name: Issuer
    38            priority: 1
    39            type: string
    40          - jsonPath: .status.conditions[?(@.type=="Ready")].message
    41            name: Status
    42            priority: 1
    43            type: string
    44          - jsonPath: .metadata.creationTimestamp
    45            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.
    46            name: Age
    47            type: date
    48        schema:
    49          openAPIV3Schema:
    50            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`)."
    51            type: object
    52            required:
    53              - spec
    54            properties:
    55              apiVersion:
    56                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'
    57                type: string
    58              kind:
    59                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'
    60                type: string
    61              metadata:
    62                type: object
    63              spec:
    64                description: Desired state of the Certificate resource.
    65                type: object
    66                required:
    67                  - issuerRef
    68                  - secretName
    69                properties:
    70                  additionalOutputFormats:
    71                    description: AdditionalOutputFormats defines extra output formats of the private key and signed certificate chain to be written to this Certificate's target Secret. This is an Alpha Feature and is only enabled with the `--feature-gates=AdditionalCertificateOutputFormats=true` option on both the controller and webhook components.
    72                    type: array
    73                    items:
    74                      description: CertificateAdditionalOutputFormat defines an additional output format of a Certificate resource. These contain supplementary data formats of the signed certificate chain and paired private key.
    75                      type: object
    76                      required:
    77                        - type
    78                      properties:
    79                        type:
    80                          description: Type is the name of the format type that should be written to the Certificate's target Secret.
    81                          type: string
    82                          enum:
    83                            - DER
    84                            - CombinedPEM
    85                  commonName:
    86                    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'
    87                    type: string
    88                  dnsNames:
    89                    description: DNSNames is a list of DNS subjectAltNames to be set on the Certificate.
    90                    type: array
    91                    items:
    92                      type: string
    93                  duration:
    94                    description: The requested 'duration' (i.e. lifetime) of the Certificate. This option may be ignored/overridden by some issuer types. If unset this defaults to 90 days. Certificate will be renewed either 2/3 through its duration or `renewBefore` period before its expiry, whichever is later. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
    95                    type: string
    96                  emailAddresses:
    97                    description: EmailAddresses is a list of email subjectAltNames to be set on the Certificate.
    98                    type: array
    99                    items:
   100                      type: string
   101                  encodeUsagesInRequest:
   102                    description: EncodeUsagesInRequest controls whether key usages should be present in the CertificateRequest
   103                    type: boolean
   104                  ipAddresses:
   105                    description: IPAddresses is a list of IP address subjectAltNames to be set on the Certificate.
   106                    type: array
   107                    items:
   108                      type: string
   109                  isCA:
   110                    description: IsCA will mark this Certificate as valid for certificate signing. This will automatically add the `cert sign` usage to the list of `usages`.
   111                    type: boolean
   112                  issuerRef:
   113                    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.
   114                    type: object
   115                    required:
   116                      - name
   117                    properties:
   118                      group:
   119                        description: Group of the resource being referred to.
   120                        type: string
   121                      kind:
   122                        description: Kind of the resource being referred to.
   123                        type: string
   124                      name:
   125                        description: Name of the resource being referred to.
   126                        type: string
   127                  keystores:
   128                    description: Keystores configures additional keystore output formats stored in the `secretName` Secret resource.
   129                    type: object
   130                    properties:
   131                      jks:
   132                        description: JKS configures options for storing a JKS keystore in the `spec.secretName` Secret resource.
   133                        type: object
   134                        required:
   135                          - create
   136                          - passwordSecretRef
   137                        properties:
   138                          create:
   139                            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
   140                            type: boolean
   141                          passwordSecretRef:
   142                            description: PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore.
   143                            type: object
   144                            required:
   145                              - name
   146                            properties:
   147                              key:
   148                                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.
   149                                type: string
   150                              name:
   151                                description: 'Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   152                                type: string
   153                      pkcs12:
   154                        description: PKCS12 configures options for storing a PKCS12 keystore in the `spec.secretName` Secret resource.
   155                        type: object
   156                        required:
   157                          - create
   158                          - passwordSecretRef
   159                        properties:
   160                          create:
   161                            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
   162                            type: boolean
   163                          passwordSecretRef:
   164                            description: PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore.
   165                            type: object
   166                            required:
   167                              - name
   168                            properties:
   169                              key:
   170                                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.
   171                                type: string
   172                              name:
   173                                description: 'Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
   174                                type: string
   175                  privateKey:
   176                    description: Options to control private keys used for the Certificate.
   177                    type: object
   178                    properties:
   179                      algorithm:
   180                        description: Algorithm is the private key algorithm of the corresponding private key for this certificate. If provided, allowed values are either `RSA`,`Ed25519` or `ECDSA` If `algorithm` is specified and `size` is not provided, key size of 256 will be used for `ECDSA` key algorithm and key size of 2048 will be used for `RSA` key algorithm. key size is ignored when using the `Ed25519` key algorithm.
   181                        type: string
   182                        enum:
   183                          - RSA
   184                          - ECDSA
   185                          - Ed25519
   186                      encoding:
   187                        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.
   188                        type: string
   189                        enum:
   190                          - PKCS1
   191                          - PKCS8
   192                      rotationPolicy:
   193                        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.
   194                        type: string
   195                        enum:
   196                          - Never
   197                          - Always
   198                      size:
   199                        description: Size is the key bit size of the corresponding private key for this certificate. If `algorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `algorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. If `algorithm` is set to `Ed25519`, Size is ignored. No other values are allowed.
   200                        type: integer
   201                  renewBefore:
   202                    description: How long before the currently issued certificate's expiry cert-manager should renew the certificate. The default is 2/3 of the issued certificate's duration. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
   203                    type: string
   204                  revisionHistoryLimit:
   205                    description: revisionHistoryLimit is the maximum number of CertificateRequest revisions that are maintained in the Certificate's history. Each revision represents a single `CertificateRequest` created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number. If set, revisionHistoryLimit must be a value of `1` or greater. If unset (`nil`), revisions will not be garbage collected. Default value is `nil`.
   206                    type: integer
   207                    format: int32
   208                  secretName:
   209                    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.
   210                    type: string
   211                  secretTemplate:
   212                    description: SecretTemplate defines annotations and labels to be copied to the Certificate's Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate's Secret.
   213                    type: object
   214                    properties:
   215                      annotations:
   216                        description: Annotations is a key value map to be copied to the target Kubernetes Secret.
   217                        type: object
   218                        additionalProperties:
   219                          type: string
   220                      labels:
   221                        description: Labels is a key value map to be copied to the target Kubernetes Secret.
   222                        type: object
   223                        additionalProperties:
   224                          type: string
   225                  subject:
   226                    description: Full X509 name specification (https://golang.org/pkg/crypto/x509/pkix/#Name).
   227                    type: object
   228                    properties:
   229                      countries:
   230                        description: Countries to be used on the Certificate.
   231                        type: array
   232                        items:
   233                          type: string
   234                      localities:
   235                        description: Cities to be used on the Certificate.
   236                        type: array
   237                        items:
   238                          type: string
   239                      organizationalUnits:
   240                        description: Organizational Units to be used on the Certificate.
   241                        type: array
   242                        items:
   243                          type: string
   244                      organizations:
   245                        description: Organizations to be used on the Certificate.
   246                        type: array
   247                        items:
   248                          type: string
   249                      postalCodes:
   250                        description: Postal codes to be used on the Certificate.
   251                        type: array
   252                        items:
   253                          type: string
   254                      provinces:
   255                        description: State/Provinces to be used on the Certificate.
   256                        type: array
   257                        items:
   258                          type: string
   259                      serialNumber:
   260                        description: Serial number to be used on the Certificate.
   261                        type: string
   262                      streetAddresses:
   263                        description: Street addresses to be used on the Certificate.
   264                        type: array
   265                        items:
   266                          type: string
   267                  uris:
   268                    description: URIs is a list of URI subjectAltNames to be set on the Certificate.
   269                    type: array
   270                    items:
   271                      type: string
   272                  usages:
   273                    description: Usages is the set of x509 usages that are requested for the certificate. Defaults to `digital signature` and `key encipherment` if not specified.
   274                    type: array
   275                    items:
   276                      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"'
   277                      type: string
   278                      enum:
   279                        - signing
   280                        - digital signature
   281                        - content commitment
   282                        - key encipherment
   283                        - key agreement
   284                        - data encipherment
   285                        - cert sign
   286                        - crl sign
   287                        - encipher only
   288                        - decipher only
   289                        - any
   290                        - server auth
   291                        - client auth
   292                        - code signing
   293                        - email protection
   294                        - s/mime
   295                        - ipsec end system
   296                        - ipsec tunnel
   297                        - ipsec user
   298                        - timestamping
   299                        - ocsp signing
   300                        - microsoft sgc
   301                        - netscape sgc
   302              status:
   303                description: Status of the Certificate. This is set and managed automatically.
   304                type: object
   305                properties:
   306                  conditions:
   307                    description: List of status conditions to indicate the status of certificates. Known condition types are `Ready` and `Issuing`.
   308                    type: array
   309                    items:
   310                      description: CertificateCondition contains condition information for an Certificate.
   311                      type: object
   312                      required:
   313                        - status
   314                        - type
   315                      properties:
   316                        lastTransitionTime:
   317                          description: LastTransitionTime is the timestamp corresponding to the last status change of this condition.
   318                          type: string
   319                          format: date-time
   320                        message:
   321                          description: Message is a human readable description of the details of the last transition, complementing reason.
   322                          type: string
   323                        observedGeneration:
   324                          description: If set, this represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.condition[x].observedGeneration is 9, the condition is out of date with respect to the current state of the Certificate.
   325                          type: integer
   326                          format: int64
   327                        reason:
   328                          description: Reason is a brief machine readable explanation for the condition's last transition.
   329                          type: string
   330                        status:
   331                          description: Status of the condition, one of (`True`, `False`, `Unknown`).
   332                          type: string
   333                          enum:
   334                            - "True"
   335                            - "False"
   336                            - Unknown
   337                        type:
   338                          description: Type of the condition, known values are (`Ready`, `Issuing`).
   339                          type: string
   340                    x-kubernetes-list-map-keys:
   341                      - type
   342                    x-kubernetes-list-type: map
   343                  failedIssuanceAttempts:
   344                    description: The number of continuous failed issuance attempts up till now. This field gets removed (if set) on a successful issuance and gets set to 1 if unset and an issuance has failed. If an issuance has failed, the delay till the next issuance will be calculated using formula time.Hour * 2 ^ (failedIssuanceAttempts - 1).
   345                    type: integer
   346                  lastFailureTime:
   347                    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.
   348                    type: string
   349                    format: date-time
   350                  nextPrivateKeySecretName:
   351                    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.
   352                    type: string
   353                  notAfter:
   354                    description: The expiration time of the certificate stored in the secret named by this resource in `spec.secretName`.
   355                    type: string
   356                    format: date-time
   357                  notBefore:
   358                    description: The time after which the certificate stored in the secret named by this resource in spec.secretName is valid.
   359                    type: string
   360                    format: date-time
   361                  renewalTime:
   362                    description: RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled.
   363                    type: string
   364                    format: date-time
   365                  revision:
   366                    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."
   367                    type: integer
   368        served: true
   369        storage: true
   370