Skip to content
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.

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

refactor "Installing Kubeflow" page #2611

Merged
165 changes: 0 additions & 165 deletions content/en/docs/started/getting-started.md

This file was deleted.

118 changes: 118 additions & 0 deletions content/en/docs/started/installing-kubeflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
+++
title = "Installing Kubeflow"
rui-vas marked this conversation as resolved.
Show resolved Hide resolved
description = "Overview of installation choices for Kubeflow"
weight = 20

+++

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/kubeflow-overview/">Kubeflow Overview</a> page.

There are two pathways to get up and running with Kubeflow, you may either:
1. Use a [packaged distribution](#packaged-distributions)
1. Use the [manifests](#manifests) (advanced)

<a id="packaged-distributions"></a>
## Packaged distributions

{{% alert color="warning" %}}
Packaged distributions are developed and supported by their respective maintainers, the Kubeflow community does not currently endorse or certify any distribution.
{{% /alert %}}

<b>See the table below for a list of options and links to documentation:</b>

thesuperzapper marked this conversation as resolved.
Show resolved Hide resolved
thesuperzapper marked this conversation as resolved.
Show resolved Hide resolved
<div class="table-responsive">
<table class="table table-bordered">
<thead class="thead-light">
<tr>
<th>Name</th>
<th>Maintainer</th>
<th>Platform</th>
<th>Link - Docs</th>
<th>Link - External Website</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="/docs/distributions/aws/">Docs</a></td>
<td></td>
</tr>
<tr>
<td>Kubeflow on Azure</td>
<td>Microsoft Azure</td>
<td>Azure Kubernetes Service (AKS)</td>
<td><a href="/docs/distributions/azure/">Docs</a></td>
<td></td>
</tr>
<tr>
<td>Kubeflow on GCP</td>
<td>Google Cloud</td>
Bobgy marked this conversation as resolved.
Show resolved Hide resolved
<td>Google Kubernetes Engine (GKE)</td>
<td><a href="/docs/distributions/gke/">Docs</a></td>
<td></td>
</tr>
<tr>
<td>Kubeflow on IBM Cloud</td>
<td>IBM Cloud</td>
<td>IBM Cloud Kubernetes Service (IKS) </td>
<td><a href="/docs/distributions/ibm/">Docs</a></td>
<td></td>
</tr>
<tr>
<td>Kubeflow on OpenShift</td>
<td>IBM Cloud</td>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Red Hat

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, this distribution is maintained by IBM Cloud, (not RedHat) @animeshsingh can verify.

<td>OpenShift</td>
<td><a href="/docs/distributions/openshift/">Docs</a></td>
<td></td>
</tr>
<tr>
<td>Argoflow</td>
<td>Argoflow Community</td>
<td>Conformant Kubernetes</td>
<td>N/A</td>
<td><a href="https://github.com/argoflow/argoflow">External Website</a></td>
</tr>
<tr>
<td>Arrikto MiniKF</td>
<td>Arrikto</td>
<td>AWS Marketplace, GCP Marketplace, Vagrant</td>
<td><a href="/docs/distributions/minikf/">Docs</a></td>
<td></td>
</tr>
<tr>
<td>Charmed Kubeflow</td>
<td>Canonical</td>
<td>Conformant Kubernetes</td>
<td><a href="/docs/distributions/charmed/">Docs</a></td>
<td><a href="https://charmed-kubeflow.io/docs">External Website</a></td>
</tr>
<tr>
<td>MicroK8s Kubeflow Add-on</td>
<td>Canonical</td>
<td>MicroK8s</td>
<td><a href="/docs/distributions/microk8s/">Docs</a></td>
<td><a href="https://microk8s.io/docs/addon-kubeflow">External Website</a></td>
</tr>
</tbody>
rui-vas marked this conversation as resolved.
Show resolved Hide resolved
</table>
</div>

<a id="manifests"></a>
## Manifests

{{% alert color="warning" %}}
This method is for advanced users. The Kubeflow community will not support environment-specific issues. If you need support, please consider using a [packaged distribution](#packaged-distributions) of Kubeflow.
{{% /alert %}}

The <a href="https://github.com/kubeflow/community/tree/master/wg-manifests">Manifests Working Group</a> is responsible for aggregating the authoritative manifests of each official Kubeflow component.
While these manifests are intended to be the base of packaged distributions, advanced users may choose to install them directly 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>