Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update documentation for kubernetes auth method supporting patches to role configuration #17461

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

docs: update documentation for kubernetes auth method supporting patches to role configuration #17461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9241f99
docs: update documentation for kubernetes auth method supporting patc…
f4z3r Oct 7, 2022
89de271
chore: add changelog for PR
f4z3r Oct 7, 2022
5f7e441
fix: update section title to be inline with PKI secret engine title o…
f4z3r Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog/17461.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:improvement
website/docs: Added documentation for Kubernetes Auth method supporting PATCH on role configuration.
```
19 changes: 15 additions & 4 deletions website/content/api-docs/auth/kubernetes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,27 @@ $ curl \
}
```

## Create Role
## Create/Update Role

Registers a role in the auth method. Role types have specific entities
that can perform login operations against this endpoint. Constraints specific
to the role type must be set on the role. These are applied to the authenticated
entities attempting to login.

| Method | Path |
| :----- | :---------------------------- |
| `POST` | `/auth/kubernetes/role/:name` |
| Method | Path |
| :------ | :---------------------------- |
| `POST` | `/auth/kubernetes/role/:name` |
| `PATCH` | `/auth/kubernetes/role/:name` |


~> **Note** `POST`ing to this endpoint when the role already exists causes
Vault to overwrite the contents of the role, using the provided request
data (and any defaults for elided parameters). It does not update only
the provided fields.<br /><br />
Since Vault 1.11.0, Vault supports the PATCH operation to this endpoint,
using the [JSON patch format](https://datatracker.ietf.org/doc/html/rfc6902)
supported by KVv2, allowing update of specific fields. Note that
`vault write` uses `POST`.

### Parameters

Expand Down