System resources · Kind catalogue · Examples
Plugin¶
API version: sys.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: plugins.sys.openbaoconfig.io
Categories: openbao
Plugin registers an external plugin in the OpenBao plugin catalog at sys/plugins/catalog/<type>/<name>, so mounts can use it. The binary must already be in the server's plugin_directory (or be an OCI plugin). Root namespace only. deletionPolicy defaults to Orphan, because deregistering breaks the mounts that use the plugin; Delete deregisters an unversioned plugin.
Example:
Example:
spec:
connectionRef:
name: openbao
type: secret
name: openbao-plugin-secrets-nomad
command: openbao-plugin-secrets-nomad
sha256: 2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae
version: v0.21.0Example¶
examples/sys/plugin.yaml
apiVersion: v1
kind: Secret
metadata:
name: obco-ldap-plugin-env
namespace: openbao-config
type: Opaque
stringData:
https-proxy: http://obco-plugin:fake-proxy-password@proxy.example.com:3128
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Plugin
metadata:
name: obco-ldap-auth-plugin
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
type: auth
name: ldap
command: openbao-plugin-auth-ldap
sha256: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
args:
- -tls-skip-verify=false
env:
- name: HTTPS_PROXY
secretKeyRef:
name: obco-ldap-plugin-env
key: https-proxy
version: v0.1.0
oci: false
---
apiVersion: sys.openbaoconfig.io/v1alpha1
kind: Plugin
metadata:
name: obco-nomad-secrets-plugin
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
driftInterval: 1h
managementPolicy: Manage
type: secret
name: nomad
command: openbao-plugin-secrets-nomad
sha256: 89abcdef0123456789abcdef0123456789abcdef0123456789abcdef01234567
oci: true
On GitHub: plugin.yaml, generated sample with every field.
Fields¶
Defaults below are CRD schema defaults. A blank cell does not imply zero, false or an empty value; see the field description for omission behaviour. Required fields inside an optional object apply only when that object is set.
| Field | Type | Required | Default | Description | Validation |
|---|---|---|---|---|---|
spec | object | yes | Desired state of the plugin catalog entry. | ConstraintsCEL:!has(self.__namespace__) || self.__namespace__ == '' (Plugin exists only in the root namespace: leave namespace empty)CEL: self.type == oldSelf.type (type is immutable)CEL: has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name is immutable)CEL: has(self.version) == has(oldSelf.version) && (!has(self.version) || self.version == oldSelf.version) (version is immutable: register a new version with a new resource)CEL: !has(self.version) || !has(self.deletionPolicy) || self.deletionPolicy == 'Orphan' (a versioned plugin cannot be deregistered by the operator: use deletionPolicy Orphan)CEL: !self.command.contains('..') (command must not contain '..')CEL: has(self.__namespace__) == has(oldSelf.__namespace__) && (!has(self.__namespace__) || self.__namespace__ == oldSelf.__namespace__) (namespace is immutable)CEL: self.connectionRef == oldSelf.connectionRef (connectionRef is immutable) | |
spec.args | []string | no | Arguments passed to the plugin binary, in order. Maps to `args`. Example: ["-tls-skip-verify=false"] | Constraintsitems: <=64list type: atomic each item: length: <=1024 | |
spec.command | string | yes | File name of the plugin binary, relative to the server's plugin_directory; must not contain "..". Pass arguments in args. Maps to `command`. Example: openbao-plugin-secrets-nomad | Constraintspattern:^[A-Za-z0-9_][A-Za-z0-9_.+-]*$length: >=1, <=256 | |
spec.connectionRef | object | yes | Connection used to reach and log in to OpenBao. Immutable. | ||
spec.connectionRef.kind | string | no | "OpenBaoConnection" | Kind of the connection: OpenBaoConnection (in the same Kubernetes namespace as this resource) or ClusterOpenBaoConnection (cluster-scoped; its allowedNamespaces must select this namespace). Default: OpenBaoConnection. | Constraintsone of:OpenBaoConnection, ClusterOpenBaoConnection |
spec.connectionRef.name | string | yes | Name of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao | Constraintslength: >=1, <=253 | |
spec.creationPolicy | string | no | "Create" | How an object that already exists in OpenBao, and is not yet owned by this resource, is treated. Create (default): create the object; an existing one is refused with reason Conflict. Adopt: take over an existing object and never create one. CreateOrAdopt: create it, or take over an existing one. Settings that always exist in OpenBao (configuration singletons) need Adopt or CreateOrAdopt. | Constraintsone of:Create, Adopt, CreateOrAdopt |
spec.deletionPolicy | string | no | "Orphan" | What happens in OpenBao when this resource is deleted. Orphan (default): the OpenBao object stays. Delete: the object is removed (a configuration singleton is reset to its defaults); data and key holders (mounts, namespaces, KV data, audit devices, endpoints, transit, PKI, SSH CA and TOTP keys, MFA methods, entities) are removed only while the resource carries the annotation openbaoconfig.io/allow-destructive-delete: "true". Kinds whose OpenBao object cannot be deleted reject Delete. | Constraintsone of:Delete, Orphan |
spec.driftDetection | string | no | "Enabled" | Whether OpenBao is re-read periodically to detect and repair out-of-band changes. Enabled (default): re-read every driftInterval. Disabled: write only when the spec or a referenced Secret changes. | Constraintsone of:Enabled, Disabled |
spec.driftInterval | string | no | How often OpenBao is re-read for drift, as a duration of at least 30s. Default: the operator's interval for the kind (15m for kinds that grant access such as policies, auth mounts and roles, 1h for the rest), with jitter. Example: 30m | Constraintslength: <=32CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s) | |
spec.env | []object | no | Environment variables of the plugin process, each read from a Secret key and sent as NAME=value in `env`. OpenBao never returns them, so a changed Secret is detected by its hash (status.writeOnlyHash) and written again; the values are never stored in status. | Constraintsitems: <=64list type: map (keys: name) | |
spec.env[] | object | no | An environment variable of the plugin process whose value is read from a Secret key. | ||
spec.env[].name | string | yes | Name of the environment variable, sent as NAME=value in `env`. Example: PLUGIN_LOG_LEVEL | Constraintspattern:^[A-Za-z_][A-Za-z0-9_]*$length: >=1, <=128 | |
spec.env[].secretKeyRef | object | yes | Secret key, in the same namespace as this resource, that holds the variable's value. Read from a Secret key; never stored in status. | ||
spec.env[].secretKeyRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.env[].secretKeyRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.managementPolicy | string | no | "Manage" | Whether the operator writes to OpenBao. Manage (default): converge OpenBao to the spec, create and delete as the policies say. Observe: only read the object and report drift in the conditions; never write or delete. | Constraintsone of:Manage, Observe |
spec.name | string | no | Name of the plugin in the catalog, the <name> in sys/plugins/catalog/<type>/<name>; mounts use it as their type. Default: metadata.name. Immutable. Example: openbao-plugin-secrets-nomad | Constraintspattern:^[A-Za-z0-9_][A-Za-z0-9_.+-]*$length: >=1, <=128 | |
spec.namespace | string | no | OpenBao namespace of the object, relative to the connection's base namespace; empty means the connection namespace itself. Segments are separated by "/", without leading or trailing slash. Immutable: it cannot be added, changed or removed after creation. Example: team-a/apps | Constraintspattern:^[A-Za-z0-9_-][A-Za-z0-9._-]*(/[A-Za-z0-9_-][A-Za-z0-9._-]*)*$length: <=256 | |
spec.oci | boolean | no | Whether the server downloads the plugin as an OCI image (declared in the plugin stanza of the server configuration) instead of using a binary placed in plugin_directory. Maps to `oci`. Default: false. Example: true | ||
spec.sha256 | string | yes | Hex-encoded SHA-256 checksum of the plugin binary (64 lowercase hex characters). Maps to `sha256`. Example: 2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae | Constraintspattern:^[a-f0-9]{64}$ | |
spec.type | string | yes | Kind of backend the plugin implements, the <type> in sys/plugins/catalog/<type>/<name>: auth, database or secret. Immutable. Example: secret | Constraintsone of:auth, database, secret | |
spec.version | string | no | Semantic version of the plugin; a leading "v" is added if missing. Maps to `version`. A plugin binary that reports its own version must be registered with that version. Drift detection of a versioned plugin covers sha256 only, and a versioned plugin requires deletionPolicy Orphan. Immutable: register a new version with a new resource. Example: v0.21.0 | Constraintspattern:^v?[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.-]+)?(\+[0-9A-Za-z.-]+)?$length: <=128 | |
status | object | no | Observed state reported by the operator: conditions, OpenBao path, ownership and the hash of env values. | ||
status.acquired | string | no | How the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned. | ||
status.conditions | []object | no | Current state as conditions: Ready (the OpenBao object matches the spec) and Synced (the last reconcile succeeded), each with a reason such as Available, Drifted, Conflict, ConnectionNotReady or PermissionDenied, and the generation it describes. | Constraintslist type: map (keys: type) | |
status.conditions[] | object | no | Condition contains details for one aspect of the current state of this API Resource. | ||
status.conditions[].lastTransitionTime | string (date-time) | yes | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. | ||
status.conditions[].message | string | yes | message is a human readable message indicating details about the transition. This may be an empty string. | Constraintslength: <=32768 | |
status.conditions[].observedGeneration | integer (int64) | no | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. | Constraintsvalue: >=0 | |
status.conditions[].reason | string | yes | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. | Constraintspattern:^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$length: >=1, <=1024 | |
status.conditions[].status | string | yes | status of the condition, one of True, False, Unknown. | Constraintsone of:True, False, Unknown | |
status.conditions[].type | string | yes | type of condition in CamelCase or in foo.example.com/CamelCase. | Constraintspattern:^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$length: <=316 | |
status.id | string | no | Identifier OpenBao generated for the object (an entity, group or alias ID, or a mount accessor), for kinds that have one; other resources reference it. Example: 6c9f3e0a-1b2c-4d5e-8f90-123456789abc | ||
status.namespace | string | no | Absolute OpenBao namespace the object was written in; empty means the root namespace. If it later differs from the spec, reconciling stops with reason NamespaceChanged. Example: team-a/apps | ||
status.observedGeneration | integer (int64) | no | The metadata.generation of this resource that the operator last reconciled. | ||
status.path | string | no | Full OpenBao API path of the object, including its namespace, as last written; deletion uses it even after the spec changed. Example: team-a/sys/policies/acl/app-read | ||
status.rotationNonce | string | no | Value of the resource's rotation nonce when one-time inputs, such as a root credential that OpenBao rotates afterwards, were last sent; changing the nonce in the spec sends them again. | ||
status.serverID | string | no | Cluster ID of the OpenBao server the object was acquired on. If the connection later reaches another server, reconciling stops with reason ServerChanged and nothing is written or deleted. Example: 80f7de92-c12e-e960-4754-255c32fc6b53 | ||
status.writeOnlyHash | string | no | Keyed hash (HMAC-SHA256) of the write-only inputs, such as passwords read from Secrets; a change forces a write. It never contains or reveals the values. |