NEW: Get project updates onTwitterandMastodon

trust-manager API Reference

Packages:

trust.cert-manager.io/v1alpha1

Resource Types:

Bundle

NameTypeDescriptionRequired
apiVersionstringtrust.cert-manager.io/v1alpha1true
kindstringBundletrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the metadata field.true
specobject

Desired state of the Bundle resource.


true
statusobject

Status of the Bundle. This is set and managed automatically.


false

Bundle.spec

Desired state of the Bundle resource.

NameTypeDescriptionRequired
sources[]object

Sources is a set of references to data whose data will sync to the target.


true
targetobject

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.

NameTypeDescriptionRequired
configMapobject

ConfigMap is a reference (by name) to a ConfigMap's data key, or to a list of ConfigMap's data key using label selector, in the trust Namespace.


false
inLinestring

InLine is a simple string to append as the source data.


false
secretobject

Secret is a reference (by name) to a Secret's data key, or to a list of Secret's data key using label selector, in the trust Namespace.


false
useDefaultCAsboolean

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, or to a list of ConfigMap's data key using label selector, in the trust Namespace.

NameTypeDescriptionRequired
keystring

Key is the key of the entry in the object's data field to be used.


true
namestring

Name is the name of the source object in the trust Namespace. This field must be left empty when selector is set


false
selectorobject

Selector is the label selector to use to fetch a list of objects. Must not be set when Name is set.


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.

NameTypeDescriptionRequired
matchExpressions[]object

matchExpressions is a list of label selector requirements. The requirements are ANDed.


false
matchLabelsmap[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.

NameTypeDescriptionRequired
keystring

key is the label key that the selector applies to.


true
operatorstring

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, or to a list of Secret's data key using label selector, in the trust Namespace.

NameTypeDescriptionRequired
keystring

Key is the key of the entry in the object's data field to be used.


true
namestring

Name is the name of the source object in the trust Namespace. This field must be left empty when selector is set


false
selectorobject

Selector is the label selector to use to fetch a list of objects. Must not be set when Name is set.


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.

NameTypeDescriptionRequired
matchExpressions[]object

matchExpressions is a list of label selector requirements. The requirements are ANDed.


false
matchLabelsmap[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.

NameTypeDescriptionRequired
keystring

key is the label key that the selector applies to.


true
operatorstring

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.

NameTypeDescriptionRequired
additionalFormatsobject

AdditionalFormats specifies any additional formats to write to the target


false
configMapobject

ConfigMap is the target ConfigMap in Namespaces that all Bundle source data will be synced to.


false
namespaceSelectorobject

NamespaceSelector will, if set, only sync the target resource in Namespaces which match the selector.


false
secretobject

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

NameTypeDescriptionRequired
jksobject

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


false
pkcs12object

PKCS12 requests a PKCS12-formatted binary trust bundle to be written to the target. The bundle is by default created without a password.


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

NameTypeDescriptionRequired
keystring

Key is the key of the entry in the object's data field to be used.


true
passwordstring

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.

NameTypeDescriptionRequired
keystring

Key is the key of the entry in the object's data field to be used.


true
passwordstring

Password for PKCS12 trust store



Default:

false

Bundle.spec.target.configMap

ConfigMap is the target ConfigMap in Namespaces that all Bundle source data will be synced to.

NameTypeDescriptionRequired
keystring

Key is the key of the entry in the object's data field to be used.


true

Bundle.spec.target.namespaceSelector

NamespaceSelector will, if set, only sync the target resource in Namespaces which match the selector.

NameTypeDescriptionRequired
matchLabelsmap[string]string

MatchLabels matches on the set of labels that must be present on a Namespace for the Bundle target to be synced there.


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.

NameTypeDescriptionRequired
keystring

Key is the key of the entry in the object's data field to be used.


true

Bundle.status

Status of the Bundle. This is set and managed automatically.

NameTypeDescriptionRequired
conditions[]object

List of status conditions to indicate the status of the Bundle. Known condition types are Bundle.


false
defaultCAVersionstring

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]

BundleCondition contains condition information for a Bundle.

NameTypeDescriptionRequired
lastTransitionTimestring

LastTransitionTime is the timestamp corresponding to the last status change of this condition.



Format: date-time

true
reasonstring

Reason is a brief machine-readable explanation for the condition's last transition. The value should be a CamelCase string. This field may not be empty.


true
statusenum

Status of the condition, one of True, False, Unknown.



Enum: True, False, Unknown

true
typestring

Type of the condition, known values are (Synced).


true
messagestring

Message is a human-readable description of the details of the last transition, complementing reason.


false
observedGenerationinteger

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 Bundle.



Format: int64
Minimum: 0

false