Skip to content

secrets.openbaoconfig.io

AWSSecretsConfig, AWSSecretsRole, AzureSecretsConfig, AzureSecretsRole, ConsulSecretsConfig, ConsulSecretsRole, DatabaseConnection, DatabaseRole, DatabaseStaticRole, GCPImpersonatedAccount, GCPRoleset, GCPSecretsConfig, GCPStaticAccount, GitHubSecretsConfig, GitHubSecretsRole, KVConfig, KVSecret, KVSecretMetadata, KubernetesSecretsConfig, KubernetesSecretsRole, LDAPSecretsConfig, LDAPSecretsDynamicRole, LDAPSecretsStaticRole, MongoDBAtlasSecretsConfig, MongoDBAtlasSecretsRole, NomadSecretsConfig, NomadSecretsRole, PKIACMEConfig, PKIAutoTidy, PKICELRole, PKIConfig, PKIIssuer, PKIKey, PKIKeyConfig, PKIRole, QuaySecretsConfig, QuaySecretsRole, QuaySecretsStaticRole, RabbitMQConfig, RabbitMQRole, RandomSecret, SSHCA, SSHRole, TOTPKey, TerraformCloudSecretsConfig, TerraformCloudSecretsRole, TransitCacheConfig, TransitKey, TransitKeyConfig

Choose a kind for its complete field reference, validation rules and tested example manifests.

AWSSecretsConfig

AWSSecretsConfig sets the root credentials (<mount>/config/root) and lease settings (<mount>/config/lease) of an AWS secrets engine, an external plugin that must be registered.

AWSSecretsConfig fields and YAML example · Example gallery

AWSSecretsRole

AWSSecretsRole manages a role of an AWS secrets engine (external plugin) at <mount>/roles/<name>: the kind of AWS credential issued from <mount>/creds/<name> and the IAM policies it carries.

AWSSecretsRole fields and YAML example · Example gallery

AzureSecretsConfig

AzureSecretsConfig sets the configuration of an Azure secrets engine (external plugin) at <mount>/config: the subscription, tenant and the application credentials OpenBao uses to create service principals.

AzureSecretsConfig fields and YAML example · Example gallery

AzureSecretsRole

AzureSecretsRole manages a role of an Azure secrets engine (external plugin) at <mount>/roles/<name>: the role assignments and groups of the service principals issued from <mount>/creds/<name>, or an existing application to add credentials to.

AzureSecretsRole fields and YAML example · Example gallery

ConsulSecretsConfig

ConsulSecretsConfig sets the access configuration of a Consul secrets engine (external plugin) at <mount>/config/access: the Consul address and the management token OpenBao uses to create ACL tokens.

ConsulSecretsConfig fields and YAML example · Example gallery

ConsulSecretsRole

ConsulSecretsRole manages a role of a Consul secrets engine (external plugin) at <mount>/roles/<name>: the policies, roles and identities of the Consul ACL tokens issued from <mount>/creds/<name>.

ConsulSecretsRole fields and YAML example · Example gallery

DatabaseConnection

DatabaseConnection manages a connection of a database secrets engine at <mount>/config/<name>: the plugin, the root credentials (from a Secret) and the roles allowed to use it.

DatabaseConnection fields and YAML example · Example gallery

DatabaseRole

DatabaseRole manages a dynamic role of a database secrets engine at <mount>/roles/<name>: OpenBao creates a short-lived database user per request (<mount>/creds/<name>) with the creation statements.

DatabaseRole fields and YAML example · Example gallery

DatabaseStaticRole

DatabaseStaticRole manages a static role of a database secrets engine at <mount>/static-roles/<name>: OpenBao owns and rotates the password of an existing database user, served at <mount>/static-creds/<name>.

DatabaseStaticRole fields and YAML example · Example gallery

GCPImpersonatedAccount

GCPImpersonatedAccount manages an impersonated account of a GCP secrets engine (external plugin) at <mount>/impersonated-account/<name>: OpenBao issues access tokens by impersonating an existing service account, without keys.

GCPImpersonatedAccount fields and YAML example · Example gallery

GCPRoleset

GCPRoleset manages a roleset of a GCP secrets engine (external plugin) at <mount>/roleset/<name>: OpenBao creates a service account with the given IAM bindings and issues access tokens or keys for it.

GCPRoleset fields and YAML example · Example gallery

GCPSecretsConfig

GCPSecretsConfig sets the configuration of a GCP secrets engine (external plugin) at <mount>/config: the service account credentials OpenBao uses and the lease limits.

GCPSecretsConfig fields and YAML example · Example gallery

GCPStaticAccount

GCPStaticAccount manages a static account of a GCP secrets engine (external plugin) at <mount>/static-account/<name>, which issues access tokens or keys for an existing service account instead of creating one.

GCPStaticAccount fields and YAML example · Example gallery

GitHubSecretsConfig

GitHubSecretsConfig sets the GitHub App of a GitHub secrets plugin mount (external plugin) at <mount>/config.

GitHubSecretsConfig fields and YAML example · Example gallery

GitHubSecretsRole

GitHubSecretsRole manages a permission set of a GitHub secrets plugin mount (external plugin) at <mount>/permissionset/<name>: the repositories and permissions of the installation tokens issued from <mount>/token/<name>.

GitHubSecretsRole fields and YAML example · Example gallery

KVConfig

KVConfig sets the engine-wide configuration of a KV version 2 secrets engine at <mount>/config: version retention and check-and-set enforcement.

KVConfig fields and YAML example · Example gallery

KVSecret

KVSecret writes a secret to a KV secrets engine at <mount>/data/<path> (version 2) or <mount>/<path> (version 1), with values read from Kubernetes Secrets.

KVSecret fields and YAML example · Example gallery

KVSecretMetadata

KVSecretMetadata sets the per-secret metadata of one KV version 2 secret at <mount>/metadata/<path>: version retention, check-and-set and custom metadata.

KVSecretMetadata fields and YAML example · Example gallery

KubernetesSecretsConfig

KubernetesSecretsConfig sets the configuration of a Kubernetes secrets engine at <mount>/config: the cluster in which OpenBao creates service accounts, tokens and role bindings for KubernetesSecretsRole credentials.

KubernetesSecretsConfig fields and YAML example · Example gallery

KubernetesSecretsRole

KubernetesSecretsRole manages a role of a Kubernetes secrets engine at <mount>/roles/<name>, from which OpenBao issues short-lived Kubernetes service account tokens (<mount>/creds/<name>).

KubernetesSecretsRole fields and YAML example · Example gallery

LDAPSecretsConfig

LDAPSecretsConfig sets the directory connection of an LDAP secrets plugin mount (external plugin) at <mount>/config: where the directory is and the account OpenBao binds as to manage passwords.

LDAPSecretsConfig fields and YAML example · Example gallery

LDAPSecretsDynamicRole

LDAPSecretsDynamicRole manages a dynamic role of an LDAP secrets plugin mount (external plugin) at <mount>/role/<name>: each request to <mount>/creds/<name> creates a short-lived directory account from LDIF templates.

LDAPSecretsDynamicRole fields and YAML example · Example gallery

LDAPSecretsStaticRole

LDAPSecretsStaticRole manages a static role of an LDAP secrets plugin mount (external plugin) at <mount>/static-role/<name>: OpenBao owns and rotates the password of an existing directory account, served at <mount>/static-cred/<name>.

LDAPSecretsStaticRole fields and YAML example · Example gallery

MongoDBAtlasSecretsConfig

MongoDBAtlasSecretsConfig sets the programmatic API key of a MongoDB Atlas secrets plugin mount (external plugin) at <mount>/config, which OpenBao uses to create short-lived Atlas API keys.

MongoDBAtlasSecretsConfig fields and YAML example · Example gallery

MongoDBAtlasSecretsRole

MongoDBAtlasSecretsRole manages a role of a MongoDB Atlas secrets plugin mount (external plugin) at <mount>/roles/<name>: the Atlas roles and access list of the programmatic API keys issued from <mount>/creds/<name>.

MongoDBAtlasSecretsRole fields and YAML example · Example gallery

NomadSecretsConfig

NomadSecretsConfig sets the cluster connection (<mount>/config/access) and lease limits (<mount>/config/lease) of a Nomad secrets plugin mount (external plugin), which issues Nomad ACL tokens.

NomadSecretsConfig fields and YAML example · Example gallery

NomadSecretsRole

NomadSecretsRole manages a role of a Nomad secrets plugin mount (external plugin) at <mount>/role/<name>: the type and policies of the Nomad ACL tokens issued from <mount>/creds/<name>.

NomadSecretsRole fields and YAML example · Example gallery

PKIACMEConfig

PKIACMEConfig sets the ACME server configuration of a PKI secrets engine at <mount>/config/acme, so ACME clients such as cert-manager or certbot can request certificates.

PKIACMEConfig fields and YAML example · Example gallery

PKIAutoTidy

PKIAutoTidy sets the periodic tidy configuration of a PKI secrets engine at <mount>/config/auto-tidy, which removes expired certificates, issuers and ACME data on a schedule.

PKIAutoTidy fields and YAML example · Example gallery

PKICELRole

PKICELRole manages a CEL-backed PKI role at <mountPath>/cel/roles/<name>.

PKICELRole fields and YAML example · Example gallery

PKIConfig

PKIConfig sets the mount-wide configuration of a PKI secrets engine: AIA URLs (config/urls), CRL (config/crl), cluster address (config/cluster) and default issuer (config/issuers).

PKIConfig fields and YAML example · Example gallery

PKIIssuer

PKIIssuer manages a root or intermediate CA issuer of a PKI secrets engine at <mount>/issuer/<name>.

PKIIssuer fields and YAML example · Example gallery

PKIKey

PKIKey manages a private key of a PKI secrets engine at <mount>/key/<name>, generated in OpenBao, backed by an external key, or imported from a Secret.

PKIKey fields and YAML example · Example gallery

PKIKeyConfig

PKIKeyConfig sets the default signing key of a PKI secrets engine at <mountPath>/config/keys.

PKIKeyConfig fields and YAML example · Example gallery

PKIRole

PKIRole manages a certificate role of a PKI secrets engine at <mount>/roles/<name>: which names, key types, lifetimes and usages certificates issued or signed through it (<mount>/issue/<name>, <mount>/sign/<name>) may have.

PKIRole fields and YAML example · Example gallery

QuaySecretsConfig

QuaySecretsConfig sets the Quay instance of a Quay secrets plugin mount (external plugin) at <mount>/config, in which OpenBao creates robot accounts.

QuaySecretsConfig fields and YAML example · Example gallery

QuaySecretsRole

QuaySecretsRole manages a role of a Quay secrets plugin mount (external plugin) at <mount>/roles/<name>: each request to <mount>/creds/<name> creates a short-lived robot account with the listed permissions.

QuaySecretsRole fields and YAML example · Example gallery

QuaySecretsStaticRole

QuaySecretsStaticRole manages a static role of a Quay secrets plugin mount (external plugin) at <mount>/static-roles/<name>: one long-lived robot account whose token is served at <mount>/static-creds/<name>.

QuaySecretsStaticRole fields and YAML example · Example gallery

RabbitMQConfig

RabbitMQConfig sets the connection (<mount>/config/connection) and lease settings (<mount>/config/lease) of a RabbitMQ secrets engine, which issues dynamic RabbitMQ users.

RabbitMQConfig fields and YAML example · Example gallery

RabbitMQRole

RabbitMQRole manages a role of a RabbitMQ secrets engine at <mount>/roles/<name>: the tags and virtual host permissions of the dynamic users issued from <mount>/creds/<name>.

RabbitMQRole fields and YAML example · Example gallery

RandomSecret

RandomSecret generates a value, such as a password, once and stores it under one key of a KV secret (<mount>/data/<path> on version 2).

RandomSecret fields and YAML example · Example gallery

SSHCA

SSHCA configures the default signing CA of an SSH secrets engine at <mount>/config/ca, generated by OpenBao or imported from a Secret.

SSHCA fields and YAML example · Example gallery

SSHRole

SSHRole manages a role of an SSH secrets engine at <mount>/roles/<name>: a ca role signs SSH user or host certificates with the SSHCA, an otp role issues one-time SSH passwords.

SSHRole fields and YAML example · Example gallery

TOTPKey

TOTPKey manages a key of a TOTP secrets engine at <mount>/keys/<name>, either generated by OpenBao or imported from a Secret.

TOTPKey fields and YAML example · Example gallery

TerraformCloudSecretsConfig

TerraformCloudSecretsConfig sets the instance and API token of a Terraform Cloud secrets plugin mount (external plugin) at <mount>/config, which issues HCP Terraform or Terraform Enterprise API tokens.

TerraformCloudSecretsConfig fields and YAML example · Example gallery

TerraformCloudSecretsRole

TerraformCloudSecretsRole manages a role of a Terraform Cloud secrets plugin mount (external plugin) at <mount>/role/<name>: which organization, team or user API tokens are issued from <mount>/creds/<name>.

TerraformCloudSecretsRole fields and YAML example · Example gallery

TransitCacheConfig

TransitCacheConfig sets the encryption-cache configuration of a Transit secrets engine at <mount>/cache-config.

TransitCacheConfig fields and YAML example · Example gallery

TransitKey

TransitKey manages a named key of a transit secrets engine at <mount>/keys/<name>, for encryption as a service, signing or HMAC; its key material never leaves OpenBao unless exportable.

TransitKey fields and YAML example · Example gallery

TransitKeyConfig

TransitKeyConfig sets the mount-wide key configuration of a Transit secrets engine at <mount>/config/keys.

TransitKeyConfig fields and YAML example · Example gallery