Skip to content

Update CMX overview and pricing info to include VMs #3446

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

Merged
merged 6 commits into from
Aug 15, 2025
Merged

Update CMX overview and pricing info to include VMs #3446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
94bc1c3
Update CMX overview and pricing info to include VMs
paigecalvert Aug 13, 2025
0932622
edits
paigecalvert Aug 13, 2025
6b04599
add a screenshot
paigecalvert Aug 13, 2025
d63c890
rm partial and screenshot
paigecalvert Aug 13, 2025
1c33dd9
edit link
paigecalvert Aug 13, 2025
3d0a075
Update docs/vendor/testing-about.md
paigecalvert Aug 15, 2025
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
8 changes: 0 additions & 8 deletions docs/partials/cmx/_overview.mdx
View file
Open in desktop

This file was deleted.

9 changes: 0 additions & 9 deletions docs/partials/cmx/_supported-clusters-overview.mdx
View file
Open in desktop

This file was deleted.

89 changes: 19 additions & 70 deletions docs/vendor/testing-about.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,89 +1,38 @@
import Overview from "../partials/cmx/_overview.mdx"
import SupportedClusters from "../partials/cmx/_supported-clusters-overview.mdx"

# About Compatibility Matrix

This topic describes Replicated Compatibility Matrix, including use cases, billing, limitations, and more.

## Overview

<Overview/>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note: I removed or relocated a lot of existing content from the overview topic.

Much of it either fit better in the Pricing topic, or was specific to clusters.

You can use Compatibility Matrix with the Replicated CLI or the Replicated Vendor Portal. For more information about how to use Compatibility Matrix, see [Use Compatibility Matrix](testing-how-to).

### Supported Clusters

<SupportedClusters/>

### Billing and Credits

Clusters created with Compatibility Matrix are billed by the minute. Per-minute billing begins when the cluster reaches a `running` status and ends when the cluster is deleted. Compatibility Matrix marks a cluster as `running` when a working kubeconfig for the cluster is accessible.

You are billed only for the time that the cluster is in a `running` status. You are _not_ billed for the time that it takes Compatibility Matrix to create and tear down clusters, including when the cluster is in an `assigned` status.

For more information about pricing, see [Compatibility Matrix Pricing](testing-pricing).

To create clusters with Compatibility Matrix, you must have credits in your Vendor Portal account.
If you have a contract, you can purchase credits by logging in to the Vendor Portal and going to [**Compatibility Matrix > Buy additional credits**](https://vendor.replicated.com/compatibility-matrix).
Otherwise, to request credits, log in to the Vendor Portal and go to [**Compatibility Matrix > Request more credits**](https://vendor.replicated.com/compatibility-matrix).

### Quotas and Capacity

By default, Compatibility Matrix sets quotas for the capacity that can be used concurrently by each vendor portal team. These quotas are designed to ensure that Replicated maintains a minimum amount of capacity for provisioning both VM and cloud-based clusters.

By default, the quota for cloud-based cluster distributions (AKS, GKE, EKS) is three clusters running concurrently.

VM-based cluster distributions (such as kind, OpenShift, and Replicated Embedded Cluster) have the following default quotas:
* 32 vCPUs
* 128 GiB memory
* 800 GiB disk size

You can request increased quotas at any time with no additional cost. To view your team's current quota and capacity usage, or to request a quota increase, go to [**Compatibility Matrix > Settings**](https://vendor.replicated.com/compatibility-matrix/settings) in the vendor portal:

![Compatibility matrix settings page](/images/compatibility-matrix-settings.png)
You can use Replicated Compatibility Matrix to quickly provision ephemeral clusters and VMs. Compatibility Matrix's networking features also provide kubectl or SSH access to clusters and VMs. This allows you to install and test your application in a range of different development environments before releasing to customers.

[View a larger version of this image](/images/compatibility-matrix-settings.png)
Example use cases for Compatibility Matrix include:
* Run tests before releasing a new version of your application to validate compatibility with supported Kubernetes distributions
* Get access to a cluster or VM to develop on and quickly test changes
* Reproduce a reported issue on a customer-representative environment for troubleshooting

### Cluster Status
You can use Compatibility Matrix with the Replicated CLI or the Replicated Vendor Portal. For more information about how to use Compatibility Matrix, see [Create Clusters](testing-how-to) and [Create VMs](testing-vm-create).

Clusters created with Compatibility Matrix can have the following statuses:
## Supported Clusters and VMs
Copy link
Contributor Author

Choose a reason for hiding this comment

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

^ updated with info about VMs


* `assigned`: The cluster resources were requested and Compatibility Matrix is provisioning the cluster. You are not billed for the time that a cluster spends in the `assigned` status.
Compatibility Matrix can create VMs, VM-based clusters (such as kind, k3s, RKE2, and Red Hat OpenShift OKD), and cloud-managed clusters (such as EKS, GKE and AKS):

* `running`: A working kubeconfig for the cluster is accessible. Billing begins when the cluster reaches a `running` status.
* Cloud-based Kubernetes distributions are run in a Replicated managed and controlled cloud account to optimize and deliver a clusters quickly and reliably. The Replicated account has control planes ready and adds a node group when you request it, making the cluster available much faster than if you try to create your own cluster with your own cloud account.

Additionally, clusters are verified prior to transitioning to a `running` status. Verification includes checking that the cluster is healthy and running with the correct number of nodes, as well as passing [sonobuoy](https://sonobuoy.io/) tests in `--quick` mode.
* VMs and VM-based clusters run on Replicated bare metal servers located in several data centers, including data centers physically in the European Union.

* `terminated`: The cluster is deleted. Billing ends when the cluster status is changed from `running` to `terminated`.
You can run [`replicated cluster versions`](/reference/replicated-cli-cluster-versions) or [`replicated vm versions`](/reference/replicated-cli-vm-versions) for an up-to-date list of the available cluster distributions or VM types.

* `error`: An error occured when attempting to provision the cluster.
For more information about the supported cluster distributions, see [Supported Compatibility Matrix Cluster Types](testing-supported-clusters).

You can view the status of clusters using the `replicated cluster ls` command. For more information, see [cluster ls](/reference/replicated-cli-cluster-ls).
For more information about supported VMs, see [Supported VM Types](/vendor/testing-vm-create#supported-vm-types.)

### Cluster Add-ons
## Billing and Credits

The Replicated Compatibility Matrix enables you to extend your cluster with add-ons, to make use of by your application, such as an AWS S3 object store.
This allows you to more easily provision dependencies required by your application.
Clusters and VMs created with Compatibility Matrix are billed by the minute, plus a startup charge. Per-minute billing begins when a `running` status is reached and ends when the cluster or VM is deleted.

For more information about how to use the add-ons, see [Compatibility Matrix Cluster Add-ons](testing-cluster-addons).

## Limitations

Compatibility Matrix has the following limitations:

- Clusters cannot be resized. Create another cluster if you want to make changes, such as add another node.
- Clusters cannot be rebooted. Create another cluster if you need to reset/reboot the cluster.
- On cloud clusters, node groups are not available for every distribution. For distribution-specific details, see [Supported Compatibility Matrix Cluster Types](/vendor/testing-supported-clusters).
- Multi-node support is not available for every distribution. For distribution-specific details, see [Supported Compatibility Matrix Cluster Types](/vendor/testing-supported-clusters).
- ARM instance types are only supported on Cloud Clusters. For distribution-specific details, see [Supported Compatibility Matrix Cluster Types](/vendor/testing-supported-clusters).
- GPU instance types are only supported on Cloud Clusters. For distribution-specific details, see [Supported Compatibility Matrix Cluster Types](/vendor/testing-supported-clusters).
- There is no support for IPv6 as a single stack. Dual stack support is available on kind clusters.
- There is no support for air gap testing.
- The `cluster upgrade` feature is available only for kURL distributions. See [cluster upgrade](/reference/replicated-cli-cluster-upgrade).
- Cloud clusters do not allow for the configuration of CNI, CSI, CRI, Ingress, or other plugins, add-ons, services, and interfaces.
- The node operating systems for clusters created with Compatibility Matrix cannot be configured nor replaced with different operating systems.
- The Kubernetes scheduler for clusters created with Compatibility Matrix cannot be replaced with a different scheduler.
- Each team has a quota limit on the amount of resources that can be used simultaneously. This limit can be raised by messaging your account representative.
- Team actions with Compatibility Matrix (for example, creating and deleting clusters and requesting quota increases) are not logged and displayed in the [Vendor Team Audit Log](https://vendor.replicated.com/team/audit-log).
For more information about pricing, see [Compatibility Matrix Pricing](testing-pricing).

For additional distribution-specific limitations, see [Supported Compatibility Matrix Cluster Types](testing-supported-clusters).
To create clusters with Compatibility Matrix, you must have credits in your Vendor Portal account.
If you have a contract, you can purchase credits by logging in to the Vendor Portal and going to [**Compatibility Matrix > Buy additional credits**](https://vendor.replicated.com/compatibility-matrix).
Otherwise, to request credits, log in to the Vendor Portal and go to [**Compatibility Matrix > Request more credits**](https://vendor.replicated.com/compatibility-matrix).
21 changes: 21 additions & 0 deletions docs/vendor/testing-how-to.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,27 @@ You can use Compatibility Matrix clusters for testing and troubleshooting Kubern

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

## Limitations
Copy link
Contributor Author

@paigecalvert paigecalvert Aug 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

^ moved these Limitations from the main overview page over to the Create Clusters page since they were specific to Limitations

Note: I am not sure if all of these are still relevant. It's likely been awhile since they were reviewed/updated

Copy link
Contributor

Choose a reason for hiding this comment

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

Good point. I made note that we'll need a separate review of Limitations. But that certainly doesn't need to block the reorganization you're doing here!


Compatibility Matrix has the following limitations:

- Clusters cannot be resized. Create another cluster if you want to make changes, such as add another node.
- Clusters cannot be rebooted. Create another cluster if you need to reset/reboot the cluster.
- On cloud clusters, node groups are not available for every distribution. For distribution-specific details, see [Supported Compatibility Matrix Cluster Types](/vendor/testing-supported-clusters).
- Multi-node support is not available for every distribution. For distribution-specific details, see [Supported Compatibility Matrix Cluster Types](/vendor/testing-supported-clusters).
- ARM instance types are only supported on Cloud Clusters. For distribution-specific details, see [Supported Compatibility Matrix Cluster Types](/vendor/testing-supported-clusters).
- GPU instance types are only supported on Cloud Clusters. For distribution-specific details, see [Supported Compatibility Matrix Cluster Types](/vendor/testing-supported-clusters).
- There is no support for IPv6 as a single stack. Dual stack support is available on kind clusters.
- There is no support for air gap testing.
- The `cluster upgrade` feature is available only for kURL distributions. See [cluster upgrade](/reference/replicated-cli-cluster-upgrade).
- Cloud clusters do not allow for the configuration of CNI, CSI, CRI, Ingress, or other plugins, add-ons, services, and interfaces.
- The node operating systems for clusters created with Compatibility Matrix cannot be configured nor replaced with different operating systems.
- The Kubernetes scheduler for clusters created with Compatibility Matrix cannot be replaced with a different scheduler.
- Each team has a quota limit on the amount of resources that can be used simultaneously. This limit can be raised by messaging your account representative.
- Team actions with Compatibility Matrix (for example, creating and deleting clusters and requesting quota increases) are not logged and displayed in the [Vendor Team Audit Log](https://vendor.replicated.com/team/audit-log).

For additional distribution-specific limitations, see [Supported Compatibility Matrix Cluster Types](testing-supported-clusters).

## Prerequisites

Before you can use Compatibility Matrix clusters, you must complete the following prerequisites:
Expand Down
43 changes: 36 additions & 7 deletions docs/vendor/testing-pricing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,50 @@

This topic describes the pricing for Replicated Compatibility Matrix.

## Pricing Overview
## Usage-Based Pricing
Copy link
Contributor Author

@paigecalvert paigecalvert Aug 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Updated the pricing info to include info about VMs

Also made some formatting edits to make it easier to read (like adding a bulleted list of the costs)

Copy link
Contributor

Choose a reason for hiding this comment

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

Very nice!


Compatibility Matrix usage-based pricing includes a $0.50 per cluster startup cost, plus by the minute pricing based on instance size and count (starting at the time the cluster state changed to "running" and ending when the cluster is either expired (TTL) or removed). Minutes will be rounded up, so there will be a minimum charge of $0.50 plus 1 minute for all running clusters. Each cluster's cost will be rounded up to the nearest cent and subtracted from the available credits in the team account.
There is a minimum cost of $0.50 plus one minute for each running cluster or VM created with Compatibility Matrix. Cost is rounded up to the nearest cent and subtracted from the available credits in the team account.

Remaining credit balance is viewable on the Replicated Vendor Portal [Cluster History](https://vendor.replicated.com/compatibility-matrix/history) page or with the Vendor API v3 [/vendor/v3/cluster/stats](https://replicated-vendor-api.readme.io/reference/getclusterstats) endpoint. Cluster [add-ons](/vendor/testing-cluster-addons) may incur additional charges.
The following provides more detail about the costs that are included in Compatibility Matrix usage-based pricing:

* A $0.50 per cluster or VM startup cost.

* By-the-minute pricing based on instance size and count, starting at the time the cluster or VM status is `running` and ending when the cluster or VM is either expired (TTL) or removed. Minutes are rounded up.

:::note
You are billed _only_ for the time that the cluster status is `running`. You are _not_ billed for the time that it takes Compatibility Matrix to create, verify, and tear down clusters and VMs. You can view the status of clusters and VMs using the [`replicated cluster ls`](/reference/replicated-cli-cluster-ls) and [`replicated vm ls`](/reference/replicated-cli-vm-ls) commands.

For VMs, a `running` status indicates an SSH endpoint is available. For clusters, a `running` status indicates a working kubeconfig for the cluster is accessible. Additionally, clusters are verified prior to transitioning to a `running` status. Verification includes checking that the cluster is healthy and running with the correct number of nodes, as well as passing sonobuoy tests in `--quick` mode.
:::

* Additional charges when applicable for cluster [add-ons](/vendor/testing-cluster-addons).

## Credit Balance

You can view remaining credit balance on the Replicated Vendor Portal [Cluster History](https://vendor.replicated.com/compatibility-matrix/history) page or with the Vendor API v3 [/vendor/v3/cluster/stats](https://replicated-vendor-api.readme.io/reference/getclusterstats) endpoint.

If the team's available credits are insufficient to run the cluster for the full duration of the TTL, the cluster creation will be rejected.

Team members assigned the Admin role will receive a warning to their email address when the remaining credit balance falls below the amount of credits that were consumed by your team in the previous seven days.
Team members assigned the Admin role receive a warning to their email address when the remaining credit balance falls below the amount of credits that were consumed by your team in the previous seven days.

## Quotas and Capacity

By default, Compatibility Matrix sets quotas for the capacity that can be used concurrently by each Vendor Portal team. These quotas are designed to ensure that Replicated maintains a minimum amount of capacity for provisioning VMs and clusters.

By default, the quota for cloud-based cluster distributions (AKS, GKE, EKS) is three clusters running concurrently.

VMs and VM-based cluster distributions (such as kind, OpenShift, and Replicated Embedded Cluster) have the following default quotas:
* 32 vCPUs
* 128 GiB memory
* 800 GiB disk size

You can request increased quotas at any time with no additional cost. To view your team's current quota and capacity usage, or to request a quota increase, go to [**Compatibility Matrix > Settings**](https://vendor.replicated.com/compatibility-matrix/settings) in the Vendor Portal:

## Cluster Quotas
![Compatibility matrix settings page](/images/compatibility-matrix-settings.png)

Each team is limited by the number of clusters that they can run concurrently. To increase the quota, reach out to your account manager.
[View a larger version of this image](/images/compatibility-matrix-settings.png)

## VM Cluster Pricing (Openshift, RKE2, K3s, Kind, Embedded Cluster, kURL)
## VMs and VM-Based Cluster Pricing (Openshift, RKE2, K3s, Kind, Embedded Cluster, kURL)

VM-based clusters approximately match the AWS m6.i instance type pricing.

Expand Down
Binary file modified static/images/compatibility-matrix-settings.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.