Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 6.41 KB

README.md

File metadata and controls

71 lines (52 loc) · 6.41 KB
Raw

GitOps Bridge

The GitOps Bridge is a community project that aims to showcase best practices and patterns for bridging the process of creating a Kubernetes cluster to subsequently managing everything through GitOps. It focuses on using ArgoCD or FluxCD, both of which are CNCF-graduated projects.

For an example template on bootstrapping ArgoCD, see the GitHub repository GitOps Control Plane.

There are many tools available for creating Kubernetes clusters. These include "roll-your-own" solutions like kubeadm, minikube, and kind, as well as cloud-managed services like Amazon EKS. The method of cluster creation should not impact GitOps compatibility; GitOps engines should work with any tool that the user chooses for cluster creation. This includes scenarios where Kubernetes is used to create other Kubernetes clusters, such as with CAPI/CAPA, Crossplane, ACK, or any tool running inside Kubernetes to deploy Kubernetes.

The GitOps Bridge becomes extremely important in the context of cloud-managed Kubernetes clusters, as these clusters often have integrations with cloud services. When using GitOps to install a tool in such cases, the tool—usually configured via Helm—needs to be set up with metadata about resources or workload identities (like IAM). This metadata is often available as a result of running an Infrastructure as Code (IaC) tool such as Terraform, CloudFormation, or a cloud CLI. The GitOps Bridge provides patterns for bridging this metadata to GitOps, using features specific to the GitOps engine in use.

The GitOps Bridge should also be compatible with GitOps engines that run as SaaS and are not installed inside the cluster, such as the Akuity Platform, CodeFresh, Weaveworks, and others.

The GitOps Bridge Pattern enables Kubernetes administrators to utilize Infrastructure as Code (IaC) and GitOps tools for deploying Kubernetes Addons and Workloads. Addons often depend on Cloud resources that are external to the cluster. The configuration metadata for these external resources is required by the Addons' Helm charts. While IaC is used to create these cloud resources, it is not used to install the Helm charts. Instead, the IaC tool stores this metadata either within GitOps resources in the cluster or in a Git repository. The GitOps tool then extracts these metadata values and passes them to the Helm chart during the Addon installation process. This mechanism forms the bridge between IaC and GitOps, hence the term "GitOps Bridge."

Try out the Getting Started example.

Additional examples available on the GitOps Bridge Pattern:

ArgoCD

This git repository contains the files on how to create the Kubernete Clusters and how to bridge the metadata to the GitOps engine, there is an additiona git repository GitOps Control Plane that contains the ArgoCD App of Apps to bootstrap and manage the Application Sets for the clusters intended to be use as template to get started.

Terraform and GitOps Bridge:

  • Terraform has providers for helm and kubernetes, the problem with these providers is that terraform is design to have control over the state of the Kubernetes resources, any changes to these resources outside Terraform for example using kubectl or GitOps (ie ArgoCD, FluxCD) would create problems in terraform state.

ArgoCD Status

IaC GitOps Status
Terraform ArgoCD Stable try it!
EKSCTL ArgoCD
CDK ArgoCD
Crossplane ArgoCD
CAPI ArgoCD
Pulumi ArgoCD

FluxCD Status

IaC GitOps Status
Terraform FluxCD In Progress
EKSCTL FluxCD
CDK FluxCD
Crossplane FluxCD
CAPI FluxCD
Pulumi FluxCD

Researched Resources: