From 5648f9b3967461fe976635c9f287e176887f4ee1 Mon Sep 17 00:00:00 2001 From: Devin Stein Date: Mon, 9 Dec 2019 11:36:42 -0800 Subject: [PATCH] Add background section to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 676ac03..1811d1f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # KSOPS - A Flexible Kustomize Plugin for SOPS Encrypted Resource + - [Background](#background) - [Overview](#overview) - [Requirements](#requirements) - [Example](#example) @@ -7,6 +8,10 @@ - [Argo CD Integration](#argo-cd-integration) +## Background + +At [Viaduct](https://www.viaduct.ai/), we manage our Kubernetes resources via the [GitOps](https://www.weave.works/blog/gitops-operations-by-pull-request) pattern; however, we could not find a solution compatible with our stack for managing secrets via the GitOps paradigm. We built `KSOPS` to connect [kustomize](https://github.com/kubernetes-sigs/kustomize/) to [SOPS](https://github.com/mozilla/sops) and integrated it with [Argo CD](https://github.com/argoproj/argo-cd) to safely manage our secrets the same way we manage the rest our Kubernetes manifest. + ## Overview `KSOPS`, or kustomize-SOPS, is a [kustomize](https://github.com/kubernetes-sigs/kustomize/) plugin for SOPS encrypted resources. `KSOPS` can be used to decrypt any Kubernetes resource, but is most commonly used to decrypt encrypted Kubernetes Secrets and ConfigMaps. As a [kustomize](https://github.com/kubernetes-sigs/kustomize/) plugin, `KSOPS` allows you to manage, build, and apply encrypted manifests the same way you manage the rest of your Kubernetes manifests.