Changes based on bootcamp feedback (#36)

* fix: remove comments from code blocks * fix: gpu machineset name pattern to match instructions
redhat-na-ssa · Dec 4, 2024 · 98338f9 · 98338f9
1 parent fecafe2
commit 98338f9
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 13 deletions.
diff --git a/docs/00-prerequisite.md b/docs/00-prerequisite.md
@@ -14,10 +14,8 @@
 - [ ] Git clone this repository
 
 ```sh
-# git clone repo
 git clone https://github.com/redhat-na-ssa/hobbyist-guide-to-rhoai.git
 
-# change into the repo directory
 cd hobbyist-guide-to-rhoai
 ```
 

diff --git a/docs/01-add-administrative-user.md b/docs/01-add-administrative-user.md
@@ -35,7 +35,6 @@ For this bootcamp, we are using HTpasswd as the Identity Provider (IdP). To lear
 
 - [ ] Create an htpasswd using a container on OpenShift
 
-      # using oc to create htpasswd
       oc run \
         --image httpd \
         -q --rm -i minion -- /bin/sh -c 'sleep 2; htpasswd -n -b -B -C10 <username> <password>' > scratch/users.htpasswd

diff --git a/docs/02-enable-gpu-support.md b/docs/02-enable-gpu-support.md
@@ -47,11 +47,12 @@
 
 - [ ] Make a copy of one of the existing compute MachineSet definitions and output the result to a YAML file
 
-      # get your machineset name --no-headers removes the headers from the output. awk '{print $1}'. extracts the first column.
-      # head -n 1 limits the output to the first entry.
+> `--no-headers removes the headers from the output.`  
+> `awk '{print $1}'. extracts the first column.`  
+> `head -n 1 limits the output to the first entry.`
+
       MACHINESET_COPY=$(oc get machinesets -n openshift-machine-api --no-headers | awk '{print $1}' | head -n 1)
 
-      # make a copy of an existing machineset definition
       oc get machineset $MACHINESET_COPY -n openshift-machine-api -o yaml > scratch/machineset.yaml
 
 - [ ] Edit the downloaded machineset.yaml and update the following fields:
@@ -155,7 +156,6 @@
 
 - [ ] Verify the operator is installed and running
 
-      # watch the pods get created in the new project
       oc get pods -n openshift-nfd -w
 
 > Expected output
@@ -281,7 +281,6 @@ Below are some of the [PCI vendor ID assignments](https://pcisig.com/membership/
 
 - [ ] Verify an install plan has been created. Be patient.
 
-      # you can watch the installplan instances get created
       oc get installplan -n nvidia-gpu-operator -w
 
 > Expected output
@@ -365,10 +364,8 @@ Below are some of the [PCI vendor ID assignments](https://pcisig.com/membership/
 
 - [ ] Apply this label to new machines/nodes:
 
-      # set an env value
       MACHINE_SET_TYPE=$(oc -n openshift-machine-api get machinesets.machine.openshift.io -o name | grep gpu | head -n1)
 
-      # patch the machineset
       oc -n openshift-machine-api \
         patch "${MACHINE_SET_TYPE}" \
         --type=merge --patch '{"spec":{"template":{"spec":{"metadata":{"labels":{"node-role.kubernetes.io/gpu":""}}}}}}'

diff --git a/docs/09-configure-distributed-workloads.md b/docs/09-configure-distributed-workloads.md
@@ -101,10 +101,8 @@ In this example, the kueue.x-k8s.io/default-queue: "true" annotation defines thi
 
 - [ ] Apply the configuration to create the local-queue object
 
-      # go to sandbox
       oc project sandbox || oc new-project sandbox
 
-      # create local queue
       oc apply -f configs/09/rhoai-kueue-local-queue.yaml
 
 > Expected output

diff --git a/scripts/library/ocp.sh b/scripts/library/ocp.sh
@@ -232,8 +232,10 @@ ocp_aws_create_gpu_machineset(){
   # 8 x gaudi:  dl1.24xlarge
 
   INSTANCE_TYPE=${1:-g4dn.4xlarge}
+  GPU_INSTANCE_NAME=${2:-cluster-${INSTANCE_TYPE/./-}-gpu}
 
-  ocp_aws_clone_worker_machineset "${INSTANCE_TYPE}"
+  echo "Creating machineset: ${INSTANCE_TYPE} as ${GPU_INSTANCE_NAME}"
+  ocp_aws_clone_worker_machineset "${INSTANCE_TYPE}" "${GPU_INSTANCE_NAME}"
 
   MACHINE_SET_TYPE=$(oc -n openshift-machine-api get machinesets.machine.openshift.io -o name | grep "${INSTANCE_TYPE%.*}" | head -n1)