Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.envzero.com/llms.txt

Use this file to discover all available pages before exploring further.

Choosing the docker agent is the quickest way to start running the self-hosted agent.

​
Running a deployment-agent

  1. Create an agent pool and generate an authentication secret. See Creating an Agent Pool.
  2. Create your state encryption key in base64 encoding (base64 encoding of any string you choose). This value will be used to encrypt and decrypt the environment state and working directory Read more about the state encryption key here
  3. Run the agent: 
    docker run -e AGENT_ACCESS_TOKEN='<your-agent-access-token>' -e ENV0_STATE_ENCRYPTION_KEY='<your-base64-encryption-key>' ghcr.io/env0/deployment-agent:latest
The agent should be marked as Active and be ready to handle deployments.
Enabling Multi-ConcurrencyDo you have multiple deployments waiting to run and you don’t want to them to wait?Each container is designed to handle a single deployment at a time.To run multiple deployments in parallel, create another deployment agent using the docker run command. You can run any number of containers to satisfy your deployment needs.

​
Cloud Credential Configurations

These are optional configurations, and typically role authentication will be handled by native container service mechanisms. See note below regarding exposing Environment Variables for native authentication.
KeysDescription
ASSUMER_ACCESS_KEY_ID
ASSUMER_SECRET_ACCESS_KEY		plaintext, access key and secret key user role that is used to assume the deployment credentials specified in the env zero project configurations.
For GCP, and Azure you can embed the Environment Variables for GCP and Azure and use ADDITIONAL_ENV_VARS to expose them to the runner environment.

​
Secrets

These are optional configurations, and typically will be handled by native authentication mechanisms in AWS, GCP, Azure if you’re using the managed container services like ECS.
Keys
CUSTOMER_AWS_ACCESS_KEY_ID
CUSTOMER_AWS_SECRET_ACCESS_KEY
AWS_SECRETS_REGION		plaintext, access key & secret key user role that has the following permission: secretsmanager:GetSecretValue
AWS_SECRETS_REGION(optional) - default region is us-east-1
USE_OIDC_FOR_AWS_SSMWhen enabled, the agent will authenticate to AWS SSM using env zero OIDC
CUSTOM_ROLE_FOR_OIDC_AWS_SSM
CUSTOM_DURATION_FOR_OIDC_AWS_SSM		Custom role for AWS SSM secret fetching, Note: only used when USE_OIDC_FOR_AWS_SSM=true
CUSTOMER_VAULT_TOKEN
CUSTOMER_VAULT_ADDRESS		plaintext, using HashiCorp Vault to store secrets
Token should be a long lived token.
CUSTOMER_GOOGLE_PROJECT
CUSTOMER_GOOGLE_CREDENTIALS		plaintext, Google service account credentials to fetch GCP secrets requires Secret Manager Secret Access role
CUSTOMER_AZURE_CLIENT_ID
CUSTOMER_AZURE_CLIENT_SECRET
CUSTOMER_AZURE_TENANT_ID		plaintext, using Azure Key Vault Secrets to store secrets for the agent

​
Cost Estimation

KeyDescription
INFRACOST_API_KEYInfracost API Key, create a personal / organizational key at infracost.io

​
Running a vcs-agent (for on-prem / self-hosted VCS)

In the case that you are using a self-hosted version control such as Bitbucket Server, GitLab Enterprise, GitHub Enterprise, you will need to run the vcs-agent. It has to run in parallel with the deployment-agent to interact with private VCS.
  1. Set credentials for the relevant VCS as environment variables (see variables table below)
  2. Run docker: docker run -e AGENT_ACCESS_TOKEN='<your-agent-access-token>' ghcr.io/env0/vcs-agent:latest
    env zero has a public docker registry on GitHub which is maintained here.
KeysDescriptionRequired for feature
BITBUCKET_SERVER_CREDENTIALSBitbucket server credentials in the format username:token (using a Personal Access token).On-premise Bitbucket Server installation.
GITLAB_ENTERPRISE_CREDENTIALSGitlab Enterprise credentials in the form of a Personal Access token.On-premise Gitlab Enterprise installation
GITLAB_ENTERPRISE_BASE_URL_SUFFIXIn cases where your GitLab instance base url is not at the root of the url, and in a separate path, e.g https://gitlab.acme.com/prod you should define that added suffix to this value
GITLAB_ENTERPRISE_BASE_URL_SUFFIX=prod		On-premise Gitlab Enterprise installation
GITHUB_ENTERPRISE_APP_ID
GITHUB_ENTERPRISE_APP_CLIENT_ID
GITHUB_ENTERPRISE_APP_INSTALLATION_ID
GITHUB_ENTERPRISE_APP_CLIENT_SECRET
GITHUB_ENTERPRISE_APP_PRIVATE_KEY		Github Enterprise Integration (see step 3)On-premise GitHub Enterprise installation

​
Exposing Custom Environment Variables

By default, env zero’s runner will not expose all the environment variables defined in the container. This is to help ensure some safety, and isolating the container environment from the runner’s environment. However, in certain scenarios, you may still want to expose environment variables defined in the container. For example, if you’re running in AWS ECS, and you want to use the cluster role for authorization purposes.
KeyDescription
ADDITIONAL_ENV_VARS["ENV_VAR_A", "ENV_VAR_B","ENV_VAR_C"]
This single-quoted array will allow the runner environment to see the three environment variables listed in the list. This assume those environment variables were defined with the docker configuration itself.

​
AWS ECS

When defining a role for the container, AWS sets an environment AWS_CONTAINER_CREDENTIALS_RELATIVE_URI this variable should be added to the ADDITIONAL_ENV_VARS to be exposed to the runner environment. For example, ADDITIONAL_ENV_VARS=["AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"]

​
Next steps