Skip to content

Commit

Permalink
Add background section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
devstein committed Dec 9, 2019
1 parent 6ef407b commit 5648f9b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# KSOPS - A Flexible Kustomize Plugin for SOPS Encrypted Resource

- [Background](#background)
- [Overview](#overview)
- [Requirements](#requirements)
- [Example](#example)
- [Development and Testing](#development-and-testing)
- [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.
Expand Down

0 comments on commit 5648f9b

Please sign in to comment.