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.

Sign up for GitHub

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
Merged

Update testing-how-to.md #2839

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d34396f
Update testing-how-to.md
AmberAlston Nov 19, 2024
7a93841
Update replicated-cli-cluster-prepare.md
AmberAlston Nov 19, 2024
a30aadf
Update testing-how-to.md
AmberAlston Nov 19, 2024
738b73a
Update testing-supported-clusters.md
AmberAlston Nov 19, 2024
2d49d57
Update testing-supported-clusters.md
AmberAlston Nov 19, 2024
ade0a92
Update testing-how-to.md
AmberAlston Nov 19, 2024
70c12a5
Update testing-how-to.md
AmberAlston Nov 19, 2024
06c2294
Update testing-supported-clusters.md
AmberAlston Nov 19, 2024
3fc3f1e
docs edits
paigecalvert Nov 20, 2024
f9b3bc8
Update testing-how-to.md
paigecalvert Nov 20, 2024
c71ebf1
Update testing-supported-clusters.md
paigecalvert Nov 20, 2024
d54ca90
Update replicated-cli-cluster-prepare.md
paigecalvert Nov 20, 2024
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
4 changes: 4 additions & 0 deletions docs/reference/replicated-cli-cluster-prepare.md
View file
Open in desktop
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
7 changes: 5 additions & 2 deletions docs/vendor/testing-how-to.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,12 @@ 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.
* `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"
Copy link
Member

Choose a reason for hiding this comment

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

Isn't this going to result in people actually trying --version latest for EC? Which will not work, as it should be a channel sequence number.

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

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
View file
Open in desktop
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><b>A valid customer license is required to create an Embedded Cluster.</b></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 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>
Copy link
Member

Choose a reason for hiding this comment

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

Should we clarify it needs to be the slug, and not the sequence number for kURL?

</tr>
<tr>
<th>Supported Instance Types</th>
Expand Down