2020-12-29 18:02:29 +00:00
apiVersion : apiextensions.k8s.io/v1
kind : CustomResourceDefinition
metadata :
annotations :
2023-05-15 09:11:10 +00:00
controller-gen.kubebuilder.io/version : v0.11.4
2020-12-29 18:02:29 +00:00
name : clustersecretstores.external-secrets.io
spec :
group : external-secrets.io
names :
categories :
- externalsecrets
kind : ClusterSecretStore
listKind : ClusterSecretStoreList
plural : clustersecretstores
shortNames :
- css
singular : clustersecretstore
scope : Cluster
versions :
- additionalPrinterColumns :
- jsonPath : .metadata.creationTimestamp
name : AGE
type : date
2022-02-17 16:13:59 +00:00
- jsonPath : .status.conditions[?(@.type=="Ready")].reason
name : Status
type : string
2022-03-23 12:07:06 +00:00
deprecated : true
2020-12-29 18:02:29 +00:00
name : v1alpha1
2022-02-08 17:07:34 +00:00
schema :
openAPIV3Schema :
description : ClusterSecretStore represents a secure external location for
storing secrets, which can be referenced as part of `storeRef` fields.
properties :
apiVersion :
description : 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type : string
kind :
description : 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type : string
metadata :
type : object
spec :
description : SecretStoreSpec defines the desired state of SecretStore.
properties :
controller :
description: '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'
type : string
provider :
description : Used to configure the provider. Only one provider may
be set
maxProperties : 1
minProperties : 1
properties :
akeyless :
description : Akeyless configures this store to sync secrets using
Akeyless Vault provider
properties :
akeylessGWApiURL :
description : Akeyless GW API Url from which the secrets to
be fetched from.
type : string
authSecretRef :
description : Auth configures how the operator authenticates
with Akeyless.
properties :
2022-09-11 11:25:29 +00:00
kubernetesAuth :
description : Kubernetes authenticates with Akeyless by
passing the ServiceAccount token stored in the named
Secret resource.
properties :
accessID :
description : the Akeyless Kubernetes auth-method access-id
type : string
k8sConfName :
description : Kubernetes-auth configuration name in
Akeyless-Gateway
type : string
secretRef :
description : Optional secret field containing a Kubernetes
ServiceAccount JWT used for authenticating with
Akeyless. If a name is specified without a key,
`token` is the default. If one is not specified,
the one bound to the controller will be used.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
serviceAccountRef :
description : Optional service account field containing
the name of a kubernetes ServiceAccount. If the
service account is specified, the service account
secret token JWT will be used for authenticating
with Akeyless. If the service account selector is
not supplied, the secretRef will be used instead.
properties :
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
required :
- name
type : object
required :
- accessID
- k8sConfName
type : object
2022-02-08 17:07:34 +00:00
secretRef :
2022-09-11 11:25:29 +00:00
description : Reference to a Secret that contains the details
to authenticate with Akeyless.
2022-02-08 17:07:34 +00:00
properties :
accessID :
description : The SecretAccessID is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
accessType :
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
accessTypeParam :
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
type : object
2023-03-07 12:11:02 +00:00
caBundle :
description : PEM/base64 encoded CA bundle used to validate
Akeyless Gateway certificate. Only used if the AkeylessGWApiURL
URL is using HTTPS protocol. If not set the system root
certificates are used to validate the TLS connection.
format : byte
type : string
caProvider :
description : The provider for the CA bundle to use to validate
Akeyless Gateway certificate.
properties :
key :
description : The key the value inside of the provider
type to use, only used with "Secret" type
type : string
name :
description : The name of the object located at the provider
type.
type : string
namespace :
description : The namespace the Provider type is in.
type : string
type :
description : The type of provider to use such as "Secret",
or "ConfigMap".
enum :
- Secret
- ConfigMap
type : string
required :
- name
- type
type : object
2022-02-08 17:07:34 +00:00
required :
- akeylessGWApiURL
- authSecretRef
type : object
alibaba :
description : Alibaba configures this store to sync secrets using
Alibaba Cloud provider
properties :
auth :
description : AlibabaAuth contains a secretRef for credentials.
properties :
2023-04-16 12:12:30 +00:00
rrsa :
description : Authenticate against Alibaba using RRSA.
properties :
oidcProviderArn :
type : string
oidcTokenFilePath :
type : string
roleArn :
type : string
sessionName :
type : string
required :
- oidcProviderArn
- oidcTokenFilePath
- roleArn
- sessionName
type : object
2022-02-08 17:07:34 +00:00
secretRef :
description : AlibabaAuthSecretRef holds secret references
for Alibaba credentials.
properties :
accessKeyIDSecretRef :
description : The AccessKeyID is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
accessKeySecretSecretRef :
description : The AccessKeySecret is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
required :
- accessKeyIDSecretRef
- accessKeySecretSecretRef
type : object
type : object
regionID :
description : Alibaba Region to be used for the provider
type : string
required :
- auth
- regionID
type : object
aws :
description : AWS configures this store to sync secrets using AWS
Secret Manager provider
properties :
auth :
description : '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'
properties :
jwt :
description : Authenticate against AWS using service account
tokens.
properties :
serviceAccountRef :
description : A reference to a ServiceAccount resource.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
2022-02-08 17:07:34 +00:00
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
required :
- name
type : object
type : object
secretRef :
description : AWSAuthSecretRef holds secret references
for AWS credentials both AccessKeyID and SecretAccessKey
must be defined in order to properly authenticate.
properties :
accessKeyIDSecretRef :
description : The AccessKeyID is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
secretAccessKeySecretRef :
description : The SecretAccessKey is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
type : object
region :
description : AWS Region to be used for the provider
type : string
role :
description : Role is a Role ARN which the SecretManager provider
will assume
type : string
service :
description : Service defines which service should be used
to fetch the secrets
enum :
- SecretsManager
- ParameterStore
type : string
required :
- region
- service
type : object
azurekv :
description : AzureKV configures this store to sync secrets using
Azure Key Vault provider
properties :
authSecretRef :
description : Auth configures how the operator authenticates
with Azure. Required for ServicePrincipal auth type.
properties :
clientId :
description : The Azure clientId of the service principle
used for authentication.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
clientSecret :
description : The Azure ClientSecret of the service principle
used for authentication.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
authType :
default : ServicePrincipal
description : '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)'
enum :
- ServicePrincipal
- ManagedIdentity
2022-03-22 20:59:01 +00:00
- WorkloadIdentity
2022-02-08 17:07:34 +00:00
type : string
identityId :
description : If multiple Managed Identity is assigned to the
pod, you can select the one to be used
type : string
2022-03-22 20:59:01 +00:00
serviceAccountRef :
description : ServiceAccountRef specified the service account
that should be used when authenticating with WorkloadIdentity.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim for the
service account token If the service account uses a
well-known annotation for e.g. IRSA or GCP Workload
Identity then this audiences will be appended to the
list
items :
type : string
type : array
2022-03-22 20:59:01 +00:00
name :
description : The name of the ServiceAccount resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
required :
- name
type : object
2022-02-08 17:07:34 +00:00
tenantId :
description : TenantID configures the Azure Tenant to send
requests to. Required for ServicePrincipal auth type.
type : string
vaultUrl :
description : Vault Url from which the secrets to be fetched
from.
type : string
required :
- vaultUrl
type : object
fake :
description : Fake configures a store with static key/value pairs
properties :
data :
items :
properties :
key :
type : string
value :
type : string
valueMap :
additionalProperties :
type : string
type : object
version :
type : string
required :
- key
type : object
type : array
required :
- data
type : object
gcpsm :
description : GCPSM configures this store to sync secrets using
Google Cloud Platform Secret Manager provider
properties :
auth :
description : Auth defines the information necessary to authenticate
against GCP
properties :
secretRef :
properties :
secretAccessKeySecretRef :
description : The SecretAccessKey is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
workloadIdentity :
properties :
clusterLocation :
type : string
clusterName :
type : string
2022-03-02 10:24:04 +00:00
clusterProjectID :
type : string
2022-02-08 17:07:34 +00:00
serviceAccountRef :
description : A reference to a ServiceAccount resource.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
2022-02-08 17:07:34 +00:00
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
required :
- name
type : object
required :
- clusterLocation
- clusterName
- serviceAccountRef
type : object
type : object
projectID :
description : ProjectID project where secret is located
type : string
type : object
gitlab :
2023-05-15 12:12:24 +00:00
description : GitLab configures this store to sync secrets using
GitLab Variables provider
2022-02-08 17:07:34 +00:00
properties :
auth :
description : Auth configures how secret-manager authenticates
with a GitLab instance.
properties :
SecretRef :
properties :
accessToken :
description : AccessToken is used for authentication.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
required :
- SecretRef
type : object
projectID :
description : ProjectID specifies a project where secrets are
located.
type : string
url :
description : URL configures the GitLab instance URL. Defaults
to https://gitlab.com/.
type : string
required :
- auth
type : object
ibm :
description : IBM configures this store to sync secrets using IBM
Cloud provider
properties :
auth :
description : Auth configures how secret-manager authenticates
with the IBM secrets manager.
properties :
secretRef :
properties :
secretApiKeySecretRef :
description : The SecretAccessKey is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
required :
- secretRef
type : object
serviceUrl :
description : ServiceURL is the Endpoint URL that is specific
to the Secrets Manager service instance
type : string
required :
- auth
type : object
2022-02-23 07:04:50 +00:00
kubernetes :
description : Kubernetes configures this store to sync secrets
using a Kubernetes cluster provider
properties :
auth :
description : Auth configures how secret-manager authenticates
with a Kubernetes instance.
maxProperties : 1
minProperties : 1
properties :
cert :
description : has both clientCert and clientKey as secretKeySelector
properties :
clientCert :
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
clientKey :
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
serviceAccount :
description : points to a service account that should be
used for authentication
properties :
serviceAccount :
description : A reference to a ServiceAccount resource.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
2022-02-23 07:04:50 +00:00
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
required :
- name
type : object
type : object
token :
description : use static token to authenticate with
properties :
bearerToken :
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
type : object
remoteNamespace :
default : default
description : Remote namespace to fetch the secrets from
type : string
server :
description : configures the Kubernetes server Address.
properties :
caBundle :
description : CABundle is a base64-encoded CA certificate
format : byte
type : string
caProvider :
description: 'see : https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider'
properties :
key :
description : The key the value inside of the provider
type to use, only used with "Secret" type
type : string
name :
description : The name of the object located at the
provider type.
type : string
namespace :
description : The namespace the Provider type is in.
type : string
type :
description : The type of provider to use such as "Secret",
or "ConfigMap".
enum :
- Secret
- ConfigMap
type : string
required :
- name
- type
type : object
url :
default : kubernetes.default
description : configures the Kubernetes server Address.
type : string
type : object
required :
- auth
type : object
2022-02-08 17:07:34 +00:00
oracle :
description : Oracle configures this store to sync secrets using
Oracle Vault provider
properties :
auth :
description : Auth configures how secret-manager authenticates
2022-02-10 19:52:12 +00:00
with the Oracle Vault. If empty, use the instance principal,
otherwise the user credentials specified in Auth.
2022-02-08 17:07:34 +00:00
properties :
secretRef :
description : SecretRef to pass through sensitive information.
properties :
fingerprint :
description : Fingerprint is the fingerprint of the
API private key.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
privatekey :
description : PrivateKey is the user's API Signing
Key in PEM format, used for authentication.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
2022-02-10 19:52:12 +00:00
required :
- fingerprint
- privatekey
2022-02-08 17:07:34 +00:00
type : object
2022-02-10 19:52:12 +00:00
tenancy :
description : Tenancy is the tenancy OCID where user is
located.
type : string
user :
description : User is an access OCID specific to the account.
type : string
2022-02-08 17:07:34 +00:00
required :
- secretRef
2022-02-10 19:52:12 +00:00
- tenancy
- user
2022-02-08 17:07:34 +00:00
type : object
region :
2022-02-10 19:52:12 +00:00
description : Region is the region where vault is located.
2022-02-08 17:07:34 +00:00
type : string
vault :
description : Vault is the vault's OCID of the specific vault
where secret is located.
type : string
required :
2022-02-10 19:52:12 +00:00
- region
- vault
2022-02-08 17:07:34 +00:00
type : object
vault :
description : Vault configures this store to sync secrets using
Hashi provider
properties :
auth :
description : Auth configures how secret-manager authenticates
with the Vault server.
properties :
appRole :
description : AppRole authenticates with Vault using the
App Role auth mechanism, with the role and secret stored
in a Kubernetes Secret resource.
properties :
path :
default : approle
description : 'Path where the App Role authentication
backend is mounted in Vault, e.g : "approle" '
type : string
roleId :
description : RoleID configured in the App Role authentication
backend when setting up the authentication backend
in Vault.
type : string
secretRef :
description : 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.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
required :
- path
- roleId
- secretRef
type : object
cert :
description : Cert authenticates with TLS Certificates
by passing client certificate, private key and ca certificate
Cert authentication method
properties :
clientCert :
description : ClientCert is a certificate to authenticate
using the Cert Vault authentication method
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
secretRef :
description : SecretRef to a key in a Secret resource
containing client private key to authenticate with
Vault using the Cert authentication method
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
jwt :
description : Jwt authenticates with Vault by passing role
and JWT token using the JWT/OIDC authentication method
properties :
2022-04-04 19:20:58 +00:00
kubernetesServiceAccountToken :
description : Optional ServiceAccountToken specifies
the Kubernetes service account for which to request
a token for with the `TokenRequest` API.
properties :
audiences :
description : 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.
items :
type : string
type : array
expirationSeconds :
description : 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.
format : int64
type : integer
serviceAccountRef :
description : Service account field containing
the name of a kubernetes ServiceAccount.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud`
claim for the service account token If the
service account uses a well-known annotation
for e.g. IRSA or GCP Workload Identity then
this audiences will be appended to the list
items :
type : string
type : array
2022-04-04 19:20:58 +00:00
name :
description : The name of the ServiceAccount
resource being referred to.
type : string
namespace :
description : Namespace of the resource being
referred to. Ignored if referent is not
cluster-scoped. cluster-scoped defaults
to the namespace of the referent.
type : string
required :
- name
type : object
required :
- serviceAccountRef
type : object
2022-02-08 17:07:34 +00:00
path :
default : jwt
description : 'Path where the JWT authentication backend
is mounted in Vault, e.g : "jwt" '
type : string
role :
description : Role is a JWT role to authenticate using
the JWT/OIDC Vault authentication method
type : string
secretRef :
2022-04-04 19:20:58 +00:00
description : Optional SecretRef that refers to a key
in a Secret resource containing JWT token to authenticate
with Vault using the JWT/OIDC authentication method.
2022-02-08 17:07:34 +00:00
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
required :
- path
type : object
kubernetes :
description : Kubernetes authenticates with Vault by passing
the ServiceAccount token stored in the named Secret
resource to the Vault server.
properties :
mountPath :
default : kubernetes
description : 'Path where the Kubernetes authentication
backend is mounted in Vault, e.g : "kubernetes" '
type : string
role :
description : A required field containing the Vault
Role to assume. A Role binds a Kubernetes ServiceAccount
with a set of Vault policies.
type : string
secretRef :
description : 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.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
serviceAccountRef :
description : 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.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
2022-02-08 17:07:34 +00:00
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
required :
- name
type : object
required :
- mountPath
- role
type : object
ldap :
description : Ldap authenticates with Vault by passing
username/password pair using the LDAP authentication
method
properties :
path :
default : ldap
description : 'Path where the LDAP authentication backend
is mounted in Vault, e.g : "ldap" '
type : string
secretRef :
description : SecretRef to a key in a Secret resource
containing password for the LDAP user used to authenticate
with Vault using the LDAP authentication method
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
username :
description : Username is a LDAP user name used to
authenticate using the LDAP Vault authentication
method
type : string
required :
- path
- username
type : object
tokenSecretRef :
description : TokenSecretRef authenticates with Vault by
presenting a token.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
caBundle :
description : 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.
format : byte
type : string
caProvider :
description : The provider for the CA bundle to use to validate
Vault server certificate.
properties :
key :
description : The key the value inside of the provider
type to use, only used with "Secret" type
type : string
name :
description : The name of the object located at the provider
type.
type : string
namespace :
description : The namespace the Provider type is in.
type : string
type :
description : The type of provider to use such as "Secret",
or "ConfigMap".
enum :
- Secret
- ConfigMap
type : string
required :
- name
- type
type : object
forwardInconsistent :
description : 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
type : boolean
namespace :
description : 'Name of the vault namespace. Namespaces is a
set of features within Vault Enterprise that allows Vault
environments to support Secure Multi-tenancy. e.g : "ns1" .
More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces'
type : string
path :
description : 'Path is the mount path of the Vault KV backend
endpoint, e.g : "secret" . The v2 KV secret engine version
specific "/data" path suffix for fetching secrets from Vault
is optional and will be appended if not present in specified
path.'
type : string
readYourWrites :
description : ReadYourWrites ensures isolated read-after-write
semantics by providing discovered cluster replication states
in each request. More information about eventual consistency
in Vault can be found here https://www.vaultproject.io/docs/enterprise/consistency
type : boolean
server :
description : 'Server is the connection address for the Vault
server, e.g : "https://vault.example.com:8200" .'
type : string
version :
default : v2
description : Version is the Vault KV secret engine version.
This can be either "v1" or "v2". Version defaults to "v2".
enum :
- v1
- v2
type : string
required :
- auth
- server
type : object
webhook :
description : Webhook configures this store to sync secrets using
a generic templated webhook
properties :
body :
description : Body
type : string
caBundle :
description : 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.
format : byte
type : string
caProvider :
description : The provider for the CA bundle to use to validate
webhook server certificate.
properties :
key :
description : The key the value inside of the provider
type to use, only used with "Secret" type
type : string
name :
description : The name of the object located at the provider
type.
type : string
namespace :
description : The namespace the Provider type is in.
type : string
type :
description : The type of provider to use such as "Secret",
or "ConfigMap".
enum :
- Secret
- ConfigMap
type : string
required :
- name
- type
type : object
headers :
additionalProperties :
type : string
description : Headers
type : object
method :
description : Webhook Method
type : string
result :
description : Result formatting
properties :
jsonPath :
description : Json path of return value
type : string
type : object
secrets :
description : Secrets to fill in templates These secrets will
be passed to the templating function as key value pairs
under the given name
items :
properties :
name :
description : Name of this secret in templates
type : string
secretRef :
description : Secret ref to fill in credentials
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it may
be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of the
referent.
type : string
type : object
required :
- name
- secretRef
type : object
type : array
timeout :
description : Timeout
type : string
url :
description : Webhook url to call
type : string
required :
- result
- url
type : object
yandexlockbox :
description : YandexLockbox configures this store to sync secrets
using Yandex Lockbox provider
properties :
apiEndpoint :
description : Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')
type : string
auth :
description : Auth defines the information necessary to authenticate
against Yandex Lockbox
properties :
authorizedKeySecretRef :
description : The authorized key used for authentication
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
caProvider :
description : The provider for the CA bundle to use to validate
Yandex.Cloud server certificate.
properties :
certSecretRef :
description : A reference to a specific 'key' within a
Secret resource, In some instances, `key` is a required
field.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
required :
- auth
type : object
type : object
retrySettings :
description : Used to configure http retries if failed
properties :
maxRetries :
format : int32
type : integer
retryInterval :
type : string
type : object
required :
- provider
type : object
status :
description : SecretStoreStatus defines the observed state of the SecretStore.
properties :
conditions :
items :
properties :
lastTransitionTime :
format : date-time
type : string
message :
type : string
reason :
type : string
status :
type : string
type :
type : string
required :
- status
- type
type : object
type : array
type : object
type : object
served : true
storage : false
subresources :
status : {}
- additionalPrinterColumns :
- jsonPath : .metadata.creationTimestamp
name : AGE
type : date
2022-07-19 18:48:37 +00:00
- jsonPath : .status.conditions[?(@.type=="Ready")].reason
name : Status
type : string
2022-11-29 19:04:46 +00:00
- jsonPath : .status.capabilities
name : Capabilities
type : string
2022-07-19 18:48:37 +00:00
- jsonPath : .status.conditions[?(@.type=="Ready")].status
name : Ready
type : string
2022-02-08 17:07:34 +00:00
name : v1beta1
2020-12-29 18:02:29 +00:00
schema :
openAPIV3Schema :
description : ClusterSecretStore represents a secure external location for
storing secrets, which can be referenced as part of `storeRef` fields.
properties :
apiVersion :
description : 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type : string
kind :
description : 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info : https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type : string
metadata :
type : object
spec :
description : SecretStoreSpec defines the desired state of SecretStore.
properties :
2022-10-17 14:40:18 +00:00
conditions :
description : Used to constraint a ClusterSecretStore to specific namespaces.
Relevant only to ClusterSecretStore
items :
description : ClusterSecretStoreCondition describes a condition by
which to choose namespaces to process ExternalSecrets in for a
ClusterSecretStore instance.
properties :
namespaceSelector :
description : Choose namespace using a labelSelector
properties :
matchExpressions :
description : matchExpressions is a list of label selector
requirements. The requirements are ANDed.
items :
description : A label selector requirement is a selector
that contains values, a key, and an operator that relates
the key and values.
properties :
key :
description : key is the label key that the selector
applies to.
type : string
operator :
description : operator represents a key's relationship
to a set of values. Valid operators are In, NotIn,
Exists and DoesNotExist.
type : string
values :
description : values is an array of string values.
If the operator is In or NotIn, the values array
must be non-empty. If the operator is Exists or
DoesNotExist, the values array must be empty. This
array is replaced during a strategic merge patch.
items :
type : string
type : array
required :
- key
- operator
type : object
type : array
matchLabels :
additionalProperties :
type : string
description : matchLabels is a map of {key,value} pairs.
A single {key,value} in the matchLabels map is equivalent
to an element of matchExpressions, whose key field is
"key" , the operator is "In", and the values array contains
only "value". The requirements are ANDed.
type : object
type : object
x-kubernetes-map-type : atomic
namespaces :
description : Choose namespaces by name
items :
type : string
type : array
type : object
type : array
2020-12-29 18:02:29 +00:00
controller :
description: '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'
type : string
provider :
description : Used to configure the provider. Only one provider may
be set
maxProperties : 1
minProperties : 1
properties :
2021-11-07 14:18:40 +00:00
akeyless :
description : Akeyless configures this store to sync secrets using
Akeyless Vault provider
properties :
akeylessGWApiURL :
description : Akeyless GW API Url from which the secrets to
be fetched from.
type : string
authSecretRef :
description : Auth configures how the operator authenticates
with Akeyless.
properties :
2022-09-11 11:25:29 +00:00
kubernetesAuth :
description : Kubernetes authenticates with Akeyless by
passing the ServiceAccount token stored in the named
Secret resource.
properties :
accessID :
description : the Akeyless Kubernetes auth-method access-id
type : string
k8sConfName :
description : Kubernetes-auth configuration name in
Akeyless-Gateway
type : string
secretRef :
description : Optional secret field containing a Kubernetes
ServiceAccount JWT used for authenticating with
Akeyless. If a name is specified without a key,
`token` is the default. If one is not specified,
the one bound to the controller will be used.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
serviceAccountRef :
description : Optional service account field containing
the name of a kubernetes ServiceAccount. If the
service account is specified, the service account
secret token JWT will be used for authenticating
with Akeyless. If the service account selector is
not supplied, the secretRef will be used instead.
properties :
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
required :
- name
type : object
required :
- accessID
- k8sConfName
type : object
2021-11-07 14:18:40 +00:00
secretRef :
2022-09-11 11:25:29 +00:00
description : Reference to a Secret that contains the details
to authenticate with Akeyless.
2021-11-07 14:18:40 +00:00
properties :
accessID :
description : The SecretAccessID is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
accessType :
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
accessTypeParam :
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
type : object
2023-03-07 12:11:02 +00:00
caBundle :
description : PEM/base64 encoded CA bundle used to validate
Akeyless Gateway certificate. Only used if the AkeylessGWApiURL
URL is using HTTPS protocol. If not set the system root
certificates are used to validate the TLS connection.
format : byte
type : string
caProvider :
description : The provider for the CA bundle to use to validate
Akeyless Gateway certificate.
properties :
key :
description : The key where the CA certificate can be found
in the Secret or ConfigMap.
type : string
name :
description : The name of the object located at the provider
type.
type : string
namespace :
description : The namespace the Provider type is in. Can
only be defined when used in a ClusterSecretStore.
type : string
type :
description : The type of provider to use such as "Secret",
or "ConfigMap".
enum :
- Secret
- ConfigMap
type : string
required :
- name
- type
type : object
2021-11-07 14:18:40 +00:00
required :
- akeylessGWApiURL
- authSecretRef
type : object
2021-08-06 16:17:29 +00:00
alibaba :
description : Alibaba configures this store to sync secrets using
Alibaba Cloud provider
properties :
auth :
description : AlibabaAuth contains a secretRef for credentials.
properties :
2023-04-16 12:12:30 +00:00
rrsa :
description : Authenticate against Alibaba using RRSA.
properties :
oidcProviderArn :
type : string
oidcTokenFilePath :
type : string
roleArn :
type : string
sessionName :
type : string
required :
- oidcProviderArn
- oidcTokenFilePath
- roleArn
- sessionName
type : object
2021-08-06 16:17:29 +00:00
secretRef :
description : AlibabaAuthSecretRef holds secret references
2021-08-31 13:36:49 +00:00
for Alibaba credentials.
2021-08-06 16:17:29 +00:00
properties :
accessKeyIDSecretRef :
description : The AccessKeyID is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
accessKeySecretSecretRef :
description : The AccessKeySecret is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
required :
- accessKeyIDSecretRef
- accessKeySecretSecretRef
type : object
type : object
regionID :
description : Alibaba Region to be used for the provider
type : string
required :
- auth
- regionID
type : object
2021-03-10 10:43:25 +00:00
aws :
description : AWS configures this store to sync secrets using AWS
Secret Manager provider
2020-12-29 18:02:29 +00:00
properties :
2023-01-08 14:49:22 +00:00
additionalRoles :
description : AdditionalRoles is a chained list of Role ARNs
which the SecretManager provider will sequentially assume
before assuming Role
items :
type : string
type : array
2020-12-29 18:02:29 +00:00
auth :
2021-02-24 19:01:28 +00:00
description : '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'
2020-12-29 18:02:29 +00:00
properties :
2021-07-07 20:27:35 +00:00
jwt :
description : Authenticate against AWS using service account
tokens.
properties :
serviceAccountRef :
description : A reference to a ServiceAccount resource.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
2021-07-07 20:27:35 +00:00
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
required :
- name
type : object
type : object
2020-12-29 18:02:29 +00:00
secretRef :
2021-03-10 10:43:25 +00:00
description : AWSAuthSecretRef holds secret references
2021-07-07 20:27:35 +00:00
for AWS credentials both AccessKeyID and SecretAccessKey
2021-02-24 19:01:28 +00:00
must be defined in order to properly authenticate.
2020-12-29 18:02:29 +00:00
properties :
accessKeyIDSecretRef :
description : The AccessKeyID is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
2020-12-29 20:50:43 +00:00
description : The name of the Secret resource being
referred to.
2020-12-29 18:02:29 +00:00
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
secretAccessKeySecretRef :
description : The SecretAccessKey is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
2020-12-29 20:50:43 +00:00
description : The name of the Secret resource being
referred to.
2020-12-29 18:02:29 +00:00
type : string
namespace :
description : Namespace of the resource being referred
2022-10-29 18:15:50 +00:00
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
sessionTokenSecretRef :
description : 'The SessionToken used for authentication
This must be defined if AccessKeyID and SecretAccessKey
are temporary credentials see : https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html'
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
2020-12-29 18:02:29 +00:00
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
type : object
2023-04-05 18:08:13 +00:00
externalID :
description : AWS External ID set on assumed IAM roles
type : string
2020-12-29 18:02:29 +00:00
region :
description : AWS Region to be used for the provider
type : string
role :
description : Role is a Role ARN which the SecretManager provider
will assume
type : string
2021-03-10 10:43:25 +00:00
service :
description : Service defines which service should be used
to fetch the secrets
enum :
- SecretsManager
- ParameterStore
type : string
2020-12-29 18:02:29 +00:00
required :
- region
2021-03-10 10:43:25 +00:00
- service
2020-12-29 18:02:29 +00:00
type : object
2021-05-17 08:25:26 +00:00
azurekv :
description : AzureKV configures this store to sync secrets using
Azure Key Vault provider
properties :
authSecretRef :
description : Auth configures how the operator authenticates
2021-12-03 11:11:56 +00:00
with Azure. Required for ServicePrincipal auth type.
2021-05-17 08:25:26 +00:00
properties :
clientId :
description : The Azure clientId of the service principle
used for authentication.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
clientSecret :
description : The Azure ClientSecret of the service principle
used for authentication.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
2021-12-03 11:11:56 +00:00
authType :
default : ServicePrincipal
description : '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)'
enum :
- ServicePrincipal
- ManagedIdentity
2022-03-22 20:59:01 +00:00
- WorkloadIdentity
2021-12-03 11:11:56 +00:00
type : string
2022-08-17 22:12:44 +00:00
environmentType :
default : PublicCloud
description : 'EnvironmentType specifies the Azure cloud environment
endpoints to use for connecting and authenticating with
Azure. By default it points to the public cloud AAD endpoint.
The following endpoints are available, also see here : https://github.com/Azure/go-autorest/blob/main/autorest/azure/environments.go#L152
PublicCloud, USGovernmentCloud, ChinaCloud, GermanCloud'
enum :
- PublicCloud
- USGovernmentCloud
- ChinaCloud
- GermanCloud
type : string
2021-12-03 11:11:56 +00:00
identityId :
description : If multiple Managed Identity is assigned to the
pod, you can select the one to be used
type : string
2022-03-22 20:59:01 +00:00
serviceAccountRef :
description : ServiceAccountRef specified the service account
that should be used when authenticating with WorkloadIdentity.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim for the
service account token If the service account uses a
well-known annotation for e.g. IRSA or GCP Workload
Identity then this audiences will be appended to the
list
items :
type : string
type : array
2022-03-22 20:59:01 +00:00
name :
description : The name of the ServiceAccount resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
required :
- name
type : object
2021-05-17 08:25:26 +00:00
tenantId :
description : TenantID configures the Azure Tenant to send
2021-12-03 11:11:56 +00:00
requests to. Required for ServicePrincipal auth type.
2021-05-17 08:25:26 +00:00
type : string
vaultUrl :
description : Vault Url from which the secrets to be fetched
from.
type : string
required :
- vaultUrl
2021-05-11 09:39:12 +00:00
type : object
2022-09-23 20:47:25 +00:00
doppler :
description : Doppler configures this store to sync secrets using
the Doppler provider
properties :
auth :
description : Auth configures how the Operator authenticates
with the Doppler API
properties :
secretRef :
properties :
dopplerToken :
description : The DopplerToken is used for authentication.
See https://docs.doppler.com/reference/api#authentication
for auth token types. The Key attribute defaults
to dopplerToken if not specified.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
required :
- dopplerToken
type : object
required :
- secretRef
type : object
config :
description : Doppler config (required if not using a Service
Token)
type : string
format :
description : Format enables the downloading of secrets as
a file (string)
enum :
- json
- dotnet-json
- env
- yaml
- docker
type : string
nameTransformer :
description : Environment variable compatible name transforms
that change secret names to a different format
enum :
- upper-camel
- camel
- lower-snake
- tf-var
- dotnet-env
type : string
project :
description : Doppler project (required if not using a Service
Token)
type : string
required :
- auth
type : object
2022-02-01 10:03:05 +00:00
fake :
description : Fake configures a store with static key/value pairs
properties :
data :
items :
properties :
key :
type : string
value :
type : string
valueMap :
additionalProperties :
type : string
type : object
version :
type : string
required :
- key
type : object
type : array
required :
- data
type : object
2021-05-20 16:09:13 +00:00
gcpsm :
description : GCPSM configures this store to sync secrets using
Google Cloud Platform Secret Manager provider
properties :
auth :
description : Auth defines the information necessary to authenticate
against GCP
properties :
secretRef :
properties :
secretAccessKeySecretRef :
description : The SecretAccessKey is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
2021-12-17 00:25:54 +00:00
workloadIdentity :
properties :
clusterLocation :
type : string
clusterName :
type : string
2022-03-02 10:24:04 +00:00
clusterProjectID :
type : string
2021-12-17 00:25:54 +00:00
serviceAccountRef :
description : A reference to a ServiceAccount resource.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
2021-12-17 00:25:54 +00:00
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
required :
- name
type : object
required :
- clusterLocation
- clusterName
- serviceAccountRef
type : object
2021-05-20 16:09:13 +00:00
type : object
projectID :
description : ProjectID project where secret is located
type : string
type : object
2021-07-29 15:32:11 +00:00
gitlab :
2023-05-15 12:12:24 +00:00
description : GitLab configures this store to sync secrets using
GitLab Variables provider
2021-07-29 15:32:11 +00:00
properties :
auth :
description : Auth configures how secret-manager authenticates
2021-08-26 16:19:56 +00:00
with a GitLab instance.
2021-07-29 15:32:11 +00:00
properties :
SecretRef :
properties :
accessToken :
2021-08-26 16:19:56 +00:00
description : AccessToken is used for authentication.
2021-07-29 15:32:11 +00:00
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
required :
- SecretRef
type : object
2022-09-27 20:08:38 +00:00
environment :
description : Environment environment_scope of gitlab CI/CD
variables (Please see https://docs.gitlab.com/ee/ci/environments/#create-a-static-environment
on how to create environments)
type : string
2022-11-21 21:26:34 +00:00
groupIDs :
description : GroupIDs specify, which gitlab groups to pull
secrets from. Group secrets are read from left to right
followed by the project variables.
items :
type : string
type : array
inheritFromGroups :
description : InheritFromGroups specifies whether parent groups
should be discovered and checked for secrets.
type : boolean
2021-07-29 15:32:11 +00:00
projectID :
2021-08-26 16:19:56 +00:00
description : ProjectID specifies a project where secrets are
located.
type : string
url :
description : URL configures the GitLab instance URL. Defaults
to https://gitlab.com/.
2021-07-29 15:32:11 +00:00
type : string
2021-05-20 16:09:13 +00:00
required :
- auth
type : object
2021-05-19 09:50:36 +00:00
ibm :
description : IBM configures this store to sync secrets using IBM
Cloud provider
properties :
auth :
description : Auth configures how secret-manager authenticates
with the IBM secrets manager.
2022-07-26 20:48:07 +00:00
maxProperties : 1
minProperties : 1
2021-05-19 09:50:36 +00:00
properties :
2022-07-26 20:48:07 +00:00
containerAuth :
description : IBM Container-based auth with IAM Trusted
Profile.
properties :
iamEndpoint :
type : string
profile :
description : the IBM Trusted Profile
type : string
tokenLocation :
description : Location the token is mounted on the
pod
type : string
required :
- profile
type : object
2021-05-19 09:50:36 +00:00
secretRef :
properties :
secretApiKeySecretRef :
description : The SecretAccessKey is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
type : object
serviceUrl :
description : ServiceURL is the Endpoint URL that is specific
to the Secrets Manager service instance
type : string
required :
- auth
type : object
2023-02-03 14:27:21 +00:00
keepersecurity :
description : KeeperSecurity configures this store to sync secrets
using the KeeperSecurity provider
properties :
2023-02-27 22:22:33 +00:00
authRef :
description : A reference to a specific 'key' within a Secret
resource, In some instances, `key` is a required field.
2023-02-03 14:27:21 +00:00
properties :
2023-02-27 22:22:33 +00:00
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this field
may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being referred
to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
2023-02-03 14:27:21 +00:00
type : object
folderID :
type : string
required :
2023-02-27 22:22:33 +00:00
- authRef
2023-02-03 14:27:21 +00:00
- folderID
type : object
2022-01-25 20:11:12 +00:00
kubernetes :
description : Kubernetes configures this store to sync secrets
using a Kubernetes cluster provider
properties :
auth :
description : Auth configures how secret-manager authenticates
with a Kubernetes instance.
2022-02-22 18:45:45 +00:00
maxProperties : 1
minProperties : 1
2022-01-25 20:11:12 +00:00
properties :
2022-02-17 17:45:43 +00:00
cert :
description : has both clientCert and clientKey as secretKeySelector
2022-01-25 20:11:12 +00:00
properties :
2022-02-17 18:38:45 +00:00
clientCert :
2022-01-25 20:11:12 +00:00
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
2022-02-17 18:38:45 +00:00
clientKey :
2022-01-25 20:11:12 +00:00
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
2022-02-17 17:45:43 +00:00
type : object
serviceAccount :
description : points to a service account that should be
used for authentication
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim for
the service account token If the service account
uses a well-known annotation for e.g. IRSA or GCP
Workload Identity then this audiences will be appended
to the list
items :
type : string
type : array
2022-06-13 19:49:05 +00:00
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
required :
- name
2022-02-17 17:45:43 +00:00
type : object
token :
description : use static token to authenticate with
properties :
bearerToken :
2022-01-25 20:11:12 +00:00
description : A reference to a specific 'key' within
a Secret resource, In some instances, `key` is a
required field.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
type : object
remoteNamespace :
2022-01-26 18:27:59 +00:00
default : default
description : Remote namespace to fetch the secrets from
2022-01-25 20:11:12 +00:00
type : string
server :
2022-01-26 18:27:59 +00:00
description : configures the Kubernetes server Address.
2022-02-17 17:45:43 +00:00
properties :
caBundle :
description : CABundle is a base64-encoded CA certificate
format : byte
type : string
caProvider :
description: 'see : https://external-secrets.io/v0.4.1/spec/#external-secrets.io/v1alpha1.CAProvider'
properties :
key :
2022-07-27 21:44:23 +00:00
description : The key where the CA certificate can
be found in the Secret or ConfigMap.
2022-02-17 17:45:43 +00:00
type : string
name :
description : The name of the object located at the
provider type.
type : string
namespace :
description : The namespace the Provider type is in.
2022-07-27 21:44:23 +00:00
Can only be defined when used in a ClusterSecretStore.
2022-02-17 17:45:43 +00:00
type : string
type :
description : The type of provider to use such as "Secret",
or "ConfigMap".
enum :
- Secret
- ConfigMap
type : string
required :
- name
- type
type : object
url :
default : kubernetes.default
description : configures the Kubernetes server Address.
type : string
type : object
required :
- auth
2022-01-25 20:11:12 +00:00
type : object
2021-11-02 09:03:35 +00:00
onepassword :
description : OnePassword configures this store to sync secrets
using the 1Password Cloud provider
properties :
auth :
description : Auth defines the information necessary to authenticate
against OnePassword Connect Server
properties :
secretRef :
description : OnePasswordAuthSecretRef holds secret references
for 1Password credentials.
properties :
connectTokenSecretRef :
description : The ConnectToken is used for authentication
to a 1Password Connect Server.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
required :
- connectTokenSecretRef
type : object
required :
- secretRef
type : object
connectHost :
description : ConnectHost defines the OnePassword Connect Server
to connect to
type : string
vaults :
additionalProperties :
type : integer
description : Vaults defines which OnePassword vaults to search
in which order
type : object
required :
- auth
- connectHost
- vaults
type : object
2021-08-27 15:09:39 +00:00
oracle :
description : Oracle configures this store to sync secrets using
2021-09-03 10:14:17 +00:00
Oracle Vault provider
2021-08-27 15:09:39 +00:00
properties :
auth :
description : Auth configures how secret-manager authenticates
2022-02-07 13:03:49 +00:00
with the Oracle Vault. If empty, use the instance principal,
otherwise the user credentials specified in Auth.
2021-08-27 15:09:39 +00:00
properties :
secretRef :
2021-09-02 14:19:47 +00:00
description : SecretRef to pass through sensitive information.
2021-08-27 15:09:39 +00:00
properties :
fingerprint :
2022-01-16 10:02:56 +00:00
description : Fingerprint is the fingerprint of the
API private key.
2021-08-27 15:09:39 +00:00
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
privatekey :
2022-01-16 10:02:56 +00:00
description : PrivateKey is the user's API Signing
Key in PEM format, used for authentication.
2021-08-27 15:09:39 +00:00
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
2022-02-07 13:03:49 +00:00
required :
- fingerprint
- privatekey
2021-08-27 15:09:39 +00:00
type : object
2022-02-07 13:03:49 +00:00
tenancy :
description : Tenancy is the tenancy OCID where user is
located.
type : string
user :
description : User is an access OCID specific to the account.
type : string
2021-08-27 15:09:39 +00:00
required :
- secretRef
2022-02-07 13:03:49 +00:00
- tenancy
- user
2021-08-27 15:09:39 +00:00
type : object
region :
2022-02-07 13:03:49 +00:00
description : Region is the region where vault is located.
2021-08-27 15:09:39 +00:00
type : string
2022-01-16 10:05:58 +00:00
vault :
description : Vault is the vault's OCID of the specific vault
where secret is located.
type : string
2021-08-27 15:09:39 +00:00
required :
2022-02-07 13:03:49 +00:00
- region
- vault
2021-08-27 15:09:39 +00:00
type : object
2023-03-16 00:03:52 +00:00
scaleway :
description : Scaleway
properties :
accessKey :
description : AccessKey is the non-secret part of the api key.
properties :
secretRef :
description : SecretRef references a key in a secret that
will be used as value.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
value :
description : Value can be specified directly to set a
value without using a secret.
type : string
type : object
apiUrl :
description : APIURL is the url of the api to use. Defaults
to https://api.scaleway.com
type : string
projectId :
description : 'ProjectID is the id of your project, which you
can find in the console : https://console.scaleway.com/project/settings'
type : string
region :
description: 'Region where your secrets are located : https://developers.scaleway.com/en/quickstart/#region-and-zone'
type : string
secretKey :
description : SecretKey is the non-secret part of the api key.
properties :
secretRef :
description : SecretRef references a key in a secret that
will be used as value.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
value :
description : Value can be specified directly to set a
value without using a secret.
type : string
type : object
required :
- accessKey
- projectId
- region
- secretKey
type : object
2022-05-02 16:28:18 +00:00
senhasegura :
description : Senhasegura configures this store to sync secrets
using senhasegura provider
properties :
auth :
description : Auth defines parameters to authenticate in senhasegura
properties :
clientId :
type : string
clientSecretSecretRef :
description : A reference to a specific 'key' within a
Secret resource, In some instances, `key` is a required
field.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
required :
- clientId
- clientSecretSecretRef
type : object
ignoreSslCertificate :
default : false
description : IgnoreSslCertificate defines if SSL certificate
must be ignored
type : boolean
module :
description : Module defines which senhasegura module should
be used to get secrets
type : string
url :
description : URL of senhasegura
type : string
required :
- auth
- module
- url
type : object
2021-03-01 10:13:03 +00:00
vault :
description : Vault configures this store to sync secrets using
Hashi provider
properties :
auth :
description : Auth configures how secret-manager authenticates
with the Vault server.
properties :
appRole :
description : AppRole authenticates with Vault using the
App Role auth mechanism, with the role and secret stored
in a Kubernetes Secret resource.
properties :
path :
default : approle
description : 'Path where the App Role authentication
backend is mounted in Vault, e.g : "approle" '
type : string
roleId :
description : RoleID configured in the App Role authentication
backend when setting up the authentication backend
in Vault.
type : string
2023-05-12 10:56:26 +00:00
roleRef :
description : Reference to a key in a Secret that contains
the App Role ID used to authenticate with Vault.
The `key` field must be specified and denotes which
entry within the Secret resource is used as the
app role id.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
2021-03-01 10:13:03 +00:00
secretRef :
description : 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.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
required :
- path
- secretRef
type : object
2021-07-13 20:44:10 +00:00
cert :
description : Cert authenticates with TLS Certificates
by passing client certificate, private key and ca certificate
Cert authentication method
properties :
2021-07-14 11:59:04 +00:00
clientCert :
2021-07-13 20:44:10 +00:00
description : ClientCert is a certificate to authenticate
using the Cert Vault authentication method
2021-07-21 21:30:49 +00:00
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
2021-07-13 20:44:10 +00:00
secretRef :
description : SecretRef to a key in a Secret resource
containing client private key to authenticate with
Vault using the Cert authentication method
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
type : object
2023-05-11 09:10:07 +00:00
iam :
description : Iam authenticates with vault by passing a
special AWS request signed with AWS IAM credentials
AWS IAM authentication method
properties :
externalID :
description : AWS External ID set on assumed IAM roles
type : string
jwt :
description : Specify a service account with IRSA enabled
properties :
serviceAccountRef :
description : A reference to a ServiceAccount resource.
properties :
audiences :
description : Audience specifies the `aud`
claim for the service account token If the
service account uses a well-known annotation
for e.g. IRSA or GCP Workload Identity then
this audiences will be appended to the list
items :
type : string
type : array
name :
description : The name of the ServiceAccount
resource being referred to.
type : string
namespace :
description : Namespace of the resource being
referred to. Ignored if referent is not
cluster-scoped. cluster-scoped defaults
to the namespace of the referent.
type : string
required :
- name
type : object
type : object
path :
description : 'Path where the AWS auth method is enabled
in Vault, e.g : "aws" '
type : string
region :
description : AWS region
type : string
role :
description : This is the AWS role to be assumed before
talking to vault
type : string
secretRef :
description : Specify credentials in a Secret object
properties :
accessKeyIDSecretRef :
description : The AccessKeyID is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some
instances of this field may be defaulted,
in others it may be required.
type : string
name :
description : The name of the Secret resource
being referred to.
type : string
namespace :
description : Namespace of the resource being
referred to. Ignored if referent is not
cluster-scoped. cluster-scoped defaults
to the namespace of the referent.
type : string
type : object
secretAccessKeySecretRef :
description : The SecretAccessKey is used for authentication
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some
instances of this field may be defaulted,
in others it may be required.
type : string
name :
description : The name of the Secret resource
being referred to.
type : string
namespace :
description : Namespace of the resource being
referred to. Ignored if referent is not
cluster-scoped. cluster-scoped defaults
to the namespace of the referent.
type : string
type : object
sessionTokenSecretRef :
description : 'The SessionToken used for authentication
This must be defined if AccessKeyID and SecretAccessKey
are temporary credentials see : https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html'
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some
instances of this field may be defaulted,
in others it may be required.
type : string
name :
description : The name of the Secret resource
being referred to.
type : string
namespace :
description : Namespace of the resource being
referred to. Ignored if referent is not
cluster-scoped. cluster-scoped defaults
to the namespace of the referent.
type : string
type : object
type : object
vaultAwsIamServerID :
description : 'X-Vault-AWS-IAM-Server-ID is an additional
header used by Vault IAM auth method to mitigate
against different types of replay attacks. More
details here : https://developer.hashicorp.com/vault/docs/auth/aws'
type : string
vaultRole :
description : Vault Role. In vault, a role describes
an identity with a set of permissions, groups, or
policies you want to attach a user of the secrets
engine
type : string
required :
- vaultRole
type : object
2021-05-13 16:19:57 +00:00
jwt :
description : Jwt authenticates with Vault by passing role
and JWT token using the JWT/OIDC authentication method
properties :
2022-04-04 19:20:58 +00:00
kubernetesServiceAccountToken :
description : Optional ServiceAccountToken specifies
the Kubernetes service account for which to request
a token for with the `TokenRequest` API.
properties :
audiences :
2022-08-19 15:32:06 +00:00
description : 'Optional audiences field that will
2022-04-04 19:20:58 +00:00
be used to request a temporary Kubernetes service
account token for the service account referenced
by `serviceAccountRef`. Defaults to a single
2022-08-19 15:32:06 +00:00
audience `vault` it not specified. Deprecated :
use serviceAccountRef.Audiences instead'
2022-04-04 19:20:58 +00:00
items :
type : string
type : array
expirationSeconds :
2022-08-19 15:32:06 +00:00
description : 'Optional expiration time in seconds
2022-04-04 19:20:58 +00:00
that will be used to request a temporary Kubernetes
service account token for the service account
2022-08-19 15:32:06 +00:00
referenced by `serviceAccountRef`. Deprecated :
this will be removed in the future. Defaults
to 10 minutes.'
2022-04-04 19:20:58 +00:00
format : int64
type : integer
serviceAccountRef :
description : Service account field containing
the name of a kubernetes ServiceAccount.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud`
claim for the service account token If the
service account uses a well-known annotation
for e.g. IRSA or GCP Workload Identity then
this audiences will be appended to the list
items :
type : string
type : array
2022-04-04 19:20:58 +00:00
name :
description : The name of the ServiceAccount
resource being referred to.
type : string
namespace :
description : Namespace of the resource being
referred to. Ignored if referent is not
cluster-scoped. cluster-scoped defaults
to the namespace of the referent.
type : string
required :
- name
type : object
required :
- serviceAccountRef
type : object
2022-01-05 23:22:00 +00:00
path :
default : jwt
description : 'Path where the JWT authentication backend
is mounted in Vault, e.g : "jwt" '
type : string
2021-05-13 16:19:57 +00:00
role :
description : Role is a JWT role to authenticate using
the JWT/OIDC Vault authentication method
type : string
2021-05-14 09:39:41 +00:00
secretRef :
2022-04-04 19:20:58 +00:00
description : Optional SecretRef that refers to a key
in a Secret resource containing JWT token to authenticate
with Vault using the JWT/OIDC authentication method.
2021-05-13 16:19:57 +00:00
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
2022-01-05 23:22:00 +00:00
required :
- path
2021-05-13 16:19:57 +00:00
type : object
2021-03-01 10:13:03 +00:00
kubernetes :
description : Kubernetes authenticates with Vault by passing
the ServiceAccount token stored in the named Secret
resource to the Vault server.
properties :
mountPath :
default : kubernetes
description : 'Path where the Kubernetes authentication
backend is mounted in Vault, e.g : "kubernetes" '
type : string
role :
description : A required field containing the Vault
Role to assume. A Role binds a Kubernetes ServiceAccount
with a set of Vault policies.
type : string
secretRef :
description : 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.
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
2021-04-08 17:11:56 +00:00
the referent.
type : string
type : object
serviceAccountRef :
description : 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.
properties :
2022-08-19 15:32:06 +00:00
audiences :
description : Audience specifies the `aud` claim
for the service account token If the service
account uses a well-known annotation for e.g.
IRSA or GCP Workload Identity then this audiences
will be appended to the list
items :
type : string
type : array
2021-04-08 17:11:56 +00:00
name :
description : The name of the ServiceAccount resource
being referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
2021-03-01 10:13:03 +00:00
the referent.
type : string
required :
- name
type : object
required :
- mountPath
- role
type : object
2021-05-13 15:02:04 +00:00
ldap :
description : Ldap authenticates with Vault by passing
username/password pair using the LDAP authentication
method
properties :
2022-01-05 22:54:50 +00:00
path :
default : ldap
description : 'Path where the LDAP authentication backend
is mounted in Vault, e.g : "ldap" '
type : string
2021-05-14 09:39:41 +00:00
secretRef :
2021-05-13 15:02:04 +00:00
description : SecretRef to a key in a Secret resource
containing password for the LDAP user used to authenticate
with Vault using the LDAP authentication method
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it
may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of
the referent.
type : string
type : object
username :
description : Username is a LDAP user name used to
authenticate using the LDAP Vault authentication
method
type : string
required :
2022-01-05 22:54:50 +00:00
- path
2021-05-13 15:02:04 +00:00
- username
type : object
2021-03-01 10:13:03 +00:00
tokenSecretRef :
description : TokenSecretRef authenticates with Vault by
presenting a token.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
caBundle :
description : 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.
format : byte
type : string
2021-10-06 04:55:44 +00:00
caProvider :
description : The provider for the CA bundle to use to validate
Vault server certificate.
properties :
key :
2022-07-27 21:44:23 +00:00
description : The key where the CA certificate can be found
in the Secret or ConfigMap.
2021-10-06 04:55:44 +00:00
type : string
name :
description : The name of the object located at the provider
type.
type : string
namespace :
2022-07-27 21:44:23 +00:00
description : The namespace the Provider type is in. Can
only be defined when used in a ClusterSecretStore.
2021-10-06 04:55:44 +00:00
type : string
type :
description : The type of provider to use such as "Secret",
or "ConfigMap".
enum :
- Secret
- ConfigMap
type : string
required :
- name
- type
type : object
2022-01-19 22:16:45 +00:00
forwardInconsistent :
description : 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
type : boolean
2021-03-01 10:13:03 +00:00
namespace :
description : 'Name of the vault namespace. Namespaces is a
set of features within Vault Enterprise that allows Vault
environments to support Secure Multi-tenancy. e.g : "ns1" .
More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces'
type : string
path :
description : 'Path is the mount path of the Vault KV backend
endpoint, e.g : "secret" . The v2 KV secret engine version
specific "/data" path suffix for fetching secrets from Vault
is optional and will be appended if not present in specified
path.'
type : string
2022-01-19 22:16:45 +00:00
readYourWrites :
description : ReadYourWrites ensures isolated read-after-write
semantics by providing discovered cluster replication states
in each request. More information about eventual consistency
in Vault can be found here https://www.vaultproject.io/docs/enterprise/consistency
type : boolean
2021-03-01 10:13:03 +00:00
server :
description : 'Server is the connection address for the Vault
server, e.g : "https://vault.example.com:8200" .'
type : string
version :
default : v2
description : Version is the Vault KV secret engine version.
This can be either "v1" or "v2". Version defaults to "v2".
enum :
- v1
- v2
type : string
required :
- auth
- server
type : object
2021-12-29 09:53:29 +00:00
webhook :
description : Webhook configures this store to sync secrets using
a generic templated webhook
properties :
body :
description : Body
type : string
caBundle :
description : 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.
format : byte
type : string
caProvider :
description : The provider for the CA bundle to use to validate
webhook server certificate.
properties :
key :
description : The key the value inside of the provider
type to use, only used with "Secret" type
type : string
name :
description : The name of the object located at the provider
type.
type : string
namespace :
description : The namespace the Provider type is in.
type : string
type :
description : The type of provider to use such as "Secret",
or "ConfigMap".
enum :
- Secret
- ConfigMap
type : string
required :
- name
- type
type : object
headers :
additionalProperties :
type : string
description : Headers
type : object
method :
description : Webhook Method
type : string
result :
description : Result formatting
properties :
jsonPath :
description : Json path of return value
type : string
type : object
secrets :
description : Secrets to fill in templates These secrets will
be passed to the templating function as key value pairs
under the given name
items :
properties :
name :
description : Name of this secret in templates
type : string
secretRef :
description : Secret ref to fill in credentials
properties :
key :
description : The key of the entry in the Secret
resource's `data` field to be used. Some instances
of this field may be defaulted, in others it may
be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped.
cluster-scoped defaults to the namespace of the
referent.
type : string
type : object
required :
- name
- secretRef
type : object
type : array
timeout :
description : Timeout
type : string
url :
description : Webhook url to call
type : string
required :
- result
- url
type : object
2022-04-22 18:40:52 +00:00
yandexcertificatemanager :
description : YandexCertificateManager configures this store to
sync secrets using Yandex Certificate Manager provider
properties :
apiEndpoint :
description : Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')
type : string
auth :
description : Auth defines the information necessary to authenticate
against Yandex Certificate Manager
properties :
authorizedKeySecretRef :
description : The authorized key used for authentication
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
caProvider :
description : The provider for the CA bundle to use to validate
Yandex.Cloud server certificate.
properties :
certSecretRef :
description : A reference to a specific 'key' within a
Secret resource, In some instances, `key` is a required
field.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
required :
- auth
type : object
2021-08-12 17:05:02 +00:00
yandexlockbox :
description : YandexLockbox configures this store to sync secrets
using Yandex Lockbox provider
properties :
2021-08-20 13:16:35 +00:00
apiEndpoint :
description : Yandex.Cloud API endpoint (e.g. 'api.cloud.yandex.net:443')
type : string
2021-08-12 17:05:02 +00:00
auth :
description : Auth defines the information necessary to authenticate
against Yandex Lockbox
properties :
authorizedKeySecretRef :
2021-08-19 14:33:36 +00:00
description : The authorized key used for authentication
2021-08-12 17:05:02 +00:00
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
2021-12-16 19:16:23 +00:00
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
caProvider :
description : The provider for the CA bundle to use to validate
Yandex.Cloud server certificate.
properties :
certSecretRef :
description : A reference to a specific 'key' within a
Secret resource, In some instances, `key` is a required
field.
properties :
key :
description : The key of the entry in the Secret resource's
`data` field to be used. Some instances of this
field may be defaulted, in others it may be required.
type : string
name :
2021-08-12 17:05:02 +00:00
description : The name of the Secret resource being
referred to.
type : string
namespace :
description : Namespace of the resource being referred
to. Ignored if referent is not cluster-scoped. cluster-scoped
defaults to the namespace of the referent.
type : string
type : object
type : object
required :
- auth
type : object
2020-12-29 18:02:29 +00:00
type : object
2022-04-06 04:02:19 +00:00
refreshInterval :
description : Used to configure store refresh interval in seconds.
Empty or 0 will default to the controller config.
type : integer
2021-10-20 23:50:01 +00:00
retrySettings :
description : Used to configure http retries if failed
properties :
maxRetries :
format : int32
type : integer
retryInterval :
type : string
type : object
2020-12-29 18:02:29 +00:00
required :
- provider
type : object
2021-06-25 20:28:46 +00:00
status :
description : SecretStoreStatus defines the observed state of the SecretStore.
properties :
2022-11-29 19:04:46 +00:00
capabilities :
description : SecretStoreCapabilities defines the possible operations
a SecretStore can do.
type : string
2021-06-25 20:28:46 +00:00
conditions :
items :
properties :
lastTransitionTime :
format : date-time
type : string
message :
type : string
reason :
type : string
status :
type : string
type :
type : string
required :
- status
- type
type : object
type : array
type : object
2020-12-29 18:02:29 +00:00
type : object
served : true
storage : true
subresources :
status : {}
