The AccessKeyID is used for authentication

The SecretAccessKey is used for authentication

The SessionToken used for authentication This must be defined if AccessKeyID and SecretAccessKey are temporary credentials see: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html

Service defines which service should be used to fetch the secrets

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

Role is a Role ARN which the SecretManager provider will assume

AWS Region to be used for the provider

"ParameterStore"

AWSServiceParameterStore is the AWS SystemsManager ParameterStore. see: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html

"SecretsManager"

AWSServiceSecretsManager is the AWS SecretsManager. see: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html

The AccessKeyID is used for authentication

The AccessKeySecret is used for authentication

Alibaba Region to be used for the provider

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

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

The SecretAccessID is used for authentication

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

The name of the object located at the provider type.

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

The namespace the Provider type is in.

"ConfigMap"

"Secret"

the Akeyless Kubernetes auth-method access-id

Kubernetes-auth configuration name in Akeyless-Gateway

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.

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.

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

Auth configures how the operator authenticates with Akeyless.

The AccessKeyID is used for authentication

The AccessKeySecret is used for authentication

Alibaba Region to be used for the provider

"ManagedIdentity"

Using Managed Identity to authenticate. Used with aad-pod-identity installed in the cluster.

"ServicePrincipal"

Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.

"WorkloadIdentity"

Using Workload Identity service accounts to authenticate.

"ChinaCloud"

"GermanCloud"

"PublicCloud"

"USGovernmentCloud"

The Azure clientId of the service principle used for authentication.

The Azure ClientSecret of the service principle used for authentication.

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)

Vault Url from which the secrets to be fetched from.

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

EnvironmentType specifies the Azure cloud environment endpoints to use for connecting and authenticating with Azure. By default it points to the public cloud AAD endpoint. The following endpoints are available, also see here: https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152 PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud

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

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

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

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

The name of the object located at the provider type.

The key where the CA certificate can be found in the Secret or ConfigMap.

The namespace the Provider type is in. Can only be defined when used in a ClusterSecretStore.

"ConfigMap"

"Secret"

"NotReady"

"PartiallyReady"

"Ready"

Namespace is the namespace that failed when trying to apply an ExternalSecret

Reason is why the ExternalSecret failed to apply to the namespace

Immutable defines if the final secret will be immutable

The spec for the ExternalSecrets to be created

The name of the external secrets to be created defaults to the name of the ClusterExternalSecret

The labels to select by to find the Namespaces to create the ExternalSecrets in.

The time in which the controller should reconcile it’s objects and recheck namespaces for labels.

Failed namespaces are the namespaces that failed to apply an ExternalSecret

ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets

Choose namespace using a labelSelector

Choose namespaces by name

The DopplerToken is used for authentication. See https://docs.doppler.com/reference/api#authentication for auth token types. The Key attribute defaults to dopplerToken if not specified.

Auth configures how the Operator authenticates with the Doppler API

Doppler project (required if not using a Service Token)

Doppler config (required if not using a Service Token)

Environment variable compatible name transforms that change secret names to a different format

Format enables the downloading of secrets as a file (string)

SecretRef to pass through sensitive information.

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

User is an access OCID specific to the account.

projectID is an access token specific to the secret.

projectID is an access token specific to the secret.

The Access Token is used for authentication

projectID is an access token specific to the secret.

URL configures the Password Depot instance URL.

Database to use as source

Auth configures how secret-manager authenticates with a Password Depot instance.

Username / Password is used for authentication.

"Deleted"

"Ready"

"Default"

"Unicode"

"Merge"

Merge does not create the Secret, but merges the data fields to the Secret.

"None"

None does not create a Secret (future use with injector).

"Orphan"

Orphan creates the Secret and does not set the ownerReference. I.e. it will be orphaned after the deletion of the ExternalSecret.

"Owner"

Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.

SecretKey defines the key in which the controller stores the value. This is the key in the Kind=Secret

RemoteRef points to the remote secret and defines which secret (version/property/..) to fetch.

SourceRef allows you to override the source from which the value will pulled from.

Used to extract multiple key/value pairs from one secret Note: Extract does not support sourceRef.Generator or sourceRef.GeneratorRef.

Used to find secrets based on tags or regular expressions Note: Find does not support sourceRef.Generator or sourceRef.GeneratorRef.

Used to rewrite secret Keys after getting them from the secret Provider Multiple Rewrite operations can be provided. They are applied in a layered order (first to last)

SourceRef points to a store or generator which contains secret values ready to use. Use this in combination with Extract or Find pull values out of a specific SecretStore. When sourceRef points to a generator Extract or Find is not supported. The generator returns a static map of values

Key is the key used in the Provider, mandatory

Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None

Used to select a specific property of the Provider value (if a map), if supported

Used to select a specific version of the Provider value, if supported

Used to define a conversion Strategy

Used to define a decoding Strategy

"Auto"

"Base64"

"Base64URL"

"None"

"Delete"

Delete deletes the secret if all provider secrets are deleted. If a secret gets deleted on the provider side and is not accessible anymore this is not considered an error and the ExternalSecret does not go into SecretSyncedError status.

"Merge"

Merge removes keys in the secret, but not the secret itself. If a secret gets deleted on the provider side and is not accessible anymore this is not considered an error and the ExternalSecret does not go into SecretSyncedError status.

"Retain"

Retain will retain the secret if all provider secrets have been deleted. If a provider secret does not exist the ExternalSecret gets into the SecretSyncedError status.

A root path to start the find operations.

Finds secrets based on the name.

Find secrets based on tags.

Used to define a conversion Strategy

Used to define a decoding Strategy

"Fetch"

"None"

Used to rewrite with regular expressions. The resulting key will be the output of a regexp.ReplaceAll operation.

Used to define the regular expression of a re.Compiler.

Used to define the target pattern of a ReplaceAll operation.

RefreshInterval is the amount of time before the values are read again from the SecretStore provider Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h” May be set to zero to fetch and create it once. Defaults to 1h.

Data defines the connection between the Kubernetes Secret keys and the Provider data

DataFrom is used to fetch all properties from a specific Provider data If multiple entries are specified, the Secret keys are merged in the specified order

refreshTime is the time and date the external secret was fetched and the target secret updated

SyncedResourceVersion keeps track of the last synced version

Name defines the name of the Secret resource to be managed This field is immutable Defaults to the .metadata.name of the ExternalSecret resource

CreationPolicy defines rules on how to create the resulting Secret Defaults to ‘Owner’

DeletionPolicy defines rules on how to delete the resulting Secret Defaults to ‘Retain’

Template defines a blueprint for the created Secret resource.

Immutable defines if the final secret will be immutable

Finds secrets base

The SecretAccessKey is used for authentication

Auth defines the information necessary to authenticate against GCP

ProjectID project where secret is located

Specify the apiVersion of the generator resource

Specify the Kind of the resource, e.g. Password, ACRAccessToken etc.

Specify the name of the generator resource

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

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

ProjectID specifies a project where secrets are located.

InheritFromGroups specifies whether parent groups should be discovered and checked for secrets.

GroupIDs specify, which gitlab groups to pull secrets from. Group secrets are read from left to right followed by the project variables.

Environment environment_scope of gitlab CI/CD variables (Please see https://docs.gitlab.com/ee/ci/environments/#create-a-static-environment on how to create environments)

AccessToken is used for authentication.

the IBM Trusted Profile

Location the token is mounted on the pod

The SecretAccessKey is used for authentication

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

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

has both clientCert and clientKey as secretKeySelector

use static token to authenticate with

points to a service account that should be used for authentication

configures the Kubernetes server Address.

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

Remote namespace to fetch the secrets from

configures the Kubernetes server Address.

CABundle is a base64-encoded CA certificate

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

The ConnectToken is used for authentication to a 1Password Connect Server.

Auth defines the information necessary to authenticate against OnePassword Connect Server

ConnectHost defines the OnePassword Connect Server to connect to

Vaults defines which OnePassword vaults to search in which order

Tenancy is the tenancy OCID where user is located.

User is an access OCID specific to the account.

SecretRef to pass through sensitive information.

Region is the region where vault is located.

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

Auth configures how secret-manager authenticates with the Oracle Vault. If empty, use the instance principal, otherwise the user credentials specified in Auth.

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

Fingerprint is the fingerprint of the API private key.

"Ready"

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

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

Akeyless configures this store to sync secrets using Akeyless Vault provider

Vault configures this store to sync secrets using Hashi provider

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

Oracle configures this store to sync secrets using Oracle Vault provider

IBM configures this store to sync secrets using IBM Cloud provider

YandexCertificateManager configures this store to sync secrets using Yandex Certificate Manager provider

YandexLockbox configures this store to sync secrets using Yandex Lockbox provider

GitLab configures this store to sync secrets using GitLab Variables provider

Alibaba configures this store to sync secrets using Alibaba Cloud provider

OnePassword configures this store to sync secrets using the 1Password Cloud provider

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

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

Fake configures a store with static key/value pairs

Senhasegura configures this store to sync secrets using senhasegura provider

Doppler configures this store to sync secrets using the Doppler provider

Name of the SecretStore resource

Kind of the SecretStore resource (SecretStore or ClusterSecretStore) Defaults to SecretStore

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

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

Used to configure http retries if failed

Used to configure store refresh interval in seconds. Empty or 0 will default to the controller config.

Used to constraint a ClusterSecretStore to specific namespaces. Relevant only to ClusterSecretStore

"DSM"

	SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module
see: https://senhasegura.com/devops

URL of senhasegura

Module defines which senhasegura module should be used to get secrets

Auth defines parameters to authenticate in senhasegura

IgnoreSslCertificate defines if SSL certificate must be ignored

GeneratorRef points to a generator custom resource in

"v1"

"v2"

"KeysAndValues"

"Values"

"Annotations"

"Data"

"Labels"

"StringData"

2

Error indicates that there is a misconfiguration.

0

Ready indicates that the client is configured correctly and can be used.

1

Unknown indicates that the client can be used but information is missing and it can not be validated.

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

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

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.

TokenSecretRef authenticates with Vault by presenting a token.

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

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

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

UserPass authenticates with Vault by passing username/password pair using the userPass authentication method

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

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

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

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

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

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

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

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

"v1"

"v2"

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

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.

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.

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

Oracle configures this store to sync secrets using Oracle Vault provider

Service account field containing the name of a kubernetes ServiceAccount.

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. Deprecated: use serviceAccountRef.Audiences instead

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

Alibaba configures this store to sync secrets using Alibaba Cloud provider

PasswordDepot configures this store to sync secrets using PasswordDepot provider

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

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

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

Path where the UserPass authentication backend is mounted in Vault, e.g: “userpass”

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

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

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

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

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.

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

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

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.

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

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

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#allow_forwarding_via_header

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

The name of the object located at the provider type.

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

The namespace the Provider type is in.

"ConfigMap"

"Secret"

Webhook Method

Webhook url to call

Headers

Body

Timeout

Result formatting

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

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.

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

Json path of return value

Name of this secret in templates

Secret ref to fill in credentials

The authorized key used for authentication

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

Auth defines the information necessary to authenticate against Yandex Certificate Manager

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

The authorized key used for authentication

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

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

Auth defines the information necessary to authenticate against Yandex Lockbox

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