Skip to content

Commit 5171917

Browse files
committed
docs: clarify installation instructions
1 parent ede4c41 commit 5171917

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ The tool has two halves:
1616
- Gitops Server - an instance of this gets deployed to each of your kubernetes clusters, listening on changes made to your gitops cluster repo. The server's responsibility is to update the deployments on the cluster it lives on to match the app specifications in the repo.
1717
- Gitops CLI - this is a tool that you can use to interact comfortably with your cluster repo. It allows listing all deployed applications, what images they're presently running on, and which clusters they live on. It also provides numerous operations that can be applied to one or more apps at a time, such as bumping to a newer version of an image, or running a particular command across your app cohort.
1818

19-
You can install the CLI tool with: `pip install gitops`
2019

2120
Currently Kubernetes/Helm is the only supported cluster interface. All app deployments are performed as applications of Helm charts.
2221

@@ -36,13 +35,17 @@ This is a git repository that you set up, where you list out all of your applica
3635
+- jobs
3736
</pre>
3837

39-
## Installation
38+
## Gitops CLI Installation
4039

41-
Secrets should be placed in `secrets.env`. The example file `secrets.example.env` has the environment variables you will need to supply.
40+
1. Install the CLI tool with: `uv tool install gitops` and upgrade it with `uv tool upgrade gitops`.
41+
42+
2. Set up the environment variable `GITOPS_APPS_DIRECTORY` to invoke gitops from any directory.
4243

43-
Add `export GITOPS_APPS_DIRECTORY=~/<cluster-apps-folder>` to invoke gitops from any directory.
44+
## Gitops Server Installation
45+
46+
Secrets should be placed in `secrets.env`. The example file `secrets.example.env` has the environment variables you will need to supply.
4447

45-
Ensure that gitops has `edit` access to the namespace it is deploying to. An example RoleBinding is:
48+
Ensure that the gitops service account has `edit` access to the namespace it is deploying to. An example RoleBinding is:
4649

4750
```
4851
apiVersion: rbac.authorization.k8s.io/v1

0 commit comments

Comments
 (0)