-
Notifications
You must be signed in to change notification settings - Fork 773
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixing doc for KF installation on existing clusters (#977)
* Fixing doc for existing clusters * Update authentication.md * Update getting-started-k8s.md * Update getting-started-k8s.md * Address review comments * Minor changes * Address review comments * Address review comments * Minor title change * Fix path
- Loading branch information
1 parent
63b34cb
commit 70bda37
Showing
5 changed files
with
160 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| +++ | ||
| title = "Kubeflow on Existing Kubernetes Clusters" | ||
| description = "Instructions for installing Kubeflow on your existing clusters" | ||
| weight = 2 | ||
| +++ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| +++ | ||
| title = "Kubeflow Deployment with kfctl_k8s_istio" | ||
| description = "Instructions for installing Kubeflow on your existing Kubernetes cluster using kfctl_k8s_istio config" | ||
| weight = 2 | ||
| +++ | ||
|
|
||
| This config creates a vanilla deployment of Kubeflow with all its core components without any external dependencies. The deployment can be customized based on your environment needs. | ||
|
|
||
| **Maintainer and supporter: Kubeflow community** | ||
|
|
||
| ### Deploy Kubeflow | ||
|
|
||
| Follow these steps to deploy Kubeflow: | ||
|
|
||
| 1. Download a `kfctl` release from the [Kubeflow releases page](https://github.com/kubeflow/kubeflow/releases/) and unpack it: | ||
|
|
||
| ``` | ||
| tar -xvf kfctl_<release tag>_<platform>.tar.gz | ||
| ``` | ||
|
|
||
| 1. Run the following commands to set up and deploy Kubeflow. The code below includes an optional command to add the binary `kfctl` to your path. If you don't add the binary to your path, you must use the full path to the `kfctl` binary each time you run it. | ||
|
|
||
| ```bash | ||
| # Add kfctl to PATH, to make the kfctl binary easier to use. | ||
| export PATH=$PATH:"<path to kfctl>" | ||
| export KFAPP="<your choice of application directory name>" | ||
| # Installs istio by default. Comment out istio components in the config file to skip istio installation. See https://github.com/kubeflow/kubeflow/pull/3663 | ||
| export CONFIG="https://raw.githubusercontent.com/kubeflow/kubeflow/master/bootstrap/config/kfctl_k8s_istio.yaml" | ||
|
|
||
| kfctl init ${KFAPP} --config=${CONFIG} -V | ||
| cd ${KFAPP} | ||
| kfctl generate all -V | ||
| kfctl apply all -V | ||
| ``` | ||
|
|
||
| * **${KFAPP}** - the _name_ of a directory where you want Kubeflow | ||
| configurations to be stored. This directory is created when you run | ||
| `kfctl init`. If you want a custom deployment name, specify that name here. | ||
| The value of this variable becomes the name of your deployment. | ||
| The value of this variable cannot be greater than 25 characters. It must | ||
| contain just the directory name, not the full path to the directory. | ||
| The content of this directory is described in the next section. | ||
|
|
||
|
|
||
| Check the resources deployed in namespace `kubeflow`: | ||
|
|
||
| ``` | ||
| kubectl -n kubeflow get all | ||
|
|
||
| ``` | ||
|
|
||
| ### Access Kubeflow Dashboard | ||
|
|
||
| Once Kubeflow is deployed, the Kubeflow Dashboard can be accessed via `istio-ingressgateway` service. If loadbalancer is not available in your environment, NodePort or Port forwarding can be used to access the Kubeflow Dashboard.Refer [Ingress Gateway guide](https://istio.io/docs/tasks/traffic-management/ingress/ingress-control/). | ||
|
|
||
| ### Delete Kubeflow | ||
|
|
||
| Run the following commands to delete your deployment and reclaim all resources: | ||
|
|
||
| ```bash | ||
| cd ${KFAPP} | ||
| # If you want to delete all the resources, run: | ||
| kfctl delete all -V | ||
| ``` | ||
|
|
||
| ### Understanding the deployment process | ||
|
|
||
| The deployment process is controlled by 4 different commands: | ||
|
|
||
| * **init** - one time set up. | ||
| * **generate** - creates config files defining the various resources. | ||
| * **apply** - creates or updates the resources. | ||
| * **delete** - deletes the resources. | ||
|
|
||
| With the exception of `init`, all commands take an argument which describes the | ||
| set of resources to apply the command to; this argument can be one of the | ||
| following: | ||
|
|
||
| * **k8s** - all resources that run on Kubernetes. | ||
| * **all** - platform and Kubernetes resources. | ||
|
|
||
| #### App layout | ||
|
|
||
| Your Kubeflow app directory contains the following files and directories: | ||
|
|
||
| * **${KFAPP}/app.yaml** defines configurations related to your Kubeflow deployment. | ||
| * **${KFAPP}/kustomize**: contains the YAML manifests that will be deployed. | ||
|
|
||
| ### Next steps | ||
|
|
||
| * Run a [sample machine learning workflow](/docs/examples/resources/). | ||
| * Get started with [Kubeflow Pipelines](/docs/pipelines/pipelines-quickstart/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| +++ | ||
| title = "Deploying Kubeflow on Existing Clusters" | ||
| description = "Instructions for installing Kubeflow on your existing Kubernetes cluster with list of supported options" | ||
| weight = 1 | ||
| +++ | ||
|
|
||
| Follow these instructions if you want to install Kubeflow on an existing Kubernetes cluster. | ||
|
|
||
| If you are using a Kubernetes distribution or Cloud Provider which has specific instructions for installing Kubeflow we recommend following those instructions. Those instructions do additional Cloud specific setup to create a really great Kubeflow experience. | ||
|
|
||
| The following table lists the options for installing Kubeflow on an existing Kubernetes Cluster and links to detailed instructions. | ||
|
|
||
| ### Community maintained | ||
|
|
||
| This section includes vendor-neutral solutions governed by community consensus. Below deployment configs are maintained and supported by the community. | ||
|
|
||
| <div class="table-responsive"> | ||
| <table class="table table-bordered"> | ||
| <thead class="thead-light"> | ||
| <tr> | ||
| <th>Deployment config</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>kfctl_k8s_istio.yaml</td> | ||
| <td> This config creates a vanilla deployment of Kubeflow with all its core components without any external dependencies. The deployment can be customized based on your environment needs. <br />Follow instructions: <a href="/docs/started/k8s/kfctl-k8s-istio/">Kubeflow Deployment with kfctl_k8s_istio</a></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
|
|
||
| ### Vendor maintained | ||
|
|
||
| This section includes the deployment solutions that are supported by specific vendors/providers. | ||
|
|
||
| <div class="table-responsive"> | ||
| <table class="table table-bordered"> | ||
| <thead class="thead-light"> | ||
| <tr> | ||
| <th>Deployment config</th> | ||
| <th>Description</th> | ||
| <th>Maintainer/Supporter</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td>existing_arrikto.yaml</td> | ||
| <td> This deployment uses Dex and Istio for vendor-neutral authentication. <br />Follow instructions: <a href="/docs/started/k8s/kfctl-existing-arrikto/">Kubeflow Deployment with existing_arrikto</a></td> | ||
| <td><a href="https://www.arrikto.com/">Arrikto</a></td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> |