atmos

command module
v1.54.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 14, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

README ΒΆ

atmos Latest Release Slack Community

atmos

atmos - Universal Tool for DevOps and Cloud Automation.

Screenshots

Demo
Example of running atmos to describe infrastructure.


[!NOTE] This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

README Header

Introduction

Atmos is a workflow automation tool. Atmos is lets you take a complex workflow and turn it into a parameterized CLI. 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 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.

Common Use-cases

atmos includes workflows for dealing with:

  • Provision large, multi-accountTerraform environments
  • Deploy helm charts to Kubernetes clusters with helmfile
  • Execute helm commands on Kubernetes clusters
  • Executing kubectl commands on Kubernetes clusters

Here are some other ways you can extend atmos:

  • Running AWS CDK constructs to define cloud resources
  • Executing commands for the serverless framework
  • Executing shell commands
  • Combining various commands into workflows to execute many commands sequentially in just one step
  • ... and many more

In essence, it's a tool that orchestrates the other CLI tools in a consistent and self-explaining manner.

It's a superset of all other tools and task runners (e.g. make, terragrunt, terraform, aws cli, gcloud, etc.) and is intended to be used to tie everything together, so you can provide a simple CLI interface for your developers.

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

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:

πŸ› Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

πŸ’» Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

πŸ“° Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

πŸ“† Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

About

This project is maintained and funded by Cloud Posse, LLC.

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Learn More

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

  • Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
  • Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
  • Site Reliability Engineering. You'll have total visibility into your apps and microservices.
  • Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
  • GitOps. You'll be able to operate your infrastructure via Pull Requests.
  • Training. You'll receive hands-on training so your team can operate what we build.
  • Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
  • Troubleshooting. You'll get help to triage when things aren't working.
  • Code Reviews. You'll receive constructive feedback on Pull Requests.
  • Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

README Commercial Support

License

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

Copyright Β© 2017-2024 Cloud Posse, LLC README Footer Beacon

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis
internal
pkg
aws

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL