Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: simplify helm install command and update vale settings #343

Merged
merged 2 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/styles/Google/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ exceptions:
- VS
- Windows
- JSON
- vCluster
2 changes: 1 addition & 1 deletion .github/styles/Loft/code-blocks-language.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
28 changes: 10 additions & 18 deletions vcluster/_partials/deploy/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Step>
</Flow>
Expand All @@ -43,23 +43,15 @@ import InstallCLIFragment from './install-cli-beta.mdx'
<Flow>
<Step>

Create the "team-x" namespace.

```bash
kubectl create namespace team-x
```

</Step>
<Step>

Deploy vCluster using `helm upgrade` command.
Deploy vCluster using `helm upgrade` command.

```bash
helm upgrade --install my-vcluster vcluster \
--values vcluster.yaml \
--repo https://charts.loft.sh \
--namespace team-x \
--repository-config='' \
--create-namespace
```

</Step>
Expand Down Expand Up @@ -116,7 +108,7 @@ To deploy vCluster using ArgoCD, you need the following files:
<Flow>
<Step>

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
Expand All @@ -142,12 +134,12 @@ To deploy vCluster using ArgoCD, you need the following files:
<Step>

Commit and push these files to your configured ArgoCD repository.

</Step>
<Step>

Synchronize your ArgoCD repository with your configured cluster.

</Step>
</Flow>

Expand Down Expand Up @@ -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)
```

</Step>
</Step>
<Step>

Create the namespace for the vCluster.

```bash
kubectl create namespace ${CLUSTER_NAMESPACE}
```
Expand All @@ -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.
:::

</Step>
Expand All @@ -215,4 +207,4 @@ The Kubernetes version for the vCluster is not set at the CAPI provider command.
</Step>
</Flow>
</TabItem>
</Tabs>
</Tabs>
28 changes: 10 additions & 18 deletions vcluster_versioned_docs/version-0.20.0/_partials/deploy/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Step>
</Flow>
Expand All @@ -43,23 +43,15 @@ import InstallCLIFragment from './install-cli.mdx'
<Flow>
<Step>

Create the "team-x" namespace.

```bash
kubectl create namespace team-x
```

</Step>
<Step>

Deploy vCluster using `helm upgrade` command.
Deploy vCluster using `helm upgrade` command.

```bash
helm upgrade --install my-vcluster vcluster \
--values vcluster.yaml \
--repo https://charts.loft.sh \
--namespace team-x \
--repository-config='' \
--create-namespace
```

</Step>
Expand Down Expand Up @@ -116,7 +108,7 @@ To deploy vCluster using ArgoCD, you need the following files:
<Flow>
<Step>

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
Expand All @@ -142,12 +134,12 @@ To deploy vCluster using ArgoCD, you need the following files:
<Step>

Commit and push these files to your configured ArgoCD repository.

</Step>
<Step>

Synchronize your ArgoCD repository with your configured cluster.

</Step>
</Flow>

Expand Down Expand Up @@ -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)
```

</Step>
</Step>
<Step>

Create the namespace for the vCluster.

```bash
kubectl create namespace ${CLUSTER_NAMESPACE}
```
Expand All @@ -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.
:::

</Step>
Expand All @@ -215,4 +207,4 @@ The Kubernetes version for the vCluster is not set at the CAPI provider command.
</Step>
</Flow>
</TabItem>
</Tabs>
</Tabs>