Merge pull request #832 from konstructio/update-mkcert

fix: Updating docs for mkcert
konstructio · Nov 27, 2024 · 0894999 · 0894999
2 parents 0cfa657 + 80ff6d1
commit 0894999
Show file tree

Hide file tree

Showing 113 changed files with 5,019 additions and 200 deletions.
diff --git a/docs/akamai/quick-start/install/cli.mdx b/docs/akamai/quick-start/install/cli.mdx
@@ -38,11 +38,30 @@ export const TabLabel = ({ imgSrc, label, alt }) => (
 
     <TabItem attributes={{ className: styles.github }} value="github" label={ <GitHubLogo /> }>
     <GitHubPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
+
     <GitHubClusterCreateCmd />
     <CommonTerminalOutput cloud="Akamai"  minutes="10" handoffScreen={GitHubHandoffScreen} />
   </TabItem>
 
 </Tabs>
-
 <CommonRootCredentialsCmd cloud="akamai" />
 <CommonClusterConnectivity />
diff --git a/docs/aws/quick-start/install/cli.mdx b/docs/aws/quick-start/install/cli.mdx
@@ -37,15 +37,55 @@ export const TabLabel = ({ imgSrc, label, alt }) => (
 <Tabs groupId="git_provider" defaultValue="github" queryString>
   <TabItem attributes={{ className: styles.github }} value="github" label={ <GitHubLogo /> }>
     <GitHubPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
+
     <GitHubClusterCreateCmd />
     <CommonTerminalOutput cloud="Aws"  minutes="10" handoffScreen={GitHubHandoffScreen} />
-  </TabItem>
-  <TabItem attributes={{ className: styles.gitlab }} value="gitlab" label={ <GitLabLogo /> }>
+    </TabItem>
+    <TabItem attributes={{ className: styles.gitlab }} value="gitlab" label={ <GitLabLogo /> }>
     <GitLabPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
+
     <GitLabClusterCreateCmd />
     <CommonTerminalOutput cloud="Aws"  minutes="10" handoffScreen={GitLabHandoffScreen} />
   </TabItem>
 </Tabs>
 
-<CommonRootCredentialsCmd cloud="aws" />
-<CommonClusterConnectivity />
+    <CommonRootCredentialsCmd cloud="aws" />
+    <CommonClusterConnectivity />
diff --git a/docs/azure/quick-start/install/cli.mdx b/docs/azure/quick-start/install/cli.mdx
@@ -27,12 +27,50 @@ import GitLabHandoffScreen from "../../../img/azure/gitlab/handoff-screen.png";
 
     <TabItem attributes={{ className: styles.github }} value="github" label={ <GitHubLogo /> }>
         <GitHubPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+        ```shell
+        brew install mkcert
+        mkcert -install
+        ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+        ```shell
+        brew install nss
+        ```
         <GitHubClusterCreateCmd />
         <CommonTerminalOutput cloud="Azure"  minutes="20" handoffScreen={GitHubHandoffScreen} />
     </TabItem>
 
     <TabItem attributes={{ className: styles.gitlab }} value="gitlab" label={ <GitLabLogo /> }>
         <GitLabPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+        ```shell
+        brew install mkcert
+        mkcert -install
+        ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+        ```shell
+        brew install nss
+        ```
         <GitLabClusterCreateCmd />
         <CommonTerminalOutput cloud="Azure"  minutes="20" handoffScreen={GitLabHandoffScreen} />
     </TabItem>

diff --git a/docs/civo/quick-start/install/cli.mdx b/docs/civo/quick-start/install/cli.mdx
@@ -38,17 +38,57 @@ export const TabLabel = ({ imgSrc, label, alt }) => (
 
     <TabItem attributes={{ className: styles.github }} value="github" label={ <GitHubLogo /> }>
     <GitHubPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
+
     <GitHubClusterCreateCmd />
     <CommonTerminalOutput cloud="Civo"  minutes="10" handoffScreen={GitHubHandoffScreen} />
   </TabItem>
 
       <TabItem attributes={{ className: styles.gitlab }} value="gitlab" label={ <GitLabLogo /> }>
     <GitLabPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
+
     <GitLabClusterCreateCmd />
     <CommonTerminalOutput cloud="Civo"  minutes="10" handoffScreen={GitLabHandoffScreen} />
   </TabItem>
 
 </Tabs>
 
-<CommonRootCredentialsCmd cloud="civo" />
-<CommonClusterConnectivity />
+    <CommonRootCredentialsCmd cloud="civo" />
+    <CommonClusterConnectivity />
diff --git a/docs/do/quick-start/install/cli.mdx b/docs/do/quick-start/install/cli.mdx
@@ -39,13 +39,51 @@ export const TabLabel = ({ imgSrc, label, alt }) => (
 
     <TabItem attributes={{ className: styles.github }} value="github" label={<GitHubLogo /> }>
     <GitHubPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
     <GitHubClusterCreateCmd />
     <SpaceRegion />
     <CommonTerminalOutput cloud="Do"  minutes="10" handoffScreen={GitHubHandoffScreen} />
   </TabItem>
 
       <TabItem attributes={{ className: styles.gitlab }} value="gitlab" label={ <GitLabLogo /> }>
     <GitLabPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
     <GitLabClusterCreateCmd />
     <SpaceRegion />
     <CommonTerminalOutput cloud="Do"  minutes="10" handoffScreen={GitLabHandoffScreen} />

diff --git a/docs/gcp/quick-start/install/cli.mdx b/docs/gcp/quick-start/install/cli.mdx
@@ -38,17 +38,55 @@ export const TabLabel = ({ imgSrc, label, alt }) => (
 
     <TabItem attributes={{ className: styles.github }} value="github" label={ <GitHubLogo /> }>
     <GitHubPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
     <GitHubClusterCreateCmd />
     <CommonTerminalOutput cloud="Gcp"  minutes="10" handoffScreen={GitHubHandoffScreen} />
   </TabItem>
 
       <TabItem attributes={{ className: styles.gitlab }} value="gitlab" label={ <GitLabLogo /> }>
     <GitLabPrerequisites />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+    ```shell
+    brew install mkcert
+    mkcert -install
+    ```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+    ```shell
+    brew install nss
+    ```
     <GitLabClusterCreateCmd />
     <CommonTerminalOutput cloud="Gcp"  minutes="10" handoffScreen={GitLabHandoffScreen} />
   </TabItem>
 
 </Tabs>
 
-<CommonRootCredentialsCmd cloud="beta google" />
-<CommonClusterConnectivity />
+    <CommonRootCredentialsCmd cloud="beta google" />
+    <CommonClusterConnectivity />
diff --git a/docs/k3s/quick-start/install/cli.mdx b/docs/k3s/quick-start/install/cli.mdx
@@ -37,13 +37,53 @@ export const TabLabel = ({ imgSrc, label, alt }) => (
 <Tabs groupId="git_provider" defaultValue="gitlab" queryString>
   <TabItem attributes={{ className: styles.github }} value="github" label={ <GitHubLogo /> }>
     <GitHubPrerequisites />
-    <GitHubClusterCreateCmd />
-    <CommonTerminalOutput cloud="K3s"  minutes="10" handoffScreen={GitHubHandoffScreen} />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+```shell
+brew install mkcert
+mkcert -install
+```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+```shell
+brew install nss
+```
+
+  <GitHubClusterCreateCmd />
+  <CommonTerminalOutput cloud="K3s"  minutes="10" handoffScreen={GitHubHandoffScreen} />
   </TabItem>
   <TabItem attributes={{ className: styles.gitlab }} value="gitlab" label={ <GitLabLogo /> }>
     <GitLabPrerequisites />
-    <GitLabClusterCreateCmd />
-    <CommonTerminalOutput cloud="K3s"  minutes="10" handoffScreen={GitLabHandoffScreen} />
+
+### Install the CA (Certificate Authority) of mkcert in your trusted store
+
+We use [mkcert](https://github.com/FiloSottile/mkcert) to generate local certificates and serve `https` with the Traefik Ingress Controller. During the installation, Kubefirst generates these certificates and pushes them to Kubernetes as secrets to attach to Ingress resources.
+
+To allow the applications running in your Kubefirst platform in addition to your browser to trust the certificates generated by your Kubefirst local install, you need to install the CA (Certificate Authority) of mkcert in your trusted store. To do so, follow these simple steps:
+
+```shell
+brew install mkcert
+mkcert -install
+```
+
+This is not an optional step: the cluster creation will fail if you don't install the mkcert CA in your trusted store.
+
+If you are using Firefox, you have one more step: you need to install the [Network Security Services](https://firefox-source-docs.mozilla.org/security/nss/index.html) (NSS):
+
+```shell
+brew install nss
+```
+
+   <GitLabClusterCreateCmd />
+   <CommonTerminalOutput cloud="K3s"  minutes="10" handoffScreen={GitLabHandoffScreen} />
   </TabItem>
 </Tabs>