Skip to content

docs: add VM instance compatibility matrix #47

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.

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

dsloanm
Copy link
Contributor

@dsloanm dsloanm commented Mar 17, 2025

Adds a compatibility matrix reference page for VM instance types that have been used for testing Charmed HPC on Azure.

At the moment, this is mostly beneficial for the slurmd charm, as this has been tested on a few different combinations of instances to confirm RDMA and GPU compatibility. The remaining charms have been exclusively run on Standard_D2as_v6 instances, Juju's default for Azure.

@dsloanm dsloanm requested a review from a team as a code owner March 17, 2025 15:59
@dsloanm dsloanm requested review from AshleyCliff and removed request for a team March 17, 2025 15:59
@dsloanm dsloanm force-pushed the reference/compatibility-matrix branch 2 times, most recently from 4d19681 to c147f19 Compare March 18, 2025 17:25
@NucciTheBoss NucciTheBoss added the docs This pull request makes a change to the documentation label Mar 21, 2025
Copy link
Contributor

@AshleyCliff AshleyCliff left a comment

Choose a reason for hiding this comment

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

Looks good! Definitely some useful information to have available to users - we'll want to update as we test on other VMs. I've made just a few suggestions on phrasing and maybe a different title.

@@ -0,0 +1,76 @@
(reference-compatibility-matrix)=
# Compatibility Matrix
Copy link
Contributor

Choose a reason for hiding this comment

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

Something like 'VM compatibility' might be better as a title, since the current title doesn't hint at what is/is not compatible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. I've changed the title to "Virtual machine compatibility" for clarity.

@dsloanm dsloanm force-pushed the reference/compatibility-matrix branch from 190fdee to 8de4e9d Compare April 7, 2025 10:26
Copy link
Contributor

@AshleyCliff AshleyCliff left a comment

Choose a reason for hiding this comment

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

One suggestion about adding a note.

Once the release policy is confirmed, we'll likely want to either add a column noting which Charmed HPC release is being tested, or have a unique page/section for each release. Since the release policy should be implemented in near future, we should potentially leave this PR unmerged until those updates can be made. Thoughts?

@dsloanm dsloanm force-pushed the reference/compatibility-matrix branch from 8191fa0 to 3f96798 Compare April 9, 2025 14:55
@dsloanm
Copy link
Contributor Author

dsloanm commented Apr 9, 2025

Note has been added and I've rebased on current main once more.

Yes, I think that's a good idea to keep this un-merged for now. We can update when we have the release policy in place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This pull request makes a change to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants