Skip to content
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

Update some IBM Cloud related docs for Kubeflow 1.1 release #2110

Merged
merged 10 commits into from
Aug 11, 2020
2 changes: 1 addition & 1 deletion content/en/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ docs/started/requirements/ /docs/started/getting-started/
/docs/started/getting-started-aws/ /docs/started/cloud/getting-started-aws/
/docs/started/getting-started-azure/ /docs/started/cloud/getting-started-azure/
/docs/started/getting-started-gke/ /docs/started/cloud/getting-started-gke/
/docs/started/getting-started-icp/ /docs/started/cloud/getting-started-icp/
/docs/started/getting-started-iks/ /docs/started/cloud/getting-started-iks/

/docs/other-guides/upgrade/ /docs/upgrading/upgrade/

Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/ibm/deploy/install-kubeflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ directories:
Kubeflow deployment.

* This file is a copy of the GitHub-based configuration YAML file that
you used when deploying Kubeflow. For example, {{% config-uri-k8s-istio %}}.
you used when deploying Kubeflow. For example, {{% config-uri-ibm %}}.
* When you run `kfctl apply` or `kfctl build`, kfctl creates
a local version of the configuration file, `${CONFIG_FILE}`,
which you can further customize if necessary.
Expand Down Expand Up @@ -154,7 +154,7 @@ export BASE_DIR=<path to a base directory>
export KF_DIR=${BASE_DIR}/${KF_NAME}

# Set the configuration file to use, such as the file specified below:
export CONFIG_URI="https://raw.githubusercontent.com/kubeflow/manifests/master/kfdef/kfctl_ibm.v1.1.0.yaml"
export CONFIG_URI="https://raw.githubusercontent.com/kubeflow/manifests/v1.1-branch/kfdef/kfctl_ibm.v1.1.0.yaml"

# Generate and deploy Kubeflow:
mkdir -p ${KF_DIR}
Expand Down Expand Up @@ -196,7 +196,7 @@ The scenario is a GitHub organization owner can authorize its organization membe
```
1. Setup configuration files:
```
export CONFIG_URI="https://raw.githubusercontent.com/kubeflow/manifests/master/kfdef/kfctl_ibm_dex_multi_user.v1.1.0.yaml"
export CONFIG_URI="https://raw.githubusercontent.com/kubeflow/manifests/v1.1-branch/kfdef/kfctl_ibm_dex_multi_user.v1.1.0.yaml"
# Generate and deploy Kubeflow:
mkdir -p ${KF_DIR}
cd ${KF_DIR}
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/operator/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Kubeflow Operator controller logic is based on the [`kfctl` package](https://git
|[v1.0](https://github.com/kubeflow/kfctl/tree/v1.0)|[aipipeline/kubeflow-operator:v1.0.0](https://hub.docker.com/layers/aipipeline/kubeflow-operator/v1.0.0/images/sha256-63d00b29a61ff5bc9b0527c8a515cd4cb55de474c45d8e0f65742908ede4d88f?context=repo)|[1.0.0](https://github.com/kubeflow/manifests/tree/f56bb47d7dc5378497ad1e38ea99f7b5ebe7a950)|[kfctl_k8s_istio.v1.0.0.yaml](https://github.com/kubeflow/manifests/blob/f56bb47d7dc5378497ad1e38ea99f7b5ebe7a950/kfdef/kfctl_k8s_istio.v1.0.0.yaml)||
|[v1.0.1](https://github.com/kubeflow/kfctl/tree/v1.0.1)|[aipipeline/kubeflow-operator:v1.0.1](https://hub.docker.com/layers/aipipeline/kubeflow-operator/v1.0.1/images/sha256-828024b773040271e4b547ce9219046f705fb7123e05503d5a2d1428dfbcfb6e?context=repo)|[1.0.1](https://github.com/kubeflow/manifests/tree/v1.0.1)|[kfctl_k8s_istio.v1.0.1.yaml](https://github.com/kubeflow/manifests/blob/v1.0.1/kfdef/kfctl_k8s_istio.v1.0.1.yaml)||
|[v1.0.2](https://github.com/kubeflow/kfctl/tree/v1.0.2)|[aipipeline/kubeflow-operator:v1.0.2](https://hub.docker.com/layers/aipipeline/kubeflow-operator/v1.0.2/images/sha256-18d2ca6f19c1204d5654dfc4cc08032c168e89a95dee68572b9e2aaedada4bda?context=repo)|[1.0.2](https://github.com/kubeflow/manifests/tree/v1.0.2)|[kfctl_k8s_istio.v1.0.2.yaml](https://github.com/kubeflow/manifests/blob/v1.0.2/kfdef/kfctl_k8s_istio.v1.0.2.yaml)||
|[v1.1.0](https://github.com/kubeflow/kfctl/tree/v1.1.0)|[aipipeline/kubeflow-operator:v1.1.0](https://hub.docker.com/layers/aipipeline/kubeflow-operator/v1.0.0/images/sha256-63d00b29a61ff5bc9b0527c8a515cd4cb55de474c45d8e0f65742908ede4d88f?context=explore)|[1.1.0](https://github.com/kubeflow/manifests/tree/v1.1.0)|[kfctl_ibm.v1.1.0.yaml](https://github.com/kubeflow/manifests/blob/v1.1.0/kfdef/kfctl_ibm.yaml)||
|[v1.1.0](https://github.com/kubeflow/kfctl/tree/v1.1.0)|[aipipeline/kubeflow-operator:v1.1.0](https://hub.docker.com/layers/aipipeline/kubeflow-operator/v1.0.0/images/sha256-63d00b29a61ff5bc9b0527c8a515cd4cb55de474c45d8e0f65742908ede4d88f?context=explore)|[1.1.0](https://github.com/kubeflow/manifests/tree/v1.1.0)|[kfctl_ibm.v1.1.0.yaml](https://github.com/kubeflow/manifests/blob/v1.1-branch/kfdef/kfctl_ibm.v1.1.0.yaml)||
|[master](https://github.com/kubeflow/kfctl)|[aipipeline/kubeflow-operator:master](https://hub.docker.com/layers/aipipeline/kubeflow-operator/master/images/sha256-e81020c426a12237c7cf84316dbbd0efda76e732233ddd57ef33543381dfb8a1?context=repo)|[master](https://github.com/kubeflow/manifests)|[kfctl_ibm.yaml](https://github.com/kubeflow/manifests/blob/master/kfdef/kfctl_ibm.yaml)|as of 07/29/2020|

> Note: if building a customized operator for a specific version of Kubeflow is desired, you can run `git checkout` to that specific branch tag. Keep in mind to use the matching version of manifests.
73 changes: 53 additions & 20 deletions content/en/docs/other-guides/kustomize.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@ description = "The basics of Kubeflow configuration with kfctl and kustomize"
weight = 10

+++
{{% alert title="Out of date" color="warning" %}}
This guide contains outdated information pertaining to Kubeflow 1.0. This guide
needs to be updated for Kubeflow 1.1.
{{% /alert %}}

{{% stable-status %}}

Expand Down Expand Up @@ -49,10 +45,53 @@ YAML configuration files to bootstrap the configuration. You can see all the
[configuration files on
GitHub](https://github.com/kubeflow/manifests/tree/master/kfdef).

You can also compose your own configuration file with components and applications of your choice. Starting with Kubeflow 1.1 release, the _KfDef_ manifest also supports using _stack_ to declare a specific stack of applications. To use this new feature, the manifest should contain one application with `kubeflow-apps` name.

```yaml
apiVersion: kfdef.apps.kubeflow.org/v1
kind: KfDef
metadata:
namespace: kubeflow
spec:
applications:
# Install istio in a different namespace: istio-system
# Remove this application if istio is already installed
- kustomizeConfig:
repoRef:
name: manifests
path: istio/istio/base
name: kubeflow-istio
...
# Install Kubeflow applications. In the stacks/generic path, a set of core
# Kubeflow components (pipelines, central dashboard, profiles, etc) are included
# in the one kustomization.yaml.
- kustomizeConfig:
repoRef:
name: manifests
path: stacks/generic
name: kubeflow-apps
...
# Spartakus is a separate applications so that kfctl can remove it
# to disable usage reporting
- kustomizeConfig:
repoRef:
name: manifests
path: common/spartakus/overlays/application
name: spartakus
...
repos:
- name: manifests
uri: https://github.com/kubeflow/manifests/archive/v1.1-branch.tar.gz
version: v1.1-branch
```

Note that with the above manifests, the `kfctl` CLI expects all applications to have a `kustomization.yaml` file in the `kustomizeConfig.repoRef.path` directory. The `kustomization.yaml` file will be used by the `kustomize` to build and apply all Kubernetes resources for that stack of applications. The `parameters` and `overlays` fields under `kustomizeConfig` for each application will be ignored.

You can continue to compose the _KfDef_ manifest in the old format prior to Kubeflow 1.1 without naming any application as `kubeflow-apps`.

As an example, this guide uses the
[kfctl_k8s_istio.yaml](https://github.com/kubeflow/manifests/blob/master/kfdef/kfctl_k8s_istio.yaml)
configuration. For more details about this configuration, see the
[kfctl_k8s_istio deployment guide](/docs/started/k8s/kfctl-k8s-istio/).
[kfctl_ibm.yaml](https://github.com/kubeflow/manifests/blob/master/kfdef/kfctl_ibm.yaml)
configuration. This configuration is written using the _stack_ option.

Typically, you specify the configuration file with a `-f <config-file>`
parameter when you run `kfctl build` or `kfctl apply`. The following example
Expand All @@ -72,7 +111,7 @@ export KF_DIR=${BASE_DIR}/${KF_NAME}

# Set the URI of the configuration file to use when deploying Kubeflow.
# For example:
export CONFIG_URI="{{% config-uri-k8s-istio %}}"
export CONFIG_URI="{{% config-uri-ibm %}}"

# Create your Kubeflow configurations:
mkdir -p ${KF_DIR}
Expand All @@ -95,12 +134,12 @@ which you can further customize if necessary.
Follow these steps to apply the configurations to your Kubeflow cluster:

1. Set an environment variable pointing to your local configuration file.
For example, this guide uses the `{{% config-file-k8s-istio %}}`
For example, this guide uses the `{{% config-file-ibm %}}`
configuration. If you chose a different configuration in the previous step,
you must change the file name to reflect your configuration:

```
export CONFIG_FILE=${KF_DIR}/{{% config-file-k8s-istio %}}
export CONFIG_FILE=${KF_DIR}/{{% config-file-ibm %}}
```

1. Apply the configurations:
Expand All @@ -110,6 +149,7 @@ Follow these steps to apply the configurations to your Kubeflow cluster:
```

<a id="kubeflow-directory"><a/>

### Your Kubeflow directory layout

Your Kubeflow application directory is the directory where you choose to store
Expand Down Expand Up @@ -162,9 +202,8 @@ Below are some examples of configuration files:
* [kfctl_istio_dex.yaml](https://github.com/kubeflow/manifests/blob/master/kfdef/kfctl_istio_dex.yaml)
to install Kubeflow on an existing Kubernetes cluster with Dex and Istio for
authentication.
* [kfctl_gcp_iap.yaml](https://github.com/kubeflow/manifests/blob/master/kfdef/kfctl_gcp_iap.yaml)
to create a Google Kubernetes Engine (GKE) cluster with Kubeflow using
Cloud Identity-Aware Proxy (Cloud IAP) for access control.
* [kfctl_ibm.yaml](https://github.com/kubeflow/manifests/blob/master/kfdef/kfctl_ibm.yaml)
to create a IBM Cloud Kubernetes Service (IKS) cluster with Kubeflow.

The kustomize package manager in kfctl uses the information in your
`${CONFIG_FILE}` to traverse the directories under the
Expand Down Expand Up @@ -266,19 +305,13 @@ your Kubeflow deployment:
kfctl apply -V -f ${CONFIG_FILE}
```


### More examples

For examples of customizing your deployment, see the guide to [customizing
Kubeflow on GKE](/docs/gke/customizing-gke/).

For information about how Kubeflow uses Spartakus, see the guide to
[usage reporting](/docs/other-guides/usage-reporting/).

## More about kustomize

Below are some useful kustomize terms, from the
[kustomize glossary](https://github.com/kubernetes-sigs/kustomize/blob/master/docs/glossary.md):
[kustomize glossary](https://kubernetes-sigs.github.io/kustomize/api-reference/glossary/):

* **base:** A combination of a kustomization and resource(s). Bases can be
referred to by other kustomizations.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/other-guides/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Consult the support page for the cloud service or platform that you're using:

* [Amazon Web Services (AWS)](https://aws.amazon.com/contact-us/)
* [Google Cloud Platform (GCP)](https://cloud.google.com/support-hub/)
* [IBM Cloud Private](https://www.ibm.com/cloud/support)
* [IBM Cloud](https://www.ibm.com/cloud/support)
* [Microsoft Azure](https://azure.microsoft.com/en-au/support/options/)
* [Red Hat OpenShift](https://help.openshift.com/)

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/reference/version-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ documentation for that application.
(<a href="https://github.com/kubeflow/kfserving">GitHub</a>)
</td>
<td>Beta</td>
<td>v0.2.2</td>
<td>v0.3.0</td>
</tr>
<tr>
<td><a href="/docs/components/misc/metadata/">Metadata</a>
Expand Down Expand Up @@ -247,7 +247,7 @@ one of the following Kubeflow SDKs and command-line interfaces
(<a href="https://github.com/kubeflow/kfctl">GitHub</a> )
</td>
<td>Stable</td>
<td>1.0.0</td>
<td>1.1.0</td>
</tr>
<tr>
<td><a href="/docs/pipelines/sdk/sdk-overview/">Kubeflow Pipelines SDK</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,8 @@ description = "Get Kubeflow running on IBM Cloud Kubernetes Service (IKS) "
weight = 2

+++
{{% alert title="Out of date" color="warning" %}}
This guide contains outdated information pertaining to Kubeflow 1.0. This guide
needs to be updated for Kubeflow 1.1.
{{% /alert %}}

Please refer to the [installation section](/docs/ibm/install-kubeflow) in the
Please refer to the [installation section](/docs/ibm/deploy/install-kubeflow) in the
[IBM docs](/docs/ibm/) for information on setting up your IKS environment and deploying Kubeflow on IBM Cloud Kubernetes Service (IKS).


Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ The matrix is therefore an alternative way of accessing the information in the
<td><b>IBM Cloud (IKS)</b></td>
<td><a href="{{% config-uri-ibm %}}">{{% config-file-ibm %}}</a>
</td>
<td><a href="/docs/started/cloud/getting-started-icp/">Docs</a></td>
<td><a href="/docs/started/cloud/getting-started-iks/">Docs</a></td>
</tr>
<tr>
<td><b>OpenShift</b></td>
Expand Down Expand Up @@ -181,7 +181,7 @@ tools for deploying and managing Kubeflow:

## Understanding the Kubeflow versioning policies

With the launch of Kubeflow v1.0, the Kubeflow community attributes
With the launch of Kubeflow {{% kf-latest-version %}}, the Kubeflow community attributes
*stable status* to those applications and other components that
meet the required level of stability, supportability, and upgradability.

Expand Down
2 changes: 1 addition & 1 deletion layouts/shortcodes/config-file-ibm.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
kfctl_ibm.v1.0.2.yaml
kfctl_ibm.v1.1.0.yaml
2 changes: 1 addition & 1 deletion layouts/shortcodes/config-uri-ibm.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
https://raw.githubusercontent.com/kubeflow/manifests/v1.0-branch/kfdef/kfctl_ibm.v1.0.2.yaml
https://raw.githubusercontent.com/kubeflow/manifests/v1.1-branch/kfdef/kfctl_ibm.v1.1.0.yaml
2 changes: 1 addition & 1 deletion layouts/shortcodes/kf-latest-version.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1.0.2
v1.1.0