Lint

Author: j-kali

docs/architecture/container_preparation.md

@@ -17,24 +17,24 @@ sequenceDiagram
     Container Preparation container ->> Vault: Log-in using SVID
     Vault ->> Container Preparation container: Returns an authentication token (write only on client's path)
     Container Preparation container ->> Vault: Write private key using authentication token
-    Vault ->> Container Preparation container: 
+    Vault ->> Container Preparation container:
     Container Preparation container ->> HPCS Server: Request creation of workloads (compute nodes, users, groups ...) authorized to access the key and using SVID to authenticate
     HPCS Server ->> Spire Server: Validate SVID
-    Spire Server ->> HPCS Spire Agent: 
+    Spire Server ->> HPCS Spire Agent:
     HPCS Spire Agent ->> Spire Server: Validate SVID
-    Spire Server ->> HPCS Server: 
+    Spire Server ->> HPCS Server:
     HPCS Server ->> Spire Server: Create workloads identities to access the key
-    Spire Server ->> HPCS Server: 
+    Spire Server ->> HPCS Server:
     HPCS Server ->> Vault: Create role and policy to access the key
-    Vault ->> HPCS Server: 
+    Vault ->> HPCS Server:
     HPCS Server ->> Container Preparation container: SpiffeID & role to access the container, path to the secret
     Container Preparation container ->> Container Preparation container: Parse info file based on previous steps
     Container Preparation container ->> Supercomputer: Ship encrypted container
-    Supercomputer ->> Container Preparation container: ' 
+    Supercomputer ->> Container Preparation container: '
     Container Preparation container ->> Supercomputer: Ship info file
-    Supercomputer ->> Container Preparation container: 
+    Supercomputer ->> Container Preparation container:
     Container Preparation container -->> Spire Agent: Kills
-    Spire Agent -->> Container Preparation container: 
+    Spire Agent -->> Container Preparation container:
     Spire Agent -->> Container Preparation container: Dies
     Container Preparation container -->> User: Finishes
 ```

docs/architecture/data_preparation.md

@@ -17,24 +17,24 @@ sequenceDiagram
     Data Preparation container ->> Vault: Log-in using SVID
     Vault ->> Data Preparation container: Returns an authentication token (write only on client's path)
     Data Preparation container ->> Vault: Write private key using authentication token
-    Vault ->> Data Preparation container: 
+    Vault ->> Data Preparation container:
     Data Preparation container ->> HPCS Server: Request creation of workloads (compute nodes, users, groups ...) authorized to access the key and using SVID to authenticate
     HPCS Server ->> Spire Server: Validate SVID
-    Spire Server ->> HPCS Spire Agent: 
+    Spire Server ->> HPCS Spire Agent:
     HPCS Spire Agent ->> Spire Server: Validate SVID
-    Spire Server ->> HPCS Server: 
+    Spire Server ->> HPCS Server:
     HPCS Server ->> Spire Server: Create workloads identities to access the key
-    Spire Server ->> HPCS Server: 
+    Spire Server ->> HPCS Server:
     HPCS Server ->> Vault: Create role and policy to access the key
-    Vault ->> HPCS Server: 
+    Vault ->> HPCS Server:
     HPCS Server ->> Data Preparation container: SpiffeID & role to access the container, path to the secret
     Data Preparation container ->> Data Preparation container: Parse info file based on previous steps
     Data Preparation container ->> Supercomputer: Ship encrypted containe
-    Supercomputer ->> Data Preparation container: 
+    Supercomputer ->> Data Preparation container:
     Data Preparation container ->> Supercomputer: Ship info file
-    Supercomputer ->> Data Preparation container: 
+    Supercomputer ->> Data Preparation container:
     Data Preparation container -->> Spire Agent: Kills
-    Spire Agent -->> Data Preparation container: 
+    Spire Agent -->> Data Preparation container:
     Spire Agent -->> Data Preparation container: Dies
     Data Preparation container -->> User: Finishes
 ```

docs/architecture/job_preparation.md

@@ -23,10 +23,10 @@ sequenceDiagram
         Job Preparation container ->> Job Preparation container: Parse info from info file
         Job Preparation container ->> Job Preparation container: Generate SBATCH file from template based on info gathered
         Job Preparation container ->> Login Node: Copy SBATCH File and HPCS Configuration file
-        Login Node ->> Job Preparation container: 
+        Login Node ->> Job Preparation container:
         Job Preparation container ->> Job Preparation container: Generate keypair for output data
         Job Preparation container ->> Login Node: Copy encryption key
-        Login Node ->> Job Preparation container: 
+        Login Node ->> Job Preparation container:
     end
 
     rect rgb(191, 223, 255)
@@ -68,13 +68,13 @@ sequenceDiagram
         Application container ->> Application container: Encrypt output directory
         Application container -->> Compute node: Finishes
         Compute node -->> Spire Agent: Kills
-        Spire Agent -->> Compute node: 
+        Spire Agent -->> Compute node:
         Spire Agent -->> Compute node: Dies
         Compute node ->> Scheduler: Becomes available
         deactivate Job Preparation container
     end
     Job Preparation container ->> Login Node: Close SSH connection
-    Login Node ->> Job Preparation container: 
+    Login Node ->> Job Preparation container:
     Login Node ->> Job Preparation container: Close SSH connection
 
     Job Preparation container -->> User: Finishes

docs/cli/container_preparation.md

@@ -2,7 +2,7 @@
 
 Using the cli directly isn't recommended, the supported way is through docker's entrypoint.
 
-The container preparation cli allows the user to create/encrypt/ship a HPCS ready image based on any OCI image. 
+The container preparation cli allows the user to create/encrypt/ship a HPCS ready image based on any OCI image.
 
 ```
 usage: prepare_container.py [-h] --base-oci-image BASE_OCI_IMAGE --sif-path SIF_PATH [--encrypted] [--docker-path DOCKER_PATH]

docs/cli/data_preparation.md

@@ -2,7 +2,7 @@
 
 Using the cli directly isn't recommended, the supported way is through docker's entrypoint.
 
-The data preparation cli allows the user to encrypt/ship an encrypted archive based on any source directory. 
+The data preparation cli allows the user to encrypt/ship an encrypted archive based on any source directory.
 
 ```
 usage: prepare_data.py [-h] --input-path INPUT_PATH --output-path OUTPUT_PATH
@@ -24,8 +24,8 @@ Examples
 python3 ./client/data_preparation/prepare_data.py --help
 
 # Run the data preparation while specifying every parameters
-python3 ./client/data_preparation/prepare_data.py --input-path $(pwd)/input_data --output-path $(pwd) 
+python3 ./client/data_preparation/prepare_data.py --input-path $(pwd)/input_data --output-path $(pwd)
 
 # Run the data preparation while specifying every parameters (shortened version)
-python3 ./client/data_preparation/prepare_data.py -i $(pwd)/input_data -o $(pwd) 
+python3 ./client/data_preparation/prepare_data.py -i $(pwd)/input_data -o $(pwd)
 ```

docs/cli/job_preparation.md

@@ -60,7 +60,7 @@ Will create a slurm job with the following configuration :
 - As etellier
 - for an hour
 
-Also : 
+Also :
 - HPCS will run the job using `/scratch/project_462000031/etellier` as its workdir
 - The application will be handled using info file at `/pfs/lustrep4/scratch/project_462000031/etellier/encrypted_prepared_jp2a.sif.info.yaml`
 - The application will be handled using info file at `/pfs/lustrep4/scratch/project_462000031/etellier/encrypted_jp2a_input.tgz.info.yaml`

docs/configuration/client.md

@@ -8,7 +8,7 @@ Client's configuration has to respect `ini` configuration format and essentially
 [spire-server]
 address = localhost
 port = 31147
-trust-domain = hpcs 
+trust-domain = hpcs
 
 [hpcs-server]
 url = http://localhost:10080
@@ -23,7 +23,7 @@ username = etellier
 
 ## Reference
 
-### `spire-server` 
+### `spire-server`
 
 This section describes the connection to the spire-server
 - `address` : address of the spire-server

docs/configuration/server.md

@@ -24,7 +24,7 @@ server-role = hpcs-server
 
 ## Reference
 
-### `spire-server` 
+### `spire-server`
 
 This section describes the connection to the spire-server
 - `address` : address of the spire-server