Skip to main content

Agent Deployment

Tutorial explaining how to deploy and register an agent in multiple environments

Requirements​

  • Hoop Command Line

Login / Signup​

Leave the default values pressing enter and type your e-mail in the end

hoop login
Press enter to leave the defaults
API_URL [https://app.hoop.dev]:
GRPC_URL [app.hoop.dev:8443]:

Your default browser will open and authenticate with your identity provider.

tip

If you don't have an organization yet, this process will perform the signup automatically

Local​

  • Start the agent locally
hoop start agent
info

The agent is only supported on Unix (MacOS/Linux)

  • Visit the URL show in the last command to register the agent

Linux | systemd​

Systemd is recommended and will help on managing the agent in the Linux server.

  1. Login to the linux server via SSH and switch the user to root
sudo su -
  1. Install and run the Agent
curl -s -L https://releases.hoop.dev/release/install-cli.sh | sh

cat - >/etc/systemd/system/hoopagent.service <<EOF
[Unit]
Description=Hoop Agent
After=network.target

[Service]
ExecStart=hoop start agent
Environment="HOME=/root"
StandardOutput=true
Restart=on-failure
RestartSec=10s

[Install]
WantedBy=multi-user.target
EOF

systemctl daemon-reload
systemctl enable hoopagent.service
systemctl start hoopagent
  1. Visit the URL and register the agent
$ journalctl -u hoopagent |grep -i 'https://app.hoop.dev/agents/new/x-agt' |tail -n1
Dec 13 21:59:21 node01 hoop[2545]: {API_URL}/agents/new/x-agt-....

Container Platforms​

In this mode, the agent needs a token in advance set as an environment variable. A crash could wipe the state of the filesystem unregistering the agent.

  1. In your local machine, execute the commands below to create an agent token.
info

You need to be an administrator and logged in to perform this action.

hoop login
AGENT_NAME=prod
HOOP_TOKEN=$(hoop admin create agent $AGENT_NAME)
  1. Deploy the image in the container platform

The runtime of most container platforms expects a specification of how to deploy the image:

  • image: hoophq/hoopdev
  • environmet variables:
    • HOOP_TOKEN - the token required to connect with the gateway
    • HOOP_GRPCURL - the grpc address gateway
info

Use app.hoop.dev:8443 for the HOOP_GRPCURL in case it's a SaaS setup.

The command above executed by the docker container runtime is enough to run the agent:

docker run --name hoopagent \
  -e HOOP_TOKEN=$HOOP_TOKEN \
  -e HOOP_GRPCURL=<host>:<port> \
  hoophq/hoopdev

In Kubernetes for example, the container specification below would be enough to run the agent:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: defaultagent
spec:
  selector:
    matchLabels:
      app: defaultagent
  strategy:
    type: Recreate
  template:
    metadata:
      labels:
        app: defaultagent
    spec:
      containers:
      - name: defaultagent
        env:
        - name: HOOP_GRPCURL
          value: '<host>:<port>'
        - name: HOOP_TOKEN
          value: 'x-agt-...'
        image: hoophq/hoopdev

Associating with Connections​

The registered agent will be available and can be associated with a connection in the webapp.

agent selection