refactor: components

kubernetes/components/volsync/README.md

@@ -0,0 +1,38 @@
+# VolSync Template
+
+## Flux Kustomization
+
+This requires `postBuild` configured on the Flux Kustomization
+
+```yaml
+apiVersion: kustomize.toolkit.fluxcd.io/v1
+kind: Kustomization
+metadata:
+  name: &app plex
+  namespace: flux-system
+spec:
+  # ...
+  postBuild:
+    substitute:
+      APP: *app
+      VOLSYNC_CAPACITY: 5Gi
+```
+
+and then call the template in your applications `kustomization.yaml`
+
+```yaml
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  # ...
+  - ../../../../components/volsync
+```
+
+## Required `postBuild` vars:
+
+- `APP`: The application name
+- `VOLSYNC_CAPACITY`: The PVC size
+
+## Optional `postBuild` vars:
+
+- TBD