Authentication resources · Kind catalogue · Examples
AWSAuthConfig¶
API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: awsauthconfigs.auth.openbaoconfig.io
Categories: openbao
AWSAuthConfig manages the AWS client configuration of an OpenBao AWS auth method at auth/<mountPath>/config/client. Use it to give OpenBao the credentials and endpoints it uses to verify iam and ec2 logins; without credentials OpenBao uses its environment (instance profile, IRSA). The AWS auth plugin must be enabled at mountPath (AuthMount). Deleting it leaves the settings in OpenBao.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: aws
accessKeySecretRef: {name: aws-auth, key: access-key}
secretKeySecretRef: {name: aws-auth, key: secret-key}
iamServerIDHeaderValue: openbao.example.comExample¶
examples/auth/awsauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthConfig
metadata:
name: aws-client
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: aws
accessKeySecretRef:
name: aws-auth-credentials
key: access-key
secretKeySecretRef:
name: aws-auth-credentials
key: secret-key
ec2Endpoint: https://ec2.eu-central-1.amazonaws.com
iamEndpoint: https://iam.amazonaws.com
stsEndpoint: https://sts.eu-central-1.amazonaws.com
stsRegion: eu-central-1
useSTSRegionFromClient: false
iamServerIDHeaderValue: openbao.example.com
allowedSTSHeaderValues:
- X-Example-Trace
maxRetries: 5
---
apiVersion: v1
kind: Secret
metadata:
name: aws-auth-credentials
namespace: openbao-config
type: Opaque
stringData:
access-key: AKIAFAKEFAKEFAKEFAKE
secret-key: fake-secret-key-not-real
On GitHub: awsauthconfig.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 AWS client configuration of an AWS auth method, written to auth/<mountPath>/config/client. Set both or neither of accessKeySecretRef and secretKeySecretRef; deletionPolicy must be Orphan. | ConstraintsCEL:has(self.mountPath) == has(oldSelf.mountPath) && (!has(self.mountPath) || self.mountPath == oldSelf.mountPath) (mountPath is immutable)CEL: !has(self.deletionPolicy) || self.deletionPolicy == 'Orphan' (deletionPolicy must be Orphan: an auth method config has no delete operation)CEL: has(self.accessKeySecretRef) == has(self.secretKeySecretRef) (set both or neither of accessKeySecretRef and secretKeySecretRef)CEL: !has(self.stsRegion) || has(self.stsEndpoint) (stsRegion requires stsEndpoint)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.accessKeySecretRef | object | no | Secret key holding the AWS access key ID OpenBao uses to call AWS APIs. Read from this Secret key; the value is never stored in status. Requires secretKeySecretRef. Unset makes OpenBao use the credentials of its environment, such as an instance profile. Maps to `access_key`. Example: {name: aws-auth, key: access-key} | ||
spec.accessKeySecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.accessKeySecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.allowedSTSHeaderValues | []string | no | Extra header names allowed in the signed STS request of an iam login. Maps to `allowed_sts_header_values`. Example: [X-Custom-Header] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
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.ec2Endpoint | string | no | URL that overrides the endpoint used for EC2 API calls, for example a VPC endpoint. Maps to `endpoint`. Example: https://ec2.eu-central-1.amazonaws.com | Constraintslength: <=2048 | |
spec.iamEndpoint | string | no | URL that overrides the endpoint used for IAM API calls. Maps to `iam_endpoint`. Example: https://iam.amazonaws.com | Constraintslength: <=2048 | |
spec.iamServerIDHeaderValue | string | no | Value that iam logins must sign in the X-Vault-AWS-IAM-Server-ID header, which stops a signed login request from being replayed against another server. Unset disables the check. Maps to `iam_server_id_header_value`. Example: openbao.example.com | Constraintslength: <=1024 | |
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.maxRetries | integer (int32) | no | Number of retries for recoverable AWS API errors; -1 uses the AWS SDK default. OpenBao defaults to -1. Maps to `max_retries`. Example: 5 | Constraintsvalue: >=-1 | |
spec.mountPath | string | no | "aws" | Path of the AWS auth method, without the auth/ prefix. Defaults to aws. Immutable. Example: aws | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: <=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.secretKeySecretRef | object | no | Secret key holding the AWS secret access key that belongs to the access key. Read from this Secret key; the value is never stored in status. Write-only: OpenBao never returns it, so only a hash of it is tracked and a change of the Secret triggers a rewrite. Maps to `secret_key`. Example: {name: aws-auth, key: secret-key} | ||
spec.secretKeySecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.secretKeySecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.stsEndpoint | string | no | URL that overrides the endpoint used for STS API calls, such as a regional STS endpoint. Maps to `sts_endpoint`. Example: https://sts.eu-central-1.amazonaws.com | Constraintslength: <=2048 | |
spec.stsRegion | string | no | AWS region used to sign STS API calls to stsEndpoint; requires stsEndpoint. Maps to `sts_region`. Example: eu-central-1 | Constraintslength: <=64 | |
spec.useSTSRegionFromClient | boolean | no | When true, STS calls use the region from the client's signed login request instead of stsRegion. Defaults to false. Maps to `use_sts_region_from_client`. Example: true | ||
status | object | no | Observed state of the client configuration, written by the operator. | ||
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. |