Connect to Remote Dependencies While Developing

To streamline local development and verification of Choreo components that depend on Choreo connections, you can bridge your local environment with the remote/deployed project. This is facilitated by the Choreo CLI and VS Code extension, which create a secure connected environment enabling real-time testing and validation.

This connected environment acts as a temporary link to your Choreo deployment. It provides your local component with the necessary connection configurations injected as environment variables. Furthermore, any outgoing HTTP requests from this local environment are securely routed to your deployed Choreo environment. This enables you to:

Securely Access Dependencies: Local components automatically get connection details for Choreo services, third-party services, and databases.
Test Integrations Early: Verify your local component's interaction with Choreo services before pushing code, using the same environment configuration.
Consistent Testing Across Environments: Ensure reliable and secure test results in both local and CI environments.

Using CLI¶

The Choreo CLI allows you to create a local subshell that is bridged to your deployed Choreo environment.

Prerequisites¶

Install the Choreo CLI. See the setup guide for instructions.
Login to Choreo via CLI
```
choreo login
```

Tip

For testing in CI environments, login to Choreo CLI using a personal access token.

Connect to a project¶

The following command will create a subshell that will be connected to your remote project environment.
```
choreo connect --project default-project
```
Execute the command to run your component locally within the Choreo subshell. For example:
```
go run main.go
```

Once your application is running within the Choreo subshell:

All connection configurations belonging to the selected project will be automatically injected into your application as environment variables.
Outgoing network requests made by your application to its dependent services will be securely redirected by the Choreo CLI to the relevant services in your remote environment.

Your application will now run connected to its remote dependencies for local development.

Advanced examples¶

Focusing Connection on a Specific Component

By default, all connection configurations within your project are injected into the subshell. If you only want to focus on a particular component's connections, you can pass it as a flag:
```
choreo connect --project default-project --component my-component
```
Connecting to Different Environments

By default, connection is established with your development environment. To connect to other non-critical environments, use the choreo connect command with the following flag:
```
choreo connect --project default-project --env test-env
```
Skipping Remote Dependencies

Sometimes, you might run certain dependencies locally. By default, choreo connect injects all connection configurations. To use your locally running dependencies instead and skip injecting specific configurations, use the choreo connect command with the following flags:
```
choreo connect --project default-project --skip-connection test-conn1 --skip-connection test-conn2 
```
Combining Connect with Application Startup

You might want to combine the choreo connect command and your application's start command into a single command. This automates the creation of the subshell and the launch of your application, reducing manual steps in your development process:
```
choreo connect --project default-project -- go run main,go
```

Tip

Execute the command choreo connect --help to explore all available advanced options and flags.

Debug using VS Code¶

The Choreo VS Code extension allows you to ensure that applications you launch and debug via VS Code are connected to your Choreo deployed project environment.

Note

This section applies when launching your local application through the VS Code debugger. For users starting their application in a terminal within VS Code, please see the "Using CLI" section for the relevant instructions.

Prerequisites¶

Install the Choreo VS Code Extension (Refer Guide).
Login to Choreo via VS Code Extension.
Link your workspace directory to an existing Choreo project (More information).

Launch Application (Connected to Project)¶

Configure Your Application's Launch Configuration.

Add the "choreo": true property to your launch configuration to instruct the Choreo VS Code extension to launch your application in a subshell that's connected to the Choreo project that the workspace is associated with.

{
    "version": "0.2.0",
    "configurations": [
        {
            "request": "launch",
            // ...Rest of your configuration
            // Add the following new property
            "choreoConnect": true
        }
    ]
}

Launch your application using VS Code (Refer Guide).

Advanced Configurations¶

You can customize the connection behavior to the remote project by modifying the launch configuration as shown below.

{
      "version": "0.2.0",
      "configurations": [
          {
              "request": "launch",
              // ...Rest of your configuration
              // Customize Choreo connect configurations
              "choreoConnect": {
                  "project": "default-project",
                  "component": "my-component",
                  "env": "test-env",
                  "skipConnection": ["test-conn1"]
              }
          }
      ]
}