hpc-compose/man/man1/hpc-compose-doctor-mpi-smoke.1 at 150894a40afab4db78f6cb1379754177f90a9200 · NicolasSchuler/hpc-compose · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.\" DO NOT EDIT. Generated by `cargo run --features manpage-bin --bin gen-manpages`
.TH "HPC\-COMPOSE\-DOCTOR\-MPI\-SMOKE" "1" "" "hpc\-compose 0.1.52" "User Commands"
.SH NAME
hpc\-compose\-doctor\-mpi\-smoke \- Render or run an MPI smoke probe for one service
.SH SYNOPSIS
.nf
hpc\-compose doctor mpi\-smoke [OPTIONS]
.fi
.SH DESCRIPTION
.PP
Render or run an MPI smoke probe for one service
.SH OPTIONS
.TP
\fB-f\fR, \fB--file\fR \fIFILE\fR
Compose specification file to read; if omitted, use the active context compose file or fall back to compose.yaml.
.TP
\fB--format\fR \fIFORMAT\fR
Output format. Possible values: text, json.
.TP
\fB--service\fR \fISERVICE\fR
MPI service to smoke\-test; inferred when exactly one MPI service exists.
.TP
\fB--submit\fR
Submit the MPI smoke probe to Slurm; without this, only render/explain it.
.TP
\fB--script\-out\fR \fIOUTPUT\fR
Write the rendered MPI smoke batch script to this path.
.TP
\fB--timeout\fR \fIDURATION\fR
Timeout for a submitted MPI smoke job. Default: 5m.
.TP
\fB--color\fR \fIWHEN\fR
Controls colored output. Default: auto. Possible values: auto, always, never.
.TP
\fB--quiet\fR
Suppress progress indicators and non\-essential labels.
.TP
\fB--profile\fR \fINAME\fR
Profile name to load from .hpc\-compose/settings.toml.
.TP
\fB--settings\-file\fR \fIPATH\fR
Explicit settings file path; defaults to upward search for .hpc\-compose/settings.toml.
.TP
\fB-h\fR, \fB--help\fR
Print help (see a summary with '\-h').
.SH EXAMPLES
.nf
hpc\-compose doctor
hpc\-compose doctor cluster\-report
hpc\-compose doctor readiness \-f compose.yaml \-\-service api
hpc\-compose doctor readiness \-f compose.yaml \-\-service api \-\-run
hpc\-compose doctor mpi\-smoke \-f compose.yaml \-\-service trainer
hpc\-compose doctor fabric\-smoke \-f compose.yaml \-\-service trainer \-\-checks auto
.fi
.SH SEE ALSO
hpc\-compose(1), hpc\-compose\-doctor(1), hpc\-compose\-doctor\-cluster\-report(1), hpc\-compose\-doctor\-fabric\-smoke(1), hpc\-compose\-doctor\-readiness(1)