Skip to content

Secrets engine resources · Kind catalogue · Examples

AWSSecretsRole

API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: awssecretsroles.secrets.openbaoconfig.io
Categories: openbao

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.

Example:

spec:
  connectionRef:
    name: openbao
  mountPath: aws
  name: s3-reader
  credentialType: assumed_role
  roleARNs: [arn:aws:iam::123456789012:role/s3-reader]

Example

examples/secrets/awssecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AWSSecretsRole
metadata:
  name: obco-aws-deploy
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Delete
  driftDetection: Enabled
  mountPath: aws
  name: deploy
  credentialType: assumed_role
  roleARNs:
    - arn:aws:iam::123456789012:role/obco-deploy
  policyARNs:
    - arn:aws:iam::aws:policy/ReadOnlyAccess
  policyDocument: |
    {
      "Version": "2012-10-17",
      "Statement": [
        {"Effect": "Allow", "Action": ["s3:ListBucket", "s3:GetObject"], "Resource": "arn:aws:s3:::obco-artifacts/*"}
      ]
    }
  iamGroups:
    - obco-readers
  sessionTags:
    team: platform
    env: sandbox
  externalID: openbao-config-external-id
  defaultSTSTTL: 15m
  maxSTSTTL: 1h
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AWSSecretsRole
metadata:
  name: obco-aws-ci-user
  namespace: openbao-config
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  mountPath: aws
  name: ci-user
  credentialType: iam_user
  policyARNs:
    - arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess
  iamTags:
    team: platform
    managed-by: openbao
  userPath: /obco/
  permissionsBoundaryARN: arn:aws:iam::123456789012:policy/obco-boundary
  mfaSerialNumber: arn:aws:iam::123456789012:mfa/obco-ci

On GitHub: awssecretsrole.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.

FieldTypeRequiredDefaultDescriptionValidation
specobjectyesspec is the desired role of an AWS secrets engine at `<mountPath>/roles/<name>`.
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.roleARNs) || self.credentialType == 'assumed_role' (roleARNs requires credentialType assumed_role)
CEL: (!has(self.userPath) && !has(self.permissionsBoundaryARN)) || self.credentialType == 'iam_user' (userPath and permissionsBoundaryARN require credentialType iam_user)
CEL: (!has(self.defaultSTSTTL) && !has(self.maxSTSTTL)) || self.credentialType == 'assumed_role' || self.credentialType == 'federation_token' (defaultSTSTTL and maxSTSTTL require credentialType assumed_role or federation_token)
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.connectionRefobjectyesConnection used to reach and log in to OpenBao. Immutable.
spec.connectionRef.kindstringno"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.namestringyesName of the OpenBaoConnection or ClusterOpenBaoConnection. Example: openbao
Constraintslength: >=1, <=253
spec.creationPolicystringno"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.credentialTypestringyescredentialType is the kind of credential the role issues (`credential_type`). Allowed: iam_user, assumed_role, federation_token, session_token. Required.
Constraintsone of: iam_user, assumed_role, federation_token, session_token
spec.defaultSTSTTLstringnodefaultSTSTTL is the default lifetime of STS credentials (`default_sts_ttl`), a duration; assumed_role or federation_token only. Example: `1h`.
Constraintspattern: ^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$
spec.deletionPolicystringno"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.driftDetectionstringno"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.driftIntervalstringnoHow 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: <=32
CEL: duration(self) >= duration('30s') (driftInterval must be at least 30s)
spec.externalIDstringnoexternalID is the external ID passed when assuming a role (`external_id`). Example: `openbao-prod`.
Constraintslength: <=1224
spec.iamGroups[]stringnoiamGroups lists IAM groups whose policies apply to the issued credentials (`iam_groups`). Example: `[readers]`.
Constraintsitems: <=64
list type: set
each item: length: <=128
spec.iamTagsmap[string]stringnoiamTags are tags set on generated IAM users (`iam_tags`). Up to 50. Example: `{team: billing}`.
Constraintsproperties: <=50
spec.managementPolicystringno"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.maxSTSTTLstringnomaxSTSTTL is the maximum lifetime of STS credentials (`max_sts_ttl`), a duration; assumed_role or federation_token only. Example: `12h`.
Constraintspattern: ^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$
spec.mfaSerialNumberstringnomfaSerialNumber is the ARN or serial number of the MFA device of the IAM user that requests credentials (`mfa_serial_number`). Example: `arn:aws:iam::123456789012:mfa/ci`.
Constraintslength: <=256
spec.mountPathstringno"aws"mountPath is the path of the AWS secrets engine mount. Defaults to `aws`. Immutable. Example: `aws`.
Constraintspattern: ^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$
length: >=1, <=128
spec.namestringnoname is the role name in OpenBao. Defaults to metadata.name. Immutable. Example: `s3-reader`.
Constraintspattern: ^[A-Za-z0-9_.@-]+$
length: >=1, <=128
spec.namespacestringnoOpenBao 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.permissionsBoundaryARNstringnopermissionsBoundaryARN is the permissions boundary attached to generated users (`permissions_boundary_arn`); iam_user only. Example: `arn:aws:iam::123456789012:policy/boundary`.
Constraintslength: <=2048
spec.policyARNs[]stringnopolicyARNs lists existing IAM policies attached to the issued credentials (`policy_arns`). Example: `[arn:aws:iam::aws:policy/AmazonS3ReadOnlyAccess]`.
Constraintsitems: <=64
list type: set
each item: length: <=2048
spec.policyDocumentstringnopolicyDocument is an IAM policy in JSON attached to the issued credentials (`policy_document`). Example: `{"Version": "2012-10-17", "Statement": [...]}`.
Constraintslength: <=65536
spec.roleARNs[]stringnoroleARNs lists the AWS roles that may be assumed (`role_arns`); assumed_role only. Example: `[arn:aws:iam::123456789012:role/s3-reader]`.
Constraintsitems: <=64
list type: set
each item: length: <=2048
spec.sessionTagsmap[string]stringnosessionTags are session tags set on assumed-role credentials (`session_tags`). Up to 50. Example: `{project: orders}`.
Constraintsproperties: <=50
spec.userPathstringnouserPath is the IAM path of generated users (`user_path`); iam_user only. Defaults to `/`. Example: `/openbao/`.
Constraintspattern: ^/(.*/)?$
length: <=512
statusobjectnostatus is the observed state of the AWS secrets role.
status.acquiredstringnoHow the operator came to own the object: Created (it created it) or Adopted (it took over an existing one). Empty until owned.
status.conditions[]objectnoCurrent 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[]objectnoCondition contains details for one aspect of the current state of this API Resource.
status.conditions[].lastTransitionTimestring (date-time)yeslastTransitionTime 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[].messagestringyesmessage is a human readable message indicating details about the transition. This may be an empty string.
Constraintslength: <=32768
status.conditions[].observedGenerationinteger (int64)noobservedGeneration 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[].reasonstringyesreason 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[].statusstringyesstatus of the condition, one of True, False, Unknown.
Constraintsone of: True, False, Unknown
status.conditions[].typestringyestype 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.idstringnoIdentifier 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.namespacestringnoAbsolute 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.observedGenerationinteger (int64)noThe metadata.generation of this resource that the operator last reconciled.
status.pathstringnoFull 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.rotationNoncestringnoValue 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.serverIDstringnoCluster 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.writeOnlyHashstringnoKeyed 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.