SecretStore (external-secrets.io/v1alpha1)

Type: object

SecretStore represents a secure external location for storing secrets, which can be referenced as part of storeRef fields.

Type: string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

Type: string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

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.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

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.

No Additional Items

Each item of this array must be:

Type: string

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.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

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

Type: object

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Manager is an identifier of the workflow managing these fields.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

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: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

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.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

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.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: boolean

If true, this reference points to the managing controller.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

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.

Populated 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

Type: string

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.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

SecretStoreSpec defines the desired state of SecretStore.

Type: string

Used to select the correct ESO controller (think: ingress.ingressClassName)
The ESO controller is instantiated with a specific controller name and filters ES based on this property

Type: object

Used to configure the provider. Only one provider may be set

Type: object

Akeyless configures this store to sync secrets using Akeyless Vault provider

Type: string

Akeyless GW API Url from which the secrets to be fetched from.

Type: object

Auth configures how the operator authenticates with Akeyless.

Type: object

Kubernetes authenticates with Akeyless by passing the ServiceAccount
token stored in the named Secret resource.

Type: string

the Akeyless Kubernetes auth-method access-id

Type: string

Kubernetes-auth configuration name in Akeyless-Gateway

Type: object

Optional secret field containing a Kubernetes ServiceAccount JWT used
for authenticating with Akeyless. If a name is specified without a key,
token is the default. If one is not specified, the one bound to
the controller will be used.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Optional service account field containing the name of a kubernetes ServiceAccount.
If the service account is specified, the service account secret token JWT will be used
for authenticating with Akeyless. If the service account selector is not supplied,
the secretRef will be used instead.

Type: array of string

Audience specifies the aud claim for the service account token
If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
then this audiences will be appended to the list

No Additional Items

Each item of this array must be:

Type: string

The name of the ServiceAccount resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Reference to a Secret that contains the details
to authenticate with Akeyless.

Type: object

The SecretAccessID is used for authentication

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

A reference to a specific 'key' within a Secret resource,
In some instances, key is a required field.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

A reference to a specific 'key' within a Secret resource,
In some instances, key is a required field.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: stringFormat: byte

PEM/base64 encoded CA bundle used to validate Akeyless Gateway certificate. Only used
if the AkeylessGWApiURL URL is using HTTPS protocol. If not set the system root certificates
are used to validate the TLS connection.

Type: object

The provider for the CA bundle to use to validate Akeyless Gateway certificate.

Type: string

The key the value inside of the provider type to use, only used with "Secret" type

Type: string

The name of the object located at the provider type.

Type: string

The namespace the Provider type is in.

Type: enum (of string)

The type of provider to use such as "Secret", or "ConfigMap".

Must be one of:

  • "Secret"
  • "ConfigMap"

Type: object

Alibaba configures this store to sync secrets using Alibaba Cloud provider

Type: object

AlibabaAuth contains a secretRef for credentials.

Type: object

Authenticate against Alibaba using RRSA.

Type: string

Type: object

AlibabaAuthSecretRef holds secret references for Alibaba credentials.

Type: object

The AccessKeyID is used for authentication

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

The AccessKeySecret is used for authentication

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

Alibaba Region to be used for the provider

Type: object

AWS configures this store to sync secrets using AWS Secret Manager provider

Type: object

Auth defines the information necessary to authenticate against AWS
if not set aws sdk will infer credentials from your environment
see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials

Type: object

Authenticate against AWS using service account tokens.

Type: object

A reference to a ServiceAccount resource.

Type: array of string

Audience specifies the aud claim for the service account token
If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
then this audiences will be appended to the list

No Additional Items

Each item of this array must be:

Type: string

The name of the ServiceAccount resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

AWSAuthSecretRef holds secret references for AWS credentials
both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.

Type: object

The AccessKeyID is used for authentication

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

The SecretAccessKey is used for authentication

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

AWS Region to be used for the provider

Type: string

Role is a Role ARN which the SecretManager provider will assume

Type: enum (of string)

Service defines which service should be used to fetch the secrets

Must be one of:

  • "SecretsManager"
  • "ParameterStore"

Type: object

AzureKV configures this store to sync secrets using Azure Key Vault provider

Type: object

Auth configures how the operator authenticates with Azure. Required for ServicePrincipal auth type.

Type: object

The Azure clientId of the service principle used for authentication.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

The Azure ClientSecret of the service principle used for authentication.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: enum (of string)

Auth type defines how to authenticate to the keyvault service.
Valid values are:
- "ServicePrincipal" (default): Using a service principal (tenantId, clientId, clientSecret)
- "ManagedIdentity": Using Managed Identity assigned to the pod (see aad-pod-identity)

Must be one of:

  • "ServicePrincipal"
  • "ManagedIdentity"
  • "WorkloadIdentity"

Type: string

If multiple Managed Identity is assigned to the pod, you can select the one to be used

Type: object

ServiceAccountRef specified the service account
that should be used when authenticating with WorkloadIdentity.

Type: array of string

Audience specifies the aud claim for the service account token
If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
then this audiences will be appended to the list

No Additional Items

Each item of this array must be:

Type: string

The name of the ServiceAccount resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.

Type: string

Vault Url from which the secrets to be fetched from.

Type: object

Fake configures a store with static key/value pairs

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: string

Type: string

Type: object

Each additional property must conform to the following schema

Type: string

Type: object

GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider

Type: object

Auth defines the information necessary to authenticate against GCP

Type: object

Type: object

The SecretAccessKey is used for authentication

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Type: object

A reference to a ServiceAccount resource.

Type: array of string

Audience specifies the aud claim for the service account token
If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
then this audiences will be appended to the list

No Additional Items

Each item of this array must be:

Type: string

The name of the ServiceAccount resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

ProjectID project where secret is located

Type: object

GitLab configures this store to sync secrets using GitLab Variables provider

Type: object

Auth configures how secret-manager authenticates with a GitLab instance.

Type: object

Type: object

AccessToken is used for authentication.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

ProjectID specifies a project where secrets are located.

Type: string

URL configures the GitLab instance URL. Defaults to https://gitlab.com/.

Type: object

IBM configures this store to sync secrets using IBM Cloud provider

Type: object

Auth configures how secret-manager authenticates with the IBM secrets manager.

Type: object

Type: object

The SecretAccessKey is used for authentication

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance

Type: object

Kubernetes configures this store to sync secrets using a Kubernetes cluster provider

Type: object

Auth configures how secret-manager authenticates with a Kubernetes instance.

Type: object

has both clientCert and clientKey as secretKeySelector

Type: object

A reference to a specific 'key' within a Secret resource,
In some instances, key is a required field.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

A reference to a specific 'key' within a Secret resource,
In some instances, key is a required field.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

points to a service account that should be used for authentication

Type: object

A reference to a ServiceAccount resource.

Type: array of string

Audience specifies the aud claim for the service account token
If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
then this audiences will be appended to the list

No Additional Items

Each item of this array must be:

Type: string

The name of the ServiceAccount resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

use static token to authenticate with

Type: object

A reference to a specific 'key' within a Secret resource,
In some instances, key is a required field.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

Remote namespace to fetch the secrets from

Type: object

configures the Kubernetes server Address.

Type: stringFormat: byte

CABundle is a base64-encoded CA certificate

Type: object

see: https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider

Type: string

The key the value inside of the provider type to use, only used with "Secret" type

Type: string

The name of the object located at the provider type.

Type: string

The namespace the Provider type is in.

Type: enum (of string)

The type of provider to use such as "Secret", or "ConfigMap".

Must be one of:

  • "Secret"
  • "ConfigMap"

Type: string

configures the Kubernetes server Address.

Type: object

Oracle configures this store to sync secrets using Oracle Vault provider

Type: object

Auth configures how secret-manager authenticates with the Oracle Vault.
If empty, instance principal is used. Optionally, the authenticating principal type
and/or user data may be supplied for the use of workload identity and user principal.

Type: object

SecretRef to pass through sensitive information.

Type: object

Fingerprint is the fingerprint of the API private key.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

PrivateKey is the user's API Signing Key in PEM format, used for authentication.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

Tenancy is the tenancy OCID where user is located.

Type: string

User is an access OCID specific to the account.

Type: string

Compartment is the vault compartment OCID.
Required for PushSecret

Type: string

EncryptionKey is the OCID of the encryption key within the vault.
Required for PushSecret

Type: enum (of string)

The type of principal to use for authentication. If left blank, the Auth struct will
determine the principal type. This optional field must be specified if using
workload identity.

Must be one of:

  • ""
  • "UserPrincipal"
  • "InstancePrincipal"
  • "Workload"

Type: string

Region is the region where vault is located.

Type: object

ServiceAccountRef specified the service account
that should be used when authenticating with WorkloadIdentity.

Type: array of string

Audience specifies the aud claim for the service account token
If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
then this audiences will be appended to the list

No Additional Items

Each item of this array must be:

Type: string

The name of the ServiceAccount resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

Vault is the vault's OCID of the specific vault where secret is located.

Type: object

Vault configures this store to sync secrets using Hashi provider

Type: object

Auth configures how secret-manager authenticates with the Vault server.

Type: object

AppRole authenticates with Vault using the App Role auth mechanism,
with the role and secret stored in a Kubernetes Secret resource.

Type: string

Path where the App Role authentication backend is mounted
in Vault, e.g: "approle"

Type: string

RoleID configured in the App Role authentication backend when setting
up the authentication backend in Vault.

Type: object

Reference to a key in a Secret that contains the App Role secret used
to authenticate with Vault.
The key field must be specified and denotes which entry within the Secret
resource is used as the app role secret.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
Cert authentication method

Type: object

ClientCert is a certificate to authenticate using the Cert Vault
authentication method

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

SecretRef to a key in a Secret resource containing client private key to
authenticate with Vault using the Cert authentication method

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Jwt authenticates with Vault by passing role and JWT token using the
JWT/OIDC authentication method

Type: object

Optional ServiceAccountToken specifies the Kubernetes service account for which to request
a token for with the TokenRequest API.

Type: array of string

Optional audiences field that will be used to request a temporary Kubernetes service
account token for the service account referenced by serviceAccountRef.
Defaults to a single audience vault it not specified.

No Additional Items

Each item of this array must be:

Type: integerFormat: int64

Optional expiration time in seconds that will be used to request a temporary
Kubernetes service account token for the service account referenced by
serviceAccountRef.
Defaults to 10 minutes.

Type: object

Service account field containing the name of a kubernetes ServiceAccount.

Type: array of string

Audience specifies the aud claim for the service account token
If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
then this audiences will be appended to the list

No Additional Items

Each item of this array must be:

Type: string

The name of the ServiceAccount resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

Path where the JWT authentication backend is mounted
in Vault, e.g: "jwt"

Type: string

Role is a JWT role to authenticate using the JWT/OIDC Vault
authentication method

Type: object

Optional SecretRef that refers to a key in a Secret resource containing JWT token to
authenticate with Vault using the JWT/OIDC authentication method.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Kubernetes authenticates with Vault by passing the ServiceAccount
token stored in the named Secret resource to the Vault server.

Type: string

Path where the Kubernetes authentication backend is mounted in Vault, e.g:
"kubernetes"

Type: string

A required field containing the Vault Role to assume. A Role binds a
Kubernetes ServiceAccount with a set of Vault policies.

Type: object

Optional secret field containing a Kubernetes ServiceAccount JWT used
for authenticating with Vault. If a name is specified without a key,
token is the default. If one is not specified, the one bound to
the controller will be used.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Optional service account field containing the name of a kubernetes ServiceAccount.
If the service account is specified, the service account secret token JWT will be used
for authenticating with Vault. If the service account selector is not supplied,
the secretRef will be used instead.

Type: array of string

Audience specifies the aud claim for the service account token
If the service account uses a well-known annotation for e.g. IRSA or GCP Workload Identity
then this audiences will be appended to the list

No Additional Items

Each item of this array must be:

Type: string

The name of the ServiceAccount resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Ldap authenticates with Vault by passing username/password pair using
the LDAP authentication method

Type: string

Path where the LDAP authentication backend is mounted
in Vault, e.g: "ldap"

Type: object

SecretRef to a key in a Secret resource containing password for the LDAP
user used to authenticate with Vault using the LDAP authentication
method

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

Username is a LDAP user name used to authenticate using the LDAP Vault
authentication method

Type: object

TokenSecretRef authenticates with Vault by presenting a token.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: stringFormat: byte

PEM encoded CA bundle used to validate Vault server certificate. Only used
if the Server URL is using HTTPS protocol. This parameter is ignored for
plain HTTP protocol connection. If not set the system root certificates
are used to validate the TLS connection.

Type: object

The provider for the CA bundle to use to validate Vault server certificate.

Type: string

The key the value inside of the provider type to use, only used with "Secret" type

Type: string

The name of the object located at the provider type.

Type: string

The namespace the Provider type is in.

Type: enum (of string)

The type of provider to use such as "Secret", or "ConfigMap".

Must be one of:

  • "Secret"
  • "ConfigMap"

Type: boolean

ForwardInconsistent tells Vault to forward read-after-write requests to the Vault
leader instead of simply retrying within a loop. This can increase performance if
the option is enabled serverside.
https://www.vaultproject.io/docs/configuration/replication#allowforwardingvia_header

Type: string

Name of the vault namespace. Namespaces is a set of features within Vault Enterprise that allows
Vault environments to support Secure Multi-tenancy. e.g: "ns1".
More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces

Type: string

Path is the mount path of the Vault KV backend endpoint, e.g:
"secret". The v2 KV secret engine version specific "/data" path suffix
for fetching secrets from Vault is optional and will be appended
if not present in specified path.

Type: boolean

ReadYourWrites ensures isolated read-after-write semantics by
providing discovered cluster replication states in each request.
More information about eventual consistency in Vault can be found here
https://www.vaultproject.io/docs/enterprise/consistency

Type: string

Server is the connection address for the Vault server, e.g: "https://vault.example.com:8200".

Type: enum (of string)

Version is the Vault KV secret engine version. This can be either "v1" or
"v2". Version defaults to "v2".

Must be one of:

  • "v1"
  • "v2"

Type: object

Webhook configures this store to sync secrets using a generic templated webhook

Type: string

Body

Type: stringFormat: byte

PEM encoded CA bundle used to validate webhook server certificate. Only used
if the Server URL is using HTTPS protocol. This parameter is ignored for
plain HTTP protocol connection. If not set the system root certificates
are used to validate the TLS connection.

Type: object

The provider for the CA bundle to use to validate webhook server certificate.

Type: string

The key the value inside of the provider type to use, only used with "Secret" type

Type: string

The name of the object located at the provider type.

Type: string

The namespace the Provider type is in.

Type: enum (of string)

The type of provider to use such as "Secret", or "ConfigMap".

Must be one of:

  • "Secret"
  • "ConfigMap"

Type: object

Headers

Each additional property must conform to the following schema

Type: string

Type: string

Webhook Method

Type: object

Result formatting

Type: string

Json path of return value

Type: array of object

Secrets to fill in templates
These secrets will be passed to the templating function as key value pairs under the given name

No Additional Items

Each item of this array must be:

Type: object

Type: string

Name of this secret in templates

Type: object

Secret ref to fill in credentials

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: string

Timeout

Type: string

Webhook url to call

Type: object

YandexLockbox configures this store to sync secrets using Yandex Lockbox provider

Type: string

Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')

Type: object

Auth defines the information necessary to authenticate against Yandex Lockbox

Type: object

The authorized key used for authentication

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

The provider for the CA bundle to use to validate Yandex.Cloud server certificate.

Type: object

A reference to a specific 'key' within a Secret resource,
In some instances, key is a required field.

Type: string

The key of the entry in the Secret resource's data field to be used. Some instances of this field may be
defaulted, in others it may be required.

Type: string

The name of the Secret resource being referred to.

Type: string

Namespace of the resource being referred to. Ignored if referent is not cluster-scoped. cluster-scoped defaults
to the namespace of the referent.

Type: object

Used to configure http retries if failed

Type: integerFormat: int32

Type: string

Type: object

SecretStoreStatus defines the observed state of the SecretStore.

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

Type: stringFormat: date-time