Skip to content

fix: documentation for ACL in cluster connect #1259

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

Merged
wtrocki merged 1 commit into from
Oct 27, 2021
Merged

fix: documentation for ACL in cluster connect #1259

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions docs/commands/rhoas_cluster_connect.adoc
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 8 additions & 1 deletion pkg/localize/locales/en/cmd/cluster.en.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,11 @@ If the cluster has a service account, it will be refreshed.
2. Create a Kafka Request object that can be used to create a ServiceBinding object using
the Service Binding operator (https://github.com/redhat-developer/service-binding-operator).

NOTE: Created service account will need to be given permissions to specified service
For example for Kafka service you should execute the following command to grant access to the service account

$ rhoas kafka acl grant-access --producer --consumer --service-account your-sa --topic "*" --group "*"

Comment on lines +166 to +170
Copy link
Contributor

@craicoverflow craicoverflow Oct 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we split this into a separate i18n message and only print it when the service is Kafka?

'''

[cluster.connect.cmd.example]
Expand Down Expand Up @@ -295,10 +300,12 @@ Client ID: {{.ClientID}}

Make a copy of the client ID to store in a safe place. Credentials won't appear again after closing the terminal.

Execute the following command to grant access to the service account using rhoas cli:
You will need to assign permissions to service account in order to use it.
For example for Kafka service you should execute the following command to grant access to the service account:

$ rhoas kafka acl grant-access --producer --consumer --service-account {{.ClientID}} --topic "*" --group "*"
'''


[cluster.kubernetes.createTokenSecret.log.info.createFailed]
one = 'Creation of the "{{.Name}}" secret failed:'
Expand Down