Atmos

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/atmos/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse/atmos/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/atmos.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/atmos/commits/main/"><img src="https://img.shields.io/github/last-commit/cloudposse/atmos/main?style=for-the-badge" alt="Last Updated"/></a><a href="https://github.com/cloudposse/atmos/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/cloudposse/atmos/test.yml?style=for-the-badge" alt="Tests"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

Atmos is a framework for orchestrating and operating infrastructure workflows across multiple cloud and DevOps toolchains.

Use Atmos to break your architecture into reusable Components that you implement using Terraform "root modules". Then tie everything together using Stack configurations defined in YAML.

Atmos can change how you think about the Terraform code you write to build your infrastructure. Atmos is a framework that simplifies complex cloud architectures and DevOps workflows into intuitive CLI commands. Its strength in managing DRY configurations at scale for Terraform and is supported by robust design patterns, comprehensive documentation, and a passionate community, making it a versatile tool for both startups and enterprises. Atmos is extensible to accommodate any tooling, including enterprise-scale Terraform, and includes custom policy controls, vendoring, and GitOps capabilities out of the box. Everything is open source and free.

[!TIP]

You can try out atmos directly in your browser using GitHub Codespaces

<i>Already start one? Find it here.</i>

Screenshots

<img src="docs/demo.gif" alt="Demo" /><br/>Example of running atmos to describe infrastructure.

Introduction

Atmos centralizes the DevOps chain and cloud automation/orchestration into a robust command-line tool, streamlining environments and workflows into straightforward CLI commands. Leveraging advanced hierarchical configurations, it efficiently orchestrates both local and CI/CD pipeline tasks, optimizing infrastructure management for engineers and cloud architects alike. You can then run the CLI anywhere, such as locally or in CI/CD.

The Atmos project consists of a command-line tool, a Go library, and even a terraform provider. It provides numerous conventions to help you provision, manage, and orchestrate workflows across various toolchains. You can even access the configurations natively from within terraform using our terraform-provider-utils.

Cloud Posse uses this tool extensively for automating cloud infrastructure with Terraform and Kubernetes, but it can be used to automate any complex workflow.

[!TIP]

Did you know?

By leveraging Atmos in conjunction with Cloud Posse's expertise in AWS, terraform blueprints, and our knowledgeable community, teams can achieve operational mastery and innovation faster, transforming their infrastructure management practices into a competitive advantage.

Core Features

Atmos streamlines Terraform orchestration, environment, and configuration management, offering developers and DevOps a set of powerful tools to tackle deployment challenges. Designed to be cloud agnostic, it enables you to operate consistently across various cloud platforms. These features boost efficiency, clarity, and control across various environments, making it an indispensable asset for managing complex infrastructures with confidence.

• Terminal UI Polished interface for easier interaction with Terraform, workflows, and commands.
• Native Terraform Support: Orchestration, backend generation, varfile generation, ensuring compatibility with vanilla Terraform.
• Stacks: Powerful abstraction layer defined in YAML for orchestrating and deploying components.
• Components: A generic abstraction for deployable units, such as Terraform "root" modules.
• Vendoring: Pulls dependencies from remote sources, supporting immutable infrastructure practices.
• Custom Commands: Extends Atmos's functionality, allowing integration of any command with stack configurations.
• Workflow Orchestration: Comprehensive support for managing the lifecycle of cloud infrastructure from initiation to maintenance.

See all features of Atmos.

Use Cases

Atmos has consistently demonstrated its effectiveness in addressing these key use-cases, showcasing its adaptability and strength in the cloud infrastructure and DevOps domains:

• Managing Large Multi-Account Cloud Environments: Suitable for organizations using multiple cloud accounts to separate different projects or stages of development.
• Cross-Platform Cloud Architectures: Ideal for businesses that need to manage configuration of services across AWS, GCP, Azure, etc., to build a cohesive system.
• Multi-Tenant Systems for SaaS: Perfect for SaaS companies looking to host multiple customers within a unified infrastructure. Simply define a baseline tenant configuration once, and then seamlessly onboard new tenants by reusing this baseline through pure configuration, bypassing the need for further code development.
• Efficient Multi-Region Deployments: Atmos facilitates streamlined multi-region deployments by enabling businesses to define baseline configurations with stacks and extend them across regions with DRY principles through imports and inheritance.
• Compliant Infrastructure for Regulated Industries: Atmos empowers DevOps and SecOps teams to create vetted configurations that comply with SOC2, HIPAA, HITRUST, PCI, and other regulatory standards. These configurations can then be efficiently shared and reused across the organization via service catalogs, component libraries, vendoring, and OPA policies, simplifying the process of achieving and maintaining rigorous compliance.
• Empowering Teams with Self-Service Infrastructure: Allows teams to manage their infrastructure needs independently, using predefined templates and policies.
• Streamlining Deployment with Service Catalogs, Landing Zones, and Blueprints: Provides ready-to-use templates and guidelines for setting up cloud environments quickly and consistently.

[!TIP] Don't see your use-case listed? Ask us in the #atmos Slack channel, or join us for "Office Hours" every week.

Moreover, atmos is not only a command-line interface for managing clouds and clusters. It provides many useful patterns and best practices, such as:

• Enforces a project structure convention, so everybody knows where to find things.
• Provides clear separation of configuration from code, so the same code is easily deployed to different regions, environments and stages
• It can be extended to include new features, commands, and workflows
• The commands have a clean, consistent and easy to understand syntax
• The CLI code is modular and self-documenting

Telemetry

Atmos collects anonymous telemetry to help improve the product by understanding how it's used.

You can opt-out of telemetry collection in either of the following ways:

• Set settings.telemetry.enabled: false in your atmos.yaml
• Or set the environment variable: ATMOS_TELEMETRY_ENABLED=false

Note for Atmos Pro users: If you’re using Atmos Pro, your workspace ID will be included in telemetry events. This allows our team to provide more effective support and assist with troubleshooting as part of your subscription.

To learn more about what is collected and how it works, see the Telemetry Documentation.

Documentation

Find all documentation at: atmos.tools

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse/atmos/graphs/contributors">