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 provider will assume

AWS Region to be used for the provider

AdditionalRoles is a chained list of Role ARNs which the provider will sequentially assume before assuming the Role

AWS External ID set on assumed IAM roles

AWS STS assume role session tags

SecretsManager defines how the provider behaves when interacting with AWS SecretsManager

AWS STS assume role transitive session tags. Required when multiple rules are used with the provider

Prefix adds a prefix to all retrieved values.

"ParameterStore"

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

"SecretsManager"

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

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 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.

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.

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

The AccessKeyID is used for authentication

The AccessKeySecret is used for authentication

Alibaba Region to be used for the provider

NTLMProtocol configures the store to use NTLM for auth

region is for configuring the AWS region to be used.

awsCredentialsSecretRef is the reference to the secret which holds the AWS credentials. Secret should be created with below names for keys - aws_access_key_id: Access Key ID, which is the unique identifier for the AWS account or the IAM user. - aws_secret_access_key: Secret Access Key, which is used to authenticate requests made to AWS services. - aws_session_token: Session Token, is the short-lived token to authenticate requests made to AWS services.

"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.

ActiveDirectoryEndpoint is the AAD endpoint for authentication Required when using custom cloud configuration

KeyVaultEndpoint is the Key Vault service endpoint

KeyVaultDNSSuffix is the DNS suffix for Key Vault URLs

ResourceManagerEndpoint is the Azure Resource Manager endpoint

"AzureStackCloud"

"ChinaCloud"

"GermanCloud"

"PublicCloud"

"USGovernmentCloud"

The Azure clientId of the service principle or managed identity used for authentication.

The Azure tenantId of the managed identity used for authentication.

The Azure ClientSecret of the service principle used for authentication.

The Azure ClientCertificate 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. Optional for WorkloadIdentity.

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, AzureStackCloud Use AzureStackCloud when you need to configure custom Azure Stack Hub or Azure Stack Edge endpoints.

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

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

UseAzureSDK enables the use of the new Azure SDK for Go (azcore-based) instead of the legacy go-autorest SDK. This is experimental and may have behavioral differences. Defaults to false (legacy SDK).

CustomCloudConfig defines custom Azure Stack Hub or Azure Stack Edge endpoints. Required when EnvironmentType is AzureStackCloud. IMPORTANT: This feature REQUIRES UseAzureSDK to be set to true. Custom cloud configuration is not supported with the legacy go-autorest SDK.

Value can be specified directly to set a value without using a secret.

SecretRef references a key in a secret that will be used as value.

APIKey If not provided then ClientID/ClientSecret become required.

ClientID is the API OAuth Client ID.

ClientSecret is the API OAuth Client Secret.

Certificate (cert.pem) for use when authenticating with an OAuth client Id using a Client Certificate.

Certificate private key (key.pem). For use when authenticating with an OAuth client Id

Auth configures how the operator authenticates with Beyondtrust.

Auth configures how API server works.

The secret retrieval type. SECRET = Secrets Safe (credential, text, file). MANAGED_ACCOUNT = Password Safe account associated with a system.

A character that separates the folder names.

Timeout specifies a time limit for requests made by this Client. The timeout includes connection time, any redirects, and reading the response body. Defaults to 45 seconds.

Base64 encoded certificate for the bitwarden server sdk. The sdk MUST run with HTTPS to make sure no MITM attack can be performed.

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

OrganizationID determines which organization this secret store manages.

ProjectID determines which project this secret store manages.

Auth configures how secret-manager authenticates with a bitwarden machine account instance. Make sure that the token being used has permissions on the given secret.

AccessToken used for the bitwarden instance.

The folder to fetch secrets from

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"

The AccessKeyID is used for authentication

The AccessKeySecret is used for authentication

SecretKey is the Signing Key in PEM format, used for authentication.

Auth defines the information necessary to authenticate against chef Server

UserName should be the user ID on the chef server

ServerURL is the chef server URL used to connect to. If using orgs you should include your org in the url and terminate the url with a “/”

ProjectID is the project, which the secrets are stored in.

"Ready"

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

Reason is why the ExternalSecret failed to apply to the namespace

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 metadata of the external secrets to be created

The labels to select by to find the Namespaces to create the ExternalSecrets in. Deprecated: Use NamespaceSelectors instead.

A list of labels to select by to find the Namespaces to create the ExternalSecrets in. The selectors are ORed.

Choose namespaces by name. This field is ORed with anything that NamespaceSelectors ends up choosing. Deprecated: Use NamespaceSelectors instead.

The time in which the controller should reconcile its objects and recheck namespaces for labels.

ExternalSecretName is the name of the ExternalSecrets created by the ClusterExternalSecret

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

Choose namespaces by using regex matching

name of the configmap.

namespace in which the configmap exists. If empty, configmap will looked up in local namespace.

key name holding the external account credential config.

Account is the Conjur organization account name.

A reference to a specific ‘key’ containing the Conjur username within a Secret resource. In some instances, key is a required field.

A reference to a specific ‘key’ containing the Conjur API key within a Secret resource. In some instances, key is a required field.

Authenticates with Conjur using an API key.

Jwt enables JWT authentication using Kubernetes service account tokens.

Account is the Conjur organization account name.

The conjur authn jwt webservice id

Optional HostID for JWT authentication. This may be used depending on how the Conjur JWT authenticator policy is configured.

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

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

URL is the endpoint of the Conjur instance.

CABundle is a PEM encoded CA bundle that will be used to validate the Conjur server certificate.

Used to provide custom certificate authority (CA) certificates for a secret store. The CAProvider points to a Secret or ConfigMap resource that contains a PEM-encoded certificate.

Defines authentication settings for connecting to Conjur.

ClientID is the non-secret part of the credential.

ClientSecret is the secret part of the credential.

Tenant is the chosen hostname / site name.

URLTemplate If unset, defaults to “https://%s.secretsvaultcloud.%s/v1/%s%s”.

TLD is based on the server location that was chosen during provisioning. If unset, defaults to “com”.

Value can be specified directly to set a value without using a secret.

SecretRef references a key in a secret that will be used as value.

URL configures the Device42 instance URL.

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

Username / Password is used for authentication.

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)

"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.

The key in the Kubernetes Secret to store the value.

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 be pulled.

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"

"CreatedOnce"

"OnChange"

"Periodic"

Used to merge key/values in one single Secret The resulting key will contain all values from the specified secrets

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

Used to apply string transformation on the secrets. The resulting key will be the output of the template applied by the operation.

Used to define the target key of the merge operation. Required if strategy is JSON. Ignored otherwise.

Used to define key priority in conflict resolution.

Used to define the policy to use in conflict resolution.

Used to define the strategy to use in the merge operation.

"Error"

"Ignore"

"Extract"

"JSON"

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

Used to define the target pattern of a ReplaceAll operation.

Used to define the template to apply on the secret name. .value will specify the secret name in the template.

RefreshPolicy determines how the ExternalSecret should be refreshed: - CreatedOnce: Creates the Secret only if it does not exist and does not update it thereafter - Periodic: Synchronizes the Secret from the external source at regular intervals specified by refreshInterval. No periodic updates occur if refreshInterval is 0. - OnChange: Only synchronizes the Secret when the ExternalSecret’s metadata or specification changes

RefreshInterval is the amount of time before the values are read again from the SecretStore provider, specified as Golang Duration strings. Valid time units are “ns”, “us” (or “µs”), “ms”, “s”, “m”, “h” Example values: “1h”, “2h30m”, “10s” 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

Binding represents a servicebinding.io Provisioned Service reference to the secret

The name of the Secret resource to be managed. 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

EngineVersion specifies the template engine version that should be used to compile/execute the template specified in .data and .templateFrom[].

Finds secrets base

APIURL is the URL of SDKMS API. Defaults to sdkms.fortanix.com.

APIKey is the API token to access SDKMS Applications.

SecretRef is a reference to a secret containing the SDKMS API Key.

The SecretAccessKey is used for authentication

Auth defines the information necessary to authenticate against GCP

ProjectID project where secret is located

Location optionally defines a location for a secret

ClusterLocation is the location of the cluster If not specified, it fetches information from the metadata server

ClusterName is the name of the cluster If not specified, it fetches information from the metadata server

ClusterProjectID is the project ID of the cluster If not specified, it fetches information from the metadata server

credConfig holds the configmap reference containing the GCP external account credential configuration in JSON format and the key name containing the json data. For using Kubernetes cluster as the identity provider, use serviceAccountRef instead. Operators mounted serviceaccount token cannot be used as the token source, instead serviceAccountRef must be used by providing operators service account details.

serviceAccountRef is the reference to the kubernetes ServiceAccount to be used for obtaining the tokens, when Kubernetes is configured as provider in workload identity pool.

awsSecurityCredentials is for configuring AWS region and credentials to use for obtaining the access token, when using the AWS metadata server is not an option.

audience is the Secure Token Service (STS) audience which contains the resource name for the workload identity pool and the provider identifier in that pool. If specified, Audience found in the external account credential config will be overridden with the configured value. audience must be provided when serviceAccountRef or awsSecurityCredentials is configured.

externalTokenEndpoint is the endpoint explicitly set up to provide tokens, which will be matched against the credential_source.url in the provided credConfig. This field is merely to double-check the external token source URL is having the expected value.

Specify the apiVersion of the generator resource

Specify the Kind of the generator resource

Specify the name of the generator resource

URL configures the Github instance URL. Defaults to https://github.com/.

Upload URL for enterprise instances. Default to URL.

auth configures how secret-manager authenticates with a Github instance.

appID specifies the Github APP that will be used to authenticate the client

installationID specifies the Github APP installation that will be used to authenticate the client

organization will be used to fetch secrets from the Github organization

repository will be used to fetch secrets from the Github repository within an organization

environment will be used to fetch secrets from a particular environment within a github repository

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)

Base64 encoded certificate for the GitLab server sdk. The sdk MUST run with HTTPS to make sure no MITM attack can be performed.

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

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

Auth configures how the Operator authenticates with the Infisical API

SecretsScope defines the scope of the secrets within the workspace

HostAPI specifies the base URL of the Infisical API. If not provided, it defaults to “https://app.infisical.com/api”.

Name defaults to “1Password SDK”.

Version defaults to “v1.0.0”.

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.

A reference to a secret that contains the auth information.

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

SecretsPath specifies the path to the secrets within the workspace. Defaults to “/” if not provided.

Recursive indicates whether the secrets should be fetched recursively. Defaults to false if not provided.

EnvironmentSlug is the required slug identifier for the environment.

ProjectSlug is the required slug identifier for the project.

ExpandSecretReferences indicates whether secret references should be expanded. Defaults to true if not provided.

true

false

OnboardbaseAPIKey is the APIKey generated by an admin account. It is used to recognize and authorize access to a project and environment within onboardbase

OnboardbasePasscode is the passcode attached to the API Key

Auth configures how the Operator authenticates with the Onboardbase API

APIHost use this to configure the host url for the API for selfhosted installation, default is https://public.onboardbase.com/api/v1/

Project is an onboardbase project that the secrets should be pulled from

Environment is the name of an environmnent within a project to pull the secrets from

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

ServiceAccountSecretRef points to the secret containing the token to access 1Password vault.

Vault defines the vault’s name or uuid to access. Do NOT add op:// prefix. This will be done automatically.

IntegrationInfo specifies the name and version of the integration built using the 1Password Go SDK. If you don’t know which name and version to use, use DefaultIntegrationName and DefaultIntegrationVersion, respectively.

Auth defines the information necessary to authenticate against OnePassword API.

Tenancy is the tenancy OCID where user is located.

User is an access OCID specific to the account.

SecretRef to pass through sensitive information.

"InstancePrincipal"

InstancePrincipal represents a instance principal.

"UserPrincipal"

UserPrincipal represents a user principal.

"Workload"

WorkloadPrincipal represents a workload principal.

Region is the region where vault is located.

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

Compartment is the vault compartment OCID. Required for PushSecret

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

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.

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

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

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

Fingerprint is the fingerprint of the API private key.

Auth defines the information necessary to authenticate against Passbolt Server

Host defines the Passbolt Server to connect to

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.

The AccessToken is used for authentication

APIURL is the URL of the Pulumi API.

AccessToken is the access tokens to sign in to the Pulumi Cloud Console.

Organization are a space to collaborate on shared projects and stacks. To create a new organization, visit https://app.pulumi.com/ and click “New Organization”.

Project is the name of the Pulumi ESC project the environment belongs to.

Environment are YAML documents composed of static key-value pairs, programmatic expressions, dynamically retrieved values from supported providers including all major clouds, and other Pulumi ESC environments. To create a new environment, visit https://www.pulumi.com/docs/esc/environments/ for more information.

SecretRef is a reference to a secret containing the Pulumi API token.

APIURL is the url of the api to use. Defaults to https://api.scaleway.com

Region where your secrets are located: https://developers.scaleway.com/en/quickstart/#region-and-zone

ProjectID is the id of your project, which you can find in the console: https://console.scaleway.com/project/settings

AccessKey is the non-secret part of the api key.

SecretKey is the non-secret part of the api key.

Value can be specified directly to set a value without using a secret.

SecretRef references a key in a secret that will be used as value.

name of the secret.

namespace in which the secret exists. If empty, secret will looked up in local namespace.

Username is the secret server account username.

Password is the secret server account password.

Domain is the secret server domain.

ServerURL URL to your secret server installation

Value can be specified directly to set a value without using a secret.

SecretRef references a key in a secret that will be used as value.

"ReadOnly"

"ReadWrite"

"WriteOnly"

"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

BitwardenSecretsManager configures this store to sync secrets using BitwardenSecretsManager 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

Github configures this store to push Github Action secrets using Github API 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

OnePasswordSDK configures this store to use 1Password’s new Go SDK to sync secrets.

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

Scaleway

Doppler configures this store to sync secrets using the Doppler provider

Previder configures this store to sync secrets using the Previder provider

Onboardbase configures this store to sync secrets using the Onboardbase provider

KeeperSecurity configures this store to sync secrets using the KeeperSecurity provider

Conjur configures this store to sync secrets using conjur provider

Delinea DevOps Secrets Vault https://docs.delinea.com/online-help/products/devops-secrets-vault/current

SecretServer configures this store to sync secrets using SecretServer provider https://docs.delinea.com/online-help/secret-server/start.htm

Chef configures this store to sync secrets with chef server

Pulumi configures this store to sync secrets using the Pulumi provider

Fortanix configures this store to sync secrets using the Fortanix provider

Device42 configures this store to sync secrets using the Device42 provider

Infisical configures this store to sync secrets using the Infisical provider

Beyondtrust configures this store to sync secrets using Password Safe provider.

CloudruSM configures this store to sync secrets using the Cloud.ru Secret Manager provider

Volcengine configures this store to sync secrets using the Volcengine provider

Name of the SecretStore resource

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

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

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

Specifies whether to delete the secret without any recovery window. You can’t use both this parameter and RecoveryWindowInDays in the same call. If you don’t use either, then by default Secrets Manager uses a 30 day recovery window. see: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-ForceDeleteWithoutRecovery

The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the secret. You can’t use both this parameter and ForceDeleteWithoutRecovery in the same call. If you don’t use either, then by default Secrets Manager uses a 30 day recovery window. see: https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_DeleteSecret.html#SecretsManager-DeleteSecret-request-RecoveryWindowInDays

"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.

GeneratorRef points to a generator custom resource.

Deprecated: The generatorRef is not implemented in .data[]. this will be removed with v1.

"v2"

"Merge"

"Replace"

The name of the ConfigMap/Secret resource

A list of keys in the ConfigMap/Secret to use as templates for Secret data

A key in the ConfigMap/Secret

"KeysAndValues"

"Values"

"Annotations"

"Data"

"Labels"

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 ID 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 id.

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.

Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in. 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 This will default to Vault.Namespace field if set, or empty otherwise

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

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

Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials AWS IAM authentication method

UserPass authenticates with Vault by passing username/password pair

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

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

Required when true, all write operations must include a check-and-set parameter. This helps prevent unintentional overwrites of secrets.

CertSecretRef is a certificate added to the transport layer when communicating with the Vault server. If no key for the Secret is specified, external-secret will default to ‘tls.crt’.

KeySecretRef to a key in a Secret resource containing client private key added to the transport layer when communicating with the Vault server. If no key for the Secret is specified, external-secret will default to ‘tls.key’.

Path where the AWS auth method is enabled in Vault, e.g: “aws”

AWS region

This is the AWS role to be assumed before talking to vault

Vault Role. In vault, a role describes an identity with a set of permissions, groups, or policies you want to attach a user of the secrets engine

AWS External ID set on assumed IAM roles

X-Vault-AWS-IAM-Server-ID is an additional header used by Vault IAM auth method to mitigate against different types of replay attacks. More details here: https://developer.hashicorp.com/vault/docs/auth/aws

Specify credentials in a Secret object

Specify a service account with IRSA enabled

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.

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.

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

Username is an LDAP username 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

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 configuration used for client side related TLS communication, when the Vault server requires mutual authentication. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. It’s worth noting this configuration is different from the “TLS certificates auth method”, which is available under the auth.cert section.

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

Headers to be added in Vault request

CheckAndSet defines the Check-And-Set (CAS) settings for PushSecret operations. Only applies to Vault KV v2 stores. When enabled, write operations must include the current version of the secret to prevent unintentional overwrites.

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

Username is a username 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

SecretRef defines the static credentials to use for authentication. If not set, IRSA is used.

AccessKeyID is the reference to the secret containing the Access Key ID.

SecretAccessKey is the reference to the secret containing the Secret Access Key.

Token is the reference to the secret containing the STS(Security Token Service) Token.

Region specifies the Volcengine region to connect to.

Auth defines the authentication method to use. If not specified, the provider will try to use IRSA (IAM Role for Service Account).

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.

"ConfigMap"

"Secret"

Webhook Method

Webhook url to call

Headers

Auth specifies a authorization protocol. Only one protocol may be set.

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.Cloud

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

FetchingPolicy configures the provider to interpret the data.secretKey.remoteRef.key field in ExternalSecret as certificate ID or certificate name

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

Auth defines the information necessary to authenticate against Yandex.Cloud

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

FetchingPolicy configures the provider to interpret the data.secretKey.remoteRef.key field in ExternalSecret as secret ID or secret name