Skip to main content

Gitops

PyPI version versions Test Lint

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

  1. Install the CLI tool with: uv tool install gitops and upgrade it with uv tool upgrade gitops.

  2. Set up the environment variable GITOPS_APPS_DIRECTORY to 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:

  1. Checkout a feature branch and make the changes
    1. Make sure to follow instructions for writing commits by releaseplease
      1. fix: which represents bug fixes, and correlates to a SemVer patch.
      2. feat: which represents a new feature, and correlates to a SemVer minor.
      3. feat!:, or fix!:, refactor!:, etc., which represent a breaking change (indicated by the !) and will result in a SemVer major.
  2. Push changes and get the PR approved
  3. 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

gitops-1.6.2.tar.gz (132.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitops-1.6.2-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

Details for the file gitops-1.6.2.tar.gz.

File metadata

  • Download URL: gitops-1.6.2.tar.gz
  • Upload date:
  • Size: 132.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gitops-1.6.2.tar.gz
Algorithm Hash digest
SHA256 afed50109c05d7162cb5c4c06781508cd265e2b2f9f69f3cbb85de15fbd6fa58
MD5 18663e1690856b0a7f7c7be849382ebb
BLAKE2b-256 ad99f9d75ac1877d7e07e267de5d6c2c98135f37731875319863c26af33b6604

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitops-1.6.2.tar.gz:

Publisher: release-please.yaml on uptick/gitops

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gitops-1.6.2-py3-none-any.whl.

File metadata

  • Download URL: gitops-1.6.2-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

Hashes for gitops-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8768666f941fad6c162224bf4c9541284b1add27b69f0423ee894120aa5931ae
MD5 e4f4af4faeddeaeccc52357e93b596c6
BLAKE2b-256 82a2d3868536437eb28902014134e82e2418ac487c97555ac0dbbd57b7894179

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitops-1.6.2-py3-none-any.whl:

Publisher: release-please.yaml on uptick/gitops

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page