diff --git a/docs/safe-haven-services/tre-gpu-service/faq.md b/docs/safe-haven-services/shs-gpu-cluster/faq.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/faq.md rename to docs/safe-haven-services/shs-gpu-cluster/faq.md diff --git a/docs/safe-haven-services/tre-gpu-service/index.md b/docs/safe-haven-services/shs-gpu-cluster/index.md similarity index 89% rename from docs/safe-haven-services/tre-gpu-service/index.md rename to docs/safe-haven-services/shs-gpu-cluster/index.md index 262fe9745..d442308f2 100644 --- a/docs/safe-haven-services/tre-gpu-service/index.md +++ b/docs/safe-haven-services/shs-gpu-cluster/index.md @@ -109,11 +109,11 @@ This tutorial teaches users how to submit tasks to the SHS GPU Cluster. It assum | Lesson | Objective | |-----------------------------------|-------------------------------------| | [Getting started with Kubernetes](training/L1_getting_started.md) | a. What is Kubernetes?
b. How to send a task to a GPU node.
c. How to define the GPU resources needed. | -| [Building and Testing Containers](training/L1.1_building-and-testing-containers.md) | a. How to build container images.
b. How to test containers locally.
c. Best practices for container setup. | -| [Using Containers in the SHS](training/L2_using-containers-in-the-tre.md) | a. How to run containers inside the SHS.
b. Security considerations for SHS containers.
c. How to manage container dependencies. | -| [Creating Your First Pod Template](training/L2.1_creating-your-first-pod-template.md) | a. What is a Kubernetes pod template.
b. How to define pod resources.
c. How to submit a pod to the GPU cluster. | -| [Accessing the BeeGFS Inside the SHS _GPU Cluster_](training/L3_Accessing_the_BeeGFS_Inside_the_EPCC_TRE.md) | a. How to access BeeGFS from the SHS _GPU Cluster_.
b. How to read/write data efficiently.
c. Best practices for using shared storage. | -| [Requesting Persistent Volumes](training/L4_requesting_persistent_volumes.md) | a. How pods use persistent storage (Persistent Volumes and Persistent Volume Claims).
b. How SHS _GPU Cluster_ users access pre-provisioned storage via Persistent Volume Claims.
c. How to attach Persistent Volume Claims to pods using volumeMounts and proper securityContext. | +| [Building and Testing Containers](training/L2_building_and_testing_containers.md) | a. How to build container images.
b. How to test containers locally.
c. Best practices for container setup. | +| [Using Containers in the SHS](training/L3_using_containers_in_the_shs.md) | a. How to run containers inside the SHS.
b. Security considerations for SHS containers.
c. How to manage container dependencies. | +| [Creating Your First Pod Template](training/L4_creating_your_first_pod_template.md) | a. What is a Kubernetes pod template.
b. How to define pod resources.
c. How to submit a pod to the GPU cluster. | +| [Accessing the BeeGFS Inside the SHS _GPU Cluster_](training/L5_accessing_the_beegfs_inside_the_epcc_shs.md) | a. How to access BeeGFS from the SHS _GPU Cluster_.
b. How to read/write data efficiently.
c. Best practices for using shared storage. | +| [Requesting Persistent Volumes](training/L6_requesting_persistent_volumes.md) | a. How pods use persistent storage (Persistent Volumes and Persistent Volume Claims).
b. How SHS _GPU Cluster_ users access pre-provisioned storage via Persistent Volume Claims.
c. How to attach Persistent Volume Claims to pods using volumeMounts and proper securityContext. | ## Further Reading and Help diff --git a/docs/safe-haven-services/tre-gpu-service/kueue.md b/docs/safe-haven-services/shs-gpu-cluster/kueue.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/kueue.md rename to docs/safe-haven-services/shs-gpu-cluster/kueue.md diff --git a/docs/safe-haven-services/tre-gpu-service/policies.md b/docs/safe-haven-services/shs-gpu-cluster/policies.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/policies.md rename to docs/safe-haven-services/shs-gpu-cluster/policies.md diff --git a/docs/safe-haven-services/tre-gpu-service/training/L1_getting_started.md b/docs/safe-haven-services/shs-gpu-cluster/training/L1_getting_started.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/training/L1_getting_started.md rename to docs/safe-haven-services/shs-gpu-cluster/training/L1_getting_started.md diff --git a/docs/safe-haven-services/tre-gpu-service/training/L1.1_building-and-testing-containers.md b/docs/safe-haven-services/shs-gpu-cluster/training/L2_building_and_testing_containers.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/training/L1.1_building-and-testing-containers.md rename to docs/safe-haven-services/shs-gpu-cluster/training/L2_building_and_testing_containers.md diff --git a/docs/safe-haven-services/tre-gpu-service/training/L2_using-containers-in-the-tre.md b/docs/safe-haven-services/shs-gpu-cluster/training/L3_using_containers_in_the_shs.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/training/L2_using-containers-in-the-tre.md rename to docs/safe-haven-services/shs-gpu-cluster/training/L3_using_containers_in_the_shs.md diff --git a/docs/safe-haven-services/tre-gpu-service/training/L2.1_creating-your-first-pod-template.md b/docs/safe-haven-services/shs-gpu-cluster/training/L4_creating_your_first_pod_template.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/training/L2.1_creating-your-first-pod-template.md rename to docs/safe-haven-services/shs-gpu-cluster/training/L4_creating_your_first_pod_template.md diff --git a/docs/safe-haven-services/tre-gpu-service/training/L3_Accessing_the_BeeGFS_Inside_the_EPCC_TRE.md b/docs/safe-haven-services/shs-gpu-cluster/training/L5_accessing_the_beegfs_inside_the_epcc_shs.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/training/L3_Accessing_the_BeeGFS_Inside_the_EPCC_TRE.md rename to docs/safe-haven-services/shs-gpu-cluster/training/L5_accessing_the_beegfs_inside_the_epcc_shs.md diff --git a/docs/safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md b/docs/safe-haven-services/shs-gpu-cluster/training/L6_requesting_persistent_volumes.md similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md rename to docs/safe-haven-services/shs-gpu-cluster/training/L6_requesting_persistent_volumes.md diff --git a/docs/safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md b/docs/safe-haven-services/shs-gpu-cluster/training/L7_running_a_pytorch_task.md similarity index 99% rename from docs/safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md rename to docs/safe-haven-services/shs-gpu-cluster/training/L7_running_a_pytorch_task.md index 086a0c6b8..5eb1f987a 100644 --- a/docs/safe-haven-services/tre-gpu-service/training/L5_running_a_pytorch_task.md +++ b/docs/safe-haven-services/shs-gpu-cluster/training/L7_running_a_pytorch_task.md @@ -2,7 +2,7 @@ ## Requirements -It is recommended that users complete [Getting started with Kubernetes](./L1_getting_started.md) and [Requesting persistent volumes With Kubernetes](./L4_requesting_persistent_volumes.md) before proceeding with this tutorial. +It is recommended that users complete [Getting started with Kubernetes](./L1_getting_started.md) and [Requesting persistent volumes With Kubernetes](./L6_requesting_persistent_volumes.md) before proceeding with this tutorial. ## Overview diff --git a/docs/safe-haven-services/tre-gpu-service/training/L6_template_workflow.md b/docs/safe-haven-services/shs-gpu-cluster/training/L8_template_workflow.md similarity index 99% rename from docs/safe-haven-services/tre-gpu-service/training/L6_template_workflow.md rename to docs/safe-haven-services/shs-gpu-cluster/training/L8_template_workflow.md index 96b8460db..9833a5770 100644 --- a/docs/safe-haven-services/tre-gpu-service/training/L6_template_workflow.md +++ b/docs/safe-haven-services/shs-gpu-cluster/training/L8_template_workflow.md @@ -2,7 +2,7 @@ ## Requirements -It is recommended that users complete [Getting started with Kubernetes](./L1_getting_started.md) and [Requesting persistent volumes With Kubernetes](./L4_requesting_persistent_volumes.md) before proceeding with this tutorial. +It is recommended that users complete [Getting started with Kubernetes](./L1_getting_started.md) and [Requesting persistent volumes With Kubernetes](./L6_requesting_persistent_volumes.md) before proceeding with this tutorial. ## Overview @@ -32,7 +32,7 @@ The SHS GPU Cluster contains GPUs with 40Gb/80Gb of on board memory and it is ex Persistent volume claims need to be of sufficient size to hold the input data, any expected output data and a small amount of additional empty space to facilitate IO. -Read the [requesting persistent volumes with Kubernetes](L4_requesting_persistent_volumes.md) lesson to learn how to request and mount persistent volumes to pods. +Read the [requesting persistent volumes with Kubernetes](L6_requesting_persistent_volumes.md) lesson to learn how to request and mount persistent volumes to pods. It often takes several hours or days to download data sets of 1/2 TB or more to a persistent volume. diff --git a/docs/safe-haven-services/tre-gpu-service/training/resources/example_pytorch_code.py b/docs/safe-haven-services/shs-gpu-cluster/training/resources/example_pytorch_code.py similarity index 100% rename from docs/safe-haven-services/tre-gpu-service/training/resources/example_pytorch_code.py rename to docs/safe-haven-services/shs-gpu-cluster/training/resources/example_pytorch_code.py diff --git a/mkdocs.yml b/mkdocs.yml index b747694d4..2a99c5997 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -127,21 +127,18 @@ nav: - "Development Workflow": safe-haven-services/shs-container-user-guide/development-workflow.md - "Workflow Examples": safe-haven-services/shs-container-user-guide/workflow-examples.md - "Container Examples": safe-haven-services/shs-container-user-guide/container-examples.md - # TRE GPU service docs can be uncommented and added to - # the navigation menu when the TRE GPU service is made - # available to TRE tenants. See Umair Ayub and Kostas for details. - # - "TRE GPU Service": - # - "Overview": safe-haven-services/tre-gpu-service/index.md - # - "Policies": safe-haven-services/tre-gpu-service/policies.md - # - "Kueue": safe-haven-services/tre-gpu-service/kueue.md - # - "Tutorials": - # - "Getting Started": safe-haven-services/tre-gpu-service/training/L1_getting_started.md - # - "Building and Pushing Containers to GHCR": safe-haven-services/tre-gpu-service/training/L1.1_building-and-testing-containers.md - # - "Downloading Containers in the TRE GPU Cluster": safe-haven-services/tre-gpu-service/training/L2_using-containers-in-the-tre.md - # - "Creating your first pod template within a job yaml file": safe-haven-services/tre-gpu-service/training/L2.1_creating-your-first-pod-template.md - # - "Transfer Data Inside the TRE GPU Cluster": safe-haven-services/tre-gpu-service/training/L3_Accessing_the_BeeGFS_Inside_the_EPCC_TRE.md - # - "Persistent Volumes": safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md - # - "GPU Service FAQ": safe-haven-services/tre-gpu-service/faq.md + - "SHS GPU Cluster": + - "Overview": safe-haven-services/shs-gpu-cluster/index.md + - "Policies": safe-haven-services/shs-gpu-cluster/policies.md + - "Kueue": safe-haven-services/shs-gpu-cluster/kueue.md + - "Tutorials": + - "Getting Started": safe-haven-services/shs-gpu-cluster/training/L1_getting_started.md + - "Building and Pushing Containers to GHCR": safe-haven-services/shs-gpu-cluster/training/L2_building_and_testing_containers.md + - "Downloading Containers in the SHS GPU Cluster": safe-haven-services/shs-gpu-cluster/training/L3_using_containers_in_the_shs.md + - "Creating your first pod template within a job yaml file": safe-haven-services/shs-gpu-cluster/training/L4_creating_your_first_pod_template.md + - "Transfer Data Inside the SHS GPU Cluster": safe-haven-services/shs-gpu-cluster/training/L5_accessing_the_beegfs_inside_the_epcc_shs.md + - "Persistent Volumes": safe-haven-services/shs-gpu-cluster/training/L6_requesting_persistent_volumes.md + - "SHS GPU Cluster FAQ": safe-haven-services/shs-gpu-cluster/faq.md # Application Services (Open OnDemand) docs can be uncommented # and added to the navigation menu when the service is made # available to safe haven users. See MikeJ for details.