Skip to content
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

feat: add how-to for initializing cloud environment of Charmed HPC #27

Conversation

NucciTheBoss
Copy link
Member

@NucciTheBoss NucciTheBoss commented Feb 3, 2025

Like PR title says, this PR adds a how-to for initializing the cloud environment which we will deploy Charmed HPC in. Currently I just started off with LXD and Canonical Kubernetes since I want to get the structure of the page correct, but ideally we'll be able to expand it as we start to bring on more clouds such as Azure and AWS.

Related issues

Misc.

  • Removed extraneous whitespace.
  • Linked "Deploy Slurm" how-to to "Initialize cloud environment" how-to.
  • Updated "Deploy Slurm" how-to to include info about deploying Slurm to the created machine cloud charmed-hpc
    • In the Identity how-to I will be deploying the Identity charms like glauth-k8s to the Kubernetes cloud charmed-hpc-k8s
  • I further granularized the reference links we've created to reduce the chances of name clashes between reference links.

How-to guide includes info for setting up cloud environments on LXD and Canonical K8s, and updates references throughout the doc to mention the created clouds.

Signed-off-by: Jason C. Nucciarone <[email protected]>
@NucciTheBoss NucciTheBoss requested a review from a team as a code owner February 3, 2025 21:43
@NucciTheBoss NucciTheBoss requested review from AshleyCliff and removed request for a team February 3, 2025 21:43
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.

Looking good! A few phrasing and grammar corrections, and a couple more open-ended comments.

@NucciTheBoss NucciTheBoss added feature This pull request adds a new feature to the project docs This pull request makes a change to the documentation C-slurm Component: Slurm and removed documentation labels Feb 4, 2025
Changes:

* Include various grammar fixes
* Don't use Latin terms since they are hard to translate
* Correct `sudo k8s config` command
* Update section headers to read better

Signed-off-by: Jason C. Nucciarone <[email protected]>
Signed-off-by: Jason C. Nucciarone <[email protected]>
@NucciTheBoss
Copy link
Member Author

@AshleyCliff ready for review 2: electric boogalo

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.

Looking good! Just a few quick fixes and it'll be good to go.

Changes:

* Fix reference to `k8s config` command

Signed-off-by: Jason C. Nucciarone <[email protected]>
@NucciTheBoss
Copy link
Member Author

@AshleyCliff should be good to go 👍

@AshleyCliff AshleyCliff merged commit 475a73e into charmed-hpc:main Feb 5, 2025
2 checks passed
@NucciTheBoss NucciTheBoss deleted the nuccitheboss/docs/init-cloud-environment branch February 6, 2025 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-slurm Component: Slurm docs This pull request makes a change to the documentation feature This pull request adds a new feature to the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add how-to in "Getting Started" for initializing your environment before deploying Slurm
2 participants