Skip to content

Commit

Permalink
fix: broken links to v0.20 migration guide (#286)
Browse files Browse the repository at this point in the history
  • Loading branch information
Piotr1215 authored Oct 7, 2024
1 parent e0727c9 commit 71c38b5
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 44 deletions.
44 changes: 22 additions & 22 deletions vcluster/cli/0-20-cli-changes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ sidebar_label: v0.20 Changes
sidebar_position: 1
---

With the breaking changes introduced in v0.20, the vCluster CLI was also updated to match with the direction that we are going.
With the breaking changes introduced in v0.20, the vCluster CLI was also updated to match with the direction that we are going.

There were also two signicant CLI changes that influenced the changes in the `vcluster` CLI.
There were also two signicant CLI changes that influenced the changes in the `vcluster` CLI.

1. The `loft` CLI, which was used to manage the platform (formerly known as loft) was deprecated and no longer supported, so all commands in the `loft` CLI were moved into the `vcluster` CLI.
2. The `vcluster pro` command was renamed to `vcluster platform`.
1. The `loft` CLI, which was used to manage the platform (formerly known as loft) was deprecated and no longer supported, so all commands in the `loft` CLI were moved into the `vcluster` CLI.
2. The `vcluster pro` command was renamed to `vcluster platform`.

With these two signifcant changes, there were duplicate functionality from the older CLI (`loft`) and vCluster command (`vcluster pro`) that were merged as `vcluster platform`.
With these two signifcant changes, there were duplicate functionality from the older CLI (`loft`) and vCluster command (`vcluster pro`) that were merged as `vcluster platform`.

## New Commands in v0.20.0

* `vcluster convert` : Convert virtual cluster config values - This command is used to convert pre-v0.20 values.yaml files to the new vcluster.yaml
format. More details on how to convert your pre v0.20 `values.yaml` can be found in our [dedicated migration guide](../reference/migrations/0-20-migration/).
* `vcluster convert` : Convert virtual cluster config values - This command is used to convert pre-v0.20 values.yaml files to the new vcluster.yaml
format. More details on how to convert your pre v0.20 `values.yaml` can be found in our [dedicated migration guide](../reference/migrations/0-20-migration.mdx).

* `vcluster set` : Set configuration

* `vcluster use` : vCluster use subcommand - This command allows you to switch between the drivers (helm or platform).
* `vcluster use` : vCluster use subcommand - This command allows you to switch between the drivers (helm or platform).

## Renamed Commands from vCluster CLI v0.19.x

Expand All @@ -37,17 +37,17 @@ With these two signifcant changes, there were duplicate functionality from the o
* `loft import` was renamed to `vcluster platform add` : Adds a cluster or vCluster` to vCluster platform


### Changed Subcommands
### Changed Subcommands

* `vcluster pro token` / `loft token` was renamed to `vcluster platform access-key` 

* `vcluster pro connect` was renamed to `vcluster platform connect` with additional context.

* `vcluster pro generate` was removed and replaced with `vcluster platform create` and `vcluster platform set`

### Renamed Commands from `loft` CLI to `vcluster platform` CLI
### Renamed Commands from `loft` CLI to `vcluster platform` CLI

This is a list of commands that formerly in the `loft` CLI and now renamed in `vcluster` under `vcluster platform`. All funcationality remains the same.
This is a list of commands that formerly in the `loft` CLI and now renamed in `vcluster` under `vcluster platform`. All funcationality remains the same.

* `vcluster platform backup` : Backup subcommands

Expand Down Expand Up @@ -79,27 +79,27 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

### New Global Flag

•  `--config` string : The vcluster CLI config to use (will be created if it does not exist)
•  `--config` string : The vcluster CLI config to use (will be created if it does not exist)

### New Flags within Each Command
### New Flags within Each Command

`vcluster connect`

* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).

`vcluster create`

* `--add` : Automatically adds the virtual cluster to the current vCluster platform when using the helm driver (default true).
* `--add` : Automatically adds the virtual cluster to the current vCluster platform when using the helm driver (default true).

* `--background-proxy` : Uses a background-proxy to access the vCluster if docker is installed and reachable (default true).
* `--background-proxy` : Uses a background-proxy to access the vCluster if docker is installed and reachable (default true).

* `--create-context` : Creates a kube context for the space (default true).

* `--description` string : Description to show in the platform UI for this virtual cluster. 

* `--display-name` string : Display name to show in the platform UI for this virtual cluster.

* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).
* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).

* `--parameters` string : Uses a file for the parameters if a template is used.

Expand All @@ -111,7 +111,7 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

* `--skip-wait` : Does not wait until the virtual cluster is running if true. 

* `--switch-context` : Switches the current context to the new context (default true).
* `--switch-context` : Switches the current context to the new context (default true).

* `--team` string : Specifies the team to create the space for. 

Expand All @@ -123,7 +123,7 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

* `--delete-context` : Deletes the corresponding kube context if there is any (default true).

* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).
* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).

`vcluster list`

Expand All @@ -135,7 +135,7 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

`vcluster pause`

* `--driver` string : Specifies the driver for the virtual cluster (helm or platform).
* `--driver` string : Specifies the driver for the virtual cluster (helm or platform).

`vcluster resume`:

Expand All @@ -145,7 +145,7 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

`vcluster connect`

* `--kube-config` string: This flag was used to specify the file to write the created kube config to. The default value was "./kubeconfig.yaml". 
* `--kube-config` string: This flag was used to specify the file to write the created kube config to. The default value was "./kubeconfig.yaml". 

* `--kube-config-context-name` string: This flag was used to override the context name of the generated virtual cluster kube config with a specified name. 

Expand All @@ -159,6 +159,6 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

* `--extra-values` strings: This flag was deprecated and used to specify extra values. It was replaced by the  --values  flag.

* `--isolate` : This flag was used to run vcluster and its workloads in an isolated environment. In v0.20.0, running workloads in an isolated environment is [configured within vcluster.yaml](../deploy/topologies/isolated-workloads/).
* `--isolate` : This flag was used to run vcluster and its workloads in an isolated environment. In v0.20.0, running workloads in an isolated environment is [configured within vcluster.yaml](../deploy/topologies/isolated-workloads/).

* `--params` string: This flag was used to specify a file for the parameters if a template was used. It was replaced by the  --parameters string  flag.
* `--params` string: This flag was used to specify a file for the parameters if a template was used. It was replaced by the  --parameters string  flag.
44 changes: 22 additions & 22 deletions vcluster_versioned_docs/version-0.20.0/cli/0-20-cli-changes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@ sidebar_label: v0.20 Changes
sidebar_position: 1
---

With the breaking changes introduced in v0.20, the vCluster CLI was also updated to match with the direction that we are going.
With the breaking changes introduced in v0.20, the vCluster CLI was also updated to match with the direction that we are going.

There were also two signicant CLI changes that influenced the changes in the `vcluster` CLI.
There were also two signicant CLI changes that influenced the changes in the `vcluster` CLI.

1. The `loft` CLI, which was used to manage the platform (formerly known as loft) was deprecated and no longer supported, so all commands in the `loft` CLI were moved into the `vcluster` CLI.
2. The `vcluster pro` command was renamed to `vcluster platform`.
1. The `loft` CLI, which was used to manage the platform (formerly known as loft) was deprecated and no longer supported, so all commands in the `loft` CLI were moved into the `vcluster` CLI.
2. The `vcluster pro` command was renamed to `vcluster platform`.

With these two signifcant changes, there were duplicate functionality from the older CLI (`loft`) and vCluster command (`vcluster pro`) that were merged as `vcluster platform`.
With these two signifcant changes, there were duplicate functionality from the older CLI (`loft`) and vCluster command (`vcluster pro`) that were merged as `vcluster platform`.

## New Commands in v0.20.0

* `vcluster convert` : Convert virtual cluster config values - This command is used to convert pre-v0.20 values.yaml files to the new vcluster.yaml
format. More details on how to convert your pre v0.20 `values.yaml` can be found in our [dedicated migration guide](../reference/migrations/0-20-migration/).
* `vcluster convert` : Convert virtual cluster config values - This command is used to convert pre-v0.20 values.yaml files to the new vcluster.yaml
format. More details on how to convert your pre v0.20 `values.yaml` can be found in our [dedicated migration guide](../reference/migrations/0-20-migration.mdx).

* `vcluster set` : Set configuration

* `vcluster use` : vCluster use subcommand - This command allows you to switch between the drivers (helm or platform).
* `vcluster use` : vCluster use subcommand - This command allows you to switch between the drivers (helm or platform).

## Renamed Commands from vCluster CLI v0.19.x

Expand All @@ -37,17 +37,17 @@ With these two signifcant changes, there were duplicate functionality from the o
* `loft import` was renamed to `vcluster platform add` : Adds a cluster or vCluster` to vCluster platform


### Changed Subcommands
### Changed Subcommands

* `vcluster pro token` / `loft token` was renamed to `vcluster platform access-key` 

* `vcluster pro connect` was renamed to `vcluster platform connect` with additional context.

* `vcluster pro generate` was removed and replaced with `vcluster platform create` and `vcluster platform set`

### Renamed Commands from `loft` CLI to `vcluster platform` CLI
### Renamed Commands from `loft` CLI to `vcluster platform` CLI

This is a list of commands that formerly in the `loft` CLI and now renamed in `vcluster` under `vcluster platform`. All funcationality remains the same.
This is a list of commands that formerly in the `loft` CLI and now renamed in `vcluster` under `vcluster platform`. All funcationality remains the same.

* `vcluster platform backup` : Backup subcommands

Expand Down Expand Up @@ -79,27 +79,27 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

### New Global Flag

•  `--config` string : The vcluster CLI config to use (will be created if it does not exist)
•  `--config` string : The vcluster CLI config to use (will be created if it does not exist)

### New Flags within Each Command
### New Flags within Each Command

`vcluster connect`

* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).

`vcluster create`

* `--add` : Automatically adds the virtual cluster to the current vCluster platform when using the helm driver (default true).
* `--add` : Automatically adds the virtual cluster to the current vCluster platform when using the helm driver (default true).

* `--background-proxy` : Uses a background-proxy to access the vCluster if docker is installed and reachable (default true).
* `--background-proxy` : Uses a background-proxy to access the vCluster if docker is installed and reachable (default true).

* `--create-context` : Creates a kube context for the space (default true).

* `--description` string : Description to show in the platform UI for this virtual cluster. 

* `--display-name` string : Display name to show in the platform UI for this virtual cluster.

* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).
* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).

* `--parameters` string : Uses a file for the parameters if a template is used.

Expand All @@ -111,7 +111,7 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

* `--skip-wait` : Does not wait until the virtual cluster is running if true. 

* `--switch-context` : Switches the current context to the new context (default true).
* `--switch-context` : Switches the current context to the new context (default true).

* `--team` string : Specifies the team to create the space for. 

Expand All @@ -123,7 +123,7 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

* `--delete-context` : Deletes the corresponding kube context if there is any (default true).

* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).
* `--driver` string : Specifies the driver to use for managing the virtual cluster (helm or platform).

`vcluster list`

Expand All @@ -135,7 +135,7 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

`vcluster pause`

* `--driver` string : Specifies the driver for the virtual cluster (helm or platform).
* `--driver` string : Specifies the driver for the virtual cluster (helm or platform).

`vcluster resume`:

Expand All @@ -145,7 +145,7 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

`vcluster connect`

* `--kube-config` string: This flag was used to specify the file to write the created kube config to. The default value was "./kubeconfig.yaml". 
* `--kube-config` string: This flag was used to specify the file to write the created kube config to. The default value was "./kubeconfig.yaml". 

* `--kube-config-context-name` string: This flag was used to override the context name of the generated virtual cluster kube config with a specified name. 

Expand All @@ -159,6 +159,6 @@ This is a list of commands that formerly in the `loft` CLI and now renamed in `v

* `--extra-values` strings: This flag was deprecated and used to specify extra values. It was replaced by the  --values  flag.

* `--isolate` : This flag was used to run vcluster and its workloads in an isolated environment. In v0.20.0, running workloads in an isolated environment is [configured within vcluster.yaml](../deploy/topologies/isolated-workloads/).
* `--isolate` : This flag was used to run vcluster and its workloads in an isolated environment. In v0.20.0, running workloads in an isolated environment is [configured within vcluster.yaml](../deploy/topologies/isolated-workloads.mdx).

* `--params` string: This flag was used to specify a file for the parameters if a template was used. It was replaced by the  --parameters string  flag.
* `--params` string: This flag was used to specify a file for the parameters if a template was used. It was replaced by the  --parameters string  flag.

0 comments on commit 71c38b5

Please sign in to comment.