---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.8.0
creationTimestamp: null
name: certificates.anthos-cert-manager.io
spec:
group: anthos-cert-manager.io
names:
kind: Certificate
listKind: CertificateList
plural: certificates
singular: certificate
scope: Namespaced
versions:
- name: v1
schema:
openAPIV3Schema:
description: Certificate is the Schema for the certificates API
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: CertificateSpec defines the desired state of Certificate
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 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
type: string
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. 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.
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. 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.
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`,`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.
type: string
encoding:
description: The private key cryptography standards (PKCS) encoding
for this certificate's private key to be encoded in. If provided,
allowed values are `PKCS1` and `PKCS8` standing for PKCS#1 and
PKCS#8, respectively. Defaults to `PKCS1` if not specified.
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.
enum:
- Never
- Always
type: string
size:
description: Size is the key bit size of the corresponding private
key for this certificate. If `algorithm` is set to `RSA`, valid
values are `2048`, `4096` or `8192`, and will default to `2048`
if not specified. If `algorithm` is set to `ECDSA`, valid values
are `256`, `384` or `521`, and will default to `256` if not
specified. If `algorithm` is set to `Ed25519`, Size is ignored.
No other values are allowed.
type: integer
type: object
renewBefore:
description: How long before the currently issued certificate's expiry
cert-manager should renew the certificate. The default is 2/3 of
the issued certificate's duration. Minimum accepted value is 5 minutes.
Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration
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
secretTemplate:
description: SecretTemplate defines annotations and labels to be copied
to the Certificate's Secret. Labels and annotations on the Secret
will be changed as they appear on the SecretTemplate when added
or removed. SecretTemplate annotations are added in conjunction
with, and cannot overwrite, the base set of annotations cert-manager
sets on the Certificate's Secret.
properties:
annotations:
additionalProperties:
type: string
description: Annotations is a key value map to be copied to the
target Kubernetes Secret.
type: object
labels:
additionalProperties:
type: string
description: Labels is a key value map to be copied to the target
Kubernetes Secret.
type: object
type: object
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
required:
- issuerRef
- secretName
type: object
status:
description: CertificateStatus defines the observed state of Certificate
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
observedGeneration:
description: If set, this represents the .metadata.generation
that the condition was set based upon. For instance, if .metadata.generation
is currently 12, but the .status.condition[x].observedGeneration
is 9, the condition is out of date with respect to the current
state of the Certificate.
format: int64
type: integer
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
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
failedIssuanceAttempts:
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).
type: integer
lastFailureTime:
description: LastFailureTime is the time as recorded by the Certificate
controller of the most recent failure to complete a CertificateRequest
for this Certificate resource. If set, cert-manager will not re-request
another Certificate until 1 hour has elapsed from this time.
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
type: object
served: true
storage: true
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []
