Skip to content

Commit

Permalink
chore: test building and deploying docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholaskuechler committed Nov 18, 2024
1 parent 4dea9bb commit 615683e
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/component-argo-workflows.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/component-overview.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/component-understack-workflows.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/deploy-guide/auth.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/deploy-guide/external-argocd.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/deploy-guide/extra-regions.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/deploy-guide/gitops-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]: <https://about.gitlab.com/topics/gitops/>
[app-of-apps]: <https://argo-cd.readthedocs.io/en/stable/operator-manual/cluster-bootstrapping/>
Expand Down
4 changes: 2 additions & 2 deletions docs/deploy-guide/index.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/vision.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 615683e

Please sign in to comment.