github.com/alibaba/sealer@v0.8.6-0.20220430115802-37a2bdaa8173/docs/design/plugin_zh.md

# 集群镜像插件

插件可以帮助用户做一些之外的事情，比如更改主机名，升级内核，或者添加节点标签等……

## 主机名插件

如果你在Clusterfile后添加插件配置并应用它，sealer将帮助你更改所有的主机名：

```yaml
---
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
  name: hostname
spec:
  type: HOSTNAME
  data: |
    192.168.0.2 master-0
    192.168.0.3 master-1
    192.168.0.4 master-2
    192.168.0.5 node-0
    192.168.0.6 node-1
    192.168.0.7 node-2
```

> Hostname Plugin 将各个节点在安装集群前修改为对应的主机名。

## 脚本插件

如果你在Clusterfile后添加Shell插件配置并应用它，sealer将帮助你执行shell命令(执行路径为镜像Rootfs目录)：

```yaml
---
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
  name: shell
spec:
  type: SHELL
  action: PostInstall
  'on': node-role.kubernetes.io/master=
  data: |
    kubectl taint nodes node-role.kubernetes.io/master=:NoSchedule
```

```shell
action : [PreInit| PostInstall] # 指定执行shell的时机
  在初始化之前执行命令      |  action: PreInit
  在添加节点之前执行命令    |  action: PreJoin
  在添加节点之后执行命令    |  action: PostJoin
  在执行Kubefile CMD之前  |  action: PreGuest
  在安装集群之后执行命令    ｜  action: PostInstall
  在清理集群前执行命令      |  action: PreClean
  在清理集群后执行命令      |  action: PostClean
  组合使用                |  action: PreInit|PreJoin
on     : #指定执行命令的机器
  为空时默认在所有节点执行
  在所有master节点上执行   | 'on': master
  在所有node节点上执行     | 'on': node
  在指定IP上执行          ｜ 'on': 192.168.56.113,192.168.56.114,192.168.56.115,192.168.56.116
  在有连续IP的机器上执行    | 'on': 192.168.56.113-192.168.56.116
  在指定label节点上执行(action需为PostInstall或PreClean)  | 'on': node-role.kubernetes.io/master=
data   : #指定执行的shell命令
```

## 标签插件

如果你在Clusterfile后添加label插件配置并应用它，sealer将帮助你添加label：

```yaml
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
  name: label
spec:
  type: LABEL
  action: PreGuest
  data: |
    192.168.0.2 ssd=true
    192.168.0.3 ssd=true
    192.168.0.4 ssd=true
    192.168.0.5 ssd=false,hdd=true
    192.168.0.6 ssd=false,hdd=true
    192.168.0.7 ssd=false,hdd=true
```

> 节点ip与标签之前使用空格隔开，多个标签之间使用逗号隔开。

## 集群检测插件

由于服务器以及环境因素(服务器磁盘性能差)可能会导致sealer安装完kubernetes集群后，立即部署应用服务，出现部署失败的情况。cluster check插件会等待kubernetes集群稳定后再部署应用服务。

```yaml
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
  name: checkCluster
spec:
  type: CLUSTERCHECK
  action: PreGuest
```

## 污点插件

如果你在Clusterfile后添加taint插件配置并应用它，sealer将帮助你添加污点和去污点：

```yaml
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
  name: taint
spec:
  type: TAINT
  action: PreGuest
  data: |
    192.168.56.3 key1=value1:NoSchedule
    192.168.56.4 key2=value2:NoSchedule-
    192.168.56.3-192.168.56.7 key3:NoSchedule
    192.168.56.3,192.168.56.4,192.168.56.5,192.168.56.6,192.168.56.7 key4:NoSchedule
    192.168.56.3 key5=:NoSchedule
    192.168.56.3 key6:NoSchedule-
    192.168.56.4 key7:NoSchedule-
```

> data写法为`ips taint_argument`
> ips           : 多个ip通过`,`连接，连续ip写法为 首ip-末尾ip
> taint_argument: 同kubernetes 添加或去污点写法(key=value:effect #effect必须为：NoSchedule, PreferNoSchedule 或 NoExecute)。

## 插件使用步骤

Clusterfile内容：

```
apiVersion: sealer.aliyun.com/v1alpha1
kind: Cluster
metadata:
  name: my-cluster
spec:
  image: registry.cn-qingdao.aliyuncs.com/sealer-io/kubernetes:v1.19.8
  provider: BAREMETAL
  ssh:
    # ssh的私钥文件绝对路径，例如/root/.ssh/id_rsa
    pk: xxx
    # ssh的私钥文件密码，如果没有的话就设置为""
    pkPasswd: xxx
    # ssh登录用户
    user: root
    # ssh的登录密码，如果使用的密钥登录则无需设置
    passwd: xxx
  network:
    podCIDR: 100.64.0.0/10
    svcCIDR: 10.96.0.0/22
  certSANS:
    - aliyun-inc.com
    - 10.0.0.2
  masters:
    ipList:
     - 192.168.0.2
     - 192.168.0.3
     - 192.168.0.4
  nodes:
    ipList:
     - 192.168.0.5
     - 192.168.0.6
     - 192.168.0.7
---
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
  name: hostname
spec:
  type: HOSTNAME
  data: |
     192.168.0.2 master-0
     192.168.0.3 master-1
     192.168.0.4 master-2
     192.168.0.5 node-0
     192.168.0.6 node-1
     192.168.0.7 node-2
---
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
  name: taint
spec:
  type: SHELL
  action: PostInstall
  on: node-role.kubernetes.io/master=
  data: |
     kubectl taint nodes node-role.kubernetes.io/master=:NoSchedule
```

```
sealer apply -f Clusterfile #plugin仅在安装时执行，后续apply不生效。
```

> 执行上述命令后hostname，shell plugin将修改主机名并在成功安装集群后执行shell命令。

## 在Kubefile中定义默认插件

很多情况下在不使用Clusterfile的情况下也能使用插件，本质上sealer会先把Clusterfile中的插件配置先存储到 rootfs/plugins目录，再去使用，所以我们可以在制作镜像时就定义好默认插件。

插件配置文件 shell.yaml:

```yaml
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
name: taint
spec:
type: SHELL
action: PostInstall
on: node-role.kubernetes.io/master=
data: |
  kubectl get nodes
---
apiVersion: sealer.aliyun.com/v1alpha1
kind: Plugin
metadata:
  name: SHELL
spec:
  action: PostInstall
  data: |
    if type yum >/dev/null 2>&1;then
    yum -y install iscsi-initiator-utils
    systemctl enable iscsid
    systemctl start iscsid
    elif type apt-get >/dev/null 2>&1;then
    apt-get update
    apt-get -y install open-iscsi
    systemctl enable iscsid
    systemctl start iscsid
    fi
```

Kubefile:

```shell script
FROM kubernetes:v1.19.8
COPY shell.yaml plugin
```

构建一个包含安装iscsi的插件(或更多插件)的集群镜像:

```shell script
sealer build -m lite -t kubernetes-iscsi:v1.19.8 .
```

通过镜像启动集群后插件也将被执行，而无需在Clusterfile中定义插件:
`sealer run kubernetes-iscsi:v1.19.8 -m x.x.x.x -p xxx`