Skip to content

Fix auth guide in notebooks #894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: ray-jobs-feature
Choose a base branch
from
Open

Fix auth guide in notebooks #894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion codecov.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,3 @@ coverage:
default:
target: 85%
threshold: 2.5%

13 changes: 4 additions & 9 deletions demo-notebooks/guided-demos/4_rayjob_existing_cluster.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@
"metadata": {},
"outputs": [],
"source": [
"from codeflare_sdk import Cluster, ClusterConfiguration, RayJob, TokenAuthentication"
"from codeflare_sdk import Cluster, ClusterConfiguration, RayJob"
]
},
{
"cell_type": "markdown",
"id": "649c5911",
"metadata": {},
"source": [
"Execute the below cell to authenticate the notebook via OpenShift."
"Run the below `oc login` command using your Token and Server URL. Ensure the command is prepended by `!` and not `%`. This will work when running both locally and within RHOAI."
]
},
{
Expand All @@ -55,12 +55,7 @@
"metadata": {},
"outputs": [],
"source": [
"auth = TokenAuthentication(\n",
" token = \"XXXXX\",\n",
" server = \"XXXXX\",\n",
" skip_tls=False\n",
")\n",
"auth.login()"
"!oc login --token=<your-token> --server=<your-server-url>"
]
},
{
Expand Down Expand Up @@ -116,7 +111,7 @@
"id": "a0e2a650",
"metadata": {},
"source": [
"## Creating and Submitting the RayJob"
"## Submitting the RayJob"
]
},
{
Expand Down
26 changes: 6 additions & 20 deletions ...d-demos/5_rayjob_lifecycled_cluster.ipynb → ...oks/guided-demos/5_submit_rayjob_cr.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"id": "9259e514",
"metadata": {},
"source": [
"# Submitting a RayJob which lifecycles its own RayCluster\n",
"# Submitting a RayJob CR\n",
"\n",
"In this notebook, we will go through the basics of using the SDK to:\n",
" * Define a RayCluster configuration\n",
Expand All @@ -18,14 +18,7 @@
"id": "18136ea7",
"metadata": {},
"source": [
"## Defining and Submitting the RayJob"
]
},
{
"cell_type": "markdown",
"id": "a1c2545d",
"metadata": {},
"source": [
"## Defining and Submitting the RayJob\n",
"First, we'll need to import the relevant CodeFlare SDK packages. You can do this by executing the below cell."
]
},
Expand All @@ -36,17 +29,15 @@
"metadata": {},
"outputs": [],
"source": [
"from codeflare_sdk import RayJob, ManagedClusterConfig, TokenAuthentication"
"from codeflare_sdk import RayJob, ManagedClusterConfig"
]
},
{
"cell_type": "markdown",
"id": "649c5911",
"metadata": {},
"source": [
"Execute the below cell to authenticate the notebook via OpenShift.\n",
"\n",
"**TODO: Add guide to authenticate locally.**"
"Run the below `oc login` command using your Token and Server URL. Ensure the command is prepended by `!` and not `%`. This will work when running both locally and within RHOAI."
]
},
{
Expand All @@ -56,12 +47,7 @@
"metadata": {},
"outputs": [],
"source": [
"auth = TokenAuthentication(\n",
" token = \"XXXXX\",\n",
" server = \"XXXXX\",\n",
" skip_tls=False\n",
")\n",
"auth.login()"
"!oc login --token=<your-token> --server=<your-server-url>"
]
},
{
Expand Down Expand Up @@ -120,7 +106,7 @@
"id": "f3612de2",
"metadata": {},
"source": [
"We can check the status of our cluster by executing the below cell. If it's not up immediately, run the cell a few more times until you see that it's in a 'running' state."
"We can check the status of our job by executing the below cell. The status may appear as `unknown` for a time while the RayCluster spins up."
]
},
{
Expand Down
Loading