Atlas Examples

This repository contains application and infrastructure examples for Atlas by HashiCorp.

Examples

Setup

Examples should use common inputs and structures as much as possible. The most commonly used environment variables for the examples are listed and explained below.

Environment Variables

# For Atlas
ATLAS_TOKEN
ATLAS_USERNAME

# For AWS
AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY
AWS_DEFAULT_REGION

See the Environment variable article on Wikipedia for an explanation of how to set and use environment variables.

Atlas Variables

To generate an Atlas Token, visit your account page in Atlas.

Atlas Username can be either your personal username in Atlas (e.g., clstokes) or the name of the organization you belong to within Atlas (e.g., hashicorp).

Amazon Web Services Credentials

Visit the IAM Management Console and follow th instructions at Managing Access Keys for IAM Users.

Google Cloud Platform Credentials

Visit the Google Developers Console and follow the instructions at Service accounts.

Writing Examples

Pretty simple - create a folder named after the example. Add a README if setup is required, and add supporting files.

Please try to adhere to the above environment variables to keep projects consistent and easy to adopt.

Issues

To report issues (such as typographical errors or confusion) in these examples, please open a GitHub issue. For Atlas-specific support, please email [email protected].

Documentation

Additional documentation on Atlas, Vagrant, Packer, Terraform, and Consul can be read here.