Skip to content
Permalink
Browse files

Getting-started guide: Linked to AWS docs and did a tech writer review (

#672)

* Getting-started guide: Linked to AWS docs and did a tech writer review.

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review suggestion

Co-Authored-By: sarahmaddox <sarahmaddox@users.noreply.github.com>

* Accepting review changes
  • Loading branch information...
sarahmaddox authored and k8s-ci-robot committed May 2, 2019
1 parent fb6f5da commit 6a18035ae7475a64902e47553f96d4da5b4de996
Showing with 47 additions and 39 deletions.
  1. +47 −39 content/docs/started/getting-started.md
@@ -1,63 +1,71 @@
+++
title = "Getting Started with Kubeflow"
description = "Quickly get running with your ML Workflow"
description = "Get your machine-learning workflow up and running on Kubeflow"
weight = 1
+++

There are a variety of ways to install Kubeflow
There are various ways to install Kubeflow. Choose one of the following options
to suit your environment (cloud, on premises (on prem), or local):

* GCP users should follow the [guide for deploying on GCP](/docs/gke/deploy/)
* On prem users or users with an existing Kubernetes cluster should follow the [guide for deploying on kubernetes](/docs/started/getting-started-k8s/)
* Users who want to run Kubernetes locally in a virtual machine can select one of the following options
* To use Kubeflow on Google Cloud Platform (GCP) and Kubernetes Engine (GKE),
follow the [GCP deployment guide](/docs/gke/deploy/).
* To use Kubeflow on Amazon Web Services (AWS),
follow the [AWS deployment guide](/docs/aws/deploy/).
* If you have an existing Kubernetes cluster or want to use Kubeflow on prem,
follow the [guide to deploying Kubeflow on
Kubernetes](/docs/started/getting-started-k8s/).
* If you want to run Kubernetes locally in a virtual machine (VM), choose one of
the following options:

* [MiniKF setup](/docs/started/getting-started-minikf/)
* MiniKF is a fast and easy way to get started with Kubeflow.
* It installs with just two commands and then you are up for
experimentation, and for running complete Kubeflow Pipelines.
experimentation, and for running complete Kubeflow Pipelines.
* MiniKF runs on all major operating systems (Linux, macOS, Windows).

* [Minikube setup](/docs/started/getting-started-minikube/)
* Minikube leverages virtualization applications like [Virtual
Box](https://www.virtualbox.org/) or [VMware
Fusion](https://www.vmware.com/products/fusion.html) to host the virtual
machine and provides a CLI that can be leveraged outside of the VM.
* Minikube defines a fully baked ISO that contains a minimal operating
system and kubernetes already installed.
* Minikube uses virtualization applications like
[VirtualBox](https://www.virtualbox.org/) or [VMware
Fusion](https://www.vmware.com/products/fusion.html) to host the VM
and provides a CLI that you can use outside the VM.
* Minikube defines a fully-baked
[ISO image](https://en.wikipedia.org/wiki/ISO_image) that contains a
minimal operating system and Kubernetes already installed.
* This option may be useful if you are just starting to learn and already
have one of the virtualization applications already installed.
have one of the virtualization applications installed.

* [Microk8s setup](/docs/started/getting-started-multipass/)
* The benefits of using [Microk8s](https://microk8s.io/) include:
- Can be installed on any Linux system as a
[snap](https://snapcraft.io/)
- Strong isolation and update semantics - your single-node cluster
will be updated within a short period after upstream Kubernetes
releases.
- GPU pass through built in - e.g. **microk8s.enable gpu**
* If you are not on a Linux machine, or you want to use Kubeflow in a
confined environment, then use
[Multipass](https://github.com/CanonicalLtd/multipass) to launch a
virtual machine. Benefits include:
- Ubuntu [cloud-images](http://cloud-images.ubuntu.com/) already
integrated.
- Lightweight hypervisor using native operating system mechanisms
(e.g. [Hypervisor
Framework](https://developer.apple.com/documentation/hypervisor) on
MacOS, [Hyper-V on Windows
10](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v),
QEMU/KVM for linux)
- Eliminates the need to install a separate virtualization
application.
- You can use cloud-init to customize the VM (as you might in a cloud)
* [MicroK8s setup](/docs/started/getting-started-multipass/)
* [MicroK8s](https://microk8s.io/) can provide the following benefits:
- A small, fast, secure, single node Kubernetes installation that installs on any
Linux system as a [snap](https://snapcraft.io/microk8s).
- Strong isolation and update semantics - your cluster
is updated within a short period after upstream Kubernetes
releases.
- Built-in support to enable an installed GPU:
`microk8s.enable gpu`
* MicroK8s requires Linux. If you are not on a Linux machine, or you want
to confine your Kubeflow to a disposable machine, the installation guide
show you how to use
[Multipass](https://github.com/CanonicalLtd/multipass) to launch a VM.
Benefits include:
- [Ubuntu Cloud Images](http://cloud-images.ubuntu.com/) already
integrated.
- Lightweight hypervisor using native operating system mechanisms
(for example, [Hypervisor
Framework](https://developer.apple.com/documentation/hypervisor) on
macOS, [Hyper-V on Windows
10](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v), or
QEMU/KVM for Linux).
- No need to install a separate virtualization application.
- Use of `cloud-init` to customize the VM.

## Troubleshooting

For detailed troubleshooting instructions, please refer to the [troubleshooting
guide](/docs/other-guides/troubleshooting/).
See the [Kubeflow troubleshooting guide](/docs/other-guides/troubleshooting/).

## Resources

* The [documentation](/docs/) provides in-depth instructions for using Kubeflow
* The [documentation](/docs/) provides in-depth instructions for using Kubeflow.
* Self-paced scenarios for learning and trying out Kubeflow:
* [Codelabs](https://codelabs.developers.google.com/?cat=tensorflow)
* [Introduction to Kubeflow on Google Kubernetes

0 comments on commit 6a18035

Please sign in to comment.
You can’t perform that action at this time.