mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-30 23:38:13 +02:00
Renamed cymais to infinito and did some other optimations and logout implementations
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
## 📖 CyMaIS.Cloud Ansible & Python Directory Guide
|
||||
## 📖 Infinito.Nexus Ansible & Python Directory Guide
|
||||
|
||||
This document provides a **decision matrix** for when to use each default Ansible plugin and module directory in the context of **CyMaIS.Cloud development** with Ansible and Python. It links to official docs, explains use-cases, and points back to our conversation.
|
||||
This document provides a **decision matrix** for when to use each default Ansible plugin and module directory in the context of **Infinito.Nexus development** with Ansible and Python. It links to official docs, explains use-cases, and points back to our conversation.
|
||||
|
||||
---
|
||||
|
||||
@@ -31,12 +31,12 @@ ansible-repo/
|
||||
|
||||
### 🎯 Decision Matrix: Which Folder for What?
|
||||
|
||||
| Folder | Type | Use-Case | Example (CyMaIS.Cloud) | Emoji |
|
||||
| Folder | Type | Use-Case | Example (Infinito.Nexus) | Emoji |
|
||||
| -------------------- | -------------------- | ---------------------------------------- | ----------------------------------------------------- | ----- |
|
||||
| `library/` | **Module** | Write idempotent actions | `cloud_network.py`: manage VPCs, subnets | 📦 |
|
||||
| `filter_plugins/` | **Filter plugin** | Jinja2 data transforms in templates/vars | `to_camel_case.py`: convert keys for API calls | 🔍 |
|
||||
| `lookup_plugins/` | **Lookup plugin** | Fetch external/secure data at runtime | `vault_lookup.py`: pull secrets from CyMaIS Vault | 👉 |
|
||||
| `module_utils/` | **Utility library** | Shared Python code for modules | `cymais_client.py`: common API client base class | 🛠️ |
|
||||
| `lookup_plugins/` | **Lookup plugin** | Fetch external/secure data at runtime | `vault_lookup.py`: pull secrets from Infinito.Nexus Vault | 👉 |
|
||||
| `module_utils/` | **Utility library** | Shared Python code for modules | `infinito_client.py`: common API client base class | 🛠️ |
|
||||
| `action_plugins/` | **Action plugin** | Complex task orchestration wrappers | `deploy_stack.py`: sequence Terraform + Ansible steps | ⚙️ |
|
||||
| `callback_plugins/` | **Callback plugin** | Customize log/report behavior | `notify_slack.py`: send playbook status to Slack | 📣 |
|
||||
| `inventory_plugins/` | **Inventory plugin** | Dynamic host/group sources | `azure_inventory.py`: list hosts from Azure tags | 🌐 |
|
||||
@@ -96,15 +96,15 @@ ansible-repo/
|
||||
|
||||
---
|
||||
|
||||
### 🚀 CyMaIS.Cloud Best Practices
|
||||
### 🚀 Infinito.Nexus Best Practices
|
||||
|
||||
* **Organize modules** by service under `library/cloud/` (e.g., `vm`, `network`, `storage`).
|
||||
* **Shared client code** in `module_utils/cymais/` for authentication, request handling.
|
||||
* **Secrets lookup** via `lookup_plugins/vault_lookup.py` pointing to CyMaIS Vault.
|
||||
* **Shared client code** in `module_utils/infinito/` for authentication, request handling.
|
||||
* **Secrets lookup** via `lookup_plugins/vault_lookup.py` pointing to Infinito.Nexus Vault.
|
||||
* **Filters** to normalize data formats from cloud APIs (e.g., `snake_to_camel`).
|
||||
* **Callbacks** to stream playbook results into CyMaIS Monitoring.
|
||||
* **Callbacks** to stream playbook results into Infinito.Nexus Monitoring.
|
||||
|
||||
Use this matrix as your **single source of truth** when extending Ansible for CyMaIS.Cloud! 👍
|
||||
Use this matrix as your **single source of truth** when extending Ansible for Infinito.Nexus! 👍
|
||||
|
||||
---
|
||||
|
||||
|
@@ -1,11 +1,11 @@
|
||||
Developer Guide
|
||||
===============
|
||||
|
||||
Welcome to the **CyMaIS Developer Guide**! This guide provides essential information for developers who want to contribute to the CyMaIS open-source project.
|
||||
Welcome to the **Infinito.Nexus Developer Guide**! This guide provides essential information for developers who want to contribute to the Infinito.Nexus open-source project.
|
||||
|
||||
Explore CyMaIS Solutions
|
||||
Explore Infinito.Nexus Solutions
|
||||
------------------------
|
||||
CyMaIS offers various solutions for IT infrastructure automation. Learn more about the available applications:
|
||||
Infinito.Nexus offers various solutions for IT infrastructure automation. Learn more about the available applications:
|
||||
|
||||
- :doc:`../../../roles/application_glosar`
|
||||
- :doc:`../../../roles/application_categories`
|
||||
@@ -16,21 +16,21 @@ For Developers
|
||||
Understanding Ansible Roles
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
CyMaIS is powered by **Ansible** roles to automate deployments. Developers can explore the technical details of our roles here:
|
||||
Infinito.Nexus is powered by **Ansible** roles to automate deployments. Developers can explore the technical details of our roles here:
|
||||
|
||||
- :doc:`../../../roles/ansible_role_glosar`
|
||||
|
||||
Contributing to CyMaIS
|
||||
Contributing to Infinito.Nexus
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Want to contribute to the project or explore the source code? Check out our **GitHub repository**:
|
||||
|
||||
- `CyMaIS GitHub Repository <https://github.com/kevinveenbirkenbach/cymais/tree/master/roles>`_
|
||||
- `Infinito.Nexus GitHub Repository <https://github.com/kevinveenbirkenbach/infinito-nexus/tree/master/roles>`_
|
||||
|
||||
Contribution Guidelines
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
1. **Fork the Repository** – Start by forking the CyMaIS repository.
|
||||
1. **Fork the Repository** – Start by forking the Infinito.Nexus repository.
|
||||
2. **Create a New Branch** – Make changes in a dedicated branch.
|
||||
3. **Follow Coding Standards** – Ensure your code is well-documented and follows best practices.
|
||||
4. **Submit a Pull Request** – Once your changes are tested, submit a PR for review.
|
||||
@@ -42,12 +42,12 @@ For detailed guidelines, refer to:
|
||||
|
||||
Community & Support
|
||||
-------------------
|
||||
If you have questions or need help, visit the **CyMaIS Information Hub**:
|
||||
If you have questions or need help, visit the **Infinito.Nexus Information Hub**:
|
||||
|
||||
- `hub.cymais.cloud <https://hub.cymais.cloud>`_
|
||||
- `hub.infinito.nexus <https://hub.infinito.nexus>`_
|
||||
|
||||
This is the best place to ask questions, get support, and collaborate with other contributors.
|
||||
|
||||
Stay connected, collaborate, and help improve CyMaIS together!
|
||||
Stay connected, collaborate, and help improve Infinito.Nexus together!
|
||||
|
||||
Happy coding! 🚀
|
Reference in New Issue
Block a user