helm-charts

Atlantis

Lint Code Base Lint and Test Charts Release Charts pages-build-deployment

Atlantis is a tool for safe collaboration on Terraform repositories.

Introduction

This chart creates a single pod in a StatefulSet running Atlantis. Atlantis persists Terraform plan files and lockfiles to disk for the duration of a Pull/Merge Request. These files are stored in a PersistentVolumeClaim to survive Pod failures.

Prerequisites

Required Configuration

In order for Atlantis to start and run successfully:

  1. At least one of the following sets of credentials must be defined:
    • github
    • gitlab
    • bitbucket
    • azuredevops

    Refer to values.yaml for detailed examples. They can also be provided directly through a Kubernetes Secret, use the variable vcsSecretName to reference it.

  2. Supply a value for orgAllowlist, e.g. github.com/myorg/*.

Additional manifests

It is possible to add additional manifests into a deployment, to extend the chart. One of the reason is to deploy a manifest specific to a cloud provider ( BackendConfig on GKE for example ).

extraManifests:
  - apiVersion: cloud.google.com/v1beta1
    kind: BackendConfig
    metadata:
      name: "-test"
    spec:
      securityPolicy:
        name: "gcp-cloud-armor-policy-test"

Customization

The following options are supported. See values.yaml for more detailed documentation and examples:

Parameter Description Default    
allowDraftPRs Allow atlantis to run on draft Pull Requests false    
allowForkPRs Allow atlantis to run on fork Pull Requests false    
api.secret API secret to enable API endpoints n/a    
apiSecretName Name of a pre-existing Kubernetes Secret containing a apisecret key. Use this instead of api.secret n/a    
atlantisUrl Base URL of atlantis server. This URL also reflects in pull-requests CI hooks where terraform changes are displayed. n/a    
aws.config Contents of a file to be mounted to ~/.aws/config or aws.directory/config. n/a    
aws.credentials Contents of a file to be mounted to ~/.aws/credentials aws.directory/credentials. n/a    
aws.directory If set, will mount AWS credentials to the specified path and set AWS_SHARED_CREDENTIALS_FILE and AWS_CONFIG_FILE variables. If not set, default path /home/atlantis/.aws will be used. n/a    
awsSecretName Secret name containing AWS credentials - will override aws.credentials and aws.config. Will be used a volume mount on $HOME/.aws or aws.directory, so it needs a credentials key. The key config is optional. See the file templates/secret-aws.yml for more info on the Secret contents. n/a    
azuredevops.token Personal access token for the Atlantis Azure DevOps user. n/a    
azuredevops.user Repository or organization-wide secret for the Atlantis Azure DevOps,integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value. n/a    
azuredevops.webhookPassword Webhook password for the Atlantis Azure DevOps integration. All repositories in Azure DevOps that are to be integrated with Atlantis must share the same value. n/a    
azuredevops.webhookUser Webhook user for the Atlantis Azure DevOps integration. n/a    
basicAuth.password Password for basic authentication n/a    
basicAuth.username Username for basic authentication n/a    
basicAuthSecretName Name of a pre-existing Kubernetes Secret containing username and password keys for basic auth credentials. Use this instead of basicAuth.username/basicAuth.password n/a    
bitbucket.baseURL Base URL of Bitbucket Server installation. n/a    
bitbucket.secret Webhook secret for Bitbucket repositories (Bitbucket Server only). n/a    
bitbucket.token Personal access token for the Atlantis Bitbucket user. n/a    
bitbucket.user Name of the Atlantis Bitbucket user. n/a    
command Optionally override the command field of the Atlantis Docker container. If not set, the default Atlantis ENTRYPOINT is used. Must be an array. n/a    
commonLabels Add Common Labels to all resources {}    
config Override atlantis main configuration by config map. It’s allow some additional functionality like slack notifications. n/a    
containerSecurityContext.allowPrivilegeEscalation Whether to enable privilege escalation n/a    
containerSecurityContext.readOnlyRootFilesystem Whether the root file system should be read-only n/a    
servicemonitor.enabled Enable Prometheus service monitor. This requires metrics.prometheus.endpoint to be defined (/metrics is a good default) in the repoConfig value false    
servicemonitor.interval Interval at which metrics should be scraped 30s    
servicemonitor.path HTTP path to scrape for metrics /metrics    
servicemonitor.auth If authentication is required on Atlantis, the servicemonitor should reference a secret with the credentials. The default values.yaml file provides two options for that, basicAuth, using the atlantis-basic-auth secret created by this chart, or externalSecret if the credentials are set there n/a    
customPem SecretName of the custom ca-certificates.cert to override the /etc/ssl/certs/ca-certificates.crt with your custom one (self-signed certificates)
Secret has to be created manually and shal contain ca-certificates.crt: PEM
n/a    
dataStorage DEPRECATED - Amount of storage available for Atlantis’ data directory (mostly used to check out git repositories). 5Gi    
defaultTFVersion Default Terraform version to be used by atlantis server n/a    
disableApplyAll Disables running atlantis apply without any flags false    
disableApply Disables running atlantis apply regardless of what options are specified false    
disableRepoLocking Stops atlantis locking projects and or workspaces when running terraform false    
enableKubernetesBackend Deploy rbac to allow for the serviceAccount to manage terraform state via a kubernetes backend false    
environmentRaw Array environment variables in plain Kubernetes yaml format. See values.yaml for example. []    
environmentSecrets Array of Kubernetes secrets that can be used to set environment variables. See values.yaml for example. {}    
environment Map of environment variables for the container. {}    
extraContainers Additional containers to use and depends of use cases. []    
extraManifests Add additional manifests to deploy []    
extraVolumeMounts List of additional volumes mounted to the container. []    
extraVolumes List of additional volumes available to the pod. []    
gitconfigSecretName Name of a pre-existing Kubernetes Secret containing a gitconfig key. Use this instead of gitconfig (optional) n/a    
gitconfig Contents of a file to be mounted to ~/.gitconfig. Use to allow redirection for Terraform modules in private git repositories. n/a    
github.hostname Hostname of your GitHub Enterprise installation. n/a    
github.secret Repository or organization-wide webhook secret for the Atlantis GitHub integration. All repositories in GitHub that are to be integrated with Atlantis must share the same value. n/a    
github.token Personal access token for the Atlantis GitHub user. n/a    
github.user Name of the Atlantis GitHub user. n/a    
githubApp.id GitHub app ID. If set, GitHub authentication will be performed as an installation. n/a    
githubApp.key A GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as an installation. n/a    
githubApp.secret Secret used to validate GitHub webhooks (see Securing your webhooks). n/a    
githubApp.slug A slugged version of GitHub app name shown in pull requests comments, etc (not Atlantis App but something like atlantis-app). Atlantis uses the value of this parameter to identify the comments it has left on GitHub pull requests. This is used for functions such as hidePrevPlanComments. n/a    
gitlab.hostname Hostname of your GitLab Enterprise installation. n/a    
gitlab.secret Webhook secret for the Atlantis GitLab integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value. n/a    
gitlab.token Personal access token for the Atlantis GitLab user. n/a    
gitlab.user Repository or organization-wide secret for the Atlantis GitLab,integration. All repositories in GitLab that are to be integrated with Atlantis must share the same value. n/a    
googleServiceAccountSecrets An array of Kubernetes secrets containing Google Service Account credentials. See values.yaml for examples and additional documentation. n/a    
hidePrevPlanComments Allow atlantis to hide previous plan comments false    
hostAliases[].hostnames Hostnames for host alias entry n/a    
hostAliases[].ip IP for host alias entry n/a    
imagePullSecrets List of secrets for pulling images from private registries. []    
ingress.annotations Additional annotations to use for the Ingress. {}    
ingress.apiVersion Override ingress apiVersion. Useful in scenarios in which helm can’t determine the capabilities of the Kubernetes cluster. n/a    
ingress.enabled Whether to create a Kubernetes Ingress. true    
ingress.host Domain name Kubernetes Ingress rule looks for. Set it to the domain Atlantis will be hosted on.     /
ingress.hosts[0].host List of domain names Kubernetes Ingress rule looks for. Set it to the domains in which Atlantis will be hosted on. chart-example.local    
ingress.hosts[0].paths List of paths to use in Kubernetes Ingress rules. Should be set to /* if using gce-ingress in Google [/]    
ingress.labels Additional labels to use for the Ingress. {}    
ingress.path Path to use in the Ingress. Should be set to /* if using gce-ingress in Google Cloud. /    
ingress.tls Kubernetes tls block. See Kubernetes docs for details. []    
initContainers Containers used to initialize context for Atlantis pods []    
lifecycle Configure pod container lifecycle hooks. See Kubernetes docs for details. {}    
loadEnvFromConfigMaps Array of Kubernetes ConfigMaps to set all key-value pairs as environment variables. See values.yaml for example. []    
loadEnvFromSecrets Array of Kubernetes secrets to set all key-value pairs as environment variables. See values.yaml for example. []    
lockingDbType Locking DB type for storing plan and apply locks. Allowed values are boltdb and redis. n/a    
logLevel Level to use for logging. Either debug, info, warn, or error. n/a    
netrcSecretName Name of a pre-existing Kubernetes Secret containing a netrc key. Use this instead of netrc (optional) n/a    
netrc Contents of a file to be mounted to ~/.netrc. Use to authenticate with private registries hosting terraform modules. n/a    
orgAllowlist Allowlist of repositories from which Atlantis will accept webhooks. This value must be set for Atlantis to function correctly. Accepts wildcard characters (*). Multiple values may be comma-separated. none    
orgWhitelist Deprecated (see orgAllowlist) List of repositories from which Atlantis will accept webhooks. Accepts wildcard characters (*). Multiple values may be comma-separated. none    
podTemplate.annotations Additional annotations to use for pods. {}    
podTemplate.labels Additional labels to use for pods. {}    
redis.db Redis database number for Locking DB of type redis. n/a    
redis.host Redis hostname for Locking DB of type redis. n/a    
redis.insecureSkipVerify Whether Redis client should skip verification of Redis server’s certificate chain and hostname. Setting to true may introduce a security vulnerability. n/a    
redis.password Redis password for Locking DB of type redis. n/a    
redis.port Redis port for Locking DB of type redis. n/a    
redis.tlsEnabled Whether to enable TLS connection to Redis. n/a    
redisSecretName Name of a pre-existing Kubernetes Secret containing a password key. Use this instead of redis.password. n/a    
repoConfig Server-side Repository Configuration as a raw YAML string. Configuration is stored in ConfigMap. n/a    
service.annotations Additional annotations to use for the service. n/a    
service.loadBalancerIP Expose this service on the given ip if service.type = LoadBalancerIP n/a    
service.loadBalancerSourceRanges Array of allowlisted IP addresses for the Atlantis Service. If no value is specified, the Service will allow incoming traffic from all IP addresses (0.0.0.0/0). n/a    
service.port Port of the Service. 80    
service.targetPort Target Port of the Service. 4141    
serviceAccount.annotations Additional Service Account annotations n/a    
serviceAccount.create Whether to create a Kubernetes ServiceAccount if no account matching serviceAccount.name exists. true    
serviceAccount.mount Whether to mount the Kubernetes ServiceAccount into the pod true    
serviceAccount.name Name of the Kubernetes ServiceAccount under which Atlantis should run. If no value is specified and serviceAccount.create is true, Atlantis will be run under a ServiceAccount whose name is the FullName of the Helm chart’s instance, else Atlantis will be run under the default ServiceAccount. n/a    
serviceAccountSecrets.credentials-staging Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE. n/a    
serviceAccountSecrets.credentials Deprecated (see googleServiceAccountSecrets) JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE. n/a    
statefulSet.annotations Additional annotations to use for StatefulSet. {}    
statefulSet.labels Additional labels to use for StatefulSet. {}    
statefulSet.priorityClassName Leverage a PriorityClass to ensure your pods survive resource shortages. {}    
statefulSet.securityContext Allow customizing fsGroup/runAsUser. {}    
statefulSet.shareProcessNamespace Share the process namespace between all containers in a pod. false    
statefulSet.updateStrategy Configure updateStrategy of the StatefulSet. {}    
storageClassName DEPRECATED - Storage class of the volume mounted for the Atlantis data directory. n/a    
terminationGracePeriodSeconds Set terminationGracePeriodSeconds for the StatefulSet. {}    
test.enabled Whether to enable the test. true    
tlsSecretName Name of a Secret for Atlantis’ HTTPS certificate containing the following data items tls.crt with the public certificate and tls.key with the private key. n/a    
topologySpreadConstraints You can use topology spread constraints to control how Pods are spread across your cluster among failure-domains such as regions, zones, nodes, and other user-defined topology domains. (requires Kubernetes >= 1.19). []    
vcsSecretName Name of a pre-existing Kubernetes Secret containing token and secret keys set to your VCS provider’s API token and webhook secret, respectively. Use this instead of github.token/github.secret, etc. (optional) n/a    
volumeClaim.dataStorage Amount of storage available for embedded Atlantis’ data directory 5Gi    
volumeClaim.enabled Activate embedded volume claim for Atlantis’ data directory (mostly used to check out git repositories). true    
volumeClaim.storageClassName Storage class of the embedded volume mounted for the Atlantis data directory. n/a    

NOTE: All the Server Configurations are passed as Environment Variables.

Upgrading

From 4.0.* to 4.1.*

From 2.* to 3.*

To replicate your previous configuration, run Atlantis locally with your previous flags and Atlantis will print out the equivalent repo-config, for example:

$ atlantis server --allow-repo-config --require-approval --require-mergeable --gh-user=foo --gh-token=bar --repo-allowlist='*'
WARNING: Flags --require-approval, --require-mergeable and --allow-repo-config have been deprecated.
Create a --repo-config file with the following config instead:

---
repos:
- id: /.*/
  apply_requirements: [approved, mergeable]
  allowed_overrides: [apply_requirements, workflow]
  allow_custom_workflows: true

or use --repo-config-json='{"repos":[{"id":"/.*/", "apply_requirements":["approved", "mergeable"], "allowed_overrides":["apply_requirements","workflow"], "allow_custom_workflows":true}]}'

Then use this YAML in the new repoConfig value:

repoConfig: |
  ---
  repos:
  - id: /.*/
    apply_requirements: [approved, mergeable]
    allowed_overrides: [apply_requirements, workflow]
    allow_custom_workflows: true

From 1.* to 2.*

Testing the Deployment

To perform a smoke test of the deployment (i.e. ensure that the Atlantis UI is up and running):

  1. Install the chart. Supply your own values file or use test-values.yaml, which has a minimal set of values required in order for Atlantis to start.

     helm repo add runatlantis https://runatlantis.github.io/helm-charts
     helm install -f test-values.yaml my-atlantis runatlantis/atlantis --debug
    
  2. Run the tests:

     helm test my-atlantis