Skip to main content

ASUS Chromebook Flip C302CA を chrx で GalliumOS とのデュアルブートにする

Chromebook、便利ですね。ここ何年かずっと愛用しています。持ち歩く場合はだいたいこれです。

そしてこれを使っているときに、たまにさくっとした Linux 環境が欲しくなることがあり、その目的でこれまでは crouton で chroot した xubuntu が動くようにしていたのですが、ハードウェアの制御(特にグラフィック)まわりでどうも不都合なシーンがちらほら出てくるようになりました。

そんなわけで、とりあえず別のものを、ということで、chrx を使って GalliumOS をデュアルブートな感じで動かすことにしました。

前提

  • RW_LEGACY をカスタムの SeaBIOS で書き換え済み
  • デベロッパモードに変更済み

手順

インストールして初期設定をしていきます。

パーティション分割

Ctrl + Alt + Tcrosh を立ち上げて、シェルを起動します。

> shell

まずはパーティションを作ります。この辺も chrx におまかせです。以下を実行して、指示に従って数字を入力します。今回は 16 GB にしました。

$ cd ; curl -Os https://chrx.org/go && sh go

再起動しろと言われるので再起動すると、自動修復が始まります。左上のカウントが 00:00 になっても何も起きなくて怖いですが、そのまま気にせずに数分放置しておくと、勝手に起動してきます。

起動してきたら、ChromeOS が完全に初期化されている状態なので、初期設定をして、ネットワークにつなげます。

インストール

パーティションが切れたら、またシェルを起動して、GalliumOS をインストールします。

$ cd ; curl -Os https://chrx.org/go && sh go -d galliumos -H c302ca -U kuro -p steam -p chrome -p admin-misc -L ja_JP.UTF-8

引数で渡すオプションは、-h で出るヘルプを見ながら適当にします。-H が設定するホスト名、-U が作成するユーザ名です。

試した感じだと、タイムゾーン(-Z)の指定はうまく機能しなかったので、起動後に変更することにして、ここでは省きました。

で、数十分で完了するので、指示に従って再起動し、通常 Ctrl + D で起動するところで Ctrl + L して、GalliumOS を起動させ、ログインします。

ユーザ名は -U で指定したもので、初期パスワードはユーザ名と同一です。

日本語関連パッケージの導入

起動したら、言語周りを整えます。インストール時に -Lja_JP.UTF-8 を指定しても、日本語環境で必要なすべてのパッケージが導入されるわけではないようです。

で、Xfce のまま GUI から不足パッケージを突っ込もうとしたところ、固まって死んでしまいました。いちど multi-user.target に切り替えて作業するほうが良さそうです。

そんなわけで、ターミナルを起動して、

$ sudo systemctl isolate multi-user.target

して、画面左上でカーソルが点滅したら、Alt + F1F1ESC の右隣のキー)で仮想コンソールを切り替えてログインして、パッケージを入れて再起動します。

$ sudo apt update
$ sudo apt install $(check-language-support -l ja)
$ sudo reboot

日本語入力の設定

起動後、日本語入力ができるようにします。

  1. 左下のメニュ(Whisler Menu)の [設定] > [言語サポート] で、[キーボード入力に使う IM システム]fcitx になっていることを確認します
  2. 右下の通知エリアのキーボードアイコンの右クリックメニュから [設定] を開き、Mozc だけを残して、それ以外をすべて - ボタンで削除します

これで、

  • キーボードレイアウトが正しい
  • キーボード左上の [かな <-> 英数] キーで日本語入力と直接入力を切り替えられる

な状態になります。im-config とか fcitx-configtool でも設定できる気がします。たぶん。

パスワードの変更

キーボードレイアウトが正しくなったので、ターミナルで passwd してパスワードを変更します。

タイムゾーンの設定

UTC のままなので、JST にします。

  1. メニュの [設定] > [時刻と日付の設定] で、[Unlock] します
  2. [タイムゾーン]Asia/Tokyo にして、[Lock] します

timedatectl でも大丈夫です。反映は再起動後です。

オーディオの修正

GalliumOS の Hardware Compatibility でも記載されているとおり、C302(というか Skylake 系全般)は内蔵オーディオが正常に動作しないようです。実際、スピーカから何らかの音を再生させると、バキバキでひどい状態です。

USB や Bluetooth 接続のオーディオであれば正常に動作するようですが、GitHub の issue #379 で無理やりがんばる方法が出ていたのでそれをやっておきます。

Google Drive 上にアップロードされた以下をダウンロードして、

ターミナルでこれらを使ってごにょごにょします。

$ sudo dpkg -i linux-image-4.16.18-galliumos5-pre1_amd64.deb
$ sudo dpkg -x galliumos-skylake_3.0+dev3_supports_GaOS2.1_all.deb /
$ sudo skylake-audio-helper get-topology
$ sudo rm /lib/firmware/9d70-CORE-COREBOOT-0-tplg.bin
$ sudo rm /lib/firmware/9d70-COREv4-COREBOOT-0-tplg.bin
$ sudo rm /lib/firmware/9d70-INTEL-SCRDMAX-0-tplg.bin
$ sudo skylake-audio-helper reset
$ sudo reboot

reset のときにスピーカがポンッてなるのでちょっとびっくりしました。再起動後は音声が正常に再生できます。


Rapsberry Pi

冬休みの自由研究: EdgeX Foundry (7) Kubernetes 上で Fuji リリースを動かす

EdgeX Foundry 関連エントリ

EdgeX Foundry と Kubernetes

これまでの EdgeX Foundry 関連エントリでは、一貫してその動作を Docker Compose に任せていました。公式でも Docker Compose や Snaps を利用して動作させる手順が紹介されています。

が、最近よく Kubernetes(や OpenShift)を触っていることもあり、コンテナなら Kubernetes でも動かせるよね! という気持ちになったので、やってみました。

なお、現段階では、Kubernetes 上で動作させるためのマニフェストファイルは、公式には用意されていません。また、そもそも EdgeX Foundry は HA 構成を明確にはサポートしておらず、実装上も考慮されていないようです。つまり、仮に Kubernetes で動作させられたとしても、レプリカを増やしてロードバランスするような状態での正常な動作は何の保証もないことになります。

というわけで、現状ではあくまで実験程度に捉えておくのがよいと思います。

今回の目標

後述しますが、EdgeX Foundry の Kubernetes 上での動作は、過去にすでに試みられているので、今回はそれらの先行実装で解決されていない以下の 2 点を解消できる実装を目標としました。

  1. 現時点での Fuji リリースを動作させられること
  2. マルチノード構成の Kubernetes で動かせること

幸いなことに、自宅の vSphere 環境では Cluster API を使ってマルチノードの Kubernetes 環境がすぐに作れるようになっている ので、この環境を使います。

できあがったマニフェスト

紆余曲折を経てひとまず動くものができたので、リポジトリ に置いてあります。

以下、使い方を簡単に紹介します。リポジトリはあらかじめクローンしておきます。

$ git clone https://github.com/kurokobo/edgex-on-kubernetes.git
$ cd edgex-on-kubernetes

Persistent Volume の用意

PV を 4 つ使うので、PV の実体となるものを用意します。今回は QNAP を NFS ストレージとして使いました。

エクスポートされた NFS 領域を適当な作業用の Linux 端末からマウントして、PV の実体となるサブディレクトリを作っておきます。

$ mount -t nfs 192.168.0.200:/k8s /mnt/k8s
$ for i in $(seq -f %03g 100); do sudo mkdir /mnt/k8s/pv$i; done
$ umount /mnt/k8s

続けて、これらの NFS 領域を Kubernetes の PersistentVolume として定義します。マニフェストの中身はこんな感じです。

$ cat persistentvolumes/nfs/pv001-persistentvolume.yaml
apiVersion: v1
kind: PersistentVolume
metadata:
  name: pv001
spec:
  capacity:
    storage: 512Mi
  accessModes:
    - ReadWriteMany
  persistentVolumeReclaimPolicy: Recycle
  nfs:
    server: 192.168.0.200
    path: /k8s/pv001

当然ですが、これはぼくの環境に合わせたものなので、それ以外の環境で動かす場合は適宜修正は必要です。今回は nfs で書いていますが、hostPath でも gcePersistentDisk でも好きなようにしてください。

逆にいえば、Deployment ではボリュームを PVC で割り当てているので、環境に合わせて編集するのは PV だけでどうにかなる気がします。

マニフェストができたら、kubectl create します。

$ ls persistentvolumes/nfs/*.yaml | xargs -n 1 kubectl create -f
persistentvolume/pv001 created
persistentvolume/pv002 created
persistentvolume/pv003 created
persistentvolume/pv004 created

$ kubectl get pv
NAME    CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS      CLAIM   STORAGECLASS   REASON   AGE
pv001   512Mi      RWX            Recycle          Available                                   22s
pv002   128Mi      RWX            Recycle          Available                                   22s
pv003   128Mi      RWX            Recycle          Available                                   22s
pv004   128Mi      RWX            Recycle          Available                                   22s

Persistent Volume Claim の用意

PV ができたら、PVC を作ります。

$ ls persistentvolumeclaims/*.yaml | xargs -n 1 kubectl create -f
persistentvolumeclaim/consul-config created
persistentvolumeclaim/consul-data created
persistentvolumeclaim/db-data created
persistentvolumeclaim/log-data created

$ kubectl get pv,pvc
NAME                     CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM                   STORAGECLASS   REASON   AGE
persistentvolume/pv001   512Mi      RWX            Recycle          Bound    default/db-data                                 11m
persistentvolume/pv002   128Mi      RWX            Recycle          Bound    default/consul-data                             11m
persistentvolume/pv003   128Mi      RWX            Recycle          Bound    default/log-data                                11m
persistentvolume/pv004   128Mi      RWX            Recycle          Bound    default/consul-config                           11m

NAME                                  STATUS   VOLUME   CAPACITY   ACCESS MODES   STORAGECLASS   AGE
persistentvolumeclaim/consul-config   Bound    pv004    128Mi      RWX                           8s
persistentvolumeclaim/consul-data     Bound    pv002    128Mi      RWX                           8s
persistentvolumeclaim/db-data         Bound    pv001    512Mi      RWX                           8s
persistentvolumeclaim/log-data        Bound    pv003    128Mi      RWX                           7s

PV の STATUSBound になって、PVC の VOLUME で PV が対応付けられていれば大丈夫です。

Service の作成

続けて SVC を作ります。マニフェストファイル内で、外部から触りそうなヤツだけ type: LoadBalancer を書いて外部 IP アドレスを持たせています。

$ ls services/*.yaml | xargs -n 1 kubectl create -f
service/edgex-app-service-configurable-rules created
service/edgex-core-command created
service/edgex-core-consul created
service/edgex-core-data created
service/edgex-core-metadata created
service/edgex-device-virtual created
service/edgex-mongo created
service/edgex-support-logging created
service/edgex-support-notifications created
service/edgex-support-rulesengine created
service/edgex-support-scheduler created
service/edgex-sys-mgmt-agent created
service/edgex-ui-go created

$ kubectl get svc
NAME                                   TYPE           CLUSTER-IP       EXTERNAL-IP    PORT(S)                          AGE
edgex-app-service-configurable-rules   ClusterIP      100.67.112.145   <none>         48100/TCP                        8s
edgex-core-command                     LoadBalancer   100.69.10.125    192.168.0.50   48082:31022/TCP                  8s
edgex-core-consul                      LoadBalancer   100.71.56.117    192.168.0.51   8400:30675/TCP,8500:32711/TCP    8s
edgex-core-data                        LoadBalancer   100.70.131.230   192.168.0.52   48080:31879/TCP,5563:31195/TCP   8s
edgex-core-metadata                    LoadBalancer   100.68.152.47    192.168.0.53   48081:30265/TCP                  8s
edgex-device-virtual                   ClusterIP      100.70.115.198   <none>         49990/TCP                        8s
edgex-mongo                            LoadBalancer   100.69.209.129   192.168.0.54   27017:30701/TCP                  7s
edgex-support-logging                  ClusterIP      100.65.29.76     <none>         48061/TCP                        7s
edgex-support-notifications            ClusterIP      100.65.127.176   <none>         48060/TCP                        7s
edgex-support-rulesengine              ClusterIP      100.64.125.224   <none>         48075/TCP                        7s
edgex-support-scheduler                ClusterIP      100.70.168.47    <none>         48085/TCP                        7s
edgex-sys-mgmt-agent                   LoadBalancer   100.68.113.150   192.168.0.55   48090:32466/TCP                  7s
edgex-ui-go                            LoadBalancer   100.64.153.22    192.168.0.56   4000:32252/TCP                   7s
kubernetes                             ClusterIP      100.64.0.1       <none>         443/TCP                          14m

外部からの触りっぷりをもうちょっときれいにしたい場合は、Ingress でも作るとよいと思います。

Deployment の作成と Consul の初期化

ここまでできたら、あとは順次マイクロサービスを起動していきます。

最初に、edgex-files を起動させて、PV 内にファイルを配置します。その後、Consul(edgex-core-consul)を起動させます。

$ kubectl create -f pods/edgex-files-pod.yaml
pod/edgex-files created

$ while [[ $(kubectl get pods edgex-files -o "jsonpath={.status.phase}") != "Succeeded" ]]; do sleep 1; done

$ kubectl create -f deployments/edgex-core-consul-deployment.yaml
deployment.apps/edgex-core-consul created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-core-consul
deployment.apps/edgex-core-consul condition met

Consul が起動したら、edgex-core-config-seed を動作させて、Consul に初期設定値を登録させます。

$ kubectl create -f pods/edgex-core-config-seed-pod.yaml
pod/edgex-core-config-seed created

$ while [[ $(kubectl get pods edgex-core-config-seed -o "jsonpath={.status.phase}") != "Succeeded" ]]; do sleep 1; done

edgex-filesedgex-core-config-seed は、それぞれ edgex-files はファイルのコピーが終わったら、edgex-core-config-seed は Consul に値を登録し終わったら不要になります。そのため、ここではこれらは Deployment リソースとしてではなく Pod リソースとして定義しています。

残りの Deployment の作成

残りのマイクロサービスを起動していきます。

$ kubectl create -f deployments/edgex-mongo-deployment.yaml
deployment.apps/edgex-mongo created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-mongo
deployment.apps/edgex-mongo condition met

$ kubectl create -f deployments/edgex-support-logging-deployment.yaml
deployment.apps/edgex-support-logging created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-support-logging
deployment.apps/edgex-support-logging condition met

$ kubectl create -f deployments/edgex-support-notifications-deployment.yaml
deployment.apps/edgex-support-notifications created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-support-notifications
deployment.apps/edgex-support-notifications condition met

$ kubectl create -f deployments/edgex-core-metadata-deployment.yaml
deployment.apps/edgex-core-metadata created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-core-metadata
deployment.apps/edgex-core-metadata condition met

$ kubectl create -f deployments/edgex-core-data-deployment.yaml
deployment.apps/edgex-core-data created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-core-data
deployment.apps/edgex-core-data condition met

$ kubectl create -f deployments/edgex-core-command-deployment.yaml
deployment.apps/edgex-core-command created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-core-command
deployment.apps/edgex-core-command condition met

$ kubectl create -f deployments/edgex-support-scheduler-deployment.yaml
deployment.apps/edgex-support-scheduler created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-support-scheduler
deployment.apps/edgex-support-scheduler condition met

$ kubectl create -f deployments/edgex-support-rulesengine-deployment.yaml
deployment.apps/edgex-support-rulesengine created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-support-rulesengine
deployment.apps/edgex-support-rulesengine condition met

$ kubectl create -f deployments/edgex-app-service-configurable-rules-deployment.yaml
deployment.apps/edgex-app-service-configurable-rules created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-app-service-configurable-rules
deployment.apps/edgex-app-service-configurable-rules condition met

$ kubectl create -f deployments/edgex-device-virtual-deployment.yaml
deployment.apps/edgex-device-virtual created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-device-virtual
deployment.apps/edgex-device-virtual condition met

$ kubectl create -f deployments/edgex-sys-mgmt-agent-deployment.yaml
deployment.apps/edgex-sys-mgmt-agent created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-sys-mgmt-agent
deployment.apps/edgex-sys-mgmt-agent condition met

$ kubectl create -f deployments/edgex-ui-go-deployment.yaml
deployment.apps/edgex-ui-go created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-ui-go
deployment.apps/edgex-ui-go condition met

完成

完成です。

$ kubectl get all,pv,pvc
NAME                                                        READY   STATUS      RESTARTS   AGE
pod/edgex-app-service-configurable-rules-6c794d754d-xj4v4   1/1     Running     0          92s
pod/edgex-core-command-cc8465b6f-kgwhm                      1/1     Running     0          98s
pod/edgex-core-config-seed                                  0/1     Completed   0          2m13s
pod/edgex-core-consul-5b8cdbbfc8-g7j6t                      1/1     Running     0          2m26s
pod/edgex-core-data-c7775c56b-t8rdf                         1/1     Running     0          100s
pod/edgex-core-metadata-66f86d86b-mfqfg                     1/1     Running     0          102s
pod/edgex-device-virtual-597f9d77f-vqlln                    1/1     Running     0          90s
pod/edgex-files                                             0/1     Completed   0          6m13s
pod/edgex-mongo-99c7d8957-fsz6c                             1/1     Running     0          110s
pod/edgex-support-logging-8566649bf8-dj8fw                  1/1     Running     0          107s
pod/edgex-support-notifications-586cf544f-n8md7             1/1     Running     0          104s
pod/edgex-support-rulesengine-6cfc49f89b-xn8fc              1/1     Running     0          94s
pod/edgex-support-scheduler-7658f985bb-9bmz2                1/1     Running     0          96s
pod/edgex-sys-mgmt-agent-5dd56c65bb-tnqth                   1/1     Running     0          88s
pod/edgex-ui-go-54668dcc94-mdx2d                            1/1     Running     0          86s

NAME                                           TYPE           CLUSTER-IP       EXTERNAL-IP    PORT(S)                          AGE
service/edgex-app-service-configurable-rules   ClusterIP      100.67.11.126    <none>         48100/TCP                        7m33s
service/edgex-core-command                     LoadBalancer   100.71.84.78     192.168.0.50   48082:32108/TCP                  7m33s
service/edgex-core-consul                      LoadBalancer   100.66.136.131   192.168.0.51   8400:31442/TCP,8500:31806/TCP    7m32s
service/edgex-core-data                        LoadBalancer   100.64.210.255   192.168.0.52   48080:31808/TCP,5563:30664/TCP   7m32s
service/edgex-core-metadata                    LoadBalancer   100.67.207.51    192.168.0.53   48081:32379/TCP                  7m32s
service/edgex-device-virtual                   ClusterIP      100.69.130.2     <none>         49990/TCP                        7m32s
service/edgex-mongo                            LoadBalancer   100.66.8.30      192.168.0.54   27017:31973/TCP                  7m32s
service/edgex-support-logging                  ClusterIP      100.68.171.73    <none>         48061/TCP                        7m32s
service/edgex-support-notifications            ClusterIP      100.67.242.204   <none>         48060/TCP                        7m32s
service/edgex-support-rulesengine              ClusterIP      100.67.203.199   <none>         48075/TCP                        7m32s
service/edgex-support-scheduler                ClusterIP      100.65.53.193    <none>         48085/TCP                        7m31s
service/edgex-sys-mgmt-agent                   LoadBalancer   100.65.122.248   192.168.0.55   48090:31476/TCP                  7m31s
service/edgex-ui-go                            LoadBalancer   100.70.107.81    192.168.0.56   4000:30852/TCP                   7m31s
service/kubernetes                             ClusterIP      100.64.0.1       <none>         443/TCP                          47m

NAME                                                   READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/edgex-app-service-configurable-rules   1/1     1            1           92s
deployment.apps/edgex-core-command                     1/1     1            1           98s
deployment.apps/edgex-core-consul                      1/1     1            1           2m26s
deployment.apps/edgex-core-data                        1/1     1            1           100s
deployment.apps/edgex-core-metadata                    1/1     1            1           102s
deployment.apps/edgex-device-virtual                   1/1     1            1           90s
deployment.apps/edgex-mongo                            1/1     1            1           110s
deployment.apps/edgex-support-logging                  1/1     1            1           107s
deployment.apps/edgex-support-notifications            1/1     1            1           104s
deployment.apps/edgex-support-rulesengine              1/1     1            1           94s
deployment.apps/edgex-support-scheduler                1/1     1            1           96s
deployment.apps/edgex-sys-mgmt-agent                   1/1     1            1           88s
deployment.apps/edgex-ui-go                            1/1     1            1           86s

NAME                                                              DESIRED   CURRENT   READY   AGE
replicaset.apps/edgex-app-service-configurable-rules-6c794d754d   1         1         1       92s
replicaset.apps/edgex-core-command-cc8465b6f                      1         1         1       98s
replicaset.apps/edgex-core-consul-5b8cdbbfc8                      1         1         1       2m26s
replicaset.apps/edgex-core-data-c7775c56b                         1         1         1       100s
replicaset.apps/edgex-core-metadata-66f86d86b                     1         1         1       102s
replicaset.apps/edgex-device-virtual-597f9d77f                    1         1         1       90s
replicaset.apps/edgex-mongo-99c7d8957                             1         1         1       110s
replicaset.apps/edgex-support-logging-8566649bf8                  1         1         1       107s
replicaset.apps/edgex-support-notifications-586cf544f             1         1         1       104s
replicaset.apps/edgex-support-rulesengine-6cfc49f89b              1         1         1       94s
replicaset.apps/edgex-support-scheduler-7658f985bb                1         1         1       96s
replicaset.apps/edgex-sys-mgmt-agent-5dd56c65bb                   1         1         1       88s
replicaset.apps/edgex-ui-go-54668dcc94                            1         1         1       86s

NAME                     CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM                   STORAGECLASS   REASON   AGE
persistentvolume/pv001   512Mi      RWX            Recycle          Bound    default/db-data                                 8m11s
persistentvolume/pv002   128Mi      RWX            Recycle          Bound    default/consul-config                           8m11s
persistentvolume/pv003   128Mi      RWX            Recycle          Bound    default/consul-data                             8m10s
persistentvolume/pv004   128Mi      RWX            Recycle          Bound    default/log-data                                8m10s

NAME                                  STATUS   VOLUME   CAPACITY   ACCESS MODES   STORAGECLASS   AGE
persistentvolumeclaim/consul-config   Bound    pv002    128Mi      RWX                           8m4s
persistentvolumeclaim/consul-data     Bound    pv003    128Mi      RWX                           8m4s
persistentvolumeclaim/db-data         Bound    pv001    512Mi      RWX                           8m4s
persistentvolumeclaim/log-data        Bound    pv004    128Mi      RWX                           8m4s

動作確認

標準で edgex-device-virtual が動いているので、edgex-core-data のログなどを除けば値が取り込まれていることが観察できます。

$ kubectl logs edgex-core-data-c7775c56b-t8rdf --tail 4
level=INFO ts=2020-03-01T07:41:47.454970177Z app=edgex-core-data source=event.go:240 msg="Putting event on message queue"
level=INFO ts=2020-03-01T07:41:47.455410868Z app=edgex-core-data source=event.go:258 msg="Event Published on message queue. Topic: events, Correlation-id: 4d142e84-f3b2-49cd-a1d4-8be7dc7e5d36 "
level=INFO ts=2020-03-01T07:41:47.47515949Z app=edgex-core-data source=event.go:240 msg="Putting event on message queue"
level=INFO ts=2020-03-01T07:41:47.47523845Z app=edgex-core-data source=event.go:258 msg="Event Published on message queue. Topic: events, Correlation-id: 6e6f7f2a-da7f-4fc7-ac1f-85e5918c31ed "

適当に MQTT トピックにエクスポートさせると、実際に値が届いていることが確認できます。エクスポート先の MQTT ブローカは、マニフェストファイルで環境変数として定義しているので、適宜修正してください。

$ docker run -d --rm --name broker -p 1883:1883 eclipse-mosquitto
598878ed584699c61b4ccb95cdaeb53cc70b3a56793b53c83db1511483dc037a

$ kubectl create -f deployments/edgex-app-service-configurable-mqtt-export-deployment.yaml
deployment.apps/edgex-app-service-configurable-mqtt-export created

$ kubectl wait --for=condition=available --timeout=60s deployment edgex-app-service-configurable-mqtt-export
deployment.apps/edgex-app-service-configurable-mqtt-export condition met

$ docker run --init --rm -it efrecon/mqtt-client sub -h 192.168.0.100 -t "#" -v
edgex-handson-topic {"id":"5a79e954-6c3f-4635-9e60-d93379a2a7ec","device":"Random-UnsignedInteger-Device","origin":1583049398041588772,"readings":[{"id":"529f5003-47b6-45ab-a743-7b4a21d937f4","origin":1583049398026423142,"device":"Random-UnsignedInteger-Device","name":"Uint8","value":"80"}]}
edgex-handson-topic {"id":"2cd0b56e-28c8-4035-9351-75028b37afef","device":"Random-UnsignedInteger-Device","origin":1583049398427444993,"readings":[{"id":"0a041b11-76f9-426c-9098-75affe58ea89","origin":1583049398412848451,"device":"Random-UnsignedInteger-Device","name":"Uint64","value":"2542183823530459689"}]}
edgex-handson-topic {"id":"00aaffb1-27ca-43ff-8150-ace2eefe2a32","device":"Random-Boolean-Device","origin":1583049398815297954,"readings":[{"id":"7ecc8518-ae56-4c78-8527-dd3442b14c6d","origin":1583049398800419572,"device":"Random-Boolean-Device","name":"Bool","value":"false"}]}
...

残されている問題

そんなわけで、とりあえずは動いていますが、

  • 起動・停止が面倒
    • マイクロサービス間に依存関係があり、起動順序に配慮が必要(依存関係自体は Docker Compose でも定義されているし起動順序も公式ドキュメントに書いてあるので無視できない)
    • Kubernetes では起動順序を制御しにくい(実装が検討されているっぽい のでそれに期待)
    • 現状では、コマンド群をシェルスクリプトにするか、InitContianers などでがんばるのが精々。Kustomize とか Helm でも細かい順序制御はしんどい気がする
  • 設定ファイルの流し込みがしにくい
    • configuration.toml などをコンテナに渡しにくい
    • PV を新しく作って InitContainers で git clone するなどの工夫が必要
  • ヘルスチェックをしていない
    • いわゆる Liveness Probe、Rediness Probe の追加をサボった
  • edgex-sys-mgmt-agent が部分的に動かないかも(未確認)
    • /var/run/docker.sock を消したが影響を確認していない

あたりに本気で使うにはハードルがありそうです。将来的には公式に参考実装やベストプラクティスが出てくるといいですね。

マニフェストの作成過程

いきなりできあがったモノを紹介しましたが、作る過程をざっくり書いておきます。

とりあえず Kompose で変換する

Docker Compose ファイルを Kubernetes 用のマニフェストに変換できる Kompose というものがあります。おもむろにこれに突っ込めば完成!

$ kompose convert -f docker-compose.yml
INFO Network edgex-network is detected at Source, shall be converted to equivalent NetworkPolicy at Destination
...
INFO Kubernetes file "app-service-rules-service.yaml" created
...
INFO Kubernetes file "edgex-network-networkpolicy.yaml" created

となるはずもなく、このままだと全然動きません。この作業で、

  • Services(*-service.yaml
  • Deployments(*-deployment.yaml
  • Persistent Volyme Claims(*-persistentvolumeclaim.yaml
  • Network Policy(*-networkpolicy.yaml

の 4 種類のファイルができあがっています。

このままだと動かないとは言いつつ、ベースとしては充分使えるので、これを編集していく形で実装を考えます。

アーキテクチャを考える

この段階で、テストだからがばがばでよしとすることにして、Network Policy のマニフェストは消しました。

残りのマニフェストで定義された構成を、以下のように考えて組み替えていきます。

  • 共有ボリュームの持たせ方
    • Docker Compose ファイルだと、ボリュームが無駄に広い範囲で共有されすぎている気がする
    • 最新の Nightly Build リリースの Docker Compose ファイルをみると、最小限に絞られていそうだ
    • Nightly Build 版での共有っぷりを参考に、今回も共有範囲は最小限に絞ることにする
  • 共有ボリュームへのファイルの配置の仕方
    • edgex-files のコンテナイメージ内に共有ボリューム上に置くべきファイルが保存されている
    • Docker Compose と同じようにマウントしてしまうと、既存のファイルがオーバライドされて見えなくなる
    • 別のパスにマウントして、commandargs で必要なファイルをコピーさせるようにする
    • 一度だけ動けばよいので、restartPolicyNever にした Pod にする
  • 設定の配り方
    • 先行実装では edgex-config-seed を消し去っていた(ローカルの設定ファイルを使わせていた)例がある
    • とはいえ EdgeX Foundry は Consul ありきでできているフシもあるので、できれば Docker Compose のときと同じようにしたい
    • 一度だけ動けばよいので、restartPolicyNever にした Pod にする
  • Docker ならではの実装の排除
    • Portainer は Docker 前提なので消すことにする
    • /var/run/docker.sock のマウントも Docker 前提なので消すことにする
  • PV の作り方
    • Deployment に直接 PV を持たせるのではなく、お作法通り PVC を使ってマウントさせるようにする

マニフェストの整形

方針が決まったら、Kompose で変換されたマニフェストファイルを実際にきれいにしていきます。

  • Services
    • metadata を削除、または修正
    • ほかのマイクロサービスから正しく名前解決できるように name を各マイクロサービスのホスト名に修正
    • selector を Deployment に合わせて修正
    • 外部からアクセスしそうなサービスに type: LoadBalancer を追加
  • Deployments
    • API バージョンを修正、併せて必須パラメータ(selector)追加
    • metadata を削除、または修正
    • Deployment と Pod の name を各マイクロサービスのホスト名に統一
    • 不要なボリュームの削除
    • edgex-core-config-seededgex-files の削除
  • Pods
    • edgex-core-config-seededgex-files を新規に追加
    • restartPolicy やボリュームの変更、commandargs の追加
  • Persistent Volume Claims
    • metadata を削除、または修正
    • accessModesReadWriteMany に変更
    • サイズを変更(値は このとき の実使用量を基に決定)
  • Persistent Volumes
    • 新規に追加

こまごまトラブルシュート

で、だいたいできたと思ったら、一部のマイクロサービスで、REST エンドポイントとして必要な HTTP サーバが起動しない状態になりました。以下のような具合で、起動しようとした直後に停止してしまっています。

$ kubectl logs edgex-support-logging-66fc4f6c98-28bk4
...
level=INFO ts=2020-02-25T12:47:50.622662811Z app=edgex-support-logging source=httpserver.go:72 msg="Web server starting (edgex-support-logging:48061)"
level=INFO ts=2020-02-25T12:47:50.624106767Z app=edgex-support-logging source=httpserver.go:80 msg="Web server stopped"
...

いろいろ調べたら、以下のような状態のようでした。

  • edgex-go リポジトリで管理されているマイクロサービスで起きる
  • HTTP サーバは、マイクロサービスの起動時に <ホスト名>:<ポート番号> で待ち受けを指示される
    • 上記のログの例だと edgex-support-logging:48061
    • 待ち受けのホスト名とポート番号は Consul から受け取る
  • HTTP サーバは、指示された <ホスト名> の名前解決を試みる
    • コンテナ内の /etc/hosts を無視して、Kubernetes による名前解決が行われる
    • 名前解決したいホスト名が Service の名前と一致しているため、Kubernetes の ClusterIP に解決される
  • Pod 内のプロセスからは ClusterIP は利用できない(Pod の IP アドレスしか認識されない)ため、待ち受けできずに死ぬ

Consul 上のホスト名を書き換えるのも、Pod と Service でホスト名を別にするのも、副作用がわからないのでできれば避けたいところです。そもそも Kubernetes の仕様上、コンテナ内の /etc/hosts には Pod の IP アドレスと Pod のホスト名が正しく書いてあるわけですから、これを参照してくれさえすればよいだけの話です。

が、Go 言語のデフォルトの名前解決の仕組みでは、/etc/nsswitch.conf が存在しない(または存在していても中で files が指定されていない)場合に、/etc/hosts は無視されるようです。この挙動の修正は 1.15 のロードマップに乗っている ものの、要するに、現時点ではそういう仕様ということになります。

そして、問題が起きているマイクロサービスのコンテナイメージは、scratchalpine などがベースになっているので、/etc/nsswitch.conf が存在しません。

というわけで、いろいろな仕様が重なった結果として、こういう問題が引き起こされています。がんばりましょう。

この解決にあたって、以下の 3 案を考えました。今回はいちばんマニフェストへの取り込みがラクな最初の案を採用しています。

  • 環境変数 GODEBUG に、値 netdns=cgo を与える
    • 名前解決に Go 標準ではなく CGO の仕組みを使うことを強制するオプション
    • CGO では /etc/nsswitch.conf が存在していなくても /etc/hosts が読み取られる
  • /etc/nsswitch.conf(中身は hosts: files dns)をコンテナ内に配置する
    • コンテナイメージを自製するか、PV や InitContainer などを使ってがんばる必要がある
  • Consul の K/V ストアの /edgex/core/1.0/*/Service/Host を全部 0.0.0.0 にする
    • Consul を起動させて、手で書き換えてから残りのサービスを起動するようにする
    • 副作用が不明

先行実装

冒頭で書いた通り、EdgeX Foundry の Kubernetes 上での動作は、すでに過去に試みられています。現状で確認できているものを簡単に紹介します。

EdgeX on Kubernetes

EdgeX Foundry のブログの 2018 年のエントリで、当時のリリースを Kubernetes で動作させる例が紹介されています。

2018 年当時なので、使われているイメージは古く、どうやら Barcelona ベースのようです。

また、共有ボリュームとして利用する PV が hostPath で定義されているので、シングルノード上での動作が前提になっているものと推測されます。

edgex-kubernetes-support

GitHub の edgexfoundry-holding 配下のリポジトリとして用意されています。比較的新しめです。

こちらは Edinburgh をベースにしたものと Nightly Build をベースにしたものがありました。Nightly Build とはいえ、半年以上前のそれなので、実際は Fuji 相当に近そうです。Helm チャートも用意されています。

K8s だけでなく K3s も対象としている点はうれしいですが、これも PV が hostPath で定義されているので、シングルノードでの動作を前提としているようです。

まとめ

EdgeX Foundry の Fuji リリースを、マルチノード構成の Kubernetes 上で動作させるためのマニフェストファイルを作成して、動作を確認しました。

Kompose は便利ですが、やはりそれなりの規模の Docker Compose ファイルだと完全に無編集でそのまま使えるというわけにはいかないですね。よい経験になりました。

EdgeX Foundry も Kubernetes も、本当に日々更新されていっているので、追従し続けるのは相当しんどそうです。このブログの EdgeX Foundry 関連エントリも、来月に予定されている次期バージョン(Geneva)のリリースですぐに時代遅れになるわけです。がんばりましょう。

EdgeX Foundry 関連エントリ


Cluster API で vSphere 上の Kubernetes クラスタを管理する

きっかけ

実験したいことが出てきてしまい、自宅で Kubernetes を触りたくなりました。

これまで Kubernetes を触る場合は Google Kubernetes Engine(GKE)ばかりを使っていたのですが、 今回実験したいのは IoT の世界でいうエッジ側の話なので、できればオンプレミス相当の Kuberentes クラスタが欲しいところです。

そんなわけで、これ幸いと自宅の vSphere 環境で Cluster API を叩いてゲストクラスタを作ることにしました。Cluster API は、2019 年に VMware から発表された VMware Tanzu や Project Pacific の実装でも使われているそうで、そういう意味でも興味のあるところです。

VMware Tanzu や Project Pacific は、エントリの本筋ではないので細かくは書きませんが、めっちゃ雑に書くと、vSphere と Kubernetes がイケてる感じにくっついたヤツです。

Cluster API とは

Cluster API は、Kubernetes っぽいお作法で Kubernetes クラスタそれ自体を管理できる仕組みです。Kubernetes の SIG のプロジェクト として開発が進められています。

最新バージョンは 2019 年 9 月にリリースされた v1alpha2 で、現在は v1alpha3 が開発中です。バージョン名を見てもわかる通り、現段階ではいわゆるアルファ版ですし、ドキュメントでも『プロトタイプだよ』『どんどん変わるからね』と記載されているので、ごりごりに使い込むのはまだちょっと待ったほうがよさそうですね。

Cluster API is still in a prototype stage while we get feedback on the API types themselves. All of the code here is to experiment with the API and demo its abilities, in order to drive more technical feedback to the API design. Because of this, all of the codebase is rapidly changing.

https://github.com/kubernetes-sigs/cluster-api/blob/master/README.md

Kubernetes クラスタを構成するノードは、多くの場合は仮想マシンです。その仮想マシンは、パブリッククラウド上だったりオンプレミスの vSphere 上や OpenStack 上だったりで動いているわけですが、Cluster API では、そうしたプラットフォームごとに Provider なる実装が用意されており、環境差異を抽象化してくれます。これにより、異なる環境でも同一の操作感で Kubernetes クラスタを管理できます。

今回は vSphere 環境上の Kubernetes クラスタの構成が目的なので、vSphere 用の Provider を使って作業します。

構成要素と構成の流れ

最終的には、いわゆる Kubernetes らしく業務や開発で様々なアプリケーションを動作させることになる Kubernetes クラスタと、それらを管理するためだけの Kubernetes クラスタ、の大きく二種類の Kubernetes クラスタができあがります。

前者がゲストクラスタ(ワークロードクラスタ)、後者がマネジメントクラスタなどと呼ばれるようです。Cluster API はこのうちのマネジメントクラスタに組み込まれており、この Cluster API によってゲストクラスタのライフサイクルを簡単に管理できるということです。

ざっくりイメージ

もう少し具体的にいえば、例えば Kubernetes クラスタ自体は cluster リソースとして、あるいはそれを構成するノードの仮想マシンは machine リソースとして扱えるようになり、通常の pod リソースや deployment リソースと同じように、自分以外の Kubernetes クラスタの構成が管理できるということです。

構築の観点では、つまりマネジメントクラスタができさえすれば Cluster API 環境はほぼ完成と言えるわけですが、実際にはマネジメントクラスタ自身もマネジメントクラスタで管理するため、手順はちょっと複雑です。

マネジメントクラスタの作り方はいくつかあるようですが、今回は vSphere 用 Provider の Getting Started の通り、以下のような流れで構成を進めます。

作業の流れのイメージ
  1. 作業用端末(図中 Workstation)に Docker や kuberctl など必要なモノを揃えて、マニフェストファイルを生成する
  2. Docker 上に作業用の Kubernetes クラスタ(ブートストラップクラスタ)を作り、Cluster API を導入する
  3. 導入した Cluster API を使って、マニフェストファイルに従って本当のマネジメントクラスタを作る
  4. マネジメントクラスタに Cluster API 環境を移行(Pivoting)して、ブートストラップクラスタを消す

最終的なマネジメントクラスタを作るためにさらに別の Kubernetes クラスタ(ブートストラップクラスタ)が必要なあたりがわりとややこしいですが、そういうものみたいです。

ここまでできたら、Cluster API の本来の利用方法の通り、マニフェストファイルに従ってゲストクラスタを作ったり消したり拡張したり縮小したりできます。

ここまでの作業はこれをやるためのただのお膳立てです

構築の準備

前述した流れの通り、マネジメントクラスタを構築するには、ブートストラップクラスタが動作できる環境が必要です。また、マネジメントクラスタが動作する vSphere 環境でも、少し準備が必要です。

作業端末の整備

作業前提を整えます。作業用の端末は、ブートストラップクラスタの動作と、それを用いたマネジメントクラスタの構築ができる必要があり、このために、

が必要です。Windows でもおそらく動くとは思いますが、今回は作業用の Ubuntu 端末を別に用意して使っています。

Docker は適当に入れます。今回の端末は Ubuntu 19.10 なので、19.04 用のバイナリを無理やり入れます。

$ sudo apt update
$ sudo apt install apt-transport-https ca-certificates curl software-properties-common
$ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
$ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu disco stable"
$ sudo apt update
$ sudo apt install docker-ce docker-ce-cli containerd.io
$ sudo usermod -aG docker ${USER}

clusterctl と Kind、kubectl はバイナリをダウンロードするだけです。

$ curl -Lo ./clusterctl https://github.com/kubernetes-sigs/cluster-api/releases/download/v0.2.9/clusterctl-darwin-amd64
$ chmod +x ./clusterctl
$ mv ./clusterctl ~/bin
$ curl -Lo ./kind https://github.com/kubernetes-sigs/kind/releases/download/v0.6.1/kind-$(uname)-amd64
$ chmod +x ./kind
$ mv ./kind ~/bin
$ curl -Lo ./kubectl https://storage.googleapis.com/kubernetes-release/release/`curl -s https://storage.googleapis.com/kubernetes-release/release/stable.txt`/bin/linux/amd64/kubectl
$ chmod +x ./kubectl
$ mv ./kubectl ~/bin

が、clusterctl は v1alpha2 の時点ですでに DEPRECATED 扱いでした。

しかしながら代替手段がよくわかっていないし、Cluster API のドキュメント 通りではなにやらうまく動かない(kubeconfig 用の secret ができあがらない)ので、v1alpha3 が出て情報が増えてきたらどうにかします。

あと、Kind の最新リリースは現時点で 0.7.0 ですが、それを使うと後続の作業がうまく動かなかったので、ひとつ古い 0.6.1 を指定しています。

vSphere 環境での OVA テンプレートの展開

vSphere 環境用の Provider を使って Kubernetes クラスタを作った場合、最終的にできあがる Kubernetes のノードは vSphere 環境上の仮想マシンです。

この仮想マシンの元になるテンプレートが用意されているので、これをあらかじめデプロイして、テンプレートに変換しておきます。

Ubuntu 版と CentOS 版がありますが、今回は Ubuntu 版の最新の 1.16.3 を使いました。

その他のイメージのリンクは リポジトリに一覧 されています。

vSphere 環境でのフォルダとリソースプールの作成

マネジメントクラスタとゲストクラスタを入れるフォルダ(仮想マシンインベントリのヤツ)とリソースプールを作ります。入れ物としてただあればよいので、設定は適当で大丈夫です。

マネジメントクラスタの構成

では、実際の構築を進めます。ブートストラップクラスタを作り、そこで Cluster API を動作させて、それを通じて最終的なマネジメントクラスタを作ります。

はじめに、構成に必要な環境変数を、envvars.txt にまとめて定義します。内容はそれぞれの環境に依存するので書き換えが必要です。

$ cat envvars.txt
# vCenter config/credentials
export VSPHERE_SERVER='192.168.0.201'                  # (required) The vCenter server IP or FQDN
export VSPHERE_USERNAME='administrator@vsphere.local'  # (required) The username used to access the remote vSphere endpoint
export VSPHERE_PASSWORD='my-secure-password'           # (required) The password used to access the remote vSphere endpoint

# vSphere deployment configs
export VSPHERE_DATACENTER='kuro-dc01'                                 # (required) The vSphere datacenter to deploy the management cluster on
export VSPHERE_DATASTORE='nfs-ds01'                                   # (required) The vSphere datastore to deploy the management cluster on
export VSPHERE_NETWORK='ext-vm'                                       # (required) The VM network to deploy the management cluster on
export VSPHERE_RESOURCE_POOL='k8s'                                    # (required) The vSphere resource pool for your VMs
export VSPHERE_FOLDER='k8s'                                           # (optional) The VM folder for your VMs, defaults to the root vSphere folder if not set.
export VSPHERE_TEMPLATE='template_ubuntu-1804-kube-v1.16.3'           # (required) The VM template to use for your management cluster.
export VSPHERE_DISK_GIB='50'                                          # (optional) The VM Disk size in GB, defaults to 20 if not set
export VSPHERE_NUM_CPUS='2'                                           # (optional) The # of CPUs for control plane nodes in your management cluster, defaults to 2 if not set
export VSPHERE_MEM_MIB='2048'                                         # (optional) The memory (in MiB) for control plane nodes in your management cluster, defaults to 2048 if not set
export SSH_AUTHORIZED_KEY='ssh-rsa AAAAB...6Ix0= kuro@kuro-ubuntu01'  # (optional) The public ssh authorized key on all machines in this cluster

# Kubernetes configs
export KUBERNETES_VERSION='1.16.3'     # (optional) The Kubernetes version to use, defaults to 1.16.2
export SERVICE_CIDR='100.64.0.0/13'    # (optional) The service CIDR of the management cluster, defaults to "100.64.0.0/13"
export CLUSTER_CIDR='100.96.0.0/11'    # (optional) The cluster CIDR of the management cluster, defaults to "100.96.0.0/11"
export SERVICE_DOMAIN='cluster.local'  # (optional) The k8s service domain of the management cluster, defaults to "cluster.local"

続けて、このファイルを使って、マネジメントクラスタの構成を定義したマニフェストファイル群を生成します。この作業のための専用のコンテナイメージが用意されているので、これに食べさせます。

$ docker run --rm \
  -v "$(pwd):/out" \
  -v "$(pwd)/envvars.txt":/envvars.txt:ro \
  gcr.io/cluster-api-provider-vsphere/release/manifests:latest \
  -c management-cluster
Checking 192.168.0.201 for vSphere version
Detected vSphere version 6.7.1
Generated ./out/management-cluster/addons.yaml
Generated ./out/management-cluster/cluster.yaml
Generated ./out/management-cluster/controlplane.yaml
Generated ./out/management-cluster/machinedeployment.yaml
Generated /build/examples/pre-67u3/provider-components/provider-components-cluster-api.yaml
Generated /build/examples/pre-67u3/provider-components/provider-components-kubeadm.yaml
Generated /build/examples/pre-67u3/provider-components/provider-components-vsphere.yaml
Generated ./out/management-cluster/provider-components.yaml
WARNING: ./out/management-cluster/provider-components.yaml includes vSphere credentials

これで、./out/management-cluster 配下にマニフェストファイル群が出力されました。

$ ls -l ./out/management-cluster/
total 268
-rw-r--r-- 1 kuro kuro  19656 Feb 11 08:54 addons.yaml
-rw-r--r-- 1 kuro kuro    933 Feb 11 08:54 cluster.yaml
-rw-r--r-- 1 kuro kuro   3649 Feb 11 08:54 controlplane.yaml
-rw-r--r-- 1 kuro kuro   2576 Feb 11 08:54 machinedeployment.yaml
-rw-r--r-- 1 kuro kuro 240747 Feb 11 08:54 provider-components.yaml

で、あとはこれらを clusterctl に食べさせるだけです。

$ clusterctl create cluster \
  --bootstrap-type kind \
  --bootstrap-flags name=management-cluster \
  --cluster ./out/management-cluster/cluster.yaml \
  --machines ./out/management-cluster/controlplane.yaml \
  --provider-components ./out/management-cluster/provider-components.yaml \
  --addon-components ./out/management-cluster/addons.yaml \
  --kubeconfig-out ./out/management-cluster/kubeconfig
NOTICE: clusterctl has been deprecated in v1alpha2 and will be removed in a future version.
I0211 08:55:09.414116    2332 createbootstrapcluster.go:27] Preparing bootstrap cluster
I0211 08:55:59.745617    2332 clusterdeployer.go:82] Applying Cluster API stack to bootstrap cluster
...
I0211 08:56:02.302440    2332 clusterdeployer.go:87] Provisioning target cluster via bootstrap cluster
...
I0211 08:56:02.454960    2332 applymachines.go:46] Creating machines in namespace "default"
I0211 08:59:12.512879    2332 clusterdeployer.go:105] Creating target cluster
...
I0211 08:59:13.394821    2332 clusterdeployer.go:123] Pivoting Cluster API stack to target cluster
...
I0211 08:59:56.665878    2332 clusterdeployer.go:164] Done provisioning cluster. You can now access your cluster with kubectl --kubeconfig ./out/management-cluster/kubeconfig
I0211 08:59:56.666586    2332 createbootstrapcluster.go:36] Cleaning up bootstrap cluster.

主要なログだけ抜粋していますが、これだけで、

  1. Kind を使って、作業端末の Docker 上にブートストラップクラスタを構築する
  2. ブートストラップクラスタに Cluster API を導入する
  3. その Cluster API を使って、マニフェスト通りに vSphere 環境上にマネジメントクラスタをデプロイする
    • 仮想マシンをテンプレートからデプロイする
    • 仮想マシンをクラスタのコントロールプレーンとして構成する
  4. ブートストラップクラスタ上に構成していた Cluster API の環境をマネジメントクラスタに移行する(Pivoting)

が実行され、最終的な形でマネジメントクラスタができあがります。

完成したマネジメントクラスタへの接続に必要な情報は、./out/management-cluster/kubeconfig に保存されています。kubectl の設定ファイルをこれに切り替えてコマンドを実行すると、マネジメントクラスタ自体の情報や、machine リソースとしての自分自身の存在が確認できます。

$ export KUBECONFIG="$(pwd)/out/management-cluster/kubeconfig"

$ kubectl cluster-info
Kubernetes master is running at https://192.168.0.27:6443
KubeDNS is running at https://192.168.0.27:6443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy

To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

$ kubectl get machines
NAME                                       PROVIDERID                                       PHASE
management-cluster-controlplane-0          vsphere://42069f1f-21ac-45be-69b9-e94702d3062b   running

vSphere 環境では、仮想マシン management-cluster-controlplane-0 の存在が確認できるはずです。

ここまででマネジメントクラスタができたので、Cluster API 環境は完成です。あとは好きなように Cluster API を使ってゲストクラスタを作ったり消したり拡張したり縮小したりできます。

ゲストクラスタの構成

実際に、Cluster API を使って、新しくゲストクラスタを構成します。

Cluster API は、Kubernetes のお作法で Kubernetes クラスタ自体が管理できるので、つまり、クラスタの構成情報も、Pod や Deployment などほかの Kubernetes リソースと同じように、マニフェストファイルで定義されます。よって、ゲストクラスタを作るには、その構成を定義したマニフェストファイルが必要です。

本来はきちんと中身を書くべきっぽいですが、マネジメントクラスタ用のマニフェストファイルを作ったのと同じ方法でゲストクラスタ用のマニフェストファイル群も作れるので、ここではそれを利用します。

$ docker run --rm \
  -v "$(pwd):/out" \
  -v "$(pwd)/envvars.txt":/envvars.txt:ro \
  gcr.io/cluster-api-provider-vsphere/release/manifests:latest \
  -c workload-cluster-1
Checking 192.168.0.201 for vSphere version
Detected vSphere version 6.7.1
Generated ./out/workload-cluster-1/addons.yaml
Generated ./out/workload-cluster-1/cluster.yaml
Generated ./out/workload-cluster-1/controlplane.yaml
Generated ./out/workload-cluster-1/machinedeployment.yaml
Generated /build/examples/pre-67u3/provider-components/provider-components-cluster-api.yaml
Generated /build/examples/pre-67u3/provider-components/provider-components-kubeadm.yaml
Generated /build/examples/pre-67u3/provider-components/provider-components-vsphere.yaml
Generated ./out/workload-cluster-1/provider-components.yaml
WARNING: ./out/workload-cluster-1/provider-components.yaml includes vSphere credentials

ゲストクラスタの定義と、コントロールプレーンの定義が、

  • ./out/workload-cluster-1/cluster.yaml
  • ./out/workload-cluster-1/controlplane.yaml

に含まれます。また、ワーカノードの定義は、

  • ./out/workload-cluster-1/machinedeployment.yaml

です。自分でマニフェストをいじる場合は、この辺をどうにかする必要があるということですね。

実際にデプロイするには、kubectl の接続先をマネジメントクラスタに切り替えてから、先の 3 つのファイルをマネジメントクラスタに突っ込みます。

$ export KUBECONFIG="$(pwd)/out/management-cluster/kubeconfig"

$ kubectl apply -f ./out/workload-cluster-1/cluster.yaml
cluster.cluster.x-k8s.io/workload-cluster-1 created
vspherecluster.infrastructure.cluster.x-k8s.io/workload-cluster-1 created

$ kubectl apply -f ./out/workload-cluster-1/controlplane.yaml
kubeadmconfig.bootstrap.cluster.x-k8s.io/workload-cluster-1-controlplane-0 created
machine.cluster.x-k8s.io/workload-cluster-1-controlplane-0 created
vspheremachine.infrastructure.cluster.x-k8s.io/workload-cluster-1-controlplane-0 created

$ kubectl apply -f ./out/workload-cluster-1/machinedeployment.yaml
kubeadmconfigtemplate.bootstrap.cluster.x-k8s.io/workload-cluster-1-md-0 created
machinedeployment.cluster.x-k8s.io/workload-cluster-1-md-0 created
vspheremachinetemplate.infrastructure.cluster.x-k8s.io/workload-cluster-1-md-0 created

この作業によって、まずコントロールプレーンがデプロイされ、続けてワーカノードがデプロイされます。vSphere 環境でも順次仮想マシンがデプロイされパワーオンされていく様子が観察できるでしょう。

デプロイが完了すると、以下のように、マネジメントクラスタが Kubernetes クラスタ自体を cluster リソースや machine リソースとして管理できている状態になります。

$ kubectl get clusters
NAME                 PHASE
management-cluster   provisioned
workload-cluster-1   provisioned

$ kubectl get machines
NAME                                       PROVIDERID                                       PHASE
management-cluster-controlplane-0          vsphere://42069f1f-21ac-45be-69b9-e94702d3062b   running
workload-cluster-1-controlplane-0          vsphere://4206f835-1e8d-3473-943f-0e2cc4b04319   running
workload-cluster-1-md-0-78469c8cf9-fr22j   vsphere://4206661b-9be8-cede-eeee-68ddbbdeb872   running
workload-cluster-1-md-0-78469c8cf9-jnqnw   vsphere://4206861f-e133-4a53-2008-3346c81ed8e3   running

ゲストクラスタへの接続情報は、secret リソースとして保持されています。これを kubeconfig として保存することで、kubectl でゲストクラスタに接続できるようになります。

$ kubectl get secrets
NAME                            TYPE                                  DATA   AGE
...
workload-cluster-1-kubeconfig   Opaque                                1      
...

$ kubectl get secret workload-cluster-1-kubeconfig -o=jsonpath='{.data.value}' | \
  { base64 -d 2>/dev/null || base64 -D; } >./out/workload-cluster-1/kubeconfig

実際に接続すれば、当たり前ですがゲストクラスタやノードの情報が確認できます。

$ export KUBECONFIG="$(pwd)/out/workload-cluster-1/kubeconfig"

$ kubectl cluster-info
Kubernetes master is running at https://192.168.0.28:6443
KubeDNS is running at https://192.168.0.28:6443/api/v1/namespaces/kube-system/services/kube-dns:dns/proxy

To further debug and diagnose cluster problems, use 'kubectl cluster-info dump'.

$ kubectl get nodes
NAME                                       STATUS     ROLES    AGE     VERSION
workload-cluster-1-controlplane-0          NotReady   master   3m14s   v1.16.3
workload-cluster-1-md-0-78469c8cf9-fr22j   NotReady   <none>   90s     v1.16.3

表示されている通り、この段階ではノードは NotReady です。これは CNI プラグインが構成されていないからで、雑にいえば、この Kubernetes クラスタ内のコンテナネットワークに使う実装を明示する必要があるということです。

コンテナネットワークの実装には Flannel とか Calico とかいろいろありますが、ゲストクラスタ用マニフェスト群の中にある ./out/workload-cluster-1/addons.yaml で Calico を構成できるので、今回はこれを使います。

適用してしばらく待つと、ノードが Ready になり、ゲストクラスタの完成です。

$ kubectl apply -f ./out/workload-cluster-1/addons.yaml 
configmap/calico-config created
...
serviceaccount/calico-kube-controllers created

$ kubectl get nodes
NAME                                       STATUS   ROLES    AGE     VERSION
workload-cluster-1-controlplane-0          Ready    master   4m22s   v1.16.3
workload-cluster-1-md-0-78469c8cf9-fr22j   Ready    <none>   2m38s   v1.16.3

ゲストクラスタの拡張

Kubernetes って、アプリケーションのスケールアウトが kubectl scale だけでできてめっちゃラクですよね。

というのと同じノリで、ゲストクラスタもめっちゃラクにスケールアウトできるので、やってみましょう。

ノードの管理はマネジメントクラスタから行うので、接続先を切り替えて、machinedeployment をスケールさせます。

$ export KUBECONFIG="$(pwd)/out/management-cluster/kubeconfig"

$ kubectl scale md workload-cluster-1-md-0 --replicas=3
machinedeployment.cluster.x-k8s.io/workload-cluster-1-md-0 scaled

$ kubectl get machines
NAME                                       PROVIDERID                                       PHASE
management-cluster-controlplane-0          vsphere://42069f1f-21ac-45be-69b9-e94702d3062b   running
workload-cluster-1-controlplane-0          vsphere://4206f835-1e8d-3473-943f-0e2cc4b04319   running
workload-cluster-1-md-0-78469c8cf9-fr22j   vsphere://4206661b-9be8-cede-eeee-68ddbbdeb872   running
workload-cluster-1-md-0-78469c8cf9-jnqnw   vsphere://4206861f-e133-4a53-2008-3346c81ed8e3   running
workload-cluster-1-md-0-78469c8cf9-nxvht   vsphere://4206ec88-6607-1699-8051-e1447a448983   running

これだけでノードが 3 台になりました。仮想マシンも増えています。

ノードが増えた様子

簡単ですね。

ゲストクラスタのロードバランサの構成

おまけです。

vSphere が組み込みでロードバランサを持っていないから仕方ないですが、 現状、Cluster API でゲストクラスタを構成するときには、ロードバランサは構成できません。

このままだと、ゲストクラスタで kubectl expose--type=LoadBalancer しても EXTERNAL-IP が永遠に pending のままで、外部に公開できません。

GitHub でも issue があります し、めっちゃがんばると多分オンプレミス環境でも NSX-T とかでどうにかできるとは思いますが、その域に達していないので、とりあえず MetalLB を突っ込んで解決します。

MetalLB とは

ロードバランサが使えずにサービスを外部に公開できない、というのは、ベアメタル環境で Kubernetes を使うときによく遭遇する話題のようで、そういうヒト向けの仮想ロードバランサの実装です。

実際には正しい負荷分散にはならないみたいですが、ものすごく気軽に使えますし、アクセス経路の提供という意味では充分機能するので便利です。

MetalLB の構成と初期設定

公式のドキュメント に従います。インストール用のマニフェストファイルを突っ込んだあと、

$ kubectl apply -f https://raw.githubusercontent.com/google/metallb/v0.8.3/manifests/metallb.yaml
namespace/metallb-system created
...
deployment.apps/controller created

ドキュメントの Layer 2 Configuration の通りに設定用マニフェストファイルを作って突っ込みます。IP アドレスのレンジは任意で修正します。

$ cat metallb.yaml 
apiVersion: v1
kind: ConfigMap
metadata:
  namespace: metallb-system
  name: config
data:
  config: |
    address-pools:
    - name: default
      protocol: layer2
      addresses:
      - 192.168.0.50-192.168.0.99

$ kubectl apply -f metallb.yaml 
configmap/config created

これだけです。

動作確認

Kubernetes のチュートリアルのヤツ を作って、

$ kubectl apply -f https://k8s.io/examples/service/load-balancer-example.yaml
deployment.apps/hello-world created

$ kubectl get pods
NAME                          READY   STATUS    RESTARTS   AGE
hello-world-f9b447754-6rrt9   1/1     Running   0          68s
hello-world-f9b447754-b6psq   1/1     Running   0          68s
hello-world-f9b447754-ml5w8   1/1     Running   0          68s
hello-world-f9b447754-nprbn   1/1     Running   0          68s
hello-world-f9b447754-wpgv5   1/1     Running   0          68s

expose します。

$ kubectl expose deployment hello-world --type=LoadBalancer
service/hello-world exposed

$ kubectl get services
NAME          TYPE           CLUSTER-IP       EXTERNAL-IP    PORT(S)          AGE
hello-world   LoadBalancer   100.69.189.221   192.168.0.50   8080:32015/TCP   6s
kubernetes    ClusterIP      100.64.0.1       <none>         443/TCP          4h55m

$ kubectl describe services hello-world
...
Endpoints:                100.113.190.67:8080,100.113.190.68:8080,100.97.109.3:8080 + 2 more...
...

EXTERNAL-IP に MetalLB で設定したレンジの IP アドレスが振られていますし、エンドポイントも 5 つです。

実際にこの IP アドレスにアクセスすると、正しく表示が返ってきます。無事に動いているようです。

$ curl http://192.168.0.50:8080/
Hello Kubernetes!

まとめ

vSphere 環境で Cluster API を使って Kubernetes クラスタを管理できる状態を整えました。

最初の作業はちょっとだけ手間ですが、いちどできてしまうとスケールも相当楽なので使いやすそうです。ロードバランサ周りが NSX-T などふくめいい感じにできるようになってくると、活用の幅も広がりそうですね。

VMware Tanzu や Project Pacific でも Kubernetes クラスタのライフサイクル管理は謳われているので、この手の作業が導入作業も含めて GUI や API 経由でポチポチ簡単にできるようになるのだろうと勝手に思っています。GA になったら触ってみます。


おうち IoT 用の LINE ボットをもう少し賢くする

これまでの LINE ボットの課題

2018 年に、家のエアコンを操作してくれる LINE ボットを作って以来、すでに一年半くらい運用しています。概要は 当時のエントリでも紹介しています が、LINE での会話を元に自宅のエアコンを操作してくれるものです。

これ、作った当初に想定していた以上にたいへん便利で、外出先で家族と『そろそろロボくんにお願いしておこう』などの会話が発生する程度には実際に活用されていました。この手の『作ってみた』系は、長期的な運用が定着する前に使わなくなることが多い印象もあり、これは小規模ではあるもののうまくいった例と言えるかと思います。

当時の LINE ボットの様子

一方で、作りが甘い部分もあって、

  • Lambda の Node.js のランタイムで EoL が迫っていた
    • そもそも Node.js のランタイム側の更新に追従していくことに将来的にけっこう体力を使いそうな印象がある
    • 当時 Node.js を選んだ理由は『とりあえずいちど触ってみたかった』からというだけで、すでにその目的は達成できた
  • ひとつの Lambda に全機能を詰め込んでいて、どう考えてもイケてないアーキテクチャだ
  • 機能が足りない
    • エアコンのオンオフと温度の変更はできたが、冷房と暖房の切り替え機能を実装していない

など、長期的な運用に耐えられるよう全体を作り直したいモチベーションも強くなってきていました。

そんな中、あるイベントに参加して、『Raspberry Pi とセンサとクラウドサービスを使って何でもいいから個人で何かを作る』という活動をすることになり、タイミングもよかったので、この LINE ボットの作り直しを進めることにしました。

できたもの

で、こういう風に進化して、今も元気に動いています。

現在の LINE ボットの様子

以下のような機能が付いています。

  • エアコンの操作
    • オンオフ、冷暖房の切り替え、温度の変更、現在の設定の確認をしてくれます
  • 加湿器の操作
    • オンオフをしてくれます
  • 空調センサ
    • 室内に設置したセンサを使って、気温、湿度、気圧、二酸化炭素濃度の現在の値を教えてくれます
    • 任意の時間分の履歴をグラフ化して送ってくれます
  • 家計簿の記録
    • 支払者、使途、金額を Google Sheets に追記してくれます
  • 毎朝の自動制御
    • 毎朝、部屋が寒い(暑い)場合は、暖房(冷房)を付けてくれます
    • 毎朝、部屋が乾燥している場合は、加湿器を付けてくれます

実装

実装を簡単に紹介します。末尾には GitHub へのリンクも載せています。

全体像

全体はこのような構成です。

こけおどし全体像

参加したイベントの性質上、なるべくたくさんの要素技術を取り込んだほうが評価が上がる仕組みだったため、あえてまわりくどく冗長な構成になっている部分もあります。

センシングと蓄積

センシングと蓄積は、図の以下の部分です。これまで複数回にわたって紹介してきた EdgeX Foundry を中心に構成しています。

センシングと蓄積の部分

EdgeX Foundry 自体は、家庭内の IoT ゲートウェイサーバとして構築した Ubuntu 仮想マシン(ESXi 上で動作)の中で動いています。このゲートウェイサーバ上では MQTT ブローカも動かしています。

Raspberry Pi は、センサ値を読んで MQTT トピックにひたすら放り込み続けるだけの係です。EdgeX Foundry は、この Raspberry Pi を MQTT デバイスとして制御するよう構成されており、所定の MQTT トピックに投げ込まれたデータを取り込んで、アプリケーションサービスの機能を使ってクラウド上の所定の宛先にデータをエクスポートしています。

エクスポート先は、Mosquitto のパブリック MQTT トピックと、Pivotal Web Service(PWS)上のワーカアプリケーションで、なんやかんやされて最終的にデータは InfluxDB Cloud 2.0、Redis Cloud、MongoDB mLab に蓄積されます。

十数年前に PIC や Arduino でセンサやアクチュエータを操作していた頃は、データシートとにらめっこをしながら必要な抵抗を計算したり回路を考えたりしていましたが、最近のヤツは単にデータを読み取るだけなら恐ろしいくらい簡単ですね…… けっこう衝撃でした。

今回は BME280 と MH-Z19 を使っています。安いですし精度は悪いのでしょうが、厳密な値は必要としていないのでよしとしています。最初は DS18B20 も使っていましたが、BME280 を組み込んでからは使っていません。

アクチュエーション

最終的にはエアコンと加湿器が操作されるわけですが、この部分の実装は、前者は Nature Remo の API、後者は非公式の野良 API で制御しています。

アクチュエーションの部分

Nature Remo の API を叩く役は、AWS の所定の Lambda に一任しています。加湿器も同様ですが、こちらは非公式 API の都合上、ローカルネットワーク内からしか制御できなかったので、Lambda からいちど IoT Core の MQTT トピックに命令をなげ、それをローカルネットワーク側から購読して後続の処理をトリガさせています。ここだけは Node.js です。

加湿器は、モデルの選定がなかなかたいへんでした。加湿器に限らず何らかの家電を外部から自動制御する場合、

  • スマートコンセントを利用する
    • コンセントが通電したら目的の動作が開始される仕様である必要がある
  • スマートスイッチ(SwitchBot など)を利用する
    • 目的のボタンが、物理的にスマートスイッチで押下できる形状であり、かつスマートスイッチの力で押せるだけの硬さである必要がある
  • スマートリモコンを利用する
    • RF ではなく赤外線を利用したリモコンで制御できる機器である必要がある
  • 専用の API を利用する
    • API が公開されている必要がある

のいずれかの条件を満たす必要がありますが、加湿器でこれに合致するモデルが全然見つけられませんでした。大体の加湿器は、コンセントの通電後にさらにボタンを押さないと動作しませんし、ボタンの周辺の形状や寸法やボタンの硬さは公開されていませんし、リモコン付きのモデルでも赤外線でなく RF ですし、公式の API はなさそうですし。

結局、公開されていない API を無理やり叩ける非公式のライブラリが存在していてハックの余地がありそう、ということがわかった Oittm のアロマディフューザー を採用しています。ただしこれも、

  • 非公式のライブラリ で制御できるようにするには、公式アプリケーション Tuya Smart の旧バージョン(3.12.6 以前)を使って、MITM 攻撃的なヤツでアプリケーションの通信を自分で盗聴してキーを入手しないといけない
  • ライブラリが Node.js 向けしかない
  • そもそもの加湿器自体が小型でとても非力で、リビングなど広い空間の加湿には向かない

など、ベストとは言い難い状態です。改善の余地ありです。

インタフェイスとインタラクション

インタフェイス役の LINE ボットに話しかけると、LINE の Messaging API 経由で AWS の Lambda に届いて、メッセージ本文がパタンマッチされてその内容に応じて後続の処理がトリガされます。

インタラクションの部分

エアコンの操作であれば Nature Remo を制御する Lambda を呼びますし、加湿器の操作であればそれ用の別の Lambda を呼びます。センサのデータが必要な処理であれば、外部のデータベースに必要なデータを取りに行く Lambda を呼びます。

インタフェイスとしての LINE

グラフを要求された場合は、InfluxDB からデータを取ってきて matplotlib で描画したあとに S3 に保存し、それをプッシュでユーザに送ります。描画する対象(温度、湿度、気圧……)と長さ(N 分、M 時間)はメッセージ本文から都度判断します。

実際に生成されたグラフの例

この辺りの処理では、

  • グラフ要求のメッセージが来たら、受理した旨の返事を後続処理に先行して即座にしてしまい、画像の生成と送信はあとから非同期で行う
    • グラフの生成に時間がかかるため、 同期的に処理させると(Lambda ではなく)API Gateway がタイムアウトする
  • S3 のバケット名や画像ファイル名をなるべく短くする
    • LINE で画像を送るときは、画像そのものではなく画像の URL を送る必要がある
    • Lambda で発行する S3 の署名付き URL は 1,000 文字前後とめちゃくちゃ長い(x-amz-security-token が含まれるため)
    • LINE 側の制約で、URL は 1,000 文字以内でないとエラーで送れない
    • 署名付き URL ではなくパブリックな URL にしてしまうのは気が引ける
    • バケット名やファイル名は URL に含まれるため、短くすることでギリギリ 1,000 文字以内になる

などの工夫が必要でした。特に二点目はひどい回避策ですが、あまり権限をがばがばにはしたくなかったので仕方なく……。

また、LINE とはまったく関係ないところで、Grafana を PWS で動かしており、そこでもグラフを見られるようにしています。

感触とロードマップ

センサの値がグラフで見られるのが、実際に使ってみると思っていた以上におもしろかったです。

例えばエアコンをつけてから温度が上がっていく様子や、朝起きて部屋で人間が活動しだしてから二酸化炭素濃度が一気に上がる様子、逆に家が無人になってから下がる様子、キッチンで火を使う調理を始めたタイミングなど、思っていた以上に生活パタンが可視化されることがわかりました。

また、二酸化炭素濃度や気圧の変化では眠気や頭痛の誘発なども懸念されるので、体調に違和感を覚えたときに客観的な変化をすぐ確認できるのはうれしく、体調管理面でも地味に役立っています。

運用面では、Lambda まわりをすべて CloudFormation で定義したことで、コードの管理とデプロイがだいぶに楽になりました。クラウド側がマネージドサービスとサーバレスアーキテクチャだけで組めているのも安心感があります。

ただ、本エントリの途中で、

参加したイベントの性質上、なるべくたくさんの要素技術を取り込んだほうが評価が上がる仕組みだったため、あえてまわりくどく冗長な構成になっている部分もあります

と書いた通り、正直なところ機能に比較して実装が大げさすぎるので、この辺はスリムにしたいと思っています。

イベントはもう終わったので、現状のゴテゴテ感を保つ意味はあまりなく、例えば、

  • この規模だと EdgeX Foundry の恩恵は受けにくいので、まるっと削って Raspberry Pi から直接クラウドに投げてもよいだろう
  • データの蓄積場所も AWS の DynamoDB などにしてしまえば、PWS も InfluxDB も Redis も MongoDB もいらなくなり、AWS に全部寄せられるだろう
  • いっそ Raspberry Pi も AWS IoT Greengrass で AWS から管理させるとよいのでは

などのダイエットや試行錯誤を検討中です。とくに Greengrass は完全に未修分野なので純粋に興味もあり触ってみたいですね。

物理的には、加湿器をもう少し高機能(大容量)かつ自動制御しやすいものに替えたい気持ちがあります。オンオフは自動で制御できても、給水が自動化しづらいので、結局は人間の介入が必要な状態になってしまっており、人間が手を抜くにはタンクの容量がキモになりそうだと考えています。

関連リポジトリ

一覧します。

  • raspi-airmeasurment
    • Raspberry Pi 上で動作させる、各種センサ値を読み取って MQTT トピックに送る Python プログラム
  • edgex-lab-raspi
    • Raspberry Pi から MQTT トピックに送られた値の取り込みや、クラウドへのエクスポートを行えるように構成した EdgeX Foundry の Docker Compose ファイル
  • edgex-lab-export2db
    • PWS 上で動作させる、EdgeX Foundry からエクスポートされたデータを各種データベースに保存するためのプログラム群
    • Telegraf 用のイメージは Docker Hub の kurokobo/edgex-lab-telegraf に配置済み
  • grafana-with-flux
    • PWS 上で動作させる Grafana
  • sam-smarthome-api
    • AWS 上で動作させる一連の Lambda 群
  • tuya-mqtt
    • MQTT の配信を受けて加湿器をコントロールする Node.js プログラム


Rapsberry Pi

冬休みの自由研究: EdgeX Foundry (6) アプリケーションサービスによるエクスポート

EdgeX Foundry 関連エントリ

エクスポート方法の新旧

エクスポートサービスを取り扱ったエントリの最後で、以下のように書きました。

……と、意気揚々と書いてきたものの、今回利用したエクスポートサービスは最近のリリースではすでに廃止されており、エクスポートの機能は アプリケーションサービス に統合されているようです。

冬休みの自由研究: EdgeX Foundry (3) エクスポートサービスによるエクスポート

アプリケーションサービスに関する公式ドキュメント では、エクスポートサービスの利用はまだサポートされるものの、今後はアプリケーションサービスの利用が推奨されています。

エクスポートサービスを利用したエクスポートの欠点として、

  • エクスポートサービスは、登録されているすべてのクライアントにデータを順次配信するが、これがボトルネックになり、エンドポイント側の受信が遅延する
  • 登録されているクライアントを管理することそれ自体のオーバヘッドと複雑さが EdgeX Foundry にとって負担である
  • 特定のクラウドへのエクスポートに限定して作りこむのではなく、SDK を提供してクラウドプロバイダにとらわれない状態にすべきだ

などが挙げられています。ここでいう SDK とそれを使った実装がアプリケーションサービスなわけですが、アプリケーションサービスでは、

  • コアサービス(データを ZeroMQ で配る Core Data)に直接つなげられることで、パフォーマンスの問題を排除する
  • 開発者には、データが利用可能になったら直ちにそれに対して何らかの処理を行える手段が提供される
  • 登録作業が不要である

などの点でよい感じになっています。

いまいち正しくない気もしますが、ざっくりまとめると、下図の上が下になったので、

上がこれまで、下がこれから

エクスポートサービス(のディストリビューションサービス)がボトルネックにならなくなったし、値を好きに処理できる場所もできたよ! ということかと思います。

今回試すこと

そういうわけで、エクスポートサービスのなくなった世界でも生きていけるよう、エクスポートサービスを扱ったエントリと同様に、MQTT トピックと REST エンドポイントへ、アプリケーションサービスを使ってエクスポートできる状態を作ります。

今回も GitHub にもろもろ置いてあります ので、こちらをクローンして使います。

$ git clone https://github.com/kurokobo/edgex-lab-handson.git
 
$ cd lab05

アプリケーションサービス

上図のアプリケーションサービスの箱の中には、ファンクション(Fn で表記)を並べました。アプリケーションサービスでは、このように任意のファンクション群をパイプライン化してデータフローを定義できます。

例えば簡単な例では、標準で用意されているファンクションを並べるだけでも、

  1. デバイス名でフィルタするファンクション
  2. リソース名でフィルタするファンクション
  3. JSON 形式に変換するファンクション
  4. MQTT でエクスポートするファンクション

などのパイプラインが構成できます。現時点で利用できるファンクションは、SDK の README.md で確認できます。

構成の考え方

標準で実装されているアプリケーションサービスとして、app-service-configurable がありますが、これは、ひとつのパイプラインをひとつのインスタンスで処理する前提で作られているようです。また、パイプラインそのものは、インスタンスごとの設定ファイル configuration.toml で定義します。

つまり、コンテナ環境の例でいえば、冒頭の絵のように、

  • 最終的に MQTT トピックにエクスポートする app-service-configurable コンテナ
  • 最終的に REST エンドポイントにエクスポートする app-service-configurable コンテナ

など、app-service-configurable が、目的に応じて複数起動している状態を作るということです。

なお、コアサービスのホスト名やポート番号、MQTT ではブローカのホスト名など環境に依存する情報は、コンテナの場合は環境変数で Docker Compose ファイルから渡せるようになっています。エクスポートサービスでは API を叩いてクライアントとして登録する作業が必要でしたが、すべての構成をあらかじめファイルとして定義しておけるということですね。

設定ファイルの確認

コンテナの場合、デフォルトでコンテナ内の /res に、目的別に事前構成された configuration.toml がディレクトリを分けて配置されています。そして、起動時に渡す環境変数で、どのディレクトリの中身を利用するか指定します。

例えば、MQTT トピックへのエクスポートで利用する configuration.toml は以下です。

$ cat mqtt-export/configuration.toml
...
  [Writable.Pipeline]
    ExecutionOrder = "TransformToJSON, MQTTSend, MarkAsPushed"

    [Writable.Pipeline.Functions.TransformToJSON]
    [Writable.Pipeline.Functions.MarkAsPushed]
    [Writable.Pipeline.Functions.FilterByDeviceName]
      [Writable.Pipeline.Functions.FilterByDeviceName.Parameters]
        DeviceNames = ""
    [Writable.Pipeline.Functions.FilterByValueDescriptor]
      [Writable.Pipeline.Functions.FilterByValueDescriptor.Parameters]
        ValueDescriptors = ""
    [Writable.Pipeline.Functions.MQTTSend]
      [Writable.Pipeline.Functions.MQTTSend.Parameters]
        qos="0"
        key=""
        autoreconnect="false"
        retain="false"
        cert=""
        persistOnError = "false"
      [Writable.Pipeline.Functions.MQTTSend.Addressable]
        Address=   "localhost"
        Port=      1883
        Protocol=  "tcp"
        Publisher= "AppServiceConfigurable-mqtt-export"
        User=      ""
        Password=  ""
        Topic=     "edgex-events"
...

ExecutionOrder に含まれる関数がパイプラインとして順次実行されていきます。この例だと、JSON に変換してから MQTT トピックに送信しています。

利用する関数は下で列挙されていますが、ExecutionOrder に含まれないものは実際には利用されないようです。デバイス名でフィルタする関数(FilterByDeviceName)なども書かれていますが、使いたいなら自分で ExecutionOrder に書いてね、ということでしょう。

また、MQTT ブローカのホスト名に localhost が指定されていたり、トピック名が edgex-events になっていたりしますが、先述のとおり、この辺りは環境変数で書き換えますのでこのままで問題ありません。

同様に、REST エンドポイントへのエクスポートで利用する設定ファイルは以下です。

$ cat http-export/configuration.toml
...
  [Writable.StoreAndForward]
    Enabled = false
    RetryInterval = "5m"
    MaxRetryCount = 10

  [Writable.Pipeline]
    UseTargetTypeOfByteArray = false
    ExecutionOrder = "FilterByDeviceName, TransformToJSON, HTTPPostJSON, MarkAsPushed"

    [Writable.Pipeline.Functions.TransformToJSON]
    [Writable.Pipeline.Functions.MarkAsPushed]
    [Writable.Pipeline.Functions.FilterByDeviceName]
      [Writable.Pipeline.Functions.FilterByDeviceName.Parameters]
        DeviceNames = ""
    [Writable.Pipeline.Functions.FilterByValueDescriptor]
      [Writable.Pipeline.Functions.FilterByValueDescriptor.Parameters]
        ValueDescriptors = ""
    [Writable.Pipeline.Functions.HTTPPostJSON]
      [Writable.Pipeline.Functions.HTTPPostJSON.Parameters]
        url = "http://"
        persistOnError = "false"
...

環境変数による柔軟なオーバライド

設定ファイルに含まれるパラメータは、実装から推測すると、おそらくすべて環境変数で書き換えが可能です。セクション名の区切り文字を _ に置換して、さらに _<パラメータ名> を付与して環境変数として与えれば、オーバライドされるようでした。

例えば、ExecutionOrder 自体も、Writable_Pipeline_ExecutionOrder 環境変数として与えられます。例えば先述の mqtt-exportExecutionOrder には FilterByDeviceName が含まれせんが、環境変数で以下を与えることで、このフィルタも有効化できます。

  • 環境変数 Writable_Pipeline_ExecutionOrder
    • FilterByDeviceName, TransformToJSON, MQTTSend, MarkAsPushed
  • 環境変数 Writable_Pipeline_Functions_FilterByDeviceName_Parameters_DeviceNames
    • <デバイス名>

今回の構成の定義

では、今回用の構成を作ります。先の通り、環境依存の値は環境変数経由で与えればよいので、今回編集するのは、Docker Compose ファイルです。

Docker Compose ファイルには、もともと、ルールエンジンにデータを送る用の app-service-rules が定義されています。

$ cat docker-composer.yml
...
  app-service-rules:
    image: edgexfoundry/docker-app-service-configurable:1.0.0
    ports:
      - "48096:48096"
    container_name: edgex-app-service-configurable-rules
    hostname: edgex-app-service-configurable-rules
    networks:
      edgex-network:
        aliases:
          - edgex-app-service-configurable-rules
    environment:
      <<: *common-variables
      edgex_service: http://edgex-app-service-configurable-rules:48096
      edgex_profile: rules-engine
      Service_Host: edgex-app-service-configurable-rules
      MessageBus_SubscribeHost_Host: edgex-core-data
    depends_on:
      - consul
      - logging
      - data
...

今回は、これに加えて、MQTT トピックにエクスポートする app-service-mqtt-export と、REST エンドポイントにエクスポートする app-service-http-export を追加しています。

$ cat docker-composer.yml
...
  app-service-mqtt-export:
    image: edgexfoundry/docker-app-service-configurable:1.0.0
    ports:
      - "48097:48097"
    container_name: edgex-app-service-configurable-mqtt-export
    hostname: edgex-app-service-configurable-mqtt-export
    networks:
      edgex-network:
        aliases:
          - edgex-app-service-configurable-mqtt-export
    environment:
      <<: *common-variables
      edgex_service: http://edgex-app-service-configurable-mqtt-export:48097
      edgex_profile: mqtt-export
      Service_Host: edgex-app-service-configurable-mqtt-export
      MessageBus_SubscribeHost_Host: edgex-core-data
      Writable_Pipeline_Functions_MQTTSend_Addressable_Address: 192.168.0.100
      Writable_Pipeline_Functions_MQTTSend_Addressable_Port: 1883
      Writable_Pipeline_Functions_MQTTSend_Addressable_Protocol: tcp
      # Writable_Pipeline_Functions_MQTTSend_Addressable_Publisher: 
      # Writable_Pipeline_Functions_MQTTSend_Addressable_User: 
      # Writable_Pipeline_Functions_MQTTSend_Addressable_Password: 
      Writable_Pipeline_Functions_MQTTSend_Addressable_Topic: edgex-handson-topic
      # Writable_Pipeline_Functions_MQTTSend_Parameters_Qos: 
      # Writable_Pipeline_Functions_MQTTSend_Parameters_Key: 
      # Writable_Pipeline_Functions_MQTTSend_Parameters_Cert: 
      # Writable_Pipeline_Functions_MQTTSend_Parameters_Autoreconnect: 
      # Writable_Pipeline_Functions_MQTTSend_Parameters_Retain: 
      # Writable_Pipeline_Functions_MQTTSend_Parameters_PersistOnError: 
    volumes:
      - ./app-service-configurable:/res
    depends_on:
      - consul
      - logging
      - data

  app-service-http-export:
    image: edgexfoundry/docker-app-service-configurable:1.0.0
    ports:
      - "48098:48098"
    container_name: edgex-app-service-configurable-http-export
    hostname: edgex-app-service-configurable-http-export
    networks:
      edgex-network:
        aliases:
          - edgex-app-service-configurable-http-export
    environment:
      <<: *common-variables
      edgex_service: http://edgex-app-service-configurable-http-export:48098
      edgex_profile: http-export
      Service_Host: edgex-app-service-configurable-http-export
      MessageBus_SubscribeHost_Host: edgex-core-data
      Writable_Pipeline_Functions_HTTPPostJSON_Parameters_url: http://192.168.0.100:5000/api/v1/echo
      # Writable_Pipeline_Functions_HTTPPostJSON_Parameters_persistOnError: 
    volumes:
      - ./app-service-configurable:/res
    depends_on:
      - consul
      - logging
      - data 
...

使っているコンテナイメージは、いずれもまったく同じです。ボリュームも同じマウントのしかたをしていますが、使う設定ファイルを edgex_profile で制御しています。また、読ませる設定ファイルに応じて、必要な設定を環境変数で入れています。

MQTT ブローカや REST エンドポイントのホスト名などは環境に合わせて適宜修正してください。ほかにも、configuration.toml で変更したい値があれば、環境変数として与えると変えられます。

また、今回はエクスポートサービスが起動しないようにコメントアウトしています。

起動

下準備として、MQTT ブローカを起動して、購読を開始します。

$ docker run -d --rm --name broker -p 1883:1883 eclipse-mosquitto

$ docker run --init --rm -it efrecon/mqtt-client sub -h 192.168.0.100 -t "#" -v

別のターミナルで REST エンドポイントも起動します。

$ cd rest-endpoint

$ python ./main.py
 * Serving Flask app "main" (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: on
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 159-538-312
 * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)

この状態で、EdgeX Foundry を起動します。

$ docker-compose up -d

動作確認

必要な設定はすべて環境変数を使って与えていたので、何もしないでも MQTT トピックと REST エンドポイントに値が届き出します。

$ docker run --init --rm -it efrecon/mqtt-client sub -h 192.168.0.100 -t "#" -v
...
edgex-handson-topic {"id":"a11011bb-30cb-44fa-885c-8929c64e35b1","device":"Random-UnsignedInteger-Device","origin":1580015685340757500,"readings":[{"id":"26f50397-1e8b-4ca0-8db2-eeeee958a643","origin":1580015685326443600,"device":"Random-UnsignedInteger-Device","name":"Uint8","value":"90"}]}
edgex-handson-topic {"id":"526631fd-a0f7-437d-98a9-4f6eb8a06775","device":"Random-UnsignedInteger-Device","origin":1580015685369824800,"readings":[{"id":"91ef8066-5c31-4377-84e6-a6d517457f62","origin":1580015685356418200,"device":"Random-UnsignedInteger-Device","name":"Uint16","value":"27009"}]}
...
$ python ./main.py
...
--
2020-01-26 14:15:10.318596
{"id":"be20b21b-f0a4-4550-95bb-a78b5c597f56","device":"Random-Integer-Device","origin":1580015710310854200,"readings":[{"id":"d62fdacc-bfa4-4d05-a537-25c03e151f78","origin":1580015710295318700,"device":"Random-Integer-Device","name":"Int8","value":"3"}]}
192.168.0.100 - - [26/Jan/2020 14:15:10] "POST /api/v1/echo HTTP/1.1" 200 -
--
2020-01-26 14:15:10.375595
{"id":"c0275732-2e3d-4945-9435-d6e77e0ccb74","device":"Random-Integer-Device","origin":1580015710364584600,"readings":[{"id":"067d71a3-7c1f-4fea-968d-ac5db0410e67","origin":1580015710350134100,"device":"Random-Integer-Device","name":"Int16","value":"-23040"}]}
192.168.0.100 - - [26/Jan/2020 14:15:10] "POST /api/v1/echo HTTP/1.1" 200 -
...

簡単ですね。

これらの値は、冒頭で紹介した通り、それぞれのアプリケーションサービスが直接コアサービス層から値を受け取って処理したうえでエクスポートしています。データパスが分散して並列化するので、エクスポートサービスを使っていた頃に存在していたボトルネックが回避されます。

まとめ

エクスポートサービスを利用しないエクスポート手段として、アプリケーションサービスを構成して試しました。

使ってみると、確かにこのアーキテクチャのほうが素直で圧倒的に使い勝手が良いです。家の環境もこっちに置き換えました。

現段階ではバンドルされている関数は多くないですが、今後この辺りも充実してくることが期待できそうです。

EdgeX Foundry 関連エントリ