Secrets engine resources · Kind catalogue · Examples
TerraformCloudSecretsRole¶
API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: terraformcloudsecretsroles.secrets.openbaoconfig.io
Categories: openbao
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>`.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: terraform
name: ci-team
organization: example-org
teamID: team-AbCdEfGh12345678
ttl: 1hExample¶
examples/secrets/terraformcloudsecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: TerraformCloudSecretsRole
metadata:
name: platform-team
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: terraform
name: platform-team
organization: example-org
teamID: team-fakefakefake0001
credentialType: team
description: openbao-platform
ttl: 1h
maxTTL: 24h
On GitHub: terraformcloudsecretsrole.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 | spec is the desired role of the Terraform Cloud secrets plugin at `<mountPath>/role/<name>`. An organization token is issued when only organization is set, a team token with teamID, a user token with userID. The plugin creates a new organization or legacy team token on every write of such a role, which revokes the previous one, so every change of the spec rotates that token. | ConstraintsCEL:has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)CEL: has(self.name) == has(oldSelf.name) && (!has(self.name) || self.name == oldSelf.name) (name is immutable)CEL: has(self.credentialType) == has(oldSelf.credentialType) && (!has(self.credentialType) || self.credentialType == oldSelf.credentialType) (credentialType is immutable)CEL: !has(self.userID) || !(has(self.organization) || has(self.teamID)) (userID cannot be combined with organization or teamID)CEL: has(self.organization) || has(self.teamID) || has(self.userID) (set organization, teamID or userID)CEL: !has(self.credentialType) || self.credentialType != 'team_legacy' || !(has(self.description) || has(self.ttl) || has(self.maxTTL)) (team_legacy roles take no description, ttl or maxTTL)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.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.credentialType | string | no | credentialType selects the token type explicitly (`credential_type`). Allowed: organization, team, team_legacy, user. Unset derives it from teamID and userID. Immutable. | Constraintsone of:organization, team, team_legacy, user | |
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.description | string | no | description prefixes the name of issued team and user tokens, to identify them in the Terraform UI (`description`). Not for team_legacy. Example: `openbao-ci`. | Constraintslength: <=256 | |
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.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.maxTTL | string | no | maxTTL is the maximum lease duration of issued tokens (`max_ttl`), a duration. Not for team_legacy. Defaults to the mount's max lease TTL. Example: `24h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.mountPath | string | no | "terraform" | mountPath is the path the Terraform Cloud secrets plugin is mounted at. Defaults to `terraform`. Immutable. Example: `terraform`. | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: >=1, <=256 |
spec.name | string | no | name is the role name in OpenBao, lower case because OpenBao lowercases role names. Defaults to metadata.name. Immutable. Example: `ci-team`. | Constraintspattern:^[a-z0-9_]([a-z0-9_.-]*[a-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.organization | string | no | organization is the name of the Terraform organization (`organization`). Example: `example-org`. | Constraintslength: <=256 | |
spec.teamID | string | no | teamID is the ID of the Terraform team (`team_id`). Example: `team-AbCdEfGh12345678`. | Constraintslength: <=64 | |
spec.ttl | string | no | ttl is the default lease duration of issued tokens (`ttl`), a duration. Not for team_legacy. Defaults to the mount's default lease TTL. Example: `1h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
spec.userID | string | no | userID is the ID of the Terraform user (`user_id`); not combinable with organization or teamID. Example: `user-AbCdEfGh12345678`. | Constraintslength: <=64 | |
status | object | no | status is the observed state of the Terraform Cloud secrets role. | ||
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. |