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

Update testing-how-to.md #2839

Merged
merged 12 commits into from
Nov 20, 2024
4 changes: 4 additions & 0 deletions docs/reference/replicated-cli-cluster-prepare.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
9 changes: 6 additions & 3 deletions docs/vendor/testing-how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,17 @@ 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]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ wrapped in brackets to indicate optionality

```
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.
* `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` 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).

Expand Down Expand Up @@ -307,4 +310,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:

<TestRecs/>
<TestRecs/>
4 changes: 2 additions & 2 deletions docs/vendor/testing-supported-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ Compatibility Matrix supports creating clusters with Replicated Embedded Cluster
<td>
<ul>
<li>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`.</li>
<li>A valid customer license is required for installing with Embedded Cluster.</li>
<li><strong>A valid customer license is required to create an Embedded Cluster.</strong></li>
<li>The [cluster prepare](/vendor/testing-how-to#prepare-clusters) command is not supported.</li>
</ul>
<p>For additional limitations that apply to all distributions, see <a href="testing-about#limitations">Limitations</a>.</p>
Expand All @@ -267,7 +267,7 @@ Compatibility Matrix supports creating [kURL](https://kurl.sh) clusters.
</tr>
<tr>
<th>Supported kURL Versions</th>
<td>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).</td>
<td>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).</td>
</tr>
<tr>
<th>Supported Instance Types</th>
Expand Down