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

Enable job profiling with influxdb #38

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions .custom_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Terraform
terraform
Traefik
traefik
InfluxDB
influxdb

# CLI commands
hostname
Expand Down
1 change: 1 addition & 0 deletions howto/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ taking you through the setup of your own Charmed HPC cluster.

- {ref}`howto-setup-deploy-slurm`
- {ref}`howto-setup-deploy-shared-filesystem`
- {ref}`howto-enable-job-profiling-with-influxdb`

(howto-manage)=
## Manage
Expand Down
24 changes: 24 additions & 0 deletions howto/setup/enable-job-profiling-with-influxdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
(howto-enable-job-profiling-with-influxdb)=
# How to enable job profiling with InfluxDB

Charmed-HPC integrates with the [InfluxDB Charm](https://charmhub.io/influxdb) to enable job profiling in slurm.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Charmed-HPC integrates with the [InfluxDB Charm](https://charmhub.io/influxdb) to enable job profiling in slurm.
Charmed HPC can integrate with the [InfluxDB Charm](https://charmhub.io/influxdb) to enable job profiling in Slurm.


This how-to guide explains how enable job profiling by deploying and integrating `influxdb` with charmed-hpc.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This how-to guide explains how enable job profiling by deploying and integrating `influxdb` with charmed-hpc.
This guide explains how to enable job profiling by deploying and integrating `influxdb` with charmed-hpc.


## Prerequisites

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

## Deploy and Integrate InfluxDB

InfluxDB can be deployed using Juju in a single command.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
InfluxDB can be deployed using Juju in a single command.
InfluxDB can be deployed using Juju in a single command:

:::{code-block} shell
$ juju deploy influxdb
:::

Now [integrate](https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/juju-cli/list-of-juju-cli-commands/integrate/) the newly deployed influxdb charm with slurmctld.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Now [integrate](https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/juju-cli/list-of-juju-cli-commands/integrate/) the newly deployed influxdb charm with slurmctld.
Now [integrate](https://canonical-juju.readthedocs-hosted.com/en/latest/user/reference/juju-cli/list-of-juju-cli-commands/integrate/) the newly deployed influxdb charm with slurmctld:

:::{code-block} shell
$ juju integrate influxdb slurmctld
:::

Once the InfluxDB charm deployment and integration are complete slurm will be configured to send job profiling metrics to influxdb, enabling the use of the [`sstat`](https://slurm.schedmd.com/sstat.html) command.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Once the InfluxDB charm deployment and integration are complete slurm will be configured to send job profiling metrics to influxdb, enabling the use of the [`sstat`](https://slurm.schedmd.com/sstat.html) command.
Once the InfluxDB charm deployment and integration are complete, Slurm is configured to send job profiling metrics to influxdb, enabling the use of the [`sstat`](https://slurm.schedmd.com/sstat.html) command.

5 changes: 3 additions & 2 deletions howto/setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ See the how-to guides in this section for the steps to set up and deploy various

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

- {ref}`howto-enable-job-profiling-with-influxdb`



Expand All @@ -15,5 +15,6 @@ See the how-to guides in this section for the steps to set up and deploy various

Deploy Slurm <deploy-slurm>
Deploy a shared filesystem <deploy-shared-filesystem>
Enable job profiling with InfluxDB <enable-job-profiling-with-influxdb>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Enable job profiling with InfluxDB <enable-job-profiling-with-influxdb>
Enable job profiling <enable-job-profiling-with-influxdb>

Copy link
Contributor

Choose a reason for hiding this comment

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

Just a bit too wordy for the sidebar


:::
:::