docs: update documentation for deploying Slurm #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Enabled these extension so that we can have both in-line syntax highlighting for code, and colon blocks to more easily show that we are working with MyST, not just markdown with extra steps. Signed-off-by: Jason C. Nucciarone <[email protected]>
NucciTheBoss
requested review from
AshleyCliff
and removed request for
a team
AshleyCliff
requested changes
Jan 17, 2025
Now include instructions for using Terraform as well. Signed-off-by: Jason C. Nucciarone <[email protected]>
Rename done to make it clear what HPC infrastructure we're working with rather than just being generic. Too premature to optimize for a possible future where we're supporting multiple workload managers. Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
New words added: * hostname * sackd * juju * Terraform/terraform Signed-off-by: Jason C. Nucciarone <[email protected]>
`myst-parser` discourages using implicit targets for referencing headers. Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
Changes: * Move note about ingress to Prerequisites section since it's VERY IMPORTANT (Grafana Agent won't work without it), and update admonition to be more specific about what happens if ingress is not enabled. Signed-off-by: Jason C. Nucciarone <[email protected]>
NucciTheBoss
force-pushed
the
nuccitheboss/docs/update-deploy-wlm
branch
from
bcab09d to
5d601e3
Compare
|
@AshleyCliff ready for another review. Having the same linkcheck issue as #18. Seems to be an intermittent problem with the jwt website. |
AshleyCliff
requested changes
Jan 21, 2025
More consistent nomenclature between CLI and Terraform. Also indicates the existence of multiple clients for integrating with Charmed HPC. Signed-off-by: Jason C. Nucciarone <[email protected]>
|
Ready for round 3 😎 Linkcheck still seems to be freaking out however 😢 |
Uses the annotation `{l=shell}` to highlight commands intended to be run through the shell.
Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
|
Fixed |
|
Looks great! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the Slurm documentation to be more current, and adds instructions for deploying Slurm with both the CLI and Terraform. Also includes additional sections for how to set the node state to idle and verify that they are idle.
Other things this PR does is enable to
attrs_inlineandcolon_fenceMyST extensions so we can get more cool and awesome MyST features.Related issues