helm-external-secrets/docs/spec.md

Packages:

• external-secrets.io/v1beta1

external-secrets.io/v1beta1

Package v1beta1 contains resources for external-secrets

Resource Types:

AWSAuth

(Appears on: AWSProvider)

AWSAuth tells the controller how to do authentication with aws. Only one of secretRef or jwt can be specified. if none is specified the controller will load credentials using the aws sdk defaults.

AWSAuthSecretRef AWSJWTAuth

Field	Description
secretRef
(Optional)
jwt
(Optional)

AWSAuthSecretRef

(Appears on: AWSAuth)

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

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
accessKeyIDSecretRef
The AccessKeyID is used for authentication
secretAccessKeySecretRef
The SecretAccessKey is used for authentication

AWSJWTAuth

(Appears on: AWSAuth)

Authenticate against AWS using service account tokens.

github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector

Field	Description
serviceAccountRef

AWSProvider

(Appears on: SecretStoreProvider)

AWSProvider configures a store to sync secrets with AWS.

AWSServiceType AWSAuth

Field	Description
service
Service defines which service should be used to fetch the secrets
auth
(Optional) 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 string (Optional)

Role is a Role ARN which the SecretManager provider will assume

region string

AWS Region to be used for the provider

AWSServiceType (string alias)

(Appears on: AWSProvider)

AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.

Value	Description
"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

AkeylessAuth

(Appears on: AkeylessProvider)

AkeylessAuthSecretRef

Field	Description
secretRef

AkeylessAuthSecretRef

(Appears on: AkeylessAuth)

AkeylessAuthSecretRef AKEYLESS_ACCESS_TYPE_PARAM: AZURE_OBJ_ID OR GCP_AUDIENCE OR ACCESS_KEY OR KUB_CONFIG_NAME.

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
accessID
The SecretAccessID is used for authentication
accessType

accessTypeParam github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

AkeylessProvider

(Appears on: SecretStoreProvider)

AkeylessProvider Configures an store to sync secrets using Akeyless KV.

string AkeylessAuth

Field	Description
akeylessGWApiURL
Akeyless GW API Url from which the secrets to be fetched from.
authSecretRef
Auth configures how the operator authenticates with Akeyless.

AlibabaAuth

(Appears on: AlibabaProvider)

AlibabaAuth contains a secretRef for credentials.

AlibabaAuthSecretRef

Field	Description
secretRef

AlibabaAuthSecretRef

(Appears on: AlibabaAuth)

AlibabaAuthSecretRef holds secret references for Alibaba credentials.

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
accessKeyIDSecretRef
The AccessKeyID is used for authentication
accessKeySecretSecretRef
The AccessKeySecret is used for authentication

AlibabaProvider

(Appears on: SecretStoreProvider)

AlibabaProvider configures a store to sync secrets using the Alibaba Secret Manager provider.

AlibabaAuth string

Field	Description
auth
endpoint
(Optional)

regionID string

Alibaba Region to be used for the provider

AzureAuthType (string alias)

(Appears on: AzureKVProvider)

AuthType describes how to authenticate to the Azure Keyvault Only one of the following auth types may be specified. If none of the following auth type is specified, the default one is ServicePrincipal.

Value	Description
"ManagedIdentity"	Using Managed Identity to authenticate. Used with aad-pod-identity installed in the clister.
"ServicePrincipal"	Using service principal to authenticate, which needs a tenantId, a clientId and a clientSecret.
"WorkloadIdentity"	Using Workload Identity service accounts to authenticate.

AzureKVAuth

(Appears on: AzureKVProvider)

Configuration used to authenticate with Azure.

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
clientId
(Optional) The Azure clientId of the service principle used for authentication.
clientSecret
(Optional) The Azure ClientSecret of the service principle used for authentication.

AzureKVProvider

(Appears on: SecretStoreProvider)

Configures an store to sync secrets using Azure KV.

AzureAuthType string

Field	Description
authType
(Optional) 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)
vaultUrl
Vault Url from which the secrets to be fetched from.

tenantId string (Optional)

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

authSecretRef AzureKVAuth (Optional)

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

serviceAccountRef github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector (Optional)

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

identityId string (Optional)

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

CAProvider

(Appears on: KubernetesServer, VaultProvider)

Defines a location to fetch the cert for the vault provider from.

CAProviderType string

Field	Description
type
The type of provider to use such as “Secret”, or “ConfigMap”.
name
The name of the object located at the provider type.

key string

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

namespace string (Optional)

The namespace the Provider type is in.

CAProviderType (string alias)

(Appears on: CAProvider)

Value	Description
"ConfigMap"
"Secret"

CertAuth

(Appears on: KubernetesAuth)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
clientCert
clientKey

ClusterExternalSecret

ClusterExternalSecret is the Schema for the clusterexternalsecrets API.

Kubernetes meta/v1.ObjectMeta ClusterExternalSecretSpec string Kubernetes meta/v1.LabelSelector

Field	Description
metadata
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ExternalSecretSpec externalSecretSpec The spec for the ExternalSecrets to be created
externalSecretName
(Optional) The name of the external secrets to be created defaults to the name of the ClusterExternalSecret
namespaceSelector
The labels to select by to find the Namespaces to create the ExternalSecrets in.

refreshTime Kubernetes meta/v1.Duration

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

status ClusterExternalSecretStatus

ClusterExternalSecretConditionType (string alias)

(Appears on: ClusterExternalSecretStatusCondition)

Value	Description
"NotReady"
"PartiallyReady"
"Ready"

ClusterExternalSecretNamespaceFailure

(Appears on: ClusterExternalSecretStatus)

ClusterExternalSecretNamespaceFailure represents a failed namespace deployment and it’s reason.

string string

Field	Description
namespace
Namespace is the namespace that failed when trying to apply an ExternalSecret
reason
(Optional) Reason is why the ExternalSecret failed to apply to the namespace

ClusterExternalSecretSpec

(Appears on: ClusterExternalSecret)

ClusterExternalSecretSpec defines the desired state of ClusterExternalSecret.

ExternalSecretSpec string

Field	Description
externalSecretSpec
The spec for the ExternalSecrets to be created
externalSecretName
(Optional) The name of the external secrets to be created defaults to the name of the ClusterExternalSecret

namespaceSelector Kubernetes meta/v1.LabelSelector

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

refreshTime Kubernetes meta/v1.Duration

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

ClusterExternalSecretStatus

(Appears on: ClusterExternalSecret)

ClusterExternalSecretStatus defines the observed state of ClusterExternalSecret.

[]ClusterExternalSecretNamespaceFailure []string

Field	Description
failedNamespaces
(Optional) Failed namespaces are the namespaces that failed to apply an ExternalSecret
provisionedNamespaces
(Optional) ProvisionedNamespaces are the namespaces where the ClusterExternalSecret has secrets

conditions []ClusterExternalSecretStatusCondition (Optional)

ClusterExternalSecretStatusCondition

(Appears on: ClusterExternalSecretStatus)

ClusterExternalSecretConditionType Kubernetes core/v1.ConditionStatus

Field	Description
type
status

message string (Optional)

ClusterSecretStore

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

Kubernetes meta/v1.ObjectMeta SecretStoreSpec SecretStoreProvider SecretStoreRetrySettings

Field	Description
metadata
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
string controller (Optional) 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
provider
Used to configure the provider. Only one provider may be set
retrySettings
(Optional) Used to configure http retries if failed

refreshInterval int (Optional)

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

status SecretStoreStatus

ExternalSecret

ExternalSecret is the Schema for the external-secrets API.

Kubernetes meta/v1.ObjectMeta ExternalSecretSpec ExternalSecretTarget Kubernetes meta/v1.Duration

Field	Description
metadata
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SecretStoreRef secretStoreRef
target
(Optional)
refreshInterval
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 []ExternalSecretData (Optional)

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

dataFrom []ExternalSecretDataFromRemoteRef (Optional)

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

status ExternalSecretStatus

ExternalSecretConditionType (string alias)

(Appears on: ExternalSecretStatusCondition)

Value	Description
"Deleted"
"Ready"

ExternalSecretConversionStrategy (string alias)

(Appears on: ExternalSecretDataRemoteRef, ExternalSecretFind)

Value	Description
"Default"
"Unicode"

ExternalSecretCreationPolicy (string alias)

(Appears on: ExternalSecretTarget)

ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.

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

ExternalSecretData

(Appears on: ExternalSecretSpec)

ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.) and the Provider data.

string ExternalSecretDataRemoteRef

Field	Description
secretKey
remoteRef

ExternalSecretDataFromRemoteRef

(Appears on: ExternalSecretSpec)

ExternalSecretDataRemoteRef ExternalSecretFind

Field	Description
extract
(Optional) Used to extract multiple key/value pairs from one secret
find
(Optional) Used to find secrets based on tags or regular expressions

ExternalSecretDataRemoteRef

(Appears on: ExternalSecretData, ExternalSecretDataFromRemoteRef)

ExternalSecretDataRemoteRef defines Provider data location.

string ExternalSecretMetadataPolicy

Field	Description
key
Key is the key used in the Provider, mandatory
metadataPolicy
(Optional) Policy for fetching tags/labels from provider secrets, possible options are Fetch, None. Defaults to None

property string (Optional)

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

version string (Optional)

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

conversionStrategy ExternalSecretConversionStrategy (Optional)

Used to define a conversion Strategy

ExternalSecretDeletionPolicy (string alias)

(Appears on: ExternalSecretTarget)

ExternalSecretDeletionPolicy defines rules on how to delete the resulting Secret.

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

ExternalSecretFind

(Appears on: ExternalSecretDataFromRemoteRef)

string FindName

Field	Description
path
(Optional) A root path to start the find operations.
name
(Optional) Finds secrets based on the name.

tags map[string]string (Optional)

Find secrets based on tags.

conversionStrategy ExternalSecretConversionStrategy (Optional)

Used to define a conversion Strategy

ExternalSecretMetadataPolicy (string alias)

(Appears on: ExternalSecretDataRemoteRef)

Value	Description
"Fetch"
"None"

ExternalSecretSpec

(Appears on: ClusterExternalSecretSpec, ExternalSecret)

ExternalSecretSpec defines the desired state of ExternalSecret.

SecretStoreRef ExternalSecretTarget

Field	Description
secretStoreRef
target
(Optional)

refreshInterval Kubernetes meta/v1.Duration

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 []ExternalSecretData (Optional)

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

dataFrom []ExternalSecretDataFromRemoteRef (Optional)

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

ExternalSecretStatus

(Appears on: ExternalSecret)

Kubernetes meta/v1.Time string

Field	Description
refreshTime
refreshTime is the time and date the external secret was fetched and the target secret updated
syncedResourceVersion
SyncedResourceVersion keeps track of the last synced version

conditions []ExternalSecretStatusCondition (Optional)

ExternalSecretStatusCondition

(Appears on: ExternalSecretStatus)

ExternalSecretConditionType Kubernetes core/v1.ConditionStatus

Field	Description
type
status

reason string (Optional) message string (Optional) lastTransitionTime Kubernetes meta/v1.Time (Optional)

ExternalSecretTarget

(Appears on: ExternalSecretSpec)

ExternalSecretTarget defines the Kubernetes Secret to be created There can be only one target per ExternalSecret.

string ExternalSecretCreationPolicy

Field	Description
name
(Optional) 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
(Optional) CreationPolicy defines rules on how to create the resulting Secret Defaults to ‘Owner’

deletionPolicy ExternalSecretDeletionPolicy (Optional)

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

template ExternalSecretTemplate (Optional)

Template defines a blueprint for the created Secret resource.

immutable bool (Optional)

Immutable defines if the final secret will be immutable

ExternalSecretTemplate

(Appears on: ExternalSecretTarget)

ExternalSecretTemplate defines a blueprint for the created Secret resource. we can not use native corev1.Secret, it will have empty ObjectMeta values: https://github.com/kubernetes-sigs/controller-tools/issues/448

Kubernetes core/v1.SecretType TemplateEngineVersion

Field	Description
type
(Optional)
engineVersion

metadata ExternalSecretTemplateMetadata (Optional) data map[string]string (Optional) templateFrom []TemplateFrom (Optional)

ExternalSecretTemplateMetadata

(Appears on: ExternalSecretTemplate)

ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.

map[string]string map[string]string

Field	Description
annotations
(Optional)
labels
(Optional)

ExternalSecretValidator

FakeProvider

(Appears on: SecretStoreProvider)

FakeProvider configures a fake provider that returns static values.

[]FakeProviderData

Field	Description
data

FakeProviderData

(Appears on: FakeProvider)

string string

Field	Description
key
value

valueMap map[string]string version string

FindName

(Appears on: ExternalSecretFind)

string

Field	Description
regexp
(Optional) Finds secrets base

GCPSMAuth

(Appears on: GCPSMProvider)

GCPSMAuthSecretRef GCPWorkloadIdentity

Field	Description
secretRef
(Optional)
workloadIdentity
(Optional)

GCPSMAuthSecretRef

(Appears on: GCPSMAuth)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
secretAccessKeySecretRef
(Optional) The SecretAccessKey is used for authentication

GCPSMProvider

(Appears on: SecretStoreProvider)

GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.

GCPSMAuth string

Field	Description
auth
(Optional) Auth defines the information necessary to authenticate against GCP
projectID
ProjectID project where secret is located

GCPWorkloadIdentity

(Appears on: GCPSMAuth)

github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector string

Field	Description
serviceAccountRef
clusterLocation

clusterName string clusterProjectID string

GenericStore

GenericStore is a common interface for interacting with ClusterSecretStore or a namespaced SecretStore.

GenericStoreValidator

GitlabAuth

(Appears on: GitlabProvider)

GitlabSecretRef

Field	Description
SecretRef

GitlabProvider

(Appears on: SecretStoreProvider)

Configures a store to sync secrets with a GitLab instance.

string GitlabAuth

Field	Description
url
URL configures the GitLab instance URL. Defaults to https://gitlab.com/.
auth
Auth configures how secret-manager authenticates with a GitLab instance.

projectID string

ProjectID specifies a project where secrets are located.

GitlabSecretRef

(Appears on: GitlabAuth)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
accessToken
AccessToken is used for authentication.

IBMAuth

(Appears on: IBMProvider)

IBMAuthSecretRef IBMAuthContainerAuth

Field	Description
secretRef
containerAuth

IBMAuthContainerAuth

(Appears on: IBMAuth)

IBM Container-based auth with IAM Trusted Profile.

string string

Field	Description
profile
the IBM Trusted Profile
tokenLocation
Location the token is mounted on the pod

iamEndpoint string

IBMAuthSecretRef

(Appears on: IBMAuth)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
secretApiKeySecretRef
The SecretAccessKey is used for authentication

IBMProvider

(Appears on: SecretStoreProvider)

Configures an store to sync secrets using a IBM Cloud Secrets Manager backend.

IBMAuth string

Field	Description
auth
Auth configures how secret-manager authenticates with the IBM secrets manager.
serviceUrl
ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance

KubernetesAuth

(Appears on: KubernetesProvider)

CertAuth TokenAuth

Field	Description
cert
(Optional) has both clientCert and clientKey as secretKeySelector
token
(Optional) use static token to authenticate with

serviceAccount github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector (Optional)

points to a service account that should be used for authentication

KubernetesProvider

(Appears on: SecretStoreProvider)

Configures a store to sync secrets with a Kubernetes instance.

KubernetesServer KubernetesAuth

Field	Description
server
configures the Kubernetes server Address.
auth
Auth configures how secret-manager authenticates with a Kubernetes instance.

remoteNamespace string (Optional)

Remote namespace to fetch the secrets from

KubernetesServer

(Appears on: KubernetesProvider)

string []byte

Field	Description
url
(Optional) configures the Kubernetes server Address.
caBundle
(Optional) CABundle is a base64-encoded CA certificate

caProvider CAProvider (Optional)

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

NoSecretError

NoSecretError shall be returned when a GetSecret can not find the desired secret. This is used for deletionPolicy.

OnePasswordAuth

(Appears on: OnePasswordProvider)

OnePasswordAuth contains a secretRef for credentials.

OnePasswordAuthSecretRef

Field	Description
secretRef

OnePasswordAuthSecretRef

(Appears on: OnePasswordAuth)

OnePasswordAuthSecretRef holds secret references for 1Password credentials.

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

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

OnePasswordProvider

(Appears on: SecretStoreProvider)

OnePasswordProvider configures a store to sync secrets using the 1Password Secret Manager provider.

OnePasswordAuth string

Field	Description
auth
Auth defines the information necessary to authenticate against OnePassword Connect Server
connectHost
ConnectHost defines the OnePassword Connect Server to connect to

vaults map[string]int

Vaults defines which OnePassword vaults to search in which order

OracleAuth

(Appears on: OracleProvider)

string string

Field	Description
tenancy
Tenancy is the tenancy OCID where user is located.
user
User is an access OCID specific to the account.

secretRef OracleSecretRef

SecretRef to pass through sensitive information.

OracleProvider

(Appears on: SecretStoreProvider)

Configures an store to sync secrets using a Oracle Vault backend.

string string

Field	Description
region
Region is the region where vault is located.
vault
Vault is the vault’s OCID of the specific vault where secret is located.

auth OracleAuth (Optional)

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

OracleSecretRef

(Appears on: OracleAuth)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
privatekey
PrivateKey is the user’s API Signing Key in PEM format, used for authentication.
fingerprint
Fingerprint is the fingerprint of the API private key.

Provider

Provider is a common interface for interacting with secret backends.

SecretStore

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

Kubernetes meta/v1.ObjectMeta SecretStoreSpec SecretStoreProvider SecretStoreRetrySettings

Field	Description
metadata
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
string controller (Optional) 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
provider
Used to configure the provider. Only one provider may be set
retrySettings
(Optional) Used to configure http retries if failed

refreshInterval int (Optional)

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

status SecretStoreStatus

SecretStoreConditionType (string alias)

(Appears on: SecretStoreStatusCondition)

Value	Description
"Ready"

SecretStoreProvider

(Appears on: SecretStoreSpec)

SecretStoreProvider contains the provider-specific configration.

AWSProvider AzureKVProvider

Field	Description
aws
(Optional) AWS configures this store to sync secrets using AWS Secret Manager provider
azurekv
(Optional) AzureKV configures this store to sync secrets using Azure Key Vault provider

akeyless AkeylessProvider (Optional)

Akeyless configures this store to sync secrets using Akeyless Vault provider

vault VaultProvider (Optional)

Vault configures this store to sync secrets using Hashi provider

gcpsm GCPSMProvider (Optional)

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

oracle OracleProvider (Optional)

Oracle configures this store to sync secrets using Oracle Vault provider

ibm IBMProvider (Optional)

IBM configures this store to sync secrets using IBM Cloud provider

yandexcertificatemanager YandexCertificateManagerProvider (Optional)

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

yandexlockbox YandexLockboxProvider (Optional)

YandexLockbox configures this store to sync secrets using Yandex Lockbox provider

gitlab GitlabProvider (Optional)

Gitlab configures this store to sync secrets using Gitlab Variables provider

alibaba AlibabaProvider (Optional)

Alibaba configures this store to sync secrets using Alibaba Cloud provider

onepassword OnePasswordProvider (Optional)

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

webhook WebhookProvider (Optional)

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

kubernetes KubernetesProvider (Optional)

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

fake FakeProvider (Optional)

Fake configures a store with static key/value pairs

senhasegura SenhaseguraProvider (Optional)

Senhasegura configures this store to sync secrets using senhasegura provider

SecretStoreRef

(Appears on: ExternalSecretSpec)

SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.

string string

Field	Description
name
Name of the SecretStore resource
kind
(Optional) Kind of the SecretStore resource (SecretStore or ClusterSecretStore) Defaults to SecretStore

SecretStoreRetrySettings

(Appears on: SecretStoreSpec)

int32 string

Field	Description
maxRetries
retryInterval

SecretStoreSpec

(Appears on: ClusterSecretStore, SecretStore)

SecretStoreSpec defines the desired state of SecretStore.

string SecretStoreProvider

Field	Description
controller
(Optional) 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
provider
Used to configure the provider. Only one provider may be set

retrySettings SecretStoreRetrySettings (Optional)

Used to configure http retries if failed

refreshInterval int (Optional)

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

SecretStoreStatus

(Appears on: ClusterSecretStore, SecretStore)

SecretStoreStatus defines the observed state of the SecretStore.

[]SecretStoreStatusCondition

Field	Description
conditions
(Optional)

SecretStoreStatusCondition

(Appears on: SecretStoreStatus)

SecretStoreConditionType Kubernetes core/v1.ConditionStatus

Field	Description
type
status

reason string (Optional) message string (Optional) lastTransitionTime Kubernetes meta/v1.Time (Optional)

SecretsClient

SecretsClient provides access to secrets.

SenhaseguraAuth

(Appears on: SenhaseguraProvider)

SenhaseguraAuth tells the controller how to do auth in senhasegura

string github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
clientId
clientSecretSecretRef

SenhaseguraModuleType (string alias)

(Appears on: SenhaseguraProvider)

SenhaseguraModuleType enum defines senhasegura target module to fetch secrets

Value	Description
"DSM"	SenhaseguraModuleDSM is the senhasegura DevOps Secrets Management module see: https://senhasegura.com/devops

SenhaseguraProvider

(Appears on: SecretStoreProvider)

SenhaseguraProvider setup a store to sync secrets with senhasegura

string SenhaseguraModuleType

Field	Description
url
URL of senhasegura
module
Module defines which senhasegura module should be used to get secrets

auth SenhaseguraAuth

Auth defines parameters to authenticate in senhasegura

ignoreSslCertificate bool

IgnoreSslCertificate defines if SSL certificate must be ignored

TemplateEngineVersion (string alias)

(Appears on: ExternalSecretTemplate)

Value	Description
"v1"
"v2"

TemplateFrom

(Appears on: ExternalSecretTemplate)

TemplateRef TemplateRef

Field	Description
configMap
secret

TemplateRef

(Appears on: TemplateFrom)

string []TemplateRefItem

Field	Description
name
items

TemplateRefItem

(Appears on: TemplateRef)

string

Field	Description
key

TokenAuth

(Appears on: KubernetesAuth)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
bearerToken

ValidationResult (byte alias)

Value	Description
2	Error indicates that there is a misconfiguration.
0	Ready indicates that the client is confgured correctly and can be used.
1	Unknown indicates that the client can be used but information is missing and it can not be validated.

VaultAppRole

(Appears on: VaultAuth)

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

string string

Field	Description
path
Path where the App Role authentication backend is mounted in Vault, e.g: “approle”
roleId
RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault.

secretRef github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

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.

VaultAuth

(Appears on: VaultProvider)

VaultAuth is the configuration used to authenticate with a Vault server. Only one of tokenSecretRef, appRole, kubernetes, ldap, jwt or cert can be specified.

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector VaultAppRole

Field	Description
tokenSecretRef
(Optional) TokenSecretRef authenticates with Vault by presenting a token.
appRole
(Optional) AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.

kubernetes VaultKubernetesAuth (Optional)

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

ldap VaultLdapAuth (Optional)

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

jwt VaultJwtAuth (Optional)

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

cert VaultCertAuth (Optional)

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

VaultCertAuth

(Appears on: VaultAuth)

VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication method, with the role name and token stored in a Kubernetes Secret resource.

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
clientCert
(Optional) ClientCert is a certificate to authenticate using the Cert Vault authentication method
secretRef
SecretRef to a key in a Secret resource containing client private key to authenticate with Vault using the Cert authentication method

VaultJwtAuth

(Appears on: VaultAuth)

VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication method, with the role name and a token stored in a Kubernetes Secret resource or a Kubernetes service account token retrieved via TokenRequest.

string string

Field	Description
path
Path where the JWT authentication backend is mounted in Vault, e.g: “jwt”
role
(Optional) Role is a JWT role to authenticate using the JWT/OIDC Vault authentication method

secretRef github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector (Optional)

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

kubernetesServiceAccountToken VaultKubernetesServiceAccountTokenAuth (Optional)

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

VaultKVStoreVersion (string alias)

(Appears on: VaultProvider)

Value	Description
"v1"
"v2"

VaultKubernetesAuth

(Appears on: VaultAuth)

Authenticate against Vault using a Kubernetes ServiceAccount token stored in a Secret.

string github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector

Field	Description
mountPath
Path where the Kubernetes authentication backend is mounted in Vault, e.g: “kubernetes”
serviceAccountRef
(Optional) 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.

secretRef github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector (Optional)

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.

role string

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

VaultKubernetesServiceAccountTokenAuth

(Appears on: VaultJwtAuth)

VaultKubernetesServiceAccountTokenAuth authenticates with Vault using a temporary Kubernetes service account token retrieved by the TokenRequest API.

github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector []string

Field	Description
serviceAccountRef
Service account field containing the name of a kubernetes ServiceAccount.
audiences
(Optional) 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.

expirationSeconds int64 (Optional)

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.

VaultLdapAuth

(Appears on: VaultAuth)

VaultLdapAuth authenticates with Vault using the LDAP authentication method, with the username and password stored in a Kubernetes Secret resource.

string string

Field	Description
path
Path where the LDAP authentication backend is mounted in Vault, e.g: “ldap”
username
Username is a LDAP user name used to authenticate using the LDAP Vault authentication method

secretRef github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

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

VaultProvider

(Appears on: SecretStoreProvider)

Configures an store to sync secrets using a HashiCorp Vault KV backend.

VaultAuth string

Field	Description
auth
Auth configures how secret-manager authenticates with the Vault server.
server
Server is the connection address for the Vault server, e.g: “https://vault.example.com:8200”.

path string (Optional)

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 VaultKVStoreVersion

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

namespace string (Optional)

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

caBundle []byte (Optional)

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.

caProvider CAProvider (Optional)

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

readYourWrites bool (Optional)

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 bool (Optional)

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

WebhookCAProvider

(Appears on: WebhookProvider)

Defines a location to fetch the cert for the webhook provider from.

WebhookCAProviderType string

Field	Description
type
The type of provider to use such as “Secret”, or “ConfigMap”.
name
The name of the object located at the provider type.

key string

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

namespace string (Optional)

The namespace the Provider type is in.

WebhookCAProviderType (string alias)

(Appears on: WebhookCAProvider)

Value	Description
"ConfigMap"
"Secret"

WebhookProvider

(Appears on: SecretStoreProvider)

AkeylessProvider Configures an store to sync secrets using Akeyless KV.

string string

Field	Description
method
Webhook Method
url
Webhook url to call

headers map[string]string (Optional)

Headers

body string (Optional)

Body

timeout Kubernetes meta/v1.Duration (Optional)

Timeout

result WebhookResult

Result formatting

secrets []WebhookSecret (Optional)

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

caBundle []byte (Optional)

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.

caProvider WebhookCAProvider (Optional)

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

WebhookResult

(Appears on: WebhookProvider)

string

Field	Description
jsonPath
(Optional) Json path of return value

WebhookSecret

(Appears on: WebhookProvider)

string github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
name
Name of this secret in templates
secretRef
Secret ref to fill in credentials

YandexCertificateManagerAuth

(Appears on: YandexCertificateManagerProvider)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
authorizedKeySecretRef
(Optional) The authorized key used for authentication

YandexCertificateManagerCAProvider

(Appears on: YandexCertificateManagerProvider)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
certSecretRef

YandexCertificateManagerProvider

(Appears on: SecretStoreProvider)

YandexCertificateManagerProvider Configures a store to sync secrets using the Yandex Certificate Manager provider.

string YandexCertificateManagerAuth

Field	Description
apiEndpoint
(Optional) Yandex.Cloud API endpoint (e.g. ‘api.cloud.yandex.net:443’)
auth
Auth defines the information necessary to authenticate against Yandex Certificate Manager

caProvider YandexCertificateManagerCAProvider (Optional)

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

YandexLockboxAuth

(Appears on: YandexLockboxProvider)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
authorizedKeySecretRef
(Optional) The authorized key used for authentication

YandexLockboxCAProvider

(Appears on: YandexLockboxProvider)

github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector

Field	Description
certSecretRef

YandexLockboxProvider

(Appears on: SecretStoreProvider)

YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.

string YandexLockboxAuth

Field	Description
apiEndpoint
(Optional) Yandex.Cloud API endpoint (e.g. ‘api.cloud.yandex.net:443’)
auth
Auth defines the information necessary to authenticate against Yandex Lockbox

caProvider YandexLockboxCAProvider (Optional)

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

---

Generated with gen-crd-api-reference-docs.