improve documentation

eth-cscs · Jun 16, 2024 · 1947e5a · 1947e5a
1 parent 02cb617
commit 1947e5a
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Another CLI tool for [Alps](https://www.cscs.ch/science/computer-science-hpc/2021/cscs-hewlett-packard-enterprise-and-nvidia-announce-worlds-most-powerful-ai-capable-supercomputer).
 
-Manta is a frontend cli to interact and extend CSM, it uses [mesa](https://github.com/eth-cscs/mesa) for all Shasta interaction.
+Manta is a frontend cli to interact and extend CSM, it uses [mesa](https://github.com/eth-cscs/mesa) as a backend to interact with CSM.
 
 Manta's goals:
 
@@ -12,11 +12,11 @@ Manta's goals:
 
 Manta aggregates information from multiple sources:
 
- - Shasta Keycloak
- - Shasta API
- - Shasta K8s API
+ - CSM Keycloak
+ - CSM API
+ - CSM K8s API
  - local git repo
- - Gitea API (Shasta VCS)
+ - Gitea API (CSM VCS)
  - Hashicorp Vault
 
 ## Features

diff --git a/docs/Migration.md b/docs/Migration.md
@@ -0,0 +1 @@
+# Migration
diff --git a/docs/basics.md b/docs/basics.md
@@ -0,0 +1,21 @@
+# Basic operations
+
+## List configurations
+
+## List sessions
+
+## List images
+
+## List cluster details/summary
+
+## List hardware information
+
+## Set runtime configuration
+
+## Set boot image
+
+> :warning: **Highly discourage**: only do this if sessions in the system has been deleted
+
+## Set boot configuration
+
+## Set kernel parameters
diff --git a/docs/index.md b/docs/index.md
@@ -2,7 +2,7 @@
 
 Another CLI tool for [Alps](https://www.cscs.ch/science/computer-science-hpc/2021/cscs-hewlett-packard-enterprise-and-nvidia-announce-worlds-most-powerful-ai-capable-supercomputer).
 
-Manta is a frontend cli to interact and extend CSM, it uses [mesa](https://github.com/eth-cscs/mesa) for all Shasta interaction.
+Manta is a frontend cli to interact and extend CSM, it uses [mesa](https://github.com/eth-cscs/mesa) as a backend to interact with CSM.
 
 Manta's goals:
 
@@ -12,11 +12,11 @@ Manta's goals:
 
 Manta aggregates information from multiple sources:
 
- - Shasta Keycloak
- - Shasta API
- - Shasta K8s API
+ - CSM Keycloak
+ - CSM API
+ - CSM K8s API
  - local git repo
- - Gitea API (Shasta VCS)
+ - Gitea API (CSM VCS)
  - Hashicorp Vault
 
 ## Features
@@ -37,3 +37,13 @@ Manta aggregates information from multiple sources:
 - Audit/Log
 - Delete all data related to CFS configuration
 - Migrate nodes from HSM group based on hw components profile
+
+## Introduction
+
+> :warning: **WIP**: trying to fill the gap in cray and sat clis when managing clusters
+
+Configuration inmutability: overwritting configurations used by clusters (nodes booting with an image linked to a configuration or runtime configuration) is a bad practice because the history of that configuration is lost. 
+
+Configuration vs images: Images are assigned to node but doing this directly is a bad practice, the reason for this is. There is no way to know the content of an image based on its id or name, therefore the configuration-image relationship is mandatory to keep and we should always refer to configurations when assigning images to nodes to boot. For this the sessions must not be deleted. Missing this information means we won't be able to track down the scripts used to build the image.
+
+Cluster vs nodes operations: Provide operations on a list no nodes or on all nodes in a cluster
diff --git a/docs/sat.md b/docs/sat.md
@@ -0,0 +1 @@
+# SAT file
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,3 +8,6 @@ nav:
   - Home: index.md
   - Installation: installation.md
   - Configuration: configuration.md
+  - Basics: basics.md
+  - SAT file: sat.md
+  - Migration: migration.md