Skip to content

Commit 638ec14

Browse files
committed
docs: detail the creation of deploy repo
Add details on the creation of the Deployment Repository.
1 parent 1f00b3f commit 638ec14

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

docs/deploy-guide/getting-started.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ be consumed by different tools. It is recommended that one Deploy Repository
2121
is used per Management tier, see [Introduction](./welcome.md) for information
2222
on what this is.
2323

24+
### Layout
25+
2426
The layout of this repo will be something like:
2527

2628
```shell
@@ -53,13 +55,23 @@ The layout of this repo will be something like:
5355
7. The definitions of the hardware flavors that this cluster, which later you will see maps to a site. Notice it is different than staging.
5456
8. The cluster labeled as `global-prod` will have resources consumed here.
5557

56-
### Deploy repository permissions
58+
### Creation and Access
5759

58-
To get started, you'll need a Deploy Repository that you can commit to. This means you should have write access to this repository.
60+
To effectively utilize [GitOps][gitops] we will need a Deploy Repository.
5961

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.
62+
```bash
63+
# create my-deploy locally
64+
git init my-deploy
65+
# or clone one down
66+
git clone https://url/to/my-deploy
67+
```
6168

62-
[GitHub Deploy Keys][gh-deploy-keys] will work.
69+
This will need to be hosted somewhere that your ArgoCD instance in your
70+
Management Cluster will be able to access it. For ArgoCD, you will need
71+
to set up read-only credentials. This allows ArgoCD to fetch the
72+
necessary data being able to making any changes to your repository.
73+
One way to achieve this is by using [GitHub Deploy Keys][gh-deploy-keys]
74+
or check the [ArgoCD][argocd] documentation for other methods.
6375

6476
## UnderStack Repository
6577

docs/deploy-guide/gitops-install.md

+2
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ git init uc-deploy
2929
git clone https://path/to/my/uc-deploy
3030
```
3131

32+
See [Deployment Repository](./getting-started.md#creation-and-access)
33+
3234
## Pre-deployment
3335

3436
Embracing GitOps and declarative configuration, we will define three

0 commit comments

Comments
 (0)