secrets.v1beta1.hcpVaultSecretsApp

"HCPVaultSecretsApp is the Schema for the hcpvaultsecretsapps API"

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of HCPVaultSecretsApp

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(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: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(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: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(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: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(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: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(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. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

fn metadata.withSelfLink

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"HCPVaultSecretsAppSpec defines the desired state of HCPVaultSecretsApp"

fn spec.withAppName

withAppName(appName)

"AppName of the Vault Secrets Application that is to be synced."

fn spec.withHcpAuthRef

withHcpAuthRef(hcpAuthRef)

"HCPAuthRef to the HCPAuth resource, can be prefixed with a namespace, eg:\nnamespaceA/vaultAuthRefB. If no namespace prefix is provided it will default\nto the namespace of the HCPAuth CR. If no value is specified for HCPAuthRef the\nOperator will default to the default HCPAuth, configured in the operator's\nnamespace."

fn spec.withRefreshAfter

withRefreshAfter(refreshAfter)

"RefreshAfter a period of time, in duration notation e.g. 30s, 1m, 24h"

fn spec.withRolloutRestartTargets

withRolloutRestartTargets(rolloutRestartTargets)

"RolloutRestartTargets should be configured whenever the application(s)\nconsuming the HCP Vault Secrets App does not support dynamically reloading a\nrotated secret. In that case one, or more RolloutRestartTarget(s) can be\nconfigured here. The Operator will trigger a \"rollout-restart\" for each target\nwhenever the Vault secret changes between reconciliation events. See\nRolloutRestartTarget for more details."

fn spec.withRolloutRestartTargetsMixin

withRolloutRestartTargetsMixin(rolloutRestartTargets)

"RolloutRestartTargets should be configured whenever the application(s)\nconsuming the HCP Vault Secrets App does not support dynamically reloading a\nrotated secret. In that case one, or more RolloutRestartTarget(s) can be\nconfigured here. The Operator will trigger a \"rollout-restart\" for each target\nwhenever the Vault secret changes between reconciliation events. See\nRolloutRestartTarget for more details."

Note: This function appends passed data to existing values

obj spec.destination

"Destination provides configuration necessary for syncing the HCP Vault\nApplication secrets to Kubernetes."

fn spec.destination.withAnnotations

withAnnotations(annotations)

"Annotations to apply to the Secret. Requires Create to be set to true."

fn spec.destination.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations to apply to the Secret. Requires Create to be set to true."

Note: This function appends passed data to existing values

fn spec.destination.withCreate

withCreate(create)

"Create the destination Secret.\nIf the Secret already exists this should be set to false."

fn spec.destination.withLabels

withLabels(labels)

"Labels to apply to the Secret. Requires Create to be set to true."

fn spec.destination.withLabelsMixin

withLabelsMixin(labels)

"Labels to apply to the Secret. Requires Create to be set to true."

Note: This function appends passed data to existing values

fn spec.destination.withName

withName(name)

"Name of the Secret"

fn spec.destination.withOverwrite

withOverwrite(overwrite)

"Overwrite the destination Secret if it exists and Create is true. This is\nuseful when migrating to VSO from a previous secret deployment strategy."

fn spec.destination.withType

withType(type)

"Type of Kubernetes Secret. Requires Create to be set to true.\nDefaults to Opaque."

obj spec.destination.transformation

"Transformation provides configuration for transforming the secret data before\nit is stored in the Destination."

fn spec.destination.transformation.withExcludeRaw

withExcludeRaw(excludeRaw)

"ExcludeRaw data from the destination Secret. Exclusion policy can be set\nglobally by including 'exclude-raw` in the '--global-transformation-options'\ncommand line flag. If set, the command line flag always takes precedence over\nthis configuration."

fn spec.destination.transformation.withExcludes

withExcludes(excludes)

"Excludes contains regex patterns used to filter top-level source secret data\nfields for exclusion from the final K8s Secret data. These pattern filters are\nnever applied to templated fields as defined in Templates. They are always\napplied before any inclusion patterns. To exclude all source secret data\nfields, you can configure the single pattern \".*\"."

fn spec.destination.transformation.withExcludesMixin

withExcludesMixin(excludes)

"Excludes contains regex patterns used to filter top-level source secret data\nfields for exclusion from the final K8s Secret data. These pattern filters are\nnever applied to templated fields as defined in Templates. They are always\napplied before any inclusion patterns. To exclude all source secret data\nfields, you can configure the single pattern \".*\"."

Note: This function appends passed data to existing values

fn spec.destination.transformation.withIncludes

withIncludes(includes)

"Includes contains regex patterns used to filter top-level source secret data\nfields for inclusion in the final K8s Secret data. These pattern filters are\nnever applied to templated fields as defined in Templates. They are always\napplied last."

fn spec.destination.transformation.withIncludesMixin

withIncludesMixin(includes)

"Includes contains regex patterns used to filter top-level source secret data\nfields for inclusion in the final K8s Secret data. These pattern filters are\nnever applied to templated fields as defined in Templates. They are always\napplied last."

Note: This function appends passed data to existing values

fn spec.destination.transformation.withTemplates

withTemplates(templates)

"Templates maps a template name to its Template. Templates are always included\nin the rendered K8s Secret, and take precedence over templates defined in a\nSecretTransformation."

fn spec.destination.transformation.withTemplatesMixin

withTemplatesMixin(templates)

"Templates maps a template name to its Template. Templates are always included\nin the rendered K8s Secret, and take precedence over templates defined in a\nSecretTransformation."

Note: This function appends passed data to existing values

fn spec.destination.transformation.withTransformationRefs

withTransformationRefs(transformationRefs)

"TransformationRefs contain references to template configuration from\nSecretTransformation."

fn spec.destination.transformation.withTransformationRefsMixin

withTransformationRefsMixin(transformationRefs)

"TransformationRefs contain references to template configuration from\nSecretTransformation."

Note: This function appends passed data to existing values

obj spec.destination.transformation.transformationRefs

"TransformationRefs contain references to template configuration from\nSecretTransformation."

fn spec.destination.transformation.transformationRefs.withIgnoreExcludes

withIgnoreExcludes(ignoreExcludes)

"IgnoreExcludes controls whether to use the SecretTransformation's Excludes\ndata key filters."

fn spec.destination.transformation.transformationRefs.withIgnoreIncludes

withIgnoreIncludes(ignoreIncludes)

"IgnoreIncludes controls whether to use the SecretTransformation's Includes\ndata key filters."

fn spec.destination.transformation.transformationRefs.withName

withName(name)

"Name of the SecretTransformation resource."

fn spec.destination.transformation.transformationRefs.withNamespace

withNamespace(namespace)

"Namespace of the SecretTransformation resource."

fn spec.destination.transformation.transformationRefs.withTemplateRefs

withTemplateRefs(templateRefs)

"TemplateRefs map to a Template found in this TransformationRef. If empty, then\nall templates from the SecretTransformation will be rendered to the K8s Secret."

fn spec.destination.transformation.transformationRefs.withTemplateRefsMixin

withTemplateRefsMixin(templateRefs)

"TemplateRefs map to a Template found in this TransformationRef. If empty, then\nall templates from the SecretTransformation will be rendered to the K8s Secret."

Note: This function appends passed data to existing values

obj spec.destination.transformation.transformationRefs.templateRefs

"TemplateRefs map to a Template found in this TransformationRef. If empty, then\nall templates from the SecretTransformation will be rendered to the K8s Secret."

fn spec.destination.transformation.transformationRefs.templateRefs.withKeyOverride

withKeyOverride(keyOverride)

"KeyOverride to the rendered template in the Destination secret. If Key is\nempty, then the Key from reference spec will be used. Set this to override the\nKey set from the reference spec."

fn spec.destination.transformation.transformationRefs.templateRefs.withName

withName(name)

"Name of the Template in SecretTransformationSpec.Templates.\nthe rendered secret data."

obj spec.rolloutRestartTargets

"RolloutRestartTargets should be configured whenever the application(s)\nconsuming the HCP Vault Secrets App does not support dynamically reloading a\nrotated secret. In that case one, or more RolloutRestartTarget(s) can be\nconfigured here. The Operator will trigger a \"rollout-restart\" for each target\nwhenever the Vault secret changes between reconciliation events. See\nRolloutRestartTarget for more details."

fn spec.rolloutRestartTargets.withKind

withKind(kind)

"Kind of the resource"

fn spec.rolloutRestartTargets.withName

withName(name)

"Name of the resource"

obj spec.syncConfig

"SyncConfig configures sync behavior from HVS to VSO"

obj spec.syncConfig.dynamic

"Dynamic configures sync behavior for dynamic secrets."

fn spec.syncConfig.dynamic.withRenewalPercent

withRenewalPercent(renewalPercent)

"RenewalPercent is the percent out of 100 of a dynamic secret's TTL when\nnew secrets are generated. Defaults to 67 percent plus up to 10% jitter."