-
Notifications
You must be signed in to change notification settings - Fork 91
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
Update content of database credential docs #1656
base: dev
Are you sure you want to change the base?
Conversation
@@ -7,9 +7,9 @@ When you create a Choreo-managed database or cache, you can add it to the Market | |||
|
|||
## Step 1: Register credentials | |||
|
|||
When you create a database or cache server, you get super admin credentials by default. You can use these credentials to create new user credentials. The steps to create new user credentials depend on the type of database or cache you are using. | |||
You can register either the default super admin credentials or credentials you create using the super admin credentials. When you create a database or cache server, you get super admin credentials by default. You can use these super user credentials to create new user credentials. The steps to create new user credentials depend on the type of database or cache you are using. |
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.
Suggestion:
To register credentials, you can either use the default super admin credentials or the credentials you create using the super admin credentials. When you create a database or cache server, super admin credentials are generated by default. You can use these super admin credentials to create new user credentials. The steps to create new user credentials depend on the type of database or cache you are using.
|
||
You can register either the default super admin credentials or any custom credentials you create using the super admin credentials. | ||
The registered credentials will be used when creating the connection. You will be prompted to select the credentials for each database from the list of added credentials during the connection setup. |
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.
Suggestion:
You can use the registered credentials to create a connection. During connection setup, you must select credentials for each database from the list of available credentials.
- If you want to use the custom credentials you created using the super admin credentials, select **Add New Credentials** and specify appropriate values for each field. | ||
- If you want to use the default super admin credentials, select **Add Super Admin Credentials** and specify appropriate values for each field. | ||
|
||
i. **Add New Credentials** |
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.
Let's avoid the numbering since we are asking users to select one of the two options.
Suggestion:
-
Select Add New Credentials and specify the following:
- A display name for the credentials.
- The database credentials you created to use when setting up database connections in Choreo.
- The environment where you want to use the credentials.The steps to create new user credentials depend on the type of database or cache you are using. In general, you must log in to your database server as the super admin using a command-line interface or a database management tool. Then, create new database users with the required permission levels.
-
Select Add Super Admin Credentials and specify the following:
- A display name for the credentials.
- The default super admin credentials to use when setting up database connections in Choreo.
- The environment where you want to use the credentials.
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.
Can we remove the second point in Add Super Admin Credentials
The default super admin credentials to use when setting up database connections in Choreo.
as user does not require to provide it, values will be auto populated
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.
Added a few minor suggestions to apply if it makes sense.
Purpose
Goals
Approach
Release note
Samples
Related PRs