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.
Sign Up
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://app.cloudposse.com and clicking the "Continue with Github" button.
Now that 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
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.
Joining a Workspace
When you login for the first time, if you're already a member of a workspace you'll automatically be taken to a screen that allows you to select which workspace you want to currently use.
Creating a 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.
Working with Multiple Workspaces
Within the Atmos Pro application, you can be a member of an unlimited number of workspaces, but you can only work with
one workspace at a time. To switch between workspaces, click on your avitar icon in the top right corner of the
application and choose Switch Workspace
. Once you've selected a workspace, you'll stay within that workspace until
you switch to another workspace, even across login sessions.
Install the Atmos Pro GitHub App
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.
Installation by Github Administrators
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.
Installation by Non-Administratiors
If you aren't an administrator of the Github organization that owns the repositories you'd like to use with Atmos Pro,
you can request that an administrator approve the Atmos Pro GitHub App by clicking the Authorize and Request
button
after selecting the subset of repositories you'd like to use with Atmos Pro.
Import Repositories
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 to 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 to option to add more repositories at any time from the
repositories screen within the Atmos Pro application.
Next Steps
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 lean more about Ordered Deployments, click the Introduction
link below.