From d599c9d9ad3f92c23e50ee5844d3c55c3741dee8 Mon Sep 17 00:00:00 2001 From: Dominic Sloan-Murphy Date: Mon, 17 Mar 2025 15:45:41 +0000 Subject: [PATCH 1/8] docs: add VM instance compatibility matrix --- .custom_wordlist.txt | 8 ++++ index.md | 1 + reference/compatibility-matrix.md | 74 +++++++++++++++++++++++++++++++ reference/index.md | 2 + 4 files changed, 85 insertions(+) create mode 100644 reference/compatibility-matrix.md diff --git a/.custom_wordlist.txt b/.custom_wordlist.txt index 5a5ec45..386cb39 100644 --- a/.custom_wordlist.txt +++ b/.custom_wordlist.txt @@ -62,6 +62,14 @@ maas microsoft OpenStack +# Cloud VM instance types +Dasv +Dv +HB +HBv +NCasT +NVadsA + # Developer jargon/acronyms conf CUDA diff --git a/index.md b/index.md index 22cdee3..6114946 100644 --- a/index.md +++ b/index.md @@ -43,6 +43,7 @@ __Discussion and clarification__ of key topics __Technical information__ - {ref}`reference-underlying-projects-and-dependencies` +- {ref}`reference-compatibility-matrix` - {ref}`gres` - {ref}`reference-interconnects` - {ref}`reference-performance` diff --git a/reference/compatibility-matrix.md b/reference/compatibility-matrix.md new file mode 100644 index 0000000..5504592 --- /dev/null +++ b/reference/compatibility-matrix.md @@ -0,0 +1,74 @@ +(reference-compatibility-matrix)= +# Compatibility Matrix + +The tables below provide an overview of cloud instance types that have been tested for compatibility with Charmed HPC revisions. Key: + +* ✔ Compatible: Fully compatible with all Charmed HPC features. No known issues. +* △ Partial: May be compatible with a subset of Charmed HPC features or have issues that can be worked around to allow for basic use. +* ✘ Incompatible: Has issues that prevent even basic use. + +## Microsoft Azure + +### Charm: `sackd` + +**Revision:** 13 + +:::{csv-table} +:header: > +: instance type, series, compatibility, notes +:widths: 9, 5, 6, 9 + +Standard_D2as_v6, [Dasv6](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/general-purpose/dasv6-series), ✔ Compatible, "" +::: + +### Charm: `slurmctld` + +**Revision:** 95 + +:::{csv-table} +:header: > +: instance type, series, compatibility, notes +:widths: 9, 5, 6, 9 + +Standard_D2as_v6, [Dasv6](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/general-purpose/dasv6-series), ✔ Compatible, "" +::: + +### Charm: `slurmd` + +**Revision:** 116 + +:::{csv-table} +:header: > +: instance type, series, compatibility, notes +:widths: 9, 5, 6, 9 + +Standard_HB120rs_v3, [HBv3](https://learn.microsoft.com/en-us/azure/virtual-machines/hbv3-series-overview), ✔ Compatible, "" +Standard_HB176rs_v4, [HBv4](https://learn.microsoft.com/en-us/azure/virtual-machines/hbv4-series-overview), ✔ Compatible, "" +Standard_NC24ads_A100_v4, [NC_A100_v4](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/gpu-accelerated/nca100v4-series), ✔ Compatible, "" +Standard_NC4as_T4_v3, [NCasT4_v3](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/gpu-accelerated/ncast4v3-series), ✔ Compatible, "" +Standard_NV6ads_A10_v5, [NVadsA10_v5](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/gpu-accelerated/nvadsa10v5-series), ✘ Incompatible, "GPU driver failures. See [#82](https://github.com/charmed-hpc/slurm-charms/issues/82)" +::: + +### Charm: `slurmdbd` + +**Revision:** 87 + +:::{csv-table} +:header: > +: instance type, series, compatibility, notes +:widths: 9, 5, 6, 9 + +Standard_D2as_v6, [Dasv6](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/general-purpose/dasv6-series), ✔ Compatible, "" +::: + +### Charm: `slurmrestd` + +**Revision:** 89 + +:::{csv-table} +:header: > +: instance type, series, compatibility, notes +:widths: 9, 5, 6, 9 + +Standard_D2as_v6, [Dasv6](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/general-purpose/dasv6-series), ✔ Compatible, "" +::: diff --git a/reference/index.md b/reference/index.md index eef093e..8975433 100644 --- a/reference/index.md +++ b/reference/index.md @@ -7,6 +7,7 @@ Charmed HPC operates. ## General information - {ref}`reference-underlying-projects-and-dependencies` +- {ref}`reference-compatibility-matrix` - {ref}`gres` - {ref}`reference-interconnects` - {ref}`reference-monitoring` @@ -19,6 +20,7 @@ Charmed HPC operates. :hidden: Underlying projects and dependencies +compatibility-matrix gres/index interconnects/index monitoring/index From 92e3e75bedd2e40483c0d196cd4ad1435339c5e1 Mon Sep 17 00:00:00 2001 From: dsloanm Date: Mon, 24 Mar 2025 10:59:09 +0000 Subject: [PATCH 2/8] docs: add advice on picking VM sizes --- reference/compatibility-matrix.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/reference/compatibility-matrix.md b/reference/compatibility-matrix.md index 5504592..f9bfc99 100644 --- a/reference/compatibility-matrix.md +++ b/reference/compatibility-matrix.md @@ -9,6 +9,8 @@ The tables below provide an overview of cloud instance types that have been test ## Microsoft Azure +To decide on suitable VMs, it may be useful to refer to [Sizes for virtual machines in Azure](https://learn.microsoft.com/en-us/azure/virtual-machines/sizes/overview). A typical Charmed HPC deployment will use a mix of high-performance and GPU-accelerated compute VMs for cluster compute nodes, and general purpose VMs for other node types. + ### Charm: `sackd` **Revision:** 13 From 0ce5a3bc55d88021f8aa764664f9baeea93e9c2e Mon Sep 17 00:00:00 2001 From: dsloanm Date: Mon, 7 Apr 2025 10:53:13 +0100 Subject: [PATCH 3/8] docs: improve VM compatibility justification Co-authored-by: Ashley Cliff --- reference/compatibility-matrix.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/reference/compatibility-matrix.md b/reference/compatibility-matrix.md index f9bfc99..088dca9 100644 --- a/reference/compatibility-matrix.md +++ b/reference/compatibility-matrix.md @@ -1,7 +1,9 @@ (reference-compatibility-matrix)= # Compatibility Matrix -The tables below provide an overview of cloud instance types that have been tested for compatibility with Charmed HPC revisions. Key: +The tables below provide an overview of cloud instance types that have been tested for compatibility with Charmed HPC revisions. Inclusion in a table indicates that the corresponding VM type has been tested; however, exclusion from the table simply indicates that the instance has not been tested thoroughly and may be compatible or incompatible with Charmed HPC. + +The compatibility key: * ✔ Compatible: Fully compatible with all Charmed HPC features. No known issues. * △ Partial: May be compatible with a subset of Charmed HPC features or have issues that can be worked around to allow for basic use. From fbfd6f7f10e5cfb0d73e03dd9a1e8c3acf269a44 Mon Sep 17 00:00:00 2001 From: dsloanm Date: Mon, 7 Apr 2025 10:54:22 +0100 Subject: [PATCH 4/8] docs: clarify meaning of `Partial` VM compatibility Co-authored-by: Ashley Cliff --- reference/compatibility-matrix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/compatibility-matrix.md b/reference/compatibility-matrix.md index 088dca9..13aebf0 100644 --- a/reference/compatibility-matrix.md +++ b/reference/compatibility-matrix.md @@ -6,7 +6,7 @@ The tables below provide an overview of cloud instance types that have been test The compatibility key: * ✔ Compatible: Fully compatible with all Charmed HPC features. No known issues. -* △ Partial: May be compatible with a subset of Charmed HPC features or have issues that can be worked around to allow for basic use. +* △ Partial: May be compatible with a subset of Charmed HPC features or may have issues that require work-arounds. * ✘ Incompatible: Has issues that prevent even basic use. ## Microsoft Azure From 46fe499cddc58fef60821a4047662a95fda265a0 Mon Sep 17 00:00:00 2001 From: dsloanm Date: Mon, 7 Apr 2025 10:54:53 +0100 Subject: [PATCH 5/8] docs: clarify meaning of `Incompatible` VM compatibility Co-authored-by: Ashley Cliff --- reference/compatibility-matrix.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/compatibility-matrix.md b/reference/compatibility-matrix.md index 13aebf0..9ae8a1e 100644 --- a/reference/compatibility-matrix.md +++ b/reference/compatibility-matrix.md @@ -7,7 +7,7 @@ The compatibility key: * ✔ Compatible: Fully compatible with all Charmed HPC features. No known issues. * △ Partial: May be compatible with a subset of Charmed HPC features or may have issues that require work-arounds. -* ✘ Incompatible: Has issues that prevent even basic use. +* ✘ Incompatible: Has issues that prevent all use-cases. ## Microsoft Azure From 172624f3117e12a3b125f68bafddc8609f64a5a5 Mon Sep 17 00:00:00 2001 From: Dominic Sloan-Murphy Date: Mon, 7 Apr 2025 11:23:06 +0100 Subject: [PATCH 6/8] docs: rename Compatibility Matrix to Virtual Machine Compatibility --- index.md | 3 ++- reference/index.md | 4 ++-- .../{compatibility-matrix.md => vm-compatibility.md} | 8 ++++---- 3 files changed, 8 insertions(+), 7 deletions(-) rename reference/{compatibility-matrix.md => vm-compatibility.md} (96%) diff --git a/index.md b/index.md index 6114946..72fb338 100644 --- a/index.md +++ b/index.md @@ -43,12 +43,13 @@ __Discussion and clarification__ of key topics __Technical information__ - {ref}`reference-underlying-projects-and-dependencies` -- {ref}`reference-compatibility-matrix` - {ref}`gres` - {ref}`reference-interconnects` - {ref}`reference-performance` - {ref}`reference-monitoring` +- {ref}`reference-vm-compatibility` + ``` ```` diff --git a/reference/index.md b/reference/index.md index 8975433..5e53ff0 100644 --- a/reference/index.md +++ b/reference/index.md @@ -7,11 +7,11 @@ Charmed HPC operates. ## General information - {ref}`reference-underlying-projects-and-dependencies` -- {ref}`reference-compatibility-matrix` - {ref}`gres` - {ref}`reference-interconnects` - {ref}`reference-monitoring` - {ref}`reference-performance` +- {ref}`reference-vm-compatibility` ```{filtered-toctree} @@ -20,11 +20,11 @@ Charmed HPC operates. :hidden: Underlying projects and dependencies -compatibility-matrix gres/index interconnects/index monitoring/index Performance +vm-compatibility :draft:Glossary ``` diff --git a/reference/compatibility-matrix.md b/reference/vm-compatibility.md similarity index 96% rename from reference/compatibility-matrix.md rename to reference/vm-compatibility.md index 9ae8a1e..44dd498 100644 --- a/reference/compatibility-matrix.md +++ b/reference/vm-compatibility.md @@ -1,12 +1,12 @@ -(reference-compatibility-matrix)= -# Compatibility Matrix +(reference-vm-compatibility)= +# Virtual Machine Compatibility -The tables below provide an overview of cloud instance types that have been tested for compatibility with Charmed HPC revisions. Inclusion in a table indicates that the corresponding VM type has been tested; however, exclusion from the table simply indicates that the instance has not been tested thoroughly and may be compatible or incompatible with Charmed HPC. +The tables below provide an overview of cloud instance types that have been tested for compatibility with Charmed HPC revisions. Inclusion in a table indicates that the corresponding VM type has been tested; however, exclusion from the table simply indicates that the instance has not been tested thoroughly and may be compatible or incompatible with Charmed HPC. The compatibility key: * ✔ Compatible: Fully compatible with all Charmed HPC features. No known issues. -* △ Partial: May be compatible with a subset of Charmed HPC features or may have issues that require work-arounds. +* △ Partial: May be compatible with a subset of Charmed HPC features or may have issues that require workarounds. * ✘ Incompatible: Has issues that prevent all use-cases. ## Microsoft Azure From 37d793804e517dd8d04b25101a35c9f3f11a021b Mon Sep 17 00:00:00 2001 From: Dominic Sloan-Murphy Date: Mon, 7 Apr 2025 11:29:23 +0100 Subject: [PATCH 7/8] fix: use consistent capitalization for VM compatibility page title --- reference/vm-compatibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/vm-compatibility.md b/reference/vm-compatibility.md index 44dd498..f6dbcad 100644 --- a/reference/vm-compatibility.md +++ b/reference/vm-compatibility.md @@ -1,5 +1,5 @@ (reference-vm-compatibility)= -# Virtual Machine Compatibility +# Virtual machine compatibility The tables below provide an overview of cloud instance types that have been tested for compatibility with Charmed HPC revisions. Inclusion in a table indicates that the corresponding VM type has been tested; however, exclusion from the table simply indicates that the instance has not been tested thoroughly and may be compatible or incompatible with Charmed HPC. From 3f96798f845327857a9d38129a76b50c504d367a Mon Sep 17 00:00:00 2001 From: Dominic Sloan-Murphy Date: Wed, 9 Apr 2025 15:50:10 +0100 Subject: [PATCH 8/8] docs: reword VM compatibility introduction --- reference/vm-compatibility.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/reference/vm-compatibility.md b/reference/vm-compatibility.md index f6dbcad..dc4668a 100644 --- a/reference/vm-compatibility.md +++ b/reference/vm-compatibility.md @@ -1,11 +1,11 @@ (reference-vm-compatibility)= # Virtual machine compatibility -The tables below provide an overview of cloud instance types that have been tested for compatibility with Charmed HPC revisions. Inclusion in a table indicates that the corresponding VM type has been tested; however, exclusion from the table simply indicates that the instance has not been tested thoroughly and may be compatible or incompatible with Charmed HPC. +The tables below provide an overview of cloud instance types that have been tested for compatibility with Charmed HPC revisions. Inclusion in a table indicates that the corresponding VM type has been shown to work effectively; however this data is for informational purposes only and should not be construed as an official guarantee of full compatibility or comprehensive support. Exclusion from the table simply indicates that the instance has not been tested thoroughly and may be compatible or incompatible with Charmed HPC. The compatibility key: -* ✔ Compatible: Fully compatible with all Charmed HPC features. No known issues. +* ✔ Compatible: Compatible with all Charmed HPC features. No known issues. * △ Partial: May be compatible with a subset of Charmed HPC features or may have issues that require workarounds. * ✘ Incompatible: Has issues that prevent all use-cases.