Skip to content

Commit 275a621

Browse files
sarahmaddoxk8s-ci-robot
authored andcommitted
Updated Kubernetes version and clarifed version requirements. (kubeflow#984)
1 parent 934792f commit 275a621

File tree

2 files changed

+25
-13
lines changed

2 files changed

+25
-13
lines changed

content/docs/started/getting-started.md

+24-12
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,29 @@ weight = 1
88

99
This document provides information about setting up Kubeflow in various environments.
1010

11-
Before you set up Kubeflow, it's important to have some knowledge of the following systems and tools:
11+
It's important that you have some knowledge of the following systems and tools:
1212

1313
* [Kubernetes](https://kubernetes.io/docs/tutorials/kubernetes-basics/)
1414
* [TensorFlow](https://www.tensorflow.org/get_started/)
1515
* [kustomize](https://kustomize.io/)
1616

1717
### Kubeflow requirements
1818

19-
* kustomize version {{% kustomize-min-version %}} or later. See the
20-
[kustomize component guide](https://github.com/kubeflow/manifests#using-kustomize) for details about
21-
installing kustomize.
22-
* An existing Kubernetes cluster using Kubernetes version
23-
{{% kubernetes-min-version %}} or later:
19+
Before installing Kubeflow, ensure that your environment meets the
20+
following requirements:
2421

25-
* A minimum of 0.6 CPU in cluster (Reserved for 3 replicated ambassador pods and according to your need add additional CPUs)
26-
* Node with storage >= 10 GB (Due to the ML libraries and third party packages being bundled in Kubeflow Docker images)
22+
* You need kustomize version {{% kustomize-min-version %}} or later. See the
23+
[kustomize component guide](/docs/components/misc/kustomize/)
24+
for details about installing kustomize.
25+
26+
* If you intend to install Kubeflow on an existing Kubernetes cluster, the
27+
cluster must meet the following requirements:
28+
29+
* Kubernetes version {{% kubernetes-min-version %}} or later.
30+
* A minimum of 0.6 CPU in cluster. (Reserved for 3 replicated ambassador pods
31+
and according to your needs add additional CPUs.)
32+
* Node with storage >= 10 GB. (Due to the ML libraries and third party packages
33+
bundled in the Kubeflow Docker images.)
2734

2835
## Get your machine-learning workflow up and running on Kubeflow
2936

@@ -88,12 +95,17 @@ to suit your environment (cloud, on premises (on prem), or local):
8895

8996
## Installing command line tools
9097

91-
* Download the `kfctl` command line interface from the
92-
[Kubeflow releases page](https://github.com/kubeflow/kubeflow/releases/).
98+
The following information is useful if you need or prefer to use command line
99+
tools for deploying and managing Kubeflow:
93100

94-
* Follow the `kubectl` installation and setup from the [Kubernetes documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
101+
* Download the `kfctl` binary from the
102+
[Kubeflow releases page](https://github.com/kubeflow/kubeflow/releases/).
95103

96-
* Download the `kustomize` command line interface from the [kustomize release page](https://github.com/kubernetes-sigs/kustomize/releases/).
104+
* Follow the `kubectl` installation and setup from the [Kubernetes
105+
documentation](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
106+
As described in the Kubernetes documentation, your kubectl
107+
version must be within one minor version of the Kubernetes version that you
108+
use in your Kubeflow cluster.
97109

98110
## Troubleshooting
99111

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1.8
1+
1.11

0 commit comments

Comments
 (0)