IAM Group#

Creates a group in your organisation's identity provider and manages its membership.

API Details#

Field	Value
API Group	`iam.cloud.stakater.com`
Version	`v1`
Kind	`Group`
Scope	Namespace-scoped

Spec Parameters#

All parameters are nested under spec.parameters.

Required#

Field	Type	Description
`name`	`string`	Name of the organisation group

Optional#

Field	Type	Description
`path`	`string`	Path for the group in the organisation group hierarchy (e.g., `/teams/engineering`)
`members`	`string[]`	List of usernames to add to the group
`attributes`	`object`	Additional key/value attributes to set on the group. Each value is a `string[]`.

Status Fields#

Field	Type	Description
`status.group.id`	`string`	Group ID (uuid) assigned by the IdP
`status.group.name`	`string`	Confirmed group name
`status.group.path`	`string`	Confirmed group path
`status.group.created`	`boolean`	Whether the group was successfully created
`status.group.ready`	`boolean`	Whether the group is ready and accessible
`status.memberships.members`	`string[]`	List of members currently in the group
`status.memberships.ready`	`boolean`	Whether memberships are synchronised
`status.conditions`	`array`	Standard Kubernetes conditions

Examples#

Minimal#

apiVersion: iam.cloud.stakater.com/v1
kind: Group
metadata:
  name: engineering-team
spec:
  parameters:
    name: engineering-team

With Path and Members#

apiVersion: iam.cloud.stakater.com/v1
kind: Group
metadata:
  name: engineering-team
spec:
  parameters:
    name: engineering-team
    path: /teams/engineering
    members:
      - alice
      - bob
      - charlie

With Attributes#

apiVersion: iam.cloud.stakater.com/v1
kind: Group
metadata:
  name: platform-team
spec:
  parameters:
    name: platform-team
    path: /teams/platform
    attributes:
      department:
        - engineering
      costCentre:
        - cc-1234

How-to Guide#

Create an IAM Group