diff --git a/docs/partials/cmx/_overview.mdx b/docs/partials/cmx/_overview.mdx deleted file mode 100644 index 8a0d4fd1b7..0000000000 --- a/docs/partials/cmx/_overview.mdx +++ /dev/null @@ -1,8 +0,0 @@ -Replicated Compatibility Matrix quickly provisions ephemeral clusters of different Kubernetes distributions and versions, such as OpenShift, EKS, and Replicated kURL. - -You can use Compatibility Matrix to get kubectl access to running clusters within minutes or less. This allows you to more easily test your code in a range of different environments before releasing to customers. - -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 to develop on and quickly test changes -* Reproduce a reported issue on a customer-representative environment for troubleshooting diff --git a/docs/partials/cmx/_supported-clusters-overview.mdx b/docs/partials/cmx/_supported-clusters-overview.mdx deleted file mode 100644 index 108bf7cfce..0000000000 --- a/docs/partials/cmx/_supported-clusters-overview.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Compatibility Matrix can create clusters on virtual machines (VMs), such as kind, k3s, RKE2, and Red Hat OpenShift OKD, and also create cloud-managed clusters, such as EKS, GKE and AKS: - -* 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. - -* VMs run on Replicated bare metal servers located in several data centers, including data centers physically in the European Union. - -To view an up-to-date list of the available cluster distributions, including the supported Kubernetes versions, instance types, and maximum nodes for each distribution, run [`replicated cluster versions`](/reference/replicated-cli-cluster-versions). - -For detailed information about the available cluster distributions, see [Supported Compatibility Matrix Cluster Types](testing-supported-clusters). diff --git a/docs/vendor/testing-about.md b/docs/vendor/testing-about.md index b346902563..0af1c03665 100644 --- a/docs/vendor/testing-about.md +++ b/docs/vendor/testing-about.md @@ -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 - - -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 - - - -### 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 -* `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). \ No newline at end of file diff --git a/docs/vendor/testing-how-to.md b/docs/vendor/testing-how-to.md index b6d4ac2f18..936ae8c2c0 100644 --- a/docs/vendor/testing-how-to.md +++ b/docs/vendor/testing-how-to.md @@ -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 + +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: diff --git a/docs/vendor/testing-pricing.mdx b/docs/vendor/testing-pricing.mdx index babb039c30..dc873f79d2 100644 --- a/docs/vendor/testing-pricing.mdx +++ b/docs/vendor/testing-pricing.mdx @@ -2,21 +2,50 @@ This topic describes the pricing for Replicated Compatibility Matrix. -## Pricing Overview +## Usage-Based Pricing -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. diff --git a/static/images/compatibility-matrix-settings.png b/static/images/compatibility-matrix-settings.png index 6d41d215d4..46fb3f3a16 100644 Binary files a/static/images/compatibility-matrix-settings.png and b/static/images/compatibility-matrix-settings.png differ