Polishing during review

cloudogu · Jan 17, 2023 · a61b5aa · a61b5aa
1 parent 159954b
commit a61b5aa
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -440,11 +440,11 @@ Via the `vault` parameter, you can deploy Hashicorp Vault and the External Secre
 With this, the whole flow from secret value in Vault to kubernetes `Secret` via External Secrets Operator can be seen in 
 action:
 
-![External Secret Operator <-> Vault - flow](https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/cloudogu/gitops-playground/feature/vault/docs/plantuml-src/External-Secret-Operator-Flow.puml&fmt=svg)
+![External Secret Operator <-> Vault - flow](https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/cloudogu/gitops-playground/main/docs/plantuml-src/External-Secret-Operator-Flow.puml&fmt=svg)
 
 For this to work, the GitOps playground configures the whole chain in Kubernetes and vault (when [dev mode](#dev-mode) is used): 
 
-![External Secret Operator Custom Resources](https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/cloudogu/gitops-playground/feature/vault/docs/plantuml-src/External-Secret-Operator-CRs.puml&fmt=svg)
+![External Secret Operator Custom Resources](https://www.plantuml.com/plantuml/proxy?src=https://raw.githubusercontent.com/cloudogu/gitops-playground/main/docs/plantuml-src/External-Secret-Operator-CRs.puml&fmt=svg)
 
 * In k8s `namespaces` `argocd-staging` and `argocd-production`:
   * Creates `SecretStore` and `ServiceAccount` (used to authenticate with vault)
@@ -500,7 +500,9 @@ To demo this, you could
 ```shell
 while ; do echo -n "$(date '+%Y-%m-%d %H:%M:%S'): " ; curl http://localhost:30024/secret/ ; echo; sleep 1; done
 ```
-  This usually takes between a couple of seconds and 1-2 minutes. 
+  This usually takes between a couple of seconds and 1-2 minutes.  
+  This time consists of `ExternalSecret`'s `refreshInterval`, as well as the kubelet sync period (defaults to 1 Minute) 
+  + cache propagation delay
 
 ### Argo CD UI
 

diff --git a/docs/plantuml-src/External-Secret-Operator-CRs.puml b/docs/plantuml-src/External-Secret-Operator-CRs.puml
@@ -41,7 +41,7 @@ ESO --> ES : read
 ESO --> vault : read\n(using info from ES+SS)
 'ESO --> vault : uses info from\n ExternalSecret + SecretStore\nto read actual secret 
 ESO -> secrets : create
-secrets <-- pods : use
+secrets <-- pods : mount
 ES -> Store: reference
 Store --> sa : reference
 Store -> vault : reference

diff --git a/docs/plantuml-src/External-Secret-Operator-Flow.puml b/docs/plantuml-src/External-Secret-Operator-Flow.puml
@@ -22,7 +22,7 @@
 
 !define COLOR_ABOVE_TRANSPARENT_BACKGROUND WHITE
 
-skinparam backgroundcolor TRANSPARENT
+skinparam backgroundcolor WHITE
 skinparam actorStyle awesome
 
 

diff --git a/src/main/groovy/com/cloudogu/gitops/Application.groovy b/src/main/groovy/com/cloudogu/gitops/Application.groovy
@@ -30,6 +30,7 @@ class Application {
     // This means, that the first registered feature will be first and the last feature registered will be the last to run
     private List<Feature> registerFeatures() {
         List<Feature> features = []
+        // Idea for refactoring: Feature classes have different names as features in config -> Generalize!
         features.add(new ArgoCD(config))
         features.add(new Mailhog(config))
         features.add(new PrometheusStack(config))