Skip to content

feat: add single Codeflare entrypoint with handler pattern and remove legacy auth #1091

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
szaher wants to merge 11 commits into
base: main
Choose a base branch
from
Open

feat: add single Codeflare entrypoint with handler pattern and remove legacy auth #1091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
dfa530f
docs: add single entrypoint design spec for Codeflare class
szaher May 15, 2026
3ecf4f0
feat: add SDKConfig dataclass with validation
szaher May 15, 2026
72b6365
feat: add Codeflare class with kube-authkit authentication
szaher May 15, 2026
1bfbb15
feat: add ClusterHandler with create/get/list/list_queued
szaher May 15, 2026
6772c26
feat: add JobHandler with submit/create
szaher May 15, 2026
58c3a16
refactor: remove legacy auth classes from auth.py
szaher May 15, 2026
2e6eddd
refactor: update exports — add Codeflare/SDKConfig, remove legacy auth
szaher May 15, 2026
d0f4ada
test: update auth tests — remove legacy class tests, keep config/cert…
szaher May 15, 2026
023ff49
test: add import removal tests and verify full suite passes
szaher May 15, 2026
bf52fd7
fix: address code review findings — consistent namespace fallback, cl…
szaher May 15, 2026
7fc63d9
add example guided demo
szaher May 18, 2026
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
9 changes: 4 additions & 5 deletions demo-notebooks/additional-demos/hf_interactive.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@
"outputs": [],
"source": [
"# Import pieces from codeflare-sdk\n",
"from codeflare_sdk import Cluster, ClusterConfiguration, set_api_client\n",
"from kube_authkit import AuthConfig, get_k8s_client"
"from codeflare_sdk import Codeflare, SDKConfig, Cluster, ClusterConfiguration\n",
"from kube_authkit import AuthConfig"
]
},
{
Expand All @@ -60,7 +60,7 @@
"# auth_config = AuthConfig(method=\"auto\")\n",
"\n",
"# Option 2 (Recommended for RHOAI Workbenches): Token-based authentication\n",
"# Get your token with: oc whoami -t (or from the OpenShift console → Copy login command)\n",
"# Get your token with: oc whoami -t (or from the OpenShift console \u2192 Copy login command)\n",
"auth_config = AuthConfig(\n",
" method=\"openshift\",\n",
" k8s_api_host=\"https://api.example.com:6443\",\n",
Expand All @@ -76,8 +76,7 @@
"# use_device_flow=True, # Interactive device flow for notebook environments\n",
"# )\n",
"\n",
"api_client = get_k8s_client(config=auth_config)\n",
"set_api_client(api_client)"
"cf = Codeflare(config=SDKConfig(auth=auth_config))\n"
]
},
{
Expand Down
9 changes: 4 additions & 5 deletions demo-notebooks/additional-demos/local_interactive.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"outputs": [],
"source": [
"# Import pieces from codeflare-sdk\n",
"from codeflare_sdk import Cluster, ClusterConfiguration, set_api_client\n",
"from kube_authkit import AuthConfig, get_k8s_client"
"from codeflare_sdk import Codeflare, SDKConfig, Cluster, ClusterConfiguration\n",
"from kube_authkit import AuthConfig"
]
},
{
Expand All @@ -30,7 +30,7 @@
"# auth_config = AuthConfig(method=\"auto\")\n",
"\n",
"# Option 2 (Recommended for RHOAI Workbenches): Token-based authentication\n",
"# Get your token with: oc whoami -t (or from the OpenShift console → Copy login command)\n",
"# Get your token with: oc whoami -t (or from the OpenShift console \u2192 Copy login command)\n",
"auth_config = AuthConfig(\n",
" method=\"openshift\",\n",
" k8s_api_host=\"https://api.example.com:6443\",\n",
Expand All @@ -46,8 +46,7 @@
"# use_device_flow=True, # Interactive device flow for notebook environments\n",
"# )\n",
"\n",
"api_client = get_k8s_client(config=auth_config)\n",
"set_api_client(api_client)"
"cf = Codeflare(config=SDKConfig(auth=auth_config))\n"
]
},
{
Expand Down
9 changes: 4 additions & 5 deletions demo-notebooks/additional-demos/ray_job_client.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"outputs": [],
"source": [
"# Import pieces from codeflare-sdk\n",
"from codeflare_sdk import Cluster, ClusterConfiguration, RayJobClient, set_api_client\n",
"from kube_authkit import AuthConfig, get_k8s_client"
"from codeflare_sdk import Codeflare, SDKConfig, Cluster, ClusterConfiguration, RayJobClient\n",
"from kube_authkit import AuthConfig"
]
},
{
Expand All @@ -33,7 +33,7 @@
"# auth_config = AuthConfig(method=\"auto\")\n",
"\n",
"# Option 2 (Recommended for RHOAI Workbenches): Token-based authentication\n",
"# Get your token with: oc whoami -t (or from the OpenShift console → Copy login command)\n",
"# Get your token with: oc whoami -t (or from the OpenShift console \u2192 Copy login command)\n",
"# Note: auth_token is also used below as the bearer token for the RayJobClient\n",
"auth_token = \"sha256~XXXXX\" # oc whoami -t\n",
"auth_config = AuthConfig(\n",
Expand All @@ -52,8 +52,7 @@
"# )\n",
"# auth_token = ... # Retrieve access token from your OIDC provider for RayJobClient\n",
"\n",
"api_client = get_k8s_client(config=auth_config)\n",
"set_api_client(api_client)"
"cf = Codeflare(config=SDKConfig(auth=auth_config))\n"
]
},
{
Expand Down
9 changes: 4 additions & 5 deletions demo-notebooks/guided-demos/0_basic_ray.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
"outputs": [],
"source": [
"# Import pieces from codeflare-sdk\n",
"from codeflare_sdk import Cluster, ClusterConfiguration, set_api_client\n",
"from kube_authkit import AuthConfig, get_k8s_client"
"from codeflare_sdk import Codeflare, SDKConfig, Cluster, ClusterConfiguration\n",
"from kube_authkit import AuthConfig"
]
},
{
Expand All @@ -39,7 +39,7 @@
"# auth_config = AuthConfig(method=\"auto\")\n",
"\n",
"# Option 2 (Recommended for RHOAI Workbenches): Token-based authentication\n",
"# Get your token with: oc whoami -t (or from the OpenShift console → Copy login command)\n",
"# Get your token with: oc whoami -t (or from the OpenShift console \u2192 Copy login command)\n",
"auth_config = AuthConfig(\n",
" method=\"openshift\",\n",
" k8s_api_host=\"https://api.example.com:6443\",\n",
Expand All @@ -55,8 +55,7 @@
"# use_device_flow=True, # Interactive device flow for notebook environments\n",
"# )\n",
"\n",
"api_client = get_k8s_client(config=auth_config)\n",
"set_api_client(api_client)"
"cf = Codeflare(config=SDKConfig(auth=auth_config))\n"
]
},
{
Expand Down
9 changes: 4 additions & 5 deletions demo-notebooks/guided-demos/1_cluster_job_client.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"outputs": [],
"source": [
"# Import pieces from codeflare-sdk\n",
"from codeflare_sdk import Cluster, ClusterConfiguration, set_api_client\n",
"from kube_authkit import AuthConfig, get_k8s_client"
"from codeflare_sdk import Codeflare, SDKConfig, Cluster, ClusterConfiguration\n",
"from kube_authkit import AuthConfig"
]
},
{
Expand All @@ -33,7 +33,7 @@
"# auth_config = AuthConfig(method=\"auto\")\n",
"\n",
"# Option 2 (Recommended for RHOAI Workbenches): Token-based authentication\n",
"# Get your token with: oc whoami -t (or from the OpenShift console → Copy login command)\n",
"# Get your token with: oc whoami -t (or from the OpenShift console \u2192 Copy login command)\n",
"auth_config = AuthConfig(\n",
" method=\"openshift\",\n",
" k8s_api_host=\"https://api.example.com:6443\",\n",
Expand All @@ -49,8 +49,7 @@
"# use_device_flow=True, # Interactive device flow for notebook environments\n",
"# )\n",
"\n",
"api_client = get_k8s_client(config=auth_config)\n",
"set_api_client(api_client)"
"cf = Codeflare(config=SDKConfig(auth=auth_config))\n"
]
},
{
Expand Down
9 changes: 4 additions & 5 deletions demo-notebooks/guided-demos/2_basic_interactive.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
"outputs": [],
"source": [
"# Import pieces from codeflare-sdk\n",
"from codeflare_sdk import Cluster, ClusterConfiguration, set_api_client\n",
"from kube_authkit import AuthConfig, get_k8s_client"
"from codeflare_sdk import Codeflare, SDKConfig, Cluster, ClusterConfiguration\n",
"from kube_authkit import AuthConfig"
]
},
{
Expand All @@ -36,7 +36,7 @@
"# auth_config = AuthConfig(method=\"auto\")\n",
"\n",
"# Option 2 (Recommended for RHOAI Workbenches): Token-based authentication\n",
"# Get your token with: oc whoami -t (or from the OpenShift console → Copy login command)\n",
"# Get your token with: oc whoami -t (or from the OpenShift console \u2192 Copy login command)\n",
"auth_config = AuthConfig(\n",
" method=\"openshift\",\n",
" k8s_api_host=\"https://api.example.com:6443\",\n",
Expand All @@ -52,8 +52,7 @@
"# use_device_flow=True, # Interactive device flow for notebook environments\n",
"# )\n",
"\n",
"api_client = get_k8s_client(config=auth_config)\n",
"set_api_client(api_client)"
"cf = Codeflare(config=SDKConfig(auth=auth_config))\n"
]
},
{
Expand Down
9 changes: 4 additions & 5 deletions demo-notebooks/guided-demos/3_widget_example.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
"outputs": [],
"source": [
"# Import pieces from codeflare-sdk\n",
"from codeflare_sdk import Cluster, ClusterConfiguration, view_clusters, set_api_client\n",
"from kube_authkit import AuthConfig, get_k8s_client"
"from codeflare_sdk import Codeflare, SDKConfig, Cluster, ClusterConfiguration, view_clusters\n",
"from kube_authkit import AuthConfig"
]
},
{
Expand All @@ -39,7 +39,7 @@
"# auth_config = AuthConfig(method=\"auto\")\n",
"\n",
"# Option 2 (Recommended for RHOAI Workbenches): Token-based authentication\n",
"# Get your token with: oc whoami -t (or from the OpenShift console → Copy login command)\n",
"# Get your token with: oc whoami -t (or from the OpenShift console \u2192 Copy login command)\n",
"auth_config = AuthConfig(\n",
" method=\"openshift\",\n",
" k8s_api_host=\"https://api.example.com:6443\",\n",
Expand All @@ -55,8 +55,7 @@
"# use_device_flow=True, # Interactive device flow for notebook environments\n",
"# )\n",
"\n",
"api_client = get_k8s_client(config=auth_config)\n",
"set_api_client(api_client)"
"cf = Codeflare(config=SDKConfig(auth=auth_config))\n"
]
},
{
Expand Down
Loading
Loading