-
Notifications
You must be signed in to change notification settings - Fork 96
docs: add documentation for using portal service accounts #883
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
base: main
Are you sure you want to change the base?
docs: add documentation for using portal service accounts #883
Conversation
Signed-off-by: Dustin Scott <[email protected]>
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Hi @scottd018. Thanks for your PR. I'm waiting for a terraform-redhat member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
@hunterkepley Please help to review this pr, which adds the missing part for the tf, thanks |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks pretty good at explaining the client ID and secret, but I did have a point of clarification surrounding the OCM offline token with regards to the new SSO login method for ROSA.
|
||
* An offline [OCM token](https://console.redhat.com/openshift/token/rosa) | ||
* One of the following for authenticating against the OCM service: | ||
* An offline [OCM token](https://console.redhat.com/openshift/token/rosa) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You right; i will create a new PR, i cannot modify that one. OCM offline token will be deprecated, so the only supported method will be using portal service accounts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fjcloud please ping me on here or preferably slack for review on that new MR :)
|
||
* A client ID and client secret value when using [Red Hat Customer Portal Service Accounts](https://docs.redhat.com/en/documentation/red_hat_customer_portal/1/html/creating_and_managing_service_accounts/con-ciam-svc-acct-intro-creating-service-acct#con-ciam-svc-acct-intro-creating-service-acct). | ||
|
||
These values allow the Terraform provider to refresh the token prior to the 15-minute expiry time and allow avoiding the use of a single, hard-coded access token against the OCM API. Like the offline OCM token, the purpose of this token is to verify that you have access and permission to create and upgrade clusters. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These values allow the Terraform provider to refresh the token prior to the 15-minute expiry time and allow avoiding the use of a single, hard-coded access token against the OCM API. Like the offline OCM token, the purpose of this token is to verify that you have access and permission to create and upgrade clusters. | |
These values allow the Terraform provider to refresh the token prior to the 15-minute expiry time and avoid using a single, hard-coded access token against the OCM API. Like the offline OCM token, the purpose of this token is to verify that you have access and permission to create and upgrade clusters. |
What this PR does / why we need it:
There is currently no information on using the
client_id
andclient_secret
parameters when using portal service accounts. This creates confusion when customers are trying to use the access tokens, described at https://docs.redhat.com/en/documentation/red_hat_customer_portal/1/html/creating_and_managing_service_accounts/ref-ciam-svc-acct-api-creating-service-acct, and causes a timeout when provisioning clusters, which is hard-coded at 15 minutes.Which issue(s) this PR fixes (optional, use
fixes #<issue_number>(, fixes #<issue_number>, ...)
format, where issue_number might be a GitHub issue, or a Jira story (OCM-xxxx):Fixes #
Change type
Checklist