Merge pull request #5 from adonofri/Documentation_markdown

Documentation markdown
ICSC-Spoke2-repo · Apr 19, 2024 · a5c0b10 · a5c0b10
2 parents e58039a + c06e019
commit a5c0b10
Show file tree

Hide file tree

Showing 8 changed files with 94 additions and 5 deletions.
diff --git a/docs/img/IAM_registration.png b/docs/img/IAM_registration.png
diff --git a/docs/img/jupyter_demo.png b/docs/img/jupyter_demo.png
diff --git a/docs/img/request_plus.png b/docs/img/request_plus.png
diff --git a/docs/img/server_options.png b/docs/img/server_options.png
diff --git a/docs/img/signIN.png b/docs/img/signIN.png
diff --git a/docs/img/stop_server.png b/docs/img/stop_server.png
diff --git a/docs/sections/access.md b/docs/sections/access.md
@@ -12,9 +12,37 @@ myst:
       ```{figure} ../img/iam.png
       :width: 400px
       ```
+      
     key4: |
       ```{figure} ../img/request.png
       ```
+
+    key5: |
+      ```{figure} ../img/IAM_registration.png
+      ```
+    
+    key6: |
+      ```{figure} ../img/jupyter_demo.png
+      ```  
+
+    key7: |
+      ```{figure} ../img/request_plus.png
+      ``` 
+
+    key8: |
+      ```{figure} ../img/server_options.png
+      ``` 
+
+    key9: |
+      ```{figure} ../img/signIN.png
+      ``` 
+
+    key10: |
+      ```{figure} ../img/stop_server.png
+      ``` 
+
+
+
 ---
 
 # Resource Access
@@ -27,11 +55,72 @@ Before accessing the hub itself, an authentication step is needed, relying on an
 ## Account Requests
 If the user doesn't already have an account, please use the same authentication page available at the following link: https://iam-demo.cloud.cnaf.infn.it/
 
-|            |                       |
-| ---------- | --------------------- |
-| {{ key3 }} | {{ key2 }} {{ key4 }} |
+|            |              |
+| ---------- | ------------ |
+| {{ key3 }} | {{ key9}}    |
+
+
+By clicking on "Sign in with OAuth 2.0", you will be redirected to the login [page](https://iam-demo.cloud.cnaf.infn.it/)
+
+For first time access:
+1. Apply for a new account by clicking on the green "Apply for an account" button (see fig.1);
+1. The page will redirect you to a form to be filled in (fig.2). You can use "spoke2 tests" as motivation;
+1. Click on "Register" and wait for the confirmation email to the address indicated in the form and click on the URL in the email to confirm;
+1. After the first confirmation, the account activation process will start. At the end of this process, you'll receive a second email to confirm the username and to set the password;
+1. When you access the new page, you will have to join the "highrate" group.
+
+
+Your account is now ready to use.
+
+|            | 
+| ---------- | 
+| {{ key5 }} | 
+
+
+Once the account creation process is complete, you will receive an email containing a confirmation URL within a few moments.
+Upon clicking the URL, you will need to wait for the account activation by the admins. You will receive further communication via email (this may take longer than the initial email), confirming your username and providing a URL for setting the password.
+Upon accessing the new page, you will need to join the "highrate" group.
+
+
+|            | 
+| ---------- | 
+| {{ key7 }} | 
+
+
+
+
+Once joined to the group (which should be visible in the "Groups" section), through the URL provided, https://hub.192.135.24.49.myip.cloud.infn.it
+you will gain access to the resources of the INFN cloud. Specifically, you can choose from the dropdown menu:
+- The Operating System image to be used
+   - Alma8-0.0.34 + python3.11 + Dask
+   - Alma8-0.0.40 + python3.11 + Dask + ROOT 6.30
+- The required number of cores
+   - 1, 2, 4 o 8
+- The required memory capacity
+   - 2, 4, 8, 16
+
+
+
+|            | 
+| ---------- | 
+| {{ key8 }} | 
+
+
+Wait for the server startup and access JupyterHub.
+
+
+|            | 
+| ---------- | 
+| {{ key6 }} | 
+
+
+Careful: Currently, each user is allocated 10 GB of persistent storage upon account creation. All files must be saved within the "persistent-storage" directory, otherwise they will be lost upon resource release
+
+To release the resources, simply click on "File - Hub Control Panel" and then click on "Stop My Server".
+
+
 
-A short video of the entire procedure is available [here](https://drive.google.com/file/d/1xe7JnEDpsPZBlCtI_krstdwg1aNZ4Xkf/view?usp=sharing)
+* A short video of the entire procedure is available [here](https://drive.google.com/file/d/1xe7JnEDpsPZBlCtI_krstdwg1aNZ4Xkf/view?usp=sharing)*
 
 ## Configuration
 Once logged-in, the user has to choose an image to be loaded on the cluster. Choosing a custom image is an option, however some ready-to-use images are available:

diff --git a/docs/sections/usage.md b/docs/sections/usage.md
@@ -5,7 +5,7 @@ These repository will converge into https://github.com/ICSC-Spoke2-repo/HighRate
 
 Some examples are available at the following links:
 - CMS Open Data, VBS-like selection: https://github.com/ttedeschi/WP5-examples/tree/main
-- Future Colliders, FCCee: https://github.com/adonofri/INFN\_na\_interactive\_analysis/tree/main
+- Future Colliders, FCCee: https://github.com/adonofri/INFN_na_interactive_analysis
 
 Additional information may be added here, if needed.