Authentication resources · Kind catalogue · Examples
AWSAuthRole¶
API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: awsauthroles.auth.openbaoconfig.io
Categories: openbao
AWSAuthRole manages a role of an OpenBao AWS auth method at auth/<mountPath>/role/<name>. Use it to let AWS workloads log in with signed IAM credentials (authType iam) or an EC2 instance identity document (authType ec2) and receive an OpenBao token with the listed policies. The AWS auth plugin must be enabled at mountPath (AuthMount).
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: aws
authType: iam
boundIAMPrincipalARNs: [arn:aws:iam::123456789012:role/app]
tokenPolicies: [app-read]
tokenTTL: 1hExample¶
examples/auth/awsauthrole.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthRole
metadata:
name: aws-app
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: aws
name: app
authType: iam
boundAMIIDs:
- ami-0123456789abcdef0
boundAccountIDs:
- "123456789012"
boundRegions:
- eu-central-1
boundVPCIDs:
- vpc-0123456789abcdef0
boundSubnetIDs:
- subnet-0123456789abcdef0
boundIAMRoleARNs:
- arn:aws:iam::123456789012:role/app
boundIAMInstanceProfileARNs:
- arn:aws:iam::123456789012:instance-profile/app
boundEC2InstanceIDs:
- i-0123456789abcdef0
boundIAMPrincipalARNs:
- arn:aws:iam::123456789012:role/app
inferredEntityType: ec2_instance
inferredAWSRegion: eu-central-1
resolveAWSUniqueIDs: true
tokenTTL: 1h
tokenMaxTTL: 8h
tokenExplicitMaxTTL: 24h
tokenPeriod: 30m
tokenPolicies:
- default-login
- app-read
policyRefs:
- name: obco-team-a-reader
tokenBoundCIDRs:
- 10.0.0.0/8
- 192.168.10.0/24
tokenNumUses: 0
tokenType: service
tokenNoDefaultPolicy: false
tokenStrictlyBindIP: false
---
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: AWSAuthRole
metadata:
name: aws-ec2
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: aws
name: ec2
authType: ec2
boundAMIIDs:
- ami-0123456789abcdef0
boundAccountIDs:
- "123456789012"
roleTag: VaultRole
allowInstanceMigration: false
disallowReauthentication: true
tokenPolicies:
- app-read
On GitHub: awsauthrole.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 an AWS auth role, written to auth/<mountPath>/role/<name>. The EC2 bound fields (boundAMIIDs to boundEC2InstanceIDs) need authType ec2, or authType iam with inferredEntityType; a login must match every bound list that is set. | 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.authType) ? self.authType : 'iam') == (has(oldSelf.authType) ? oldSelf.authType : 'iam') (authType is immutable)CEL: (has(self.authType) ? self.authType : 'iam') == 'ec2' || (!has(self.roleTag) && !has(self.allowInstanceMigration) && !has(self.disallowReauthentication)) (roleTag, allowInstanceMigration and disallowReauthentication apply only to authType ec2)CEL: (has(self.authType) ? self.authType : 'iam') == 'iam' || (!has(self.boundIAMPrincipalARNs) && !has(self.inferredEntityType) && !has(self.inferredAWSRegion) && !has(self.resolveAWSUniqueIDs)) (boundIAMPrincipalARNs, inferredEntityType, inferredAWSRegion and resolveAWSUniqueIDs apply only to authType iam)CEL: (has(self.authType) ? self.authType : 'iam') == 'ec2' || has(self.inferredEntityType) || (!has(self.boundAMIIDs) && !has(self.boundAccountIDs) && !has(self.boundRegions) && !has(self.boundVPCIDs) && !has(self.boundSubnetIDs) && !has(self.boundIAMRoleARNs) && !has(self.boundIAMInstanceProfileARNs) && !has(self.boundEC2InstanceIDs)) (the EC2 bound fields need authType ec2, or authType iam with inferredEntityType)CEL: has(self.inferredEntityType) == has(self.inferredAWSRegion) (set both or neither of inferredEntityType and inferredAWSRegion)CEL: (has(self.resolveAWSUniqueIDs) ? self.resolveAWSUniqueIDs : true) || !(has(oldSelf.resolveAWSUniqueIDs) ? oldSelf.resolveAWSUniqueIDs : true) (resolveAWSUniqueIDs cannot change from true to false)CEL: !has(self.tokenTTL) || !has(self.tokenMaxTTL) || duration(self.tokenTTL) <= duration(self.tokenMaxTTL) (tokenTTL must not exceed tokenMaxTTL)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.allowInstanceMigration | boolean | no | When true, an EC2 instance may log in again after it moved to a new host (its pending time changed); use with caution. Only for authType ec2. Defaults to false. Maps to `allow_instance_migration`. Example: true | ||
spec.authType | string | no | "iam" | Login method the role allows: iam (signed sts:GetCallerIdentity request) or ec2 (signed instance identity document). Defaults to iam. Immutable. Maps to `auth_type`. Example: ec2 | Constraintsone of:iam, ec2length: <=3 |
spec.boundAMIIDs | []string | no | AMI IDs the logging-in EC2 instance must be started from. Maps to `bound_ami_id`. Example: [ami-0123456789abcdef0] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
spec.boundAccountIDs | []string | no | AWS account IDs the logging-in EC2 instance must belong to. Maps to `bound_account_id`. Example: ["123456789012"] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
spec.boundEC2InstanceIDs | []string | no | EC2 instance IDs allowed to log in. Maps to `bound_ec2_instance_id`. Example: [i-0123456789abcdef0] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
spec.boundIAMInstanceProfileARNs | []string | no | Instance profile ARNs the logging-in EC2 instance must have one of; a trailing "*" matches a prefix. Maps to `bound_iam_instance_profile_arn`. Example: [arn:aws:iam::123456789012:instance-profile/app] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
spec.boundIAMPrincipalARNs | []string | no | IAM principal ARNs (users or roles) allowed to log in with authType iam; a trailing "*" matches a prefix. Maps to `bound_iam_principal_arn`. Example: [arn:aws:iam::123456789012:role/app] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
spec.boundIAMRoleARNs | []string | no | IAM role ARNs, one of which must be in the instance profile of the logging-in EC2 instance; a trailing "*" matches a prefix. Maps to `bound_iam_role_arn`. Example: [arn:aws:iam::123456789012:role/app] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
spec.boundRegions | []string | no | AWS regions the logging-in EC2 instance must run in. Maps to `bound_region`. Example: [eu-central-1] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
spec.boundSubnetIDs | []string | no | Subnet IDs the logging-in EC2 instance must run in. Maps to `bound_subnet_id`. Example: [subnet-0123456789abcdef0] | Constraintsitems: <=64list type: set each item: length: >=1, <=512 | |
spec.boundVPCIDs | []string | no | VPC IDs the logging-in EC2 instance must run in. Maps to `bound_vpc_id`. Example: [vpc-0123456789abcdef0] | 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.disallowReauthentication | boolean | no | When true, each EC2 instance can log in only once; later logins are refused. Only for authType ec2. Defaults to false. Maps to `disallow_reauthentication`. Example: true | ||
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.inferredAWSRegion | string | no | AWS region in which the inferred entity is looked up; requires inferredEntityType. Maps to `inferred_aws_region`. Example: eu-central-1 | Constraintslength: <=64 | |
spec.inferredEntityType | string | no | Makes an iam login be checked as a login of the inferred entity, so the EC2 bound fields apply; requires inferredAWSRegion and authType iam. Allowed value: ec2_instance. Maps to `inferred_entity_type`. Example: ec2_instance | Constraintsone of:ec2_instancelength: <=16 | |
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.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.name | string | no | Name of the role in OpenBao, used in the login request. Defaults to metadata.name. Immutable. Example: app | Constraintspattern:^[A-Za-z0-9_]([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.policyRefs | []object | no | Policy resources in this Kubernetes namespace whose OpenBao policy names are added to tokenPolicies. The role waits until each Policy is Ready; each Policy must use the same connectionRef and namespace as the role. Example: [{name: app-read}] | Constraintsitems: <=32list type: map (keys: name) | |
spec.policyRefs[] | object | no | Reference by name to an object in the same Kubernetes namespace as this resource. | ||
spec.policyRefs[].name | string | yes | Name of the referenced object, in the same namespace as this resource. Example: my-app | Constraintslength: >=1, <=253 | |
spec.resolveAWSUniqueIDs | boolean | no | When true, boundIAMPrincipalARNs are resolved to AWS unique IDs, so a deleted and recreated principal with the same ARN cannot log in. Only for authType iam. OpenBao defaults to true; it cannot be changed from true to false. Maps to `resolve_aws_unique_ids`. Example: false | ||
spec.roleTag | string | no | EC2 instance tag key that holds a role tag, which can further restrict the role's policies and settings; only for authType ec2. Maps to `role_tag`. Example: OpenBaoRole | Constraintslength: <=127 | |
spec.tokenBoundCIDRs | []string | no | Client CIDR blocks or IP addresses allowed to use issued tokens. Unset allows any address. Maps to `token_bound_cidrs`. Example: [10.0.0.0/8, 192.168.1.10] | Constraintsitems: <=64list type: set CEL: self.all(c, isCIDR(c) || isIP(c)) (tokenBoundCIDRs entries must be CIDR blocks or IP addresses)each item: length: <=64 | |
spec.tokenExplicitMaxTTL | string | no | Hard cap on the lifetime of issued tokens that renewals cannot extend, as a duration. Unset or 0 means no explicit cap. Maps to `token_explicit_max_ttl`. Example: 24h | ||
spec.tokenMaxTTL | string | no | Maximum lifetime of issued tokens including renewals, as a duration. Unset or 0 uses the mount or system max TTL. Maps to `token_max_ttl`. Example: 8h | ||
spec.tokenNoDefaultPolicy | boolean | no | When true, the default policy is not attached to issued tokens; only the listed policies apply. Defaults to false. Maps to `token_no_default_policy`. Example: true | ||
spec.tokenNumUses | integer (int32) | no | Maximum number of requests an issued token may make; 0 or unset means unlimited. Maps to `token_num_uses`. Example: 10 | Constraintsvalue: >=0 | |
spec.tokenPeriod | string | no | Makes issued tokens periodic: they never expire as long as they are renewed within this duration, and each renewal resets the TTL to it. Unset or 0 means not periodic. Maps to `token_period`. Example: 1h | ||
spec.tokenPolicies | []string | no | OpenBao policy names attached to issued tokens, in addition to the default policy and the policies from policyRefs. Maps to `token_policies`. Example: [app-read, app-write] | Constraintsitems: <=256list type: set each item: length: >=1, <=128 | |
spec.tokenStrictlyBindIP | boolean | no | When true, issued tokens can only be used from the IP address of the client that logged in. Built-in auth methods only: an external plugin built on an older OpenBao SDK ignores it and never returns it. Defaults to false. Maps to `token_strictly_bind_ip`. Example: true | ||
spec.tokenTTL | string | no | Initial lifetime of issued tokens, as a duration. Unset or 0 uses the mount or system default TTL; must not exceed tokenMaxTTL. Maps to `token_ttl`. Example: 1h | ||
spec.tokenType | string | no | Type of token to issue. One of default (the mount's default, normally service), service (renewable, can create child tokens) or batch (lightweight, not renewable). Maps to `token_type`. Example: service | Constraintsone of:default, service, batch | |
status | object | no | Observed state of the role, 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. |