From 7ff24f95e6168c681f869f99d5b11849cd4b34ed Mon Sep 17 00:00:00 2001 From: Marc Campbell Date: Thu, 3 Aug 2023 10:19:00 -0600 Subject: [PATCH 1/2] Document replicated instance types for VMs --- .../replicated-cli-cluster-create.md | 15 +------ .../testing-replicated-instance-types.md | 37 ++++++++++++++++ docs/vendor/testing-supported-clusters.md | 44 +++++++++++++++++++ sidebars.js | 1 + 4 files changed, 83 insertions(+), 14 deletions(-) create mode 100644 docs/vendor/testing-replicated-instance-types.md diff --git a/docs/reference/replicated-cli-cluster-create.md b/docs/reference/replicated-cli-cluster-create.md index 8bd9d61da5..c35eba8c21 100644 --- a/docs/reference/replicated-cli-cluster-create.md +++ b/docs/reference/replicated-cli-cluster-create.md @@ -35,12 +35,7 @@ replicated cluster create [flags] --instance-type string - The type of instance to use for cloud-based clusters, such as x5.xlarge. - - - --memory - integer - The amount of memory (GiB) to request per node. Required for VM clusters. Default: 4 + The type of instance to use for nodes in the cluster, such as x5.xlarge. --name @@ -62,11 +57,6 @@ replicated cluster create [flags] string The cluster Time to Live (TTL) duration, in hours, before the cluster is automatically deleted by the service. TTL starts when the cluster is in a Ready state. Valid values: 1 - 48. Default: 1 - - --vcpu - integer - The number of vCPUs to request per node. Required for VM clusters. Default: 4 - --version string @@ -87,6 +77,3 @@ For an EKS distribution: replicated cluster create --name eks-example --distribution eks --version 1.27 --node-count 3 --instance-type m5.xlarge ``` -:::note -For VM distributions, you must specify `--vpcu` and `--memory` instead of `--instance-type`. -::: diff --git a/docs/vendor/testing-replicated-instance-types.md b/docs/vendor/testing-replicated-instance-types.md new file mode 100644 index 0000000000..fe830a0863 --- /dev/null +++ b/docs/vendor/testing-replicated-instance-types.md @@ -0,0 +1,37 @@ +# Replicated Instance Types + +When creating a VM-based cluster, you must specify a Replicated instance type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TypeMemory (GiB)VCPU Count
r1.small8 GB2 VCPUs
r1.medium16 GB4 VCPUs
r1.large32 GB8 VCPUs
r1.xlarge64 GB16 VCPUs
r1.2xlarge128 GB32 VCPUs
diff --git a/docs/vendor/testing-supported-clusters.md b/docs/vendor/testing-supported-clusters.md index 4fbda4a0f7..3762f7517b 100644 --- a/docs/vendor/testing-supported-clusters.md +++ b/docs/vendor/testing-supported-clusters.md @@ -27,6 +27,11 @@ The compatibility matrix supports creating single-node [kind](https://kind.sigs. Limitations See Limitations + + Node and Supported Instance Types + + Common Use Cases Smoke tests @@ -50,6 +55,11 @@ The compatibility matrix supports creating single-node [k3s](https://k3s.io) clu Supported Kubernetes Versions 1.24, 1.25, 1.26 + + Node and Supported Instance Types + + Limitations You can only choose a minor version, not a patch version. The K3s installer chooses the latest patch for that minor version. See k3s.



For additional limitations, see Limitations. @@ -77,6 +87,40 @@ The compatibility matrix supports creating single-node [Red Hat OpenShift OKD](h Limitations See Limitations + + Node and Supported Instance Types + + + + Common Use Cases + Customer release tests + + + + +### Helm VM + +The compatibility matrix supports creating single-node [HelmVM](https://github.com/replicatedhq/helmbin) clusters, which is a version of Kubernetes that has a Helm chart embedded and runs as a single binary. + + + + + + + + + + + + + + + + + + diff --git a/sidebars.js b/sidebars.js index 7cbdb03452..e534234e48 100644 --- a/sidebars.js +++ b/sidebars.js @@ -582,6 +582,7 @@ const sidebars = { items: [ 'vendor/testing-about', 'vendor/testing-supported-clusters', + 'vendor/testing-replicated-instance-types', 'vendor/testing-how-to', ], }, From b841ca28004896116c4a6b98d3fb3be348df3893 Mon Sep 17 00:00:00 2001 From: Jonquil Williams <91626429+jonquil2002@users.noreply.github.com> Date: Thu, 3 Aug 2023 12:37:06 -0400 Subject: [PATCH 2/2] Added xref to the CLI table. --- docs/reference/replicated-cli-cluster-create.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/replicated-cli-cluster-create.md b/docs/reference/replicated-cli-cluster-create.md index c35eba8c21..c549cae579 100644 --- a/docs/reference/replicated-cli-cluster-create.md +++ b/docs/reference/replicated-cli-cluster-create.md @@ -35,7 +35,7 @@ replicated cluster create [flags] - +
TypeDescription
Supported HelmVM Version1.27
LimitationsSee Limitations
Node and Supported Instance Types
  • Specify a Replicated instance type for the nodes. +
Common Use Cases Customer release tests
--instance-type stringThe type of instance to use for nodes in the cluster, such as x5.xlarge.The type of instance to use for nodes in the cluster, such as x5.xlarge. For VM-based clusters, see Replicated Instance Types.
--name