-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Peter MacKinnon
committed
May 24, 2018
1 parent
31023ab
commit da36990
Showing
63 changed files
with
10,260 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,6 @@ | ||
# pkg and bin directories currently contain build artifacts | ||
# only so we exclude them. | ||
bin/ | ||
vendor/ | ||
|
||
.vscode/ | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
<!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* | ||
|
||
- [core](#core) | ||
- [Quickstart](#quickstart) | ||
- [Using the library](#using-the-library) | ||
- [io.ksonnet.pkg.kubeflow-core](#ioksonnetpkgkubeflow-core) | ||
- [Example](#example) | ||
- [Parameters](#parameters) | ||
|
||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
# core | ||
|
||
> Core components of Kubeflow. | ||
|
||
* [Quickstart](#quickstart) | ||
* [Using Prototypes](#using-prototypes) | ||
* [io.ksonnet.pkg.kubeflow-core](#io.ksonnet.pkg.kubeflow-core) | ||
|
||
## Quickstart | ||
|
||
*The following commands use the `io.ksonnet.pkg.kubeflow` prototype to generate Kubernetes YAML for core, and then deploys it to your Kubernetes cluster.* | ||
|
||
First, create a cluster and install the ksonnet CLI (see root-level [README.md](rootReadme)). | ||
|
||
If you haven't yet created a [ksonnet application](linkToSomewhere), do so using `ks init <app-name>`. | ||
|
||
Finally, in the ksonnet application directory, run the following: | ||
|
||
```shell | ||
# Expand prototype as a Jsonnet file, place in a file in the | ||
# `components/` directory. (YAML and JSON are also available.) | ||
$ ks prototype use io.ksonnet.pkg.kubeflow-core \ | ||
--name core \ | ||
--namespace default \ | ||
--disks | ||
|
||
# Apply to server. | ||
$ ks apply -f core.jsonnet | ||
``` | ||
|
||
## Using the library | ||
|
||
The library files for core define a set of relevant *parts* (_e.g._, deployments, services, secrets, and so on) that can be combined to configure core for a wide variety of scenarios. For example, a database like Redis may need a secret to hold the user password, or it may have no password if it's acting as a cache. | ||
|
||
This library provides a set of pre-fabricated "flavors" (or "distributions") of core, each of which is configured for a different use case. These are captured as ksonnet *prototypes*, which allow users to interactively customize these distributions for their specific needs. | ||
|
||
These prototypes, as well as how to use them, are enumerated below. | ||
|
||
### io.ksonnet.pkg.kubeflow-core | ||
|
||
Kubeflow core components | ||
#### Example | ||
|
||
```shell | ||
# Expand prototype as a Jsonnet file, place in a file in the | ||
# `components/` directory. (YAML and JSON are also available.) | ||
$ ks prototype use io.ksonnet.pkg.kubeflow-core core \ | ||
--name YOUR_NAME_HERE | ||
``` | ||
|
||
#### Parameters | ||
|
||
The available options to pass prototype are: | ||
|
||
* `--name=<name>`: Name to give to each of the components [string] | ||
|
||
|
||
[rootReadme]: https://github.com/ksonnet/mixins |
19 changes: 19 additions & 0 deletions
19
dev-kubeflow-org/ks-app/vendor/kubeflow/core/all.libsonnet
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{ | ||
parts(params):: { | ||
local ambassador = import "kubeflow/core/ambassador.libsonnet", | ||
local jupyterhub = import "kubeflow/core/jupyterhub.libsonnet", | ||
local nfs = import "kubeflow/core/nfs.libsonnet", | ||
local tfjob = import "kubeflow/core/tf-job-operator.libsonnet", | ||
local spartakus = import "kubeflow/core/spartakus.libsonnet", | ||
local centraldashboard = import "kubeflow/core/centraldashboard.libsonnet", | ||
local version = import "kubeflow/core/version.libsonnet", | ||
|
||
all:: jupyterhub.all(params) | ||
+ tfjob.all(params) | ||
+ ambassador.all(params) | ||
+ nfs.all(params) | ||
+ spartakus.all(params) | ||
+ centraldashboard.all(params) | ||
+ version.all(params), | ||
}, | ||
} |
Oops, something went wrong.