Merge branch 'main' into klwuibm-patch-1

Author: chcost

deploy/ibm_cloud_code_engine/README.md

@@ -51,7 +51,8 @@ export NAMESPACE=<namespace from above>
 
 Update With the following command you can download a basic Ray cluster definition and customize it for your namespace:
 ```shell
-sed "s/NAMESPACE/$NAMESPACE/" > ./example-cluster.yaml
+cd ./deploy/ibm_cloud_code_engine/
+sed "s/NAMESPACE/$NAMESPACE/" ./example-cluster.yaml.template > ./example-cluster.yaml
 ```
 
 This reference deployment file will create a Ray cluster with following characteristics:

deploy/ibm_cloud_code_engine/example-cluster.yaml renamed to deploy/ibm_cloud_code_engine/example-cluster.yaml.template

@@ -26,7 +26,7 @@ provider:
     use_internal_ips: true
 
     # Namespace to use for all resources created.
-    namespace:  
+    namespace: NAMESPACE 
 
     services:
       # Service that maps to the head node of the Ray cluster.
@@ -120,7 +120,7 @@ available_node_types:
       spec:
         # Change this if you altered the autoscaler_service_account above
         # or want to provide your own.
-        serviceAccountName: ap9fjwkf04j-writer
+        serviceAccountName: NAMESPACE-writer
 
         restartPolicy: Never
 

docs/source/getting_started/starting.md

@@ -71,7 +71,8 @@ export NAMESPACE=<namespace from above>
 
 Update With the following command you can download a basic Ray cluster definition and customize it for your namespace:
 ```shell
-sed "s/NAMESPACE/$NAMESPACE/" > ./example-cluster.yaml
+cd ./deploy/ibm_cloud_code_engine/
+sed "s/NAMESPACE/$NAMESPACE/" ./example-cluster.yaml.template > ./example-cluster.yaml
 ```
 
 This reference deployment file will create a Ray cluster with following characteristics:
@@ -163,17 +164,16 @@ pip3 install -r requirements.txt
    Assuming openshift cluster access from pre-reqs.
 
    a) Create namespace
-    
-       ```
+      ```shell
        $ oc create namespace codefalre
        namespace/codeflare created
        $
-       ```
-   
+      ```
+
    b) Bring up Ray cluster  
-   
-        ```
-        $ ray up ray/python/ray/autoscaler/kubernetes/example-full.yaml
+
+    ```
+      $ ray up ray/python/ray/autoscaler/kubernetes/example-full.yaml
         Cluster: default
 
         Checking Kubernetes environment settings
@@ -247,8 +247,8 @@ pip3 install -r requirements.txt
           Connect to a terminal on the cluster head:
             ray attach /Users/darroyo/git_workspaces/github.com/ray-project/ray/python/ray/autoscaler/kubernetes/example-full.yaml
           Get a remote shell to the cluster manually:
-            kubectl -n ray exec -it ray-head-ql46b -- bash
-        ```
+            kubectl -n ray exec -it ray-head-ql46b -- bash  
+      ```
 
 3. Verify  
    a) Check for head node
@@ -262,7 +262,7 @@ pip3 install -r requirements.txt
    b) Run example test
 
     ```
-    ray submit python/ray/autoscaler/kubernetes/example-full.yaml x.py 
+    ray submit ray/python/ray/autoscaler/kubernetes/example-full.yaml x.py 
     Loaded cached provider configuration
     If you experience issues with the cloud provider, try re-running the command with --no-config-cache.
     2021-02-09 08:50:51,028	INFO command_runner.py:171 -- NodeUpdater: ray-head-ql46b: Running kubectl -n ray exec -it ray-head-ql46b -- bash --login -c -i 'true && source ~/.bashrc && export OMP_NUM_THREADS=1 PYTHONWARNINGS=ignore && (python ~/x.py)'
@@ -276,4 +276,4 @@ Jupyter setup demo [Reference repository](https://github.com/erikerlandson/ray-o
 
 ### Running examples
 
-Once in a Jupyer envrionment, refer to [notebooks](../../notebooks) for example pipeline. Documentation for reference use cases can be found in [Examples](https://codeflare.readthedocs.io/en/latest/).
+Once in a Jupyer envrionment, refer to [notebooks](../../notebooks) for example pipeline. Documentation for reference use cases can be found in [Examples](https://codeflare.readthedocs.io/en/latest/).