From d34396fae1ee8fa33dccc55b7ad14369ff4cb820 Mon Sep 17 00:00:00 2001 From: Amber Alston Date: Tue, 19 Nov 2024 14:55:58 -0700 Subject: [PATCH 01/12] Update testing-how-to.md --- docs/vendor/testing-how-to.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/vendor/testing-how-to.md b/docs/vendor/testing-how-to.md index b7b500235d..688f43b395 100644 --- a/docs/vendor/testing-how-to.md +++ b/docs/vendor/testing-how-to.md @@ -43,6 +43,7 @@ To create a cluster using the Replicated CLI: * `NAME` is any name for the cluster. If `--name` is excluded, a name is automatically generated for the cluster. * `K8S_DISTRO` is the Kubernetes distribution for the cluster. * `K8S_VERSION` is the Kubernetes version for the cluster. + * When creating an Embedded Cluster using `cluster create`, the value passed for `--version` should be the `Channel sequence` value * `DISK_SIZE` is the disk size (GiB) to request per node. * `INSTANCE_TYPE` is the instance type to use for each node. @@ -307,4 +308,4 @@ Replicated recommends that you maintain unique CI/CD workflows for development ( Incorporating code tests into your CI/CD workflows is important for ensuring that developers receive quick feedback and can make updates in small iterations. Replicated recommends that you create and run all of the following test types as part of your CI/CD workflows: - \ No newline at end of file + From 7a93841421dd4cacea9de15817dfb3ba6156bc7f Mon Sep 17 00:00:00 2001 From: Amber Alston Date: Tue, 19 Nov 2024 14:59:50 -0700 Subject: [PATCH 02/12] Update replicated-cli-cluster-prepare.md --- docs/reference/replicated-cli-cluster-prepare.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/reference/replicated-cli-cluster-prepare.md b/docs/reference/replicated-cli-cluster-prepare.md index 32658683ba..0c3320e98f 100644 --- a/docs/reference/replicated-cli-cluster-prepare.md +++ b/docs/reference/replicated-cli-cluster-prepare.md @@ -9,6 +9,10 @@ Create a cluster and a release, then install the release in the cluster. This al `cluster prepare` is not recommended for production testing. For production testing, use `cluster create` instead. ::: +:::note +The `cluster prepare` command is not supported for the Embedded Cluster type. +::: + ## Usage ```bash replicated cluster prepare [flags] From a30aadf97a6e77455c4c4189784e3162bf042992 Mon Sep 17 00:00:00 2001 From: Amber Alston Date: Tue, 19 Nov 2024 15:12:02 -0700 Subject: [PATCH 03/12] Update testing-how-to.md --- docs/vendor/testing-how-to.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/vendor/testing-how-to.md b/docs/vendor/testing-how-to.md index 688f43b395..0d1d6aa858 100644 --- a/docs/vendor/testing-how-to.md +++ b/docs/vendor/testing-how-to.md @@ -42,8 +42,9 @@ To create a cluster using the Replicated CLI: Where: * `NAME` is any name for the cluster. If `--name` is excluded, a name is automatically generated for the cluster. * `K8S_DISTRO` is the Kubernetes distribution for the cluster. - * `K8S_VERSION` is the Kubernetes version for the cluster. - * When creating an Embedded Cluster using `cluster create`, the value passed for `--version` should be the `Channel sequence` value + * `K8S_VERSION` is the Kubernetes version for the cluster if creating a standard Cloud or VM based cluster. + * When creating an Embedded Cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the `Channel release sequence` value if not using "latest" + * When creating a kURL cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the kURL Installer ID if not using "latest" * `DISK_SIZE` is the disk size (GiB) to request per node. * `INSTANCE_TYPE` is the instance type to use for each node. From 738b73a879e03bc61cb7a5031e04c58f89c03333 Mon Sep 17 00:00:00 2001 From: Amber Alston Date: Tue, 19 Nov 2024 15:34:22 -0700 Subject: [PATCH 04/12] Update testing-supported-clusters.md --- docs/vendor/testing-supported-clusters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vendor/testing-supported-clusters.md b/docs/vendor/testing-supported-clusters.md index 7c4a46a1b1..273a966b9c 100644 --- a/docs/vendor/testing-supported-clusters.md +++ b/docs/vendor/testing-supported-clusters.md @@ -267,7 +267,7 @@ Compatibility Matrix supports creating [kURL](https://kurl.sh) clusters. Supported kURL Versions - Any promoted kURL installer. For an installer version other than "latest", you can find the ID for previously promoted installers on the **Channels > kURL Installer History** page in the Vendor Portal. For more information about viewing the history of kURL installers promoted to a channel, see [Installer History](/vendor/installer-history). + Any promoted kURL installer. Version is optional. For an installer version other than "latest", you can find the ID for previously promoted installers on the **Channels > kURL Installer History** page in the Vendor Portal. For more information about viewing the history of kURL installers promoted to a channel, see [Installer History](/vendor/installer-history). Supported Instance Types From 2d49d577c30db1b982c5898120402ddd5967ead5 Mon Sep 17 00:00:00 2001 From: Amber Alston Date: Tue, 19 Nov 2024 15:39:10 -0700 Subject: [PATCH 05/12] Update testing-supported-clusters.md --- docs/vendor/testing-supported-clusters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vendor/testing-supported-clusters.md b/docs/vendor/testing-supported-clusters.md index 273a966b9c..fa9694d304 100644 --- a/docs/vendor/testing-supported-clusters.md +++ b/docs/vendor/testing-supported-clusters.md @@ -244,7 +244,7 @@ Compatibility Matrix supports creating clusters with Replicated Embedded Cluster
  • The Admin Console UI is not exposed publicly and must be exposed via `kubectl -n kotsadm port-forward svc/kurl-proxy-kotsadm 38800:8800`. The password for the Admin Console is `password`.
    • -
  • A valid customer license is required for installing with Embedded Cluster.
    • +
  • A valid customer license is required to create an Embedded Cluster.
  • The [cluster prepare](/vendor/testing-how-to#prepare-clusters) command is not supported.

For additional limitations that apply to all distributions, see Limitations.

From ade0a92e41b46ab4fd8f1a923a8e796f0dc16903 Mon Sep 17 00:00:00 2001 From: Amber Alston Date: Tue, 19 Nov 2024 15:44:41 -0700 Subject: [PATCH 06/12] Update testing-how-to.md --- docs/vendor/testing-how-to.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/vendor/testing-how-to.md b/docs/vendor/testing-how-to.md index 0d1d6aa858..3ab0d4f00c 100644 --- a/docs/vendor/testing-how-to.md +++ b/docs/vendor/testing-how-to.md @@ -47,6 +47,7 @@ To create a cluster using the Replicated CLI: * When creating a kURL cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the kURL Installer ID if not using "latest" * `DISK_SIZE` is the disk size (GiB) to request per node. * `INSTANCE_TYPE` is the instance type to use for each node. + * (Embedded Cluster only) `License ID` - A valid customer license is required to create an Embedded Cluster and can be passed as `--license-id [value]`. For command usage and additional optional flags, see [cluster create](/reference/replicated-cli-cluster-create). From 70c12a56441b1020ef60a82ab8effee6c882b7fe Mon Sep 17 00:00:00 2001 From: Amber Alston Date: Tue, 19 Nov 2024 16:02:46 -0700 Subject: [PATCH 07/12] Update testing-how-to.md --- docs/vendor/testing-how-to.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vendor/testing-how-to.md b/docs/vendor/testing-how-to.md index 3ab0d4f00c..198943cefc 100644 --- a/docs/vendor/testing-how-to.md +++ b/docs/vendor/testing-how-to.md @@ -43,7 +43,7 @@ To create a cluster using the Replicated CLI: * `NAME` is any name for the cluster. If `--name` is excluded, a name is automatically generated for the cluster. * `K8S_DISTRO` is the Kubernetes distribution for the cluster. * `K8S_VERSION` is the Kubernetes version for the cluster if creating a standard Cloud or VM based cluster. - * When creating an Embedded Cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the `Channel release sequence` value if not using "latest" + * When creating an Embedded Cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the `Channel release sequence` value, otherwise the latest available release on the channel will be used. * When creating a kURL cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the kURL Installer ID if not using "latest" * `DISK_SIZE` is the disk size (GiB) to request per node. * `INSTANCE_TYPE` is the instance type to use for each node. From 06c2294612f76297ce0bafa82727e87bbe2794ca Mon Sep 17 00:00:00 2001 From: Amber Alston Date: Tue, 19 Nov 2024 16:07:55 -0700 Subject: [PATCH 08/12] Update testing-supported-clusters.md --- docs/vendor/testing-supported-clusters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vendor/testing-supported-clusters.md b/docs/vendor/testing-supported-clusters.md index fa9694d304..c2eea1ffe7 100644 --- a/docs/vendor/testing-supported-clusters.md +++ b/docs/vendor/testing-supported-clusters.md @@ -267,7 +267,7 @@ Compatibility Matrix supports creating [kURL](https://kurl.sh) clusters. Supported kURL Versions - Any promoted kURL installer. Version is optional. For an installer version other than "latest", you can find the ID for previously promoted installers on the **Channels > kURL Installer History** page in the Vendor Portal. For more information about viewing the history of kURL installers promoted to a channel, see [Installer History](/vendor/installer-history). + Any promoted kURL installer. Version is optional. For an installer version other than "latest", you can find the specific Installer ID for a previously promoted installer under the relevant **Install Command** (ID after kurl.sh/) on the **Channels > kURL Installer History** page in the Vendor Portal. For more information about viewing the history of kURL installers promoted to a channel, see [Installer History](/vendor/installer-history). Supported Instance Types From 3fc3f1e1147539fe3df35e0fcc85dd6bd22adb40 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 19 Nov 2024 18:29:50 -0700 Subject: [PATCH 09/12] docs edits --- docs/vendor/testing-how-to.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/vendor/testing-how-to.md b/docs/vendor/testing-how-to.md index 198943cefc..246ae373e1 100644 --- a/docs/vendor/testing-how-to.md +++ b/docs/vendor/testing-how-to.md @@ -42,9 +42,9 @@ To create a cluster using the Replicated CLI: Where: * `NAME` is any name for the cluster. If `--name` is excluded, a name is automatically generated for the cluster. * `K8S_DISTRO` is the Kubernetes distribution for the cluster. - * `K8S_VERSION` is the Kubernetes version for the cluster if creating a standard Cloud or VM based cluster. - * When creating an Embedded Cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the `Channel release sequence` value, otherwise the latest available release on the channel will be used. - * When creating a kURL cluster type using `cluster create`, use of `--version` is optional, and the value passed should be the kURL Installer ID if not using "latest" + * `K8S_VERSION` is the Kubernetes version for the cluster if creating a standard Cloud or VM-based cluster. If creating an Embedded Cluster or kURL cluster type,`--version` is optional: + * For Embedded Cluster types, `--verison` is the latest available release on the channel by default. Otherwise, to specify a different release, set `--version` to the `Channel release sequence` value for the release. + * For kURL cluster types, `--verison` is the `"latest"` kURL Installer ID by default. Otherwise, to specify a different kURL Installer, set `--version` to the kURL Installer ID. * `DISK_SIZE` is the disk size (GiB) to request per node. * `INSTANCE_TYPE` is the instance type to use for each node. * (Embedded Cluster only) `License ID` - A valid customer license is required to create an Embedded Cluster and can be passed as `--license-id [value]`. From f9b3bc87e7d3817d81cd5bbbbc586de21d1f5374 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 19 Nov 2024 18:32:09 -0700 Subject: [PATCH 10/12] Update testing-how-to.md --- docs/vendor/testing-how-to.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/vendor/testing-how-to.md b/docs/vendor/testing-how-to.md index 246ae373e1..5f47154c71 100644 --- a/docs/vendor/testing-how-to.md +++ b/docs/vendor/testing-how-to.md @@ -37,7 +37,7 @@ To create a cluster using the Replicated CLI: 1. Run the following command to create a cluster: ``` - replicated cluster create --name NAME --distribution K8S_DISTRO --version K8S_VERSION --disk DISK_SIZE --instance-type INSTANCE_TYPE + replicated cluster create --name NAME --distribution K8S_DISTRO --version K8S_VERSION --disk DISK_SIZE --instance-type INSTANCE_TYPE [--license-id LICENSE_ID] ``` Where: * `NAME` is any name for the cluster. If `--name` is excluded, a name is automatically generated for the cluster. @@ -47,7 +47,7 @@ To create a cluster using the Replicated CLI: * For kURL cluster types, `--verison` is the `"latest"` kURL Installer ID by default. Otherwise, to specify a different kURL Installer, set `--version` to the kURL Installer ID. * `DISK_SIZE` is the disk size (GiB) to request per node. * `INSTANCE_TYPE` is the instance type to use for each node. - * (Embedded Cluster only) `License ID` - A valid customer license is required to create an Embedded Cluster and can be passed as `--license-id [value]`. + * (Embedded Cluster Only) `LICENSE_ID` is a valid customer license. Required to create an Embedded Cluster. For command usage and additional optional flags, see [cluster create](/reference/replicated-cli-cluster-create). From c71ebf1c91003506ebb36f7a6e67ff4f46c14754 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 19 Nov 2024 18:32:45 -0700 Subject: [PATCH 11/12] Update testing-supported-clusters.md --- docs/vendor/testing-supported-clusters.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vendor/testing-supported-clusters.md b/docs/vendor/testing-supported-clusters.md index c2eea1ffe7..a88bc167aa 100644 --- a/docs/vendor/testing-supported-clusters.md +++ b/docs/vendor/testing-supported-clusters.md @@ -244,7 +244,7 @@ Compatibility Matrix supports creating clusters with Replicated Embedded Cluster
  • The Admin Console UI is not exposed publicly and must be exposed via `kubectl -n kotsadm port-forward svc/kurl-proxy-kotsadm 38800:8800`. The password for the Admin Console is `password`.
    • -
  • A valid customer license is required to create an Embedded Cluster.
    • +
  • A valid customer license is required to create an Embedded Cluster.
  • The [cluster prepare](/vendor/testing-how-to#prepare-clusters) command is not supported.

For additional limitations that apply to all distributions, see Limitations.

From d54ca90eb021b432f6e344a6e9ad6c527dcae2e9 Mon Sep 17 00:00:00 2001 From: Paige Calvert Date: Tue, 19 Nov 2024 18:33:50 -0700 Subject: [PATCH 12/12] Update replicated-cli-cluster-prepare.md --- docs/reference/replicated-cli-cluster-prepare.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/reference/replicated-cli-cluster-prepare.md b/docs/reference/replicated-cli-cluster-prepare.md index 0c3320e98f..98d66e718e 100644 --- a/docs/reference/replicated-cli-cluster-prepare.md +++ b/docs/reference/replicated-cli-cluster-prepare.md @@ -5,13 +5,10 @@ import Help from "../partials/replicated-cli/_help.mdx" Create a cluster and a release, then install the release in the cluster. This allows you to deploy applications to a cluster for compatibility testing without needing to promote a release to a channel or create a temporary customer. For more information, see [About Compatibility Matrix](/vendor/testing-about). -:::note -`cluster prepare` is not recommended for production testing. For production testing, use `cluster create` instead. -::: +## Limtiations -:::note -The `cluster prepare` command is not supported for the Embedded Cluster type. -::: +* `cluster prepare` is not recommended for production testing. For production testing, use `cluster create` instead. +* `cluster prepare` is not supported for the Embedded Cluster type. ## Usage ```bash