From 99cd370be904b8b71192bfdf43598c3aef0e4f0b Mon Sep 17 00:00:00 2001 From: Steven Wade Date: Mon, 8 Apr 2024 21:07:47 +0100 Subject: [PATCH] add: new example using personal access tokens. Signed-off-by: Steven Wade --- README.md | 2 +- docs/index.md | 6 ++---- docs/resources/bootstrap_git.md | 15 ++++++++------- templates/index.md.tmpl | 6 ++---- templates/resources/bootstrap_git.md.tmpl | 15 ++++++++------- 5 files changed, 21 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 0023e345..9529564d 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ All documentation is available on the [Terraform provider website](https://regis The following guides are available to help you use the provider: -- [Bootstrapping a cluster using a GitHub repository using a personal access token(PAT)](examples/github-via-pat) +- [Bootstrapping a cluster using a GitHub repository using a personal access token (PAT)](examples/github-via-pat) - [Bootstrapping a cluster using a GitHub repository via SSH](examples/github-via-ssh) - [Bootstrapping a cluster using a GitHub repository via SSH and GPG](examples/github-via-ssh-with-gpg) - [Bootstrapping a cluster using a GitHub repository via SSH with flux customizations](examples/github-with-customizations) diff --git a/docs/index.md b/docs/index.md index 2a84a172..0646f829 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,16 +15,14 @@ The provider needs to be configured with Kubernetes credentials to be used. The following examples are available to help you use the provider: -- [Bootstrapping a cluster using a GitHub repository and a personal access token(PAT)](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-pat) +- [Bootstrapping a cluster using a GitHub repository and a personal access token (PAT)](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-pat) - [Bootstrapping a cluster using a GitHub repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh) - [Bootstrapping a cluster using a GitHub repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh-with-gpg) - [Bootstrapping a cluster using a GitHub repository via SSH with flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-customizations) - [Bootstrapping a cluster using a GitHub repository via SSH and GPG with inline flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-inline-customizations) - [Bootstrapping a cluster using a Gitlab repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh) - [Bootstrapping a cluster using a Gitlab repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh-with-gpg) -- [Bootstrapping a cluster using a Helm Release and not the flux_bootstrap_git resource](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/helm-install) ** - -** This is the recommended approach if you do not want to perform initial flux bootstrapping. +- [Bootstrapping a cluster using a Helm Release](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/helm-install) ## Provider Configuration diff --git a/docs/resources/bootstrap_git.md b/docs/resources/bootstrap_git.md index 3c63c19c..6b064a65 100644 --- a/docs/resources/bootstrap_git.md +++ b/docs/resources/bootstrap_git.md @@ -13,13 +13,14 @@ Commits Flux components to a Git repository and configures a Kubernetes cluster The following examples are available to help you use the provider: -- [Configuration using a Github repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh) -- [Configuration using a Github repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh-with-gpg) -- [Configuration using a Github repository via SSH with flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-customizations) -- [Configuration using a Github repository via SSH and GPG with inline flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-inline-customizations) -- [Configuration using a Gitlab repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh) -- [Configuration using a Gitlab repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh-with-gpg) -- [Configuration using a Helm Release and not the flux_bootstrap_git resource]((https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/helm-install) that is the recommended approach if you do not want to perform bootstrapping. +- [Bootstrapping a cluster using a GitHub repository and a personal access token (PAT)](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-pat) +- [Bootstrapping a cluster using a GitHub repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh) +- [Bootstrapping a cluster using a GitHub repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh-with-gpg) +- [Bootstrapping a cluster using a GitHub repository via SSH with flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-customizations) +- [Bootstrapping a cluster using a GitHub repository via SSH and GPG with inline flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-inline-customizations) +- [Bootstrapping a cluster using a Gitlab repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh) +- [Bootstrapping a cluster using a Gitlab repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh-with-gpg) +- [Bootstrapping a cluster using a Helm Release](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/helm-install) ## Schema diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 2a361f2b..297c3d73 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -15,16 +15,14 @@ The provider needs to be configured with Kubernetes credentials to be used. The following examples are available to help you use the provider: -- [Bootstrapping a cluster using a GitHub repository and a personal access token(PAT)](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-pat) +- [Bootstrapping a cluster using a GitHub repository and a personal access token (PAT)](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-pat) - [Bootstrapping a cluster using a GitHub repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh) - [Bootstrapping a cluster using a GitHub repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh-with-gpg) - [Bootstrapping a cluster using a GitHub repository via SSH with flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-customizations) - [Bootstrapping a cluster using a GitHub repository via SSH and GPG with inline flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-inline-customizations) - [Bootstrapping a cluster using a Gitlab repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh) - [Bootstrapping a cluster using a Gitlab repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh-with-gpg) -- [Bootstrapping a cluster using a Helm Release and not the flux_bootstrap_git resource](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/helm-install) ** - -** This is the recommended approach if you do not want to perform initial flux bootstrapping. +- [Bootstrapping a cluster using a Helm Release](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/helm-install) ## Provider Configuration diff --git a/templates/resources/bootstrap_git.md.tmpl b/templates/resources/bootstrap_git.md.tmpl index 154ad456..4f3a335e 100644 --- a/templates/resources/bootstrap_git.md.tmpl +++ b/templates/resources/bootstrap_git.md.tmpl @@ -13,13 +13,14 @@ description: |- The following examples are available to help you use the provider: -- [Configuration using a Github repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh) -- [Configuration using a Github repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh-with-gpg) -- [Configuration using a Github repository via SSH with flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-customizations) -- [Configuration using a Github repository via SSH and GPG with inline flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-inline-customizations) -- [Configuration using a Gitlab repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh) -- [Configuration using a Gitlab repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh-with-gpg) -- [Configuration using a Helm Release and not the flux_bootstrap_git resource]((https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/helm-install) that is the recommended approach if you do not want to perform bootstrapping. +- [Bootstrapping a cluster using a GitHub repository and a personal access token (PAT)](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-pat) +- [Bootstrapping a cluster using a GitHub repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh) +- [Bootstrapping a cluster using a GitHub repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-via-ssh-with-gpg) +- [Bootstrapping a cluster using a GitHub repository via SSH with flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-customizations) +- [Bootstrapping a cluster using a GitHub repository via SSH and GPG with inline flux customizations](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/github-with-inline-customizations) +- [Bootstrapping a cluster using a Gitlab repository via SSH](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh) +- [Bootstrapping a cluster using a Gitlab repository via SSH and GPG](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/gitlab-via-ssh-with-gpg) +- [Bootstrapping a cluster using a Helm Release](https://github.com/fluxcd/terraform-provider-flux/tree/main/examples/helm-install) {{ .SchemaMarkdown | trimspace }}