Skip to content

Latest commit

 

History

History
163 lines (113 loc) · 9.62 KB

api.md

File metadata and controls

163 lines (113 loc) · 9.62 KB
Raw

secrets.mz.com/v1alpha1

Note: This document is generated from code and comments. Do not edit it directly.

Table of Contents

ConfigMapSecret

ConfigMapSecret holds configuration data with embedded secrets.

Field Description Type Required
kind ConfigMapSecret string false
apiVersion secrets.mz.com/v1alpha1 string false
metadata Standard object metadata. More info. metav1.ObjectMeta false
spec Desired state of the ConfigMapSecret. More info. ConfigMapSecretSpec false
status Observed state of the ConfigMapSecret. More info. ConfigMapSecretStatus false

Back to TOC

ConfigMapSecretCondition

ConfigMapSecretCondition describes the state of a ConfigMapSecret.

Field Description Type Required
type Type of the condition. ConfigMapSecretConditionType true
status Status of the condition: True, False, or Unknown. corev1.ConditionStatus true
lastUpdateTime The last time the condition was updated. metav1.Time false
lastTransitionTime Last time the condition transitioned from one status to another. metav1.Time false
reason The reason for the last update. string false
message A human readable message indicating details about the last update. string false

Back to TOC

ConfigMapSecretConditionType

ConfigMapSecretConditionType is a valid value for ConfigMapSecretCondition.Type

Name Value Description
ConfigMapSecretRenderFailure RenderFailure ConfigMapSecretRenderFailure means that the target secret could not be rendered.

Back to TOC

ConfigMapSecretList

ConfigMapSecretList contains a list of ConfigMapSecrets.

Field Description Type Required
kind ConfigMapSecretList string false
apiVersion secrets.mz.com/v1alpha1 string false
metadata Standard list metadata. More info. metav1.ListMeta false
items List of ConfigMapSecrets. []ConfigMapSecret true

Back to TOC

ConfigMapSecretSpec

ConfigMapSecretSpec defines the desired state of a ConfigMapSecret.

Field Description Type Required
template Template that describes the config that will be rendered.

Variable references $(VAR_NAME) in template data are expanded using the ConfigMapSecret's variables. If a variable cannot be resolved, the reference in the input data will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.		 ConfigMapTemplate false
varsFrom List of sources to populate template variables. Keys defined in a source must consist of alphanumeric characters, '-', '_' or '.'. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by Vars with a duplicate key will take precedence. []VarsFromSource false
vars List of template variables. []Var false

Back to TOC

ConfigMapSecretStatus

ConfigMapSecretStatus describes the observed state of a ConfigMapSecret.

Field Description Type Required
observedGeneration The generation observed by the ConfigMapSecret controller. int64 false
conditions Represents the latest available observations of a ConfigMapSecret's current state. []ConfigMapSecretCondition false

Back to TOC

ConfigMapTemplate

ConfigMapTemplate is a ConfigMap template.

Field Description Type Required
metadata Metadata is a stripped down version of the standard object metadata. Its properties will be applied to the metadata of the generated Secret. If no name is provided, the name of the ConfigMapSecret will be used. EmbeddedObjectMeta false
data Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field. map[string]string false
binaryData BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the keys in the Data field. map[string][]byte false

Back to TOC

ConfigMapVarsSource

ConfigMapVarsSource selects a ConfigMap to populate template variables with.

Field Description Type Required
name Name of the referent. More info. string false
optional Specify whether the ConfigMap must be defined. *bool false

Back to TOC

EmbeddedObjectMeta

EmbeddedObjectMeta contains a subset of the fields from k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta. Only fields which are relevant to embedded resources are included.

Field Description Type Required
name Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. More info. string false
labels Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info. map[string]string false
annotations Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info. map[string]string false

Back to TOC

SecretVarsSource

SecretVarsSource selects a Secret to populate template variables with.

Field Description Type Required
name Name of the referent. More info. string false
optional Specify whether the Secret must be defined. *bool false

Back to TOC

Var

Var is a template variable.

Field Description Type Required
name Name of the template variable. string true
value Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the ConfigMapSecret. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. string false
secretValue SecretValue selects a value by its key in a Secret. *corev1.SecretKeySelector false
configMapValue ConfigMapValue selects a value by its key in a ConfigMap. *corev1.ConfigMapKeySelector false

Back to TOC

VarsFromSource

VarsFromSource represents the source of a set of template variables.

Field Description Type Required
prefix An optional identifier to prepend to each key. string false
secretRef The Secret to select. *SecretVarsSource false
configMapRef The ConfigMap to select. *ConfigMapVarsSource false

Back to TOC