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.

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

Jump to bottom

Update content of database credential docs #1656

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Update content of database credential docs #1656

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a75ac6
Update content of database credential docs
hanzjk Nov 7, 2024
292be14
Update wording
hanzjk Nov 8, 2024
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
13 changes: 9 additions & 4 deletions ...abases-and-caches/add-choreo-managed-databases-and-caches-to-the-marketplace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

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.
Copy link
Contributor

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.


To register credentials for a database, follow these steps:

Expand All @@ -20,8 +20,13 @@ To register credentials for a database, follow these steps:
5. Click the **Databases** tab.
6. Click to expand the database for which you want to register credentials, then click **Add Credentials**.
7. In the **Add Credentials** dialog, do one of the following depending on your requirements:
- 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**
Copy link
Contributor

@Nashaath Nashaath Nov 8, 2024 •
edited
Loading

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

The content will look like this if the suggested changes are applied:
Screenshot 2024-11-08 at 16 59 32

I can apply the changes if the suggestions are good to go.

Copy link
Contributor Author

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

- Add the newly created database credentials to Choreo by providing a display name and specifying the environment where those credentials will be used.
- The steps to create new user credentials depend on the type of database or cache you are using. Generally, you will need to log in to your database server as the super admin using a command-line interface or a database management tool and create new database users with the required permission levels.

ii. **Add Super Admin Credentials**
- Add the provided super admin credentials by giving a display name and specifying the environment where those credentials will be used.
8. Click **Save**.

!!! tip
Expand Down