Authentication resources · Kind catalogue · Examples
GCPAuthConfig¶
API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: gcpauthconfigs.auth.openbaoconfig.io
Categories: openbao
GCPAuthConfig manages the configuration of an OpenBao GCP auth method at auth/<mountPath>/config. Use it to set the Google credentials and alias/metadata settings that GCP iam and gce logins use. Needs the gcp auth plugin registered and enabled at auth/<mountPath>; there is one config per mount and it is never deleted.
Example:
Example:
spec:
connectionRef:
name: openbao
mountPath: gcp
credentialsSecretRef:
name: gcp-auth-sa
key: credentials.json
iamAlias: unique_idExample¶
examples/auth/gcpauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GCPAuthConfig
metadata:
name: gcp
namespace: openbao-config
spec:
connectionRef:
kind: OpenBaoConnection
name: openbao
creationPolicy: CreateOrAdopt
deletionPolicy: Orphan
driftDetection: Enabled
mountPath: gcp
credentialsSecretRef:
name: gcp-auth-credentials
key: credentials.json
iamAlias: unique_id
iamMetadata:
- project_id
- role
gceAlias: instance_id
gceMetadata:
- zone
- instance_id
customEndpoint:
api: https://www.googleapis.com
iam: https://iam.googleapis.com
crm: https://cloudresourcemanager.googleapis.com
compute: https://compute.googleapis.com
---
apiVersion: v1
kind: Secret
metadata:
name: gcp-auth-credentials
namespace: openbao-config
type: Opaque
stringData:
credentials.json: '{"type":"service_account","project_id":"fake-project","private_key":"fake-not-real"}'
On GitHub: gcpauthconfig.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 the GCP auth method configuration, written to auth/<mountPath>/config. deletionPolicy must be Orphan because the config has no delete operation. | 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.__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.credentialsSecretRef | object | no | Secret key holding the JSON key file of the Google service account OpenBao uses to verify logins. Read from this Secret key; the value is never stored in status, is write-only in OpenBao and is tracked by a hash, so a change of the Secret is written again. Unset makes OpenBao use the application default credentials of its environment. Maps to `credentials`. Example: {name: gcp-auth-sa, key: credentials.json} | ||
spec.credentialsSecretRef.key | string | yes | Key in the Secret's data whose value is used. Example: password | Constraintslength: >=1, <=253 | |
spec.credentialsSecretRef.name | string | yes | Name of the Kubernetes Secret, in the same namespace as this resource. Example: openbao-credentials | Constraintslength: >=1, <=253 | |
spec.customEndpoint | object | no | Overrides for the Google API endpoints OpenBao calls, for example for Private Google Access. Unset uses the public endpoints. Maps to `custom_endpoint`. Example: {api: "https://www.googleapis.com", iam: "https://iam.googleapis.com"} | ||
spec.customEndpoint.api | string | no | Replacement for the Google API endpoint https://www.googleapis.com. Maps to `custom_endpoint.api`. Example: https://private.googleapis.com | Constraintslength: <=2048 | |
spec.customEndpoint.compute | string | no | Replacement for the Compute Engine endpoint https://compute.googleapis.com. Maps to `custom_endpoint.compute`. Example: https://compute-private.example.com:443 | Constraintslength: <=2048 | |
spec.customEndpoint.crm | string | no | Replacement for the Cloud Resource Manager endpoint https://cloudresourcemanager.googleapis.com. Maps to `custom_endpoint.crm`. Example: https://crm-private.example.com:443 | Constraintslength: <=2048 | |
spec.customEndpoint.iam | string | no | Replacement for the IAM endpoint https://iam.googleapis.com. Maps to `custom_endpoint.iam`. Example: https://iam-private.example.com:443 | Constraintslength: <=2048 | |
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.gceAlias | string | no | Value used as the entity alias name of gce logins: role_id (the role's unique ID) or instance_id (the instance's unique ID). OpenBao defaults to role_id. Maps to `gce_alias`. Example: instance_id | Constraintsone of:role_id, instance_id | |
spec.gceMetadata | []string | no | Instance metadata fields added to tokens and audit logs from gce logins, listed explicitly (the value default is rejected because OpenBao reads it back expanded). Unset keeps the server's value, which starts as the plugin's default set. Maps to `gce_metadata`. Example: [instance_name, project_id, zone] | Constraintsitems: <=64list type: set CEL: !self.exists(m, m == 'default') (list the metadata fields explicitly instead of default, which OpenBao reads back as the expanded list)each item: length: >=1, <=512 | |
spec.iamAlias | string | no | Value used as the entity alias name of iam logins: role_id (the role's unique ID) or unique_id (the service account's unique ID). OpenBao defaults to role_id. Maps to `iam_alias`. Example: unique_id | Constraintsone of:role_id, unique_id | |
spec.iamMetadata | []string | no | Metadata fields added to tokens and audit logs from iam logins, listed explicitly (the value default is rejected because OpenBao reads it back expanded). Unset keeps the server's value, which starts as the plugin's default set. Maps to `iam_metadata`. Example: [project_id, role, service_account_email] | Constraintsitems: <=64list type: set CEL: !self.exists(m, m == 'default') (list the metadata fields explicitly instead of default, which OpenBao reads back as the expanded list)each item: length: >=1, <=512 | |
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 | "gcp" | Path of the GCP auth method, without the auth/ prefix. Defaults to gcp. Immutable. Example: gcp/prod | 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 | |
status | object | no | Observed state of the GCP auth method 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. |