clustermax 0.2.1__tar.gz

clustermax-0.2.1/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 SemiAnalysis
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

clustermax-0.2.1/PKG-INFO

@@ -0,0 +1,350 @@
+Metadata-Version: 2.4
+Name: clustermax
+Version: 0.2.1
+Summary: ClusterMAX GPU cluster audit and security CLI
+Author: SemiAnalysis
+Maintainer: SemiAnalysis
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://clustermax.semianalysis.com/
+Project-URL: Documentation, https://www.clustermax.ai/criteria
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: prompt-toolkit<4,>=3.0.52
+Requires-Dist: PyYAML>=6
+Provides-Extra: dev
+Requires-Dist: build>=1; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Dynamic: license-file
+
+# ClusterMAX
+
+This repo is for `cmax`, a CLI tool that we use to audit GPU clusters and standalone machines during research for ClusterMAX. The initial release supports our recent article on neocloud security that precedes ClusterMAX 3.0.
+
+Version 0.2.1 of the `cmax` CLI provides these functional commands:
+
+| Command | Function |
+|---|---|
+| `cmax audit security` | This command runs a focused, read-only security audit. |
+| `cmax audit` | This command runs the complete cluster audit. |
+| `cmax audit review` | This command reviews a saved audit without new checks. |
+
+## Install ClusterMAX
+
+ClusterMAX requires Python 3.10 or later. Install the current release:
+```
+uv venv
+source .venv/bin/activate
+uv pip install clustermax
+cmax -v
+```
+
+You can also use the `--pre` option to install the latest nightly release:
+```
+uv pip install --pre -U clustermax
+```
+
+Use `-h` to see available options when using the CLI:
+```
+cmax -h
+cmax audit -h
+cmax audit security -h
+```
+
+Nightly releases use the `0.3.0.devYYYYMMDDNN` format until the stable 0.3.0
+release. This version is newer than stable 0.2.1 when `--pre` is enabled.
+
+## Public documentation
+
+The [ClusterMAX website](https://clustermax.semianalysis.com/) explains the rating system. The [evaluation criteria](https://www.clustermax.ai/criteria) list our full checklist, while the [expectations page](https://www.clustermax.ai/expectations) lists or clearest expectations for Slurm, Kubernetes, standalone machines, monitoring dashboards, and health checks.
+
+## Run a security audit
+
+The current [minimum-version table](https://www.clustermax.ai/minimum-versions) lists the software and firmware versions used for grading, with vendor advisories behind each value. Its [machine-readable form](https://www.clustermax.ai/minimum-versions.json) is the table `cmax audit security` fetches on startup (skip with `--no-fetch-minimums`).
+
+The security profile selects the version and isolation checks from the complete audit. Use `-s` or `--show` to list the applicable checks before the audit runs:
+
+```console
+$ cmax audit security --show
+[versions] Minimum versions
+  securityVersions.nvidiaDriver.status: Security Versions / NVIDIA Driver
+  ...
+
+[isolation] Security isolation
+  security.januscape.status: Security / Januscape
+  ...
+```
+
+Use `--dry-run -o yaml` to show the resolved plan. This will be useful for future releases of the clustermax CLI. The following example selects a standalone virtual machine:
+
+```console
+$ cmax audit security --vm --dry-run -o yaml
+# Only audit security manifest is enabled, unrelated tests are not
+version: 4
+manifest_selection:
+  enabled:
+  - audit.audit
+  disabled_count: 0
+  disabled_by_phase:
+    audit: 0
+audit_profile:
+  name: security
+  dry_run: true
+  command: cmax audit security
+  target:
+    selection: explicit
+    environment: vm
+    harness: standalone
+  scope:
+    core_collector: true
+    checks:
+      fabric: true
+      gpu: false
+      system: false
+    general_findings_report: false
+    standard_report: true
+  artifacts:
+  - audit.out
+  - audit.values.json
+  checks:
+  - securityVersions.nvidiaDriver.status
+  - securityVersions.nvidiaContainerToolkit.status
+  - securityVersions.cudaToolkit.status
+  - securityVersions.runc.status
+  - securityVersions.docker.status
+  - securityVersions.connectxFirmware.status
+  - securityVersions.dcgm.status
+  - securityVersions.dcgmExporter.status
+  - securityVersions.virtioNetBluefield.status
+  - securityVersions.virtioNetBluefield.exposure
+  - securityVersions.dpuHostIsolation.status
+  - security.januscape.status
+  - security.guestKernel.newerInstalled
+  - security.fragnesia.status
+  - bmc-ipmi
+  - ufm-profile
+  - pcie-passthrough
+  - nvlink-boundary
+```
+
+The resolved plan enables only `audit.audit`. It uses the standard artifact
+files, progress wrapper, and report formatter. On Slurm, the security profile
+uses a focused collector that runs the worker security inventory, container
+version inventory, and backend fabric checks that its report needs.
+
+Every live audit reports its target before it collects data. An interactive
+run requires confirmation. The default answer cancels the audit with exit code
+130:
+
+```text
+# ClusterMAX audit target
+  Command: cmax audit security
+  Target: Local machine
+  Host: <hostname>
+  System: macOS <version> (<architecture>)
+  Access: current shell; cluster credentials are not used
+  Compatibility: limited; Linux GPU checks can report unavailable components
+  Selection: auto-detected
+Run this audit? [y]es, [c]hange target or access, [N]o:
+```
+
+Enter `c` to select the local machine, a Kubernetes cluster, or a Slurm
+cluster. Kubernetes selection accepts a kubeconfig path and a context. It
+validates the connection before the audit starts. Slurm selection validates
+the current Slurm client session.
+
+Run the security audit after you confirm that the target is correct. The command
+uses `-v` detail by default.
+```bash
+cmax audit security
+```
+
+Use `-vvv` for the most detail.
+```bash
+cmax audit security -vvv
+```
+
+## Notes on usage
+
+The command detects Slurm, Kubernetes, containers, virtual machines, macOS, and standalone hosts automatically, and confirms the selection interactively with the user. To skip this confirmation and force the CLI to use a certain approach, use `--local`, `--slurm`, `--k8s`, `--container`, `--vm`, or `--standalone`. Use `--kubeconfig PATH` to select Kubernetes credentials. An explicit target option confirms the target in a non-interactive run. Use `--yes` to accept an auto-detected target without a prompt.
+
+Users can run the command multiple times. Each run writes timestamped artifacts
+under `~/.clustermax/audit/` by default.
+
+A failed security check produces exit code 2. Use `--exit-zero` when the caller
+requires exit code 0.
+
+See [the security audit section](#run-a-security-audit) for the criteria,
+report format, and evidence limits.
+
+## Run a cluster audit
+
+Version 0.2.1 runs the core audit. Use `-s` or `--show` to list every check without collecting data:
+
+```bash
+cmax audit --show
+```
+
+The preview groups the full audit checks into these profiles:
+
+| Profile | Scope |
+|---|---|
+| `versions` | This profile shows component versions and required minimums. |
+| `isolation` | This profile shows kernel, virtualization, and tenant isolation. |
+| `hardware` | This profile shows GPU, memory, and input-output virtualization. |
+| `software` | This profile shows GPU development and diagnostic tools. |
+| `containers` | This profile shows the container runtime and its GPU integration. |
+| `orchestration` | This profile shows Slurm workers, Pyxis, and Kubernetes kubelets. |
+| `networking` | This profile shows fabric topology, adapter naming, and NCCL configuration. |
+| `storage` | This profile shows binary storage installation and configuration checks. |
+| `health` | This profile shows node health and GPU telemetry checks. |
+
+Use a profile as an audit subcommand to select its checks:
+
+```bash
+cmax audit hardware --show
+cmax audit hardware
+cmax audit networking --slurm
+```
+
+Every named profile uses the same core collector wrapper, progress display,
+artifact directory, and report formatter. A profile limits the supplemental
+checks and the terminal report to its selected audit checks. The shared
+collector still records the inventory that the selected checks need. The Slurm
+security profile also omits complete-audit sections that do not supply security
+evidence.
+
+The complete audit reads seven days of retained kernel history for GPU errors.
+It checks every node in an active Slurm allocation and every Kubernetes GPU
+node. It uses the current-boot `dmesg` buffer when the journal is not readable.
+
+Each live profile saves `audit.out` and `audit.values.json`. The security
+profile returns exit code 2 when its standard report contains a failed check.
+Use `--exit-zero` when an automation system requires exit code 0.
+
+Every audit report uses the same status blocks. `PASS` is green, `WARNING` is
+yellow, `FAIL` is red, and `SKIPPED` is dim when output goes to a terminal.
+Redirected output stays plain text. The default `-v` output shows every passed,
+warning, failed, and skipped check. It also shows each observed version, its
+minimum version, and a link to that component in the published
+[minimum-version table](https://www.clustermax.ai/minimum-versions), such as
+[`runc`](https://www.clustermax.ai/minimum-versions#runc). The `-vv` output adds
+labeled CVE and vendor documentation links. The `-vvv` output adds the issue
+description and recommended remediation. The CLI does not provide an output
+level below `-v`.
+
+Target aliases select an environment for the complete audit:
+
+```bash
+cmax audit slurm
+cmax audit k8s
+cmax audit standalone
+cmax audit vm
+cmax audit container
+```
+
+These commands are equivalent to the matching `--slurm`, `--k8s`,
+`--standalone`, `--vm`, and `--container` options.
+
+The Slurm audit checks Pyxis through the container options that Pyxis adds to
+`srun --help`. It records the installed package version when package metadata
+is available. The check does not start a container or wait for a GPU allocation.
+If the options are unavailable, the audit links to the
+[NVIDIA Pyxis installation instructions](https://github.com/NVIDIA/pyxis#installation).
+
+The full audit also evaluates the published criteria that have binary results
+from a cluster target. These checks verify scheduler CUDA device assignment,
+Lmod, Kubernetes ReadWriteMany storage, and Nsight Compute profiling permission.
+The audit omits criteria that require commercial, contractual, performance,
+reliability, provider-side, or scale-out network evidence.
+
+After target selection, the audit runs only checks that apply to that target.
+A standalone container, virtual machine, or bare-metal host omits every check
+that applies only to Slurm or Kubernetes. These checks include GRES, Pyxis,
+scheduler topology, multi-node NCCL, health programs, prologs, NHC,
+auto-remediation, and kubelet CPU Manager.
+
+A Kubernetes audit discovers provider components across all namespaces, because
+managed services can use provider-specific namespaces and current Kubernetes
+application labels. The audit also distinguishes a container runtime binary
+from a compatibility link whose command name is `docker`. When the audit finds
+Promtail with Loki or Elasticsearch, it reports the aggregation system as the
+logging stack and reports Promtail only as a detected log shipper.
+
+The Kubernetes BMC and IPMI check uses the confirmed Kubernetes identity to
+create a privileged pod that mounts each worker host root. The report names
+each checked node and states the fleet coverage. This evidence proves what that
+administrative identity can reach. It does not prove that an ordinary workload
+pod can reach the same local management interface. The check examines up to 32
+worker nodes by default. Set `CLUSTERMAX_AUDIT_K8S_BMC_NODE_LIMIT` to a larger
+positive integer when a larger fleet requires complete coverage.
+
+The standalone audit also omits scale-out network checks. It does not inspect
+InfiniBand, RoCE, RDMA, HCA naming, PKeys, UFM, SHARP, fabric topology, or
+GPUDirect RDMA. The report marks their criteria as `SKIPPED`. Slurm and
+Kubernetes audits keep their scale-out checks.
+
+The standalone audit still reads the local PCI device list to determine
+whether the NVIDIA GPU driver security criterion applies to the host.
+
+The platform configuration checks have separate entry points. The hardware
+profile runs `vm-iommu-check.py` and `arm-smmu-virtualization-check.py`. The
+networking profile runs `nccl-topology-file-check.py` on Slurm and
+`nccl-ib-qps-check.py` on Slurm or Kubernetes. The entry points reuse one host
+collection during an audit run.
+
+The core audit collects cluster, host, GPU, storage, network, health, and
+security data. It does not run the planned performance or reliability tests.
+
+Each audit command sets its execution profile and selected harness explicitly.
+An inherited `CLUSTERMAX_AUDIT_SCOPE` or `CLUSTERMAX_AUDIT_HARNESS` value cannot
+change the confirmed selection. `cmax audit` uses the complete profile. Each
+named subcommand uses its matching focused profile.
+
+Run or review the core audit with these commands:
+
+```bash
+cmax audit
+cmax audit review
+```
+
+ClusterMAX detects Slurm, Kubernetes, or a standalone machine. Use `--slurm`,
+`--k8s`, `--local`, or `--standalone` when detection is incorrect. The command
+uses the same target report and confirmation as the security audit.
+
+Each audit saves its results in `~/.clustermax/audit/<timestamp>/`. Set
+`CLUSTERMAX_RUNS_ROOT` when you need the ingest-compatible
+`<root>/<cluster>/<timestamp>/audit/` layout.
+
+The audit is read-only. This section gives the requirements, checks, and output
+files.
+
+Use `cmax audit review` to open the newest saved audit. You can also specify an
+audit directory, an `audit.values.json` file, or an `audit.out` file:
+
+```bash
+cmax audit review runs/<cluster>/<timestamp>/audit/audit.out
+cmax audit review --command 'find runc'
+cmax audit review --command 'show securityVersions.runc.status'
+```
+
+Use `-v` to include passing and skipped checks. Use `-vv` to include observed
+evidence. Use `-vvv` to include recommended remediation and labeled reference
+URLs. Use `--command raw` to print the saved collector log. Use
+`--no-interactive` to print the review and exit.
+
+## Repository contents
+
+| Path | Contents |
+|---|---|
+| `cmax/` | This directory contains the command code and `cmax.yaml` configuration. |
+| `cmax/scripts/1-audit/` | This directory contains the scripts that run an audit. |
+| `tests/audit/` | This directory contains all audit tests, fixtures, and test helpers. |
+
+This release excludes provider results, internal notes, the private dashboard,
+benchmark implementations, bundled data, and database code.
+
+## License
+
+All published ClusterMAX source code uses the Apache License 2.0. See
+[LICENSE](LICENSE).