2021-03-01 07:31:02 +00:00
< p > Packages:< / p >
< ul >
< li >
< a href = "#external-secrets.io%2fv1alpha1" > external-secrets.io/v1alpha1< / a >
< / li >
< / ul >
< h2 id = "external-secrets.io/v1alpha1" > external-secrets.io/v1alpha1< / h2 >
< p >
< p > Package v1alpha1 contains resources for external-secrets< / p >
< / p >
Resource Types:
< ul > < / ul >
2021-03-10 10:43:25 +00:00
< h3 id = "external-secrets.io/v1alpha1.AWSAuth" > AWSAuth
2021-03-01 07:31:02 +00:00
< / h3 >
< p >
(< em > Appears on:< / em >
2021-03-10 10:43:25 +00:00
< a href = "#external-secrets.io/v1alpha1.AWSProvider" > AWSProvider< / a > )
2021-03-01 07:31:02 +00:00
< / p >
< p >
2021-07-07 20:27:35 +00:00
< p > AWSAuth tells the controller how to do authentication with aws.
Only one of secretRef or jwt can be specified.
2021-08-07 13:53:31 +00:00
if none is specified the controller will load credentials using the aws sdk defaults.< / p >
2021-03-01 07:31:02 +00:00
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > secretRef< / code > < / br >
< em >
2021-03-10 10:43:25 +00:00
< a href = "#external-secrets.io/v1alpha1.AWSAuthSecretRef" >
AWSAuthSecretRef
2021-03-01 07:31:02 +00:00
< / a >
< / em >
< / td >
< td >
2021-07-07 20:27:35 +00:00
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > jwt< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.AWSJWTAuth" >
AWSJWTAuth
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2021-03-01 07:31:02 +00:00
< / td >
< / tr >
< / tbody >
< / table >
2021-03-10 10:43:25 +00:00
< h3 id = "external-secrets.io/v1alpha1.AWSAuthSecretRef" > AWSAuthSecretRef
2021-03-01 07:31:02 +00:00
< / h3 >
< p >
(< em > Appears on:< / em >
2021-03-10 10:43:25 +00:00
< a href = "#external-secrets.io/v1alpha1.AWSAuth" > AWSAuth< / a > )
2021-03-01 07:31:02 +00:00
< / p >
< p >
2021-07-07 20:27:35 +00:00
< p > AWSAuthSecretRef holds secret references for AWS credentials
2021-03-01 07:31:02 +00:00
both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > accessKeyIDSecretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > The AccessKeyID is used for authentication< / p >
< / td >
< / tr >
< tr >
< td >
< code > secretAccessKeySecretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > The SecretAccessKey is used for authentication< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-07-07 20:27:35 +00:00
< h3 id = "external-secrets.io/v1alpha1.AWSJWTAuth" > AWSJWTAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.AWSAuth" > AWSAuth< / a > )
< / p >
< p >
2021-08-07 13:53:31 +00:00
< p > Authenticate against AWS using service account tokens.< / p >
2021-07-07 20:27:35 +00:00
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > serviceAccountRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
2021-03-10 10:43:25 +00:00
< h3 id = "external-secrets.io/v1alpha1.AWSProvider" > AWSProvider
2021-03-01 07:31:02 +00:00
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" > SecretStoreProvider< / a > )
< / p >
< p >
2021-05-12 20:50:05 +00:00
< p > AWSProvider configures a store to sync secrets with AWS.< / p >
2021-03-01 07:31:02 +00:00
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2021-03-10 10:43:25 +00:00
< code > service< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.AWSServiceType" >
AWSServiceType
< / a >
< / em >
< / td >
< td >
< p > Service defines which service should be used to fetch the secrets< / p >
< / td >
< / tr >
< tr >
< td >
2021-03-01 07:31:02 +00:00
< code > auth< / code > < / br >
< em >
2021-03-10 10:43:25 +00:00
< a href = "#external-secrets.io/v1alpha1.AWSAuth" >
AWSAuth
2021-03-01 07:31:02 +00:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Auth defines the information necessary to authenticate against AWS
if not set aws sdk will infer credentials from your environment
see: < a href = "https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials" > https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials< / a > < / p >
< / td >
< / tr >
< tr >
< td >
< code > role< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Role is a Role ARN which the SecretManager provider will assume< / p >
< / td >
< / tr >
< tr >
< td >
< code > region< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > AWS Region to be used for the provider< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-03-10 10:43:25 +00:00
< h3 id = "external-secrets.io/v1alpha1.AWSServiceType" > AWSServiceType
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.AWSProvider" > AWSProvider< / a > )
< / p >
< p >
2021-05-12 20:50:05 +00:00
< p > AWSServiceType is a enum that defines the service/API that is used to fetch the secrets.< / p >
2021-03-10 10:43:25 +00:00
< / p >
< table >
< thead >
< tr >
< th > Value< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody > < tr > < td > < p > " ParameterStore" < / p > < / td >
2021-05-12 20:50:05 +00:00
< td > < p > AWSServiceParameterStore is the AWS SystemsManager ParameterStore.
2021-03-10 10:43:25 +00:00
see: < a href = "https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html" > https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html< / a > < / p >
< / td >
< / tr > < tr > < td > < p > " SecretsManager" < / p > < / td >
2021-05-12 20:50:05 +00:00
< td > < p > AWSServiceSecretsManager is the AWS SecretsManager.
2021-03-10 10:43:25 +00:00
see: < a href = "https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html" > https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html< / a > < / p >
< / td >
< / tr > < / tbody >
< / table >
2021-06-23 06:57:22 +00:00
< h3 id = "external-secrets.io/v1alpha1.AzureKVAuth" > AzureKVAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.AzureKVProvider" > AzureKVProvider< / a > )
< / p >
< p >
< p > Configuration used to authenticate with Azure.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > clientId< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > The Azure clientId of the service principle used for authentication.< / p >
< / td >
< / tr >
< tr >
< td >
< code > clientSecret< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > The Azure ClientSecret of the service principle used for authentication.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.AzureKVProvider" > AzureKVProvider
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" > SecretStoreProvider< / a > )
< / p >
< p >
< p > Configures an store to sync secrets using Azure KV.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > vaultUrl< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > Vault Url from which the secrets to be fetched from.< / p >
< / td >
< / tr >
< tr >
< td >
< code > tenantId< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > TenantID configures the Azure Tenant to send requests to.< / p >
< / td >
< / tr >
< tr >
< td >
< code > authSecretRef< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.AzureKVAuth" >
AzureKVAuth
< / a >
< / em >
< / td >
< td >
< p > Auth configures how the operator authenticates with Azure.< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-03-01 07:31:02 +00:00
< h3 id = "external-secrets.io/v1alpha1.ClusterSecretStore" > ClusterSecretStore
< / h3 >
< p >
< p > ClusterSecretStore represents a secure external location for storing secrets, which can be referenced as part of < code > storeRef< / code > fields.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > metadata< / code > < / br >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreSpec" >
SecretStoreSpec
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table >
< tr >
< td >
< code > controller< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
< code > provider< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" >
SecretStoreProvider
< / a >
< / em >
< / td >
< td >
< p > Used to configure the provider. Only one provider may be set< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
2021-06-25 20:28:46 +00:00
< tr >
< td >
< code > status< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreStatus" >
SecretStoreStatus
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
2021-03-01 07:31:02 +00:00
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecret" > ExternalSecret
< / h3 >
< p >
< p > ExternalSecret is the Schema for the external-secrets API.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > metadata< / code > < / br >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretSpec" >
ExternalSecretSpec
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table >
< tr >
< td >
< code > secretStoreRef< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreRef" >
SecretStoreRef
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > target< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretTarget" >
ExternalSecretTarget
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > refreshInterval< / code > < / br >
< em >
2021-03-10 10:43:25 +00:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta" >
Kubernetes meta/v1.Duration
< / a >
2021-03-01 07:31:02 +00:00
< / em >
< / td >
< td >
2021-03-10 10:43:25 +00:00
< p > 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.< / p >
2021-03-01 07:31:02 +00:00
< / td >
< / tr >
< tr >
< td >
< code > data< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretData" >
[]ExternalSecretData
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Data defines the connection between the Kubernetes Secret keys and the Provider data< / p >
< / td >
< / tr >
< tr >
< td >
< code > dataFrom< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef" >
[]ExternalSecretDataRemoteRef
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretStatus" >
ExternalSecretStatus
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretConditionType" > ExternalSecretConditionType
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretStatusCondition" > ExternalSecretStatusCondition< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Value< / th >
< th > Description< / th >
< / tr >
< / thead >
2021-08-19 14:33:36 +00:00
< tbody > < tr > < td > < p > " Deleted" < / p > < / td >
< td > < / td >
< / tr > < tr > < td > < p > " Ready" < / p > < / td >
2021-03-01 07:31:02 +00:00
< td > < / td >
< / tr > < / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretCreationPolicy" > ExternalSecretCreationPolicy
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretTarget" > ExternalSecretTarget< / a > )
< / p >
< p >
< p > ExternalSecretCreationPolicy defines rules on how to create the resulting Secret.< / p >
< / p >
< table >
< thead >
< tr >
< th > Value< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody > < tr > < td > < p > " Merge" < / p > < / td >
< td > < p > Merge does not create the Secret, but merges the data fields to the Secret.< / p >
< / td >
< / tr > < tr > < td > < p > " None" < / p > < / td >
< td > < p > None does not create a Secret (future use with injector).< / p >
< / td >
< / tr > < tr > < td > < p > " Owner" < / p > < / td >
< td > < p > Owner creates the Secret and sets .metadata.ownerReferences to the ExternalSecret resource.< / p >
< / td >
< / tr > < / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretData" > ExternalSecretData
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretSpec" > ExternalSecretSpec< / a > )
< / p >
< p >
< p > ExternalSecretData defines the connection between the Kubernetes Secret key (spec.data.< key > ) and the Provider data.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > secretKey< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > remoteRef< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef" >
ExternalSecretDataRemoteRef
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef" > ExternalSecretDataRemoteRef
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretData" > ExternalSecretData< / a > ,
< a href = "#external-secrets.io/v1alpha1.ExternalSecretSpec" > ExternalSecretSpec< / a > )
< / p >
< p >
< p > ExternalSecretDataRemoteRef defines Provider data location.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > key< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > Key is the key used in the Provider, mandatory< / p >
< / td >
< / tr >
< tr >
< td >
< code > version< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Used to select a specific version of the Provider value, if supported< / p >
< / td >
< / tr >
< tr >
< td >
< code > property< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Used to select a specific property of the Provider value (if a map), if supported< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretSpec" > ExternalSecretSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecret" > ExternalSecret< / a > )
< / p >
< p >
< p > ExternalSecretSpec defines the desired state of ExternalSecret.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > secretStoreRef< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreRef" >
SecretStoreRef
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > target< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretTarget" >
ExternalSecretTarget
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > refreshInterval< / code > < / br >
< em >
2021-03-10 10:43:25 +00:00
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#duration-v1-meta" >
Kubernetes meta/v1.Duration
< / a >
2021-03-01 07:31:02 +00:00
< / em >
< / td >
< td >
2021-03-10 10:43:25 +00:00
< p > 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.< / p >
2021-03-01 07:31:02 +00:00
< / td >
< / tr >
< tr >
< td >
< code > data< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretData" >
[]ExternalSecretData
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Data defines the connection between the Kubernetes Secret keys and the Provider data< / p >
< / td >
< / tr >
< tr >
< td >
< code > dataFrom< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretDataRemoteRef" >
[]ExternalSecretDataRemoteRef
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretStatus" > ExternalSecretStatus
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecret" > ExternalSecret< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > refreshTime< / code > < / br >
< em >
< a href = "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time" >
Kubernetes meta/v1.Time
< / a >
< / em >
< / td >
< td >
< p > refreshTime is the time and date the external secret was fetched and
the target secret updated< / p >
< / td >
< / tr >
< tr >
< td >
2021-06-25 20:28:46 +00:00
< code > syncedResourceVersion< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > SyncedResourceVersion keeps track of the last synced version< / p >
< / td >
< / tr >
< tr >
< td >
2021-03-01 07:31:02 +00:00
< code > conditions< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretStatusCondition" >
[]ExternalSecretStatusCondition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretStatusCondition" > ExternalSecretStatusCondition
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretStatus" > ExternalSecretStatus< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > type< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretConditionType" >
ExternalSecretConditionType
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < / br >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core" >
Kubernetes core/v1.ConditionStatus
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > reason< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > message< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > lastTransitionTime< / code > < / br >
< em >
< a href = "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time" >
Kubernetes meta/v1.Time
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretTarget" > ExternalSecretTarget
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretSpec" > ExternalSecretSpec< / a > )
< / p >
< p >
< p > ExternalSecretTarget defines the Kubernetes Secret to be created
There can be only one target per ExternalSecret.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Name defines the name of the Secret resource to be managed
This field is immutable
Defaults to the .metadata.name of the ExternalSecret resource< / p >
< / td >
< / tr >
< tr >
< td >
< code > creationPolicy< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretCreationPolicy" >
ExternalSecretCreationPolicy
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > CreationPolicy defines rules on how to create the resulting Secret
Defaults to ‘ Owner’ < / p >
< / td >
< / tr >
2021-05-12 20:50:05 +00:00
< tr >
< td >
< code > template< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretTemplate" >
ExternalSecretTemplate
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Template defines a blueprint for the created Secret resource.< / p >
< / td >
< / tr >
2021-03-01 07:31:02 +00:00
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretTemplate" > ExternalSecretTemplate
< / h3 >
< p >
2021-05-12 20:50:05 +00:00
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretTarget" > ExternalSecretTarget< / a > )
< / p >
< p >
< p > ExternalSecretTemplate defines a blueprint for the created Secret resource.
we can not use native corev1.Secret, it will have empty ObjectMeta values: < a href = "https://github.com/kubernetes-sigs/controller-tools/issues/448" > https://github.com/kubernetes-sigs/controller-tools/issues/448< / a > < / p >
2021-03-01 07:31:02 +00:00
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > type< / code > < / br >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#secrettype-v1-core" >
Kubernetes core/v1.SecretType
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > metadata< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata" >
ExternalSecretTemplateMetadata
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
2021-05-12 20:50:05 +00:00
< tr >
< td >
< code > data< / code > < / br >
< em >
2021-05-22 14:35:01 +00:00
map[string]string
2021-05-12 20:50:05 +00:00
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
2021-06-25 23:56:42 +00:00
< tr >
< td >
< code > templateFrom< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.TemplateFrom" >
[]TemplateFrom
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
2021-03-01 07:31:02 +00:00
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.ExternalSecretTemplateMetadata" > ExternalSecretTemplateMetadata
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretTemplate" > ExternalSecretTemplate< / a > )
< / p >
< p >
< p > ExternalSecretTemplateMetadata defines metadata fields for the Secret blueprint.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > annotations< / code > < / br >
< em >
map[string]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > labels< / code > < / br >
< em >
map[string]string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
2021-05-27 09:43:10 +00:00
< h3 id = "external-secrets.io/v1alpha1.GCPSMAuth" > GCPSMAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.GCPSMProvider" > GCPSMProvider< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > secretRef< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.GCPSMAuthSecretRef" >
GCPSMAuthSecretRef
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.GCPSMAuthSecretRef" > GCPSMAuthSecretRef
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.GCPSMAuth" > GCPSMAuth< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > secretAccessKeySecretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > The SecretAccessKey is used for authentication< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.GCPSMProvider" > GCPSMProvider
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" > SecretStoreProvider< / a > )
< / p >
< p >
< p > GCPSMProvider Configures a store to sync secrets using the GCP Secret Manager provider.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > auth< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.GCPSMAuth" >
GCPSMAuth
< / a >
< / em >
< / td >
< td >
2021-08-24 17:36:28 +00:00
< em > (Optional)< / em >
2021-05-27 09:43:10 +00:00
< p > Auth defines the information necessary to authenticate against GCP< / p >
< / td >
< / tr >
< tr >
< td >
< code > projectID< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > ProjectID project where secret is located< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-03-01 07:31:02 +00:00
< h3 id = "external-secrets.io/v1alpha1.GenericStore" > GenericStore
< / h3 >
< p >
< p > GenericStore is a common interface for interacting with ClusterSecretStore
or a namespaced SecretStore.< / p >
< / p >
2021-08-25 14:48:50 +00:00
< h3 id = "external-secrets.io/v1alpha1.GitlabAuth" > GitlabAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.GitlabProvider" > GitlabProvider< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > SecretRef< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.GitlabSecretRef" >
GitlabSecretRef
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.GitlabProvider" > GitlabProvider
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" > SecretStoreProvider< / a > )
< / p >
< p >
< p > Configures an store to sync secrets using a IBM Cloud Secrets Manager
backend.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > auth< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.GitlabAuth" >
GitlabAuth
< / a >
< / em >
< / td >
< td >
< p > Auth configures how secret-manager authenticates with the IBM secrets manager.< / p >
< / td >
< / tr >
< tr >
< td >
< code > projectID< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > ProjectID project where secret is located< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.GitlabSecretRef" > GitlabSecretRef
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.GitlabAuth" > GitlabAuth< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > accessToken< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > The Access Token is used for authentication< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-07-01 14:13:53 +00:00
< h3 id = "external-secrets.io/v1alpha1.IBMAuth" > IBMAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.IBMProvider" > IBMProvider< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > secretRef< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.IBMAuthSecretRef" >
IBMAuthSecretRef
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.IBMAuthSecretRef" > IBMAuthSecretRef
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.IBMAuth" > IBMAuth< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > secretApiKeySecretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > The SecretAccessKey is used for authentication< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.IBMProvider" > IBMProvider
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" > SecretStoreProvider< / a > )
< / p >
< p >
< p > Configures an store to sync secrets using a IBM Cloud Secrets Manager
backend.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > auth< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.IBMAuth" >
IBMAuth
< / a >
< / em >
< / td >
< td >
< p > Auth configures how secret-manager authenticates with the IBM secrets manager.< / p >
< / td >
< / tr >
< tr >
< td >
< code > serviceUrl< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > ServiceURL is the Endpoint URL that is specific to the Secrets Manager service instance< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-03-01 07:31:02 +00:00
< h3 id = "external-secrets.io/v1alpha1.SecretStore" > SecretStore
< / h3 >
< p >
< p > SecretStore represents a secure external location for storing secrets, which can be referenced as part of < code > storeRef< / code > fields.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > metadata< / code > < / br >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#objectmeta-v1-meta" >
Kubernetes meta/v1.ObjectMeta
< / a >
< / em >
< / td >
< td >
Refer to the Kubernetes API documentation for the fields of the
< code > metadata< / code > field.
< / td >
< / tr >
< tr >
< td >
< code > spec< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreSpec" >
SecretStoreSpec
< / a >
< / em >
< / td >
< td >
< br / >
< br / >
< table >
< tr >
< td >
< code > controller< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
< code > provider< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" >
SecretStoreProvider
< / a >
< / em >
< / td >
< td >
< p > Used to configure the provider. Only one provider may be set< / p >
< / td >
< / tr >
< / table >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreStatus" >
SecretStoreStatus
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.SecretStoreConditionType" > SecretStoreConditionType
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreStatusCondition" > SecretStoreStatusCondition< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Value< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody > < tr > < td > < p > " Ready" < / p > < / td >
< td > < / td >
< / tr > < / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.SecretStoreProvider" > SecretStoreProvider
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreSpec" > SecretStoreSpec< / a > )
< / p >
< p >
< p > SecretStoreProvider contains the provider-specific configration.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2021-03-10 10:43:25 +00:00
< code > aws< / code > < / br >
2021-03-01 07:31:02 +00:00
< em >
2021-03-10 10:43:25 +00:00
< a href = "#external-secrets.io/v1alpha1.AWSProvider" >
AWSProvider
2021-03-01 07:31:02 +00:00
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
2021-03-10 10:43:25 +00:00
< p > AWS configures this store to sync secrets using AWS Secret Manager provider< / p >
2021-03-01 07:31:02 +00:00
< / td >
< / tr >
2021-05-12 20:50:05 +00:00
< tr >
< td >
2021-06-23 06:57:22 +00:00
< code > azurekv< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.AzureKVProvider" >
AzureKVProvider
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AzureKV configures this store to sync secrets using Azure Key Vault provider< / p >
< / td >
< / tr >
< tr >
< td >
2021-05-12 20:50:05 +00:00
< code > vault< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.VaultProvider" >
VaultProvider
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Vault configures this store to sync secrets using Hashi provider< / p >
< / td >
< / tr >
2021-05-27 09:43:10 +00:00
< tr >
< td >
< code > gcpsm< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.GCPSMProvider" >
GCPSMProvider
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > GCPSM configures this store to sync secrets using Google Cloud Platform Secret Manager provider< / p >
< / td >
< / tr >
2021-07-01 14:13:53 +00:00
< tr >
< td >
< code > ibm< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.IBMProvider" >
IBMProvider
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > IBM configures this store to sync secrets using IBM Cloud provider< / p >
< / td >
< / tr >
2021-08-19 14:33:36 +00:00
< tr >
< td >
< code > yandexlockbox< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.YandexLockboxProvider" >
YandexLockboxProvider
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > YandexLockbox configures this store to sync secrets using Yandex Lockbox provider< / p >
< / td >
< / tr >
2021-08-25 14:48:50 +00:00
< tr >
< td >
< code > gitlab< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.GitlabProvider" >
GitlabProvider
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > GItlab configures this store to sync secrets using Gitlab Variables provider< / p >
< / td >
< / tr >
2021-03-01 07:31:02 +00:00
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.SecretStoreRef" > SecretStoreRef
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretSpec" > ExternalSecretSpec< / a > )
< / p >
< p >
< p > SecretStoreRef defines which SecretStore to fetch the ExternalSecret data.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > Name of the SecretStore resource< / p >
< / td >
< / tr >
< tr >
< td >
< code > kind< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Kind of the SecretStore resource (SecretStore or ClusterSecretStore)
Defaults to < code > SecretStore< / code > < / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.SecretStoreSpec" > SecretStoreSpec
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ClusterSecretStore" > ClusterSecretStore< / a > ,
< a href = "#external-secrets.io/v1alpha1.SecretStore" > SecretStore< / a > )
< / p >
< p >
< p > SecretStoreSpec defines the desired state of SecretStore.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > controller< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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< / p >
< / td >
< / tr >
< tr >
< td >
< code > provider< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" >
SecretStoreProvider
< / a >
< / em >
< / td >
< td >
< p > Used to configure the provider. Only one provider may be set< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.SecretStoreStatus" > SecretStoreStatus
< / h3 >
< p >
(< em > Appears on:< / em >
2021-06-25 20:28:46 +00:00
< a href = "#external-secrets.io/v1alpha1.ClusterSecretStore" > ClusterSecretStore< / a > ,
2021-03-01 07:31:02 +00:00
< a href = "#external-secrets.io/v1alpha1.SecretStore" > SecretStore< / a > )
< / p >
< p >
< p > SecretStoreStatus defines the observed state of the SecretStore.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > conditions< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreStatusCondition" >
[]SecretStoreStatusCondition
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.SecretStoreStatusCondition" > SecretStoreStatusCondition
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreStatus" > SecretStoreStatus< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > type< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreConditionType" >
SecretStoreConditionType
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > status< / code > < / br >
< em >
< a href = "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#conditionstatus-v1-core" >
Kubernetes core/v1.ConditionStatus
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > reason< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > message< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< tr >
< td >
< code > lastTransitionTime< / code > < / br >
< em >
< a href = "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Time" >
Kubernetes meta/v1.Time
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< / td >
< / tr >
< / tbody >
< / table >
2021-06-25 23:56:42 +00:00
< h3 id = "external-secrets.io/v1alpha1.TemplateFrom" > TemplateFrom
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.ExternalSecretTemplate" > ExternalSecretTemplate< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > configMap< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.TemplateRef" >
TemplateRef
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > secret< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.TemplateRef" >
TemplateRef
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.TemplateRef" > TemplateRef
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.TemplateFrom" > TemplateFrom< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > name< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< / td >
< / tr >
< tr >
< td >
< code > items< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.TemplateRefItem" >
[]TemplateRefItem
< / a >
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.TemplateRefItem" > TemplateRefItem
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.TemplateRef" > TemplateRef< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > key< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< / td >
< / tr >
< / tbody >
< / table >
2021-05-12 20:50:05 +00:00
< h3 id = "external-secrets.io/v1alpha1.VaultAppRole" > VaultAppRole
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.VaultAuth" > VaultAuth< / a > )
< / p >
< p >
< p > VaultAppRole authenticates with Vault using the App Role auth mechanism,
with the role and secret stored in a Kubernetes Secret resource.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > path< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > Path where the App Role authentication backend is mounted
in Vault, e.g: “ approle” < / p >
< / td >
< / tr >
< tr >
< td >
< code > roleId< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > RoleID configured in the App Role authentication backend when setting
up the authentication backend in Vault.< / p >
< / td >
< / tr >
< tr >
< td >
< code > secretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > Reference to a key in a Secret that contains the App Role secret used
to authenticate with Vault.
The < code > key< / code > field must be specified and denotes which entry within the Secret
resource is used as the app role secret.< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.VaultAuth" > VaultAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.VaultProvider" > VaultProvider< / a > )
< / p >
< p >
2021-05-14 09:39:41 +00:00
< p > VaultAuth is the configuration used to authenticate with a Vault server.
2021-08-07 13:53:31 +00:00
Only one of < code > tokenSecretRef< / code > , < code > appRole< / code > , < code > kubernetes< / code > , < code > ldap< / code > , < code > jwt< / code > or < code > cert< / code >
2021-05-14 09:39:41 +00:00
can be specified.< / p >
2021-05-12 20:50:05 +00:00
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > tokenSecretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > TokenSecretRef authenticates with Vault by presenting a token.< / p >
< / td >
< / tr >
< tr >
< td >
< code > appRole< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.VaultAppRole" >
VaultAppRole
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > AppRole authenticates with Vault using the App Role auth mechanism,
with the role and secret stored in a Kubernetes Secret resource.< / p >
< / td >
< / tr >
< tr >
< td >
< code > kubernetes< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.VaultKubernetesAuth" >
VaultKubernetesAuth
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Kubernetes authenticates with Vault by passing the ServiceAccount
token stored in the named Secret resource to the Vault server.< / p >
< / td >
< / tr >
2021-05-13 16:32:06 +00:00
< tr >
< td >
< code > ldap< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.VaultLdapAuth" >
VaultLdapAuth
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Ldap authenticates with Vault by passing username/password pair using
the LDAP authentication method< / p >
< / td >
< / tr >
< tr >
< td >
< code > jwt< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.VaultJwtAuth" >
VaultJwtAuth
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Jwt authenticates with Vault by passing role and JWT token using the
JWT/OIDC authentication method< / p >
< / td >
< / tr >
2021-08-07 13:53:31 +00:00
< tr >
< td >
< code > cert< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.VaultCertAuth" >
VaultCertAuth
< / a >
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate
Cert authentication method< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.VaultCertAuth" > VaultCertAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.VaultAuth" > VaultAuth< / a > )
< / p >
< p >
< p > VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
method, with the role name and token stored in a Kubernetes Secret resource.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > clientCert< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > ClientCert is a certificate to authenticate using the Cert Vault
authentication method< / p >
< / td >
< / tr >
< tr >
< td >
< code > secretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > SecretRef to a key in a Secret resource containing client private key to
authenticate with Vault using the Cert authentication method< / p >
< / td >
< / tr >
2021-05-13 16:32:06 +00:00
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.VaultJwtAuth" > VaultJwtAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.VaultAuth" > VaultAuth< / a > )
< / p >
< p >
< p > VaultJwtAuth authenticates with Vault using the JWT/OIDC authentication
method, with the role name and token stored in a Kubernetes Secret resource.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > role< / code > < / br >
< em >
string
< / em >
< / td >
< td >
2021-05-14 06:40:13 +00:00
< em > (Optional)< / em >
2021-05-13 16:32:06 +00:00
< p > Role is a JWT role to authenticate using the JWT/OIDC Vault
authentication method< / p >
< / td >
< / tr >
< tr >
< td >
2021-05-14 09:39:41 +00:00
< code > secretRef< / code > < / br >
2021-05-13 16:32:06 +00:00
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > SecretRef to a key in a Secret resource containing JWT token to
authenticate with Vault using the JWT/OIDC authentication method< / p >
< / td >
< / tr >
2021-05-12 20:50:05 +00:00
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.VaultKVStoreVersion" > VaultKVStoreVersion
(< code > string< / code > alias)< / p > < / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.VaultProvider" > VaultProvider< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Value< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody > < tr > < td > < p > " v1" < / p > < / td >
< td > < / td >
< / tr > < tr > < td > < p > " v2" < / p > < / td >
< td > < / td >
< / tr > < / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.VaultKubernetesAuth" > VaultKubernetesAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.VaultAuth" > VaultAuth< / a > )
< / p >
< p >
< p > Authenticate against Vault using a Kubernetes ServiceAccount token stored in
a Secret.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > mountPath< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > Path where the Kubernetes authentication backend is mounted in Vault, e.g:
“ kubernetes” < / p >
< / td >
< / tr >
< tr >
< td >
< code > serviceAccountRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.ServiceAccountSelector
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > secretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > Optional secret field containing a Kubernetes ServiceAccount JWT used
for authenticating with Vault. If a name is specified without a key,
< code > token< / code > is the default. If one is not specified, the one bound to
the controller will be used.< / p >
< / td >
< / tr >
< tr >
< td >
< code > role< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > A required field containing the Vault Role to assume. A Role binds a
Kubernetes ServiceAccount with a set of Vault policies.< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-05-13 16:32:06 +00:00
< h3 id = "external-secrets.io/v1alpha1.VaultLdapAuth" > VaultLdapAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.VaultAuth" > VaultAuth< / a > )
< / p >
< p >
< p > VaultLdapAuth authenticates with Vault using the LDAP authentication method,
with the username and password stored in a Kubernetes Secret resource.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > username< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > Username is a LDAP user name used to authenticate using the LDAP Vault
authentication method< / p >
< / td >
< / tr >
< tr >
< td >
2021-05-14 09:39:41 +00:00
< code > secretRef< / code > < / br >
2021-05-13 16:32:06 +00:00
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< p > SecretRef to a key in a Secret resource containing password for the LDAP
user used to authenticate with Vault using the LDAP authentication
method< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-05-12 20:50:05 +00:00
< h3 id = "external-secrets.io/v1alpha1.VaultProvider" > VaultProvider
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" > SecretStoreProvider< / a > )
< / p >
< p >
< p > Configures an store to sync secrets using a HashiCorp Vault
KV backend.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > auth< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.VaultAuth" >
VaultAuth
< / a >
< / em >
< / td >
< td >
< p > Auth configures how secret-manager authenticates with the Vault server.< / p >
< / td >
< / tr >
< tr >
< td >
< code > server< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > Server is the connection address for the Vault server, e.g: “ < a href = "https://vault.example.com:8200"" > https://vault.example.com:8200” < / a > .< / p >
< / td >
< / tr >
< tr >
< td >
< code > path< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< p > 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.< / p >
< / td >
< / tr >
< tr >
< td >
< code > version< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.VaultKVStoreVersion" >
VaultKVStoreVersion
< / a >
< / em >
< / td >
< td >
< p > Version is the Vault KV secret engine version. This can be either “ v1” or
“ v2” . Version defaults to “ v2” .< / p >
< / td >
< / tr >
< tr >
< td >
< code > namespace< / code > < / br >
< em >
string
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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 < a href = "https://www.vaultproject.io/docs/enterprise/namespaces" > https://www.vaultproject.io/docs/enterprise/namespaces< / a > < / p >
< / td >
< / tr >
< tr >
< td >
< code > caBundle< / code > < / br >
< em >
[]byte
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > 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.< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-08-19 14:33:36 +00:00
< h3 id = "external-secrets.io/v1alpha1.YandexLockboxAuth" > YandexLockboxAuth
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.YandexLockboxProvider" > YandexLockboxProvider< / a > )
< / p >
< p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
< code > authorizedKeySecretRef< / code > < / br >
< em >
github.com/external-secrets/external-secrets/apis/meta/v1.SecretKeySelector
< / em >
< / td >
< td >
< em > (Optional)< / em >
< p > The authorized key used for authentication< / p >
< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "external-secrets.io/v1alpha1.YandexLockboxProvider" > YandexLockboxProvider
< / h3 >
< p >
(< em > Appears on:< / em >
< a href = "#external-secrets.io/v1alpha1.SecretStoreProvider" > SecretStoreProvider< / a > )
< / p >
< p >
< p > YandexLockboxProvider Configures a store to sync secrets using the Yandex Lockbox provider.< / p >
< / p >
< table >
< thead >
< tr >
< th > Field< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td >
2021-08-20 13:16:35 +00:00
< code > apiEndpoint< / code > < / br >
2021-08-19 14:33:36 +00:00
< em >
string
< / em >
< / td >
< td >
2021-08-20 13:16:35 +00:00
< em > (Optional)< / em >
< p > Yandex.Cloud API endpoint (e.g. ‘ api.cloud.yandex.net:443’ )< / p >
2021-08-19 14:33:36 +00:00
< / td >
< / tr >
< tr >
< td >
< code > auth< / code > < / br >
< em >
< a href = "#external-secrets.io/v1alpha1.YandexLockboxAuth" >
YandexLockboxAuth
< / a >
< / em >
< / td >
< td >
< p > Auth defines the information necessary to authenticate against Yandex Lockbox< / p >
< / td >
< / tr >
< / tbody >
< / table >
2021-03-01 07:31:02 +00:00
< hr / >
< p > < em >
Generated with < code > gen-crd-api-reference-docs< / code > .
< / em > < / p >
