From 413c8c7f414f496e0886a90a74d8da14f6ea970d Mon Sep 17 00:00:00 2001 From: Sheogorath <sheogorath@shivering-isles.com> Date: Sat, 14 Aug 2021 00:58:29 +0200 Subject: [PATCH] feat(documentation): Add intial README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..6fbba2f48 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +Shivering-Isles GitOps Infrastructure +=== + +This repository contains the Kubernetes objects that are synced and managed by [flux](https://fluxcd.io) in order to be deployed. + +Assumptions +--- + +This repository is focused on a setup based on OpenShift, [OKD](https://okd.io) to be specific. Therefore some installations and settings might be based on the expecation of OKD's default setup instead of going the plain Kubernetes way of inventing everything ourselves. + +Tools +--- + +To handle things properly, try to get the following tools: + +- oc / kubectl (you should get it from your OKD cluster) +- flux +- [sops](https://github.com/mozilla/sops/releases/) (for secret handling) +- [helm](https://helm.sh/) (just for sake of completeness and validation) + + -- GitLab