-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix
roleToRecipients
descriptions (#47295)
Closes #45287 Access Request plugin guides describe the value of the `roleToRecipients` field in Access Request plugin Helm charts as taking either a single string or an array of strings as the value of each mapping. This change fixes the error in all Access Request plugin guides that include this Helm chart value.
- Loading branch information
Showing
4 changed files
with
45 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -202,11 +202,12 @@ recipients that the email plugin will notify when a user requests access to a | |
specific role. When the plugin receives an Access Request from the Auth Service, | ||
it will look up the role being requested and identify the recipients to notify. | ||
|
||
Here is an example of a `role_to_recipients` map: | ||
|
||
<Tabs> | ||
<TabItem label="Executable or Docker"> | ||
|
||
Here is an example of a `role_to_recipients` map. Each value can be a single | ||
string or an array of strings: | ||
|
||
```toml | ||
[role_to_recipients] | ||
"*" = ["[email protected]", "[email protected]"] | ||
|
@@ -217,20 +218,23 @@ Here is an example of a `role_to_recipients` map: | |
</TabItem> | ||
<TabItem label="Helm Chart"> | ||
|
||
In the Helm chart, the `role_to_recipients` field is called `roleToRecipients` | ||
and uses the following format, where keys are strings and values are arrays of | ||
strings: | ||
|
||
```yaml | ||
roleToRecipients: | ||
"*": ["[email protected]", "[email protected]"] | ||
"dev": "[email protected]" | ||
"dba": "[email protected]" | ||
"dev": ["[email protected]"] | ||
"dba": ["[email protected]"] | ||
``` | ||
</TabItem> | ||
</Tabs> | ||
In the `role_to_recipients` map, each key is the name of a Teleport role. Each | ||
value configures the recipients the plugin will email when it receives an Access | ||
Request for that role. The value can be a single string or an array of strings. | ||
Each string must be an email address. | ||
Request for that role. Each string must be an email address. | ||
|
||
The `role_to_recipients` map must also include an entry for `"*"`, which the | ||
plugin looks up if no other entry matches a given role name. In the example | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -206,7 +206,8 @@ requested and identify the Slack channels to notify. | |
|
||
<Tabs> | ||
<TabItem label="Executable or Docker"> | ||
Here is an example of a `role_to_recipients` map: | ||
Here is an example of a `role_to_recipients` map. Each value can be a | ||
single string or an array of strings: | ||
|
||
```toml | ||
[role_to_recipients] | ||
|
@@ -216,26 +217,26 @@ Here is an example of a `role_to_recipients` map: | |
``` | ||
</TabItem> | ||
<TabItem label="Helm Chart"> | ||
In our Helm chart, the `role_to_recipients` field is called `roleToRecipients` | ||
and uses the following format: | ||
In the Helm chart, the `role_to_recipients` field is called `roleToRecipients` | ||
and uses the following format, where keys are strings and values are arrays of | ||
strings: | ||
|
||
```yaml | ||
roleToRecipients: | ||
"*": "admin-slack-channel" | ||
"*": ["admin-slack-channel"] | ||
"dev": | ||
- "dev-slack-channel" | ||
- "admin-slack-channel" | ||
"dba": "[email protected]" | ||
"dba": ["[email protected]"] | ||
``` | ||
</TabItem> | ||
</Tabs> | ||
In the `role_to_recipients` map, each key is the name of a Teleport role. Each | ||
value configures the Slack channel (or channels) to notify. The value can be a | ||
single string or an array of strings. Each string must be either the name of a | ||
Slack channel (including a user's direct message channel) or the email address | ||
of a Slack user. If the recipient is an email address, the Slack plugin will | ||
use that email address to look up a direct message channel. | ||
value configures the Slack channel (or channels) to notify. Each string must be | ||
either the name of a Slack channel (including a user's direct message channel) | ||
or the email address of a Slack user. If the recipient is an email address, the | ||
Slack plugin will use that email address to look up a direct message channel. | ||
|
||
The `role_to_recipients` map must also include an entry for `"*"`, which the | ||
plugin looks up if no other entry matches a given role name. In the example | ||
|