From 978ea3f3ac5c437f57db628af127aeb4f24879ec Mon Sep 17 00:00:00 2001 From: Simon Emms Date: Mon, 11 Nov 2024 10:17:39 +0000 Subject: [PATCH 1/7] chore(devcontainer): add vale --- .devcontainer/devcontainer.json | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 1c4d7f45..08f7185f 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,11 +1,14 @@ { "name": "devcontainer", "image": "ghcr.io/kubefirst/devcontainers/full", - "features": {}, + "features": { + "ghcr.io/shinepukur/devcontainer-features/vale:1": {} + }, "customizations": { "vscode": { "extensions": [ - "unifiedjs.vscode-mdx" + "unifiedjs.vscode-mdx", + "ChrisChinchilla.vale-vscode" ], "settings": {} } From d709dd7863671926308786132de613c517fa64bf Mon Sep 17 00:00:00 2001 From: Simon Emms Date: Mon, 11 Nov 2024 10:30:50 +0000 Subject: [PATCH 2/7] fix: update references to kubefirst for Kubefirst --- .vale/Custom/ignore.txt | 2 +- CONTRIBUTING.md | 2 +- README.md | 2 +- .../common/_installed-applications.mdx | 2 +- .../akamai/partials/common/_prerequisites.mdx | 2 +- .../partials/github/_cluster-create.mdx | 2 +- .../partials/gitlab/_cluster-create.mdx | 2 +- docs/aws/advanced/certificates.mdx | 2 +- docs/aws/advanced/security.mdx | 2 +- docs/aws/partials/common/_ecr.mdx | 2 +- docs/aws/partials/github/_cluster-create.mdx | 2 +- docs/aws/partials/gitlab/_cluster-create.mdx | 2 +- .../common/_installed-applications.mdx | 2 +- docs/civo/partials/common/_prerequisites.mdx | 4 +-- docs/civo/partials/github/_cluster-create.mdx | 2 +- docs/civo/partials/gitlab/_cluster-create.mdx | 2 +- docs/civo/quick-start/install/marketplace.mdx | 16 +++++----- docs/common/clusters.mdx | 12 +++---- docs/common/credits.mdx | 4 +-- docs/common/deprovision.mdx | 14 ++++---- docs/common/faq.mdx | 32 +++++++++---------- docs/common/gitops-catalog.mdx | 12 +++---- docs/common/gitops.mdx | 4 +-- docs/common/known-limitations.mdx | 2 +- docs/common/metaphor.mdx | 4 +-- docs/common/partials/common/_cli.mdx | 2 +- .../partials/common/_cloudflare-dns.mdx | 2 +- .../common/_prerequisites-homebrew.mdx | 2 +- .../common/_prerequisites-windows.mdx | 2 +- .../common/partials/common/_prerequisites.mdx | 2 +- .../partials/common/_root-credentials-cmd.mdx | 2 +- .../partials/common/_terminal-output.mdx | 4 +-- docs/common/partials/github/_repositories.mdx | 6 ++-- docs/common/partials/github/_tokens.mdx | 14 ++++---- .../common/partials/github/_user-creation.mdx | 6 ++-- docs/common/partials/gitlab/_repositories.mdx | 6 ++-- docs/common/partials/gitlab/_tokens.mdx | 10 +++--- .../common/partials/gitlab/_user-creation.mdx | 6 ++-- docs/common/telemetry.mdx | 4 +-- docs/common/ui.mdx | 12 +++---- docs/common/users.mdx | 2 +- docs/common/vault.mdx | 10 +++--- .../common/_installed-applications.mdx | 2 +- docs/do/partials/common/_prerequisites.mdx | 2 +- docs/do/partials/github/_cluster-create.mdx | 2 +- docs/do/partials/gitlab/_cluster-create.mdx | 2 +- docs/do/quick-start/install/marketplace.mdx | 20 ++++++------ .../common/_installed-applications.mdx | 2 +- docs/gcp/partials/common/_prerequisites.mdx | 2 +- docs/gcp/partials/github/_cluster-create.mdx | 2 +- docs/gcp/partials/gitlab/_cluster-create.mdx | 2 +- docs/index.mdx | 4 +-- docs/k3d/explore/vault.mdx | 2 +- docs/k3d/faq.mdx | 6 ++-- docs/k3d/partials/github/_install.mdx | 16 +++++----- docs/k3d/partials/gitlab/_install.mdx | 16 +++++----- docs/k3d/quick-start/install.mdx | 2 +- .../common/_installed-applications.mdx | 2 +- docs/k3s/partials/common/_prerequisites.mdx | 2 +- docs/k3s/partials/github/_cluster-create.mdx | 4 +-- docs/k3s/partials/gitlab/_cluster-create.mdx | 2 +- .../common/_installed-applications.mdx | 2 +- docs/vultr/partials/common/_prerequisites.mdx | 2 +- .../vultr/partials/github/_cluster-create.mdx | 2 +- .../vultr/partials/gitlab/_cluster-create.mdx | 2 +- 65 files changed, 163 insertions(+), 163 deletions(-) diff --git a/.vale/Custom/ignore.txt b/.vale/Custom/ignore.txt index aec6662e..3408b717 100644 --- a/.vale/Custom/ignore.txt +++ b/.vale/Custom/ignore.txt @@ -37,7 +37,7 @@ iam # K kubeconfig -kubefirst +Kubefirst kubernetes # L diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4abce769..1ecd8bcd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Firstly, we want to thank you for investing your valuable time to contribute to Note we have a [code of conduct](CODE_OF_CONDUCT.md) which needs to be followed in all your interactions with the project to keep our community healthy. -_For contribution to the Kubefirst CLI, please refer yourself to the [CONTRIBUTING.md](https://github.com/konstructio/kubefirst/blob/main/CONTRIBUTING.md) from the [kubefirst repository](https://github.com/konstructio/kubefirst)._ +_For contribution to the Kubefirst CLI, please refer yourself to the [CONTRIBUTING.md](https://github.com/konstructio/kubefirst/blob/main/CONTRIBUTING.md) from the [Kubefirst repository](https://github.com/konstructio/kubefirst)._ - [Ways to Contribute](#ways-to-contribute) - [Getting Started](#getting-started) diff --git a/README.md b/README.md index 00387938..9295fc64 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

-# kubefirst Docs +# Kubefirst Docs Welcome to the open source repository that powers [the Kubefirst documentation](https://kubefirst.konstruct.io/docs). diff --git a/docs/akamai/partials/common/_installed-applications.mdx b/docs/akamai/partials/common/_installed-applications.mdx index 3a8283c0..d563d7a9 100644 --- a/docs/akamai/partials/common/_installed-applications.mdx +++ b/docs/akamai/partials/common/_installed-applications.mdx @@ -1,3 +1,3 @@ ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). +To see what is installed by Kubefirst, check the [overview page](../../overview.mdx). diff --git a/docs/akamai/partials/common/_prerequisites.mdx b/docs/akamai/partials/common/_prerequisites.mdx index 7b95ba91..0ad5709b 100644 --- a/docs/akamai/partials/common/_prerequisites.mdx +++ b/docs/akamai/partials/common/_prerequisites.mdx @@ -1,6 +1,6 @@ ### Akamai Prerequisites -For kubefirst to be able to provision your Akamai cloud resources: +For Kubefirst to be able to provision your Akamai cloud resources: - A [Akamai account](https://www.akamai.com/create-account) in which you are an account owner. - A [Linode API token](https://cloud.linode.com/profile/tokens). diff --git a/docs/akamai/partials/github/_cluster-create.mdx b/docs/akamai/partials/github/_cluster-create.mdx index 26948ed1..aef9e0eb 100644 --- a/docs/akamai/partials/github/_cluster-create.mdx +++ b/docs/akamai/partials/github/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## Create your new Kubefirst cluster Adjust the following command with your GitHub and Akamai (Linode) tokens in addition to the appropriate values for your new platform. diff --git a/docs/akamai/partials/gitlab/_cluster-create.mdx b/docs/akamai/partials/gitlab/_cluster-create.mdx index e253c978..a1720be0 100644 --- a/docs/akamai/partials/gitlab/_cluster-create.mdx +++ b/docs/akamai/partials/gitlab/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## Create your new Kubefirst cluster Adjust the following command with your GitHub and Akamai (Linode) tokens in addition to the appropriate values for your new platform. diff --git a/docs/aws/advanced/certificates.mdx b/docs/aws/advanced/certificates.mdx index 4f3604f3..4216b036 100644 --- a/docs/aws/advanced/certificates.mdx +++ b/docs/aws/advanced/certificates.mdx @@ -10,4 +10,4 @@ import AWSLogo from '../../img/aws/logo.svg'; ## SSL Certificates -In cloud versions of the kubefirst platform, we use [cert-manager](https://cert-manager.io/) with a [Let's Encrypt](https://letsencrypt.org) ClusterIssuer for TLS encryption to all of our services on Ingress. These certificates are requested automatically, and will auto-renew. +In cloud versions of the Kubefirst platform, we use [cert-manager](https://cert-manager.io/) with a [Let's Encrypt](https://letsencrypt.org) ClusterIssuer for TLS encryption to all of our services on Ingress. These certificates are requested automatically, and will auto-renew. diff --git a/docs/aws/advanced/security.mdx b/docs/aws/advanced/security.mdx index 190fb1b2..bfa211f1 100644 --- a/docs/aws/advanced/security.mdx +++ b/docs/aws/advanced/security.mdx @@ -10,7 +10,7 @@ import AWSLogo from '../../img/aws/logo.svg'; ## Installation Account -kubefirst runs against your public cloud provider and leverages your personal cloud credentials in order to conduct the provisioning of the kubefirst platform. We do not embed your credentials into the platform in any way, they are only used during the installation process. +Kubefirst runs against your public cloud provider and leverages your personal cloud credentials in order to conduct the provisioning of the Kubefirst platform. We do not embed your credentials into the platform in any way, they are only used during the installation process. ## Granular Kubernetes Service Accounts with Explicit IAM Roles for Cloud Access diff --git a/docs/aws/partials/common/_ecr.mdx b/docs/aws/partials/common/_ecr.mdx index e8001d0e..2b871e12 100644 --- a/docs/aws/partials/common/_ecr.mdx +++ b/docs/aws/partials/common/_ecr.mdx @@ -1,5 +1,5 @@ :::tip -By default kubefirst use the Git provider you selected as container registry. With AWS, you have the option to use EKS instead. To do so, add the flag `--ecr` with the value `true` to your cluster creation command. +By default Kubefirst use the Git provider you selected as container registry. With AWS, you have the option to use EKS instead. To do so, add the flag `--ecr` with the value `true` to your cluster creation command. ::: diff --git a/docs/aws/partials/github/_cluster-create.mdx b/docs/aws/partials/github/_cluster-create.mdx index 76082163..5aa90ede 100644 --- a/docs/aws/partials/github/_cluster-create.mdx +++ b/docs/aws/partials/github/_cluster-create.mdx @@ -1,7 +1,7 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; import ECR from "../common/_ecr.mdx"; -## Create your new kubefirst cluster +## Create your new Kubefirst cluster Adjust the following command with your GitHub token in addition to the appropriate values for your new platform. diff --git a/docs/aws/partials/gitlab/_cluster-create.mdx b/docs/aws/partials/gitlab/_cluster-create.mdx index 63348c3c..a23e8629 100644 --- a/docs/aws/partials/gitlab/_cluster-create.mdx +++ b/docs/aws/partials/gitlab/_cluster-create.mdx @@ -1,7 +1,7 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; import ECR from "../common/_ecr.mdx"; -## Create your new kubefirst cluster +## Create your new Kubefirst cluster Adjust the following command with your GitLab token in addition to the appropriate values for your new platform. diff --git a/docs/civo/partials/common/_installed-applications.mdx b/docs/civo/partials/common/_installed-applications.mdx index 3a8283c0..d563d7a9 100644 --- a/docs/civo/partials/common/_installed-applications.mdx +++ b/docs/civo/partials/common/_installed-applications.mdx @@ -1,3 +1,3 @@ ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). +To see what is installed by Kubefirst, check the [overview page](../../overview.mdx). diff --git a/docs/civo/partials/common/_prerequisites.mdx b/docs/civo/partials/common/_prerequisites.mdx index 70ee1c51..fbe67254 100644 --- a/docs/civo/partials/common/_prerequisites.mdx +++ b/docs/civo/partials/common/_prerequisites.mdx @@ -1,13 +1,13 @@ ### Civo Prerequisites -For kubefirst to be able to provision your Civo cloud resources: +For Kubefirst to be able to provision your Civo cloud resources: - A [Civo account](https://dashboard.civo.com/signup) in which you are an account owner. - A publicly routable [DNS](https://www.civo.com/learn/configure-dns#adding-a-domain-name). - A [Civo token](https://dashboard.civo.com/security). :::info -kubefirst is keeping low the resources needed to create your Kubernetes cluster, but if you are already using Civo, note that you may have exceeding quota issues during the creation process. +Kubefirst is keeping low the resources needed to create your Kubernetes cluster, but if you are already using Civo, note that you may have exceeding quota issues during the creation process. Civo has a quota based on a combined allocation of instances/Kubernetes nodes, CPUs, RAM usage, and other resources. All customers start with a [basic quota level](https://www.civo.com/docs/account/quota), but you can [request quota increase](https://www.civo.com/docs/account/quota#requesting-a-quota-increase). ::: diff --git a/docs/civo/partials/github/_cluster-create.mdx b/docs/civo/partials/github/_cluster-create.mdx index 39e0daed..6b3801e2 100644 --- a/docs/civo/partials/github/_cluster-create.mdx +++ b/docs/civo/partials/github/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## 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. diff --git a/docs/civo/partials/gitlab/_cluster-create.mdx b/docs/civo/partials/gitlab/_cluster-create.mdx index ca098a15..2ffe0f7d 100644 --- a/docs/civo/partials/gitlab/_cluster-create.mdx +++ b/docs/civo/partials/gitlab/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## 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. diff --git a/docs/civo/quick-start/install/marketplace.mdx b/docs/civo/quick-start/install/marketplace.mdx index 2f6544bd..5c602fc0 100644 --- a/docs/civo/quick-start/install/marketplace.mdx +++ b/docs/civo/quick-start/install/marketplace.mdx @@ -5,9 +5,9 @@ sidebar_position: 1 image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg" --- -# Install kubefirst using the Civo Marketplace +# Install Kubefirst using the Civo Marketplace -You can create a temporary kubefirst installer cluster through the Civo Kubernetes marketplace, and use it to create your kubefirst management cluster. +You can create a temporary Kubefirst installer cluster through the Civo Kubernetes marketplace, and use it to create your Kubefirst management cluster. ## Create your installer cluster @@ -20,9 +20,9 @@ Log into your Civo account and navigate to [Kubernetes](https://dashboard.civo.c 5. In the Marketplace section select `kubefirst` 6. Click Create Cluster and wait until the cluster is ready -![kubefirst user interface showing cloud and git options](../../../img/civo/marketplace/installer-options.png) +![Kubefirst user interface showing cloud and git options](../../../img/civo/marketplace/installer-options.png) -## Connect to the install cluster and the kubefirst installer service +## Connect to the install cluster and the Kubefirst installer service In your terminal, run the following commands to download and use your new cluster's kubeconfig. This example assumes you named your cluster `installer`. @@ -35,12 +35,12 @@ Then launch the installer in your browser: [http://localhost:8080/](http://localhost:8080/) -## Create your kubefirst management cluster +## Create your Kubefirst management cluster -Provide details about your preferred Git provider, access, and cluster details and let kubefirst do the rest. +Provide details about your preferred Git provider, access, and cluster details and let Kubefirst do the rest. -![kubefirst user interface showing cloud and git options](../../../img/civo/marketplace/create-management.png) +![Kubefirst user interface showing cloud and git options](../../../img/civo/marketplace/create-management.png) ## Deleting your installer cluster -Once you've successfully installed your kubefirst `management` cluster, you can delete the `installer` cluster directly in the Civo UI. It is only used to establish the platform. +Once you've successfully installed your Kubefirst `management` cluster, you can delete the `installer` cluster directly in the Civo UI. It is only used to establish the platform. diff --git a/docs/common/clusters.mdx b/docs/common/clusters.mdx index 8b1f6235..5461e419 100644 --- a/docs/common/clusters.mdx +++ b/docs/common/clusters.mdx @@ -1,10 +1,10 @@ -The kubefirst 2.3 release introduces Kubernetes cluster lifecycle management to the platform to provide our users with the ability to create their own opinionated workload clusters in a way that takes advantage of their management cluster. We're introducing both physical clusters, which will be created in your cloud account, as well as virtual clusters, which are also isolated Kubernetes clusters, but which run inside your management cluster. +The Kubefirst 2.3 release introduces Kubernetes cluster lifecycle management to the platform to provide our users with the ability to create their own opinionated workload clusters in a way that takes advantage of their management cluster. We're introducing both physical clusters, which will be created in your cloud account, as well as virtual clusters, which are also isolated Kubernetes clusters, but which run inside your management cluster. -![cluster creation in kubefirst user interface](../img/kubefirst/getting-started/cluster-creation.gif) +![cluster creation in Kubefirst user interface](../img/kubefirst/getting-started/cluster-creation.gif) ## GitOps-Oriented Workload Clusters -By default, a new kubefirst will provide you with 2 template-driven directories that will drive how your workload clusters are created. +By default, a new Kubefirst will provide you with 2 template-driven directories that will drive how your workload clusters are created. ![cluster template directories in GitOps repository](../img/kubefirst/getting-started/cluster-template.png) @@ -33,9 +33,9 @@ If you inspect your templates for cluster and vcluster, you'll find them to be v - you can customize this template in your `gitops` repository as your needs require :::tip -The kubefirst Console "Physical Clusters" feature will be the first feature of our upcoming Pro tier. We'd love for you to try it out and tell us what you think during its free introductory period. +The Kubefirst Console "Physical Clusters" feature will be the first feature of our upcoming Pro tier. We'd love for you to try it out and tell us what you think during its free introductory period. -We plan to keep the kubefirst Console "Virtual Clusters" feature on the Community tier at no cost. +We plan to keep the Kubefirst Console "Virtual Clusters" feature on the Community tier at no cost. You will always be able to create anything you need on your own without our user interface, and we hope you find that starting point immensely valuable. We hope to earn your business with our management interface. Thank you sincerely to all of our customers. ::: @@ -48,4 +48,4 @@ Cluster creation takes about 6 minutes to fully sync in Argo CD for virtual clus Your workload cluster will have a starting point app-of-apps in Argo CD in the `clusters` app and will share your cluster's name. -When you delete a cluster, kubefirst will remove the binding from your management cluster so that it begins deleting in Argo CD, but we must leave the directory there so that the apps can remove gracefully. You're free to remove it once cluster deprovisioning has completed successfully. Deletion takes time to deprovision resources - can be anywhere from 5 to 15 minutes depending on the cloud. Be patient and inspect the deprovision operation in Argo CD. +When you delete a cluster, Kubefirst will remove the binding from your management cluster so that it begins deleting in Argo CD, but we must leave the directory there so that the apps can remove gracefully. You're free to remove it once cluster deprovisioning has completed successfully. Deletion takes time to deprovision resources - can be anywhere from 5 to 15 minutes depending on the cloud. Be patient and inspect the deprovision operation in Argo CD. diff --git a/docs/common/credits.mdx b/docs/common/credits.mdx index fa2d38a2..3ef8f205 100644 --- a/docs/common/credits.mdx +++ b/docs/common/credits.mdx @@ -1,6 +1,6 @@ ## The Tools We Love -The kubefirst platform uses some of the most popular open source projects in the world, and some closed sources ones (as little as possible). This page is dedicated to giving those projects credit for their incredible offerings. +The Kubefirst platform uses some of the most popular open source projects in the world, and some closed sources ones (as little as possible). This page is dedicated to giving those projects credit for their incredible offerings. - [Actions Runner Controller](https://github.com/actions/actions-runner-controller) ([Apache 2.0](https://github.com/external-secrets/external-secrets/blob/main/LICENSE)) - [Argo CD](https://github.com/argoproj/argo-cd) ([Apache 2.0](https://github.com/argoproj/argo-cd/blob/master/LICENSE)) @@ -27,7 +27,7 @@ The kubefirst platform uses some of the most popular open source projects in the - [vcluster](https://github.com/loft-sh/vcluster) ([Apache 2.0](https://github.com/loft-sh/vcluster/blob/main/LICENSE)) :::note -Please evaluate each licenses for third-party products used by kubefirst to validate if you can legally use them for your specific use case and legal status. +Please evaluate each licenses for third-party products used by Kubefirst to validate if you can legally use them for your specific use case and legal status. ::: ### Additional References diff --git a/docs/common/deprovision.mdx b/docs/common/deprovision.mdx index 61596818..fcc1a527 100644 --- a/docs/common/deprovision.mdx +++ b/docs/common/deprovision.mdx @@ -15,13 +15,13 @@ import GetAkamaiKubeconfig from '../akamai/partials/common/_get-kubeconfig.mdx'; # Deprovision -To destroy your kubefirst cluster, complete the following steps. +To destroy your Kubefirst cluster, complete the following steps. ## Prerequisites -### kubefirst CLI +### Kubefirst CLI -If you are coming from a cloud marketplace, and didn't use the kubefirst CLI, you will need to install it first. +If you are coming from a cloud marketplace, and didn't use the Kubefirst CLI, you will need to install it first. ```shell brew install konstructio/taps/kubefirst @@ -125,7 +125,7 @@ This will collect the required variables from the necessary secret path and outp If for some reason, Vault wasn't correctly deployed and initiated when you created your cluster, this step won't generate a proper `.env` file. You will still need to continue the deprovision process as it doesn't mean the cluster or other resources weren't created properly. You will either need to set some environment variable manually (see the tip at the [Cloud Provider](#cloud-provider) step to see all values needed) or provide them to Terraform when asked. ::: -Next, you will need to clone the `gitops` repository generated by kubefirst during the initial cluster creation: +Next, you will need to clone the `gitops` repository generated by Kubefirst during the initial cluster creation: ```shell # GitHub @@ -147,7 +147,7 @@ Switch to the `terraform` directory inside of the cloned `gitops` repository. Fo cd gitops/terraform ``` -Within the `terraform` directory, there are several subdirectories that contain the infrastructure-as-code declarations for your kubefirst resources. +Within the `terraform` directory, there are several subdirectories that contain the infrastructure-as-code declarations for your Kubefirst resources. #### Cloud Provider @@ -189,7 +189,7 @@ terraform init terraform destroy ``` -Once you've destroyed `terraform` resources for the cloud and git providers, the only resource left to clean up is the state storage objects that kubefirst created on your behalf. If you'd like to remove these, this can be achieved by using the cloud console or the command-line utility for your chosen cloud provider. +Once you've destroyed `terraform` resources for the cloud and git providers, the only resource left to clean up is the state storage objects that Kubefirst created on your behalf. If you'd like to remove these, this can be achieved by using the cloud console or the command-line utility for your chosen cloud provider. You can now delete the `gitops` repository you cloned on your computer, and the `.env` file: @@ -201,7 +201,7 @@ rm .env ### Console UI -No matter is you created your new cluster, using the CLI directly (`kubefirst create`) or by using the console UI (`kubefirst launch up`), kubefirst will have created a k3d cluster in Docker. We call it the cluster 0, which is either used to display the Console UI, or to connect to our API and create your new kubefirst cluster directly from the CLI. Since it's not needed anymore, you need to destroy it by running: +No matter is you created your new cluster, using the CLI directly (`kubefirst create`) or by using the console UI (`kubefirst launch up`), Kubefirst will have created a k3d cluster in Docker. We call it the cluster 0, which is either used to display the Console UI, or to connect to our API and create your new Kubefirst cluster directly from the CLI. Since it's not needed anymore, you need to destroy it by running: ```shell kubefirst launch down diff --git a/docs/common/faq.mdx b/docs/common/faq.mdx index 4954400c..b34f59a4 100644 --- a/docs/common/faq.mdx +++ b/docs/common/faq.mdx @@ -13,11 +13,11 @@ ## General - [I ran into an issue, what should I do?](#i-ran-into-an-issue-what-should-i-do) -- [I'm experiencing timeouts when kubefirst deploys Argo CD or HashiCorp Vault through the Helm installations](#im-experiencing-timeouts-when-kubefirst-deploys-argo-cd-or-hashicorp-vault-through-the-helm-installations) +- [I'm experiencing timeouts when Kubefirst deploys Argo CD or HashiCorp Vault through the Helm installations](#im-experiencing-timeouts-when-kubefirst-deploys-argo-cd-or-hashicorp-vault-through-the-helm-installations) - [I'm stuck with artifacts after a failed local installation and can't continue](#im-stuck-with-artifacts-after-a-failed-local-installation-and-cant-continue) - [What is the wait.yaml file in each application components folder?](#what-is-the-waityaml-file-in-each-application-components-folder) -- [Can I install kubefirst on an existing cluster?](#can-i-install-kubefirst-on-an-existing-cluster) -- [Does kubefirst add any cloud resources overhead?](#does-kubefirst-add-any-cloud-resources-overhead) +- [Can I install Kubefirst on an existing cluster?](#can-i-install-kubefirst-on-an-existing-cluster) +- [Does Kubefirst add any cloud resources overhead?](#does-kubefirst-add-any-cloud-resources-overhead) - [Can I give the GitOps repository another name?](#can-i-give-the-gitops-repository-another-name) - [How can I unseal HashiCorp Vault?](#how-can-i-unseal-hashicorp-vault) - [Terraform is returning a quota limit exceeded error](#terraform-is-returning-a-quota-limit-exceeded-error) @@ -30,7 +30,7 @@ If an error occurs, try to run the command again if you are using the CLI. Note If you are not sure about the steps to take to fix the problem you encounter, join our [Slack community](https://kubefirst.io/slack), and ask for help in the `#helping-hands` channel. We'll gladly work through it with you. If you think there is a bug, you can also open an [issue](https://github.com/kubefirst/kubefirst/issues) describing the problems you are having. -### I'm experiencing timeouts when kubefirst deploys Argo CD or HashiCorp Vault through the Helm installations +### I'm experiencing timeouts when Kubefirst deploys Argo CD or HashiCorp Vault through the Helm installations You may need a more stable connection / higher download speed. Check with your internet provider or use an online speed test to confirm you have at least 100mbps download speed, or else you may experience timeouts. @@ -39,7 +39,7 @@ You may need a more stable connection / higher download speed. Check with your i If you still cannot complete the installation due to remaining artifacts after completing a `kubefirst k3d destroy`, you may have to do a manual teardown. Firstly, you need to delete the k3d cluster with the following command: ```shell -~/.k1//tools/k3d cluster delete kubefirst +~/.k1//tools/k3d cluster delete Kubefirst kubefirst reset ``` @@ -54,23 +54,23 @@ gh repo delete /gitops --confirm We've had issues with Argo CD and its sync waves not orchestrating correctly (it's a known bug, here's [one example](https://github.com/argoproj/argo-cd/issues/12376)), so we've added the `wait.yml` file as a secondary measure to help with the reliability of the platform provisioning. We may revisit how this is functioning, and remove those files on our platform orchestration evolution. -### Can I install kubefirst on an existing cluster? +### Can I install Kubefirst on an existing cluster? -It is not possible for now to install kubefirst (as in, the management cluster) on an existing cluster. Since our tool install multiple applications to give you that production-grade management cluster, it would be quite risky to do so in a cluster with existing installations that could overlap or interfere with our, or your platform. In addition to that, since a kubefirst cluster is based on the GitOps principles, the systems in place could be removed from the cluster if they are not defined in the source of truth, the `gitops` repository. +It is not possible for now to install Kubefirst (as in, the management cluster) on an existing cluster. Since our tool install multiple applications to give you that production-grade management cluster, it would be quite risky to do so in a cluster with existing installations that could overlap or interfere with our, or your platform. In addition to that, since a Kubefirst cluster is based on the GitOps principles, the systems in place could be removed from the cluster if they are not defined in the source of truth, the `gitops` repository. -One way of _using_ an existing cluster is to go through the process of creating a new management one with kubefirst, and manually creating the proper YAML files in the `gitops` repository to recreate the same application architecture you already had. It's a manual process that could be tedious depending on the size, and complexity of the system you already have in place. Let us know if you need help or have any questions about it. +One way of _using_ an existing cluster is to go through the process of creating a new management one with Kubefirst, and manually creating the proper YAML files in the `gitops` repository to recreate the same application architecture you already had. It's a manual process that could be tedious depending on the size, and complexity of the system you already have in place. Let us know if you need help or have any questions about it. :::info You can use Helm to install the console application on an existing cluster, which we agree, can be confusing. This will give you access to the console application, which will let you **create a new cluster** using the UI installation process, but it won't install any other tools inside the cluster you used with Helm. ::: -### Does kubefirst add any cloud resources overhead? +### Does Kubefirst add any cloud resources overhead? -kubefirst adds virtually no overhead when it comes to cloud resources compared to creating a Kubernetes cluster manually and adding all the tools we install, and configure for you. You can find exactly the resources needed for public clouds by kubefirst from the Terraform files in the [gitops-template repository](https://github.com/kubefirst/gitops-template/) in the `/-/terraform//` folder. +Kubefirst adds virtually no overhead when it comes to cloud resources compared to creating a Kubernetes cluster manually and adding all the tools we install, and configure for you. You can find exactly the resources needed for public clouds by Kubefirst from the Terraform files in the [gitops-template repository](https://github.com/kubefirst/gitops-template/) in the `/-/terraform//` folder. ### Can I give the gitops repository another name? -It is not possible right now to have kubefirst create the `gitops` repository under another name, nor to easily rename it after the creation. Unfortunately, a lot of parts of our code using the repository's name are hardcoded. We may add this option in the future. +It is not possible right now to have Kubefirst create the `gitops` repository under another name, nor to easily rename it after the creation. Unfortunately, a lot of parts of our code using the repository's name are hardcoded. We may add this option in the future. ### How can I unseal HashiCorp Vault? @@ -84,13 +84,13 @@ kubectl -n vault get secrets/vault-unseal-secret --template='{{index .data "root ### Terraform is returning a quota limit exceeded error -If Terraform returns a `quota limit exceeded` error, please check that your public cloud resources quota limit settings are set above what kubefirst needs to work, and that you still have available resources. [More information](#does-kubefirst-add-any-cloud-resources-overhead) on resources used. On Civo you can check your quota usage with the `kubefirst civo quota`, same with AWS on the command line with `kubefirst aws quota`. This command is not available yet on [DigitalOcean](https://github.com/kubefirst/kubefirst/issues/1964), [Google Cloud](https://github.com/kubefirst/kubefirst/issues/1963) or [Vultr](https://github.com/kubefirst/kubefirst/issues/1965). +If Terraform returns a `quota limit exceeded` error, please check that your public cloud resources quota limit settings are set above what Kubefirst needs to work, and that you still have available resources. [More information](#does-kubefirst-add-any-cloud-resources-overhead) on resources used. On Civo you can check your quota usage with the `kubefirst civo quota`, same with AWS on the command line with `kubefirst aws quota`. This command is not available yet on [DigitalOcean](https://github.com/kubefirst/kubefirst/issues/1964), [Google Cloud](https://github.com/kubefirst/kubefirst/issues/1963) or [Vultr](https://github.com/kubefirst/kubefirst/issues/1965). ### Do you plan to support technology X? -kubefirst is an opinionated platform: we install, and configure the tools we think you need to have a production-ready Kubernetes cluster. We also try to keep the initial tooling at a minimum. Everything else that could be useful for your endeavor can either be installed using the [GitOps Catalog](gitops-catalog), or manually added by you using your new `gitops` repository. If the applications you want isn't in the Catalog, let us know by [creating an issue](https://github.com/kubefirst/gitops-catalog/issues/new) (or in our [Slack community](https://kubefirst.io/slack)), and we'll add it. +Kubefirst is an opinionated platform: we install, and configure the tools we think you need to have a production-ready Kubernetes cluster. We also try to keep the initial tooling at a minimum. Everything else that could be useful for your endeavor can either be installed using the [GitOps Catalog](gitops-catalog), or manually added by you using your new `gitops` repository. If the applications you want isn't in the Catalog, let us know by [creating an issue](https://github.com/kubefirst/gitops-catalog/issues/new) (or in our [Slack community](https://kubefirst.io/slack)), and we'll add it. -With that said, here's a list of requests we got from our users, with some details on the plans to add the technology, or not. Even if the status of the application you would like in kubefirst is `not planned`, kindly let us know. We are always listening to our community, so if a technology request is popular, we will review our plans to decide if we change our plans. +With that said, here's a list of requests we got from our users, with some details on the plans to add the technology, or not. Even if the status of the application you would like in Kubefirst is `not planned`, kindly let us know. We are always listening to our community, so if a technology request is popular, we will review our plans to decide if we change our plans. #### k0s @@ -98,8 +98,8 @@ Since we support k3d, we have no plan to support [k0s](https://github.com/k0spro ### Any plans to move away from HashiCorp Vault & Terraform following the license changes & IBM acquisition? -kubefirst is a commercial but free platform and is not subject to the new commercial restrictions related to the license change to [BSL](https://www.hashicorp.com/bsl) (Business Source License). The restriction is then flowing down to our users so you may be subject to the commercial element of it. As much as we would like to help, we are no legal experts, so we cannot advise you on the topic, but so far, we have seen no issues about this within our community. +Kubefirst is a commercial but free platform and is not subject to the new commercial restrictions related to the license change to [BSL](https://www.hashicorp.com/bsl) (Business Source License). The restriction is then flowing down to our users so you may be subject to the commercial element of it. As much as we would like to help, we are no legal experts, so we cannot advise you on the topic, but so far, we have seen no issues about this within our community. -As for the IBM acquisition, we are closely keeping track of the situation. So far there is no indication that it will cause any problems for kubefirst. We are fans of HashiCorp Vault, and Terraform, especially with its Atlantis integration, so for now, we have no plans to replace Terraform with [OpenTofu](https://opentofu.org) or Vault with [OpenBao](https://openbao.org), nor to offer alternatives as options. kubefirst being open source, there is always a way for you to replace those yourself, but we will not be able to provide any help on that matter as it's outside of the normal usage scope. +As for the IBM acquisition, we are closely keeping track of the situation. So far there is no indication that it will cause any problems for Kubefirst. We are fans of HashiCorp Vault, and Terraform, especially with its Atlantis integration, so for now, we have no plans to replace Terraform with [OpenTofu](https://opentofu.org) or Vault with [OpenBao](https://openbao.org), nor to offer alternatives as options. Kubefirst being open source, there is always a way for you to replace those yourself, but we will not be able to provide any help on that matter as it's outside of the normal usage scope. As with everything we do, we are listening to our users, so if for any reasons, the usage of HashiCorp technologies within our platform is a blocker for you, please let us know. We will keep track of the interest and issues related to this topic, and plan accordingly. diff --git a/docs/common/gitops-catalog.mdx b/docs/common/gitops-catalog.mdx index 18863976..73a4c777 100644 --- a/docs/common/gitops-catalog.mdx +++ b/docs/common/gitops-catalog.mdx @@ -1,22 +1,22 @@ # GitOps Catalog -After your kubefirst cluster has been provisioned, you can optionally leverage the kubefirst GitOps Catalog. +After your Kubefirst cluster has been provisioned, you can optionally leverage the Kubefirst GitOps Catalog. -The GitOps Catalog is a community driven collection of Kubernetes applications that can be deployed directly to your kubefirst cluster(s). +The GitOps Catalog is a community driven collection of Kubernetes applications that can be deployed directly to your Kubefirst cluster(s). For more information regarding applications that are generally available, check out the GitOps Catalog [repository](https://github.com/kubefirst/gitops-catalog). ## Using the catalog -After your management cluster has been provisioned, you're able to click on a button to **open kubefirst console**: +After your management cluster has been provisioned, you're able to click on a button to **open Kubefirst console**: ![Cluster provision complete](../img/common/catalog/button.png) -Once this button has been clicked, you'll be sent to your new kubefirst console. In the left margin, click on Applications. +Once this button has been clicked, you'll be sent to your new Kubefirst console. In the left margin, click on Applications. ![Applications page](../img/common/catalog/page.png) -This page shows the applications that have been provisioned to your kubefirst management cluster. Default applications will show up in this list without an uninstall button. +This page shows the applications that have been provisioned to your Kubefirst management cluster. Default applications will show up in this list without an uninstall button. You can click on the **GitOps catalog** link to show the catalog: @@ -26,7 +26,7 @@ From here, you can click **Install** on any of the available applications to dep ## How this works -When you opt to install any of the available services from the GitOps Catalog, the kubefirst API formats and commits a set of files to your `gitops` repository. +When you opt to install any of the available services from the GitOps Catalog, the Kubefirst API formats and commits a set of files to your `gitops` repository. Then, Argo CD is asked to refresh the upstream registry to synchronize the newly deployed application. diff --git a/docs/common/gitops.mdx b/docs/common/gitops.mdx index cbfd064e..c70ec77c 100644 --- a/docs/common/gitops.mdx +++ b/docs/common/gitops.mdx @@ -3,7 +3,7 @@ import TabItem from "@theme/TabItem"; import GitHub from '../common/partials/github/_gitops.mdx'; import GitLab from '../common/partials/gitlab/_gitops.mdx'; -The days of scripting `kubectl apply` and `helm install` in your operations are over. The kubefirst platform comes with all the tools you need to run a scalable GitOps platform powered by Argo CD GitOps. +The days of scripting `kubectl apply` and `helm install` in your operations are over. The Kubefirst platform comes with all the tools you need to run a scalable GitOps platform powered by Argo CD GitOps. ![GitOps Flow](../img/gitops/gitops-diagram-light.svg#light-mode)![GitOps Flow](../img/gitops/gitops-diagram-dark.svg#dark-mode) @@ -64,7 +64,7 @@ git push --tags Now you can use the `--gitops-template-url` flag pointing to your new repository when creating a new Kubernetes cluster. -When the kubefirst CLI checks out the `gitops-template-url` flag for the repository URL, it will default to checking out the git tag that matches the CLI's version. For example a v2.0.0 CLI would check out the `gitops-template-url` at the tag `v2.0.0`. This is not always the desired effect, as you may be forking in order to introduce some new changes to the `gitops-template` repository structure. In order to checkout the `main` branch of your forked `gitops-template` repository instead of the version tag, you need to also include the `--gitops-template-branch main` flag with your `create` command. +When the Kubefirst CLI checks out the `gitops-template-url` flag for the repository URL, it will default to checking out the git tag that matches the CLI's version. For example a v2.0.0 CLI would check out the `gitops-template-url` at the tag `v2.0.0`. This is not always the desired effect, as you may be forking in order to introduce some new changes to the `gitops-template` repository structure. In order to checkout the `main` branch of your forked `gitops-template` repository instead of the version tag, you need to also include the `--gitops-template-branch main` flag with your `create` command. You can also find the equivalent of these flags in the `Advanced Options` section of the `Cluster details` step if you are using the UI installer. diff --git a/docs/common/known-limitations.mdx b/docs/common/known-limitations.mdx index 5aecb8fe..dcab64e4 100644 --- a/docs/common/known-limitations.mdx +++ b/docs/common/known-limitations.mdx @@ -1,3 +1,3 @@ ### General -- [Let's encrypt](https://letsencrypt.org/) is limited to 50 weekly certificates with an additional limitations of 5 per subdomains. We use Let's encrypt to automatically create certificates for your domains. In most cases, this won't be an issue, but you may reach that limit if you create, and destroy often kubefirst clusters using the same domain during a short period. You can use the [Let's Debug Toolkit](https://tools.letsdebug.net/cert-search) to check those, but note that the result isn't always valid. +- [Let's encrypt](https://letsencrypt.org/) is limited to 50 weekly certificates with an additional limitations of 5 per subdomains. We use Let's encrypt to automatically create certificates for your domains. In most cases, this won't be an issue, but you may reach that limit if you create, and destroy often Kubefirst clusters using the same domain during a short period. You can use the [Let's Debug Toolkit](https://tools.letsdebug.net/cert-search) to check those, but note that the result isn't always valid. diff --git a/docs/common/metaphor.mdx b/docs/common/metaphor.mdx index 531986e2..70bf46c5 100644 --- a/docs/common/metaphor.mdx +++ b/docs/common/metaphor.mdx @@ -1,4 +1,4 @@ -The [metaphor](https://github.com/kubefirst/gitops-template/tree/main/metaphor) application is an example application with source code, builds, and GitOps delivery used to showcase various features, integrations, and best practices of the kubefirst platform. It's useful to keep on your new platform as a place to test CI changes or anything you need to verify on the platform. The metaphor app has CI/CD that delivers each application to a development, staging, and production namespace in your Kubernetes cluster. The metaphor service applications' secrets in HashiCorp Vault are bound to the metaphor application through the use of the external secrets operator, a handy Kubernetes utility to keep Kubernetes secrets in sync with the Vault, the source of truth. It demonstrates how DNS entries are automatically created in AWS Route 53 using external DNS, and has auto-renewing, short-lived certificates generated by cert-manager and the Let's Encrypt cluster-issuer. +The [metaphor](https://github.com/kubefirst/gitops-template/tree/main/metaphor) application is an example application with source code, builds, and GitOps delivery used to showcase various features, integrations, and best practices of the Kubefirst platform. It's useful to keep on your new platform as a place to test CI changes or anything you need to verify on the platform. The metaphor app has CI/CD that delivers each application to a development, staging, and production namespace in your Kubernetes cluster. The metaphor service applications' secrets in HashiCorp Vault are bound to the metaphor application through the use of the external secrets operator, a handy Kubernetes utility to keep Kubernetes secrets in sync with the Vault, the source of truth. It demonstrates how DNS entries are automatically created in AWS Route 53 using external DNS, and has auto-renewing, short-lived certificates generated by cert-manager and the Let's Encrypt cluster-issuer. ## Best Practices @@ -102,7 +102,7 @@ The files you be interested are: chart/Metaphor ``` -There is a CWFT meant to bump a chart version and update chart museum. This automation is to guide how to leverage the tooling already embedded on kubefirst to serve applications internally. +There is a CWFT meant to bump a chart version and update chart museum. This automation is to guide how to leverage the tooling already embedded on Kubefirst to serve applications internally. ## Wrapping up diff --git a/docs/common/partials/common/_cli.mdx b/docs/common/partials/common/_cli.mdx index fc625f42..d2fab1c0 100644 --- a/docs/common/partials/common/_cli.mdx +++ b/docs/common/partials/common/_cli.mdx @@ -1,3 +1,3 @@ -# Install kubefirst From the CLI +# Install Kubefirst From the CLI Using the CLI to create your cluster directly without using the [UI](./ui) is a perfect alternative for automation. The end result will be the same, a new production-ready management Kubernetes cluster, but you won't have access to the useful additional features available within the UI. diff --git a/docs/common/partials/common/_cloudflare-dns.mdx b/docs/common/partials/common/_cloudflare-dns.mdx index 539e7384..84efc9a2 100644 --- a/docs/common/partials/common/_cloudflare-dns.mdx +++ b/docs/common/partials/common/_cloudflare-dns.mdx @@ -1,6 +1,6 @@ :::tip -By default kubefirst use the cloud providers to manage DNS. You also have the option to use Cloudflare. +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 `--dns-provider cloudflare`. diff --git a/docs/common/partials/common/_prerequisites-homebrew.mdx b/docs/common/partials/common/_prerequisites-homebrew.mdx index 56321ada..8272a5d0 100644 --- a/docs/common/partials/common/_prerequisites-homebrew.mdx +++ b/docs/common/partials/common/_prerequisites-homebrew.mdx @@ -4,7 +4,7 @@ If you are on macOS or Linux, and have [Homebrew](https://brew.sh) installed, yo brew install konstructio/taps/kubefirst ``` -To upgrade an existing kubefirst CLI to the latest version run: +To upgrade an existing Kubefirst CLI to the latest version run: ```shell brew update diff --git a/docs/common/partials/common/_prerequisites-windows.mdx b/docs/common/partials/common/_prerequisites-windows.mdx index b16ebcc3..93c1c3b2 100644 --- a/docs/common/partials/common/_prerequisites-windows.mdx +++ b/docs/common/partials/common/_prerequisites-windows.mdx @@ -1 +1 @@ -We currently do not support Windows directly, but you can easily use kubefirst using [WSL](https://learn.microsoft.com/en-us/windows/wsl/about) (tested with Ubuntu). To install the latest WSL version, please follow the [Microsoft documentation on how to install Linux on Windows](https://learn.microsoft.com/en-us/windows/wsl/install). +We currently do not support Windows directly, but you can easily use Kubefirst using [WSL](https://learn.microsoft.com/en-us/windows/wsl/about) (tested with Ubuntu). To install the latest WSL version, please follow the [Microsoft documentation on how to install Linux on Windows](https://learn.microsoft.com/en-us/windows/wsl/install). diff --git a/docs/common/partials/common/_prerequisites.mdx b/docs/common/partials/common/_prerequisites.mdx index 6056be3a..cc0103da 100644 --- a/docs/common/partials/common/_prerequisites.mdx +++ b/docs/common/partials/common/_prerequisites.mdx @@ -6,7 +6,7 @@ import Windows from '../common/_prerequisites-windows.mdx'; ## Prerequisites -### kubefirst +### Kubefirst diff --git a/docs/common/partials/common/_root-credentials-cmd.mdx b/docs/common/partials/common/_root-credentials-cmd.mdx index f59a2df1..7c515aa1 100644 --- a/docs/common/partials/common/_root-credentials-cmd.mdx +++ b/docs/common/partials/common/_root-credentials-cmd.mdx @@ -7,7 +7,7 @@ To obtain your 3 initial passwords, run
![root credentials](../../../img/common/kubefirst/root-credentials.png) -If you created your cluster using the UI, or reset your kubefirst environment, you can still retrieve the root credentials (except the `kbot` user password, which you will have to find manually in Vault) using `kubectl`: +If you created your cluster using the UI, or reset your Kubefirst environment, you can still retrieve the root credentials (except the `kbot` user password, which you will have to find manually in Vault) using `kubectl`: ```shell # Argo CD admin password diff --git a/docs/common/partials/common/_terminal-output.mdx b/docs/common/partials/common/_terminal-output.mdx index 9f53a3d2..969a98ff 100644 --- a/docs/common/partials/common/_terminal-output.mdx +++ b/docs/common/partials/common/_terminal-output.mdx @@ -1,6 +1,6 @@ -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 ~ {props.minutes} minute installation, your browser will launch a new tab to the kubefirst Console, which will help you navigate your new suite of tools running in your new {props.cloud} cluster. +After the ~ {props.minutes} minute installation, your browser will launch a new tab to the Kubefirst Console, which will help you navigate your new suite of tools running in your new {props.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. diff --git a/docs/common/partials/github/_repositories.mdx b/docs/common/partials/github/_repositories.mdx index 4925f244..5d5fafa8 100644 --- a/docs/common/partials/github/_repositories.mdx +++ b/docs/common/partials/github/_repositories.mdx @@ -1,4 +1,4 @@ -When you create a new cluster with kubefirst, two new repositories will be added to your organization's GitHub account as shown here. +When you create a new cluster with Kubefirst, two new repositories will be added to your organization's GitHub account as shown here. ![GitHub repositories](../../../img/common/github/repositories.png) @@ -6,7 +6,7 @@ When you create a new cluster with kubefirst, two new repositories will be added ### `gitops` -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 modify, update or add anything to this `gitops` repository based on your business needs: it is now yours. +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 modify, update or add anything to this `gitops` repository based on your business needs: it is now yours. :::caution The repository doesn't have any branch protection by default. We highly suggest that you add some on the `main` branch. @@ -14,7 +14,7 @@ The repository doesn't have any branch protection by default. We highly suggest ### metaphor -The `metaphor` repository is an example application with source code, builds, and GitOps delivery used to showcase various features, integrations, and best practices of the kubefirst platform. More details in the [Metaphor documentation page](../../../common/metaphor.mdx). +The `metaphor` repository is an example application with source code, builds, and GitOps delivery used to showcase various features, integrations, and best practices of the Kubefirst platform. More details in the [Metaphor documentation page](../../../common/metaphor.mdx). ## GitHub Repository Management diff --git a/docs/common/partials/github/_tokens.mdx b/docs/common/partials/github/_tokens.mdx index 93b3b813..317ced4c 100644 --- a/docs/common/partials/github/_tokens.mdx +++ b/docs/common/partials/github/_tokens.mdx @@ -1,8 +1,8 @@ -kubefirst needs a GitHub token to authenticate with the GitHub API. The token is used to perform various actions on a user's behalf like the cluster creation, but also by Atlantis and Argo CD during your management, and workload clusters usage. +Kubefirst needs a GitHub token to authenticate with the GitHub API. The token is used to perform various actions on a user's behalf like the cluster creation, but also by Atlantis and Argo CD during your management, and workload clusters usage. ## How to create a GitHub Token -The easiest way is to start the kubefirst installer, and follow the screen instructions. It will guide you to issue a token with the list of scope described above to issue a GitHub Token using the [GitHub device login flow](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#device-flow). +The easiest way is to start the Kubefirst installer, and follow the screen instructions. It will guide you to issue a token with the list of scope described above to issue a GitHub Token using the [GitHub device login flow](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps#device-flow). You can also log in to your GitHub account and issue a Personal Access token following the [list of scopes below](#github-token-scopes). With the manually generated token, you can provide it via environment variable using `export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxx`. @@ -14,16 +14,16 @@ If you never connected to GitHub using SSH before and are creating a cluster usi ![GitHub Token Scopes](../../../img/common/github/scopes.png) -kubefirst needs the following scopes or scopes groups: +Kubefirst needs the following scopes or scopes groups: -| Scope | Score Permission | kubefirst Usage | +| Scope | Score Permission | Kubefirst Usage | |-----------------------|----------------------------------------------|---------------------------------------------------------------------------------------------------------| | repo | Full access to public & private repositories | Creating 2 repositories on cluster creation & manage repositories related to your cluster with Atlantis | | workflow | Add & update GitHub Actions workflow files | Creating workflows that will help manage your cluster and repositories | | write:packages | Upload & publish packages in GitHub Packages | Creating application packages (ex.: metaphor) | | admin:org | Fully manage the organization | Managing users and accesses with Infrastructure as Code using Atlantis & Vault | -| admin:public_key | Fully manage public keys | Needed for the kubefirst admin kbot user to take action in the repositories we created for you | +| admin:public_key | Fully manage public keys | Needed for the Kubefirst admin kbot user to take action in the repositories we created for you | | admin:repo_hook | Full access to repository hooks | Creating hooks for Atlantis to subscribe to some GitHub events (i.e., comments, pull requests...) | | admin:org_hook | Full access to organization hooks | This is will be removed soon (see [#2180](https://github.com/kubefirst/kubefirst/issues/2180)) | | user | Grants read & write access to profile info | Retrieving the user profile to display in the console UI & let the user validate the used token | @@ -34,7 +34,7 @@ kubefirst needs the following scopes or scopes groups: You can read more about the [scopes in the GitHub documentation](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps#available-scopes). :::warning -Those permissions are the minimum requirement for kubefirst to function properly. +Those permissions are the minimum requirement for Kubefirst to function properly. -If you feel unease with that, we suggest you create a new GitHub user or organization for the sake of testing kubefirst. +If you feel unease with that, we suggest you create a new GitHub user or organization for the sake of testing Kubefirst. ::: diff --git a/docs/common/partials/github/_user-creation.mdx b/docs/common/partials/github/_user-creation.mdx index 3805512d..1962696e 100644 --- a/docs/common/partials/github/_user-creation.mdx +++ b/docs/common/partials/github/_user-creation.mdx @@ -49,12 +49,12 @@ NOTE: Atlantis merges your pull request automatically once an apply is successfu Atlantis will always run plans automatically for you when a pull request is opened that changes files mapped in `atlantis.yaml`. -Any new users you have created through this process will have their temporary initial passwords stored in your Vault cluster. You can access Vault using the root login credentials provided to you during your kubefirst installation. Only the root Vault token can access these secrets. You will find your users' initial passwords in the Vault secret store `/secrets/users/`. +Any new users you have created through this process will have their temporary initial passwords stored in your Vault cluster. You can access Vault using the root login credentials provided to you during your Kubefirst installation. Only the root Vault token can access these secrets. You will find your users' initial passwords in the Vault secret store `/secrets/users/`. ![Vault token login](../../../img/kubefirst/local/vault-token-login.png) -Once you've provided them their initial password, they can update their own password throughout the platform by updating their user password entity in Vault. Anyone can change their own password, and Admins can reset anyone's password. These rules, just like everything else on kubefirst, can be configured in your new `gitops` repository. +Once you've provided them their initial password, they can update their own password throughout the platform by updating their user password entity in Vault. Anyone can change their own password, and Admins can reset anyone's password. These rules, just like everything else on Kubefirst, can be configured in your new `gitops` repository. ![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. +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/common/partials/gitlab/_repositories.mdx b/docs/common/partials/gitlab/_repositories.mdx index 5b584b6d..cf3b8e28 100644 --- a/docs/common/partials/gitlab/_repositories.mdx +++ b/docs/common/partials/gitlab/_repositories.mdx @@ -1,4 +1,4 @@ -In the GitOps nature, we rely on repositories to have a single source of truth when it comes to project updates. kubefirst makes heavy use of the GitOps approach to automate the development and maintenance of applications. In that regard, during the installation process, kubefirst will create a few GitLab repositories as described below. +In the GitOps nature, we rely on repositories to have a single source of truth when it comes to project updates. Kubefirst makes heavy use of the GitOps approach to automate the development and maintenance of applications. In that regard, during the installation process, Kubefirst will create a few GitLab repositories as described below. ## Repositories @@ -6,7 +6,7 @@ In the GitOps nature, we rely on repositories to have a single source of truth w ### `gitops` -The `gitops` repository houses all of our IAC and all of our GitOps configurations. All of the infrastructure that you receive with kubefirst was produced by Terraform and all of your applications are delivered with Argo CD. You can modify, update or add anything to this `gitops` repository based on your business needs: it is now yours. +The `gitops` repository houses all of our IAC and all of our GitOps configurations. All of the infrastructure that you receive with Kubefirst was produced by Terraform and all of your applications are delivered with Argo CD. You can modify, update or add anything to this `gitops` repository based on your business needs: it is now yours. :::caution The repository doesn't have any branch protection by default. We highly suggest that you add some on the `main` branch. @@ -14,7 +14,7 @@ The repository doesn't have any branch protection by default. We highly suggest ### metaphor -The `metaphor` repository is an example application with source code, builds, and GitOps delivery used to showcase various features, integrations, and best practices of the kubefirst platform. More details in the [Metaphor documentation page](../../../common/metaphor.mdx). +The `metaphor` repository is an example application with source code, builds, and GitOps delivery used to showcase various features, integrations, and best practices of the Kubefirst platform. More details in the [Metaphor documentation page](../../../common/metaphor.mdx). ## Repositories Management diff --git a/docs/common/partials/gitlab/_tokens.mdx b/docs/common/partials/gitlab/_tokens.mdx index 424aaf70..7ba07a24 100644 --- a/docs/common/partials/gitlab/_tokens.mdx +++ b/docs/common/partials/gitlab/_tokens.mdx @@ -1,22 +1,22 @@ -kubefirst uses a GitLab token to authenticate with the GitLab API. Tokens can be used to perform various actions on a user's behalf, such as creating, and deleting repository files. kubefirst uses a limited number of scopes (what is allowed with the issued token) to provision the kubefirst platform such as creating GitLab repositories and updating GitLab repository webhook URL. +Kubefirst uses a GitLab token to authenticate with the GitLab API. Tokens can be used to perform various actions on a user's behalf, such as creating, and deleting repository files. Kubefirst uses a limited number of scopes (what is allowed with the issued token) to provision the Kubefirst platform such as creating GitLab repositories and updating GitLab repository webhook URL. -kubefirst issue GitLab Tokens at the beginning of the installation using [GitLab device login flow](https://docs.gitlab.com/ce/api/oauth2.html). +Kubefirst issue GitLab Tokens at the beginning of the installation using [GitLab device login flow](https://docs.gitlab.com/ce/api/oauth2.html). ## GitLab Token Scopes -kubefirst uses the following scopes to provision the kubefirst platform: +Kubefirst uses the following scopes to provision the Kubefirst platform: ![GitLab Token Scopes](../../../img/common/gitlab/scopes.png) :::info Those permissions are the minimum require scopes we need for the token as we need to be able to create two Git repositories, add an SSH key, create groups, and more. It is used at the cluster creation, but will also be used by Atlantis and Argo CD during your management, and workload clusters usage. We do not suggest removing some of the scopes once the management cluster is created. -If you feel unease with that, we suggest you create a new GitHub or GitLab user for the sake of testing kubefirst. +If you feel unease with that, we suggest you create a new GitHub or GitLab user for the sake of testing Kubefirst. ::: ## How to create a GitLab Token -There are different ways to create a GitLab token. The easiest way is to start the kubefirst installer, and follow the screen instructions. It will guide you to issue a token with the list of scope described above. +There are different ways to create a GitLab token. The easiest way is to start the Kubefirst installer, and follow the screen instructions. It will guide you to issue a token with the list of scope described above. There are other ways to create a GitLab token. You can login into your GitLab account and issue a Personal Access Token following the list of scopes above. With the manually generated token, you can provide it via environment variable: `export GITLAB_TOKEN`. diff --git a/docs/common/partials/gitlab/_user-creation.mdx b/docs/common/partials/gitlab/_user-creation.mdx index e49b96a7..64c34b93 100644 --- a/docs/common/partials/gitlab/_user-creation.mdx +++ b/docs/common/partials/gitlab/_user-creation.mdx @@ -50,12 +50,12 @@ NOTE: Atlantis merges your merge request automatically once an apply is successf Atlantis will always run plans automatically for you when a merge request is opened that changes files mapped in `atlantis.yaml`. -Any new users you have created through this process will have their temporary initial passwords stored in your Vault cluster. You can access Vault using the root login credentials provided to you during your kubefirst installation. Only the root Vault token can access these secrets. You will find your users' initial passwords in the Vault secret store `/secrets/users/`. +Any new users you have created through this process will have their temporary initial passwords stored in your Vault cluster. You can access Vault using the root login credentials provided to you during your Kubefirst installation. Only the root Vault token can access these secrets. You will find your users' initial passwords in the Vault secret store `/secrets/users/`. ![Vault token login](../../../img/kubefirst/local/vault-token-login.png) -Once you've provided them their initial password, they can update their own password throughout the platform by updating their user password entity in Vault. Anyone can change their own password, and Admins can reset anyone's password. These rules, just like everything else on kubefirst, can be configured in your new `gitops` repository. +Once you've provided them their initial password, they can update their own password throughout the platform by updating their user password entity in Vault. Anyone can change their own password, and Admins can reset anyone's password. These rules, just like everything else on Kubefirst, can be configured in your new `gitops` repository. ![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. +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/common/telemetry.mdx b/docs/common/telemetry.mdx index e0684229..e9d07cf1 100644 --- a/docs/common/telemetry.mdx +++ b/docs/common/telemetry.mdx @@ -1,4 +1,4 @@ -kubefirst collects data in order to optimize future releases. By collecting metrics on what type of clusters are being deployed and how they are being used, kubefirst prioritizes the features that are being used across the majority of the user base. While we rely on this data to make improvements to the platform, you are always allowed to opt out for any reason. +Kubefirst collects data in order to optimize future releases. By collecting metrics on what type of clusters are being deployed and how they are being used, Kubefirst prioritizes the features that are being used across the majority of the user base. While we rely on this data to make improvements to the platform, you are always allowed to opt out for any reason. ## What Metrics are collected? @@ -12,4 +12,4 @@ kubefirst collects data in order to optimize future releases. By collecting metr - `kubefirst_team_info`: For internal use only - `machine_id`: An anonymized ID representing a distinct client host (e.g. `123456-123abc-abc123123abc-123123`) -When installing your kubefirst cluster through the CLI, append the `--use-telemetry=false` flag to opt out of this process. +When installing your Kubefirst cluster through the CLI, append the `--use-telemetry=false` flag to opt out of this process. diff --git a/docs/common/ui.mdx b/docs/common/ui.mdx index 0b584448..992bb4b0 100644 --- a/docs/common/ui.mdx +++ b/docs/common/ui.mdx @@ -3,11 +3,11 @@ import TabItem from "@theme/TabItem"; import Homebrew from '../common/partials/common/_ui-homebrew.mdx'; import Helm from '../common/partials/common/_ui-helm.mdx'; -# Install kubefirst using the UI +# Install Kubefirst using the UI -There are a few ways to install kubefirst, whether you have a cluster already or don't. +There are a few ways to install Kubefirst, whether you have a cluster already or don't. -## Step 1: Install kubefirst console +## Step 1: Install Kubefirst console @@ -18,11 +18,11 @@ There are a few ways to install kubefirst, whether you have a cluster already or -## Step 2: Install your kubefirst management cluster +## Step 2: Install your Kubefirst management cluster -Provide details about your preferred git provider, cloud provider, access, and cluster details and let kubefirst do the rest. +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) +![Kubefirst user interface showing cloud and git options](../img/console/installer.png) At the end of the process, you will be shown the password of your new administrator account named `kbot`. You need to use it to connect to the management console. If you forget to copy the password on the last screen, or lost it, you can always retrieve it from Vault. If you want to change the password for something else, please follow [this tip from the Vault documentation page](./vault.mdx#how-can-i-change-my-users-password). diff --git a/docs/common/users.mdx b/docs/common/users.mdx index e58dc010..019b5455 100644 --- a/docs/common/users.mdx +++ b/docs/common/users.mdx @@ -8,7 +8,7 @@ import GitLabLogo from './components/GitLabLogo.jsx' ## User Access -The kubefirst platform has two types of user access: administrators and developers. As you may guess, administrators have full access, but developers have limited access. Here is a list of limitations for developers: +The Kubefirst platform has two types of user access: administrators and developers. As you may guess, administrators have full access, but developers have limited access. Here is a list of limitations for developers: - Argo CD - delete applications diff --git a/docs/common/vault.mdx b/docs/common/vault.mdx index be788f67..7f6264b4 100644 --- a/docs/common/vault.mdx +++ b/docs/common/vault.mdx @@ -7,7 +7,7 @@ import MetaphorSecretsGitLab from '../common/partials/gitlab/_secrets.mdx'; ## Authentification -You will need to use Vault to log in the kubefirst management console. You can only achieve that with the `kbot` user: its password is provided in the last step of the UI installation, or you can retrieve it yourself using the instruction provided in the terminal, if you did a CLI installation. Note that you won't be able to log in the management console using Vault with the root token. +You will need to use Vault to log in the Kubefirst management console. You can only achieve that with the `kbot` user: its password is provided in the last step of the UI installation, or you can retrieve it yourself using the instruction provided in the terminal, if you did a CLI installation. Note that you won't be able to log in the management console using Vault with the root token. ### Token authentication @@ -21,7 +21,7 @@ It will output the root token. Copy it, then open your browser, and navigate to ![HashiCorp Vault Token Login](../img/kubefirst/vault/token-login.png) -While logged in with the root token, navigate to the secret at `Users -> kbot`. This secret is the username, and OIDC password for the kubefirst bot user named `kbot`. Copy the value, log out of Vault and use it to authenticate with this user in the next section. +While logged in with the root token, navigate to the secret at `Users -> kbot`. This secret is the username, and OIDC password for the Kubefirst bot user named `kbot`. Copy the value, log out of Vault and use it to authenticate with this user in the next section. ### Username authentication (human users) @@ -29,9 +29,9 @@ When logging in with users instead of tokens, select method `Username` as the lo ![HashiCorp Vault Sign in Page](../img/kubefirst/vault/vault-userpass.png) -This is the login experience that your team will use when authenticating with Vault. Initially, there will only be a singular `kbot` user created that represents the kubefirst bot account. You can pull request additional admins and developers from your team onto the platform, and they will all log in using the Username method. +This is the login experience that your team will use when authenticating with Vault. Initially, there will only be a singular `kbot` user created that represents the Kubefirst bot account. You can pull request additional admins and developers from your team onto the platform, and they will all log in using the Username method. -Once a user is logged into Vault with Username auth, they will be automatically provided single sign-on (SSO) access to Argo Workflows, Argo CD, and the [kubefirst Console application](https://github.com/kubefirst/console/). Note that it won't work for Argo CD with `kbot` or any other created users for the k3d flavor of kubefirst (it's a known [bug](https://github.com/kubefirst/kubefirst/issues/1536)): you'll need to use the Argo CD admin password. +Once a user is logged into Vault with Username auth, they will be automatically provided single sign-on (SSO) access to Argo Workflows, Argo CD, and the [Kubefirst Console application](https://github.com/kubefirst/console/). Note that it won't work for Argo CD with `kbot` or any other created users for the k3d flavor of Kubefirst (it's a known [bug](https://github.com/kubefirst/kubefirst/issues/1536)): you'll need to use the Argo CD admin password. ### Kubernetes authentication @@ -80,7 +80,7 @@ spec: secretKey: SECRET_TWO ``` -This is going to be a very common file type for you on the kubefirst platform. This Kubernetes resource deploys with metaphor, connecting to the `vault-kv-secret` cluster secret store, and pulls secrets from the path specified in the values.yaml property `vaultSecretPath`. You can either pull all secrets from Vault into the Kubernetes secret, or as this secret demonstrates, you can also specify exactly which specific key/value pairs to pull when creating the secret. +This is going to be a very common file type for you on the Kubefirst platform. This Kubernetes resource deploys with metaphor, connecting to the `vault-kv-secret` cluster secret store, and pulls secrets from the path specified in the values.yaml property `vaultSecretPath`. You can either pull all secrets from Vault into the Kubernetes secret, or as this secret demonstrates, you can also specify exactly which specific key/value pairs to pull when creating the secret. The result will be a native Kubernetes secret, which can be used by your application. Since the path is driven by Helm `values.yaml` values, the source for these secrets can be different in your different environments. For example, when you go to your `gitops` repository and look at `gitops/components/staging/metaphor/values.yaml` you'll see on the last line that we're pulling the staging secrets from the staging path in Vault. diff --git a/docs/do/partials/common/_installed-applications.mdx b/docs/do/partials/common/_installed-applications.mdx index 3a8283c0..d563d7a9 100644 --- a/docs/do/partials/common/_installed-applications.mdx +++ b/docs/do/partials/common/_installed-applications.mdx @@ -1,3 +1,3 @@ ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). +To see what is installed by Kubefirst, check the [overview page](../../overview.mdx). diff --git a/docs/do/partials/common/_prerequisites.mdx b/docs/do/partials/common/_prerequisites.mdx index 8d2880c0..94979126 100644 --- a/docs/do/partials/common/_prerequisites.mdx +++ b/docs/do/partials/common/_prerequisites.mdx @@ -1,6 +1,6 @@ ### DigitalOcean Prerequisites -For kubefirst to be able to provision your DigitalOcean cloud resources: +For Kubefirst to be able to provision your DigitalOcean cloud resources: - A [DigitalOcean account](https://cloud.digitalocean.com/registrations/new) in which you are an account owner. - A publicly routable [DNS](https://docs.digitalocean.com/tutorials/dns-registrars/). diff --git a/docs/do/partials/github/_cluster-create.mdx b/docs/do/partials/github/_cluster-create.mdx index a0a85d6a..6c6615d6 100644 --- a/docs/do/partials/github/_cluster-create.mdx +++ b/docs/do/partials/github/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## Create your new Kubefirst cluster Adjust the following command with your GitHub and DigitalOcean key in addition to the appropriate values for your new platform. diff --git a/docs/do/partials/gitlab/_cluster-create.mdx b/docs/do/partials/gitlab/_cluster-create.mdx index 022663c5..10fa6720 100644 --- a/docs/do/partials/gitlab/_cluster-create.mdx +++ b/docs/do/partials/gitlab/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## Create your new Kubefirst cluster Adjust the following command with your GitHub and DigitalOcean tokens in addition to the appropriate values for your new platform. diff --git a/docs/do/quick-start/install/marketplace.mdx b/docs/do/quick-start/install/marketplace.mdx index d0b6e2c8..9ee49ea9 100644 --- a/docs/do/quick-start/install/marketplace.mdx +++ b/docs/do/quick-start/install/marketplace.mdx @@ -5,25 +5,25 @@ sidebar_position: 1 image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg" --- -# Install kubefirst using the DigitalOcean Marketplace +# Install Kubefirst using the DigitalOcean Marketplace -You can create a temporary kubefirst installer cluster through the DigitalOcean Marketplace, and use it to create your kubefirst management cluster. +You can create a temporary Kubefirst installer cluster through the DigitalOcean Marketplace, and use it to create your Kubefirst management cluster. ## Create your installer cluster -![DigitalOcean kubefirst marketplace page](../../../img/do/marketplace/marketplace.png) +![DigitalOcean Kubefirst marketplace page](../../../img/do/marketplace/marketplace.png) -Log into your DigitalOcean account and navigate to the [kubefirst Marketplace page](https://marketplace.digitalocean.com/apps/kubefirst). +Log into your DigitalOcean account and navigate to the [Kubefirst Marketplace page](https://marketplace.digitalocean.com/apps/kubefirst). 1. Click "Install App", it will open a new tab. 2. On the new tab, click "Install". -3. Choose the data center region. It doesn't matter much as this cluster will be use to install kubefirst. +3. Choose the data center region. It doesn't matter much as this cluster will be use to install Kubefirst. 4. Lower the nodes plan to `2 GB RAM / 1 vCPU / 50 GB Disk` 5. Reduce the nodes count to `2` 6. Name the cluster `installer` 7. Click "Create Cluster" and wait until the cluster is ready -## Connect to the install cluster and the kubefirst installer service +## Connect to the install cluster and the Kubefirst installer service In your terminal, run the following commands to download and use your new cluster's kubeconfig. This example assumes you named your cluster `installer`. @@ -36,12 +36,12 @@ Then launch the installer in your browser: [http://localhost:8080/](http://localhost:8080/) -## Create your kubefirst management cluster +## Create your Kubefirst management cluster -Provide details about your preferred Git provider, access, and cluster details and let kubefirst do the rest. +Provide details about your preferred Git provider, access, and cluster details and let Kubefirst do the rest. -![kubefirst user interface showing cloud and git options](../../../img/do/marketplace/create-management.png) +![Kubefirst user interface showing cloud and git options](../../../img/do/marketplace/create-management.png) ## Deleting your installer cluster -Once you've successfully installed your kubefirst `management` cluster, you can delete the `installer` cluster directly in the DigitalOcean UI. It is only used to establish the platform. +Once you've successfully installed your Kubefirst `management` cluster, you can delete the `installer` cluster directly in the DigitalOcean UI. It is only used to establish the platform. diff --git a/docs/gcp/partials/common/_installed-applications.mdx b/docs/gcp/partials/common/_installed-applications.mdx index 3a8283c0..d563d7a9 100644 --- a/docs/gcp/partials/common/_installed-applications.mdx +++ b/docs/gcp/partials/common/_installed-applications.mdx @@ -1,3 +1,3 @@ ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). +To see what is installed by Kubefirst, check the [overview page](../../overview.mdx). diff --git a/docs/gcp/partials/common/_prerequisites.mdx b/docs/gcp/partials/common/_prerequisites.mdx index 204cdcce..71a29757 100644 --- a/docs/gcp/partials/common/_prerequisites.mdx +++ b/docs/gcp/partials/common/_prerequisites.mdx @@ -1,6 +1,6 @@ ### Google Cloud Prerequisites -For kubefirst to be able to provision your Google Cloud resources: +For Kubefirst to be able to provision your Google Cloud resources: - 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). diff --git a/docs/gcp/partials/github/_cluster-create.mdx b/docs/gcp/partials/github/_cluster-create.mdx index fdb5014f..07b5b73e 100644 --- a/docs/gcp/partials/github/_cluster-create.mdx +++ b/docs/gcp/partials/github/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## 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. diff --git a/docs/gcp/partials/gitlab/_cluster-create.mdx b/docs/gcp/partials/gitlab/_cluster-create.mdx index 50020a6f..c25694aa 100644 --- a/docs/gcp/partials/gitlab/_cluster-create.mdx +++ b/docs/gcp/partials/gitlab/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## 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. diff --git a/docs/index.mdx b/docs/index.mdx index 6d0d273d..210071b4 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -15,11 +15,11 @@ import VultrHeader from './img/vultr/header.svg'; ## What is Kubefirst? -kubefirst is a free, fully automated, and instantly operational open source platform that includes some of the most popular open source tools available in the Kubernetes space, all working together in a click. +Kubefirst is a free, fully automated, and instantly operational open source platform that includes some of the most popular open source tools available in the Kubernetes space, all working together in a click. By running our installer in your cloud, you'll get a GitOps cloud management and application delivery ecosystem complete with automated Terraform workflows, Vault secrets management, GitLab or GitHub integrations with Argo, and a demo application that demonstrates how it all pieces together. -![kubefirst Architecture](img/common/kubefirst/architecture-light.svg#light-mode)![kubefirst Architecture](img/common/kubefirst/architecture-dark.svg#dark-mode) +![Kubefirst Architecture](img/common/kubefirst/architecture-light.svg#light-mode)![Kubefirst Architecture](img/common/kubefirst/architecture-dark.svg#dark-mode) --- diff --git a/docs/k3d/explore/vault.mdx b/docs/k3d/explore/vault.mdx index 12f82ed2..82348ed5 100644 --- a/docs/k3d/explore/vault.mdx +++ b/docs/k3d/explore/vault.mdx @@ -12,7 +12,7 @@ import ExploreVault from "../../common/vault.mdx"; ### Unseal Vault -Vault may automatically seal itself with k3d if you restart Docker or your computer goes to sleep. Usually, you would have to retrieve all the three unseal keys, and manually enter them, but with kubefirst, you can unseal Vault with one easy command: +Vault may automatically seal itself with k3d if you restart Docker or your computer goes to sleep. Usually, you would have to retrieve all the three unseal keys, and manually enter them, but with Kubefirst, you can unseal Vault with one easy command: ```shell kubefirst k3d unseal-vault diff --git a/docs/k3d/faq.mdx b/docs/k3d/faq.mdx index fc7a9dee..9435ab23 100644 --- a/docs/k3d/faq.mdx +++ b/docs/k3d/faq.mdx @@ -1,6 +1,6 @@ --- title: FAQ -description: frequently asked quesitons about the kubefirst platform +description: frequently asked quesitons about the Kubefirst platform image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg" --- @@ -53,8 +53,8 @@ Rancher Desktop is not yet supported but Docker Desktop is with [WSL on Windows] ### Using nerdctl Instead of Docker -Creation via [nerdctl](https://github.com/containerd/nerdctl) isn't supported yet. k3d doesn't fully support it probably because it doesn't have an API that is publicly exposed like the Docker daemon. We need k3d to support nerdctl and containerd on WSL before we can add support in kubefirst. +Creation via [nerdctl](https://github.com/containerd/nerdctl) isn't supported yet. k3d doesn't fully support it probably because it doesn't have an API that is publicly exposed like the Docker daemon. We need k3d to support nerdctl and containerd on WSL before we can add support in Kubefirst. ### Using Lima Instead of Docker Desktop -We didn't try kubefirst k3d cluster creation with [Lima](https://github.com/lima-vm/lima) yet. If you are using it, let us know how it's working, and if you think it's something we can support with the existing codebase. +We didn't try Kubefirst k3d cluster creation with [Lima](https://github.com/lima-vm/lima) yet. If you are using it, let us know how it's working, and if you think it's something we can support with the existing codebase. diff --git a/docs/k3d/partials/github/_install.mdx b/docs/k3d/partials/github/_install.mdx index caea2dd5..f0fc5513 100644 --- a/docs/k3d/partials/github/_install.mdx +++ b/docs/k3d/partials/github/_install.mdx @@ -8,9 +8,9 @@ Create or use an actual [GitHub](https://github.com) personal account ### 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. +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: +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 @@ -49,7 +49,7 @@ Restart your browser, and you should be good to go. ### Local Atlantis Executions (optional) -To install the k3d kubefirst platform with Atlantis wired up for automated Terraform executions, you'll need to create an account with ngrok, and expose an ngrok auth token environment variable in your shell. This allows the GitHub/GitLab servers to invoke the Atlantis webhook running in your cluster. +To install the k3d Kubefirst platform with Atlantis wired up for automated Terraform executions, you'll need to create an account with ngrok, and expose an ngrok auth token environment variable in your shell. This allows the GitHub/GitLab servers to invoke the Atlantis webhook running in your cluster. You can [sign up](https://dashboard.ngrok.com/signup) for an ngrok account for free. @@ -65,15 +65,15 @@ If you skip this step the platform will still operate just fine, you just won't ## Working without SSH -If you need your kubefirst installation to avoid using SSH whenever possible, you can bypass SSH and kubefirst will configure itself, GitHub Actions, Argo CD, and your entire GitOps workflow to utilize HTTPS instead of SSH at all times. +If you need your Kubefirst installation to avoid using SSH whenever possible, you can bypass SSH and Kubefirst will configure itself, GitHub Actions, Argo CD, and your entire GitOps workflow to utilize HTTPS instead of SSH at all times. -Provide the flag `--git-protocol https` when building your k3d cluster and kubefirst will take care of the rest. +Provide the flag `--git-protocol https` when building your k3d cluster and Kubefirst will take care of the rest. If you ever need to change this, you will need to rebuild the cluster or manually update the templates in your `gitops` repository. ## Create your new local cluster -To create a new kubefirst cluster locally, run +To create a new Kubefirst cluster locally, run ```shell kubefirst k3d create @@ -91,11 +91,11 @@ export GITHUB_TOKEN=ghp_xxxxxxxx ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). +To see what is installed by Kubefirst, check the [overview page](../../overview.mdx). ## Console UI Screen -![kubefirst console screen](../../../img/common/github/console.png) +![Kubefirst console screen](../../../img/common/github/console.png) diff --git a/docs/k3d/partials/gitlab/_install.mdx b/docs/k3d/partials/gitlab/_install.mdx index 4057c7b4..5910d485 100644 --- a/docs/k3d/partials/gitlab/_install.mdx +++ b/docs/k3d/partials/gitlab/_install.mdx @@ -11,9 +11,9 @@ import CommonTerminalOutput from "../../../common/partials/common/_terminal-outp ### 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. +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: +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 @@ -52,7 +52,7 @@ Restart your browser, and you should be good to go. ### Local Atlantis Executions (optional) -To install the k3d kubefirst platform with Atlantis wired up for automated Terraform executions, you'll need to create an account with ngrok, and expose an ngrok auth token environment variable in your shell. This allows the GitHub/GitLab servers to invoke the Atlantis webhook running in your cluster. +To install the k3d Kubefirst platform with Atlantis wired up for automated Terraform executions, you'll need to create an account with ngrok, and expose an ngrok auth token environment variable in your shell. This allows the GitHub/GitLab servers to invoke the Atlantis webhook running in your cluster. You can [sign up](https://dashboard.ngrok.com/signup) for an ngrok account for free. @@ -68,15 +68,15 @@ If you skip this step the platform will still operate just fine, you just won't ## Working without SSH -If you need your kubefirst installation to avoid using SSH whenever possible, you can bypass SSH and kubefirst will configure itself, GitHub Actions, Argo CD, and your entire GitOps workflow to utilize HTTPS instead of SSH at all times. +If you need your Kubefirst installation to avoid using SSH whenever possible, you can bypass SSH and Kubefirst will configure itself, GitHub Actions, Argo CD, and your entire GitOps workflow to utilize HTTPS instead of SSH at all times. -Provide the flag `--git-protocol https` when building your k3d cluster and kubefirst will take care of the rest. +Provide the flag `--git-protocol https` when building your k3d cluster and Kubefirst will take care of the rest. If you ever need to change this, you will need to rebuild the cluster or manually update the templates in your `gitops` repository. ## Create your new local cluster -To create a new kubefirst cluster locally, run +To create a new Kubefirst cluster locally, run ```shell kubefirst k3d create \ @@ -97,11 +97,11 @@ export GITLAB_TOKEN=gl_xxxxxxxx ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). +To see what is installed by Kubefirst, check the [overview page](../../overview.mdx). ## Console UI Screen -![kubefirst console screen](../../../img/common/gitlab/console.png) +![Kubefirst console screen](../../../img/common/gitlab/console.png) diff --git a/docs/k3d/quick-start/install.mdx b/docs/k3d/quick-start/install.mdx index 4f8f93d7..04734003 100644 --- a/docs/k3d/quick-start/install.mdx +++ b/docs/k3d/quick-start/install.mdx @@ -19,7 +19,7 @@ import GitLabLogo from '../../common/components/GitLabLogo.jsx' -# Install kubefirst from the CLI +# Install Kubefirst from the CLI diff --git a/docs/k3s/partials/common/_installed-applications.mdx b/docs/k3s/partials/common/_installed-applications.mdx index 3a8283c0..d563d7a9 100644 --- a/docs/k3s/partials/common/_installed-applications.mdx +++ b/docs/k3s/partials/common/_installed-applications.mdx @@ -1,3 +1,3 @@ ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). +To see what is installed by Kubefirst, check the [overview page](../../overview.mdx). diff --git a/docs/k3s/partials/common/_prerequisites.mdx b/docs/k3s/partials/common/_prerequisites.mdx index 5ad5dc90..c59b97bc 100644 --- a/docs/k3s/partials/common/_prerequisites.mdx +++ b/docs/k3s/partials/common/_prerequisites.mdx @@ -1,5 +1,5 @@ ### K3s Prerequisites -For kubefirst to be able to provision your K3s resources: +For Kubefirst to be able to provision your K3s resources: - You need to have 3 virtual machines that will be used for the K3s agents. diff --git a/docs/k3s/partials/github/_cluster-create.mdx b/docs/k3s/partials/github/_cluster-create.mdx index d52fff0b..df7ae685 100644 --- a/docs/k3s/partials/github/_cluster-create.mdx +++ b/docs/k3s/partials/github/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## Create your new Kubefirst cluster Adjust the following command with your GitHub token in addition to the appropriate values for your new platform. @@ -21,6 +21,6 @@ kubefirst beta k3s create \ --cluster-name kubefirst ``` -If you don't provide the `--servers-public-ips` flag, kubefirst will use the `--servers-private-ips` flag value for it. +If you don't provide the `--servers-public-ips` flag, Kubefirst will use the `--servers-private-ips` flag value for it. diff --git a/docs/k3s/partials/gitlab/_cluster-create.mdx b/docs/k3s/partials/gitlab/_cluster-create.mdx index 6daa3538..366f129d 100644 --- a/docs/k3s/partials/gitlab/_cluster-create.mdx +++ b/docs/k3s/partials/gitlab/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## Create your new Kubefirst cluster Adjust the following command with your GitHub in addition to the appropriate values for your new platform. diff --git a/docs/vultr/partials/common/_installed-applications.mdx b/docs/vultr/partials/common/_installed-applications.mdx index 3a8283c0..d563d7a9 100644 --- a/docs/vultr/partials/common/_installed-applications.mdx +++ b/docs/vultr/partials/common/_installed-applications.mdx @@ -1,3 +1,3 @@ ### Installed Applications -To see what is installed by kubefirst, check the [overview page](../../overview.mdx). +To see what is installed by Kubefirst, check the [overview page](../../overview.mdx). diff --git a/docs/vultr/partials/common/_prerequisites.mdx b/docs/vultr/partials/common/_prerequisites.mdx index f21efa44..75117711 100644 --- a/docs/vultr/partials/common/_prerequisites.mdx +++ b/docs/vultr/partials/common/_prerequisites.mdx @@ -1,6 +1,6 @@ ### Vultr Prerequisites -For kubefirst to be able to provision your Vultr cloud resources: +For Kubefirst to be able to provision your Vultr cloud resources: - A [Vultr account](https://www.vultr.com/register/) in which you are an account owner. - A publicly routable [DNS](https://www.vultr.com/docs/introduction-to-vultr-dns/). diff --git a/docs/vultr/partials/github/_cluster-create.mdx b/docs/vultr/partials/github/_cluster-create.mdx index c4eb458f..aac4fbdc 100644 --- a/docs/vultr/partials/github/_cluster-create.mdx +++ b/docs/vultr/partials/github/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## 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. diff --git a/docs/vultr/partials/gitlab/_cluster-create.mdx b/docs/vultr/partials/gitlab/_cluster-create.mdx index 6e7e9b6a..e6f89862 100644 --- a/docs/vultr/partials/gitlab/_cluster-create.mdx +++ b/docs/vultr/partials/gitlab/_cluster-create.mdx @@ -1,6 +1,6 @@ import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx"; -## Create your new kubefirst cluster +## 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. From 64d6dd725afe09bdb4789783ae65c5be03ac4e9d Mon Sep 17 00:00:00 2001 From: Simon Emms Date: Mon, 11 Nov 2024 11:03:25 +0000 Subject: [PATCH 3/7] chore: re-enable kubefirst to Kubefirst suggestion --- .vale/Custom/substitutions.yml | 2 +- CODE_OF_CONDUCT.md | 4 +++- docs/common/partials/common/_ui-homebrew.mdx | 2 +- docs/community/index.md | 2 ++ 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.vale/Custom/substitutions.yml b/.vale/Custom/substitutions.yml index ad31c72e..d2eb64df 100644 --- a/.vale/Custom/substitutions.yml +++ b/.vale/Custom/substitutions.yml @@ -39,7 +39,7 @@ swap: https: HTTPS iam: IAM konstruct: Konstruct - # kubefirst: Kubefirst # Need to be activated again once we will fix all the lower cases. + kubefirst: Kubefirst kubernetes: Kubernetes mongo: MongoDB oidc: OIDC diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 9da306bb..494545c5 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -36,7 +36,9 @@ This Code of Conduct applies within all community spaces, and also applies when ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [conduct@kubefirst.com](mailto:conduct@kubefirst.com). All complaints will be reviewed and investigated promptly and fairly. + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement a [conduct@kubefirst.com](mailto:conduct@kubefirst.com). All complaints will be reviewed and investigated promptly and fairly. + All community leaders are obligated to respect the privacy and security of the reporter of any incident. diff --git a/docs/common/partials/common/_ui-homebrew.mdx b/docs/common/partials/common/_ui-homebrew.mdx index 754a0b1a..058e5962 100644 --- a/docs/common/partials/common/_ui-homebrew.mdx +++ b/docs/common/partials/common/_ui-homebrew.mdx @@ -9,5 +9,5 @@ kubefirst launch up 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. +The `kubefirst.dev` domain is only available after `kubefirst launch up` and resolves to the host machine. ::: diff --git a/docs/community/index.md b/docs/community/index.md index 911965de..a8b33aa0 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -14,4 +14,6 @@ We're happy to engage with you to talk through your use cases and any points of ## Email + To request more information or schedule a demo email [info@kubefirst.io](mailto:info@kubefirst.io) + From e8bac40ab1aee95dcc427f9c69d915904245a2b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= Date: Wed, 13 Nov 2024 09:51:52 -0700 Subject: [PATCH 4/7] decativate the capital Kubefirst rule for now --- .vale/Custom/substitutions.yml | 2 +- .vale/config/vocabularies/base/accept.txt | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.vale/Custom/substitutions.yml b/.vale/Custom/substitutions.yml index d2eb64df..49e99cf8 100644 --- a/.vale/Custom/substitutions.yml +++ b/.vale/Custom/substitutions.yml @@ -39,7 +39,7 @@ swap: https: HTTPS iam: IAM konstruct: Konstruct - kubefirst: Kubefirst + #kubefirst: Kubefirst kubernetes: Kubernetes mongo: MongoDB oidc: OIDC diff --git a/.vale/config/vocabularies/base/accept.txt b/.vale/config/vocabularies/base/accept.txt index 954994ea..776ebb82 100644 --- a/.vale/config/vocabularies/base/accept.txt +++ b/.vale/config/vocabularies/base/accept.txt @@ -44,6 +44,7 @@ kbot KMS Konstruct kubectl +Kubefirst # L Linode From ea43b77588ca1850e72e25e634810d58815dff51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= Date: Wed, 13 Nov 2024 10:03:20 -0700 Subject: [PATCH 5/7] fix --- CODE_OF_CONDUCT.md | 2 -- docs/common/faq.mdx | 2 +- docs/community/index.md | 4 +--- 3 files changed, 2 insertions(+), 6 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 494545c5..198cede3 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -36,9 +36,7 @@ This Code of Conduct applies within all community spaces, and also applies when ## Enforcement - Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement a [conduct@kubefirst.com](mailto:conduct@kubefirst.com). All complaints will be reviewed and investigated promptly and fairly. - All community leaders are obligated to respect the privacy and security of the reporter of any incident. diff --git a/docs/common/faq.mdx b/docs/common/faq.mdx index b34f59a4..a36ffa79 100644 --- a/docs/common/faq.mdx +++ b/docs/common/faq.mdx @@ -39,7 +39,7 @@ You may need a more stable connection / higher download speed. Check with your i If you still cannot complete the installation due to remaining artifacts after completing a `kubefirst k3d destroy`, you may have to do a manual teardown. Firstly, you need to delete the k3d cluster with the following command: ```shell -~/.k1//tools/k3d cluster delete Kubefirst +~/.k1//tools/k3d cluster delete kubefirst kubefirst reset ``` diff --git a/docs/community/index.md b/docs/community/index.md index a8b33aa0..c65d9666 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -14,6 +14,4 @@ We're happy to engage with you to talk through your use cases and any points of ## Email - -To request more information or schedule a demo email [info@kubefirst.io](mailto:info@kubefirst.io) - +To request more information or schedule a demo email [us](mailto:info@kubefirst.io) From f844127ddf314953d130ab6f0e50204eae87688b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= Date: Wed, 13 Nov 2024 10:04:03 -0700 Subject: [PATCH 6/7] fix --- CODE_OF_CONDUCT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 198cede3..90fb2a02 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -36,7 +36,7 @@ This Code of Conduct applies within all community spaces, and also applies when ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement a [conduct@kubefirst.com](mailto:conduct@kubefirst.com). All complaints will be reviewed and investigated promptly and fairly. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement by [email](mailto:conduct@kubefirst.com). All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. From c35faf03ac83d51d3e8effa15ca6e2daa71a24e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Harper?= Date: Wed, 13 Nov 2024 10:05:21 -0700 Subject: [PATCH 7/7] fix YAML --- .vale/Custom/substitutions.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale/Custom/substitutions.yml b/.vale/Custom/substitutions.yml index 49e99cf8..74e2e5d2 100644 --- a/.vale/Custom/substitutions.yml +++ b/.vale/Custom/substitutions.yml @@ -39,7 +39,7 @@ swap: https: HTTPS iam: IAM konstruct: Konstruct - #kubefirst: Kubefirst + # kubefirst: Kubefirst kubernetes: Kubernetes mongo: MongoDB oidc: OIDC