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.

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

RoleToRecipients Helm Chart value does not accept string value #45287

Open
bernardjkim opened this issue Aug 8, 2024 · 0 comments · May be fixed by #46737
Open

RoleToRecipients Helm Chart value does not accept string value #45287

bernardjkim opened this issue Aug 8, 2024 · 0 comments · May be fixed by #46737
Assignees
Labels
documentation helm teleport-plugin Tickets related to Teleport Plugins https://github.com/gravitational/teleport-plugins

Comments

@bernardjkim
Copy link
Contributor

bernardjkim commented Aug 8, 2024

Applies To

https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-slack/

Details

The documentation indicates that the value of a roleToRecipient key/value pair can be a string value, but the Helm Chart requires that the value is an array of strings.

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.

# Documentation example values
roleToRecipients:
  "*": "access-requests"
  "editor": "TELEPORT_USERNAME"

When attempting to install the Helm Release with similar values I get the error:

❯ helm -n slack upgrade --install teleport-plugin-slack teleport/teleport-plugin-slack --values teleport-slack-helm.yaml
Error: UPGRADE FAILED: values don't meet the specifications of the schema(s) in the following chart(s):
teleport-plugin-slack:
- roleToRecipients.*: Invalid type. Expected: array, given: string

How will we know this is resolved?

The above helm install command should install the plugin as expected. Alternatively, the documentation should be updated to indicate that the recipient values must be an array.

@bernardjkim bernardjkim added documentation teleport-plugin Tickets related to Teleport Plugins https://github.com/gravitational/teleport-plugins labels Aug 8, 2024
@zmb3 zmb3 added the helm label Aug 12, 2024
@ptgott ptgott self-assigned this Sep 18, 2024
ptgott added a commit that referenced this issue Sep 18, 2024
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.
@ptgott ptgott linked a pull request Sep 18, 2024 that will close this issue
ptgott added a commit that referenced this issue Oct 1, 2024
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation helm teleport-plugin Tickets related to Teleport Plugins https://github.com/gravitational/teleport-plugins
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants