trust-manager API Reference
Packages:
trust.cert-manager.io/v1alpha1
Resource Types:
Bundle
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | trust.cert-manager.io/v1alpha1 | true |
kind | string | Bundle | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | Desired state of the Bundle resource. | true |
status | object | Status of the Bundle. This is set and managed automatically. | false |
Bundle.spec
Desired state of the Bundle resource.
Name | Type | Description | Required |
---|---|---|---|
sources | []object | Sources is a set of references to data whose data will sync to the target. | true |
target | object | Target is the target location in all namespaces to sync source data to. | true |
Bundle.spec.sources[index]
BundleSource is the set of sources whose data will be appended and synced to the BundleTarget in all Namespaces.
Name | Type | Description | Required |
---|---|---|---|
configMap | object | ConfigMap is a reference (by name) to a ConfigMap's | false |
inLine | string | InLine is a simple string to append as the source data. | false |
secret | object | Secret is a reference (by name) to a Secret's | false |
useDefaultCAs | boolean | UseDefaultCAs, when true, requests the default CA bundle to be used as a source. Default CAs are available if trust-manager was installed via Helm or was otherwise set up to include a package-injecting init container by using the "--default-package-location" flag when starting the trust-manager controller. If default CAs were not configured at start-up, any request to use the default CAs will fail. The version of the default CA package which is used for a Bundle is stored in the defaultCAPackageVersion field of the Bundle's status field. | false |
Bundle.spec.sources[index].configMap
ConfigMap is a reference (by name) to a ConfigMap's data
key(s), or to a
list of ConfigMap's data
key(s) using label selector, in the trust Namespace.
Name | Type | Description | Required |
---|---|---|---|
includeAllKeys | boolean | IncludeAllKeys is a flag to include all keys in the object's | false |
key | string | Key of the entry in the object's | false |
name | string | Name is the name of the source object in the trust Namespace.
This field must be left empty when | false |
selector | object | Selector is the label selector to use to fetch a list of objects. Must not be set
when | false |
Bundle.spec.sources[index].configMap.selector
Selector is the label selector to use to fetch a list of objects. Must not be set
when Name
is set.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. | false |
Bundle.spec.sources[index].configMap.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. | true |
values | []string | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. | false |
Bundle.spec.sources[index].secret
Secret is a reference (by name) to a Secret's data
key(s), or to a
list of Secret's data
key(s) using label selector, in the trust Namespace.
Name | Type | Description | Required |
---|---|---|---|
includeAllKeys | boolean | IncludeAllKeys is a flag to include all keys in the object's | false |
key | string | Key of the entry in the object's | false |
name | string | Name is the name of the source object in the trust Namespace.
This field must be left empty when | false |
selector | object | Selector is the label selector to use to fetch a list of objects. Must not be set
when | false |
Bundle.spec.sources[index].secret.selector
Selector is the label selector to use to fetch a list of objects. Must not be set
when Name
is set.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. | false |
Bundle.spec.sources[index].secret.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. | true |
values | []string | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. | false |
Bundle.spec.target
Target is the target location in all namespaces to sync source data to.
Name | Type | Description | Required |
---|---|---|---|
additionalFormats | object | AdditionalFormats specifies any additional formats to write to the target | false |
configMap | object | ConfigMap is the target ConfigMap in Namespaces that all Bundle source data will be synced to. | false |
namespaceSelector | object | NamespaceSelector will, if set, only sync the target resource in Namespaces which match the selector. | false |
secret | object | Secret is the target Secret that all Bundle source data will be synced to. Using Secrets as targets is only supported if enabled at trust-manager startup. By default, trust-manager has no permissions for writing to secrets and can only read secrets in the trust namespace. | false |
Bundle.spec.target.additionalFormats
AdditionalFormats specifies any additional formats to write to the target
Name | Type | Description | Required |
---|---|---|---|
jks | object | JKS requests a JKS-formatted binary trust bundle to be written to the target. The bundle has "changeit" as the default password. For more information refer to this link https://cert-manager.io/docs/faq/#keystore-passwords Deprecated: Writing JKS is subject for removal. Please migrate to PKCS12. PKCS#12 trust stores created by trust-manager are compatible with Java. | false |
pkcs12 | object | PKCS12 requests a PKCS12-formatted binary trust bundle to be written to the target. The bundle is by default created without a password. For more information refer to this link https://cert-manager.io/docs/faq/#keystore-passwords | false |
Bundle.spec.target.additionalFormats.jks
JKS requests a JKS-formatted binary trust bundle to be written to the target. The bundle has "changeit" as the default password. For more information refer to this link https://cert-manager.io/docs/faq/#keystore-passwords Deprecated: Writing JKS is subject for removal. Please migrate to PKCS12. PKCS#12 trust stores created by trust-manager are compatible with Java.
Name | Type | Description | Required |
---|---|---|---|
key | string | Key is the key of the entry in the object's | true |
password | string | Password for JKS trust store Default: changeit | false |
Bundle.spec.target.additionalFormats.pkcs12
PKCS12 requests a PKCS12-formatted binary trust bundle to be written to the target.
The bundle is by default created without a password. For more information refer to this link https://cert-manager.io/docs/faq/#keystore-passwords
Name | Type | Description | Required |
---|---|---|---|
key | string | Key is the key of the entry in the object's | true |
password | string | Password for PKCS12 trust store Default: | false |
profile | enum | Profile specifies the certificate encryption algorithms and the HMAC algorithm used to create the PKCS12 trust store. If provided, allowed values are:
Default value is Enum: LegacyRC2, LegacyDES, Modern2023 | false |
Bundle.spec.target.configMap
ConfigMap is the target ConfigMap in Namespaces that all Bundle source data will be synced to.
Name | Type | Description | Required |
---|---|---|---|
key | string | Key is the key of the entry in the object's | true |
metadata | object | Metadata is an optional set of labels and annotations to be copied to the target. | false |
Bundle.spec.target.configMap.metadata
Metadata is an optional set of labels and annotations to be copied to the target.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | Annotations is a key value map to be copied to the target. | false |
labels | map[string]string | Labels is a key value map to be copied to the target. | false |
Bundle.spec.target.namespaceSelector
NamespaceSelector will, if set, only sync the target resource in Namespaces which match the selector.
Name | Type | Description | Required |
---|---|---|---|
matchExpressions | []object | matchExpressions is a list of label selector requirements. The requirements are ANDed. | false |
matchLabels | map[string]string | matchLabels is a map of key-value pairs. A single key-value in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. | false |
Bundle.spec.target.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
key | string | key is the label key that the selector applies to. | true |
operator | string | operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. | true |
values | []string | values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. | false |
Bundle.spec.target.secret
Secret is the target Secret that all Bundle source data will be synced to. Using Secrets as targets is only supported if enabled at trust-manager startup. By default, trust-manager has no permissions for writing to secrets and can only read secrets in the trust namespace.
Name | Type | Description | Required |
---|---|---|---|
key | string | Key is the key of the entry in the object's | true |
metadata | object | Metadata is an optional set of labels and annotations to be copied to the target. | false |
Bundle.spec.target.secret.metadata
Metadata is an optional set of labels and annotations to be copied to the target.
Name | Type | Description | Required |
---|---|---|---|
annotations | map[string]string | Annotations is a key value map to be copied to the target. | false |
labels | map[string]string | Labels is a key value map to be copied to the target. | false |
Bundle.status
Status of the Bundle. This is set and managed automatically.
Name | Type | Description | Required |
---|---|---|---|
conditions | []object | List of status conditions to indicate the status of the Bundle.
Known condition types are | false |
defaultCAVersion | string | DefaultCAPackageVersion, if set and non-empty, indicates the version information which was retrieved when the set of default CAs was requested in the bundle source. This should only be set if useDefaultCAs was set to "true" on a source, and will be the same for the same version of a bundle with identical certificates. | false |
Bundle.status.conditions[index]
Condition contains details for one aspect of the current state of this API Resource.
Name | Type | Description | Required |
---|---|---|---|
lastTransitionTime | string | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. Format: date-time | true |
message | string | message is a human readable message indicating details about the transition. This may be an empty string. | true |
reason | string | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. | true |
status | enum | status of the condition, one of True, False, Unknown. Enum: True, False, Unknown | true |
type | string | type of condition in CamelCase or in foo.example.com/CamelCase. | true |
observedGeneration | integer | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. Format: int64 | false |