Skip to content

Make instance type info more discoverable #3445

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 2 commits into from
Aug 15, 2025
Merged

Make instance type info more discoverable #3445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe56fff
Make instance type info more discoverable
paigecalvert Aug 13, 2025
ae74b03
Merge branch 'main' into cmx-vms-repl-instances
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
32 changes: 32 additions & 0 deletions docs/partials/cmx/_instance-types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<table>
<tr>
<th width="30%">Type</th>
<th width="35%">Memory (GiB)</th>
<th width="35%">VCPU Count</th>
</tr>
<tr>
<th>r1.small</th>
<td>8 GB</td>
<td>2 VCPUs</td>
</tr>
<tr>
<th>r1.medium</th>
<td>16 GB</td>
<td>4 VCPUs</td>
</tr>
<tr>
<th>r1.large</th>
<td>32 GB</td>
<td>8 VCPUs</td>
</tr>
<tr>
<th>r1.xlarge</th>
<td>64 GB</td>
<td>16 VCPUs</td>
</tr>
<tr>
<th>r1.2xlarge</th>
<td>128 GB</td>
<td>32 VCPUs</td>
</tr>
</table>
2 changes: 1 addition & 1 deletion docs/vendor/testing-ingress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Access Your Application
# Cluster Networking

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 this page title to better match the "VM Networking" pattern. Before, it wasn't clear that it was specific to clusters

This topic describes the networking options for accessing applications deployed on clusters created with Replicated Compatibility Matrix. It also describes how to use and manage Compatibility Matrix tunnels.

Expand Down
34 changes: 2 additions & 32 deletions docs/vendor/testing-supported-clusters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import Pool from "../partials/cmx/_openshift-pool.mdx"
import InstanceTypes from "../partials/cmx/_instance-types.mdx"

# Supported Compatibility Matrix Cluster Types

Expand Down Expand Up @@ -480,38 +481,7 @@ Compatibility Matrix supports creating [Oracle Container Engine for Kubernetes (

When creating a VM-based cluster with Compatibility Matrix, you must specify a Replicated instance type.

<table>
<tr>
<th width="30%">Type</th>
<th width="35%">Memory (GiB)</th>
<th width="35%">VCPU Count</th>
</tr>
<tr>
<th>r1.small</th>
<td>8 GB</td>
<td>2 VCPUs</td>
</tr>
<tr>
<th>r1.medium</th>
<td>16 GB</td>
<td>4 VCPUs</td>
</tr>
<tr>
<th>r1.large</th>
<td>32 GB</td>
<td>8 VCPUs</td>
</tr>
<tr>
<th>r1.xlarge</th>
<td>64 GB</td>
<td>16 VCPUs</td>
</tr>
<tr>
<th>r1.2xlarge</th>
<td>128 GB</td>
<td>32 VCPUs</td>
</tr>
</table>
<InstanceTypes/>

## Kubernetes Version Support Policy

Expand Down
11 changes: 9 additions & 2 deletions docs/vendor/testing-vm-create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import Prerequisites from "../partials/cmx/_prerequisites.mdx"
import InstanceTypes from "../partials/cmx/_instance-types.mdx"

# Create VMs (Beta)

Expand All @@ -18,8 +19,14 @@ The following VM types are supported:

| Distribution | Versions | Instance Types |
| :---- | :---- | :---- |
| ubuntu | 24.04, 22.04 | r1.small, r1.medium, r1.large, r1.xlarge, r1.2xlarge |
| almalinux | 8, 9, 10 | r1.small, r1.medium, r1.large, r1.xlarge, r1.2xlarge |
| ubuntu | 24.04, 22.04 | r1.small, r1.medium, r1.large, r1.xlarge, r1.2xlarge. See [Replicated Instance Types](#replicated-instance-types).|
| almalinux | 8, 9, 10 | r1.small, r1.medium, r1.large, r1.xlarge, r1.2xlarge. See [Replicated Instance Types](#replicated-instance-types). |

## Replicated Instance Types

The following describes the Replicated instance types for VMs:

<InstanceTypes/>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

^ I had a hard time finding this instance types info when I was creating a VM the other day. Previously, it was just in the "Supported Cluster Types" topic. Added to a partial so it can appear here as well

Copy link
Contributor

Choose a reason for hiding this comment

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

Much better!


## Limitations

Expand Down
7 changes: 4 additions & 3 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,20 +229,21 @@ const sidebars = {
items: [
'vendor/testing-about',
'vendor/testing-pricing',
'vendor/testing-supported-clusters',
{
type: 'category',
label: 'Use Compatibility Matrix',
items: [
'vendor/testing-how-to',
'vendor/testing-supported-clusters',
'vendor/testing-ingress',
'vendor/testing-cluster-addons',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

^ moves the rest of the clusters stuff under "Use CMX" alongside corresponding VMs topics

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice! I like this organization.
2025-08-15 - 17 04@2x

How about making these titles more consistent and shorter? Since they are already under a group with the words "Compatibility Matrix"

  • Create Clusters
  • Cluster Types
  • Cluster Networking
  • Cluster Add-ons (Alpha)
  • Create VMs (Beta)
  • VM Networking (Beta)
  • Use Compatibility Matrix with CI/CD

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a great idea--some of those older ones are definitely on the long side... I'll do a separate story for that since I'll also need to update all the cross-references to these pages after changing the titles

'vendor/testing-vm-create',
'vendor/testing-vm-networking',
'vendor/testing-ci-cd',
],
},
'vendor/testing-cluster-addons',

'vendor/compatibility-matrix-usage',
'vendor/testing-ingress',
],
},
{
Expand Down
Loading