ClusterGenerator represents a cluster-wide generator which can be referenced as part of `generatorRef` fields.
4 top-level fields · last changed in External Secrets Operator v2.10.0
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
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
ClusterGeneratorSpec defines the desired state of a ClusterGenerator.
Generator the spec for this generator, must match the kind.
ACRAccessTokenSpec defines how to generate the access token e.g. how to authenticate and which registry to use. see: https://github.com/Azure/acr/blob/main/docs/AAD-OAuth.md#overview
ACRAuth defines the authentication methods for Azure Container Registry.
ManagedIdentity uses Azure Managed Identity to authenticate with Azure.
If multiple Managed Identity is assigned to the pod, you can select the one to be used
ServicePrincipal uses Azure Service Principal credentials to authenticate with Azure.
AzureACRServicePrincipalAuthSecretRef defines the secret references for Azure Service Principal authentication. It uses static credentials stored in a Kind=Secret.
The Azure clientId of the service principle used for authentication.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
The Azure ClientSecret of the service principle used for authentication.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
WorkloadIdentity uses Azure Workload Identity to authenticate with Azure.
ServiceAccountRef specified the service account that should be used when authenticating with WorkloadIdentity.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
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
the domain name of the ACR registry e.g. foobarexample.azurecr.io
Define the scope for the access token, e.g. pull/push access for a repository. if not provided it will return a refresh token that has full scope. Note: you need to pin it down to the repository level, there is no wildcard available. examples: repository:my-repository:pull,push repository:my-repository:pull see docs for details: https://docs.docker.com/registry/spec/auth/scope/
TenantID configures the Azure Tenant to send requests to. Required for ServicePrincipal auth type.
BeyondtrustWorkloadCredentialsDynamicSecretSpec defines the desired spec for BeyondtrustWorkloadCredentials dynamic generator. This generator enables obtaining temporary, short-lived credentials from BeyondTrust Workload Credentials. For more information, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api
Controller selects the controller that should handle this generator. Leave empty to use the default controller.
Provider contains the BeyondtrustWorkloadCredentials provider configuration including authentication, server connection details, and the folder path to the dynamic secret definition. The folderPath should point to a dynamic secret definition that has been created in BeyondTrust Workload Credentials (e.g., "production/aws-temp"). For setup details, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api
Auth configures how the Operator authenticates with the BeyondTrust Workload Credentials API. Currently supports API key authentication via Kubernetes secret reference. For authentication setup, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication
APIKey configures API token authentication for BeyondTrust Workload Credentials. The token is retrieved from a Kubernetes secret and used as a Bearer token for API requests.
Token references the Kubernetes secret containing the BeyondTrust Workload Credentials API token. The secret should contain the API key used to authenticate with BeyondTrust Workload Credentials. Create an API token in your BeyondTrust Workload Credentials console and store it in a Kubernetes secret. For details on creating API tokens, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api#authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
CABundle is a base64-encoded CA certificate used to validate the BeyondTrust Workload Credentials API TLS certificate. Use this when your BeyondTrust instance uses a self-signed certificate or internal CA. If not set, the system's trusted root certificates are used.
CAProvider points to a Secret or ConfigMap containing a PEM-encoded CA certificate. This is used to validate the BeyondTrust Workload Credentials API TLS certificate. Use this as an alternative to CABundle when you want to reference an existing Kubernetes resource.
The key where the CA certificate can be found in the Secret or ConfigMap.
The name of the object located at the provider type.
The namespace the Provider type is in. Can only be defined when used in a ClusterSecretStore.
The type of provider to use such as "Secret", or "ConfigMap".
FolderPath specifies the default folder path for secret retrieval. Secrets will be fetched from this folder unless overridden in the ExternalSecret spec. Example: "production/database" or "dev/api-keys" Leave empty to retrieve secrets from the root folder. For folder organization, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api#folders
Server configures the BeyondTrust Workload Credentials server connection details. Includes the API URL and Site ID for your BeyondTrust instance. For API reference, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api
APIURL is the base URL of your BeyondTrust Workload Credentials API server. This should be the full URL to your BeyondTrust instance. Example: https://api.beyondtrust.io/siie For more information, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api#base-url
SiteID is your BeyondTrust Workload Credentials site identifier (UUID format). This identifier is unique to your BeyondTrust Workload Credentials instance. You can find your Site ID in the BeyondTrust Workload Credentials admin console. Example: a1b2c3d4-e5f6-4890-abcd-ef1234567890 For more information, see: https://docs.beyondtrust.com/bt-docs/docs/secrets-api
RetrySettings configures exponential backoff for failed API requests. If not specified, uses the default retry settings.
CloudsmithAccessTokenSpec defines the configuration for generating a Cloudsmith access token using OIDC authentication.
APIURL configures the Cloudsmith API URL. Defaults to https://api.cloudsmith.io.
OrgSlug is the organization slug in Cloudsmith
Name of the service account you are federating with
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
ServiceSlug is the service slug in Cloudsmith for OIDC authentication
ECRAuthorizationTokenSpec defines the desired state to generate an AWS ECR authorization token.
Auth defines how to authenticate with AWS
AWSJWTAuth provides configuration to authenticate against AWS using service account tokens.
ServiceAccountSelector is a reference to a ServiceAccount resource.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
AWSAuthSecretRef holds secret references for AWS credentials both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.
The AccessKeyID is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
The SecretAccessKey is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
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
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Region specifies the region to operate in.
You can assume a role before making calls to the desired AWS service.
Scope specifies the ECR service scope. Valid options are private and public.
FakeSpec contains the static data.
Used to select the correct ESO controller (think: ingress.ingressClassName) The ESO controller is instantiated with a specific controller name and filters VDS based on this property
Data defines the static data returned by this generator.
GCRAccessTokenSpec defines the desired state to generate a Google Container Registry access token.
Auth defines the means for authenticating with GCP
GCPSMAuthSecretRef defines the reference to a secret containing Google Cloud Platform credentials.
The SecretAccessKey is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
GCPWorkloadIdentity defines the configuration for using GCP Workload Identity authentication.
ServiceAccountSelector is a reference to a ServiceAccount resource.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
GCPWorkloadIdentityFederation holds the configurations required for generating federated access tokens.
audience is the Secure Token Service (STS) audience which contains the resource name for the workload identity pool and the provider identifier in that pool. If specified, Audience found in the external account credential config will be overridden with the configured value. audience must be provided when serviceAccountRef or awsSecurityCredentials is configured.
awsSecurityCredentials is for configuring AWS region and credentials to use for obtaining the access token, when using the AWS metadata server is not an option.
awsCredentialsSecretRef is the reference to the secret which holds the AWS credentials. Secret should be created with below names for keys - aws_access_key_id: Access Key ID, which is the unique identifier for the AWS account or the IAM user. - aws_secret_access_key: Secret Access Key, which is used to authenticate requests made to AWS services. - aws_session_token: Session Token, is the short-lived token to authenticate requests made to AWS services.
name of the secret.
namespace in which the secret exists. If empty, secret will looked up in local namespace.
region is for configuring the AWS region to be used.
credConfig holds the configmap reference containing the GCP external account credential configuration in JSON format and the key name containing the json data. For using Kubernetes cluster as the identity provider, use serviceAccountRef instead. Operators mounted serviceaccount token cannot be used as the token source, instead serviceAccountRef must be used by providing operators service account details.
key name holding the external account credential config.
name of the configmap.
namespace in which the configmap exists. If empty, configmap will looked up in local namespace.
externalTokenEndpoint is the endpoint explicitly set up to provide tokens, which will be matched against the credential_source.url in the provided credConfig. This field is merely to double-check the external token source URL is having the expected value.
GCPServiceAccountEmail is the email of the Google Cloud service account to impersonate after Workload Identity Federation. Use this to grant access through the service account's IAM bindings (for example roles/secretmanager.secretAccessor). When set, it overrides service_account_impersonation_url in the external account JSON from credConfig; when serviceAccountRef is set, it also overrides the "iam.gke.io/gcp-service-account" annotation on that ServiceAccount.
serviceAccountRef is the reference to the kubernetes ServiceAccount to be used for obtaining the tokens, when Kubernetes is configured as provider in workload identity pool.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
ProjectID defines which project to use to authenticate with
GithubAccessTokenSpec defines the desired state to generate a GitHub access token.
Auth configures how ESO authenticates with a Github instance.
GithubSecretRef references a secret containing GitHub credentials.
SecretKeySelector is a reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Map of permissions the token will have. If omitted, defaults to all permissions the GitHub App has.
List of repositories the token will have access to. If omitted, defaults to all repositories the GitHub App is installed to.
URL configures the GitHub instance URL. Defaults to https://github.com/.
GitlabDeployTokenSpec defines the desired state to generate a GitLab deploy token.
Auth configures how ESO authenticates with the GitLab API.
Token references a secret containing a GitLab access token (personal, group, or project) with the api scope and at least the Maintainer role on the target.
SecretKeySelector is a reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
ExpiresAt is an optional expiry for the deploy token. If omitted the token does not expire on the GitLab side and is revoked only when the generator state is cleaned up (on regeneration or when the consuming ExternalSecret is deleted).
GroupID is the numeric ID or unescaped path (e.g. parent/group) of the group to create the deploy token in. The generator URL-escapes paths before calling the GitLab API, so do not pre-encode. Mutually exclusive with projectID.
Name of the deploy token.
ProjectID is the numeric ID or unescaped path (e.g. group/project) of the project to create the deploy token in. The generator URL-escapes paths before calling the GitLab API, so do not pre-encode. Mutually exclusive with groupID.
Scopes granted to the deploy token. At least one scope is required.
URL configures the GitLab instance URL. Defaults to https://gitlab.com.
Username is an optional username for the deploy token. GitLab defaults it to gitlab+deploy-token-{n} when omitted.
GrafanaSpec controls the behavior of the grafana generator.
Auth is the authentication configuration to authenticate against the Grafana instance.
Basic auth credentials used to authenticate against the Grafana instance. Note: you need a token which has elevated permissions to create service accounts. See here for the documentation on basic roles offered by Grafana: https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
A basic auth password used to authenticate against the Grafana instance.
The key where the token is found.
The name of the Secret resource being referred to.
A basic auth username used to authenticate against the Grafana instance.
A service account token used to authenticate against the Grafana instance. Note: you need a token which has elevated permissions to create service accounts. See here for the documentation on basic roles offered by Grafana: https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
The key where the token is found.
The name of the Secret resource being referred to.
ServiceAccount is the configuration for the service account that is supposed to be generated by the generator.
Name is the name of the service account that will be created by ESO.
Role is the role of the service account. See here for the documentation on basic roles offered by Grafana: https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/
SecondsToLive is the number of seconds before the generated service account token will expire. Some Grafana deployments (e.g. AWS Managed Grafana) require this value to be set.
URL is the URL of the Grafana instance.
MFASpec controls the behavior of the mfa generator.
Algorithm to use for encoding. Defaults to SHA1 as per the RFC.
Length defines the token length. Defaults to 6 characters.
Secret is a secret selector to a secret containing the seed secret to generate the TOTP value from.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
TimePeriod defines how long the token can be active. Defaults to 30 seconds.
When defines a time parameter that can be used to pin the origin time of the generated token.
PasswordSpec controls the behavior of the password generator.
set AllowRepeat to true to allow repeating characters.
Digits specifies the number of digits in the generated password. If omitted it defaults to 25% of the length of the password
Encoding specifies the encoding of the generated password. Valid values are: - "raw" (default): no encoding - "base64": standard base64 encoding - "base64url": base64url encoding - "base32": base32 encoding - "hex": hexadecimal encoding
Length of the password to be generated. Defaults to 24
Set NoUpper to disable uppercase characters
SecretKeys defines the keys that will be populated with generated passwords. Defaults to "password" when not set.
SymbolCharacters specifies the special characters that should be used in the generated password.
Symbols specifies the number of symbol characters in the generated password. If omitted it defaults to 25% of the length of the password
QuayAccessTokenSpec defines the desired state to generate a Quay access token.
Name of the robot account you are federating with
Name of the service account you are federating with
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
URL configures the Quay instance URL. Defaults to quay.io.
SSHKeySpec controls the behavior of the ssh key generator.
Comment specifies an optional comment for the SSH key
KeySize specifies the key size for RSA keys (default: 2048) and ECDSA keys (default: 256). For RSA keys: 2048, 3072, 4096 For ECDSA keys: 256, 384, 521 Ignored for ed25519 keys
KeyType specifies the SSH key type (rsa, ecdsa, ed25519)
STSSessionTokenSpec defines the desired state to generate an AWS STS session token.
Auth defines how to authenticate with AWS
AWSJWTAuth provides configuration to authenticate against AWS using service account tokens.
ServiceAccountSelector is a reference to a ServiceAccount resource.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
AWSAuthSecretRef holds secret references for AWS credentials both AccessKeyID and SecretAccessKey must be defined in order to properly authenticate.
The AccessKeyID is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
The SecretAccessKey is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
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
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Region specifies the region to operate in.
RequestParameters contains parameters that can be passed to the STS service.
SerialNumber is the identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Possible values: hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user)
TokenCode is the value provided by the MFA device, if MFA is required.
You can assume a role before making calls to the desired AWS service.
UUIDSpec controls the behavior of the uuid generator.
VaultDynamicSecretSpec defines the desired spec of VaultDynamicSecret.
Do not fail if no secrets are found. Useful for requests where no data is expected.
Used to select the correct ESO controller (think: ingress.ingressClassName) The ESO controller is instantiated with a specific controller name and filters VDS based on this property
GetParameters are query-string parameters passed to Vault on GET calls. Each key may map to multiple values, matching HTTP query-string semantics. Ignored for non-GET methods; use Parameters for write bodies.
Vault API method to use (GET/POST/other)
Parameters to pass to Vault write (for non-GET methods)
Vault path to obtain the dynamic secret from
Vault provider common spec
Auth configures how secret-manager authenticates with the Vault server.
AppRole authenticates with Vault using the App Role auth mechanism, with the role and secret stored in a Kubernetes Secret resource.
Path where the App Role authentication backend is mounted in Vault, e.g: "approle"
RoleID configured in the App Role authentication backend when setting up the authentication backend in Vault.
Reference to a key in a Secret that contains the App Role ID used to authenticate with Vault. The `key` field must be specified and denotes which entry within the Secret resource is used as the app role id.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
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.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Cert authenticates with TLS Certificates by passing client certificate, private key and ca certificate Cert authentication method
ClientCert is a certificate to authenticate using the Cert Vault authentication method
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Path where the Certificate authentication backend is mounted in Vault, e.g: "cert"
SecretRef to a key in a Secret resource containing client private key to authenticate with Vault using the Cert authentication method
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
VaultRole specifies the Vault role to use for TLS certificate authentication.
Gcp authenticates with Vault using Google Cloud Platform authentication method GCP authentication method
Location optionally defines a location/region for the secret
Path where the GCP auth method is enabled in Vault, e.g: "gcp"
Project ID of the Google Cloud Platform project
Vault Role. In Vault, a role describes an identity with a set of permissions, groups, or policies you want to attach to a user of the secrets engine.
Specify credentials in a Secret object
The SecretAccessKey is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
ServiceAccountRef to a service account for impersonation
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Specify a service account with Workload Identity
ClusterLocation is the location of the cluster If not specified, it fetches information from the metadata server
ClusterName is the name of the cluster If not specified, it fetches information from the metadata server
ClusterProjectID is the project ID of the cluster If not specified, it fetches information from the metadata server
ServiceAccountSelector is a reference to a ServiceAccount resource.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Iam authenticates with vault by passing a special AWS request signed with AWS IAM credentials AWS IAM authentication method
AWS External ID set on assumed IAM roles
Specify a service account with IRSA enabled
ServiceAccountSelector is a reference to a ServiceAccount resource.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Path where the AWS auth method is enabled in Vault, e.g: "aws"
AWS region
This is the AWS role to be assumed before talking to vault
Specify credentials in a Secret object
The AccessKeyID is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
The SecretAccessKey is used for authentication
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
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
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
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
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
Jwt authenticates with Vault by passing role and JWT token using the JWT/OIDC authentication method
Optional ServiceAccountToken specifies the Kubernetes service account for which to request a token for with the `TokenRequest` API.
Optional audiences field that will be used to request a temporary Kubernetes service account token for the service account referenced by `serviceAccountRef`. Defaults to a single audience `vault` it not specified. Deprecated: use serviceAccountRef.Audiences instead
Optional expiration time in seconds that will be used to request a temporary Kubernetes service account token for the service account referenced by `serviceAccountRef`. Deprecated: this will be removed in the future. Defaults to 10 minutes.
Service account field containing the name of a kubernetes ServiceAccount.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Path where the JWT authentication backend is mounted in Vault, e.g: "jwt"
Role is a JWT role to authenticate using the JWT/OIDC Vault authentication method
Optional SecretRef that refers to a key in a Secret resource containing JWT token to authenticate with Vault using the JWT/OIDC authentication method.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Kubernetes authenticates with Vault by passing the ServiceAccount token stored in the named Secret resource to the Vault server.
Path where the Kubernetes authentication backend is mounted in Vault, e.g: "kubernetes"
A required field containing the Vault Role to assume. A Role binds a Kubernetes ServiceAccount with a set of Vault policies.
Optional secret field containing a Kubernetes ServiceAccount JWT used for authenticating with Vault. If a name is specified without a key, `token` is the default. If one is not specified, the one bound to the controller will be used.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
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.
Audience specifies the `aud` claim for the service account token Some providers automatically extend the audience field based on well-known annotations for workload identity (e.g. IRSA or GCP Workload Identity)
The name of the ServiceAccount resource being referred to.
Namespace of the resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Ldap authenticates with Vault by passing username/password pair using the LDAP authentication method
Path where the LDAP authentication backend is mounted in Vault, e.g: "ldap"
SecretRef to a key in a Secret resource containing password for the LDAP user used to authenticate with Vault using the LDAP authentication method
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Username is an LDAP username used to authenticate using the LDAP Vault authentication method
Name of the vault namespace to authenticate to. This can be different than the namespace your secret is in. Namespaces is a set of features within Vault Enterprise that allows Vault environments to support Secure Multi-tenancy. e.g: "ns1". More about namespaces can be found here https://www.vaultproject.io/docs/enterprise/namespaces This will default to Vault.Namespace field if set, or empty otherwise
TokenSecretRef authenticates with Vault by presenting a token.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
UserPass authenticates with Vault by passing username/password pair
Path where the UserPassword authentication backend is mounted in Vault, e.g: "userpass"
SecretRef to a key in a Secret resource containing password for the user used to authenticate with Vault using the UserPass authentication method
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Username is a username used to authenticate using the UserPass Vault authentication method
PEM encoded CA bundle used to validate Vault server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection.
The provider for the CA bundle to use to validate Vault server certificate.
The key where the CA certificate can be found in the Secret or ConfigMap.
The name of the object located at the provider type.
The namespace the Provider type is in. Can only be defined when used in a ClusterSecretStore.
The type of provider to use such as "Secret", or "ConfigMap".
CheckAndSet defines the Check-And-Set (CAS) settings for PushSecret operations. Only applies to Vault KV v2 stores. When enabled, write operations must include the current version of the secret to prevent unintentional overwrites.
Required when true, all write operations must include a check-and-set parameter. This helps prevent unintentional overwrites of secrets.
ForwardInconsistent tells Vault to forward read-after-write requests to the Vault leader instead of simply retrying within a loop. This can increase performance if the option is enabled serverside. https://www.vaultproject.io/docs/configuration/replication#allow_forwarding_via_header
Headers to be added in Vault request
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
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.
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
Server is the connection address for the Vault server, e.g: "https://vault.example.com:8200".
The configuration used for client side related TLS communication, when the Vault server requires mutual authentication. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. It's worth noting this configuration is different from the "TLS certificates auth method", which is available under the `auth.cert` section.
CertSecretRef is a certificate added to the transport layer when communicating with the Vault server. If no key for the Secret is specified, external-secret will default to 'tls.crt'.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
KeySecretRef to a key in a Secret resource containing client private key added to the transport layer when communicating with the Vault server. If no key for the Secret is specified, external-secret will default to 'tls.key'.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Version is the Vault KV secret engine version. This can be either "v1" or "v2". Version defaults to "v2".
Result type defines which data is returned from the generator. By default, it is the "data" section of the Vault API response. When using e.g. /auth/token/create the "data" section is empty but the "auth" section contains the generated token. Please refer to the vault docs regarding the result data structure. Additionally, accessing the raw response is possibly by using "Raw" result type.
Used to configure http retries if failed
WebhookSpec controls the behavior of the external generator. Any body parameters should be passed to the server through the parameters field.
Auth specifies a authorization protocol. Only one protocol may be set.
NTLMProtocol configures the store to use NTLM for auth
SecretKeySelector is a reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
SecretKeySelector is a reference to a specific 'key' within a Secret resource. In some instances, `key` is a required field.
A key in the referenced Secret. Some instances of this field may be defaulted, in others it may be required.
The name of the Secret resource being referred to.
The namespace of the Secret resource being referred to. Ignored if referent is not cluster-scoped, otherwise defaults to the namespace of the referent.
Body
PEM encoded CA bundle used to validate webhook server certificate. Only used if the Server URL is using HTTPS protocol. This parameter is ignored for plain HTTP protocol connection. If not set the system root certificates are used to validate the TLS connection.
The provider for the CA bundle to use to validate webhook server certificate.
The key where the CA certificate can be found in the Secret or ConfigMap.
The name of the object located at the provider type.
The namespace the Provider type is in.
The type of provider to use such as "Secret", or "ConfigMap".
Headers
Webhook Method
Result formatting
Json path of return value
Secrets to fill in templates These secrets will be passed to the templating function as key value pairs under the given name
Name of this secret in templates
Secret ref to fill in credentials
The key where the token is found.
The name of the Secret resource being referred to.
Timeout
Webhook url to call
Kind the kind of this generator.
Source: bundle.yaml
Changes to ClusterGenerator (generators.external-secrets.io/v1alpha1) in each External Secrets Operator version, compared to the version before it.
12 properties have changed the description
Released · View ClusterGenerator in v2.10.0
2 properties have been added
Released · View ClusterGenerator in v2.8.0
1 property has been added
Released · View ClusterGenerator in v2.7.0
1 property has been added
Released · View ClusterGenerator in v2.5.0
1 property has been added
Released · View ClusterGenerator in v2.4.0
1 property has been added
Released · View ClusterGenerator in v2.3.0
2 properties have changed the description
Released · View ClusterGenerator in v2.2.0
1 property has been added
Released · View ClusterGenerator in v1.1.1
1 property has been added
2 properties have changed the description
Released · View ClusterGenerator in v1.1.0
1 property has been added
25 properties have changed the description
Released · View ClusterGenerator in v0.20.4
1 property has been added
Released · View ClusterGenerator in v0.20.2
3 properties have been added
Released · View ClusterGenerator in v0.20.0
1 property has been added
Released · View ClusterGenerator in v0.19.0
1 property has been added
1 property has changed the description
Released · View ClusterGenerator in v0.18.0
1 property has been added
Released · View ClusterGenerator in v0.16.2
1 property has been added
1 property is no longer required
Released · View ClusterGenerator in v0.15.0
1 property is no longer required
Released · View ClusterGenerator in v0.14.4
3 properties have changed the description
Released · View ClusterGenerator in v0.14.3
1 property has changed the description
Released · View ClusterGenerator in v0.14.1
1 property has been added
Released · View ClusterGenerator in v0.14.0
2 properties have been added
Released · View ClusterGenerator in v0.13.0
ClusterGenerator was first seen on this version of External Secrets Operator
Released · View ClusterGenerator in v0.11.0
No examples of ClusterGenerator yet. Contribute one on GitHub.
kubespec.dev