Skip to main content

Deploying the On-premise Agent

Set up a secure on-premise agent faster than you can say it

The On-premise Agent enables users to secure their workloads inside their own infrastructure. Getting set up with an on-premise agent for Superblocks is an extremely simple process.

On this page:

  1. Prerequisites
  2. 5 min Quickstart Guide
  3. Environments
  4. Deployment Guidelines
  5. Supported Platforms

Prerequisites

The On-Premise Agent requires about 200MB of memory running at a steady state. Provisioning 1GB of memory for the agent is recommended but may need to be adjusted based on your workload. Provisioning with less can potentially cause your agent to hit Out Of Memory errors.

5 min Quickstart Guide

  1. Navigate to the On-Premise Agents section in Superblocks. If you have existing On-premise Agents, information about them will be displayed in the list. If not, you view instructions to add one by simply clicking the View deployment instructions button.

2. This will open up a modal displaying the necessary steps to deploy your OPA. You can customize these steps with your own configuration by modifying the form at the top of the modal.

info

We currently support Docker, Helm, AWS, GCP, Azure and Digital Ocean with more deployment options coming soon. Email help@superblockshq.com if your infrastructure is not supported

3. Execute the documented instructions to deploy your new OPA.

4. You can monitor the agent's deployment status at the bottom of the modal.

When the agent is able to connect to the Superblocks server, you will see the status updated to reflect the successful registration.

info

If you don't see the Success message after deploying your agent, try clicking the Refresh Button beside "Waiting to connect to a new agent"

5. Close the modal and view the status of your deployed agents

6. To start directing workloads to your On-premise Agents, toggle the slider On. Now all requests to your Integrations will flow through your On-premise Agents instead of the Superblocks Cloud, securing your customer data inside your network.

Environments

We recommend agents workloads to be separated by environment. You are able to specify specific agents to only handle production workloads and specific agents to only handle staging workloads. These production-only agents can be set up isolated networks and with resources provisioned separately from staging. This ensures production performance and security are not compromised by any staging workloads.

To assign environment-specific agents, you can select an environment in the deployment modal. This will append the environment variable SUPERBLOCKS_AGENT_ENVIRONMENT to your deployment instructions. If not set, by default, agents are allocated to all environments. This means the agent will handle workloads from both staging and production integrations.

Deployment Guidelines

If you're deploying the OPA in a different location and/or updating its host URL, you can override the SUPERBLOCKS_AGENT_HOST_URL environment variable with the appropriate value in the format of <agent-url>/agent.

Supported Platforms

The agent key can be obtained by clicking View deployment instructions on the On-premise Agents page. For more information on supported platforms, see Deployment Methods.

A comprehensive list of environment configurations can be found in the agent repository.