On-Premise Agent Variants
The Superblocks On-premise Agent has two variants: the standard agent and the slim agent. The agent variants give you different levels of control over the packages included in the agent and that are available when your developers write Python and JavaScript code in their APIs.
Which variant should I use?
If you're unsure where to start, want to get up and running quickly, or need to minimize dependencies on your DevOps team, the standard image is the way to go. The standard image includes all the same JavaScript and Python libraries included in Superblocks Cloud, so will let developers get started quickly with a bunch of useful libraries out of the box. Since devs have access to many of the libraries they may need, they won't need to come to your DevOps team to install new packages to unblock development.
The standard image is also recommended if you're a current Superblocks Cloud customer and already have tools deployed and you're not sure which packages/libraries you're developers are using.
The slim image on the other hand is ideal for organizations that have a high need for customization or have stringent security requirements where it is acceptable for the DevOps team to be involved in assisting developers with installing or upgrading necessary packages.
Unlike the standard image the slim image only includes the minimum packages required for the agent to run. Because of this, you'll have greater control over your agent's dependencies and can fully manage security patches and version upgrades on your own.
Variants
Standard
superblocksteam/agent:<version>
Supported Libraries
The standard on-premise agent is the defacto Superblocks agent image. It includes:
- All the supported JavaScript libraries in cloud agents (see supported JavaScript libraries)
- All the supported Python packages in cloud agents (see supported Python packages)
From a functionality point of view, running workloads against this agent is akin to running workloads against the cloud agents.
How to use
To use this agent variant, you'll set an environment variable as follows based on how you deploy your agents:
| Deployment Type | Environment Variable |
|---|---|
| Docker | SUPERBLOCKS_DOCKER_AGENT_TAG=<version> |
| Terraform | superblocks_agent_image = "ghcr.io/superblocksteam/agent:<version>" |
| Helm | image: repository: ghcr.io/superblocksteam/agent |
Slim
superblocksteam/agent:<version>-slim
Supported Libraries
The slim variant of the agent contains the minimum set of dependencies required to run the agent. This includes:
- JavaScript libraries required for the agent to run (see package-slim.json)
- Python packages required for the agent to run (see requirements-slim.txt)
How to use
To use this agent variant, you'll set an environment variable as follows based on how you deploy your agents:
| Deployment Type | Environment Variable |
|---|---|
| Docker | SUPERBLOCKS_DOCKER_AGENT_TAG=<version>-slim |
| Terraform | superblocks_agent_image = "ghcr.io/superblocksteam/agent:<version>-slim" |
| Helm | image: repository: ghcr.io/superblocksteam/agent tag: \<version\>-slim</pre> |