Skip to content

Commit

Permalink
Change Kubeflow Distributions Table (#3693)
Browse files Browse the repository at this point in the history
* Change Kubeflow Distributions Table

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Add links for all dist

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Explain what is All Certified Kubernetes Distributions

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Move Kubeflow Version to 2nd Column

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Fix order for Argoflow

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Remove ArgoFlow and Arrikto Distribution

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Add CSS Style

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Add link to Canonical release notes

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Add notice about bug reports

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Move explanation for distributions

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Fix @liuqi GitHub handler

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Order table: Maintainer, Kubeflow Version, Target Platform

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Add Distribution Name for Red Hat

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Update OWNERS files

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

* Change style for distribution name

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>

---------

Signed-off-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
  • Loading branch information
andreyvelich authored Mar 13, 2024
1 parent ff6336d commit 7d85e6e
Show file tree
Hide file tree
Showing 13 changed files with 117 additions and 124 deletions.
8 changes: 8 additions & 0 deletions assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,14 @@ footer {
}
}

// --------------------------------------------------
// Installing Kubeflow page
// --------------------------------------------------
.distributions-table thead {
background-color: $primary;
color: $secondary;
}

// --------------------------------------------------
// 404 page
// --------------------------------------------------
Expand Down
217 changes: 94 additions & 123 deletions content/en/docs/started/installing-kubeflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,243 +5,214 @@ 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 <a href="/docs/started/architecture/">Kubeflow Architecture</a> page.

### How to install Kubeflow?
Learn more about Kubeflow in 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) <sup>(for advanced users)</sup>
1. [**Packaged Distributions**](#packaged-distributions-of-kubeflow)
1. [**Raw Manifests**](#raw-kubeflow-manifests) <sup>(advanced users)</sup>

<a id="packaged-distributions"></a>
<a id="install-a-packaged-kubeflow-distribution"></a>
## Packaged Distributions of Kubeflow

## Packaged Distributions of Kubeflow

Packaged distributions are maintained by various organizations and typically aim to provide
a simplified installation and management experience for Kubeflow. Some distributions can be
deployed on [all certified Kubernetes distributions](https://kubernetes.io/partners/#conformance),
while others target a specific platform (e.g. EKS or GKE).

{{% alert title="Note" color="warning" %}}
Packaged distributions are developed and supported by their respective maintainers, <b>the Kubeflow community does not endorse or certify any specific distribution</b>.
Packaged distributions are developed and supported by their respective maintainers.
The Kubeflow community <strong>does not endorse or certify</strong> any specific distribution.

In the near future, there are plans to introduce <a href="https://github.com/kubeflow/community/blob/master/proposals/kubeflow-conformance-program-proposal.md">conformance testing for distributions</a>, you may track progress on this initiative by following <a href="https://github.com/kubeflow/kubeflow/issues/6485">kubeflow/kubeflow#6485</a>.
{{% /alert %}}

### Active Distributions

The following table lists <b>active distributions</b> that have <b>had a recent release</b> (within the last 6 months).
The following table lists distributions which are <em>maintained</em> by their respective maintainers:

<div class="table-responsive">
<div class="table-responsive distributions-table">
<table class="table table-bordered">
<thead class="thead-light">
<thead>
<tr>
<th>Name</th>
<th>Maintainer</th>
<th>Maintainer
<br><small>Distribution Name</small>
</th>
<th>Kubeflow Version</th>
<th>Target Platform</th>
<th>Link</th>
<th>Kubeflow Version</th>
</tr>
</thead>
<tbody>
<tr>
<td>Kubeflow on AWS</td>
<td>Amazon Web Services</td>
<td>
Amazon Elastic Kubernetes Service (EKS)
</td>
<td>
<a href="https://awslabs.github.io/kubeflow-manifests">Website</a>
Amazon Web Services
</td>
<td>
{{% aws/latest-version %}} <sup>[<a href="https://github.com/awslabs/kubeflow-manifests/releases">Release Notes</a>]</sup>
</td>
</tr>
<tr>
<td>Kubeflow on Azure</td>
<td>Microsoft Azure</td>
<td>
Azure Kubernetes Service (AKS)
</td>
<td>
<a href="https://azure.github.io/kubeflow-aks/main">Website</a>
Amazon Elastic Kubernetes Service (EKS)
</td>
<td>
1.7.0 <sup>[<a href="https://github.com/Azure/kubeflow-aks/releases/tag/v1.7.0">Release Notes</a>]</sup>
<a href="https://awslabs.github.io/kubeflow-manifests">Website</a>
</td>
</tr>
<tr>
<tr>
<td>Kubeflow on Google Cloud</td>
<td>Google Cloud</td>
<td>
Google Kubernetes Engine (GKE)
Aranui Solutions
<br><small>deployKF</small>
</td>
<td>
<a href="https://googlecloudplatform.github.io/kubeflow-gke-docs">Website</a>
{{% deploykf/latest-version %}} <sup>[<a href="https://www.deploykf.org/releases/version-matrix/#kubeflow-tools">Version Matrix</a>]</sup>
</td>
<td>
All Certified Kubernetes Distributions
</td>
<td>
1.8.0 <sup>[<a href="https://googlecloudplatform.github.io/kubeflow-gke-docs/docs/changelog/#180">Release Notes</a>]</sup>
<a href="https://www.deploykf.org/">Website</a>
</td>
</tr>
<tr>
<td>Kubeflow on IBM Cloud</td>
<td>IBM Cloud</td>
<td>
IBM Cloud Kubernetes Service (IKS)
Canonical
<br><small>Charmed Kubeflow</small>
</td>
<td>
<a href="https://ibm.github.io/manifests/">Website</a>
{{% canonical/latest-version %}} <sup>[<a href="https://charmed-kubeflow.io/docs/release-notes">Release Notes</a>]</sup>
</td>
<td>
{{% iks/latest-version %}} <sup>[<a href="https://github.com/IBM/manifests/releases/tag/v{{% iks/latest-version %}}">Release Notes</a>]</sup>
All Certified Kubernetes Distributions
</td>
<td>
<a href="https://charmed-kubeflow.io/">Website</a>
</td>
</tr>
<tr>
<td>Kubeflow on Nutanix</td>
<td>Nutanix</td>
<td>
Nutanix Kubernetes Engine
Google Cloud
</td>
<td>
<a href="https://nutanix.github.io/kubeflow-manifests">Website</a>
{{% gke/latest-version %}} <sup>[<a href="https://googlecloudplatform.github.io/kubeflow-gke-docs/docs/changelog/">Release Notes</a>]</sup>
</td>
<td>
{{% nutanix/latest-version %}}
Google Kubernetes Engine (GKE)
</td>
<td>
<a href="https://googlecloudplatform.github.io/kubeflow-gke-docs">Website</a>
</td>
</tr>
<tr>
<td>Charmed Kubeflow</td>
<td>Canonical</td>
<td>
All Certified Kubernetes Distributions <sup>[<a href="https://kubernetes.io/partners/#conformance">1</a>]</sup>
IBM Cloud
</td>
<td>
<a href="https://charmed-kubeflow.io/">Website</a>
{{% iks/latest-version %}} <sup>[<a href="https://github.com/IBM/manifests/releases/tag/v{{% iks/latest-version %}}">Release Notes</a>]</sup>
</td>
<td>
IBM Cloud Kubernetes Service (IKS)
</td>
<td>
1.8.0
<a href="https://ibm.github.io/manifests/">Website</a>
</td>
</tr>
<tr>
<td>deployKF</td>
<td>Aranui Solutions</td>
<td>
All Certified Kubernetes Distributions <sup>[<a href="https://kubernetes.io/partners/#conformance">1</a>]</sup>
Microsoft Azure
</td>
<td>
<a href="https://www.deploykf.org/">Website</a>
{{% azure/latest-version %}} <sup>[<a href="https://github.com/Azure/kubeflow-aks/releases/tag/v{{% azure/latest-version %}}">Release Notes</a>]</sup>
</td>
<td>
1.7.0 <sup>[<a href="https://www.deploykf.org/releases/version-matrix/#kubeflow-tools">Version Matrix</a>]</sup>
Azure Kubernetes Service (AKS)
</td>
<td>
<a href="https://azure.github.io/kubeflow-aks/main">Website</a>
</td>
</tr>
<tr>
<td>Kubeflow on Oracle Container Engine for Kubernetes</td>
<td>Oracle</td>
<td>
Oracle Container Engine for Kubernetes (OKE)
Nutanix
</td>
<td>
<a href="https://github.com/oracle-devrel/kubeflow-oke">Website</a>
{{% nutanix/latest-version %}}
</td>
<td>
1.6.0
</td>
</tr>
<tr>
<td>Kubeflow on vSphere</td>
<td>VMware</td>
<td>VMware vSphere</td>
<td>
<a href="https://vmware.github.io/vSphere-machine-learning-extension/">Website</a>
Nutanix Kubernetes Engine
</td>
<td>
1.6.1
<a href="https://nutanix.github.io/kubeflow-manifests">Website</a>
</td>
</tr>
</tbody>
</table>
</div>

### Legacy Distributions

The following table lists <b>legacy distributions</b> which have <b>not had a recent release</b> (within the last 6 months).

<div class="table-responsive">
<table class="table table-bordered">
<thead class="thead-light">
<tr>
<th>Name</th>
<th>Maintainer</th>
<th>Target Platform</th>
<th>Link</th>
<th>Latest Release</th>
</tr>
</thead>
<tbody>
<tr>
<td>Argoflow</td>
<td>Argoflow Users</td>
<td>
All Certified Kubernetes Distributions <sup>[<a href="https://kubernetes.io/partners/#conformance">1</a>]</sup>
</td>
<td>
<a href="https://github.com/argoflow">Website</a>
Red Hat
<br><small>Open Data Hub</small>
</td>
<td>
1.3.0
{{% redhat/latest-version %}}
</td>
</tr>
<tr>
<td>Kubeflow on OpenShift</td>
<td>Red Hat</td>
<td>
OpenShift
</td>
<td>
<a href="https://github.com/opendatahub-io/manifests">Website</a>
</td>
<td>
1.6.0
</td>
</tr>
<tr>
<td>Arrikto Enterprise Kubeflow</td>
<td>Arrikto</td>
<td>
◦ Amazon Elastic Kubernetes Service (EKS)
<br>
◦ Azure Kubernetes Service (AKS)
<br>
◦ Google Kubernetes Engine (GKE)
VMware
</td>
<td>
<a href="https://www.arrikto.com/enterprise-kubeflow/">Website</a>
{{% vmware/latest-version %}}
</td>
<td>
1.5.0 <sup>[<a href="https://docs.arrikto.com/Changelog.html">Release Notes</a>]</sup>
VMware vSphere
</td>
<td>
<a href="https://vmware.github.io/vSphere-machine-learning-extension/">Website</a>
</td>
</tr>
</tbody>
</table>
</div>

<a id="manifests"></a>
<a id="install-the-kubeflow-manifests-manually"></a>
## 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**.

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) <sup>(development branch)</sup>
- [`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) <sup>(development branch)</sup>
- [`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).
Nevertheless, we welcome contributions and bug reports very much.
{{% /alert %}}

The raw <a href="https://github.com/kubeflow/manifests">Kubeflow manifests</a> are aggregated by the <a href="https://github.com/kubeflow/community/tree/master/wg-manifests">Manifests Working Group</a>
and are intended to be used as the base of packaged distributions,
<b>advanced users may choose to install the manifests directly</b> by following <a href="https://github.com/kubeflow/manifests#installation">these instructions</a>.

<a id="next-steps"></a>

## Next steps

* Review the Kubeflow <a href="/docs/components/">component documentation</a>
* Explore the <a href="/docs/components/pipelines/sdk/">Kubeflow Pipelines SDK</a>
- Review the Kubeflow <a href="/docs/components/">component documentation</a>
- Explore the <a href="/docs/components/pipelines/sdk/">Kubeflow Pipelines SDK</a>
1 change: 1 addition & 0 deletions layouts/shortcodes/azure/latest-version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.7.0
2 changes: 2 additions & 0 deletions layouts/shortcodes/canonical/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
approvers:
- ca-scribner
1 change: 1 addition & 0 deletions layouts/shortcodes/canonical/latest-version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.8.0
2 changes: 2 additions & 0 deletions layouts/shortcodes/deploykf/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
approvers:
- thesuperzapper
1 change: 1 addition & 0 deletions layouts/shortcodes/deploykf/latest-version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.7.0
1 change: 0 additions & 1 deletion layouts/shortcodes/iks/latest-branch.html

This file was deleted.

1 change: 1 addition & 0 deletions layouts/shortcodes/oracle/latest-version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.6.0
2 changes: 2 additions & 0 deletions layouts/shortcodes/redhat/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
approvers:
- rimolive
1 change: 1 addition & 0 deletions layouts/shortcodes/redhat/latest-version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.6.0
3 changes: 3 additions & 0 deletions layouts/shortcodes/vmware/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
approvers:
- liuqi
- xujinheng
1 change: 1 addition & 0 deletions layouts/shortcodes/vmware/latest-version.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.6.1

0 comments on commit 7d85e6e

Please sign in to comment.