From f8b0687c926a5d293979e263f8fa9317c8c9d50d Mon Sep 17 00:00:00 2001 From: Baptiste Date: Wed, 4 Dec 2024 10:35:24 +0100 Subject: [PATCH] Review the overview --- docs/docs/overview/generators.mdx | 2 +- docs/docs/overview/integrations.mdx | 10 +++++----- docs/docs/overview/schema.mdx | 1 + docs/docs/overview/versioning.mdx | 4 ++-- docs/docs/topics/infrahub-yml.mdx | 2 +- 5 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/docs/overview/generators.mdx b/docs/docs/overview/generators.mdx index cee05417c9..261dad4665 100644 --- a/docs/docs/overview/generators.mdx +++ b/docs/docs/overview/generators.mdx @@ -19,7 +19,7 @@ Key aspects of generators include: 5. Customization: While based on templates, generators allow for significant customization to meet specific project requirements. -6. Versioning: InfraHub supports versioning of generator outputs, enabling users to track changes over time. +6. Versioning: Infrahub supports versioning of generator outputs, enabling users to track changes over time. 7. Integration: Generators can be integrated into workflows and CI/CD pipelines for automated infrastructure provisioning. diff --git a/docs/docs/overview/integrations.mdx b/docs/docs/overview/integrations.mdx index a79779d29e..361fbed1cb 100644 --- a/docs/docs/overview/integrations.mdx +++ b/docs/docs/overview/integrations.mdx @@ -7,21 +7,21 @@ import ReferenceLink from "../../src/components/Card"; Infrahub offers robust integrations with both Ansible and Nornir, which facilitate the automation and management of infrastructure tasks. -These integrations enhance the capabilities of Infrahub by enabling it to serve as a central source of truth for infrastructure data while leveraging the powerful automation frameworks of Ansible and Nornir. This makes it easier to manage and automate infrastructure tasks efficiently and accurately. +These integrations elevate Infrahub's functionality, transforming it into a centralized source of truth for infrastructure data while leveraging the robust automation capabilities of Ansible and Nornir. This streamlines the management and automation of infrastructure tasks, ensuring both efficiency and precision. ## Ansible integration -The Ansible integration with Infrahub is provided through the `opsmill.infrahub` Ansible Collection. This integration allows Infrahub to be used as an inventory source for Ansible, enabling dynamic and automated management of infrastructure based on data stored in Infrahub. +This integration is provided through the `opsmill.infrahub` Ansible Collection. It allows Infrahub to be used as a dynamic inventory source for Ansible, enabling management of infrastructure based on data stored in Infrahub. ## Nornir integration -Nornir is a Python-based automation framework primarily used for network automation. The Nornir plugin for Infrahub allows it to be used as an inventory source for Nornir, offering a seamless way to manage network devices and configurations. +Nornir is a Python-based automation framework primarily used for network automation. The Infrahub plugin for Nornir enables Infrahub to serve as an inventory source, providing a streamlined solution for managing network devices and configurations. ## Key features -- **Inventory Management**: Infrahub can dynamically generate and update inventories for Ansible playbooks and Nornir, ensuring that the latest state of infrastructure is always used. +- **Inventory Management**: Infrahub can dynamically generate and update inventories for Ansible and Nornir, ensuring that the latest state of infrastructure is always used. - **Automation**: By leveraging each framework's automation capabilities, users can execute complex infrastructure management tasks directly from Infrahub data. -- **Configuration Deployment**: This integration ensures that configurations managed by Infrahub are consistent across the infrastructure by applying them through Ansible playbooks or Nornir. +- **Configuration Deployment**: These integrations ensure that configurations managed by Infrahub are consistent across the infrastructure by applying them through Ansible or Nornir. ## More information diff --git a/docs/docs/overview/schema.mdx b/docs/docs/overview/schema.mdx index 189c089a0d..3aa126581f 100644 --- a/docs/docs/overview/schema.mdx +++ b/docs/docs/overview/schema.mdx @@ -16,6 +16,7 @@ A new deployment of Infrahub will have no schema by default. It is up to the adm Example schemas can be found: +- In the [Schema Library](https://github.com/opsmill/schema-library), this is the most comprehensive collection of schemas currently maintained by the community and OpsMill. - In the `models` directory of the [Infrahub repository](https://github.com/opsmill/infrahub/tree/develop/models) - In other OpsMill-provided [demo repositories](https://github.com/opsmill?q=demo&type=all&language=&sort=) - Via the Infrahub community diff --git a/docs/docs/overview/versioning.mdx b/docs/docs/overview/versioning.mdx index afd244148e..1bf02a5615 100644 --- a/docs/docs/overview/versioning.mdx +++ b/docs/docs/overview/versioning.mdx @@ -11,9 +11,9 @@ Infrahub integrates version control directly into its graph database, providing ## Branching and merging -Branches Infrahub allows you to create branches from the main data state. Each branch can contain modifications and is isolated from the main branch until changes are reviewed and merged. Branches can be created through the UI, CLI (`infrahubctl`), or GraphQL mutations. +Infrahub allows you to create branches from the main data state. Each branch can contain modifications and is isolated from the main branch until changes are reviewed and merged. Branches can be created through the UI, CLI (`infrahubctl`), or GraphQL mutations. -Merging changes from branches can be merged back into the main branch after review. Infrahub provides tools for viewing differences (diffs) between branches, running tests, and resolving conflicts before merging. +Changes from branches can be merged back into the main branch after review. Infrahub provides tools for viewing differences (diffs) between branches, running tests, and resolving conflicts before merging. ## Proposed changes diff --git a/docs/docs/topics/infrahub-yml.mdx b/docs/docs/topics/infrahub-yml.mdx index 99b2c936ee..bb9f813347 100644 --- a/docs/docs/topics/infrahub-yml.mdx +++ b/docs/docs/topics/infrahub-yml.mdx @@ -4,7 +4,7 @@ title: .infrahub.yml file format # `.infrahub.yml` file {#infrahub-yaml} -To make full use of a [remote repository](/topics/repository) within Infrahub, the remote repository must have a `.infrahub.yml` file defined at the root of the repository. Without this file, Infrahub will only load GraphQL queries (`.gql` extension) defined within the repository and it will ignore any other Infrahub data types. +To make full use of a [remote repository](/topics/repository) within Infrahub, the remote repository must have a `.infrahub.yml` file defined at the root of the repository. This file enables Infrahub to identify the required imports and tie together the various components. An external repository can be used to link the following Infrahub objects to an Infrahub instance: