From b8a92452ce9dccf486f45918e3a799debac65365 Mon Sep 17 00:00:00 2001 From: Piotr Zaniewski Date: Mon, 4 Nov 2024 11:32:56 +0100 Subject: [PATCH 1/2] chore: vale settings - exclude vCluster from sentence-style capitalization rule - change requirement for code blocks to have a language specified to a suggestion Signed-off-by: Piotr Zaniewski --- .github/styles/Google/Headings.yml | 1 + .github/styles/Loft/code-blocks-language.yml | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/styles/Google/Headings.yml b/.github/styles/Google/Headings.yml index c8d5be26e..7683b0636 100644 --- a/.github/styles/Google/Headings.yml +++ b/.github/styles/Google/Headings.yml @@ -27,3 +27,4 @@ exceptions: - VS - Windows - JSON + - vCluster \ No newline at end of file diff --git a/.github/styles/Loft/code-blocks-language.yml b/.github/styles/Loft/code-blocks-language.yml index 1c5d60ecb..8d659cdf9 100644 --- a/.github/styles/Loft/code-blocks-language.yml +++ b/.github/styles/Loft/code-blocks-language.yml @@ -1,6 +1,6 @@ extends: existence message: "Code blocks must include language and title attribute: ```bash title=\"Description here\"" -level: warning +level: suggestion scope: raw nonword: true tokens: From 12534fccbbea58e663d6efe4f9d524f3373474b3 Mon Sep 17 00:00:00 2001 From: Piotr Zaniewski Date: Mon, 4 Nov 2024 12:37:15 +0100 Subject: [PATCH 2/2] chore: simplify helm install command Signed-off-by: Piotr Zaniewski --- vcluster/_partials/deploy/deploy.mdx | 28 +++++++------------ .../_partials/deploy/deploy.mdx | 28 +++++++------------ 2 files changed, 20 insertions(+), 36 deletions(-) diff --git a/vcluster/_partials/deploy/deploy.mdx b/vcluster/_partials/deploy/deploy.mdx index 2cd532761..c82b6ea62 100644 --- a/vcluster/_partials/deploy/deploy.mdx +++ b/vcluster/_partials/deploy/deploy.mdx @@ -32,7 +32,7 @@ import InstallCLIFragment from './install-cli-beta.mdx' ```bash vcluster create my-vcluster --namespace team-x --values vcluster.yaml ``` - + When the installation finishes, you are automatically connected to the virtual cluster. You Kubernetes context is updated to point to your new virtual cluster. You can run local `kubectl` commands for the new virtual cluster. @@ -43,16 +43,7 @@ import InstallCLIFragment from './install-cli-beta.mdx' - Create the "team-x" namespace. - - ```bash - kubectl create namespace team-x - ``` - - - - - Deploy vCluster using `helm upgrade` command. + Deploy vCluster using `helm upgrade` command. ```bash helm upgrade --install my-vcluster vcluster \ @@ -60,6 +51,7 @@ import InstallCLIFragment from './install-cli-beta.mdx' --repo https://charts.loft.sh \ --namespace team-x \ --repository-config='' \ + --create-namespace ``` @@ -116,7 +108,7 @@ To deploy vCluster using ArgoCD, you need the following files: - Create the ArgoCD `Application` file `my-vcluster-app.yaml`, which refers to the vCluster Helm chart. + Create the ArgoCD `Application` file `my-vcluster-app.yaml`, which refers to the vCluster Helm chart. ```yaml apiVersion: argoproj.io/v1alpha1 @@ -142,12 +134,12 @@ To deploy vCluster using ArgoCD, you need the following files: Commit and push these files to your configured ArgoCD repository. - + Synchronize your ArgoCD repository with your configured cluster. - + @@ -181,11 +173,11 @@ Learn more about [Cluster API Provider for vCluster](https://github.com/loft-sh/ export VCLUSTER_YAML=$(awk '{printf "%s\\n", $0}' vcluster.yaml) ``` - + Create the namespace for the vCluster. - + ```bash kubectl create namespace ${CLUSTER_NAMESPACE} ``` @@ -202,7 +194,7 @@ Learn more about [Cluster API Provider for vCluster](https://github.com/loft-sh/ ``` :::note Kubernetes Version -The Kubernetes version for the vCluster is not set at the CAPI provider command. It is configured the `vcluster.yaml` file based on your Kubernetes distribution. +The Kubernetes version for the vCluster is not set at the CAPI provider command. It is configured the `vcluster.yaml` file based on your Kubernetes distribution. ::: @@ -215,4 +207,4 @@ The Kubernetes version for the vCluster is not set at the CAPI provider command. - \ No newline at end of file + diff --git a/vcluster_versioned_docs/version-0.20.0/_partials/deploy/deploy.mdx b/vcluster_versioned_docs/version-0.20.0/_partials/deploy/deploy.mdx index f75357340..eaf964acf 100644 --- a/vcluster_versioned_docs/version-0.20.0/_partials/deploy/deploy.mdx +++ b/vcluster_versioned_docs/version-0.20.0/_partials/deploy/deploy.mdx @@ -32,7 +32,7 @@ import InstallCLIFragment from './install-cli.mdx' ```bash vcluster create my-vcluster --namespace team-x --values vcluster.yaml ``` - + When the installation finishes, you are automatically connected to the virtual cluster. You Kubernetes context is updated to point to your new virtual cluster. You can run local `kubectl` commands for the new virtual cluster. @@ -43,16 +43,7 @@ import InstallCLIFragment from './install-cli.mdx' - Create the "team-x" namespace. - - ```bash - kubectl create namespace team-x - ``` - - - - - Deploy vCluster using `helm upgrade` command. + Deploy vCluster using `helm upgrade` command. ```bash helm upgrade --install my-vcluster vcluster \ @@ -60,6 +51,7 @@ import InstallCLIFragment from './install-cli.mdx' --repo https://charts.loft.sh \ --namespace team-x \ --repository-config='' \ + --create-namespace ``` @@ -116,7 +108,7 @@ To deploy vCluster using ArgoCD, you need the following files: - Create the ArgoCD `Application` file `my-vcluster-app.yaml`, which refers to the vCluster Helm chart. + Create the ArgoCD `Application` file `my-vcluster-app.yaml`, which refers to the vCluster Helm chart. ```yaml apiVersion: argoproj.io/v1alpha1 @@ -142,12 +134,12 @@ To deploy vCluster using ArgoCD, you need the following files: Commit and push these files to your configured ArgoCD repository. - + Synchronize your ArgoCD repository with your configured cluster. - + @@ -181,11 +173,11 @@ Learn more about [Cluster API Provider for vCluster](https://github.com/loft-sh/ export VCLUSTER_YAML=$(awk '{printf "%s\\n", $0}' vcluster.yaml) ``` - + Create the namespace for the vCluster. - + ```bash kubectl create namespace ${CLUSTER_NAMESPACE} ``` @@ -202,7 +194,7 @@ Learn more about [Cluster API Provider for vCluster](https://github.com/loft-sh/ ``` :::note Kubernetes Version -The Kubernetes version for the vCluster is not set at the CAPI provider command. It is configured the `vcluster.yaml` file based on your Kubernetes distribution. +The Kubernetes version for the vCluster is not set at the CAPI provider command. It is configured the `vcluster.yaml` file based on your Kubernetes distribution. ::: @@ -215,4 +207,4 @@ The Kubernetes version for the vCluster is not set at the CAPI provider command. - \ No newline at end of file +