Skip to content

Authentication resources · Kind catalogue · Examples

GitHubAuthConfig

API version: auth.openbaoconfig.io/v1alpha1
Scope: Namespaced
Resource: githubauthconfigs.auth.openbaoconfig.io
Categories: openbao

GitHubAuthConfig manages the configuration of an OpenBao GitHub auth method at auth/<mountPath>/config. Use it to set the GitHub organization whose members log in with a personal access token, and the token settings of those logins. Needs the github auth plugin enabled at auth/<mountPath>; there is one config per mount and it is never deleted.

Example:

spec:
  connectionRef:
    name: openbao
  mountPath: github
  organization: example-org
  organizationID: 1234567
  tokenTTL: 8h

Example

examples/auth/githubauthconfig.yaml
apiVersion: auth.openbaoconfig.io/v1alpha1
kind: GitHubAuthConfig
metadata:
  name: github
spec:
  connectionRef:
    kind: OpenBaoConnection
    name: openbao
  creationPolicy: CreateOrAdopt
  deletionPolicy: Orphan
  driftDetection: Enabled
  mountPath: github
  organization: example-org
  organizationID: 1234567
  baseURL: https://github.example.org/api/v3/
  tokenTTL: 1h
  tokenMaxTTL: 4h
  tokenExplicitMaxTTL: 8h
  tokenPeriod: 30m
  tokenPolicies:
    - default-login
    - readers
  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

On GitHub: githubauthconfig.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
specobjectyesDesired state of the GitHub auth method configuration, written to auth/<mountPath>/config. deletionPolicy must be Orphan because the config endpoint cannot be deleted.
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: the config endpoint cannot be deleted)
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.baseURLstringnoAPI endpoint of a GitHub Enterprise Server; leave unset for github.com. OpenBao appends a trailing slash when it is missing. Maps to `base_url`. Example: https://github.example.com/api/v3/
Constraintslength: <=2048
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.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.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.mountPathstringno"github"Path of the GitHub auth method, without the auth/ prefix. Defaults to github. Immutable. Example: github/example-org
Constraintspattern: ^[A-Za-z0-9_.-]+(/[A-Za-z0-9_.-]+)*$
length: <=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.organizationstringyesGitHub organization whose members may log in. Required. Maps to `organization`. Example: example-org
Constraintslength: >=1, <=256
spec.organizationIDinteger (int64)noNumeric ID of the organization. Set it when OpenBao cannot reach GitHub: when unset, OpenBao looks the ID up through the GitHub API on every write. Maps to `organization_id`. Example: 1234567
Constraintsvalue: >=1
spec.policyRefs[]objectnoPolicy 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: <=32
list type: map (keys: name)
spec.policyRefs[]objectnoReference by name to an object in the same Kubernetes namespace as this resource.
spec.policyRefs[].namestringyesName of the referenced object, in the same namespace as this resource. Example: my-app
Constraintslength: >=1, <=253
spec.tokenBoundCIDRs[]stringnoClient 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: <=64
list type: set
CEL: self.all(c, isCIDR(c) || isIP(c)) (tokenBoundCIDRs entries must be CIDR blocks or IP addresses)
each item: length: <=64
spec.tokenExplicitMaxTTLstringnoHard 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.tokenMaxTTLstringnoMaximum 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.tokenNoDefaultPolicybooleannoWhen 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.tokenNumUsesinteger (int32)noMaximum number of requests an issued token may make; 0 or unset means unlimited. Maps to `token_num_uses`. Example: 10
Constraintsvalue: >=0
spec.tokenPeriodstringnoMakes 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[]stringnoOpenBao 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: <=256
list type: set
each item: length: >=1, <=128
spec.tokenStrictlyBindIPbooleannoWhen 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.tokenTTLstringnoInitial 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.tokenTypestringnoType 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
statusobjectnoObserved state of the GitHub auth method configuration, written by the operator.
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.