Skip to content

Updates docs based on left menu item changes #1805

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

Merged
merged 2 commits into from
Apr 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ For example, if the API URL is `https://2d9ec1f6-2f04-4127-974f-0a3b20e97af5-dev
!!! info
To copy the exact service URL of a Connection, you can follow the steps given below:
1. In the Choreo Console, go to the appropriate web application component.
2. In the left navigation menu, click **Connections** under **Dependencies**.
2. In the left navigation menu, click **Connections**.
3. Click on the required Connection and copy the service URL.

If you enable Choreo's managed authentication, you don't have to manually add any logic to attach an access token to the API call because Choreo APIs accept the cookies set by Choreo's managed authentication. You can directly invoke the API as follows:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ To create a connection to the web application, follow the steps given below:

1. In the Choreo Console, go to the top navigation menu, click the **Project** list, and select the project where you created the web application.
2. On the project home page, click the web application listed under **Component Listing**.
3. In the left navigation menu, click **Dependencies** and then click **Connections**.
3. In the left navigation menu, click **Connections**.
4. Create a connection to the API you deployed in [Step 1](#step-1-assign-permissions-to-an-api-in-choreo).

Now you can proceed to deploy the web application.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To create a connection to a service or a database, follow the step-by-step instr
- **Project Connection**: Select an organization and a project in that organization.
- **Component Connection**: Select an organization, a project in that organization, and a component in the selected project.

2. In the left navigation menu, click **Dependencies** and then **Connections**. This page lists all the existing connections.
2. In the left navigation menu, click **Connections**. This page lists all the existing connections.
3. Click **+Create**. This opens the Marketplace view where you can browse and search for services or databases.
4. Click the **Services** tab. You can search and apply filters to efficiently find a service.
5. Click on the service you want to connect to.
Expand Down Expand Up @@ -57,7 +57,7 @@ To create a connection to a service or a database, follow the step-by-step instr
- **Project Connection**: Select an organization and a project in that organization.
- **Component Connection**: Select an organization, a project in that organization, and a component in the selected project.

2. In the left navigation menu, click **Dependencies** and then **Connections**. This page lists all the existing connections.
2. In the left navigation menu, click **Connections**. This page lists all the existing connections.
3. Click **+Create**. This opens the Marketplace view where you can browse and search for services or databases.
4. Click the **Databases** tab. You can search and apply filters to efficiently find a database.
5. Click on the database you want to connect to.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To register a GenAI service, follow these steps:
2. Follow one of these steps depending on your requirements:
- To register a GenAI service at the organization level, go to the Choreo Console header and select your organization from the **Organization** list.
- To register a GenAI service at the project level, go to the Choreo Console header and select your project from the **Project** list.
3. In the left navigation menu, click **Dependencies** and then click **GenAI Services**.
3. In the left navigation menu, click **Resources** and then click **GenAI Services**.
4. Click **+ Register**.
5. Select a service provider.
6. Click **Next**.
Expand Down Expand Up @@ -72,7 +72,7 @@ When you create a GenAI service, it gets listed in the **GenAI Services** list.
To view or update a GenAI service, follow these steps.

1. Sign in to the [Choreo Console](https://console.choreo.dev/).
2. In the left navigation menu, click **Dependencies** and then click **GenAI Services**. This lists all the GenAI services you have created.
2. In the left navigation menu, click **Resources** and then click **GenAI Services**. This lists all the GenAI services you have created.
3. Click on a service to view or update its details.
- **General Details**: Displays service metadata. For example, the service name, overview, labels, etc.
- **Service Definition**: Displays the service definition. To update the definition, click **Upload** and select the new definition file.
Expand All @@ -82,13 +82,13 @@ To view or update a GenAI service, follow these steps.
!!! info
To add a GenAI service to the Internal Marketplace, you must provide all the required configurations.

1. In the Choreo Console left navigation menu, click **Dependencies** and then click **GenAI Services**.
1. In the Choreo Console left navigation menu, click **Resources** and then click **GenAI Services**.
2. Click on the service you want to add to the Internal Marketplace.
3. Click **Add to Marketplace**.

### Remove a GenAI service from the Internal Marketplace

1. In the Choreo Console left navigation menu, click **Dependencies** and then click **GenAI Services**.
1. In the Choreo Console left navigation menu, click **Resources** and then click **GenAI Services**.
2. Click on the service you want to remove from the Internal Marketplace.
3. Click **Remove from Marketplace**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To register a third-party service, follow these steps:
2. Follow one of these steps depending on your requirement:
- To register a third-party service at the organization level, go to the Choreo Console header and select your organization from the **Organization** list.
- To register a third-party service at the project level, go to the Choreo Console header and select your project from the **Project** list.
3. In the left navigation menu, click **Dependencies** and then click **Third-Party Services**.
3. In the left navigation menu, click **Resources** and then click **Third-Party Services**.
4. Click **+ Register**.
5. Provide details for the service:
- Enter a **Name** and **Version**.
Expand Down Expand Up @@ -100,7 +100,7 @@ When you create a third-party service, it gets listed in the **Third-Party Servi
To view or update a third-party service, follow these steps.

1. Sign in to the [Choreo Console](https://console.choreo.dev/).
2. In the left navigation menu, click **Dependencies** and then click **Third-Party Services**. This lists all the third-party services you have created.
2. In the left navigation menu, click **Resources** and then click **Third-Party Services**. This lists all the third-party services you have created.
3. Click on a service to view or update its details.
- **General Details**: Displays service metadata. For example, the service name, overview, labels, etc.
- **Service Definition**: Displays the service definition. To update the definition, click **Upload** and select the new definition file.
Expand All @@ -111,13 +111,13 @@ To view or update a third-party service, follow these steps.
!!! info
To add a third-party service to the Internal Marketplace, you must provide all required parameters for at least one endpoint.

1. In the Choreo Console left navigation menu, click **Dependencies** and then click **Third-Party Services**.
1. In the Choreo Console left navigation menu, click **Resources** and then click **Third-Party Services**.
2. Click on the service you want to add to the Internal Marketplace.
3. Click **Add to Marketplace**.

### Remove a third-party service from the Internal Marketplace

1. In the Choreo Console left navigation menu, click **Dependencies** and then click **Third-Party Services**.
1. In the Choreo Console left navigation menu, click **Resources** and then click **Third-Party Services**.
2. Click on the service you want to remove from the Internal Marketplace.
3. Click **Remove from Marketplace**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To import credentials for a database, follow these steps:

1. Sign in to the [Choreo Console](https://console.choreo.dev/).
2. Go to the Choreo Console header and select your organization from the **Organization** list.
3. In the left navigation menu, click **Dependencies** and then click **Databases**.
3. In the left navigation menu, click **Resources** and then click **Databases**.
4. Click on a required database to view its details.
5. Click the **Databases** tab.
6. Click to expand the database for which you want to import credentials, then click **Import Credentials**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Follow the steps below to create a Choreo-Managed Cache:

1. Sign in to the Choreo Console at [https://console.choreo.dev/](https://console.choreo.dev).
2. In the header, click the **Organization** list. This opens the organization home page.
3. In the left navigation menu, click **Dependencies** and then click **Databases**.
3. In the left navigation menu, click **Resources** and then click **Databases**.
4. Click **+ Create** and select **Choreo-Managed Cache** as the data store type. Provide a display name for this server and follow the instructions.
5. Select a preferred cloud provider (AWS, Azure, GCP, or Digital Ocean).
- The cloud provider provisions the compute and storage infrastructure for your data store.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ MySQL on Choreo offers fully managed, flexible relational databases on AWS, Azur
Follow the steps below to create a Choreo-managed MySQL database:

1. From the environment list on the header, located next to the **Deployment Tracks** list, select your **Organization**.
2. In the left navigation menu, click **Dependencies** and then **Databases**.
2. In the left navigation menu, click **Resources** and then **Databases**.
3. Click **Create** and select **MySQL** as the database type. Provide a display name for this server and follow the instructions.
4. Select your preferred cloud provider from AWS, Azure, GCP, and Digital Ocean.
- Choreo uses the cloud provider to provision the compute and storage infrastructure for your database.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Follow the steps below to create a Choreo-managed PostgreSQL database:

1. Sign in to the Choreo Console at [https://console.choreo.dev/](https://console.choreo.dev/).
2. In the header, click the **Organization** list. This opens the organization home page.
3. In the left navigation menu, click **Dependencies** and then **Databases**.
3. In the left navigation menu, click **Resources** and then **Databases**.
4. Click **Create** and select **PostgreSQL** as the database type. Provide a display name for this server and follow the instructions.
5. Select your preferred cloud provider from AWS, Azure, GCP, or Digital Ocean.
- The cloud provider is used to provision the compute and storage infrastructure for your database.
Expand All @@ -24,7 +24,7 @@ Follow the steps below to create a Choreo-managed PostgreSQL vector database:

1. Sign in to the Choreo Console at [https://console.choreo.dev/](https://console.choreo.dev/).
2. In the header, click the **Organization** list. This opens the organization home page.
3. In the left navigation menu, click **Dependencies** and then **Vector Databases**.
3. In the left navigation menu, click **Resources** and then **Vector Databases**.
4. Follow steps 4 onwards in the [Create a Choreo-managed PostgreSQL database](#create-a-choreo-managed-postgresql-database) section.

## Connecting to your Choreo-managed PostgreSQL database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To create a Kafka topic, follow these steps:

1. Sign in to the Choreo Console at [https://console.choreo.dev/](https://console.choreo.dev).
2. In the header, click the **Organization** list. This opens the organization home page.
3. In the left navigation menu, click **Dependencies** and then click **Message Brokers**.
3. In the left navigation menu, click **Resources** and then click **Message Brokers**.
4. In the **Message Brokers** list, click the Kafka service for which you want to create a topic.
5. Click the **Topics** tab.
6. Click **+ Create**.
Expand Down Expand Up @@ -49,7 +49,7 @@ To manage users for a Choreo-managed Kafka service, follow these steps:

1. Sign in to the Choreo Console at [https://console.choreo.dev/](https://console.choreo.dev).
2. In the header, click the **Organization** list. This opens the organization home page.
3. In the left navigation menu, click **Dependencies** and then click **Message Brokers**.
3. In the left navigation menu, click **Resources** and then click **Message Brokers**.
4. In the **Message Brokers** list, click the Kafka service for which you want to manage users.
5. Click the **Users** tab.
6. Click **+ Add User**, specify a username, and then click **Add**.
Expand All @@ -68,7 +68,7 @@ To add an ACL entry, follow these steps:

1. Sign in to the Choreo Console at [https://console.choreo.dev/](https://console.choreo.dev).
2. In the header, click the **Organization** list. This opens the organization home page.
3. In the left navigation menu, click **Dependencies** and then click **Message Brokers**.
3. In the left navigation menu, click **Resources** and then click **Message Brokers**.
4. In the **Message Brokers** list, click the Kafka service for which you want to add an ACL entry.
5. Click the **Access Control List** tab.
6. Click **+ Add Entry**, select a username, topic, and permission.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Follow the steps below to create a Choreo-managed Kafka service:

1. Sign in to the Choreo Console at [https://console.choreo.dev/](https://console.choreo.dev).
2. In the header, click the **Organization** list. This opens the organization home page.
3. In the left navigation menu, click **Dependencies** and then click **Message Brokers**.
3. In the left navigation menu, click **Resources** and then click **Message Brokers**.
4. Click **+ Create**.
5. Specify a display name for the Kafka service and click **Next**.
6. Select your preferred cloud provider from AWS, Azure, GCP, or Digital Ocean.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Now that the `Reading List Service` is deployed and available in the Choreo Mark

A connection allows you to integrate the service with other services or external resources. For more information, refer to the [Connection](../choreo-concepts/connections.md) documentation.

1. In the left navigation menu, click **Dependencies** and then click **Connections**.
1. In the left navigation menu, click **Connections**.
2. Click **+ Create**.
3. In the **Select a Service** pane, click `Reading List Service`.
4. Specify the following:
Expand Down