Skip to content

Commit 1ad3a85

Browse files
committed
edits
1 parent a32257b commit 1ad3a85

File tree

3 files changed

+229
-158
lines changed

3 files changed

+229
-158
lines changed

docs/vendor/testing-how-to.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@ import Prerequisites from "../partials/cmx/_prerequisites.mdx"
22

33
# Create Clusters
44

5-
This topic describes how to use Replicated Compatibility Matrix to create and manage ephemeral clusters to test your applications across different Kubernetes distributions and versions
5+
This topic describes how to use Replicated Compatibility Matrix to create and manage ephemeral clusters to test your applications across different Kubernetes distributions and versions.
66

7+
This topic includes information about creating and managing clusters with Compatibility Matrix using the Replicated Vendor Portal or the Replicated CLI. For information about creating and managing clusters with the Vendor API v3, see the [clusters](https://replicated-vendor-api.readme.io/reference/listclusterusage) section in the Vendor API v3 documentation.
78

89
## About Compatibility Matrix Clusters
910

1011
Compatibility Matrix supports both VM-based clusters (such as kind, k3s, RKE2, OpenShift, and Embedded Cluster) and cloud-managed clusters (such as EKS, GKE, and AKS). VM-based clusters run on Replicated bare metal servers, while cloud clusters are provisioned in Replicated-managed cloud accounts for faster delivery.
1112

12-
**When to use Clusters vs VMs:**
13-
* **Use Clusters** for testing Kubernetes-based deployments and Helm installations.
14-
* **Use VMs** for testing Embedded Cluster installers, air-gap installations, or when you need full OS control. See [Create VMs](/vendor/testing-vm-create).
13+
You can use Compatibility Matrix clusters for testing and troubleshooting Kubernetes-based deployments and Helm installations for your application.
1514

15+
For information about creating VMs with Compatibility Matrix to test Replicated Embedded Cluster installers, air-gap installations, or when you need full OS control, see [Create VMs](/vendor/testing-vm-create).
1616

1717
## Prerequisites
1818

@@ -22,17 +22,11 @@ Before you can use Compatibility Matrix clusters, you must complete the followin
2222

2323
* Existing accounts must accept the TOS for the trial on the [**Compatibility Matrix**](https://vendor.replicated.com/compatibility-matrix) page in the Replicated Vendor Portal.
2424

25-
## Create and Manage Clusters
26-
27-
This section explains how to use Compatibility Matrix to create and manage clusters with the Replicated CLI or the Vendor Portal.
28-
29-
For information about creating and managing clusters with the Vendor API v3, see the [clusters](https://replicated-vendor-api.readme.io/reference/listclusterusage) section in the Vendor API v3 documentation.
30-
31-
### Create Clusters
25+
## Create Clusters
3226

3327
You can create clusters with Compatibility Matrix using the Replicated CLI or the Vendor Portal.
3428

35-
#### Replicated CLI
29+
### With the Replicated CLI
3630

3731
To create a cluster using the Replicated CLI:
3832

@@ -84,7 +78,7 @@ To create a cluster using the Replicated CLI:
8478

8579
In the output of the command, you can see that the `STATUS` of the cluster is `assigned`. When the kubeconfig for the cluster is accessible, the cluster's status is changed to `running`. For more information about cluster statuses, see [Cluster Status](testing-about#cluster-status) in _About Compatibility Matrix._
8680

87-
#### Vendor Portal
81+
### Vendor Portal
8882

8983
To create a cluster using the Vendor Portal:
9084

@@ -154,7 +148,7 @@ To create a cluster using the Vendor Portal:
154148

155149
[View a larger version of this image](/images/cmx-assigned-cluster.png)
156150

157-
### Prepare Clusters
151+
## Prepare Clusters
158152

159153
For applications distributed with the Replicated Vendor Portal, the [`cluster prepare`](/reference/replicated-cli-cluster-prepare) command reduces the number of steps required to provision a cluster and then deploy a release to the cluster for testing. This is useful in continuous integration (CI) workflows that run multiple times a day. For an example workflow that uses the `cluster prepare` command, see [Recommended CI/CD Workflows](/vendor/ci-workflows).
160154

@@ -213,7 +207,7 @@ The `cluster prepare` command requires either a Helm chart archive or a director
213207

214208
For command usage, including additional options, see [cluster prepare](/reference/replicated-cli-cluster-prepare).
215209

216-
### Access Clusters
210+
## Access Clusters
217211

218212
Compatibility Matrix provides the kubeconfig for clusters so that you can access clusters with the kubectl command line tool. For more information, see [Command line tool (kubectl)](https://kubernetes.io/docs/reference/kubectl/) in the Kubernetes documentation.
219213

@@ -243,7 +237,7 @@ To access a cluster from the command line:
243237

244238
1. Press Ctrl-D or type `exit` when done to end the shell and the connection to the server.
245239

246-
### Upgrade Clusters (kURL Only)
240+
## Upgrade Clusters (kURL Only)
247241

248242
For kURL clusters provisioned with Compatibility Matrix, you can use the the `cluster upgrade` command to upgrade the version of the kURL installer specification used to provision the cluster. A recommended use case for the `cluster upgrade` command is for testing your application's compatibility with Kubernetes API resource version migrations after upgrade.
249243
@@ -255,11 +249,11 @@ replicated cluster upgrade cabb74d5 --version 9d5a44c
255249
256250
For command usage, see [cluster upgrade](/reference/replicated-cli-cluster-upgrade).
257251
258-
### Delete Clusters
252+
## Delete Clusters
259253
260254
You can delete clusters using the Replicated CLI or the Vendor Portal.
261255
262-
#### Replicated CLI
256+
### Replicated CLI
263257
264258
To delete a cluster using the Replicated CLI:
265259
@@ -292,7 +286,8 @@ To delete a cluster using the Replicated CLI:
292286
```
293287
Where `CLUSTER_ID` is the ID of the target cluster.
294288
In the output of the command, you can see that the `STATUS` of the cluster is `terminated`. For command usage, see [cluster ls](/reference/replicated-cli-cluster-ls).
295-
#### Vendor Portal
289+
290+
### Vendor Portal
296291
297292
To delete a cluster using the Vendor Portal:
298293

0 commit comments

Comments
 (0)