Gitops
Manage multiple apps across one or more k8s clusters.
Overview
Keeping track of numerous of single-tenanted application deployments can quickly become a handful. Enter Gitops!
The tool has two halves:
- 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.
- 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.
Currently Kubernetes/Helm is the only supported cluster interface. All app deployments are performed as applications of Helm charts.
So what's a "cluster repo"?
This is a git repository that you set up, where you list out all of your applications and how you want them deployed. It looks like this:
.
+- apps
+- app_0
+- deployment.yml
+- secrets.yml
+- app_1
+- deployment.yml
+- secrets.yml
+- jobs
Gitops CLI Installation
-
Install the CLI tool with:
uv tool install gitopsand upgrade it withuv tool upgrade gitops. -
Set up the environment variable
GITOPS_APPS_DIRECTORYto invoke gitops from any directory.
Gitops Server Installation
Secrets should be placed in secrets.env. The example file secrets.example.env has the environment variables you will need to supply.
Ensure that the gitops service account has edit access to the namespace it is deploying to. An example RoleBinding is:
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: gitops-role-binding
namespace: workforce
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: edit
subjects:
- kind: ServiceAccount
name: default
namespace: gitops
Contribution
We're using releaseplease, to publish a new version do the following:
- Checkout a feature branch and make the changes
- Make sure to follow instructions for writing commits by releaseplease
- fix: which represents bug fixes, and correlates to a SemVer patch.
- feat: which represents a new feature, and correlates to a SemVer minor.
- feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.
- Make sure to follow instructions for writing commits by releaseplease
- Push changes and get the PR approved
- Once it is merged; an additional PR containing the release changes needs to be merged to create a release.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gitops-1.6.3.tar.gz.
File metadata
- Download URL: gitops-1.6.3.tar.gz
- Upload date:
- Size: 133.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4bdd43e1057b44db200d56ce66acddc24fc091dbc2e0272d0be041e373d9ae2
|
|
| MD5 |
28f7c8a81510419db48737bd5084649d
|
|
| BLAKE2b-256 |
19747718b8622b347e6f627a8c5c16a28813e4aeed5c82a1959c101742244b77
|
Provenance
The following attestation bundles were made for gitops-1.6.3.tar.gz:
Publisher:
release-please.yaml on uptick/gitops
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gitops-1.6.3.tar.gz -
Subject digest:
c4bdd43e1057b44db200d56ce66acddc24fc091dbc2e0272d0be041e373d9ae2 - Sigstore transparency entry: 2363555943
- Sigstore integration time:
-
Permalink:
uptick/gitops@903213ce32fc3e05bb884aacff63b516c001160a -
Branch / Tag:
refs/heads/develop - Owner: https://github.com/uptick
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-please.yaml@903213ce32fc3e05bb884aacff63b516c001160a -
Trigger Event:
push
-
Statement type:
File details
Details for the file gitops-1.6.3-py3-none-any.whl.
File metadata
- Download URL: gitops-1.6.3-py3-none-any.whl
- Upload date:
- Size: 25.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2739416bf625ea43a9a5261e359a5ee0b3bb92b4aae29f74793b351674e522f3
|
|
| MD5 |
6666c687473ddd7a5f22ec5ad87e6d6f
|
|
| BLAKE2b-256 |
d7b09e03f74af1807c5fb9bccee3ca26267fae0c29a88159c19a765b493b8abe
|
Provenance
The following attestation bundles were made for gitops-1.6.3-py3-none-any.whl:
Publisher:
release-please.yaml on uptick/gitops
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gitops-1.6.3-py3-none-any.whl -
Subject digest:
2739416bf625ea43a9a5261e359a5ee0b3bb92b4aae29f74793b351674e522f3 - Sigstore transparency entry: 2363556026
- Sigstore integration time:
-
Permalink:
uptick/gitops@903213ce32fc3e05bb884aacff63b516c001160a -
Branch / Tag:
refs/heads/develop - Owner: https://github.com/uptick
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-please.yaml@903213ce32fc3e05bb884aacff63b516c001160a -
Trigger Event:
push
-
Statement type:
