Skip to content

Commit

Permalink
docs(kubernetes-auth): add API documentation for kubernetes auth name…
Browse files Browse the repository at this point in the history
…space selectors (#19318)

Co-authored-by: Thy Ton <[email protected]>
  • Loading branch information
f4z3r and thyton authored Feb 1, 2024
1 parent a4c8ce6 commit 2a566f4
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions website/content/api-docs/auth/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,14 @@ entities attempting to login.
- `name` `(string: <required>)` - Name of the role.
- `bound_service_account_names` `(array: <required>)` - List of service account
names able to access this role. If set to "\*" all names are allowed.
- `bound_service_account_namespaces` `(array: <required>)` - List of namespaces
- `bound_service_account_namespaces` `(array: [])` - List of namespaces
allowed to access this role. If set to "\*" all namespaces are allowed.
- `bound_service_account_namespace_selector` `(string: "")` - A label selector for Kubernetes
namespaces allowed to acces this role. Accepts either a JSON or YAML object. The value
should be of type
[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#labelselector-v1-meta). Currently, label selectors with `matchExpressions` are not supported.
If this parameter is used, the Vault requires permissions to read namespaces on the Kubernetes
cluster. If set with `bound_service_account_namespaces`, the conditions are `OR`ed.
- `audience` `(string: "")` - Optional Audience claim to verify in the JWT.
- `alias_name_source` `(string: "serviceaccount_uid")` - Configures how identity aliases are generated.
Valid choices are: `serviceaccount_uid`, `serviceaccount_name`
Expand All @@ -144,7 +150,7 @@ entities attempting to login.

@include 'tokenfields.mdx'

### Sample payload
### Sample Payload 1

```json
{
Expand All @@ -155,7 +161,18 @@ entities attempting to login.
}
```

### Sample request
### Sample Payload 2

```json
{
"bound_service_account_names": "vault-auth",
"bound_service_account_namespace_selector": "\"{\"matchLabels\":{\"stage\":\"dev\",\"vault-role\":\"dev-role\"}}",
"policies": ["dev", "prod"],
"max_ttl": 1800000
}
```

### Sample Request

```shell-session
$ curl \
Expand Down

0 comments on commit 2a566f4

Please sign in to comment.