Skip to content

Commit

Permalink
Docs should show how to pull a particular release (kubeflow#524)
Browse files Browse the repository at this point in the history
* Update the docs to explain how to pin to a particular version.

* Create a new commit to see about the presubmits.

* Version needs to be included in the pkg install step.
  • Loading branch information
jlewi authored and k8s-ci-robot committed Apr 2, 2018
1 parent 3e0fd74 commit 9899cc9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 8 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,23 @@ In order to quickly set up all components, execute the following commands:
NAMESPACE=kubeflow
kubectl create namespace ${NAMESPACE}
# Which version of Kubeflow to use
# For a list of releases refer to:
# https://github.com/kubeflow/kubeflow/releases
VERSION=v0.1.0-rc.0
# Initialize a ksonnet app. Set the namespace for it's default environment.
APP_NAME=my-kubeflow
ks init ${APP_NAME}
cd ${APP_NAME}
ks env set default --namespace ${NAMESPACE}
# Install Kubeflow components
ks registry add kubeflow github.com/kubeflow/kubeflow/tree/master/kubeflow
ks pkg install kubeflow/core
ks pkg install kubeflow/tf-serving
ks pkg install kubeflow/tf-job
ks registry add kubeflow github.com/kubeflow/kubeflow/tree/${VERSION}/kubeflow
ks pkg install kubeflow/core@${VERSION}
ks pkg install kubeflow/tf-serving@${VERSION}
ks pkg install kubeflow/tf-job@${VERSION}
# Create templates for core components
ks generate kubeflow-core kubeflow-core
Expand Down
12 changes: 8 additions & 4 deletions user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,15 @@ ks init my-kubeflow
Install the Kubeflow packages into your application.

```
# For a list of releases see:
# https://github.com/kubeflow/kubeflow/releases
VERSION=v0.1.0-rc.0
cd my-kubeflow
ks registry add kubeflow github.com/kubeflow/kubeflow/tree/master/kubeflow
ks pkg install kubeflow/core
ks pkg install kubeflow/tf-serving
ks pkg install kubeflow/tf-job
ks registry add kubeflow github.com/kubeflow/kubeflow/tree/${VERSION}/kubeflow
ks pkg install kubeflow/core@${VERSION}
ks pkg install kubeflow/tf-serving@${VERSION}
ks pkg install kubeflow/tf-job@${VERSION}
```

Create the Kubeflow core component. The core component includes:
Expand Down

0 comments on commit 9899cc9

Please sign in to comment.