Secret
Kind
generic.vault.upbound.io
Group
v1alpha1
Version

apiVersion: generic.vault.upbound.io/v1alpha1
kind: Secret

Secret is the Schema for the Secrets API. Writes arbitrary data to a given path in Vault

spec object

SecretSpec defines the desired state of Secret


deletionPolicy string

DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either "Delete" or "Orphan" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223

forProvider object required

No Description Provided.


dataJsonSecretRef object

String containing a JSON-encoded object that will be written as the secret data at the given path. JSON-encoded secret data to write.


key string required

The key to select.

name string required

Name of the secret.

namespace string required

Namespace of the secret.

deleteAllVersions boolean

true/false. Only applicable for kv-v2 stores. If set to true, permanently deletes all versions for the specified key. The default behavior is to only delete the latest version of the secret. Only applicable for kv-v2 stores. If set, permanently deletes all versions for the specified key.

disableRead boolean

true/false. Set this to true if your vault authentication is not able to read the data. Setting this to true will break drift detection. Defaults to false. Don't attempt to read the token from Vault if true; drift won't be detected.

namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise. Target namespace. (requires Enterprise)

path string

The full logical path at which to write the given data. To write data into the "generic" secret backend mounted in Vault by default, this should be prefixed with secret/. Writing to other backends with this resource is possible; consult each backend's documentation to see which endpoints support the PUT and DELETE methods. Full path where the generic secret will be written.

initProvider object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.


dataJsonSecretRef object required

String containing a JSON-encoded object that will be written as the secret data at the given path. JSON-encoded secret data to write.


key string required

The key to select.

name string required

Name of the secret.

namespace string required

Namespace of the secret.

deleteAllVersions boolean

true/false. Only applicable for kv-v2 stores. If set to true, permanently deletes all versions for the specified key. The default behavior is to only delete the latest version of the secret. Only applicable for kv-v2 stores. If set, permanently deletes all versions for the specified key.

disableRead boolean

true/false. Set this to true if your vault authentication is not able to read the data. Setting this to true will break drift detection. Defaults to false. Don't attempt to read the token from Vault if true; drift won't be detected.

namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise. Target namespace. (requires Enterprise)

path string

The full logical path at which to write the given data. To write data into the "generic" secret backend mounted in Vault by default, this should be prefixed with secret/. Writing to other backends with this resource is possible; consult each backend's documentation to see which endpoints support the PUT and DELETE methods. Full path where the generic secret will be written.

managementPolicies []string

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

providerConfigRef object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.


name string required

Name of the referenced object.

policy object

Policies for referencing.


resolution string

Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.

resolve string

Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.

publishConnectionDetailsTo object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.


configRef object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.


name string required

Name of the referenced object.

policy object

Policies for referencing.


resolution string

Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved.

resolve string

Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile.

metadata object

Metadata is the metadata for connection secret.


annotations object

Annotations are the annotations to be added to connection secret.

  • For Kubernetes secrets, this will be used as "metadata.annotations".
  • It is up to Secret Store implementation for others store types.
labels object

Labels are the labels/tags to be added to connection secret.

  • For Kubernetes secrets, this will be used as "metadata.labels".
  • It is up to Secret Store implementation for others store types.
type string

Type is the SecretType for the connection secret.

  • Only valid for Kubernetes Secret Stores.
name string required

Name is the name of the connection secret.

writeConnectionSecretToRef object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.


name string required

Name of the secret.

namespace string required

Namespace of the secret.

status object

SecretStatus defines the observed state of Secret.


atProvider object

No Description Provided.


deleteAllVersions boolean

true/false. Only applicable for kv-v2 stores. If set to true, permanently deletes all versions for the specified key. The default behavior is to only delete the latest version of the secret. Only applicable for kv-v2 stores. If set, permanently deletes all versions for the specified key.

disableRead boolean

true/false. Set this to true if your vault authentication is not able to read the data. Setting this to true will break drift detection. Defaults to false. Don't attempt to read the token from Vault if true; drift won't be detected.

id string

No Description Provided.

namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise. Target namespace. (requires Enterprise)

path string

The full logical path at which to write the given data. To write data into the "generic" secret backend mounted in Vault by default, this should be prefixed with secret/. Writing to other backends with this resource is possible; consult each backend's documentation to see which endpoints support the PUT and DELETE methods. Full path where the generic secret will be written.

conditions []object

Conditions of the resource.


lastTransitionTime string required

LastTransitionTime is the last time this condition transitioned from one status to another.

message string

A Message containing details about this condition's last transition from one status to another, if any.

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.

reason string required

A Reason for this condition's last transition from one status to another.

status string required

Status of this condition; is it currently True, False, or Unknown?

type string required

Type of this condition. At most one of each condition type may apply to a resource at any point in time.

observedGeneration integer

ObservedGeneration is the latest metadata.generation which resulted in either a ready state, or stalled due to error it can not recover from without human intervention.