add consumption examples and update readme accordingly

README.md

@@ -4,39 +4,24 @@ Work in progress umbrella package
 
 ## Usage
 
-```
-# As a helm chart
-helm install bigbang chart/ -n flux-system
+The following examples expect a cluster with fluxv2 preinstalled.  This can be done by [installing the flux cli](https://toolkit.fluxcd.io/get-started/#install-the-flux-cli) and running `flux install`.  (TODO: Convert to IB images).
 
-# If you don't like helm
-helm template bigbang chart/ -n flux-system | kubectl apply -f -
-```
+### Quickstart
 
-You can also point a `HelmRelease` to this repository as so:
-
-```yaml
----
-apiVersion: source.toolkit.fluxcd.io/v1beta1
-kind: GitRepository
-metadata:
-  name: umbrella
-  namespace: flux-system
-spec:
-  url: https://repo1.dsop.io/platform-one/big-bang/apps/sandbox/umbrella.git
----
-apiVersion: helm.toolkit.fluxcd.io/v2beta1
-kind: HelmRelease
-metadata:
-  name: bigbang
-  namespace: flux-system
-spec:
-  chart:
-    spec:
-      chart: chart/
-      sourceRef:
-        kind: GitRepository
-        name: umbrella
-        namespace: flux-system
+A bare mininmum, simple quickstart is provided under `./examples/simple`:
+
+```bash
+kubectl apply -f examples/simple
 ```
 
-The `umbrella` helm chart is configurable through a variety of means, please see [TODO]() for more info.
\ No newline at end of file
+### Multi Environment
+
+Most production deployments follow a traditional Dev, Acceptance, Staging, Test (DAST) workflow.  This example demonstrates __one way__ of achieving multiple deployments with differing configurations.
+
+```bash
+# Apply dev
+kustomize build examples/multi-env/overlays/dev | kubectl apply -f -
+
+# Apply prod
+kustomize build examples/multi-env/overlays/prod | kubectl apply -f -
+```

examples/multi-env/base/gitrepository.yaml

+---
+apiVersion: source.toolkit.fluxcd.io/v1beta1
+kind: GitRepository
+metadata:
+  name: umbrella
+spec:
+  interval: 1m0s
+  url: https://repo1.dsop.io/platform-one/big-bang/apps/sandbox/umbrella.git
\ No newline at end of file

examples/multi-env/base/helmrelease.yaml

+apiVersion: helm.toolkit.fluxcd.io/v2beta1
+kind: HelmRelease
+metadata:
+  name: bigbang
+spec:
+  chart:
+    spec:
+      chart: chart
+      sourceRef:
+        kind: GitRepository
+        name: umbrella
+        namespace: flux-system
+  interval: 5m0s
+  valuesFrom:
+    - kind: ConfigMap
+      name: bigbang-values
+      optional: true
+    - kind: Secret
+      name: bigbang-values
+      optional: true

examples/multi-env/base/kustomization.yaml

+namespace: flux-system
+
+resources:
+  - gitrepository.yaml
+  - helmrelease.yaml
+
+configMapGenerator:
+  - name: bigbang-values
+    behavior: create
+    files:
+      - values.yaml
+
+generatorOptions:
+  disableNameSuffixHash: true
\ No newline at end of file

examples/multi-env/overlays/dev/kustomization.yaml

+namespace: flux-system
+
+resources:
+  - ../../base
+
+configMapGenerator:
+  - name: bigbang-values
+    behavior: merge
+    files:
+      - values.yaml
+
+generatorOptions:
+  disableNameSuffixHash: true
+
+patchesStrategicMerge:
+  - patch-gitrepository.yaml
+  - patch-helmrelease.yaml
\ No newline at end of file

examples/multi-env/overlays/dev/patch-gitrepository.yaml

+---
+apiVersion: source.toolkit.fluxcd.io/v1beta1
+kind: GitRepository
+metadata:
+  name: umbrella
+#spec:
+#  # Patch to a development branch
+#  ref:
+#    branch: hel
\ No newline at end of file

examples/multi-env/overlays/dev/patch-helmrelease.yaml

+---
+apiVersion: helm.toolkit.fluxcd.io/v2beta1
+kind: HelmRelease
+metadata:
+  name: bigbang
+spec:
+  # Bump up refresh interval for dev
+  interval: 1m0s

examples/multi-env/overlays/dev/values.yaml

+hostname: bigbang.dev
\ No newline at end of file

examples/multi-env/overlays/prod/kustomization.yaml

+namespace: flux-system
+
+resources:
+  - ../../base
+
+configMapGenerator:
+  - name: bigbang-values
+    behavior: merge
+    files:
+      - values.yaml
+
+generatorOptions:
+  disableNameSuffixHash: true
\ No newline at end of file

examples/multi-env/overlays/prod/values.yaml

+hostname: bigbang.dev
\ No newline at end of file

examples/simple/bigbang.yaml

+---
+apiVersion: source.toolkit.fluxcd.io/v1beta1
+kind: GitRepository
+metadata:
+  name: umbrella-chart
+  namespace: flux-system
+spec:
+  interval: 1m0s
+  url: https://repo1.dsop.io/platform-one/big-bang/apps/sandbox/umbrella
+---
+apiVersion: helm.toolkit.fluxcd.io/v2beta1
+kind: HelmRelease
+metadata:
+  name: bigbang
+  namespace: flux-system
+spec:
+  chart:
+    spec:
+      chart: chart
+      sourceRef:
+        kind: GitRepository
+        name: umbrella-chart
+  interval: 10m0s
+
+  # Add additional variables by using the ConfigMap and Secrets below
+  valuesFrom:
+    - kind: ConfigMap
+      name: bigbang-values
+      optional: true
+    - kind: Secret
+      name: bigbang-values
+      optional: true
+
+  # Modify big bang variables in line with the values below
+  # NOTE: These will take precedence over the `spec.valuesFrom` above
+  values:
+    hostname: bigbang.io