Skip to content

Latest commit

 

History

History
131 lines (107 loc) · 5.89 KB

how-to-configure-layout.md

File metadata and controls

131 lines (107 loc) · 5.89 KB

Customize Your layout.yaml

Index

Example

An example layout.yaml is available here. In the following we explain the fields in the yaml file one by one.

Field 1. kubernetes 

kubernetes:
  api-servers-url: http://ip:port
  dashboard-url: http://ip:port

Set kubernets api server and dashboard urls. (Recommand to use our config generator, so you don't need to worry about it.)

Field 2. machine-sku 

machine-sku:
  NC24R:
    mem: 224
    gpu:
      type: teslak80
      count: 4
    cpu:
      vcore: 24
    #Note: Up to now, the only supported os version is Ubuntu16.04. Please do not change it here.
    os: ubuntu16.04

In this field, you could define several sku with different name. And in the machine-list you should refer your machine to one of them.

Configuration Property Meaning
mem Memory
os Now we only supported ubuntu, and pai is only tested on the version 16.04LTS.
gpu If there is no gpu on this sku, you could remove this field.If user config gpu at sku, OpenPAI will label this node as type of gpu and will try to install gpu driver if no driver at this host.

Field 3. machine-list 

machine-list:

    - hostname: hostname (echo `hostname`)
      hostip: IP
      machine-type: D8SV3
      etcdid: etcdid1
      sshport: PORT
      username: username
      #password: password (Optional)
      #keyfile-path: /the/path/to/your/ssh/key (Optional)
      nodename: nodename # should be the same as hostip
      k8s-role: master
      dashboard: "true"
      zkid: "1"
      pai-master: "true"
      #docker-data: /var/lib/docker

    - hostname: hostname
      hostip: IP
      machine-type: D8SV3
      etcdid: etcdid2
      sshport: PORT
      username: username
      #password: password (Optional)
      #keyfile-path: /the/path/to/your/ssh/key (Optional)
      nodename: nodename # should be the same as hostip
      k8s-role: master
      node-exporter: "true"
      #docker-data: /var/lib/docker

    - hostname: hostname
      hostip: IP
      machine-type: NC24R
      sshport: PORT
      username: username
      #password: password (Optional)
      #keyfile-path: /the/path/to/your/ssh/key (Optional)
      nodename: nodename # should be the same as hostip
      k8s-role: worker
      pai-worker: "true"
      #docker-data: /var/lib/docker

User could config each service deploy at which node by labeling node with service tag as below:

Configuration Property Meaning
hostname Required. You could get the hostname by the command echo `hostname` on the host.
hostip Required. The ip address of the corresponding host.
machine-type Required. The sku name defined in the machine-sku.
sshport, username, password, keyfile-path sshport and username are reuired, password and keyfile-path need to fill at least one.
nodename The nodename displaying on k8s, should be the same as hostip
etcdid K8s-Master Required. The etcd is part of kubernetes master. If you assign the k8s-role=master to a node, you should set this filed. This value will be used when starting and fixing k8s.
k8s-role Required. You could set this value to master, worker or proxy. If you want to configure more than 1 k8s-master, please refer to Kubernetes High Availability Configuration.
dashboard Select one node to set this field. And set the value as "true".
pai-master Optional. hadoop-name-node, hadoop-resource-manager, frameworklauncher, restserver, webportal, grafana, prometheus and node-exporter.
zkid Unique zookeeper id required by pai-master node(s). You can set this field from 1 to n.
pai-worker Optional. hadoop-data-node, hadoop-node-manager, and node-exporter will be deployed on a pai-work
node-exporter Optional. You can assign this label to nodes to enable hardware and service monitoring.
docker-data Optional. You configure this path before k8s deployment. When deploying k8s, the docker's data root will be changed to the path configured in this field. The default value is /var/lib/docker. And it's same with the docker's default value.

Note: To deploy PAI in a single box, users should set pai-master and pai-worker labels for the same machine in machine-list section, or just follow the quick deployment approach described in this section.