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.

Sign up for GitHub

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

Table of Contents updates #37

Merged
merged 11 commits into from
Feb 12, 2025
Merged

Table of Contents updates #37

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
30042f5
docs: Updates to howto toc tree - adding manage and set up sections
AshleyCliff Feb 11, 2025
d0afdcd
docs: update homepage card for cloud environment
AshleyCliff Feb 11, 2025
d592aea
docs: Updating explanation and refs cards on homepage
AshleyCliff Feb 11, 2025
0f55b72
docs: Fixed Manage description on howto landing page to match manage …
AshleyCliff Feb 11, 2025
ec424ca
fix: Updating missed cross-reference labels
AshleyCliff Feb 11, 2025
508d6e3
fix: Second round of updating missed ref changes
AshleyCliff Feb 11, 2025
ca2ce8e
fix: Missed ref updates
AshleyCliff Feb 11, 2025
f4e80e3
fix: remove cloud env from homepage toc
AshleyCliff Feb 11, 2025
aee63aa
docs: Added first steps section to how-to landing page
AshleyCliff Feb 12, 2025
16e8b32
fix: Fixes capitalization in toc tree
AshleyCliff Feb 12, 2025
ec85d83
fix: One more cap. update
AshleyCliff Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions howto/getting-started/index.md
View file
Open in desktop

This file was deleted.

18 changes: 10 additions & 8 deletions howto/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,23 @@

The guides in this section provide detailed steps for key operations and common tasks for Charmed HPC.

(howto-getstarted)=
## Getting started
- {ref}`howto-initialize-cloud-environment`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This probably needs a description or context here, but I wasn't sure exactly what/how. Thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

How about this?

The guides in this section provide detailed steps for performing key operations and common tasks in Charmed HPC.

First steps

It is strongly recommend that you go through the {ref}howto-initialize-cloud-environment <Initialize cloud environment> guide first before going through the {ref}Setup section <howto-setup>. This guide will show you how to set up access to the compute, storage, and networking resources your Charmed HPC cluster will need.

We could then add an admonition in the future that is like "first time using/deploying Charmed HPC? Check out these tutorials here" once we have some tutorials added.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This looks good, I'll add it. And I agree adding the note pointing to tutorials eventually will help as well.


(howto-setup)=
## Setup

These how-to guides will get you started with Charmed HPC by
taking you through the deployment of your own Charmed HPC cluster.
taking you through the setup of your own Charmed HPC cluster.

- {ref}`howto-getting-started-initialize-cloud-environment`
- {ref}`howto-getting-started-deploy-slurm`
- {ref}`deploy-shared-filesystem`
- {ref}`howto-setup-deploy-slurm`
- {ref}`howto-setup-deploy-shared-filesystem`

(howto-manage)=
## Manage

The how-to guides in this section show you how to perform common management tasks after you have
deployed Charmed HPC. These guides are for system administrators and HPC engineers that are
responsible for managing Charmed HPC deployments.
responsible for managing Charmed HPC after deployment.

- {ref}`howto-manage-integrate-with-cos`

Expand All @@ -27,6 +28,7 @@ responsible for managing Charmed HPC deployments.
:maxdepth: 1
:hidden:

getting-started/index
Initialize Cloud Environment <initialize-cloud-environment>
setup/index
manage/index
:::
8 changes: 4 additions & 4 deletions ...g-started/initialize-cloud-environment.md → howto/initialize-cloud-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
relatedlinks: "[Get&#032;started&#032;with&#032;Juju](https://juju.is/docs/juju/tutorial), [Juju&#032;(Application)](https://juju.is/docs/juju/application), [Juju&#032;(Charm)](https://juju.is/docs/juju/charmed-operator), [Juju&#032;(Cloud)](https://juju.is/docs/juju/cloud), [Juju&#032;(Controller)](https://juju.is/docs/juju/controller)"
---

(howto-getting-started-initialize-cloud-environment)=
(howto-initialize-cloud-environment)=
# How to initialize cloud environment

This how-to guide shows you how to initialize the cloud environment where you will
Expand Down Expand Up @@ -33,7 +33,7 @@ you will need:
* Access to a [supported Kubernetes cloud](https://juju.is/docs/juju/juju-supported-clouds)
* The [Juju CLI client](https://juju.is/docs/juju/install-and-manage-the-client) installed on your machine

(howto-getting-started-initialize-machine-cloud)=
(howto-initialize-machine-cloud)=
## Initialize machine cloud

Follow the instructions below to initialize the `charmed-hpc` machine cloud.
Expand Down Expand Up @@ -155,7 +155,7 @@ After initializing the `charmed-hpc` machine cloud, follow the instructions belo
To use Canonical Kubernetes as the Kubernetes cloud for your Charmed HPC cluster,
you will need to have:

* [Initialized a machine cloud](#howto-getting-started-initialize-machine-cloud)
* [Initialized a machine cloud](#howto-initialize-machine-cloud)
* [Installed and bootstrapped Canonical Kubernetes](https://documentation.ubuntu.com/canonical-kubernetes/latest/snap/howto/install/snap/)
* [Enabled the default load balancer](https://documentation.ubuntu.com/canonical-kubernetes/latest/snap/howto/networking/default-loadbalancer/)

Expand Down Expand Up @@ -196,5 +196,5 @@ charmed-hpc-k8s 1 default k8s
## Next Steps

Now that both the `charmed-hpc` machine cloud and `charmed-hpc-k8s` Kubernetes cloud are initialized,
you can start deploying applications with Juju. Go to the {ref}`howto-getting-started-deploy-slurm` guide
you can start deploying applications with Juju. Go to the {ref}`howto-setup-deploy-slurm` guide
for how to deploy Slurm as the workload manager of your Charmed HPC cluster.
2 changes: 1 addition & 1 deletion howto/manage/integrate-with-cos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ for a high-level introduction to the Canonical Observability Stack.
To integrate Charmed HPC with COS, you will need:

* An [isolated](https://charmhub.io/topics/canonical-observability-stack/reference/best-practices#deploy-in-isolation) [COS deployment](https://charmhub.io/topics/canonical-observability-stack/tutorials/install-microk8s) with [ingress](https://charmhub.io/topics/canonical-observability-stack/explanation/ingress) enabled
* An active [Slurm deployment](#howto-getting-started-deploy-slurm) in your [`charmed-hpc` machine cloud](#howto-getting-started-initialize-machine-cloud)
* An active [Slurm deployment](#howto-setup-deploy-slurm) in your [`charmed-hpc` machine cloud](#howto-initialize-machine-cloud)
* The [Juju CLI client](https://juju.is/docs/juju/install-and-manage-the-client) installed on your machine
* The [`jq` CLI command](https://jqlang.org/download/) installed on your machine

Expand Down
4 changes: 2 additions & 2 deletions ...tting-started/deploy-shared-filesystem.md → howto/setup/deploy-shared-filesystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
(deploy-shared-filesystem)=
(howto-setup-deploy-shared-filesystem)=
# How to deploy a shared filesystem

Charmed-HPC allows automatic integration with shared filesystems using the
Expand All @@ -7,7 +7,7 @@ deploy `filesystem-client` to integrate with externally managed shared filesyste

## Prerequisites

- A [deployed Slurm cluster](#howto-getting-started-deploy-slurm).
- A [deployed Slurm cluster](#howto-setup-deploy-slurm).

## Deploy an external filesystem server

Expand Down
4 changes: 2 additions & 2 deletions howto/getting-started/deploy-slurm.md → howto/setup/deploy-slurm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
relatedlinks: "[Slurm&#32;website](https://slurm.schedmd.com/overview.html), [Slurm&#32;charms&#32;repository](https://github.com/charmed-hpc/slurm-charms)"
---

(howto-getting-started-deploy-slurm)=
(howto-setup-deploy-slurm)=
# How to deploy Slurm

This how-to guide shows you how to deploy the Slurm workload manager as the
Expand All @@ -13,7 +13,7 @@ The deployment, management, and operations of Slurm are controlled by the Slurm

To successfully deploy Slurm in your Charmed HPC cluster, you will at least need:

- An [initialized cloud environment](#howto-getting-started-initialize-cloud-environment).
- An [initialized cloud environment](#howto-initialize-cloud-environment).
- The [Juju CLI client](https://juju.is/docs/juju/install-and-manage-the-client) installed on your machine.

Once you have verified that you have met the prerequisites above, proceed to the instructions below.
Expand Down
23 changes: 23 additions & 0 deletions howto/setup/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Setup

See the how-to guides in this section for the steps to set up and deploy various components of Charmed HPC, such as the Slurm workload manager or a shared filesystem.

- {ref}`howto-setup-deploy-slurm`
- {ref}`howto-setup-deploy-shared-filesystem`








:::{toctree}
:titlesonly:
:maxdepth: 1
:hidden:

Deploy Slurm <deploy-slurm>
Deploy a Shared Filesystem <deploy-shared-filesystem>

:::
14 changes: 9 additions & 5 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,20 @@ The platform enables organizations to focus on obtaining key insights and making

__Step-by-step guides__ covering key operations and common tasks

- {ref}`howto-getstarted`
- {ref}`Manage Charmed HPC <howto-manage>`
- {ref}`Initialize Cloud Environment <howto-initialize-cloud-environment>`
- {ref}`howto-setup`
- {ref}`howto-manage`

```


```{grid-item-card} [Explanation](explanation/index)

__Discussion and clarification__ of key topics

- {ref}`cryptography`
- {ref}`gpus`

- {ref}`explanation-interconnects`

```

Expand All @@ -40,7 +41,9 @@ __Discussion and clarification__ of key topics

__Technical information__

- {ref}`gres`
- {ref}`reference-underlying-projects-and-dependencies`
- {ref}`gres`
- {ref}`reference-interconnects`

```

Expand Down Expand Up @@ -71,6 +74,7 @@ Here's some links to help you get started with joining the community:

self
howto/index
Initialize Cloud Environment <howto/initialize-cloud-environment>
explanation/index
reference/index
```