docs: add info about the new Cloudflare DNS flag (#437)

konstructio · Jul 26, 2023 · d4091c1 · d4091c1
1 parent eaa2938
commit d4091c1
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 0 deletions.
diff --git a/docs/aws/partials/github/_cluster-create.mdx b/docs/aws/partials/github/_cluster-create.mdx
@@ -1,3 +1,5 @@
+import CloudflareDNS from "@site/docs/common/partials/common/_cloudflare-dns.mdx";
+
 ## Create your new kubefirst cluster
 
 Adjust the following command with your GitHub token in addition to the appropriate values for your new platform.
@@ -11,3 +13,5 @@ kubefirst aws create \
   --cluster-name kubefirst-mgmt \
   --github-org your-github-organization-name
 ```
+
+<CloudflareDNS />
diff --git a/docs/aws/partials/gitlab/_cluster-create.mdx b/docs/aws/partials/gitlab/_cluster-create.mdx
@@ -1,3 +1,5 @@
+import CloudflareDNS from "@site/docs/common/partials/common/_cloudflare-dns.mdx";
+
 ## Create your new kubefirst cluster
 
 Adjust the following command with your GitLab token in addition to the appropriate values for your new platform.
@@ -12,3 +14,5 @@ kubefirst aws create \
   --domain-name your-domain.io \
   --cluster-name kubefirst
 ```
+
+<CloudflareDNS />
diff --git a/docs/civo/partials/github/_cluster-create.mdx b/docs/civo/partials/github/_cluster-create.mdx
@@ -1,3 +1,5 @@
+import CloudflareDNS from "@site/docs/common/partials/common/_cloudflare-dns.mdx";
+
 ## Create your new kubefirst cluster
 
 Adjust the following command with your GitHub and Civo tokens in addition to the appropriate values for your new platform.
@@ -13,6 +15,8 @@ kubefirst civo create \
   --cluster-name kubefirst
 ```
 
+<CloudflareDNS />
+
 The kubefirst CLI will produce a directory of utilities, a state file, and some staged platform content that can now be found in the `~/.kubefirst` and `~/.k1` folders on your local machine.
 
 After the ~10 minute installation, your browser will launch a new tab to the [kubefirst Console](https://github.com/kubefirst/console), which will help you navigate your new suite of tools running in your new Civo cluster.

diff --git a/docs/civo/partials/gitlab/_cluster-create.mdx b/docs/civo/partials/gitlab/_cluster-create.mdx
@@ -1,3 +1,5 @@
+import CloudflareDNS from "@site/docs/common/partials/common/_cloudflare-dns.mdx";
+
 ## Create your new kubefirst cluster
 
 Adjust the following command with your GitHub and Civo tokens in addition to the appropriate values for your new platform.
@@ -13,3 +15,5 @@ kubefirst civo create \
   --domain-name your-domain.io \
   --cluster-name kubefirst
 ```
+
+<CloudflareDNS />
diff --git a/docs/common/partials/common/_cloudflare-dns.mdx b/docs/common/partials/common/_cloudflare-dns.mdx
@@ -0,0 +1,9 @@
+:::tip
+
+By default kubefirst use the cloud providers to manage DNS. You also have the option to use Cloudflare.
+
+To do so, add the `dnsProvider` flag with the value `cloudflare` to your create command `—dnsProvider cloudflare`.
+
+You also need to set the `CF_API_TOKEN` environment variable with a Cloudflare token (`export CF_API_TOKEN=xxxxxxxxx`) having the `Zone.Zone`, and `Zone.DNS` edit permission. More information on Cloudflare token creation [in their documentation](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/).
+
+:::
diff --git a/docs/gcp/partials/github/_cluster-create.mdx b/docs/gcp/partials/github/_cluster-create.mdx
@@ -1,3 +1,5 @@
+import CloudflareDNS from "@site/docs/common/partials/common/_cloudflare-dns.mdx";
+
 ## Create your new kubefirst cluster
 
 Adjust the following command with your GitHub and Google Cloud tokens in addition to the appropriate values for your new platform.
@@ -13,6 +15,8 @@ kubefirst beta gcp create \
   --cluster-name kubefirst
 ```
 
+<CloudflareDNS />
+
 The kubefirst CLI will produce a directory of utilities, a state file, and some staged platform content that can now be found in the `~/.kubefirst` and `~/.k1` folders on your local machine.
 
 After the ~10 minute installation, your browser will launch a new tab to the [kubefirst Console](https://github.com/kubefirst/console), which will help you navigate your new suite of tools running in your new Google Cloud cluster.

diff --git a/docs/gcp/partials/gitlab/_cluster-create.mdx b/docs/gcp/partials/gitlab/_cluster-create.mdx
@@ -1,3 +1,5 @@
+import CloudflareDNS from "@site/docs/common/partials/common/_cloudflare-dns.mdx";
+
 ## Create your new kubefirst cluster
 
 Adjust the following command with your GitHub and Google Cloud tokens in addition to the appropriate values for your new platform.
@@ -13,3 +15,5 @@ kubefirst beta gcp create \
   --domain-name your-domain.io \
   --cluster-name kubefirst
 ```
+
+<CloudflareDNS />
diff --git a/docs/vultr/partials/github/_cluster-create.mdx b/docs/vultr/partials/github/_cluster-create.mdx
@@ -1,3 +1,5 @@
+import CloudflareDNS from "@site/docs/common/partials/common/_cloudflare-dns.mdx";
+
 ## Create your new kubefirst cluster
 
 Adjust the following command with your GitHub and Vultr key in addition to the appropriate values for your new platform.
@@ -13,6 +15,8 @@ kubefirst beta vultr create \
   --cluster-name kubefirst
 ```
 
+<CloudflareDNS />
+
 The kubefirst CLI will produce a directory of utilities, a state file, and some staged platform content that can now be found in the `~/.kubefirst` and `~/.k1` folders on your local machine.
 
 After the ~10 minute installation, your browser will launch a new tab to the [kubefirst Console](https://github.com/kubefirst/console), which will help you navigate your new suite of tools running in your new Vultr cluster.

diff --git a/docs/vultr/partials/gitlab/_cluster-create.mdx b/docs/vultr/partials/gitlab/_cluster-create.mdx
@@ -1,3 +1,5 @@
+import CloudflareDNS from "@site/docs/common/partials/common/_cloudflare-dns.mdx";
+
 ## Create your new kubefirst cluster
 
 Adjust the following command with your GitHub and Vultr tokens in addition to the appropriate values for your new platform.
@@ -13,3 +15,5 @@ kubefirst beta vultr create \
   --domain-name your-domain.io \
   --cluster-name kubefirst
 ```
+
+<CloudflareDNS />