deprecated-helm-charts/stable/atlantis

Atlantis

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 lock files to disk for the duration of a Pull/Merge Request. These files are stored in a PersistentVolumeClaim to survive Pod failures.

Prerequisites

• Kubernetes 1.9+
• PersistentVolume support

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

   Refer to values.yaml for detailed examples.

2. Supply a value for orgWhitelist, e.g. github.org/myorg/*.

Customization

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

Parameter	Description	Default
allowRepoConfig	Whether to allow the use of atlantis.yaml files.	false
dataStorage	Amount of storage available for Atlantis' data directory (mostly used to check out git repositories).	5Gi
aws.config	Contents of a file to be mounted to ~/.aws/config.	n/a
aws.credentials	Contents of a file to be mounted to ~/.aws/credentials.	n/a
bitbucket.user	Name of the Atlantis Bitbucket user.	n/a
bitbucket.token	Personal access token for the Atlantis Bitbucket user.	n/a
bitbucket.secret	Webhook secret for Bitbucket repositories (Bitbucket Server only).	n/a
bitbucket.baseURL	Base URL of Bitbucket Server installation.	n/a
environment	Map of environment variables for the container.	{}
imagePullSecrets	List of secrets for pulling images from private registries.	[]
gitconfig	Contents of a file to be mounted to ~/.gitconfig. Use to allow redirection for Terraform modules in private git repositories.	n/a
github.user	Name of the Atlantis GitHub user.	n/a
github.token	Personal access token for the Atlantis GitHub user.	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.hostname	Hostname of your GitHub Enterprise installation.	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
gitlab.token	Personal access token for the Atlantis GitLab user.	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.hostname	Hostname of your GitLab Enterprise installation.	n/a
podTemplate.annotations	Additional annotations to use for the StatefulSet.	n/a
logLevel	Level to use for logging. Either debug, info, warn, or error.	n/a
orgWhiteList	Whitelist 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
requireApproval	Whether to require pull request approval prior to applies. See Approved Requirement.	false
requireMergeable	Whether to require pull request to be mergeable prior to applies. See Mergeable Requirement.	false
serviceAccount.create	Whether to create a Kubernetes ServiceAccount if no account matching serviceAccount.name exists.	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	JSON string representing secrets for a Google Cloud Platform production service account. Only applicable if hosting Atlantis on GKE.	n/a
serviceAccountSecrets.credentials-staging	JSON string representing secrets for a Google Cloud Platform staging service account. Only applicable if hosting Atlantis on GKE.	n/a
service.port	Port of the Service.	80
service.loadBalancerSourceRanges	Array of whitelisted 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
storageClassName	Storage class of the volume mounted for the Atlantis data directory.	n/a
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

Upgrading

From 1.* to 2.*

• The following value names have changed:
  • allow_repo_config => allowRepoConfig
  • atlantis_data_storage => dataStorage NOTE: more than just a snake_case change
  • atlantis_data_storageClass => storageClassName NOTE: more than just a snake_case change
  • bitbucket.base_url => bitbucket.baseURL

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 install -f test-values.yaml --name my-atlantis stable/atlantis --debug
   

2. Run the tests:

   helm test my-atlantis