Install Atlas on Kubernetes using Kustomize

This guide will install Atlas onto your Kubernetes cluster.

All configuration for this project will be configured in the atlas namespace.

All files needed to install Atlas are in the kubernetes directory in the moment-docs repo.

We will use Kustomize for the install. (Kubernetes also ships with a Kustomize distributionβ€”if kustomize is not in your environment, use kubectl kustomize.)

β”œβ”€β”€ base
β”‚Β Β  β”œβ”€β”€ cluster_role_binding.yml
β”‚Β Β  β”œβ”€β”€ cluster_role.yml
β”‚Β Β  β”œβ”€β”€ deployment.yml
β”‚Β Β  β”œβ”€β”€ kustomization.yml
β”‚Β Β  β”œβ”€β”€ namespace.yml
β”‚Β Β  └── service_account.yml
└── overlays
    └── staging
        β”œβ”€β”€ .env.atlas-integration-tokens
        └── atlas.yml
        β”œβ”€β”€ envoy.yml
        β”œβ”€β”€ kustomization.yml

We reference a staging cluster here. Make sure to copy the atlas.yml you generated locally (in Getting Started) to kubernetes/overlays/staging/atlas.yml. If your environment uses a different name, rename the kubernetes/overlays/staging directory to use your environment name.

Kustomize configuration

These files are used to define Atlas and Envoy configurations.

Optional configuration

Adding integrations for third-party APIs

Please refer to the docs in docs/atlas-docs/integrations for a full list of integrations and how to use them.

Many integrations require credentials. To deploy these to Kubernetes, use the file kubernetes/overlays/staging/.env.atlas-integration-tokens contains placeholders where you can put access tokens for various APIs.


To provision these access tokens, see the docs in docs/atlas-docs/integrations for the integration you'd like to enable.

Once you add the tokens you'd like to use, Atlas will automatically discover them and enable the relavant integrations.

Using integrations in canvases

The docs in atlas-docs/integrations contain detailed instructions for using different integrations, as well as examples of code that you can use yourself.


Apply the configuration onto your Kubernetes cluster in the atlas namespace by running Kustomize.

kustomize build ./kubernetes/overlays/staging | kubectl apply -f -

Note: The service account is currently provisioned to allow for read access on ALL Kubernetes resources. If you want a more granular permission set, modify cluster_role.yml with the desired resources.

Testing that it works

Check that the pod is running with kubectl get po -n atlas.

Once connected, refer to the API docs for how to use Atlas.

Verifying that Atlas is installed from Moment

Once Atlas is installed and you've verified that the ECS service is healthy from the AWS console, check that it's working with Moment by adding a code cell with the following code:

const res = await atlasProxyFetch("/v1alpha1/instances");

return res.json();

Last updated