infra/crds-catalog
1
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

auto-update crds catalog

Browse Source
This commit is contained in:
Drone Shipper 2024-06-05 16:38:23 +00:00
parent 354e19abaf
commit 51a95a9a1b
6 changed files with 1184 additions and 866 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
cert-manager.io/certificate_v1.json
View File

@ -1,20 +1,20 @@
{ {
"description": "A Certificate resource should be created to ensure an up to date and signed X.509 certificate is stored in the Kubernetes Secret resource named in `spec.secretName`. \n The stored certificate will be renewed before it expires (as configured by `spec.renewBefore`).", "description": "A Certificate resource should be created to ensure an up to date and signed\nX.509 certificate is stored in the Kubernetes Secret resource named in `spec.secretName`.\n\n\nThe stored certificate will be renewed before it expires (as configured by `spec.renewBefore`).",
"type": "object", "type": "object",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "Specification of the desired state of the Certificate resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "description": "Specification of the desired state of the Certificate resource.\nhttps://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
"type": "object", "type": "object",
"required": [ "required": [
"issuerRef", "issuerRef",
@ -22,17 +22,17 @@
], ],
"properties": { "properties": {
"additionalOutputFormats": { "additionalOutputFormats": {
"description": "Defines extra output formats of the private key and signed certificate chain to be written to this Certificate's target Secret. \n This is an Alpha Feature and is only enabled with the `--feature-gates=AdditionalCertificateOutputFormats=true` option set on both the controller and webhook components.", "description": "Defines extra output formats of the private key and signed certificate chain\nto be written to this Certificate's target Secret.\n\n\nThis is a Beta Feature enabled by default. It can be disabled with the\n`--feature-gates=AdditionalCertificateOutputFormats=false` option set on both\nthe controller and webhook components.",
"type": "array", "type": "array",
"items": { "items": {
"description": "CertificateAdditionalOutputFormat defines an additional output format of a Certificate resource. These contain supplementary data formats of the signed certificate chain and paired private key.", "description": "CertificateAdditionalOutputFormat defines an additional output format of a\nCertificate resource. These contain supplementary data formats of the signed\ncertificate chain and paired private key.",
"type": "object", "type": "object",
"required": [ "required": [
"type" "type"
], ],
"properties": { "properties": {
"type": { "type": {
"description": "Type is the name of the format type that should be written to the Certificate's target Secret.", "description": "Type is the name of the format type that should be written to the\nCertificate's target Secret.",
"type": "string", "type": "string",
"enum": [ "enum": [
"DER", "DER",
@ -44,7 +44,7 @@
} }
}, },
"commonName": { "commonName": {
"description": "Requested common name X509 certificate subject attribute. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 NOTE: TLS clients will ignore this value when any subject alternative name is set (see https://tools.ietf.org/html/rfc6125#section-6.4.4). \n Should have a length of 64 characters or fewer to avoid generating invalid CSRs. Cannot be set if the `literalSubject` field is set.", "description": "Requested common name X509 certificate subject attribute.\nMore info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6\nNOTE: TLS clients will ignore this value when any subject alternative name is\nset (see https://tools.ietf.org/html/rfc6125#section-6.4.4).\n\n\nShould have a length of 64 characters or fewer to avoid generating invalid CSRs.\nCannot be set if the `literalSubject` field is set.",
"type": "string" "type": "string"
}, },
"dnsNames": { "dnsNames": {
@ -55,7 +55,7 @@
} }
}, },
"duration": { "duration": {
"description": "Requested 'duration' (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute. \n If unset, this defaults to 90 days. Minimum accepted duration is 1 hour. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.", "description": "Requested 'duration' (i.e. lifetime) of the Certificate. Note that the\nissuer may choose to ignore the requested duration, just like any other\nrequested attribute.\n\n\nIf unset, this defaults to 90 days.\nMinimum accepted duration is 1 hour.\nValue must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.",
"type": "string" "type": "string"
}, },
"emailAddresses": { "emailAddresses": {
@ -66,7 +66,7 @@
} }
}, },
"encodeUsagesInRequest": { "encodeUsagesInRequest": {
"description": "Whether the KeyUsage and ExtKeyUsage extensions should be set in the encoded CSR. \n This option defaults to true, and should only be disabled if the target issuer does not support CSRs with these X509 KeyUsage/ ExtKeyUsage extensions.", "description": "Whether the KeyUsage and ExtKeyUsage extensions should be set in the encoded CSR.\n\n\nThis option defaults to true, and should only be disabled if the target\nissuer does not support CSRs with these X509 KeyUsage/ ExtKeyUsage extensions.",
"type": "boolean" "type": "boolean"
}, },
"ipAddresses": { "ipAddresses": {
@ -77,11 +77,11 @@
} }
}, },
"isCA": { "isCA": {
"description": "Requested basic constraints isCA value. The isCA value is used to set the `isCA` field on the created CertificateRequest resources. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute. \n If true, this will automatically add the `cert sign` usage to the list of requested `usages`.", "description": "Requested basic constraints isCA value.\nThe isCA value is used to set the `isCA` field on the created CertificateRequest\nresources. Note that the issuer may choose to ignore the requested isCA value, just\nlike any other requested attribute.\n\n\nIf true, this will automatically add the `cert sign` usage to the list\nof requested `usages`.",
"type": "boolean" "type": "boolean"
}, },
"issuerRef": { "issuerRef": {
"description": "Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace. \n The `name` field of the reference must always be specified.", "description": "Reference to the issuer responsible for issuing the certificate.\nIf the issuer is namespace-scoped, it must be in the same namespace\nas the Certificate. If the issuer is cluster-scoped, it can be used\nfrom any namespace.\n\n\nThe `name` field of the reference must always be specified.",
"type": "object", "type": "object",
"required": [ "required": [
"name" "name"
@ -107,30 +107,34 @@
"type": "object", "type": "object",
"properties": { "properties": {
"jks": { "jks": {
"description": "JKS configures options for storing a JKS keystore in the `spec.secretName` Secret resource.", "description": "JKS configures options for storing a JKS keystore in the\n`spec.secretName` Secret resource.",
"type": "object", "type": "object",
"required": [ "required": [
"create", "create",
"passwordSecretRef" "passwordSecretRef"
], ],
"properties": { "properties": {
"alias": {
"description": "Alias specifies the alias of the key in the keystore, required by the JKS format.\nIf not provided, the default alias `certificate` will be used.",
"type": "string"
},
"create": { "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 be updated immediately. If the issuer provided a CA certificate, a file named `truststore.jks` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority", "description": "Create enables JKS keystore creation for the Certificate.\nIf true, a file named `keystore.jks` will be created in the target\nSecret resource, encrypted using the password stored in\n`passwordSecretRef`.\nThe keystore file will be updated immediately.\nIf the issuer provided a CA certificate, a file named `truststore.jks`\nwill also be created in the target Secret resource, encrypted using the\npassword stored in `passwordSecretRef`\ncontaining the issuing Certificate Authority",
"type": "boolean" "type": "boolean"
}, },
"passwordSecretRef": { "passwordSecretRef": {
"description": "PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the JKS keystore.", "description": "PasswordSecretRef is a reference to a key in a Secret resource\ncontaining the password used to encrypt the JKS keystore.",
"type": "object", "type": "object",
"required": [ "required": [
"name" "name"
], ],
"properties": { "properties": {
"key": { "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.", "description": "The key of the entry in the Secret resource's `data` field to be used.\nSome instances of this field may be defaulted, in others it may be\nrequired.",
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "description": "Name of the resource being referred to.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string" "type": "string"
} }
}, },
@ -140,7 +144,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"pkcs12": { "pkcs12": {
"description": "PKCS12 configures options for storing a PKCS12 keystore in the `spec.secretName` Secret resource.", "description": "PKCS12 configures options for storing a PKCS12 keystore in the\n`spec.secretName` Secret resource.",
"type": "object", "type": "object",
"required": [ "required": [
"create", "create",
@ -148,29 +152,29 @@
], ],
"properties": { "properties": {
"create": { "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 be updated immediately. If the issuer provided a CA certificate, a file named `truststore.p12` will also be created in the target Secret resource, encrypted using the password stored in `passwordSecretRef` containing the issuing Certificate Authority", "description": "Create enables PKCS12 keystore creation for the Certificate.\nIf true, a file named `keystore.p12` will be created in the target\nSecret resource, encrypted using the password stored in\n`passwordSecretRef`.\nThe keystore file will be updated immediately.\nIf the issuer provided a CA certificate, a file named `truststore.p12` will\nalso be created in the target Secret resource, encrypted using the\npassword stored in `passwordSecretRef` containing the issuing Certificate\nAuthority",
"type": "boolean" "type": "boolean"
}, },
"passwordSecretRef": { "passwordSecretRef": {
"description": "PasswordSecretRef is a reference to a key in a Secret resource containing the password used to encrypt the PKCS12 keystore.", "description": "PasswordSecretRef is a reference to a key in a Secret resource\ncontaining the password used to encrypt the PKCS12 keystore.",
"type": "object", "type": "object",
"required": [ "required": [
"name" "name"
], ],
"properties": { "properties": {
"key": { "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.", "description": "The key of the entry in the Secret resource's `data` field to be used.\nSome instances of this field may be defaulted, in others it may be\nrequired.",
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the resource being referred to. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "description": "Name of the resource being referred to.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
"type": "string" "type": "string"
} }
}, },
"additionalProperties": false "additionalProperties": false
}, },
"profile": { "profile": {
"description": "Profile specifies the key and certificate encryption algorithms and the HMAC algorithm used to create the PKCS12 keystore. Default value is `LegacyRC2` for backward compatibility. \n If provided, allowed values are: `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20. `LegacyDES`: Less secure algorithm. Use this option for maximal compatibility. `Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms (eg. because of company policy). Please note that the security of the algorithm is not that important in reality, because the unencrypted certificate and private key are also stored in the Secret.", "description": "Profile specifies the key and certificate encryption algorithms and the HMAC algorithm\nused to create the PKCS12 keystore. Default value is `LegacyRC2` for backward compatibility.\n\n\nIf provided, allowed values are:\n`LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20.\n`LegacyDES`: Less secure algorithm. Use this option for maximal compatibility.\n`Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms\n(eg. because of company policy). Please note that the security of the algorithm is not that important\nin reality, because the unencrypted certificate and private key are also stored in the Secret.",
"type": "string", "type": "string",
"enum": [ "enum": [
"LegacyRC2", "LegacyRC2",
@ -185,11 +189,11 @@
"additionalProperties": false "additionalProperties": false
}, },
"literalSubject": { "literalSubject": {
"description": "Requested X.509 certificate subject, represented using the LDAP \"String Representation of a Distinguished Name\" [1]. Important: the LDAP string format also specifies the order of the attributes in the subject, this is important when issuing certs for LDAP authentication. Example: `CN=foo,DC=corp,DC=example,DC=com` More info [1]: https://datatracker.ietf.org/doc/html/rfc4514 More info: https://github.com/cert-manager/cert-manager/issues/3203 More info: https://github.com/cert-manager/cert-manager/issues/4424 \n Cannot be set if the `subject` or `commonName` field is set. This is an Alpha Feature and is only enabled with the `--feature-gates=LiteralCertificateSubject=true` option set on both the controller and webhook components.", "description": "Requested X.509 certificate subject, represented using the LDAP \"String\nRepresentation of a Distinguished Name\" [1].\nImportant: the LDAP string format also specifies the order of the attributes\nin the subject, this is important when issuing certs for LDAP authentication.\nExample: `CN=foo,DC=corp,DC=example,DC=com`\nMore info [1]: https://datatracker.ietf.org/doc/html/rfc4514\nMore info: https://github.com/cert-manager/cert-manager/issues/3203\nMore info: https://github.com/cert-manager/cert-manager/issues/4424\n\n\nCannot be set if the `subject` or `commonName` field is set.",
"type": "string" "type": "string"
}, },
"nameConstraints": { "nameConstraints": {
"description": "x.509 certificate NameConstraint extension which MUST NOT be used in a non-CA certificate. More Info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.10 \n This is an Alpha Feature and is only enabled with the `--feature-gates=NameConstraints=true` option set on both the controller and webhook components.", "description": "x.509 certificate NameConstraint extension which MUST NOT be used in a non-CA certificate.\nMore Info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.10\n\n\nThis is an Alpha Feature and is only enabled with the\n`--feature-gates=NameConstraints=true` option set on both\nthe controller and webhook components.",
"type": "object", "type": "object",
"properties": { "properties": {
"critical": { "critical": {
@ -197,7 +201,7 @@
"type": "boolean" "type": "boolean"
}, },
"excluded": { "excluded": {
"description": "Excluded contains the constraints which must be disallowed. Any name matching a restriction in the excluded field is invalid regardless of information appearing in the permitted", "description": "Excluded contains the constraints which must be disallowed. Any name matching a\nrestriction in the excluded field is invalid regardless\nof information appearing in the permitted",
"type": "object", "type": "object",
"properties": { "properties": {
"dnsDomains": { "dnsDomains": {
@ -215,7 +219,7 @@
} }
}, },
"ipRanges": { "ipRanges": {
"description": "IPRanges is a list of IP Ranges that are permitted or excluded. This should be a valid CIDR notation.", "description": "IPRanges is a list of IP Ranges that are permitted or excluded.\nThis should be a valid CIDR notation.",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
@ -250,7 +254,7 @@
} }
}, },
"ipRanges": { "ipRanges": {
"description": "IPRanges is a list of IP Ranges that are permitted or excluded. This should be a valid CIDR notation.", "description": "IPRanges is a list of IP Ranges that are permitted or excluded.\nThis should be a valid CIDR notation.",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
@ -270,17 +274,17 @@
"additionalProperties": false "additionalProperties": false
}, },
"otherNames": { "otherNames": {
"description": "`otherNames` is an escape hatch for SAN that allows any type. We currently restrict the support to string like otherNames, cf RFC 5280 p 37 Any UTF8 String valued otherName can be passed with by setting the keys oid: x.x.x.x and UTF8Value: somevalue for `otherName`. Most commonly this would be UPN set with oid: 1.3.6.1.4.1.311.20.2.3 You should ensure that any OID passed is valid for the UTF8String type as we do not explicitly validate this.", "description": "`otherNames` is an escape hatch for SAN that allows any type. We currently restrict the support to string like otherNames, cf RFC 5280 p 37\nAny UTF8 String valued otherName can be passed with by setting the keys oid: x.x.x.x and UTF8Value: somevalue for `otherName`.\nMost commonly this would be UPN set with oid: 1.3.6.1.4.1.311.20.2.3\nYou should ensure that any OID passed is valid for the UTF8String type as we do not explicitly validate this.",
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",
"properties": { "properties": {
"oid": { "oid": {
"description": "OID is the object identifier for the otherName SAN. The object identifier must be expressed as a dotted string, for example, \"1.2.840.113556.1.4.221\".", "description": "OID is the object identifier for the otherName SAN.\nThe object identifier must be expressed as a dotted string, for\nexample, \"1.2.840.113556.1.4.221\".",
"type": "string" "type": "string"
}, },
"utf8Value": { "utf8Value": {
"description": "utf8Value is the string value of the otherName SAN. The utf8Value accepts any valid UTF8 string to set as value for the otherName SAN.", "description": "utf8Value is the string value of the otherName SAN.\nThe utf8Value accepts any valid UTF8 string to set as value for the otherName SAN.",
"type": "string" "type": "string"
} }
}, },
@ -288,11 +292,11 @@
} }
}, },
"privateKey": { "privateKey": {
"description": "Private key options. These include the key algorithm and size, the used encoding and the rotation policy.", "description": "Private key options. These include the key algorithm and size, the used\nencoding and the rotation policy.",
"type": "object", "type": "object",
"properties": { "properties": {
"algorithm": { "algorithm": {
"description": "Algorithm is the private key algorithm of the corresponding private key for this certificate. \n If provided, allowed values are either `RSA`, `ECDSA` or `Ed25519`. If `algorithm` is specified and `size` is not provided, key size of 2048 will be used for `RSA` key algorithm and key size of 256 will be used for `ECDSA` key algorithm. key size is ignored when using the `Ed25519` key algorithm.", "description": "Algorithm is the private key algorithm of the corresponding private key\nfor this certificate.\n\n\nIf provided, allowed values are either `RSA`, `ECDSA` or `Ed25519`.\nIf `algorithm` is specified and `size` is not provided,\nkey size of 2048 will be used for `RSA` key algorithm and\nkey size of 256 will be used for `ECDSA` key algorithm.\nkey size is ignored when using the `Ed25519` key algorithm.",
"type": "string", "type": "string",
"enum": [ "enum": [
"RSA", "RSA",
@ -301,7 +305,7 @@
] ]
}, },
"encoding": { "encoding": {
"description": "The private key cryptography standards (PKCS) encoding for this certificate's private key to be encoded in. \n If provided, allowed values are `PKCS1` and `PKCS8` standing for PKCS#1 and PKCS#8, respectively. Defaults to `PKCS1` if not specified.", "description": "The private key cryptography standards (PKCS) encoding for this\ncertificate's private key to be encoded in.\n\n\nIf provided, allowed values are `PKCS1` and `PKCS8` standing for PKCS#1\nand PKCS#8, respectively.\nDefaults to `PKCS1` if not specified.",
"type": "string", "type": "string",
"enum": [ "enum": [
"PKCS1", "PKCS1",
@ -309,7 +313,7 @@
] ]
}, },
"rotationPolicy": { "rotationPolicy": {
"description": "RotationPolicy controls how private keys should be regenerated when a re-issuance is being processed. \n If set to `Never`, a private key will only be generated if one does not already exist in the target `spec.secretName`. If one does exists but it does not have the correct algorithm or size, a warning will be raised to await user intervention. If set to `Always`, a private key matching the specified requirements will be generated whenever a re-issuance occurs. Default is `Never` for backward compatibility.", "description": "RotationPolicy controls how private keys should be regenerated when a\nre-issuance is being processed.\n\n\nIf set to `Never`, a private key will only be generated if one does not\nalready exist in the target `spec.secretName`. If one does exists but it\ndoes not have the correct algorithm or size, a warning will be raised\nto await user intervention.\nIf set to `Always`, a private key matching the specified requirements\nwill be generated whenever a re-issuance occurs.\nDefault is `Never` for backward compatibility.",
"type": "string", "type": "string",
"enum": [ "enum": [
"Never", "Never",
@ -317,27 +321,27 @@
] ]
}, },
"size": { "size": {
"description": "Size is the key bit size of the corresponding private key for this certificate. \n If `algorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`, and will default to `2048` if not specified. If `algorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`, and will default to `256` if not specified. If `algorithm` is set to `Ed25519`, Size is ignored. No other values are allowed.", "description": "Size is the key bit size of the corresponding private key for this certificate.\n\n\nIf `algorithm` is set to `RSA`, valid values are `2048`, `4096` or `8192`,\nand will default to `2048` if not specified.\nIf `algorithm` is set to `ECDSA`, valid values are `256`, `384` or `521`,\nand will default to `256` if not specified.\nIf `algorithm` is set to `Ed25519`, Size is ignored.\nNo other values are allowed.",
"type": "integer" "type": "integer"
} }
}, },
"additionalProperties": false "additionalProperties": false
}, },
"renewBefore": { "renewBefore": {
"description": "How long before the currently issued certificate's expiry cert-manager should renew the certificate. For example, if a certificate is valid for 60 minutes, and `renewBefore=10m`, cert-manager will begin to attempt to renew the certificate 50 minutes after it was issued (i.e. when there are 10 minutes remaining until the certificate is no longer valid). \n NOTE: The actual lifetime of the issued certificate is used to determine the renewal time. If an issuer returns a certificate with a different lifetime than the one requested, cert-manager will use the lifetime of the issued certificate. \n If unset, this defaults to 1/3 of the issued certificate's lifetime. Minimum accepted value is 5 minutes. Value must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.", "description": "How long before the currently issued certificate's expiry cert-manager should\nrenew the certificate. For example, if a certificate is valid for 60 minutes,\nand `renewBefore=10m`, cert-manager will begin to attempt to renew the certificate\n50 minutes after it was issued (i.e. when there are 10 minutes remaining until\nthe certificate is no longer valid).\n\n\nNOTE: The actual lifetime of the issued certificate is used to determine the\nrenewal time. If an issuer returns a certificate with a different lifetime than\nthe one requested, cert-manager will use the lifetime of the issued certificate.\n\n\nIf unset, this defaults to 1/3 of the issued certificate's lifetime.\nMinimum accepted value is 5 minutes.\nValue must be in units accepted by Go time.ParseDuration https://golang.org/pkg/time/#ParseDuration.",
"type": "string" "type": "string"
}, },
"revisionHistoryLimit": { "revisionHistoryLimit": {
"description": "The maximum number of CertificateRequest revisions that are maintained in the Certificate's history. Each revision represents a single `CertificateRequest` created by this Certificate, either when it was created, renewed, or Spec was changed. Revisions will be removed by oldest first if the number of revisions exceeds this number. \n If set, revisionHistoryLimit must be a value of `1` or greater. If unset (`nil`), revisions will not be garbage collected. Default value is `nil`.", "description": "The maximum number of CertificateRequest revisions that are maintained in\nthe Certificate's history. Each revision represents a single `CertificateRequest`\ncreated by this Certificate, either when it was created, renewed, or Spec\nwas changed. Revisions will be removed by oldest first if the number of\nrevisions exceeds this number.\n\n\nIf set, revisionHistoryLimit must be a value of `1` or greater.\nIf unset (`nil`), revisions will not be garbage collected.\nDefault value is `nil`.",
"type": "integer", "type": "integer",
"format": "int32" "format": "int32"
}, },
"secretName": { "secretName": {
"description": "Name of the Secret resource that will be automatically created and managed by this Certificate resource. It will be populated with a private key and certificate, signed by the denoted issuer. The Secret resource lives in the same namespace as the Certificate resource.", "description": "Name of the Secret resource that will be automatically created and\nmanaged by this Certificate resource. It will be populated with a\nprivate key and certificate, signed by the denoted issuer. The Secret\nresource lives in the same namespace as the Certificate resource.",
"type": "string" "type": "string"
}, },
"secretTemplate": { "secretTemplate": {
"description": "Defines annotations and labels to be copied to the Certificate's Secret. Labels and annotations on the Secret will be changed as they appear on the SecretTemplate when added or removed. SecretTemplate annotations are added in conjunction with, and cannot overwrite, the base set of annotations cert-manager sets on the Certificate's Secret.", "description": "Defines annotations and labels to be copied to the Certificate's Secret.\nLabels and annotations on the Secret will be changed as they appear on the\nSecretTemplate when added or removed. SecretTemplate annotations are added\nin conjunction with, and cannot overwrite, the base set of annotations\ncert-manager sets on the Certificate's Secret.",
"type": "object", "type": "object",
"properties": { "properties": {
"annotations": { "annotations": {
@ -358,7 +362,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"subject": { "subject": {
"description": "Requested set of X509 certificate subject attributes. More info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6 \n The common name attribute is specified separately in the `commonName` field. Cannot be set if the `literalSubject` field is set.", "description": "Requested set of X509 certificate subject attributes.\nMore info: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6\n\n\nThe common name attribute is specified separately in the `commonName` field.\nCannot be set if the `literalSubject` field is set.",
"type": "object", "type": "object",
"properties": { "properties": {
"countries": { "countries": {
@ -425,10 +429,10 @@
} }
}, },
"usages": { "usages": {
"description": "Requested key usages and extended key usages. These usages are used to set the `usages` field on the created CertificateRequest resources. If `encodeUsagesInRequest` is unset or set to `true`, the usages will additionally be encoded in the `request` field which contains the CSR blob. \n If unset, defaults to `digital signature` and `key encipherment`.", "description": "Requested key usages and extended key usages.\nThese usages are used to set the `usages` field on the created CertificateRequest\nresources. If `encodeUsagesInRequest` is unset or set to `true`, the usages\nwill additionally be encoded in the `request` field which contains the CSR blob.\n\n\nIf unset, defaults to `digital signature` and `key encipherment`.",
"type": "array", "type": "array",
"items": { "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 \n Valid KeyUsage values are as follows: \"signing\", \"digital signature\", \"content commitment\", \"key encipherment\", \"key agreement\", \"data encipherment\", \"cert sign\", \"crl sign\", \"encipher only\", \"decipher only\", \"any\", \"server auth\", \"client auth\", \"code signing\", \"email protection\", \"s/mime\", \"ipsec end system\", \"ipsec tunnel\", \"ipsec user\", \"timestamping\", \"ocsp signing\", \"microsoft sgc\", \"netscape sgc\"", "description": "KeyUsage specifies valid usage contexts for keys.\nSee:\nhttps://tools.ietf.org/html/rfc5280#section-4.2.1.3\nhttps://tools.ietf.org/html/rfc5280#section-4.2.1.12\n\n\nValid KeyUsage values are as follows:\n\"signing\",\n\"digital signature\",\n\"content commitment\",\n\"key encipherment\",\n\"key agreement\",\n\"data encipherment\",\n\"cert sign\",\n\"crl sign\",\n\"encipher only\",\n\"decipher only\",\n\"any\",\n\"server auth\",\n\"client auth\",\n\"code signing\",\n\"email protection\",\n\"s/mime\",\n\"ipsec end system\",\n\"ipsec tunnel\",\n\"ipsec user\",\n\"timestamping\",\n\"ocsp signing\",\n\"microsoft sgc\",\n\"netscape sgc\"",
"type": "string", "type": "string",
"enum": [ "enum": [
"signing", "signing",
@ -461,11 +465,11 @@
"additionalProperties": false "additionalProperties": false
}, },
"status": { "status": {
"description": "Status of the Certificate. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "description": "Status of the Certificate.\nThis is set and managed automatically.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
"type": "object", "type": "object",
"properties": { "properties": {
"conditions": { "conditions": {
"description": "List of status conditions to indicate the status of certificates. Known condition types are `Ready` and `Issuing`.", "description": "List of status conditions to indicate the status of certificates.\nKnown condition types are `Ready` and `Issuing`.",
"type": "array", "type": "array",
"items": { "items": {
"description": "CertificateCondition contains condition information for an Certificate.", "description": "CertificateCondition contains condition information for an Certificate.",
@ -476,21 +480,21 @@
], ],
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "LastTransitionTime is the timestamp corresponding to the last status change of this condition.", "description": "LastTransitionTime is the timestamp corresponding to the last status\nchange of this condition.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"message": { "message": {
"description": "Message is a human readable description of the details of the last transition, complementing reason.", "description": "Message is a human readable description of the details of the last\ntransition, complementing reason.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "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.", "description": "If set, this represents the .metadata.generation that the condition was\nset based upon.\nFor instance, if .metadata.generation is currently 12, but the\n.status.condition[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the Certificate.",
"type": "integer", "type": "integer",
"format": "int64" "format": "int64"
}, },
"reason": { "reason": {
"description": "Reason is a brief machine readable explanation for the condition's last transition.", "description": "Reason is a brief machine readable explanation for the condition's last\ntransition.",
"type": "string" "type": "string"
}, },
"status": { "status": {
@ -515,35 +519,35 @@
"x-kubernetes-list-type": "map" "x-kubernetes-list-type": "map"
}, },
"failedIssuanceAttempts": { "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).", "description": "The number of continuous failed issuance attempts up till now. This\nfield gets removed (if set) on a successful issuance and gets set to\n1 if unset and an issuance has failed. If an issuance has failed, the\ndelay till the next issuance will be calculated using formula\ntime.Hour * 2 ^ (failedIssuanceAttempts - 1).",
"type": "integer" "type": "integer"
}, },
"lastFailureTime": { "lastFailureTime": {
"description": "LastFailureTime is set only if the lastest issuance for this Certificate failed and contains the time of the failure. If an issuance has failed, the delay till the next issuance will be calculated using formula time.Hour * 2 ^ (failedIssuanceAttempts - 1). If the latest issuance has succeeded this field will be unset.", "description": "LastFailureTime is set only if the lastest issuance for this\nCertificate failed and contains the time of the failure. If an\nissuance has failed, the delay till the next issuance will be\ncalculated using formula time.Hour * 2 ^ (failedIssuanceAttempts -\n1). If the latest issuance has succeeded this field will be unset.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"nextPrivateKeySecretName": { "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.", "description": "The name of the Secret resource containing the private key to be used\nfor the next certificate iteration.\nThe keymanager controller will automatically set this field if the\n`Issuing` condition is set to `True`.\nIt will automatically unset this field when the Issuing condition is\nnot set or False.",
"type": "string" "type": "string"
}, },
"notAfter": { "notAfter": {
"description": "The expiration time of the certificate stored in the secret named by this resource in `spec.secretName`.", "description": "The expiration time of the certificate stored in the secret named\nby this resource in `spec.secretName`.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"notBefore": { "notBefore": {
"description": "The time after which the certificate stored in the secret named by this resource in `spec.secretName` is valid.", "description": "The time after which the certificate stored in the secret named\nby this resource in `spec.secretName` is valid.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"renewalTime": { "renewalTime": {
"description": "RenewalTime is the time at which the certificate will be next renewed. If not set, no upcoming renewal is scheduled.", "description": "RenewalTime is the time at which the certificate will be next\nrenewed.\nIf not set, no upcoming renewal is scheduled.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"revision": { "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.", "description": "The current 'revision' of the certificate as issued.\n\n\nWhen a CertificateRequest resource is created, it will have the\n`cert-manager.io/certificate-revision` set to one greater than the\ncurrent value of this field.\n\n\nUpon issuance, this field will be set to the value of the annotation\non the CertificateRequest resource used to issue the certificate.\n\n\nPersisting the value on the CertificateRequest resource allows the\ncertificates controller to know whether a request is part of an old\nissuance or if it is part of the ongoing revision's issuance by\nchecking if the revision value in the annotation is greater than this\nfield.",
"type": "integer" "type": "integer"
} }
}, },

46
cert-manager.io/certificaterequest_v1.json
View File

@ -1,20 +1,20 @@
{ {
"description": "A CertificateRequest is used to request a signed certificate from one of the configured issuers. \n All fields within the CertificateRequest's `spec` are immutable after creation. A CertificateRequest will either succeed or fail, as denoted by its `Ready` status condition and its `status.failureTime` field. \n A CertificateRequest is a one-shot resource, meaning it represents a single point in time request for a certificate and cannot be re-used.", "description": "A CertificateRequest is used to request a signed certificate from one of the\nconfigured issuers.\n\n\nAll fields within the CertificateRequest's `spec` are immutable after creation.\nA CertificateRequest will either succeed or fail, as denoted by its `Ready` status\ncondition and its `status.failureTime` field.\n\n\nA CertificateRequest is a one-shot resource, meaning it represents a single\npoint in time request for a certificate and cannot be re-used.",
"type": "object", "type": "object",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "Specification of the desired state of the CertificateRequest resource. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "description": "Specification of the desired state of the CertificateRequest resource.\nhttps://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
"type": "object", "type": "object",
"required": [ "required": [
"issuerRef", "issuerRef",
@ -22,11 +22,11 @@
], ],
"properties": { "properties": {
"duration": { "duration": {
"description": "Requested 'duration' (i.e. lifetime) of the Certificate. Note that the issuer may choose to ignore the requested duration, just like any other requested attribute.", "description": "Requested 'duration' (i.e. lifetime) of the Certificate. Note that the\nissuer may choose to ignore the requested duration, just like any other\nrequested attribute.",
"type": "string" "type": "string"
}, },
"extra": { "extra": {
"description": "Extra contains extra attributes of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.", "description": "Extra contains extra attributes of the user that created the CertificateRequest.\nPopulated by the cert-manager webhook on creation and immutable.",
"type": "object", "type": "object",
"additionalProperties": { "additionalProperties": {
"type": "array", "type": "array",
@ -36,7 +36,7 @@
} }
}, },
"groups": { "groups": {
"description": "Groups contains group membership of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.", "description": "Groups contains group membership of the user that created the CertificateRequest.\nPopulated by the cert-manager webhook on creation and immutable.",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
@ -44,11 +44,11 @@
"x-kubernetes-list-type": "atomic" "x-kubernetes-list-type": "atomic"
}, },
"isCA": { "isCA": {
"description": "Requested basic constraints isCA value. Note that the issuer may choose to ignore the requested isCA value, just like any other requested attribute. \n NOTE: If the CSR in the `Request` field has a BasicConstraints extension, it must have the same isCA value as specified here. \n If true, this will automatically add the `cert sign` usage to the list of requested `usages`.", "description": "Requested basic constraints isCA value. Note that the issuer may choose\nto ignore the requested isCA value, just like any other requested attribute.\n\n\nNOTE: If the CSR in the `Request` field has a BasicConstraints extension,\nit must have the same isCA value as specified here.\n\n\nIf true, this will automatically add the `cert sign` usage to the list\nof requested `usages`.",
"type": "boolean" "type": "boolean"
}, },
"issuerRef": { "issuerRef": {
"description": "Reference to the issuer responsible for issuing the certificate. If the issuer is namespace-scoped, it must be in the same namespace as the Certificate. If the issuer is cluster-scoped, it can be used from any namespace. \n The `name` field of the reference must always be specified.", "description": "Reference to the issuer responsible for issuing the certificate.\nIf the issuer is namespace-scoped, it must be in the same namespace\nas the Certificate. If the issuer is cluster-scoped, it can be used\nfrom any namespace.\n\n\nThe `name` field of the reference must always be specified.",
"type": "object", "type": "object",
"required": [ "required": [
"name" "name"
@ -70,19 +70,19 @@
"additionalProperties": false "additionalProperties": false
}, },
"request": { "request": {
"description": "The PEM-encoded X.509 certificate signing request to be submitted to the issuer for signing. \n If the CSR has a BasicConstraints extension, its isCA attribute must match the `isCA` value of this CertificateRequest. If the CSR has a KeyUsage extension, its key usages must match the key usages in the `usages` field of this CertificateRequest. If the CSR has a ExtKeyUsage extension, its extended key usages must match the extended key usages in the `usages` field of this CertificateRequest.", "description": "The PEM-encoded X.509 certificate signing request to be submitted to the\nissuer for signing.\n\n\nIf the CSR has a BasicConstraints extension, its isCA attribute must\nmatch the `isCA` value of this CertificateRequest.\nIf the CSR has a KeyUsage extension, its key usages must match the\nkey usages in the `usages` field of this CertificateRequest.\nIf the CSR has a ExtKeyUsage extension, its extended key usages\nmust match the extended key usages in the `usages` field of this\nCertificateRequest.",
"type": "string", "type": "string",
"format": "byte" "format": "byte"
}, },
"uid": { "uid": {
"description": "UID contains the uid of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.", "description": "UID contains the uid of the user that created the CertificateRequest.\nPopulated by the cert-manager webhook on creation and immutable.",
"type": "string" "type": "string"
}, },
"usages": { "usages": {
"description": "Requested key usages and extended key usages. \n NOTE: If the CSR in the `Request` field has uses the KeyUsage or ExtKeyUsage extension, these extensions must have the same values as specified here without any additional values. \n If unset, defaults to `digital signature` and `key encipherment`.", "description": "Requested key usages and extended key usages.\n\n\nNOTE: If the CSR in the `Request` field has uses the KeyUsage or\nExtKeyUsage extension, these extensions must have the same values\nas specified here without any additional values.\n\n\nIf unset, defaults to `digital signature` and `key encipherment`.",
"type": "array", "type": "array",
"items": { "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 \n Valid KeyUsage values are as follows: \"signing\", \"digital signature\", \"content commitment\", \"key encipherment\", \"key agreement\", \"data encipherment\", \"cert sign\", \"crl sign\", \"encipher only\", \"decipher only\", \"any\", \"server auth\", \"client auth\", \"code signing\", \"email protection\", \"s/mime\", \"ipsec end system\", \"ipsec tunnel\", \"ipsec user\", \"timestamping\", \"ocsp signing\", \"microsoft sgc\", \"netscape sgc\"", "description": "KeyUsage specifies valid usage contexts for keys.\nSee:\nhttps://tools.ietf.org/html/rfc5280#section-4.2.1.3\nhttps://tools.ietf.org/html/rfc5280#section-4.2.1.12\n\n\nValid KeyUsage values are as follows:\n\"signing\",\n\"digital signature\",\n\"content commitment\",\n\"key encipherment\",\n\"key agreement\",\n\"data encipherment\",\n\"cert sign\",\n\"crl sign\",\n\"encipher only\",\n\"decipher only\",\n\"any\",\n\"server auth\",\n\"client auth\",\n\"code signing\",\n\"email protection\",\n\"s/mime\",\n\"ipsec end system\",\n\"ipsec tunnel\",\n\"ipsec user\",\n\"timestamping\",\n\"ocsp signing\",\n\"microsoft sgc\",\n\"netscape sgc\"",
"type": "string", "type": "string",
"enum": [ "enum": [
"signing", "signing",
@ -112,28 +112,28 @@
} }
}, },
"username": { "username": {
"description": "Username contains the name of the user that created the CertificateRequest. Populated by the cert-manager webhook on creation and immutable.", "description": "Username contains the name of the user that created the CertificateRequest.\nPopulated by the cert-manager webhook on creation and immutable.",
"type": "string" "type": "string"
} }
}, },
"additionalProperties": false "additionalProperties": false
}, },
"status": { "status": {
"description": "Status of the CertificateRequest. This is set and managed automatically. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "description": "Status of the CertificateRequest.\nThis is set and managed automatically.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
"type": "object", "type": "object",
"properties": { "properties": {
"ca": { "ca": {
"description": "The PEM encoded X.509 certificate of the signer, also known as the CA (Certificate Authority). This is set on a best-effort basis by different issuers. If not set, the CA is assumed to be unknown/not available.", "description": "The PEM encoded X.509 certificate of the signer, also known as the CA\n(Certificate Authority).\nThis is set on a best-effort basis by different issuers.\nIf not set, the CA is assumed to be unknown/not available.",
"type": "string", "type": "string",
"format": "byte" "format": "byte"
}, },
"certificate": { "certificate": {
"description": "The PEM encoded X.509 certificate resulting from the certificate signing request. If not set, the CertificateRequest has either not been completed or has failed. More information on failure can be found by checking the `conditions` field.", "description": "The PEM encoded X.509 certificate resulting from the certificate\nsigning request.\nIf not set, the CertificateRequest has either not been completed or has\nfailed. More information on failure can be found by checking the\n`conditions` field.",
"type": "string", "type": "string",
"format": "byte" "format": "byte"
}, },
"conditions": { "conditions": {
"description": "List of status conditions to indicate the status of a CertificateRequest. Known condition types are `Ready`, `InvalidRequest`, `Approved` and `Denied`.", "description": "List of status conditions to indicate the status of a CertificateRequest.\nKnown condition types are `Ready`, `InvalidRequest`, `Approved` and `Denied`.",
"type": "array", "type": "array",
"items": { "items": {
"description": "CertificateRequestCondition contains condition information for a CertificateRequest.", "description": "CertificateRequestCondition contains condition information for a CertificateRequest.",
@ -144,16 +144,16 @@
], ],
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "LastTransitionTime is the timestamp corresponding to the last status change of this condition.", "description": "LastTransitionTime is the timestamp corresponding to the last status\nchange of this condition.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"message": { "message": {
"description": "Message is a human readable description of the details of the last transition, complementing reason.", "description": "Message is a human readable description of the details of the last\ntransition, complementing reason.",
"type": "string" "type": "string"
}, },
"reason": { "reason": {
"description": "Reason is a brief machine readable explanation for the condition's last transition.", "description": "Reason is a brief machine readable explanation for the condition's last\ntransition.",
"type": "string" "type": "string"
}, },
"status": { "status": {
@ -166,7 +166,7 @@
] ]
}, },
"type": { "type": {
"description": "Type of the condition, known values are (`Ready`, `InvalidRequest`, `Approved`, `Denied`).", "description": "Type of the condition, known values are (`Ready`, `InvalidRequest`,\n`Approved`, `Denied`).",
"type": "string" "type": "string"
} }
}, },
@ -178,7 +178,7 @@
"x-kubernetes-list-type": "map" "x-kubernetes-list-type": "map"
}, },
"failureTime": { "failureTime": {
"description": "FailureTime stores the time that this CertificateRequest failed. This is used to influence garbage collection and back-off.", "description": "FailureTime stores the time that this CertificateRequest failed. This is\nused to influence garbage collection and back-off.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
} }

512
cert-manager.io/challenge_v1.json
View File

File diff suppressed because it is too large Load Diff

665
cert-manager.io/clusterissuer_v1.json
View File

File diff suppressed because it is too large Load Diff

665
cert-manager.io/issuer_v1.json
View File

File diff suppressed because it is too large Load Diff

46
cert-manager.io/order_v1.json
View File

@ -7,11 +7,11 @@
], ],
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -25,29 +25,29 @@
], ],
"properties": { "properties": {
"commonName": { "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.", "description": "CommonName is the common name as specified on the DER encoded CSR.\nIf specified, this value must also be present in `dnsNames` or `ipAddresses`.\nThis field must match the corresponding field on the DER encoded CSR.",
"type": "string" "type": "string"
}, },
"dnsNames": { "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.", "description": "DNSNames is a list of DNS names that should be included as part of the Order\nvalidation process.\nThis field must match the corresponding field on the DER encoded CSR.",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"duration": { "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.", "description": "Duration is the duration for the not after date for the requested certificate.\nthis is set on order creation as pe the ACME spec.",
"type": "string" "type": "string"
}, },
"ipAddresses": { "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.", "description": "IPAddresses is a list of IP addresses that should be included as part of the Order\nvalidation process.\nThis field must match the corresponding field on the DER encoded CSR.",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"issuerRef": { "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.", "description": "IssuerRef references a properly configured ACME-type Issuer which should\nbe used to create this Order.\nIf the Issuer does not exist, processing will be retried.\nIf the Issuer is not an 'ACME' Issuer, an error will be returned and the\nOrder will be marked as failed.",
"type": "object", "type": "object",
"required": [ "required": [
"name" "name"
@ -69,7 +69,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"request": { "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.", "description": "Certificate signing request bytes in DER encoding.\nThis will be used when finalizing the order.\nThis field must be set on the order.",
"type": "string", "type": "string",
"format": "byte" "format": "byte"
} }
@ -80,20 +80,20 @@
"type": "object", "type": "object",
"properties": { "properties": {
"authorizations": { "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.", "description": "Authorizations contains data returned from the ACME server on what\nauthorizations must be completed in order to validate the DNS names\nspecified on the Order.",
"type": "array", "type": "array",
"items": { "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.", "description": "ACMEAuthorization contains data returned from the ACME server on an\nauthorization that must be completed in order validate a DNS name on an ACME\nOrder resource.",
"type": "object", "type": "object",
"required": [ "required": [
"url" "url"
], ],
"properties": { "properties": {
"challenges": { "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.", "description": "Challenges specifies the challenge types offered by the ACME server.\nOne of these challenge types will be selected when validating the DNS\nname and an appropriate Challenge resource will be created to perform\nthe ACME challenge process.",
"type": "array", "type": "array",
"items": { "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.", "description": "Challenge specifies a challenge offered by the ACME server for an Order.\nAn appropriate Challenge resource can be created to perform the ACME\nchallenge process.",
"type": "object", "type": "object",
"required": [ "required": [
"token", "token",
@ -102,15 +102,15 @@
], ],
"properties": { "properties": {
"token": { "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.", "description": "Token is the token that must be presented for this challenge.\nThis is used to compute the 'key' that must also be presented.",
"type": "string" "type": "string"
}, },
"type": { "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.", "description": "Type is the type of challenge being offered, e.g. 'http-01', 'dns-01',\n'tls-sni-01', etc.\nThis is the raw value retrieved from the ACME server.\nOnly 'http-01' and 'dns-01' are supported by cert-manager, other values\nwill be ignored.",
"type": "string" "type": "string"
}, },
"url": { "url": {
"description": "URL is the URL of this challenge. It can be used to retrieve additional metadata about the Challenge from the ACME server.", "description": "URL is the URL of this challenge. It can be used to retrieve additional\nmetadata about the Challenge from the ACME server.",
"type": "string" "type": "string"
} }
}, },
@ -122,7 +122,7 @@
"type": "string" "type": "string"
}, },
"initialState": { "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.", "description": "InitialState is the initial state of the ACME authorization when first\nfetched from the ACME server.\nIf an Authorization is already 'valid', the Order controller will not\ncreate a Challenge resource for the authorization. This will occur when\nworking with an ACME server that enables 'authz reuse' (such as Let's\nEncrypt's production endpoint).\nIf not set and 'identifier' is set, the state is assumed to be pending\nand a Challenge will be created.",
"type": "string", "type": "string",
"enum": [ "enum": [
"valid", "valid",
@ -139,7 +139,7 @@
"type": "string" "type": "string"
}, },
"wildcard": { "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'.", "description": "Wildcard will be true if this authorization is for a wildcard DNS name.\nIf this is true, the identifier will be the *non-wildcard* version of\nthe DNS name.\nFor example, if '*.example.com' is the DNS name being validated, this\nfield will be 'true' and the 'identifier' field will be 'example.com'.",
"type": "boolean" "type": "boolean"
} }
}, },
@ -147,25 +147,25 @@
} }
}, },
"certificate": { "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.", "description": "Certificate is a copy of the PEM encoded certificate for this Order.\nThis field will be populated after the order has been successfully\nfinalized with the ACME server, and the order has transitioned to the\n'valid' state.",
"type": "string", "type": "string",
"format": "byte" "format": "byte"
}, },
"failureTime": { "failureTime": {
"description": "FailureTime stores the time that this order failed. This is used to influence garbage collection and back-off.", "description": "FailureTime stores the time that this order failed.\nThis is used to influence garbage collection and back-off.",
"type": "string", "type": "string",
"format": "date-time" "format": "date-time"
}, },
"finalizeURL": { "finalizeURL": {
"description": "FinalizeURL of the Order. This is used to obtain certificates for this order once it has been completed.", "description": "FinalizeURL of the Order.\nThis is used to obtain certificates for this order once it has been completed.",
"type": "string" "type": "string"
}, },
"reason": { "reason": {
"description": "Reason optionally provides more information about a why the order is in the current state.", "description": "Reason optionally provides more information about a why the order is in\nthe current state.",
"type": "string" "type": "string"
}, },
"state": { "state": {
"description": "State contains the current state of this Order resource. States 'success' and 'expired' are 'final'", "description": "State contains the current state of this Order resource.\nStates 'success' and 'expired' are 'final'",
"type": "string", "type": "string",
"enum": [ "enum": [
"valid", "valid",
@ -178,7 +178,7 @@
] ]
}, },
"url": { "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.", "description": "URL of the Order.\nThis will initially be empty when the resource is first created.\nThe Order controller will populate this field when the Order is first processed.\nThis field will be immutable after it is initially set.",
"type": "string" "type": "string"
} }
}, },