Add guide for reconciling 3rd-party Git sources

Signed-off-by: Stefan Prodan <[email protected]>
fluxcd · May 29, 2023 · 89a8a60 · 89a8a60
1 parent b17d105
commit 89a8a60
Show file tree

Hide file tree

Showing 2 changed files with 108 additions and 0 deletions.
diff --git a/docs/guides/extra-syncs.md b/docs/guides/extra-syncs.md
@@ -0,0 +1,54 @@
+---
+subcategory: ""
+page_title: "Reconcile 3rd-party Git sources"
+description: |-
+  A guide for setting up reconciliation of 3rd-party Git sources after Flux bootstrap.
+---
+
+# Reconcile 3rd-party Git sources
+
+To generate `GitRepository` and `Kustomization` objects for reconciling
+other repositories besides the bootstrap one,
+you can use the [flux2-sync Helm chart](https://artifacthub.io/packages/helm/fluxcd-community/flux2-sync)
+and the Helm Terraform Provider.
+
+Example:
+
+```terraform
+terraform {
+  required_providers {
+    helm = {
+      source  = "hashicorp/helm"
+    }
+    kind = {
+      source  = "tehcyx/kind"
+    }
+  }
+}
+
+provider "kind" {}
+
+resource "kind_cluster" "this" {
+  name = "flux-e2e"
+}
+
+provider "helm" {
+  kubernetes {
+    host                   = kind_cluster.this.endpoint
+    client_certificate     = kind_cluster.this.client_certificate
+    client_key             = kind_cluster.this.client_key
+    cluster_ca_certificate = kind_cluster.this.cluster_ca_certificate
+  }
+}
+
+resource "helm_release" "my-app-sync" {
+  repository       = "https://fluxcd-community.github.io/helm-charts"
+  chart            = "flux2-sync"
+  name             = "my-app-sync"
+  namespace        = "flux-system"
+  values = [
+    file("${path.module}/my-app-sync-values.yaml")
+  ]
+}
+```
+
diff --git a/templates/guides/extra-syncs.md b/templates/guides/extra-syncs.md
@@ -0,0 +1,54 @@
+---
+subcategory: ""
+page_title: "Reconcile 3rd-party Git sources"
+description: |-
+  A guide for setting up reconciliation of 3rd-party Git sources after Flux bootstrap.
+---
+
+# Reconcile 3rd-party Git sources
+
+To generate `GitRepository` and `Kustomization` objects for reconciling
+other repositories besides the bootstrap one,
+you can use the [flux2-sync Helm chart](https://artifacthub.io/packages/helm/fluxcd-community/flux2-sync)
+and the Helm Terraform Provider.
+
+Example:
+
+```terraform
+terraform {
+  required_providers {
+    helm = {
+      source  = "hashicorp/helm"
+    }
+    kind = {
+      source  = "tehcyx/kind"
+    }
+  }
+}
+
+provider "kind" {}
+
+resource "kind_cluster" "this" {
+  name = "flux-e2e"
+}
+
+provider "helm" {
+  kubernetes {
+    host                   = kind_cluster.this.endpoint
+    client_certificate     = kind_cluster.this.client_certificate
+    client_key             = kind_cluster.this.client_key
+    cluster_ca_certificate = kind_cluster.this.cluster_ca_certificate
+  }
+}
+
+resource "helm_release" "my-app-sync" {
+  repository       = "https://fluxcd-community.github.io/helm-charts"
+  chart            = "flux2-sync"
+  name             = "my-app-sync"
+  namespace        = "flux-system"
+  values = [
+    file("${path.module}/my-app-sync-values.yaml")
+  ]
+}
+```
+