Skip to main content

Manage multiple apps across one or more k8s clusters.

Project description

GitOps

PyPI version versions Test Lint

Manage multiple apps across one or more k8s clusters.

Overview

Using CI/CD for applications is a wonderful technique to ease the pain of DevOps,wouldn't it be nice to apply the same workflow to cluster provisioning?

GitOps is a two-part system. A library of commands is used to manage a single-tenanted cluster within a git repository, and the server component watches the repository and provisions the calculated changes.

Currently Kubernetes/Helm is the only supported cluster interface. All changes to the cluster are performed as applications of Helm charts.

Installation

Secrets should be placed in secrets.env. The example file secrets.example.env has the environment variables you will need to supply.

Gitops has a helm chart defining its deployment. Invoke scripts are provided to make deployment painless. See tasks.py.

Add export GITOPS_APPS_DIRECTORY=~/<cluster-apps-folder> to invoke gitops from any directory.

Ensure that gitops 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

Roadmap

  • Handle failure on initial application deployment.
  • Better error reporting on failures.
  • Forced redeployment interface.
  • Make kubernetes specific code modular so that we can start to support multiple deployment methods.
  • Invoke commands and other tools should be extracted from the uptick-cluster repo, added here and packaged up. Package should create /usr/bin/gitops to act as a CLI interface. Convert invoke commands to this new interface.
  • Add a command to create a template cluster repo (ala uptick-cluster) and give instructions to push it up and set up a webhook.

Developer experience should look something like:

pip install gitops
gitops create-repository
    -> Creates cluster repo (maybe with examples?)
    -> Explains or pushes repo up somewhere.
    -> Explains or sets up a webhook on that repo.
gitops create-secrets
    -> Either downloads secrets from AWS using awscli or
    -> Prompts for each secret individually.
gitops deploy-server
    -> helm upgrade gitops chart... (see tasks.py:deploy)
# Use as normal anywhere you want (like uptick-cluster invoke scripts)
gitops summary
gitops bump```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for gitops, version 0.5.0
Filename, size File type Python version Upload date Hashes
Filename, size gitops-0.5.0-py3-none-any.whl (23.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size gitops-0.5.0.tar.gz (20.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page