Atmos Pro Installation
The first step to begin using Atmos Pro is to sign up for an account. Signing up for Atmos Pro is easy, just follow the steps below.
For a fully working quick-start example, check out the Atmos Pro Example
Advanced repository.
Atmos Pro uses GitHub OAuth to authenticate users. To sign up for an account, you'll need to use your GitHub account.
It's as simple as navigating to https://atmos-pro.com and
clicking the "Continue with GitHub" button.
Preview Only
Once you're logged in, you'll need to create a new workspace or work with an existing workspace that you've been
invited to join.
Workspaces allow you to group your company's or team's repositories together. You can create as many workspaces as you'd
like, but for now, we recommend creating a single workspace for your team. The only requirement is that a single
repository can only be imported into one workspace.
If you aren't already a member of any workspaces, you'll be taken to the Create Workspace screen. Enter a name for your
workspace and click
Create Workspace. We recommend using your company name or company plus team name (Acme, Inc. or
Acme, Inc. Retail Operations) as the name of your workspace.Preview Only
After creating your workspace, you'll need to configure your Workspace ID as a GitHub Actions variable so your workflows can authenticate with Atmos Pro.
Configure Workspace ID
Once you've created a workspace, you'll need to install the Atmos Pro GitHub App. Click the
Install button to be taken
to GitHub, where you'll be prompted to install the Atmos Pro GitHub App.Preview Only
If you're an administrator of the GitHub organization that owns the repositories you'd like to use with Atmos Pro, you
can install the Atmos Pro GitHub App by clicking the
Install and Authorize button after selecting the subset of
repositories you'd like to use with Atmos Pro.
Install & Authorize Atmos Pro
Install & Authorize on your organization Cloud Posse 🔗
for these repositories:
All repositories
This applies to all current and future repositories owned by the resource owner. Also includes public repositories (read-only).
Only select repositories
Select at least one repository. Also includes public repositories (read-only).
with these permissions:
Read access to members and metadata
Read and write access to actions, checks, code, commit statuses, environments, issues, pull requests, repository hooks, and workflows
User permissions
Installing and authorizing Atmos Pro immediately grants these permissions on your account: jkirk.
These permissions will also be requested and authorized as needed on an individual-user basis.
Read access to email addresses
Cancel
Next, you'll be redirected to https://atmos-pro.com/onboarding
Preview Only
Once you've given the Atmos Pro GitHub App the permissions it needs, you can now pick which repositories you'd like to
use in Atmos Pro by importing them. Select the GitHub organization that owns the repositories from the dropdown menu,
and then click the
Import button next to any repositories you'd like to use with Atmos Pro.If you're still waiting for an administrator to approve the Atmos Pro GitHub App, or you just want to start with one or
two repositories, just click the
Done button. You have the option to add more repositories at any time from the
repositories screen within the Atmos Pro application.Preview Only
After importing your repositories, you'll need to configure repository permissions to enable workflow dispatches. Repository permissions control which branches and workflows are allowed to interact with Atmos Pro via OIDC token exchange.
To connect your infrastructure to Atmos Pro, you'll need to update your Atmos configuration and cloud setup:
- 1Configure Atmos Auth so that Atmos knows how to exchange OIDC tokens for cloud credentials in your AWS, Azure, or GCP accounts.
- 2Configure which workflows should run for specific events (e.g.
planon pull request,applyon merge) for each component in your Atmos stacks. - 3Deploy your IaC integration so your repository is allowed to assume a role in your respective cloud provider.
Create GitHub Actions workflows that use the Atmos CLI, or make small changes to your existing workflows so Atmos Pro can dispatch them. At a minimum, you'll need four workflows:
- 1Affected Stacks — runs
atmos describe affected --uploadto notify Atmos Pro of changes. This triggers on pull requests and merge commits. - 2Upload Instances — syncs your stack instances with Atmos Pro. This should run anytime something is merged into the main branch and on a daily schedule.
- 3Plan — runs
atmos terraform planfor the affected components dispatched by Atmos Pro. - 4Apply — runs
atmos terraform applyfor the affected components dispatched by Atmos Pro.
Now that you've installed the Atmos Pro GitHub App and imported the repositories you'd like to use with Atmos Pro, you
can start using Atmos Pro to deploy your Atmos stacks. To learn more about Ordered Deployments, click the
Introduction
link below.Ready to get started?
You've completed the installation. Now, learn how it all works.