Skip to content

Commit 1f00b3f

Browse files
committed
docs: stop avoiding the word cluster
Tried to avoid using the word cluster in the docs so many times but it really doesn't make sense. Just embrace it and use it while making a note that its possible to use one cluster in place of multiple clusters.
1 parent 22e02e2 commit 1f00b3f

File tree

4 files changed

+14
-14
lines changed

4 files changed

+14
-14
lines changed

docs/deploy-guide/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The layout of this repo will be something like:
5757

5858
To get started, you'll need a Deploy Repository that you can commit to. This means you should have write access to this repository.
5959

60-
For the deployment tool, [ArgoCD](./argocd.md), you'll need to set up read-only credentials. This allows ArgoCD to fetch the necessary data without making any changes to your repository. One way to achieve this is by using [GitHub Deploy Keys][gh-deploy-keys] or similar solutions.
60+
For the deployment tool, [ArgoCD][argocd], you'll need to set up read-only credentials. This allows ArgoCD to fetch the necessary data without making any changes to your repository. One way to achieve this is by using [GitHub Deploy Keys][gh-deploy-keys] or similar solutions.
6161

6262
[GitHub Deploy Keys][gh-deploy-keys] will work.
6363

docs/deploy-guide/argocd.md renamed to docs/deploy-guide/management-cluster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# ArgoCD
1+
# Management Cluster
22

33
The deployment of all the services into your Kubernetes cluster is handled
44
by [ArgoCD][argocd]. The [System Division](./welcome.md#system-division)
5-
defines the location where [ArgoCD][argocd] runs as the __Management__ cluster.
5+
defines the location where [ArgoCD][argocd] runs as the __Management__ role.
66
While it is possible to run ArgoCD from the same cluster that your services
77
will run in, it is not advisable outside of a development setup. The
88
approach that UnderStack uses to deploy it's services with ArgoCD is the

docs/deploy-guide/welcome.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ with a production best practices installation. Improvements are always welcome.
1414

1515
## System Division
1616

17-
A fully deployed UnderStack is divided into three distinct parts, or tiers,
17+
A fully deployed UnderStack is divided into three distinct parts, or clusters,
1818
that are referred to in the documentation as:
1919

2020
- Management
@@ -30,19 +30,19 @@ flowchart TD
3030
B[Global] --> E[Site N];
3131
```
3232

33-
A fully functioning system only needs one _Management_ tier, one _Global_
34-
tier and one or more _Site_ tier(s). In this configuration,
35-
the _Management_ tier is responsible for utilizing our [GitOps][gitops]
36-
tool, [ArgoCD][argocd] to deploy the expected state to all other tier.
37-
While the _Global_ tier is
33+
A fully functioning system only needs one _Management_ cluster, one _Global_
34+
cluster and one or more _Site_ cluster(s). In this configuration,
35+
the _Management_ cluster is responsible for utilizing our [GitOps][gitops]
36+
tool, [ArgoCD][argocd] to deploy the expected state to all other clusters.
37+
While the _Global_ cluster is
3838
responsible for hosting any services that are expected to exist only once
3939
for a whole system deployment such as the DCIM/IPAM tool. While the _Site_
40-
tiers will run the tools and services that need to live close to the
40+
clusters will run the tools and services that need to live close to the
4141
actual hardware.
4242

43-
In fact, one _Management_ tier can control multiple _Global_ tiers
44-
and their associated _Site_ tiers. We call the grouping of the _Global_
45-
tier and it's associated _Site_ tiers a _partition_. An example
43+
In fact, one _Management_ cluster can control multiple _Global_ clusters
44+
and their associated _Site_ clusters. We call the grouping of the _Global_
45+
cluster and it's associated _Site_ clusters a _partition_. An example
4646
would be a staging partition and a production partition.
4747

4848
```mermaid

mkdocs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ nav:
121121
- deploy-guide/welcome.md
122122
- deploy-guide/getting-started.md
123123
- Quick Start: deploy-guide/gitops-install.md
124-
- deploy-guide/argocd.md
124+
- deploy-guide/management-cluster.md
125125
- deploy-guide/auth.md
126126
- deploy-guide/extra-sites.md
127127
- deploy-guide/add-remove-app.md

0 commit comments

Comments
 (0)