https://github.com/oracle-devrel/kubeflow-oke
Kubeflow on OKE
https://github.com/oracle-devrel/kubeflow-oke
Last synced: about 3 hours ago
JSON representation
Kubeflow on OKE
- Host: GitHub
- URL: https://github.com/oracle-devrel/kubeflow-oke
- Owner: oracle-devrel
- License: upl-1.0
- Created: 2022-08-26T08:40:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-21T20:33:08.000Z (over 1 year ago)
- Last Synced: 2026-06-24T11:36:12.614Z (about 14 hours ago)
- Language: Jupyter Notebook
- Size: 3.49 MB
- Stars: 7
- Watchers: 5
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Security: SECURITY.md
Awesome Lists containing this project
README
# Kubeflow on Oracle Container Engine for Kubernetes (OKE)
[uri-Kubernetes]: https://Kubernetes.io/
[uri-oci]: https://cloud.oracle.com/cloud-infrastructure
[uri-oracle]: https://www.oracle.com
[](https://img.shields.io/badge/license-UPL-green) [](https://sonarcloud.io/dashboard?id=oracle-devrel_kubeflow-oke)
## Introduction
Oracle Container Engine for Kubernetes (OKE) is the [Oracle][uri-oracle]-managed [Kubernetes][uri-Kubernetes] service on [Oracle Cloud Infrastructure (OCI)][uri-oci].
In this demo, we will show how to create a Kubernetes cluster, and install Kubeflow within it.
Kubeflow is an open-source platform for machine learning and MLOps on Kubernetes introduced by Google. The different stages in a typical machine learning lifecycle are represented with different software components in Kubeflow, including model development, model training, model serving, and automated machine learning.
Once we have Kubeflow installed, we'll use it to create a **Jupyter notebook environment** so you can have your own self-hosted Jupyter environment to run GPU and High-Performance Computing (HPC) workloads seamlessly.
To run our demo's workflow, we will use the [Cloud Shell](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/devcloudshellintro.htm) built into the Oracle Cloud Console but can also be run from your local workstation.
[You can watch the solution's video here.](https://youtu.be/Cc90XzwZ3fQ)
## 0. Prerequisites & Docs
### Prerequisites
- An Oracle Cloud Infrastructure (OCI) Account
- The tenancy shall have access to NVIDIA A10 Tensor Core GPU(s). Although it's not compulsory (you could run Kubeflow on CPU), launching this AI workload will work best with GPUs.
This guide can be run in many different ways, but in all cases, you will need to be signed into your Oracle Cloud Infrastructure tenancy.
### Docs
[Kubeflow](https://www.kubeflow.org/)
[Cloud Shell](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/devcloudshellintro.htm)
## 1. Create an OKE cluster
## Before getting Started
> ⚠️ Kubeflow 1.5.0 is not compatible with Kubernetes version 1.22 and onwards. To install Kubeflow 1.5.0 or older, set the Kubernetes version of your OKE cluster to v1.21.5.
We will install Kubeflow *1.8.1* on OKE using Kubernetes versions *1.29.1* and onwards running on Oracle Linux 8.
### Recommendation
Suppose you provision an OKE cluster manually or deploy with your own terraform. In that case, you must turn off the OKE in-transit encryption option and apply the cloud-init script to enable Istio.
## Getting Started
This section describes how to:
- Create a Kubernetes cluster using OKE and [The Terraform OKE Module](https://github.com/oracle-terraform-modules/terraform-oci-oke)
- Accessing OKE
- Installing Kubeflow and how to expose the Kubeflow Dashboard
1. Launch an OCI Cloud Shell instance within your OCI tenancy. Once you're inside, let's clone this repository to get access to the resources available:
```bash
git clone https://github.com/oracle-devrel/kubeflow-oke.git
```
2. To Create a Kubernetes cluster clone [The Terraform OKE Module](https://github.com/oracle-terraform-modules/terraform-oci-oke) repository to deploy OKE Cluster
```bash
git clone https://github.com/oracle-terraform-modules/terraform-oci-oke.git
```
3. Obtain the OCIDs we will need for the next step:
```bash
echo $OCI_TENANCY
echo $OCI_REGION
echo $OCI_COMPARTMENT
```
4. Edit the `kubeflow-oke/terraform.tfvars.example` file. We need to set 4 variables: the compartment and tenancy OCIDs, your home region (see [all region identifiers here](https://docs.oracle.com/en-us/iaas/Content/General/Concepts/regions.htm)) and the region identifier where you want to deploy Kubeflow. From here, you can also review other settings, including security settings around control plane access, bastions and operators. If needed, change the Kubernetes version to match the version supported by the Kubeflow version you are installing. Consider the node pool setup and if you want to use the cluster autoscaler.
Review the number of nodes in each node pool, in this example we are using three node pools.
- **System** for running system processes, e.g. *Prometheus* server.
- **App** for running actual applications, e.g. the kubeflow runtime.
- **Processing** for executing your actual analysis in, if you want this to auto scale set `autoscale` to `True` and modify `max_node_pool_size` to meet your needs.
5. Copy the `terraform.tfvars.example` as `terraform.tfvars` in terraform-oci-oke folder.
6. Copy the `provider.tf` in terraform-oci-oke folder.
7. If you aren't running this installation in your OCI Cloud Shell instance, you will need to configure OCI's security credentials for Terraform. **From terraform-oci-oke folder** init Terraform:
```bash
terraform init
```
8. Plan the deployment, and let's save the plan to a file:
```bash
terraform plan --out=kubeflow.plan
```
9. Apply the deployment (run the script):
```bash
terraform apply kubeflow.plan
```
Now you need to follow the OCI Kubernetes Environment instructions for getting your Kubernetes config information and adding it to your local kubeconfig.
## 2. Access your OKE cluster
1. Click Access Cluster on the `Cluster details` page:
2. You can either choose to run Kubernetes on the Cloud Shell (easiest) or on your own machine. It's recommended to use Cloud Shell, as otherwise you'd need to install OCI CLI and authenticate yourself. Accept the default Cloud Shell Access and click Copy to copy the `oci ce cluster create-kubeconfig ...` command.
3. To access the cluster, paste the command into your Cloud Shell session and hit Enter.
4. Verify that the `kubectl` is working by using the `get nodes` command:
```bash
kubectl get nodes
```
5. Repeat this command multiple times until all three nodes show `Ready` in the `STATUS` column:
When all three nodes are `Ready`, your OKE installation has finished successfully.
## 3. Install Kubeflow
Now that the cluster is ready, we can begin to install Kubeflow within the OKE cluster.
0. If you're running in a Compute Instance and not Cloud Shell, you will need to install `Kustomize`:
```bash
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | bash
```
1. Let's run the `install-kubeflow.sh` script in the kubeflow-oke folder to set up the version of `kustomise` and specify which `kubeflow` branch to use:
```bash
./install-kubeflow.sh
```
2. The script output will provide you with the URL, login and password to access Kubeflow console.
3. Your kubeflow dashboard is at `https://`. Login as `user@example.com`:
```bash
This is your kubeflow password for user user@example.com:
xxxxxx
```
4. (Optional) To destroy, you must remove the non-Terraform constructed OCI resources, specifically the Istio gateway load balancer. The easiest way here is to remove the service:
```bash
kubectl delete service istio-ingressgateway -n istio-system
```
## Contributing
This project welcomes contributions from the community. Before submitting a pull
request, please [review our contribution guide](./CONTRIBUTING.md).
## Security
Please consult the [security guide](./SECURITY.md) for our responsible security
vulnerability disclosure process.
## License
Copyright (c) 2024 Oracle and/or its affiliates.
Licensed under the Universal Permissive License (UPL), Version 1.0.
See [LICENSE](LICENSE.txt) for more details.
ORACLE AND ITS AFFILIATES DO NOT PROVIDE ANY WARRANTY WHATSOEVER, EXPRESS OR IMPLIED, FOR ANY SOFTWARE, MATERIAL OR CONTENT OF ANY KIND CONTAINED OR PRODUCED WITHIN THIS REPOSITORY, AND IN PARTICULAR SPECIFICALLY DISCLAIM ANY AND ALL IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. FURTHERMORE, ORACLE AND ITS AFFILIATES DO NOT REPRESENT THAT ANY CUSTOMARY SECURITY REVIEW HAS BEEN PERFORMED WITH RESPECT TO ANY SOFTWARE, MATERIAL OR CONTENT CONTAINED OR PRODUCED WITHIN THIS REPOSITORY. IN ADDITION, AND WITHOUT LIMITING THE FOREGOING, THIRD PARTIES MAY HAVE POSTED SOFTWARE, MATERIAL OR CONTENT TO THIS REPOSITORY WITHOUT ANY REVIEW. USE AT YOUR OWN RISK.