Kubeflow 使用指南

时间  2019-11-06
标签 kubeflow 使用 指南 繁體版
原文   原文链接

Kubeflow 使用指南

JupyterHub subsystemsKubeflow（https://github.com/kubeflow）是基于Kubernetes（https://kubernets.io，容器编排与管理服务软件）和TensorFlow(https://tensorflow.org，深度学习库)的机器学习流程工具，使用Ksonnet进行应用包的管理。html

本文简要介绍Kubeflow的部署和交互操做的基本概念和方法，对于Kubernetes、Tensorflow和Ksonnet 的了解对于本文内容的理解将颇有帮助，点击下面的连接查看相关的内容。node

对部署Kubeflow和运行一个简单的训练任务的手把手教的例子，能够看这个教程（ tutorial）。git

环境要求

部署 Kubeflow

咱们将使用Ksonnet来部署kubeflow到Kubernetes集群上，支持本地的和GKE、Azure中的集群。github

初始化一个目录，包含有ksonnet application。docker

ks init my-kubeflow

安装Kubeflow packages到Ksonnet application中。json

# For a list of releases see:
# https://github.com/kubeflow/kubeflow/releases
VERSION=v0.1.2

cd my-kubeflow
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}

建立Kubeflow core component. 这个core component 包括：api

ks generate core kubeflow-core --name=kubeflow-core

# Enable collection of anonymous usage metrics
# Skip this step if you don't want to enable collection.
# Or set reportUsage to false (the default).
ks param set kubeflow-core reportUsage true
ks param set kubeflow-core usageId $(uuidgen)

Ksonnet 容许参数化 Kubeflow的部署，能够按照需求设定。咱们定义两个环境变量：nocloud和cloud。浏览器

ks env add nocloud
ks env add cloud

环境变量 nocloud 用于 minikube和其它的标准 k8s clusters，环境变量 cloud 用于GKE和Azure。安全

若是使用 GKE, 咱们配置云计算环境的参数来使用 GCP的特征，以下：服务器

ks param set kubeflow-core cloud gke --env=cloud

若是集群建立在 Azure 上，使用 AKS/ACS:

ks param set kubeflow-core cloud aks --env=cloud

若是建立时使用acs-engine来代替：

ks param set kubeflow-core cloud acsengine --env=cloud

而后咱们设置 ${KF_ENV} 为 cloud 或 nocloud ，从而反映咱们在本教程中使用的环境。

$ KF_ENV=cloud|nocloud
  • 缺水状况下，Kubeflow没有持久化咱们在Jupyter notebook所作的工做。
  • 若是容器被销毁或从新建立，全部的内容，包括 notebooks 和其它的文件都会被删除。
  • 为了持久化这些文件，用户须要一个缺省的 StorageClass，在 persistent volumes 中定义。
  • 能够运行下面的命令来检查是否有了一个 storage class。
kubectl get storageclass

  • 有了缺省的storage class定义的用户，可使用jupyterNotebookPVCMount参数去建立一个volume，将被挂载到notebook之中。

    ks param set kubeflow-core jupyterNotebookPVCMount /home/jovyan/work
    • 这里咱们挂载卷到 /home/jovyan/work ，由于notebook一直以用户jovyan来执行。
    • 选中的目录将被存储到集群的缺省存储上(典型地是永久磁盘)。

建立部署的命名空间（namespace）而且设为换的一部分。能够将namespace设为更适合你本身的kubernetes cluster的名称，以下。

NAMESPACE=kubeflow
kubectl create namespace ${NAMESPACE}
ks env set ${KF_ENV} --namespace ${NAMESPACE}

而后应用该components到咱们的Kubernetes cluster。

ks apply ${KF_ENV} -c kubeflow-core

任什么时候候，可使用 ks show 探查特定的 ksonnet component在kubernetes的对象定义。

ks show ${KF_ENV} -c kubeflow-core

用法报告（Usage Reporting）

当启用时，Kubeflow将使用 spartakus 报告匿名数据，这是Kubernetes的一个汇报工具。Spartakus不会报告任何我的信息。查看 here 获得更多细节。这是彻底志愿的行为，也能够可选将其关闭，以下所示：

ks param set kubeflow-core reportUsage false

# Delete any existing deployments of spartakus
kubectl delete -n ${NAMESPACE} deploy spartakus-volunteer

为了明确开启用法报告，设置 reportUsage 为 true，以下所示：

ks param set kubeflow-core reportUsage true

# Delete any existing deployments of spartakus
kubectl delete -n ${NAMESPACE} deploy spartakus-volunteer

报告数据是你对Kubeflow的显著贡献之一，因此请考虑将其开启。这些数据容许咱们改善Kubeflow项目而且帮助Kubeflow上开展工做的企业评估其持续的投资。

你能够改进数据质量，经过给每个Kubeflow deployment 一个单独的ID。

ks param set kubeflow-core usageId $(uuidgen)

打开 Jupyter Notebook

这里的 kubeflow-core component 部署JupyterHub和对应的load balancer service，查看状态使用下面的 kubectl 命令行：

kubectl get svc -n=${NAMESPACE}

NAME               TYPE           CLUSTER-IP      EXTERNAL-IP   PORT(S)        AGE
...
tf-hub-0           ClusterIP      None            <none>        8000/TCP       1m
tf-hub-lb          ClusterIP      10.11.245.94    <none>        80/TCP         1m
...

缺水状况下，咱们使用ClusterIPs来访问JupyterHub UI，在下面状况会有所改变：

  • NodePort (for non-cloud) ，经过指示：

    ks param set kubeflow-core jupyterHubServiceType NodePort
ks apply ${KF_ENV}

  • LoadBalancer (for cloud) ，经过指示：

    ks param set kubeflow-core jupyterHubServiceType LoadBalancer
ks apply ${KF_ENV}

可是，这将使 Jupyter notebook 开放予Internet网络（有潜在的安全风险）。

本地链接到 Jupyter Notebook 可使用：

PODNAME=`kubectl get pods --namespace=${NAMESPACE} --selector="app=tf-hub" --output=template --template="{{with index .items 0}}{{.metadata.name}}{{end}}"`
kubectl port-forward --namespace=${NAMESPACE} $PODNAME 8000:8000

而后，到浏览器中打开 http://127.0.0.1:8000，若是设置了代理，须要对该地址关闭 。

将看到一个提示窗口。

  1. 使用任何username/password登陆。

  2. 点击 "Start My Server" 按钮，将会打开一个对话框。

  3. 选择镜像为CPU 或 GPU 类型，在 Image一项有菜单列出预构建的Docker镜像。也能够直接输入Tensorflow的镜像名称，用于运行。

  4. 分配内存、CPU、GPU和其余的资源，根据需求而定。 (1 CPU 和 2Gi 内存已是一个好的起点，能够知足初始练习的须要。)

    • 分配 GPUs, 须要确认你的集群中有可用数量的 GPUs，GPU将会被容器实例独占使用，若是资源不够，该实例将会一直挂起，处于Pending状态。
    • 检查是否有足够的nvidia gpus可用： kubectl get nodes "-o=custom-columns=NAME:.metadata.name,GPU:.status.allocatable.nvidia\.com/gpu"
    • 若是 GPUs 可用，你能够调度你的服务器到 GPU node，经过指定下面的json， 在 Extra Resource Limits section: {"nvidia.com/gpu": "1"}

  5. 点击 Spawn

    • 该镜像将近 10 GBs，下载须要比较长的时间，取决于网络状况。

    • 检查 pod 的状态，经过：

      kubectl -n ${NAMESPACE} describe pods jupyter-${USERNAME}

      • 这里 ${USERNAME} 是你 login时用到的名称。

      • GKE users，若是你有 IAP turned on the pod，将会名称有所不一样：

        jupyter-accounts-2egoogle-2ecom-3USER-40DOMAIN-2eEXT

  6. 完成后，将会打开 Jupyter Notebook 初始界面。

上面提供的容器镜像能够用于 Tensorflow models的训练，使用Jupyter便可操做。该镜像包含全部须要的plugins, 包括 Tensorboard，能够用于对模型进行丰富的可视化和探查分析。

将来测试安装状况，咱们运行一个基本的hello world应用 (来自 mnist_softmax.py )

from tensorflow.examples.tutorials.mnist import input_data
mnist = input_data.read_data_sets("MNIST_data/", one_hot=True)

import tensorflow as tf

x = tf.placeholder(tf.float32, [None, 784])

W = tf.Variable(tf.zeros([784, 10]))
b = tf.Variable(tf.zeros([10]))

y = tf.nn.softmax(tf.matmul(x, W) + b)

y_ = tf.placeholder(tf.float32, [None, 10])
cross_entropy = tf.reduce_mean(-tf.reduce_sum(y_ * tf.log(y), reduction_indices=[1]))

train_step = tf.train.GradientDescentOptimizer(0.05).minimize(cross_entropy)

sess = tf.InteractiveSession()
tf.global_variables_initializer().run()

for _ in range(1000):
  batch_xs, batch_ys = mnist.train.next_batch(100)
  sess.run(train_step, feed_dict={x: batch_xs, y_: batch_ys})

correct_prediction = tf.equal(tf.argmax(y,1), tf.argmax(y_,1))
accuracy = tf.reduce_mean(tf.cast(correct_prediction, tf.float32))
print(sess.run(accuracy, feed_dict={x: mnist.test.images, y_: mnist.test.labels}))

粘贴上面的例子到新的 Python 3 Jupyter notebook，而后 shift+enter 执行代码。这里会获得基于测试数据的 0.9014 结果精度。

须要注意的是，运行大多数 cloud providers时，public IP address 将会暴露到internet，而且缺省是没有安全控制的endpoint。为了产品级部署，须要使用 SSL 和 authentication, 参考 documentation。

使用TensorFlow Serving提供model服务

咱们将每个部署的模型都做为APP中的 component 。

在云计算中建立一个模型的component：

MODEL_COMPONENT=serveInception
MODEL_NAME=inception
MODEL_PATH=gs://kubeflow-models/inception
ks generate tf-serving ${MODEL_COMPONENT} --name=${MODEL_NAME}
ks param set ${MODEL_COMPONENT} modelPath ${MODEL_PATH}

(或者) 建立一个model的component 在 nfs 上，了解和参考 components/k8s-model-server，以下：

MODEL_COMPONENT=serveInceptionNFS
MODEL_NAME=inception-nfs
MODEL_PATH=/mnt/var/nfs/general/inception
MODEL_STORAGE_TYPE=nfs
NFS_PVC_NAME=nfs
ks generate tf-serving ${MODEL_COMPONENT} --name=${MODEL_NAME}
ks param set ${MODEL_COMPONENT} modelPath ${MODEL_PATH}
ks param set ${MODEL_COMPONENT} modelStorageType ${MODEL_STORAGE_TYPE}
ks param set ${MODEL_COMPONENT} nfsPVC ${NFS_PVC_NAME}

部署model component。Ksonnet将选择你的环境中的已存在的参数 (e.g. cloud, nocloud)，而后定制化结果部署为合适的：

ks apply ${KF_ENV} -c ${MODEL_COMPONENT}

以前, 一些pods和services已经建立在你的集群中。你能够查询kubernetes获得服务endpoint：

kubectl get svc inception -n=${NAMESPACE}
NAME        TYPE           CLUSTER-IP      EXTERNAL-IP      PORT(S)          AGE
...
inception   LoadBalancer   10.35.255.136   ww.xx.yy.zz   9000:30936/TCP   28m
...

在这里，你可使用的 inception_client 为 ww.xx.yy.zz:9000

在gs://kubeflow-models/inception 的model 是能够公开访问的。可是，若是你的环境没有配置google cloud credential，TF serving 将没法读取model，查看 issue 获取样本。为了设置google cloud credential，你须要环境变量 GOOGLE_APPLICATION_CREDENTIALS 指向credential 文件，或者运行 gcloud auth login. 查看 doc 获取更多详细说明。

经过 Seldon 服务 model

Seldon-core 提供了任意机器学习运行时的部署，将其 packaged in a Docker container。

安装seldon package：

ks pkg install kubeflow/seldon

建立 core components：

ks generate seldon seldon

Seldon 容许复杂的 runtime graphs用于模型推理的部署。一个 end-to-end整合的例子参见 kubeflow-seldon example。更多的细节参考 seldon-core documentation。

提交一个TensorFlow训练任务

注意：在提交训练任务以前，你首先须要有一个 deployed kubeflow to your cluster。提交训练任务时，首先确认 TFJob custom resource 是可用的。

咱们将每个TensorFlow job做为APP中的 component 看待。

A、建立工做任务

为训练任务建立 component：

JOB_NAME=myjob
ks generate tf-job ${JOB_NAME} --name=${JOB_NAME}

为了配置这个 job须要设置一系列的参数。为了查看参数列表，运行：

ks prototype describe tf-job

参数设置使用 ks param ，设置 Docker image 使用：

IMAGE=gcr.io/tf-on-k8s-dogfood/tf_sample:d4ef871-dirty-991dde4
ks param set ${JOB_NAME} image ${IMAGE}

你能够编辑 params.libsonnet 文件，直接设置参数。

警告 因为escaping序列问题，目前命令行的设置参数不能工做 (参见 ksonnet/ksonnet/issues/235)。所以，设置参数须要直接编辑 params.libsonnet 文件。

B、运行工做任务

ks apply ${KF_ENV} -c ${JOB_NAME}

C、监视工做任务

监视任务执行状况，参见 TfJob docs.

D、删除工做任务

ks delete ${KF_ENV} -c ${JOB_NAME}

运行例程-TfCnn

Kubeflow 附带了一个 ksonnet prototype ，适合运行 TensorFlow CNN Benchmarks。

建立component：

CNN_JOB_NAME=mycnnjob
ks generate tf-cnn ${CNN_JOB_NAME} --name=${CNN_JOB_NAME}

提交任务：

ks apply ${KF_ENV} -c ${CNN_JOB_NAME}

查看运行状况 (注意 tf-cnn job 也是 tfjobs. 参考 TfJob docs)

kubectl get -o yaml tfjobs ${CNN_JOB_NAME}

删除任务：

ks delete ${KF_ENV} -c ${CNN_JOB_NAME}

该 prototype提供了一系列参数控制任务的运行 (如使用 GPUs，分布式运行等...)。查看参数运行：

ks prototype describe tf-cnn

提交 PyTorch 训练任务

注意：在提交任务以前，你须要有一个部署好Kubeflow的集群（参见 deployed kubeflow to your cluster）。提交，确保 PyTorchJob custom resource 可用。

咱们将每个PyTorch任务看做为APP中的 component 。

为工做任务建立一个 component。

JOB_NAME=myjob
ks generate pytorch-job ${JOB_NAME} --name=${JOB_NAME}

为了配置工做任务，须要设置一系列的参数。 显示参数使用：

ks prototype describe pytorch-job

参数设置使用 ks param ，设置Docker image 使用：

IMAGE=<your pytorch image>
ks param set ${JOB_NAME} image ${IMAGE}

也能够编辑文件 params.libsonnet 来直接设置参数。

警告 因为escaping序列问题，目前命令行的设置参数不能工做 (参见 ksonnet/ksonnet/issues/235)。所以，设置参数须要直接编辑 params.libsonnet 文件。

运行工做任务：

ks apply ${KF_ENV} -c ${JOB_NAME}

删除工做任务：

ks delete ${KF_ENV} -c ${JOB_NAME}

高级定制

  • 数据科学家常常要求一个 POSIX 兼容的文件系统：
    • 例如，大多数HDF5 libraries 要求 POSIX，对于GCS或S3的object store没法工做。
  • 当共享 POSIX 文件系统被挂载到 notebook 环境，数据科学家能够在同一数据集上协同工做。
  • 这里将展现如何部署Kubeflow来达到这个要求。

设置磁盘参数，以分号隔开，设置你想要挂载的 Google persistent disks。

  • 这些磁盘必须在你的集群的同一个 zone 上。
  • 这些磁盘须要经过 gcloud 或 Cloud console手动建立。
  • 这些磁盘不能被引用到任何已存在的 VM 或 POD上。

建立磁盘：

gcloud --project=${PROJECT} compute disks create  --zone=${ZONE} ${PD_DISK1} --description="PD to back NFS storage on GKE." --size=1TB
  gcloud --project=${PROJECT} compute disks create  --zone=${ZONE} ${PD_DISK2} --description="PD to back NFS storage on GKE." --size=1TB

配置环境来使用这些磁盘：

ks param set --env=cloud kubeflow-core disks ${PD_DISK1},${PD_DISK2}

部署环境。

ks apply cloud

启动Juptyer，你将能够看见你的 NFS volumes 挂载为 /mnt/${DISK_NAME}。在Juptyer cell中运行：

!df

将看到以下的输出：

https://github.com/jlewi/deepvariant_on_k8s
Filesystem                                                     1K-blocks    Used  Available Use% Mounted on
overlay                                                         98884832 8336440   90532008   9% /
tmpfs                                                           15444244       0   15444244   0% /dev
tmpfs                                                           15444244       0   15444244   0% /sys/fs/cgroup
10.11.254.34:/export/pvc-d414c86a-e0db-11e7-a056-42010af00205 1055841280   77824 1002059776   1% /mnt/jlewi-kubeflow-test1
10.11.242.82:/export/pvc-33f0a5b3-e0dc-11e7-a056-42010af00205 1055841280   77824 1002059776   1% /mnt/jlewi-kubeflow-test2
/dev/sda1                                                       98884832 8336440   90532008   9% /etc/hosts
shm                                                                65536       0      65536   0% /dev/shm
tmpfs                                                           15444244       0   15444244   0% /sys/firmware
  • 这里 jlewi-kubeflow-test1 和 jlewi-kubeflow-test2 是 PDs的名称。

问题解决

Minikube

在 Minikube ，Virtualbox/VMware drivers是已知在 KVM/KVM2 driver 和 TensorFlow Serving之间的问题. 该问题跟踪在 kubernetes/minikube#2377。

咱们建议增长 Minikube分配的资源总量，以下：

minikube start --cpus 4 --memory 8096 --disk-size=40g
  • Minikube 缺省分配 2048Mb RAM给虚拟机，对于 JupyterHub是不够的。
  • 最大的磁盘容量须要知足 Kubeflow's Jupyter images，包含额外的库超过10G以上。

若是遇到jupyter-xxxx pod 进入Pending 状态，获取描述信息：

Warning  FailedScheduling  8s (x22 over 5m)  default-scheduler  0/1 nodes are available: 1 Insufficient memory.
  • 而后尝试从新建立 Minikube cluster (从新使用Ksonnet应用 Kubeflow) ，并指定更多的资源。

RBAC clusters

若是你运行的集群开启了RBAC（参考 RBAC enabled）,，运行Kubeflow可能遇到以下的错误：

ERROR Error updating roles kubeflow-test-infra.jupyter-role: roles.rbac.authorization.k8s.io "jupyter-role" is forbidden: attempt to grant extra privileges: [PolicyRule{Resources:["*"], APIGroups:["*"], Verbs:["*"]}] user=&{your-user@acme.com  [system:authenticated] map[]} ownerrules=[PolicyRule{Resources:["selfsubjectaccessreviews"], APIGroups:["authorization.k8s.io"], Verbs:["create"]} PolicyRule{NonResourceURLs:["/api" "/api/*" "/apis" "/apis/*" "/healthz" "/swagger-2.0.0.pb-v1" "/swagger.json" "/swaggerapi" "/swaggerapi/*" "/version"], Verbs:["get"]}] ruleResolutionErrors=[]

该错误指示没有足够的权限。在大多数状况下，解决这个问题经过建立合适的 clusterrole binding 而后从新部署kubeflow：

kubectl create clusterrolebinding default-admin --clusterrole=cluster-admin --user=your-user@acme.com
  • 替换 your-user@acme.com 为在错误信息提示的用户名。

若是你使用 GKE, 你能够参考 GKE's RBAC docs 去了解如何设置 RBAC，经过 IAM on GCP来实现。

spawning Jupyter pods的问题

若是你 spawning jupyter notebooks遇到麻烦，检查该 pod 是否已经被调度运行：

kubectl -n ${NAMESPACE} get pods
  • 查看启动juypter的pod名称。
  • 若是使用username/password auth，Jupyter  pod 将被命名：
jupyter-${USERNAME}

  • 若是你使用 IAP on GKE，pod 将被命名为：

    jupyter-accounts-2egoogle-2ecom-3USER-40DOMAIN-2eEXT

一旦你知道pod的名称：

kubectl -n ${NAMESPACE} describe pods ${PODNAME}
  • 查看events ，能够看到试图schedule pod的错误缘由。
  • 没法schedule pod的常见缘由是集群上没有足够的资源可用。

OpenShift

若是部署 Kubeflow 在 OpenShift 环境（ 是对 Kubernetes的封装），你须要调整 security contexts，为了ambassador 和 jupyter-hub 部署的运行。

oc adm policy add-scc-to-user anyuid -z ambassador
oc adm policy add-scc-to-user anyuid -z jupyter-hub

一旦安全策略设置好，你须要删除失败的pods 而后容许在 project deployment时能够从新建立。

你须要调整 tf-job-operator service 张好的权限，以使TFJobs可以运行。以下运行一个TFJobs：

oc adm policy add-role-to-user cluster-admin -z tf-job-operator

Docker for Mac

Docker for Mac 社区版带有Kubernetes支持 (1.9.2) ，能够从edge channel启用。若是决定私用 Kubernetes environment on Mac，部署 Kubeflow时可能遇到以下的问题：

ks apply default -c kubeflow-core
ERROR Attempting to deploy to environment 'default' at 'https://127.0.0.1:8443', but cannot locate a server at that address

该错误是由于Docker for Mac安装时设置的缺省集群为 https://localhost:6443.，一个选项是直接编辑建立的 environments/default/spec.json 文件设置 "server" 变量为正确的位置，而后重试部署。不过，更好的方式是使用但愿的kube config来建立Ksonnet app。

kubectl config use-context docker-for-desktop
ks init my-kubeflow

403 API rate limit 超出错误

由于 ksonnet 使用 Github 拉取 kubeflow，除非用户指定Github API token，将会快速消耗最大的 API 匿名调用限量，为了解决该问题，能够建立 Github API token，参考这里 guide,，而后将该token 赋给GITHUB_TOKEN 环境变量。

export GITHUB_TOKEN=<< token >>

ks apply 产生错误 "Unknown variable: env"

Kubeflow 要求版本 0.9.2 或更高，查看 see here。若是你运行 ks apply 使用的老版本ksonnet，将获得错误 Unknown variable: env ，以下所示：

ks apply ${KF_ENV} -c kubeflow-core
ERROR Error reading /Users/xxx/projects/devel/go/src/github.com/kubeflow/kubeflow/my-kubeflow/environments/nocloud/main.jsonnet: /Users/xxx/projects/devel/go/src/github.com/kubeflow/kubeflow/my-kubeflow/components/kubeflow-core.jsonnet:8:49-52 Unknown variable: env

  namespace: if params.namespace == "null" then env.namespace else params.namespace

检查ksonnet 版本，以下：

ks version

若是 ksonnet版本低于 v0.9.2, 请升级并按照 user_guide 从新建立app。

为何 Kubeflow 要使用 Ksonnet？

Ksonnet 是一个命令行工具，使管理包含多个部件的复杂部署变得更为容易，设计为与kubectl各自完成特定的操做。

Ksonnet 容许咱们从参数化的模版中建立 Kubernetes manifests。这使参数化 Kubernetes manifests 用于特定的场景变得容易。在上面的例子中，咱们为 TfServing 建立了manifests，为model提供用户化的URI。

我蛮喜欢ksonnet的一个缘由是，对待 environment  (如dev, test, staging, prod) 做为头等的概念。对于每个环境，咱们部署一样的 components只须要对特定环境有一些很小的定制化修改。咱们认为这对于一般的工做流来讲是很是友好的一种映射。例如，该特征让在本地没有GPU的状况下运行任务，使代码运行经过，而后将其移到带有大量GPU可规模伸缩的云计算环境之中。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程