Bruin CLI

Appearance

Connections ​

Bruin has various commands to handle connections via its CLI.

The connections are stored in a gitignored file called .bruin.yml, and while it is possible to edit this file directly, Bruin CLI offers convenience methods to manage connections.

List Connections ​

To list all the connections in the .bruin.yml file, run the following command:

bash
bruin connections list

The output will look like this:

Environment: default
+---------+-----------+
| TYPE    | NAME      |
+---------+-----------+
| generic | MY_SECRET |
| gorgias | my_conn   |
+---------+-----------+

Environment: someother
+---------+-----------+
| TYPE    | NAME      |
+---------+-----------+
| generic | MY_SECRET |
+---------+-----------+

Add Connection ​

To add a connection to a specific environment, run the following command:

bash
bruin connections add --env someother --type generic --name MY_SECRET --credentials '{"value": "someothersecret"}'

This will add the connection to the .bruin.yml file and the connection will be available in the given environment.

The parameter after --credentials is the value of the connection in JSON format, as you would write it in the .bruin.yml file. For further reference, you can check the Connections section of the documentation.

INFO

To be transparent, this command is meant to be used programmatically rather than human beings, since the credentials parameter is in JSON format.

Example: a GCP connection ​

bash
bruin connections add \
    --env default \
    --type google_cloud_platform \
    --name MY_GCP_CONNECTION \
    --credentials '{"project_id": "my-gcp-project", "service_account_file": "path/to/service/account/file.json"}'

Example: a generic secret ​

bash
bruin connections add \
    --env staging \
    --type generic \
    --name MY_SECRET \
    --credentials '{"value": "secret-password"}'

Delete Connection ​

To delete a connection from a specific environment, use the following command:

bash
bruin connections delete --env staging --name MY_SECRET

You can define a different path for the repo with an extra argument if you'd like:

bash
bruin connections delete --env staging --name MY_SECRET <path-to-repo>

Example ​

Delete a connection named "my-connection" from the "production" environment:

bruin connections delete -e staging -n test-connection -o json

Test Connection ​

To test if a connection is valid, you can use the test command. This command runs a simple validation check for the connection.

bash
bruin connections test --env <environment> --type <connection-type> --name <connection-name>