Secrets engine resources · Kind catalogue · Examples
AzureSecretsRole¶
API version: secrets.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: azuresecretsroles.secrets.openbaoconfig.io
Categories: openbao
AzureSecretsRole manages a role of an Azure secrets engine (external plugin) at `<mount>/roles/<name>`: the role assignments and groups of the service principals issued from `<mount>/creds/<name>`, or an existing application to add credentials to.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: azure
name: billing-reader
azureRoles:
- roleName: Reader
scope: /subscriptions/11111111-2222-3333-4444-555555555555Example¶
examples/secrets/azuresecretsrole.yaml
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AzureSecretsRole
metadata:
name: obco-azure-reader
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Delete
driftDetection: Enabled
mountPath: azure
name: reader
azureRoles:
- roleName: Reader
scope: /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/openbao-config
- roleID: /subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Authorization/roleDefinitions/acdd72a7-3385-48ef-bd42-f606fba81ae7
scope: /subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/obco-shared
azureGroups:
- groupName: obco-readers
- groupName: obco-auditors
objectID: 22222222-2222-2222-2222-222222222222
persistApp: false
ttl: 1h
maxTTL: 24h
explicitMaxTTL: 720h
permanentlyDelete: true
signInAudience: AzureADMyOrg
tags:
- team:platform
- env:sandbox
---
apiVersion: secrets.openbaoconfig.io/v1alpha1
kind: AzureSecretsRole
metadata:
name: obco-azure-existing-app
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
mountPath: azure
name: existing-app
applicationObjectID: 33333333-3333-3333-3333-333333333333
ttl: 1h
maxTTL: 8h
On GitHub: azuresecretsrole.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 an Azure secrets engine at `<mountPath>/roles/<name>`. Set azureRoles, azureGroups or applicationObjectID. | 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.azureRoles) || has(self.azureGroups) || has(self.applicationObjectID) (set azureRoles, azureGroups or applicationObjectID)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.applicationObjectID | string | no | applicationObjectID is the object ID of an existing application (`application_object_id`); credentials are then added to it instead of creating dynamic service principals. Example: `aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee`. | Constraintslength: <=64 | |
spec.azureGroups | []object | no | azureGroups are the Microsoft Entra groups the dynamic service principals join (`azure_groups`, written as JSON). Example: `[{groupName: billing-readers}]`. | Constraintsitems: <=32 | |
spec.azureGroups[] | object | no | A Microsoft Entra group the generated service principal joins. | ||
spec.azureGroups[].groupName | string | yes | groupName is the display name of the group (`group_name`). Example: `billing-readers`. | Constraintslength: >=1, <=256 | |
spec.azureGroups[].objectID | string | no | objectID is the object ID of the group (`object_id`); OpenBao looks it up from groupName when empty. Example: `aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee`. | Constraintslength: <=64 | |
spec.azureRoles | []object | no | azureRoles are the Azure role assignments of the dynamic service principals (`azure_roles`, written as JSON). Example: `[{roleName: Reader, scope: /subscriptions/<id>}]`. | Constraintsitems: <=32 | |
spec.azureRoles[] | object | no | An Azure role assigned at a scope to the generated service principal. Set roleName or roleID. | ConstraintsCEL:has(self.roleName) || has(self.roleID) (set roleName or roleID) | |
spec.azureRoles[].roleID | string | no | roleID is the full ID of the Azure role definition (`role_id`), under `/subscriptions/<id>/providers/Microsoft.Authorization/roleDefinitions/`. Example: `/subscriptions/<id>/providers/.../roleDefinitions/<guid>`. | Constraintslength: <=512 | |
spec.azureRoles[].roleName | string | no | roleName is the name of the Azure role (`role_name`). Example: `Reader`. | Constraintslength: <=256 | |
spec.azureRoles[].scope | string | yes | scope is the Azure scope of the assignment (`scope`). Example: `/subscriptions/<id>/resourceGroups/billing`. | Constraintslength: >=1, <=1024 | |
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.explicitMaxTTL | string | no | explicitMaxTTL is the hard limit on the lifetime of generated credentials and dynamic service principals (`explicit_max_ttl`), a duration; a lease is not renewed past it. Example: `720h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
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 generated credentials (`max_ttl`), a duration. 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 | "azure" | mountPath is the path of the Azure secrets engine mount. Defaults to `azure`. Immutable. Example: `azure`. | Constraintspattern:^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$length: >=1, <=128 |
spec.name | string | no | name is the role name in OpenBao. Defaults to metadata.name. Immutable. Example: `billing-reader`. | Constraintspattern:^[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.permanentlyDelete | boolean | no | permanentlyDelete deletes generated applications and service principals permanently when their lease ends (`permanently_delete`), instead of moving them to the Entra recycle bin. Defaults to false. | ||
spec.persistApp | boolean | no | persistApp keeps the generated application and service principal for the lifetime of the role (`persist_app`). Defaults to false. | ||
spec.signInAudience | string | no | signInAudience restricts which account types may sign in to the generated application (`sign_in_audience`). Allowed: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount. | Constraintsone of:AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount, PersonalMicrosoftAccount | |
spec.tags | []string | no | tags are Azure tags attached to the generated application (`tags`). Example: `[team:billing]`. | Constraintsitems: <=50list type: set each item: length: <=512 | |
spec.ttl | string | no | ttl is the default lease duration of generated credentials (`ttl`), a duration. Defaults to the mount's default lease TTL. Example: `1h`. | Constraintspattern:^(0|([0-9]+(\.[0-9]+)?(ns|us|ms|s|m|h))+)$ | |
status | object | no | status is the observed state of the Azure 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. |