Added manifests to data resources providing a map for for_each usage (#132)

Author: gavinbunney

.run/Template Go Test.run.xml

@@ -0,0 +1,16 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="true" type="GoTestRunConfiguration" factoryName="Go Test">
+    <module name="terraform-provider-kubectl" />
+    <working_directory value="$PROJECT_DIR$" />
+    <envs>
+      <env name="TF_ACC" value="1" />
+      <env name="KUBECONFIG" value="$PROJECT_DIR$/scripts/kubeconfig.yaml" />
+    </envs>
+    <kind value="DIRECTORY" />
+    <package value="github.com/gavinbunney/terraform-provider-kubectl" />
+    <directory value="$PROJECT_DIR$" />
+    <filePath value="$PROJECT_DIR$" />
+    <framework value="gotest" />
+    <method v="2" />
+  </configuration>
+</component>

_examples/manifests/directives-templated.yaml

@@ -1 +1,2 @@
+kind: MyAwesomeCRD
 MyYaml: Hello, %{ if name != "" }${name}%{ else }unnamed%{ endif }!

_examples/manifests/duplicates/multiple.yaml

@@ -0,0 +1,30 @@
+---
+apiVersion: "stable.example.com/v1"
+kind: CronTab
+metadata:
+  name: name-here-crd
+spec:
+  cronSpec: "* * * * /5"
+  image: my-awesome-cron-image
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: name-here-crontabs.stable.example.com
+spec:
+  group: stable.example.com
+  conversion:
+    strategy: None
+  scope: Namespaced
+  names:
+    plural: name-here-crontabs
+    singular: crontab
+    kind: CronTab
+    shortNames:
+      - ct
+  version: v1
+  versions:
+    - name: v1
+      served: true
+      storage: true
+---

_examples/manifests/duplicates/multiple2.yaml

@@ -0,0 +1,30 @@
+---
+apiVersion: "stable.example.com/v1"
+kind: CronTab
+metadata:
+  name: name-here-crd
+spec:
+  cronSpec: "* * * * /5"
+  image: my-awesome-cron-image
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  name: name-here-crontabs.stable.example.com
+spec:
+  group: stable.example.com
+  conversion:
+    strategy: None
+  scope: Namespaced
+  names:
+    plural: name-here-crontabs
+    singular: crontab
+    kind: CronTab
+    shortNames:
+      - ct
+  version: v1
+  versions:
+    - name: v1
+      served: true
+      storage: true
+---

_examples/manifests/multiple-templated.yaml

@@ -2,15 +2,15 @@
 apiVersion: "stable.example.com/v1"
 kind: CronTab
 metadata:
-  name: name-here-crd
+  name: name-here-crd-templated
 spec:
   cronSpec: "* * * * /5"
   image: my-awesome-cron-image
 ---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  name: name-here-crontabs.stable.example.com
+  name: name-here-templated-crontabs.stable.example.com
 spec:
   group: stable.example.com
   conversion:

_examples/manifests/single-templated.yaml

@@ -1,7 +1,7 @@
 apiVersion: "stable.example.com/v1"
 kind: ${the_kind}
 metadata:
-  name: name-here-crd
+  name: name-here-crd-single-templated
 spec:
   cronSpec: "* * * * /5"
   image: my-awesome-cron-image

_examples/manifests/single.yaml

@@ -1,7 +1,7 @@
 apiVersion: "stable.example.com/v1"
 kind: CronTab
 metadata:
-  name: name-here-crd
+  name: name-here-crd-single
 spec:
   cronSpec: "* * * * /5"
   image: my-awesome-cron-image

docs/data-sources/kubectl_file_documents.md

@@ -4,17 +4,38 @@ This provider provides a `data` resource `kubectl_file_documents` to enable ease
 
 ## Example Usage
 
+### Example Usage with for_each
+
+The recommended approach is to use the `manifests` attribute and a `for_each` expression to apply the found manifests.
+This ensures that any additional yaml documents or removals do not cause a large amount of terraform changes.
+
+```hcl
+data "kubectl_file_documents" "docs" {
+    content = file("multi-doc-manifest.yaml")
+}
+
+resource "kubectl_manifest" "test" {
+    for_each  = data.kubectl_file_documents.docs.manifests
+    yaml_body = each.value
+}
+```
+
+### Example Usage via count
+
+Raw documents can also be accessed via the `documents` attribute.
+
 ```hcl
-data "kubectl_file_documents" "manifests" {
+data "kubectl_file_documents" "docs" {
     content = file("multi-doc-manifest.yaml")
 }
 
 resource "kubectl_manifest" "test" {
-    count     = length(data.kubectl_file_documents.manifests.documents)
-    yaml_body = element(data.kubectl_file_documents.manifests.documents, count.index)
+    count     = length(data.kubectl_file_documents.docs.documents)
+    yaml_body = element(data.kubectl_file_documents.docs.documents, count.index)
 }
 ```
 
 ## Attribute Reference
 
-* `documents` - List of YAML documents (string).
+* `manifests` - Map of YAML documents with key being the document id, and value being the document yaml. Best used with `for_each` expressions.
+* `documents` - List of raw YAML documents (string). Best used with `count` expressions.

docs/data-sources/kubectl_path_documents.md

@@ -8,16 +8,34 @@ This gives you the flexibility of parameterizing your manifests, and loading & t
 
 ## Example Usage
 
-### Load all manifest documents
+### Load all manifest documents via for_each (recommended)
+
+The recommended approach is to use the `manifests` attribute and a `for_each` expression to apply the found manifests.
+This ensures that any additional yaml documents or removals do not cause a large amount of terraform changes.
 
 ```hcl
-data "kubectl_path_documents" "manifests" {
+data "kubectl_path_documents" "docs" {
+    pattern = "./manifests/*.yaml"
+}
+
+resource "kubectl_manifest" "test" {
+    for_each  = data.kubectl_file_documents.docs.manifests
+    yaml_body = each.value
+}
+```
+
+### Load all manifest documents via count
+
+Raw documents can also be accessed via the `documents` attribute.
+
+```hcl
+data "kubectl_path_documents" "docs" {
     pattern = "./manifests/*.yaml"
 }
 
 resource "kubectl_manifest" "test" {
-    count     = length(data.kubectl_path_documents.manifests.documents)
-    yaml_body = element(data.kubectl_path_documents.manifests.documents, count.index)
+    count     = length(data.kubectl_path_documents.docs.documents)
+    yaml_body = element(data.kubectl_path_documents.docs.documents, count.index)
 }
 ```
 
@@ -152,4 +170,5 @@ metadata:
 
 ## Attribute Reference
 
-* `documents` - List of YAML documents (list[string]).
+* `manifests` - Map of YAML documents with key being the document id, and value being the document yaml. Best used with `for_each` expressions.
+* `documents` - List of YAML documents (list[string]). Best used with `count` expressions.

kubernetes/data_source_kubectl_file_documents.go

@@ -22,6 +22,13 @@ func dataSourceKubectlFileDocuments() *schema.Resource {
 				Elem:     &schema.Schema{Type: schema.TypeString},
 				Computed: true,
 			},
+			"manifests": &schema.Schema{
+				Type: schema.TypeMap,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+				Computed: true,
+			},
 		},
 	}
 }
@@ -33,7 +40,27 @@ func dataSourceKubectlFileDocumentsRead(ctx context.Context, d *schema.ResourceD
 		return diag.FromErr(err)
 	}
 
+	manifests := make(map[string]string, 0)
+	for _, doc := range documents {
+		manifest, err := yaml.ParseYAML(doc)
+		if err != nil {
+			return diag.FromErr(fmt.Errorf("failed to parse yaml as a kubernetes yaml manifest: %v", err))
+		}
+
+		parsed, err := manifest.AsYAML()
+		if err != nil {
+			return diag.FromErr(fmt.Errorf("failed to parse convert manifest to yaml: %v", err))
+		}
+
+		if _, exists := manifests[manifest.GetSelfLink()]; exists {
+			return diag.FromErr(fmt.Errorf("duplicate manifest found with id: %v", manifest.GetSelfLink()))
+		}
+
+		manifests[manifest.GetSelfLink()] = parsed
+	}
+
 	d.SetId(fmt.Sprintf("%x", sha256.Sum256([]byte(content))))
-	d.Set("documents", documents)
+	_ = d.Set("documents", documents)
+	_ = d.Set("manifests", manifests)
 	return nil
 }