From d92f5019d9a824c14e6411d11a915ce3abc955cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= Date: Wed, 19 Jul 2023 02:14:55 -0400 Subject: [PATCH] fix a bunch of things --- CONTRIBUTING.md | 2 +- docs/constants.js | 2 ++ docs/gcp/credits.mdx | 2 +- docs/gcp/explore/user-creation.mdx | 10 +++--- docs/gcp/overview.mdx | 31 +++++++++---------- docs/gcp/partials/common/_prerequisites.mdx | 10 +++--- .../partials/common/_root-credentials-cmd.mdx | 4 +-- docs/gcp/partials/github/_cluster-create.mdx | 9 +++--- docs/gcp/partials/github/_install.mdx | 27 ++++++++-------- docs/gcp/partials/github/_overview.mdx | 4 +-- docs/gcp/partials/github/_prerequisites.mdx | 2 +- docs/gcp/partials/github/_repositories.mdx | 2 +- docs/gcp/partials/github/_user-creation.mdx | 2 +- docs/gcp/partials/gitlab/_cluster-create.mdx | 4 +-- docs/gcp/partials/gitlab/_install.mdx | 26 ++++++++-------- docs/gcp/partials/gitlab/_overview.mdx | 4 +-- docs/gcp/partials/gitlab/_prerequisites.mdx | 2 +- docs/gcp/partials/gitlab/_repositories.mdx | 4 +-- docs/gcp/partials/gitlab/_user-creation.mdx | 2 +- docs/gcp/platform.mdx | 3 +- docs/gcp/quick-start/install/ui.mdx | 28 ++++++----------- docs/gcp/quick-start/repositories.mdx | 13 ++++---- docs/index.mdx | 19 ++++++++++++ docusaurus.config.js | 2 +- styles/Custom/ignore.txt | 1 + styles/Custom/substitutions.yml | 2 ++ styles/Vocab/base/accept.txt | 1 + versioned_docs/version-2.0/gcp/upgrade.md | 5 +++ versioned_docs/version-2.1/gcp/upgrade.md | 5 +++ versioned_docs/version-2.2/gcp/upgrade.md | 5 +++ versioned_sidebars/version-2.0-sidebars.json | 3 ++ versioned_sidebars/version-2.1-sidebars.json | 3 ++ versioned_sidebars/version-2.2-sidebars.json | 3 ++ 33 files changed, 141 insertions(+), 101 deletions(-) create mode 100644 versioned_docs/version-2.0/gcp/upgrade.md create mode 100644 versioned_docs/version-2.1/gcp/upgrade.md create mode 100644 versioned_docs/version-2.2/gcp/upgrade.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 837acf55..a9bd1350 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,7 +111,7 @@ In MDX v1, JSX and Markdown don't interoperate well: it has been fixed in MDX v2 ##### Admonitions -You can also use special Docusaurus Markdown syntax called admonitions, which let you display beautiful notes, informations, warnings, and others. +You can also use special Docusaurus Markdown syntax called admonitions, which let you display beautiful notes, information, warnings, and others. ```markdown :::note diff --git a/docs/constants.js b/docs/constants.js index e1ed0f78..15a2edd9 100644 --- a/docs/constants.js +++ b/docs/constants.js @@ -10,3 +10,5 @@ export const GITLAB_LOGO_URL = 'https://assets.kubefirst.com/console/gitlab.svg'; export const VULTR_LOGO_URL = 'https://cf-assets.www.cloudflare.com/slt3lc6tev37/1ATBPX4YOBbCRkybT4zS2e/f4f5f0900b57c61e65960efb3d11c64f/Vultr_logo_high_res.png'; +export const GCP_LOGO_URL = + 'https://upload.wikimedia.org/wikipedia/commons/5/51/Google_Cloud_logo.svg'; diff --git a/docs/gcp/credits.mdx b/docs/gcp/credits.mdx index 2652442f..11475ce6 100644 --- a/docs/gcp/credits.mdx +++ b/docs/gcp/credits.mdx @@ -8,4 +8,4 @@ image: "https://docs.kubefirst.io/img/logo.svg" import CommonCredits from "@site/docs/common/credits.mdx" - \ No newline at end of file + diff --git a/docs/gcp/explore/user-creation.mdx b/docs/gcp/explore/user-creation.mdx index 67c22114..26117629 100644 --- a/docs/gcp/explore/user-creation.mdx +++ b/docs/gcp/explore/user-creation.mdx @@ -2,17 +2,17 @@ title: User Creation sidebar_position: 5 --- + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import styles from "@site/docs/stylesheets/tabs.module.css"; - import GitHubUserCreation from '@site/docs/gcp/partials/github/_user-creation.mdx' import GitLabUserCreation from '@site/docs/gcp/partials/gitlab/_user-creation.mdx' - @@ -22,7 +22,7 @@ import GitLabUserCreation from '@site/docs/gcp/partials/gitlab/_user-creation.md > - - \ No newline at end of file + diff --git a/docs/gcp/overview.mdx b/docs/gcp/overview.mdx index 727dccd2..002d5f0a 100644 --- a/docs/gcp/overview.mdx +++ b/docs/gcp/overview.mdx @@ -3,42 +3,41 @@ hide_title: true sidebar_label: Overview sidebar_position: 1 # custom_edit_url: https://github.com/facebook/docusaurus/edit/main/docs/api-doc-markdown.md -description: an overview of kubefirst on a gcp kubernetes cluster +description: an overview of kubefirst on a Google Cloud kubernetes cluster image: "https://docs.kubefirst.io/img/logo.svg" + --- import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import styles from "@site/docs/stylesheets/tabs.module.css"; import ReactDom from 'react-dom' import * as config from "@site/docs/constants.js" - import GitHubOverview from '@site/docs/gcp/partials/github/_overview.mdx' import GitLabOverview from '@site/docs/gcp/partials/gitlab/_overview.mdx' import CloudBanner from '@site/src/components/CloudBanner/CloudBanner.jsx' +import CommonProvisionProcess from "@site/docs/common/partials/common/_provision-process.mdx"; # Overview -The gcp provisioning process will: -- create a gitops git repository from our gitops-template and store it in your git provider -- create a kubernetes cluster in the gcp cloud -- install argocd bootstrapped against your gitops repo so your repo powers the platform -- install all the platform apps using gitops (gitops repo `/registry` folder) -- apply terraform to configure Vault (gitops repo `/terraform/vault` folder) -- bind a webhook to ngrok in cluster so you can automate terraform executions through atlantis -- integrate argo workflows with your git provider -- install argo workflow [cluster workflow templates](https://argoproj.github.io/argo-workflows/cluster-workflow-templates/#cluster-workflow-templates) to build containers, publish charts, and provide gitops delivery pipelines -- install a sample app git repository that uses this automation to demonstrate app delivery (metaphor repo) +:::caution + +Google Cloud is in beta. Use at your own risks. + +::: + +The Google Cloud provisioning process will: + -![kubefirst gcp with GitLab Cluster Diagram](../img/gcp/gitlab/installation-diagram-light.png#light-mode)![kubefirst gcp with GitLab Cluster Diagram](../img/gcp/gitlab/installation-diagram-dark.png#dark-mode) +![kubefirst Google Cloud with GitLab Cluster Diagram](../img/gcp/gitlab/installation-diagram-light.png#light-mode)![kubefirst Google Cloud with GitLab Cluster Diagram](../img/gcp/gitlab/installation-diagram-dark.png#dark-mode) # Applications - @@ -48,7 +47,7 @@ The gcp provisioning process will: > - GitLab SaaS offering has limitations that require us to use groups contrary to GitHub which can be use without an organization. -### gcp +### Google Cloud -For kubefirst to be able to provision your gcp cloud resources: +For kubefirst to be able to provision your Google Cloud resources: -- A [gcp account](https://dashboard.gcp.com/signup) in which you are an account owner. -- A publicly routable [DNS](https://www.gcp.com/learn/configure-dns#adding-a-domain-name). -- A [gcp token](https://dashboard.gcp.com/security). +- A [Google Cloud account](https://cloud.google.com) in which you are an account owner. +- A publicly routable [DNS](https://cloud.google.com/dns/docs/overview). +- Generate [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials#GAC) (ADC) (you could use the [Google Cloud CLI](https://cloud.google.com/sdk/gcloud) with the command `gcloud auth application-default login`) ## Create your new kubefirst cluster -Adjust the following command with your GitHub and gcp tokens in addition to the appropriate values for your new platform. +Adjust the following command with your GitHub and Google Cloud credentials file path (it's set to the default for macOS in the code example below) in addition to the appropriate values for your new platform. ```shell export GITLAB_TOKEN=xxxxxxxxxxxxxxxx -export gcp_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +export GOOGLE_APPLICATION_CREDENTIALS=$HOME/.config/gcloud/application_default_credentials.json -kubefirst gcp create \ +kubefirst beta gcp create \ --alerts-email yourdistro@your-company.io \ --git-provider gitlab \ --gitlab-group your-gitlab-group \ @@ -37,9 +37,9 @@ kubefirst gcp create \ --cluster-name kubefirst ``` -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. +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 gcp cluster. +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. If your deployment is not successful, errors and troubleshooting information will be stored in a local log file specified during the installation run. @@ -56,7 +56,7 @@ If your deployment is not successful, errors and troubleshooting information wil To obtain your 3 initial passwords, run ```bash -kubefirst gcp root-credentials +kubefirst beta gcp root-credentials ``` ![terminal handoff](../../../img/common/kubefirst/root-credentials.png) @@ -77,4 +77,4 @@ kubectl get pods -A ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). \ No newline at end of file +To see what is installed by kubefirst, check the [overview page](../../overview.mdx). diff --git a/docs/gcp/partials/gitlab/_overview.mdx b/docs/gcp/partials/gitlab/_overview.mdx index 274839c8..7780a73a 100644 --- a/docs/gcp/partials/gitlab/_overview.mdx +++ b/docs/gcp/partials/gitlab/_overview.mdx @@ -1,6 +1,6 @@ -`kubefirst gcp create` provisions a local [gcp](https://gcp.com) Kubernetes cluster to host your cloud native environment locally. +`kubefirst beta gcp create` provisions a local [Google Cloud](https://gcp.com) Kubernetes cluster to host your cloud native environment locally. -Your gcp cluster will include: +Your Google Cloud cluster will include: | Application | Description | |---------------------------------|-----------------------------------------------------------------------------| diff --git a/docs/gcp/partials/gitlab/_prerequisites.mdx b/docs/gcp/partials/gitlab/_prerequisites.mdx index 63993ae3..131880f2 100644 --- a/docs/gcp/partials/gitlab/_prerequisites.mdx +++ b/docs/gcp/partials/gitlab/_prerequisites.mdx @@ -4,4 +4,4 @@ - Create a [GitLab group](https://docs.gitlab.com/ee/user/group/) developer permissions. :::note GitLab SaaS offering has limitations that require us to use groups contrary to GitHub which can be use without an organization. -::: \ No newline at end of file +::: diff --git a/docs/gcp/partials/gitlab/_repositories.mdx b/docs/gcp/partials/gitlab/_repositories.mdx index 3bbab94c..79e8fc19 100644 --- a/docs/gcp/partials/gitlab/_repositories.mdx +++ b/docs/gcp/partials/gitlab/_repositories.mdx @@ -1,6 +1,6 @@ # GitLab Repositories -When you install the gcp version of kubefirst, 2 new repositories will be added to your GitLab project as shown here. +When you install the Google Cloud version of kubefirst, 2 new repositories will be added to your GitLab project as shown here. ![GitLab repositories](../../../img/common/gitlab/repositories.png) @@ -8,7 +8,7 @@ When you install the gcp version of kubefirst, 2 new repositories will be added ### gitops -The GitOps repo houses all of our IAC and all our GitOps configurations. All of the infrastructure that you receive with Kubefirst was produced by some combination of Terraform and ArgoCD. You can add any infrastructure or application to your platform by pull requesting it to your new `gitops` repository. +The `gitops` repository houses all of our IAC and all our GitOps configurations. All of the infrastructure that you receive with kubefirst was produced by some combination of Terraform and Argo CD. You can add any infrastructure or application to your platform by pull requesting it to your new `gitops` repository. ### metaphor diff --git a/docs/gcp/partials/gitlab/_user-creation.mdx b/docs/gcp/partials/gitlab/_user-creation.mdx index 1ea5dc95..bf5fe9f7 100644 --- a/docs/gcp/partials/gitlab/_user-creation.mdx +++ b/docs/gcp/partials/gitlab/_user-creation.mdx @@ -60,4 +60,4 @@ Once you've provided them their initial password, they can update their own pass ![default user creation](../../../img/kubefirst/local/default-user-creation.png) -The admins and developers that you add through IaC will automatically propagate to all tools due to the Vault OIDC provider that's preconfigured throughout the kubefirst platform tools. \ No newline at end of file +The admins and developers that you add through IaC will automatically propagate to all tools due to the Vault OIDC provider that's preconfigured throughout the kubefirst platform tools. diff --git a/docs/gcp/platform.mdx b/docs/gcp/platform.mdx index 3a2f232d..67c8d66a 100644 --- a/docs/gcp/platform.mdx +++ b/docs/gcp/platform.mdx @@ -5,6 +5,7 @@ sidebar_label: kubefirst Platform description: an overview of kubefirst image: "https://docs.kubefirst.io/img/logo.svg" --- + import Platform from "@site/docs/common/platform.mdx" - \ No newline at end of file + diff --git a/docs/gcp/quick-start/install/ui.mdx b/docs/gcp/quick-start/install/ui.mdx index a7121c75..2c4d0f6e 100644 --- a/docs/gcp/quick-start/install/ui.mdx +++ b/docs/gcp/quick-start/install/ui.mdx @@ -8,9 +8,7 @@ image: "https://docs.kubefirst.io/img/logo.svg" There are a few ways to install kubefirst, whether you have a cluster already or don't. - - -# Install Kubefirst +# Install kubefirst ## Step 1: Install kubefirst console @@ -18,11 +16,9 @@ There are a few ways to install kubefirst, whether you have a cluster already or # Helm -This will install our platform installer tools to your existing cluster so you can -create your new management cluster in your favorite cloud provider using your -favorite git provider. +This will install our platform installer tools to your existing cluster so you can create your new management cluster in your favorite cloud provider using your favorite git provider. -``` +```shell helm repo add kubefirst https://charts.kubefirst.com helm repo update @@ -35,14 +31,11 @@ Then connect to the provisioning tool at [http://localhost:8080](http://localhos # Helm (ARM / M1 Mac / M2 Mac) -This will install our platform installer UI to your existing cluster so you can -create your new management cluster in your favorite cloud provider using your -favorite git provider. +This will install our platform installer UI to your existing cluster so you can create your new management cluster in your favorite cloud provider using your favorite git provider. -This example shows a couple additional helm values settings that enable mongo to -run on the ARM architecture. +This example shows a couple additional Helm values settings that enable MongoDB to run on the ARM architecture. -``` +```shell helm repo add kubefirst https://charts.kubefirst.com helm repo update @@ -58,18 +51,17 @@ k port-forward svc/kubefirst-console 8080:8080 Then connect to the provisioning tool at [http://localhost:8080](http://localhost:8080) -# No kubernetes yet? +# No Kubernetes yet? **No cluster? No problem!** Let us create your bootstrap cluster for you as well. We'll install our provisioning tool into it to create your permanent infrastructure. -``` +```shell brew install kubefirst/tools/kubefirst kubefirst launch up ``` -Then connect to the provisioning tool at -[https://console.kubefirst.dev](https://console.kubefirst.dev ) +Then connect to the provisioning tool at [https://console.kubefirst.dev](https://console.kubefirst.dev ) :::note The kubefirst.dev domain is only available after `kubefirst launch up` and resolves to the host machine. @@ -81,4 +73,4 @@ The kubefirst.dev domain is only available after `kubefirst launch up` and resol Provide details about your preferred git provider, cloud provider, access, and cluster details and let kubefirst do the rest. -![kubefirst user interface showing cloud and git options](../../../img/console/installer.png) \ No newline at end of file +![kubefirst user interface showing cloud and git options](../../../img/console/installer.png) diff --git a/docs/gcp/quick-start/repositories.mdx b/docs/gcp/quick-start/repositories.mdx index 30e13239..ed00b05b 100644 --- a/docs/gcp/quick-start/repositories.mdx +++ b/docs/gcp/quick-start/repositories.mdx @@ -6,12 +6,14 @@ sidebar_position: 3 description: the installation process for kubefirst cli image: "https://docs.kubefirst.io/img/logo.svg" --- + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import styles from "@site/docs/stylesheets/tabs.module.css"; import ReactDom from 'react-dom' import * as config from "@site/docs/constants.js" - +import GitHubRepositories from '@site/docs/gcp/partials/github/_repositories.mdx' +import GitLabRepositories from '@site/docs/gcp/partials/gitlab/_repositories.mdx'
-import GitHubRepositories from '@site/docs/gcp/partials/github/_repositories.mdx' -import GitLabRepositories from '@site/docs/gcp/partials/gitlab/_repositories.mdx' - - @@ -41,7 +40,7 @@ import GitLabRepositories from '@site/docs/gcp/partials/gitlab/_repositories.mdx > - +
+
+
+ Google Cloud +
+
+

Google Cloud

+

Google Cloud Platform, offered by Google, is a suite of cloud computing services that runs on the same infrastructure that Google uses internally for its end-user products, such as Google Search, Gmail, Google Drive, and YouTube.

+
+
+
+ +
+
+
+
diff --git a/docusaurus.config.js b/docusaurus.config.js index 86e6a0fd..2e7c1671 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -135,7 +135,7 @@ const config = { type: 'docSidebar', position: 'left', sidebarId: 'gcp', - label: 'GCP', + label: 'Google Cloud', }, { type: 'docsVersionDropdown', diff --git a/styles/Custom/ignore.txt b/styles/Custom/ignore.txt index 8d5aee15..43747ffc 100644 --- a/styles/Custom/ignore.txt +++ b/styles/Custom/ignore.txt @@ -22,6 +22,7 @@ eks # F # G +gcp github gitlab gitops diff --git a/styles/Custom/substitutions.yml b/styles/Custom/substitutions.yml index d3be10d4..f927f3b3 100644 --- a/styles/Custom/substitutions.yml +++ b/styles/Custom/substitutions.yml @@ -24,6 +24,8 @@ swap: ecr: ECR eks: EKS docker: Docker + gcp: Google Cloud + gcp cloud: Google Cloud # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) '[G|g]ithub': GitHub # Starting or with a space before, and ending with a dot or space (so not working used in a path, caused of MDX) diff --git a/styles/Vocab/base/accept.txt b/styles/Vocab/base/accept.txt index fe8c4451..bb7a96c3 100644 --- a/styles/Vocab/base/accept.txt +++ b/styles/Vocab/base/accept.txt @@ -1,4 +1,5 @@ # A +admunition anonymize auditable automation diff --git a/versioned_docs/version-2.0/gcp/upgrade.md b/versioned_docs/version-2.0/gcp/upgrade.md new file mode 100644 index 00000000..d264485c --- /dev/null +++ b/versioned_docs/version-2.0/gcp/upgrade.md @@ -0,0 +1,5 @@ +--- +title: Google Cloud +--- + +Google Cloud support was added in kubefirst 2.1.2, please upgrade your client to 2.1.2 or later to use this cloud provider. diff --git a/versioned_docs/version-2.1/gcp/upgrade.md b/versioned_docs/version-2.1/gcp/upgrade.md new file mode 100644 index 00000000..d264485c --- /dev/null +++ b/versioned_docs/version-2.1/gcp/upgrade.md @@ -0,0 +1,5 @@ +--- +title: Google Cloud +--- + +Google Cloud support was added in kubefirst 2.1.2, please upgrade your client to 2.1.2 or later to use this cloud provider. diff --git a/versioned_docs/version-2.2/gcp/upgrade.md b/versioned_docs/version-2.2/gcp/upgrade.md new file mode 100644 index 00000000..d264485c --- /dev/null +++ b/versioned_docs/version-2.2/gcp/upgrade.md @@ -0,0 +1,5 @@ +--- +title: Google Cloud +--- + +Google Cloud support was added in kubefirst 2.1.2, please upgrade your client to 2.1.2 or later to use this cloud provider. diff --git a/versioned_sidebars/version-2.0-sidebars.json b/versioned_sidebars/version-2.0-sidebars.json index 79d706c5..d8198ae8 100644 --- a/versioned_sidebars/version-2.0-sidebars.json +++ b/versioned_sidebars/version-2.0-sidebars.json @@ -198,5 +198,8 @@ ], "vultr": [ "kubefirst/vultr/upgrade" + ], + "gcp": [ + "gcp/upgrade" ] } diff --git a/versioned_sidebars/version-2.1-sidebars.json b/versioned_sidebars/version-2.1-sidebars.json index 5fc2f1e7..bfd86c65 100644 --- a/versioned_sidebars/version-2.1-sidebars.json +++ b/versioned_sidebars/version-2.1-sidebars.json @@ -77,5 +77,8 @@ ], "vultr": [ "vultr/upgrade" + ], + "gcp": [ + "gcp/upgrade" ] } diff --git a/versioned_sidebars/version-2.2-sidebars.json b/versioned_sidebars/version-2.2-sidebars.json index af4c0032..97c29217 100644 --- a/versioned_sidebars/version-2.2-sidebars.json +++ b/versioned_sidebars/version-2.2-sidebars.json @@ -79,5 +79,8 @@ ], "vultr": [ "vultr/upgrade" + ], + "gcp": [ + "gcp/upgrade" ] }