From 615683e9b177ad0908b0cf856b8abb01163b3eec Mon Sep 17 00:00:00 2001 From: Nicholas Kuechler Date: Mon, 18 Nov 2024 12:30:39 -0600 Subject: [PATCH] chore: test building and deploying docs --- docs/component-argo-workflows.md | 4 ++-- docs/component-overview.md | 2 +- docs/component-understack-workflows.md | 6 +++--- docs/deploy-guide/auth.md | 2 +- docs/deploy-guide/external-argocd.md | 10 +++++----- docs/deploy-guide/extra-regions.md | 2 +- docs/deploy-guide/gitops-install.md | 2 +- docs/deploy-guide/index.md | 4 ++-- docs/vision.md | 2 +- mkdocs.yml | 4 ++-- 10 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/component-argo-workflows.md b/docs/component-argo-workflows.md index 8f330b97..ff83b0cd 100644 --- a/docs/component-argo-workflows.md +++ b/docs/component-argo-workflows.md @@ -1,7 +1,7 @@ # Argo Workflows [Argo Workflows][argo-workflows] was chosen as our workflow / orchestration service. It runs natively inside a -Kubernetes environment and easily integrates with [Argo Events][argo-events]. Understack will be deployed with the +Kubernetes environment and easily integrates with [Argo Events][argo-events]. UnderStack will be deployed with the set of WorkflowTemplates below. ## WorkflowTemplates @@ -16,7 +16,7 @@ set of WorkflowTemplates below. \* WorkflowTemplate which requires a manual / custom implementation. -As Understack develops, there may be underlying / dependant services which are not included, and require some of the +As UnderStack develops, there may be underlying / dependant services which are not included, and require some of the included WorkflowTemplates to be manually implemented to work in your environment. For example, the get-bmc-creds WorkflowTemplate will need to be written to communicate with whatever service you're using to store your device credentials. diff --git a/docs/component-overview.md b/docs/component-overview.md index 20350052..705e5e11 100644 --- a/docs/component-overview.md +++ b/docs/component-overview.md @@ -1,6 +1,6 @@ # Overview -Understack is deployed as a collection of multiple applications and/or tools which +UnderStack is deployed as a collection of multiple applications and/or tools which are referred to in the code base in different category groupings. Each of these groupings can themselves be multiple applications combined. diff --git a/docs/component-understack-workflows.md b/docs/component-understack-workflows.md index 8fb6c591..40a15a7e 100644 --- a/docs/component-understack-workflows.md +++ b/docs/component-understack-workflows.md @@ -1,6 +1,6 @@ -# Understack Workflows +# UnderStack Workflows -Understack Workflows is a collection of code, scripts, container definitions +UnderStack Workflows is a collection of code, scripts, container definitions centered around [Argo Workflows][argo-wf] and [Argo Events][argo-events] to drive automated operations based on events and other triggers in the system. @@ -10,7 +10,7 @@ drive automated operations based on events and other triggers in the system. [Argo Events][argo-events] is a Kubernetes-native event-driven automation framework. We can use Argo Events to trigger automations processes from any of the internal -Understack and external sources. +UnderStack and external sources. ## Kubernetes Resources diff --git a/docs/deploy-guide/auth.md b/docs/deploy-guide/auth.md index 568b27f5..816b948a 100644 --- a/docs/deploy-guide/auth.md +++ b/docs/deploy-guide/auth.md @@ -1,7 +1,7 @@ # Authentication and Authorization You must configure how users and operators will authenticate against the various services -provided by Understack. At this time [Dex IdP](https://dexidp.io) is used for all the +provided by UnderStack. At this time [Dex IdP](https://dexidp.io) is used for all the services and a connector must be configured to provide authentication. !!! warning Dex IdP Configuration Issue diff --git a/docs/deploy-guide/external-argocd.md b/docs/deploy-guide/external-argocd.md index 68a0caae..7134449b 100644 --- a/docs/deploy-guide/external-argocd.md +++ b/docs/deploy-guide/external-argocd.md @@ -45,18 +45,18 @@ Now we are ready to remove ArgoCD from our existing cluster. kubectl delete ns argocd ``` -You are now ready to deploy Understack in your external ArgoCD. +You are now ready to deploy UnderStack in your external ArgoCD. -## Deploying Understack in an external ArgoCD +## Deploying UnderStack in an external ArgoCD -If you did not have Understack already deployed with an ArgoCD in cluster +If you did not have UnderStack already deployed with an ArgoCD in cluster or you followed the removal steps above, you are ready for this section. -Firstly you must create a cluster configuration for the Understack +Firstly you must create a cluster configuration for the UnderStack [App of Apps][app-of-apps] which can be done by treating your setup like an [extra region](./extra-regions.md). Once you've created your cluster config and loaded it into your ArgoCD then you can load the -Understack [app-of-apps] into your ArgoCD with: +UnderStack [app-of-apps] into your ArgoCD with: ```bash kubectl -n argocd apply -f apps/app-of-apps.yaml diff --git a/docs/deploy-guide/extra-regions.md b/docs/deploy-guide/extra-regions.md index a4944e77..9d81c286 100644 --- a/docs/deploy-guide/extra-regions.md +++ b/docs/deploy-guide/extra-regions.md @@ -1,7 +1,7 @@ # Extra Regions To create extra regions the operation will be very similar to -creating the initial Understack deployment. +creating the initial UnderStack deployment. ## Getting the source diff --git a/docs/deploy-guide/gitops-install.md b/docs/deploy-guide/gitops-install.md index 28512317..c8b2b988 100644 --- a/docs/deploy-guide/gitops-install.md +++ b/docs/deploy-guide/gitops-install.md @@ -189,7 +189,7 @@ Finally run the following to have ArgoCD deploy the system: kubectl -n argocd apply -f apps/aio-app-of-apps.yaml ``` -At this point ArgoCD will work to deploy Understack. +At this point ArgoCD will work to deploy UnderStack. [gitops]: [app-of-apps]: diff --git a/docs/deploy-guide/index.md b/docs/deploy-guide/index.md index 6609d073..7c248feb 100644 --- a/docs/deploy-guide/index.md +++ b/docs/deploy-guide/index.md @@ -1,6 +1,6 @@ -# What is Understack? +# What is UnderStack? -Understack is a collection of open-source tools and technologies that provides +UnderStack is a collection of open-source tools and technologies that provides flexible, scalable, and cost-effective infrastructure management solution. The focus is on deploying bare metal in data centers with functional DCIM and IPAM. diff --git a/docs/vision.md b/docs/vision.md index 4d6fc2f0..7a0a1900 100644 --- a/docs/vision.md +++ b/docs/vision.md @@ -1,6 +1,6 @@ # Vision -Understack aims to provide an opinionated installation of OpenStack Ironic and related +UnderStack aims to provide an opinionated installation of OpenStack Ironic and related services to allow management of bare metal environments efficiently, rapidly, consistently and cost-effectively. ## Components diff --git a/mkdocs.yml b/mkdocs.yml index a061aee1..faae47d4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,7 @@ --- -site_name: Understack +site_name: UnderStack site_description: |- - Understack is a collection of open-source tools and technologies that provides + UnderStack is a collection of open-source tools and technologies that provides flexible, scalable, and cost-effective infrastructure management solution. The focus is on deploying bare metal in data centers with functional DCIM and IPAM.