Add repeated-list example.

Fix documentation.

Author: bigkevmcd

api/v1alpha1/gitopsset_types.go

@@ -8,7 +8,11 @@ import (
 
 // // ©itOpsSetTemplate describes a resource to create
 type GitOpsSetTemplate struct {
-	Repeat  string               `json:"repeat,omitempty"`
+	// Repeat is a JSONPath string defining that the template content should be
+	// repeated for each of the matching elements in the JSONPath expression.
+	// https://kubernetes.io/docs/reference/kubectl/jsonpath/
+	Repeat string `json:"repeat,omitempty"`
+	// Content is the YAML to be templated and generated.
 	Content runtime.RawExtension `json:"content"`
 }
 
@@ -19,6 +23,7 @@ type ListGenerator struct {
 
 // GitRepositoryGeneratorFileItemm defines a path to a file to be parsed when generating.
 type GitRepositoryGeneratorFileItem struct {
+	// Path is the name of a file to read and generate from can be JSON or YAML.
 	Path string `json:"path"`
 }
 

config/crd/bases/templates.weave.works_gitopssets.yaml

@@ -63,7 +63,11 @@ spec:
                               path to a file to be parsed when generating.
                             properties:
                               path:
+                                description: Path is the name of a file to read and
+                                  generate from can be JSON or YAML.
                                 type: string
+                            required:
+                            - path
                             type: object
                           type: array
                         repositoryRef:
@@ -88,9 +92,13 @@ spec:
                   description: // ©itOpsSetTemplate describes a resource to create
                   properties:
                     content:
+                      description: Content is the YAML to be templated and generated.
                       type: object
                       x-kubernetes-preserve-unknown-fields: true
                     repeat:
+                      description: Repeat is a JSONPath string defining that the template
+                        content should be repeated for each of the matching elements
+                        in the JSONPath expression. https://kubernetes.io/docs/reference/kubectl/jsonpath/
                       type: string
                   required:
                   - content

examples/repeated-list/kustomization.yaml

@@ -0,0 +1,3 @@
+resources:
+  - role.yaml
+  - repeated-list-generator.yaml

examples/repeated-list/repeated-list-generator.yaml

@@ -0,0 +1,30 @@
+apiVersion: templates.weave.works/v1alpha1
+kind: GitOpsSet
+metadata:
+  name: repeated-gitopsset-sample
+spec:
+  generators:
+    - list:
+        elements:
+          - env: dev
+            team: dev-team
+            teams:
+              - name: "team1"
+              - name: "team2"
+              - name: "team3"
+          - env: staging
+            team: staging-team
+            teams:
+              - name: "team4"
+              - name: "team5"
+              - name: "team6"
+  templates:
+    - repeat: "{ .teams }"
+      content:
+        kind: ConfigMap
+        apiVersion: v1
+        metadata:
+          name: "{{ .repeat.name }}-demo"
+        data:
+          name: "{{ .repeat.name }}-demo"
+          team: "{{ .element.team }}"

examples/repeated-list/role.yaml

@@ -0,0 +1,31 @@
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: configmaps-configmaps-demo-role
+rules:
+- apiGroups:
+  - ""
+  resources:
+  - configmaps
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: demo-role-binding
+roleRef:
+  apiGroup: rbac.authorization.k8s.io
+  kind: ClusterRole
+  name: configmaps-demo-role
+subjects:
+- kind: ServiceAccount
+  name: gitopssets-controller-manager
+  namespace: gitopssets-system