-
Notifications
You must be signed in to change notification settings - Fork 773
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
Restructured Getting Started Section #888
Changes from all commits
e8ee271
d4688f2
bfcea67
4f042d4
75994d5
0b102bc
2359590
9efa3b3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,3 +3,25 @@ title = "Getting Started" | |
description = "How to get started using Kubeflow." | ||
weight = 20 | ||
+++ | ||
|
||
The guides in this section give detailed information about using Kubeflow and | ||
its components. | ||
|
||
For best understanding of the guides, it's useful to have some knowledge of | ||
the following systems: | ||
|
||
* [Kubernetes](https://kubernetes.io/docs/tutorials/kubernetes-basics/) | ||
* [TensorFlow](https://www.tensorflow.org/get_started/) | ||
* [ksonnet](https://ksonnet.io/docs/tutorial) | ||
|
||
##### Kubeflow requirements | ||
|
||
* ksonnet version {{% ksonnet-min-version %}} or later. See the | ||
[ksonnet component guide](/docs/components/ksonnet/) for details about | ||
installing ksonnet. | ||
* An existing Kubernetes cluster using Kubernetes version | ||
{{% kubernetes-min-version %}} or later: | ||
|
||
* A minimum of 0.6 CPU in cluster (Reserved for 3 replicated ambassador pods and according to your need add additional CPUs) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do these general requirements hold for most use cases? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as previous comment. I'm not sure, but I wanted to focus on restructuring existing content rather than verifying its accuracy |
||
* Node with storage >= 10 GB (Due to the ML libraries and third party packages being bundled in Kubeflow Docker images) | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
+++ | ||
title = "Cloud Installation" | ||
description = "Get started with Kubeflow on a cloud provider" | ||
weight = 1 | ||
+++ |
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
+++ | ||
title = "Local Installation" | ||
description = "Get started with Kubeflow on local hardware" | ||
weight = 1 | ||
+++ | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should these be characterized as Local Virtual Machines? |
||
* [MiniKF](/docs/started/local/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. | ||
* MiniKF runs on all major operating systems (Linux, macOS, Windows). | ||
|
||
* [Minikube](/docs/started/local/getting-started-minikube/) | ||
* 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 installed. | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. microk8s will work on any linux system, local or in the cloud. Addtionally, with the advent of WSL2 on Windows, it'll work on Windows too. In the context of local, this will work without a virtual machine. I can make this edit afterwards or as part of this submission. Preference? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. After discussing this with Sarah, I'm closing this PR for now. Please give your input on how best to restructure the Getting Started guide here: #889 |
||
* [MicroK8s](/docs/started/local/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. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
+++ | ||
title = "On-Prem Installation" | ||
description = "Get started with Kubeflow On-Prem" | ||
weight = 1 | ||
+++ |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is
ksonnet
still a requirement?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not, but I wanted to focus this PR on moving the existing docs around instead of making sure all the content in them is up to date. I believe there are some others working on removing ksonnet from the docs, and I don't want to duplicate their efforts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The removal of ksonnet from this page has already happened:
https://www.kubeflow.org/docs/started/requirements/
The above page is the source of the content that this PR moves to a different page. This is one of the reasons for the merge conflict that GitHub is reporting. Please would you do a careful sync and merge. :)