Skip to content

docs(mesh-manager): add info on how to map to konnect SPAT or KPAT #8700

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(mesh-manager): add info on how to map to konnect SPAT or KPAT #8700

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 44 additions & 7 deletions app/konnect/mesh-manager/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,47 @@

#### Role binding

| {{site.mesh_product_name}} key | Description |
|-----------------------------|--------------|
| `type` | The resource type. For role binding, this should be `AccessRoleBinding`. |
| `name` | Name for the role that you want to display in the {{site.konnect_short_name}} UI. |
| `subjects.type` | The type of subject you want to bind the role to. This must be either `User` or `Group`. |
| `subjects.name` | When `subjects.type` is `User`, this should be the {{site.konnect_short_name}} email address associated with them. When `subjects.type` is `Group`, this should be the name of the {{site.konnect_short_name}} team you want to bind the role to. |
| `roles` | List of roles that you want to assign to the users or groups/teams. |
{% if_version gte:2.11.x %}
To obtain current user information you can use:

```bash
kumactl who-am-i
```

This will output:

```
User: {
"name": "[email protected]",
"groups": [
"organization-admin",
"team-a",
"mesh-system:authenticated"
]
}
```

for a [User Account Token](https://docs.konghq.com/konnect/org-management/access-tokens/) and

Check failure on line 113 in app/konnect/mesh-manager/index.md

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[kong.Relativeurls] Use relative URLs for docs URLs. For example, use [Get Started](/gateway/latest/get-started/) instead of [Get Started](https://docs.konghq.com/gateway/3.3.x/get-started/). If a direct URL is necessary, use {{ site.links.web }} instead of `https://docs.konghq.com`.

Raw Output:
{"message": "[kong.Relativeurls] Use relative URLs for docs URLs. For example, use [Get Started](/gateway/latest/get-started/) instead of [Get Started](https://docs.konghq.com/gateway/3.3.x/get-started/). If a direct URL is necessary, use {{ site.links.web }} instead of `https://docs.konghq.com`.", "location": {"path": "app/konnect/mesh-manager/index.md", "range": {"start": {"line": 113, "column": 7}}}, "severity": "ERROR"}

```
User: {
"name": "spat:97f08003-c893-4e42-88f1-e43088e51d1a",
"groups": [
"mesh-system:authenticated",
"team-b"
]
}
```

for a [System Account Token](https://docs.konghq.com/konnect/org-management/access-tokens/#main).

Check failure on line 125 in app/konnect/mesh-manager/index.md

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[kong.Relativeurls] Use relative URLs for docs URLs. For example, use [Get Started](/gateway/latest/get-started/) instead of [Get Started](https://docs.konghq.com/gateway/3.3.x/get-started/). If a direct URL is necessary, use {{ site.links.web }} instead of `https://docs.konghq.com`.

Raw Output:
{"message": "[kong.Relativeurls] Use relative URLs for docs URLs. For example, use [Get Started](/gateway/latest/get-started/) instead of [Get Started](https://docs.konghq.com/gateway/3.3.x/get-started/). If a direct URL is necessary, use {{ site.links.web }} instead of `https://docs.konghq.com`.", "location": {"path": "app/konnect/mesh-manager/index.md", "range": {"start": {"line": 125, "column": 7}}}, "severity": "ERROR"}

You can use that information to bind the role to a user or group/team.
{% endif_version %}

| {{site.mesh_product_name}} key | Description |
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `type` | The resource type. For role binding, this should be `AccessRoleBinding`. |
| `name` | Name for the role that you want to display in the {{site.konnect_short_name}} UI. |
| `subjects.type` | The type of subject you want to bind the role to. This must be either `User` or `Group`. |
| `subjects.name` | When `subjects.type` is `User`, this should be the {{site.konnect_short_name}} email address associated with them (or a `spat:<uuid>` when using [System Account Token](https://docs.konghq.com/konnect/org-management/access-tokens/#main)). When `subjects.type` is `Group`, this should be the name of the {{site.konnect_short_name}} team you want to bind the role to. |

Check failure on line 135 in app/konnect/mesh-manager/index.md

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[kong.Relativeurls] Use relative URLs for docs URLs. For example, use [Get Started](/gateway/latest/get-started/) instead of [Get Started](https://docs.konghq.com/gateway/3.3.x/get-started/). If a direct URL is necessary, use {{ site.links.web }} instead of `https://docs.konghq.com`.

Raw Output:
{"message": "[kong.Relativeurls] Use relative URLs for docs URLs. For example, use [Get Started](/gateway/latest/get-started/) instead of [Get Started](https://docs.konghq.com/gateway/3.3.x/get-started/). If a direct URL is necessary, use {{ site.links.web }} instead of `https://docs.konghq.com`.", "location": {"path": "app/konnect/mesh-manager/index.md", "range": {"start": {"line": 135, "column": 181}}}, "severity": "ERROR"}
| `roles` | List of roles that you want to assign to the users or groups/teams. |
Loading