diff --git a/assets/scss/_styles_project.scss b/assets/scss/_styles_project.scss index edcb68f258..fb7c333a5b 100644 --- a/assets/scss/_styles_project.scss +++ b/assets/scss/_styles_project.scss @@ -285,6 +285,18 @@ footer { } } +// -------------------------------------------------- +// Installing Kubeflow page +// -------------------------------------------------- +.distributions-table-active thead { + background-color: $primary; + color: $secondary; +} + +.distributions-table-legacy thead { + background-color: $info; +} + // -------------------------------------------------- // 404 page // -------------------------------------------------- diff --git a/content/en/docs/started/installing-kubeflow.md b/content/en/docs/started/installing-kubeflow.md index 2b92081bdf..bd26aac069 100644 --- a/content/en/docs/started/installing-kubeflow.md +++ b/content/en/docs/started/installing-kubeflow.md @@ -5,34 +5,48 @@ weight = 20 +++ +### What is Kubeflow? + Kubeflow is an end-to-end Machine Learning (ML) platform for Kubernetes, it provides components for each stage in the ML lifecycle, from exploration through to training and deployment. Operators can choose what is best for their users, there is no requirement to deploy every component. -To read more about the components and architecture of Kubeflow, please see the Kubeflow Architecture page. + +Learn more about Kubeflow on the [Introduction](/docs/started/introduction/) and [Architecture](/docs/started/architecture/) pages. ### How to install Kubeflow? -There are two pathways to get up and running with Kubeflow, you may either: +Anywhere you are running Kubernetes, you should be able to run Kubeflow. +There are two primary ways to install Kubeflow: -1. [Use a packaged distribution](#packaged-distributions-of-kubeflow) -2. [Use the raw manifests](#raw-kubeflow-manifests) (for advanced users) +1. [__Packaged Distributions__](#packaged-distributions-of-kubeflow) +2. [__Raw Manifests__](#raw-kubeflow-manifests) (advanced users) ## Packaged Distributions of Kubeflow -{{% alert title="Note" color="warning" %}} -Packaged distributions are developed and supported by their respective maintainers, the Kubeflow community does not endorse or certify any specific distribution. +Packaged distributions are maintained by various organizations and typically aim to provide a simplified installation and management experience for Kubeflow. + +{{% alert title="Conformance and Certification" color="warning" %}} +Packaged distributions are developed and supported by their respective maintainers. +The Kubeflow community does not endorse or certify any specific distribution. In the near future, there are plans to introduce conformance testing for distributions, you may track progress on this initiative by following kubeflow/kubeflow#6485. {{% /alert %}} +{{% alert title="Distribution Names" color="info" %}} +Some packaged distributions have names like `Kubeflow on `. +Please note, they are __not__ the only way to use Kubeflow on that platform, it is simply the name of a distribution. + +There are discussions about renaming these distributions to avoid confusion with others that may be available on the same platform. +{{% /alert %}} + ### Active Distributions -The following table lists active distributions that have had a recent release (within the last 6 months). +The following table lists active distributions which are currently maintained by their respective maintainers. -
+
- + @@ -68,7 +82,6 @@ The following table lists active distributions that have had a recent 1.7.0 [Release Notes] - @@ -164,11 +177,11 @@ The following table lists active distributions that have had a recent ### Legacy Distributions -The following table lists legacy distributions which have not had a recent release (within the last 6 months). +The following table lists legacy distributions which have not had a recent release (within the last 6 months), or whose maintainers have indicated that they are no longer actively maintaining the distribution. -
+
Name Maintainer
Kubeflow on Google Cloud Google Cloud
- + @@ -229,17 +242,26 @@ The following table lists legacy distributions which have not had a re ## Raw Kubeflow Manifests +The raw Kubeflow Manifests are aggregated by the [Manifests Working Group](https://github.com/kubeflow/community/tree/master/wg-manifests) +and are intended to be used as the __base of packaged distributions__. + +Very advanced users may choose to install the manifests for a specific Kubeflow version by following the instructions in the `README` of the [`kubeflow/manifests`](https://github.com/kubeflow/manifests) repository. + +- [__Kubeflow 1.8:__](/docs/releases/kubeflow-1.8/) + - [`v1.8-branch`](https://github.com/kubeflow/manifests/tree/v1.8-branch#installation) (development branch) + - [`v1.8.0`](https://github.com/kubeflow/manifests/tree/v1.8.0#installation) +- [__Kubeflow 1.7:__](/docs/releases/kubeflow-1.7/) + - [`v1.7-branch`](https://github.com/kubeflow/manifests/tree/v1.7-branch#installation) (development branch) + - [`v1.7.0`](https://github.com/kubeflow/manifests/tree/v1.7.0#installation) + {{% alert title="Warning" color="warning" %}} -This method is for advanced users. +Kubeflow is a complex system with many components and dependencies. +Using the raw manifests requires a deep understanding of Kubernetes, Istio, and Kubeflow itself. -The Kubeflow community is not able to provide support for environment-specific issues when using the raw manifests. +When using the raw manifests, the Kubeflow community is not able to provide support for environment-specific issues or custom configurations. If you need support, please consider using a [packaged distribution](#packaged-distributions-of-kubeflow). {{% /alert %}} -The raw Kubeflow manifests are aggregated by the Manifests Working Group -and are intended to be used as the base of packaged distributions, -advanced users may choose to install the manifests directly by following these instructions. - ## Next steps
Name Maintainer