Heroku

Hoop is configured on Heroku using our custom buildpack. The agent could be started alongside any process that stays running (e.g.: web process). The following environment variables could be configured:

NAME	REQUIRED	DESCRIPTION
HOOP_VERSION	no	The version of the agent to install, default to the latest one
HOOP_DSN	yes	The credential key used to authenticate in the gateway
HOOP_CONNECTION	yes	The name of the connections (separated by comma) to publish in the hoop dashboard.

Client Keys

Client keys are required for agents to authenticate in the gateway. The name of the key is used as the prefix when publishing connections, it acts as an tenancy configuration for workloads (e.g.: homolog, prod, dev, etc)

To create a client key, issue the command below:

hoop admin create clientkeys dev

Assuming that we have an application configured as myapp (HOOP_CONNECTION=myapp), this key will publish the connection as dev:myapp.

IMPORTANT

Client keys must be configured in their proper workload environment, otherwise users could issue commands in wrong workloads. E.g.: like issuing a command in a homolog connection that is configured in a production workload.

Connection Resources

The HOOP_CONNECTION environment variable contains a list of resources that are published in the webapp dashboard.

Specifying Multiple Connections

Sometimes it's prefered to publish more than one connection to specify different profile access. Like activating the redact to a connection and having another connection with review. To publish multiple connections, separate the names with a comma.

• HOOP_CONNECTION=myapp-redact,myapp-review

There's a limitation of 255 characteres, make sure to not exceed it.

This will publish multiple connections to the dashboard.

tip

It's possible to derive the connection from an environment variable by using the prefix env.. Example: HOOP_CONNECTION=env.APP_NAME

Installing the Buildpack

Using multiple buildpacks for an application allows starting the agent alongside any workload deployed on heroku.

Just add the hoop buildpack at the first position in the order of buildpack execution:

heroku buildpacks:add --index 1 https://github.com/hoophq/heroku-hoop-buildpack

info

Make sure that the primary language of your app is the last buildpack in the list. More Info

Configuring the Procfile

The Procfile contains the definition of the application runtime. Use the hoopstart which will start the agent in the background and then start your main process (after --).

# Procfile
# ruby example
web: hoopstart -- bundle exec puma -C config/puma.rb

Make sure that the main process stays alive, the hoop agent will run in background as long the main process stays running (for this example: bundle exec puma -C config/puma.rb)

Configuring Connections

When the main application starts it's possible to configure how users will interact with the workloads, like:

• Edit the entrypoint of the connection
• Configure plugins
• Propagate custom environment variables

Check how to deploy the ruby getting started with hoop.