diff --git a/README.md b/README.md index e9c79c7..f87be2d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ -# Ansible Collection - ednz_cloud.hashistack +# 🚀 hashistack-ansible Collection -THIS REPOSITORY IS A WORK IN PROGRESS, IT IS NOWHERE NEAR FIT FOR PRODUCTION. +![Ansible Badge](https://img.shields.io/badge/Ansible-E00?logo=ansible&logoColor=fff&style=for-the-badge) +![HashiCorp Badge](https://img.shields.io/badge/HashiCorp-000?logo=hashicorp&logoColor=fff&style=for-the-badge) +![Nomad Badge](https://img.shields.io/badge/Nomad-00CA8E?logo=nomad&logoColor=fff&style=for-the-badge) +![Vault Badge](https://img.shields.io/badge/Vault-FFEC6E?logo=vault&logoColor=000&style=for-the-badge) +![Consul Badge](https://img.shields.io/badge/Consul-F24C53?logo=consul&logoColor=fff&style=for-the-badge) + +Welcome to hashistack-ansible! This Ansible collection is your one-stop solution for deploying and managing HashiCorp product clusters with ease. Whether you're setting up Vault, Consul, or Nomad, this collection automates the entire process, allowing you to focus on building and scaling your infrastructure without the hassle. Let's dive into what this collection offers! 🌟 + +## 🎯 Features + +### 🔧 Deploy from Scratch + +Set up a fully integrated HashiStack environment with Vault, Consul, and Nomad from the ground up. Our playbooks ensure seamless integration between these services, enabling you to hit the ground running without manual setup. + +### 🎯 Targeted and Global Updates + +Update specific parts of your infrastructure using tags to target individual components or perform global updates to keep your entire stack in sync. This flexibility ensures minimal downtime and smooth rollouts. + + +### 🔐 Comprehensive Certificate Authority Management + +Easily manage your cluster's certificates with playbooks that handle the creation, renewal, and distribution of certificates across your infrastructure. This includes Root CAs, intermediates, and service-specific leaf certificates, ensuring secure communication throughout your environment. + +### 🔄 Rolling Updates for High Availability + +Perform control plane upgrades with rolling updates, ensuring that your services stay online and available during the upgrade process. This minimizes risk and maximizes uptime. + +## 🛠️ How to Get Started + +1. Install the Collection: + + ```shell + ansible-galaxy collection install ednz_cloud.hashistack:== + ``` + +2. Head to the [Quick-Start Guide](https://git.ednz.fr/ansible-collections/hashistack/wiki/quick_start) + + You'll get + +## 🧑‍💻 Contributions & Feedback + +We welcome contributions and feedback! If you encounter any issues or have suggestions for improvement, feel free to open an issue or submit a pull request. Let's make hashistack-ansible even better together! 🤝 + +## 📄 License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.