「Rio」- 古き良きDockerのUXをモダンなクラウドネイティブソフトウェア達に

Twitterにて「Rio」のデモ動画が発表された

つい先日(2018/8/7)、TwitterにてRancher社のDarren Shepherd氏がRioというプロダクトのデモ動画を発表してました。

前々から氏のツイートなどでRioの開発をしてる旨を匂わせていましたがいよいよ動く段階まできたようです。

Rancher 2.0の開発もまだまだ継続してる中、新しいプロダクトはしばらく先じゃないかと思ってましたが 思っていたより早い段階で動く姿を見れたので結構驚きました。

もうGitHubからダウンロードできる状態でしたので早速動かしてみました。

注: 以降は先のデモ動画の内容をなぞっていっただけのものです。 動画を見た方は多分この先読まなくてOKです。

Rio」って何?

Rancher社が開発している、新しいコンテナツールとのことです。

rancher/rio

READMEでは以下のように紹介されています。

  • Simple, fun, end-to-end container experience
  • Cloud Native Container Distribution

Rio is a user oriented end-to-end container solution with a focus on keeping containers simple and combating the current trend of complexity.
It's kept fun and simple through it's familiar and opinionated user experience.
Additionally, Rio is a "Cloud Native Container Distribution" meaning is includes builtin Cloud Native technologies such as Kubernetes, Istio, Containerd, etc.
so that the user need not be an expert in installing, using, and maintaining these system.

Cloud Native Container Distributionと掲げており、KubernetesやIstioをはじめとするCloud Nativeなプロダクトの組み合わせを シンプルなフロントエンドを通じて利用できるようになっています。

どんなプロダクトが含まれるかはデモ動画の中で紹介されていました(もちろんGitHub上にも書かれてます)。

f:id:febc_yamamoto:20180808195344p:plain

現在は基本となるコンテナランタイム(containerd)、オーケストレーション(kubernetes)、ネットワーク(flannel)、サービスメッシュ(istio)が組み込まれており、 今後はストレージ関連としてRancher社のLonghorn、モニタリングにPrometheus、イメージのビルドにBuildKit、イメージスキャンにCoreOSのClairなども組み込む予定のようです。

ということで早速動かしてみます。

Rioのインストール

Rioは既存のKubernetes(laptopの場合はMinikube or Docker for Win/Mac推奨とのこと)、またはLinux(4.x+)で動作するとのことです。

Prerequisites: If you want to run this on your laptop, then Minikube or Docker for Mac/Windows is recommended. If you don't have those then you need to run a Linux VM (or Linux itself, come to the darkside). We will make this easier in the future. Otherwise you can run this easily with any modern Linux server, nothing is needed to be installed except the kernel.

今回はクラウド上に立てたUbuntuで動かしてみます。 Rio本体以外はインストールする必要はないのですが、内部の調査をしたい方はkubectlくらいは入れておくと便利です。

余談1: Linux上でスタンドアロンで動かした場合はembededなk8sを起動して動作する、Rancher 2.0などと同じような動きをしてました
余談2: Docker for Macで試してたのですが外部からのアクセスができない箇所があって調べるのめんどくさくなったのでUbuntuにしました

まずRioの実行ファイルをGitHubからダウンロードし展開しておきます。

rancher/rio リリースページ

# ダウンロードして
$ curl -LO https://github.com/rancher/rio/releases/download/v0.0.2/rio-v0.0.2-linux-amd64.tar.gz

# 展開して
$ tar zxvf rio-v0.0.2-linux-amd64.tar.gz 

# PATHの通った場所へ
$ sudo mv rio-v0.0.2-linux-amd64/rio /usr/local/bin/

続いてRioコンポーネント群を起動します。 今回はRioスタンドアロンで起動します。もし既存のKubernetesクラスタを利用する場合はGitHub上のREADMEを参照してください。

# Rioサーバの起動(embeded-k8sモード)
$ sudo rio server

少し待つとコンソール上に以下のようにログイン用のトークンが出力されるはずです。 これをコピペして実行しましょう。

INFO[0010] To use CLI: rio login -s https://133.242.228.115:7443 -t xxxxxxxxxxxx::admin:xxxxxxxxxxxxxxxx 
# 起動したRioサーバへログイン(先ほどの表示をコピペ)
$ rio login -s https://133.242.228.115:7443 -t xxxxxxxxxxxx::admin:xxxxxxxxxxxxxxxx 

なお、rioコマンドをrootユーザで実行する場合はrio loginは不要とのことです。 以降はrioコマンドで様々な操作が可能になっているはずです。

余談: Rioスタンドアロンで起動した場合のkubectlの使い方

=== 2018/8/8 追記
rio -hには出てこないですが、よく見たらrio kubectlというサブコマンドがあるっぽいです。
なのでわざわざkubectlをインストールしなくても良さそうですね。
=== 追記ここまで

Rioスタンドアロンで起動するとRancher 2.0などと同じくembededモードでk8sを起動して利用するようになってました。 この場合、/var/lib/rancher/rio/server/cred/kubeconfig.yamlにkubeconfigが出力されてますのでこれを使えばkubectlも使えるようになります。 Rioを使うのであればkubectlは不要ですがやっぱりIstioのCRがどうなってるの?とか気になりますよね?そんな方向けの設定です。

# embededモードで起動しているk8sに接続するためのkubeconfigを環境変数に指定
$ export KUBECONFIG=/var/lib/rancher/rio/server/cred/kubeconfig.yaml

# kubectlが使えるはず
$ kubectl get cs
NAME                 STATUS    MESSAGE   ERROR
scheduler            Healthy   ok        
controller-manager   Healthy   ok 

$ kubectl get nodes #なんかバージョン表示がバグってるし
NAME             STATUS    ROLES     AGE       VERSION
node-conf-test   Ready     <none>    10m       v0.0.0-master+$Format:%h$

Rioでコンテナを起動してみる

まずは動かしてみます。 docker runするような感覚でrio runを実行することでコンテナの起動が可能です。

$ rio run --name foobar nginx  # --nameは省略可能

起動したか確認してみます。確認はrio psを実行します。

$ rio ps

NAME      IMAGE     CREATED          SCALE     STATE     ENDPOINT   DETAIL
foobar    nginx     10 seconds ago   1         active               

何か起動してるっぽいですね。 RioではDockerCompose風にServiceという単位でコンテナ(群)を管理しています。

Service

The main unit that is being dealt with in Rio are services. Services are just a collection of containers that provide a similar function. When you run containers in Rio you are really creating a Scalable Service. rio run and rio create will create a service. You can later scale that service with rio scale. Services are assigned a DNS name so that group of containers can be accessed from other services.

rio psで表示されるのはServiceの一覧ということですね。 さらにrio psに引数としてサービス名を与えることで詳細を確認可能です。

# サービスの詳細を確認
$ rio ps foobar

NAME                      IMAGE     CREATED              NODE                 IP         STATE     DETAIL
foobar/7946c5787c-l49rk   nginx     About a minute ago   node-conf-test       10.1.0.8   running   

コンテナへのattachやexecも可能です。

# コンテナ内でbashを実行(--interactive + --ttyオプションを指定 = dockerと同じ)
$ rio exec -it foobar bash

# *** ここはコンテナ内 ***
root@foobar-7946c5787c-l49rk:/# 

# 以下のようにサービス名/コンテナ名まで指定してもOK
# rio exec -it foobar/7946c5787c-l49rk bash

次にスケールアウトしてみます。

$ rio scale foobar=3

# 確認
$ rio ps
NAME      IMAGE     CREATED         SCALE     STATE     ENDPOINT   DETAIL
foobar    nginx     3 minutes ago   3         active               

$ rio ps foobar
NAME                      IMAGE     CREATED          NODE                 IP          STATE     DETAIL
foobar/7946c5787c-qqdkr   nginx     21 seconds ago   node-conf-test       10.1.0.9    running   
foobar/7946c5787c-snclf   nginx     21 seconds ago   node-conf-test       10.1.0.10   running   
foobar/7946c5787c-l49rk   nginx     3 minutes ago    node-conf-test       10.1.0.8    running   

端々がDockerっぽいですね。 他にもinspectといったおなじみのコマンドもありますので詳細はrio -hを実行して確認してみてください。

次に進む前に一旦起動したサービスを削除しておきます。

$ rio rm foobar

注: 今回は説明を簡単にするためにWorkSpaceやStackといった概念をすっ飛ばしてます。 詳細はGitHub上のConceptsを確認しておいてください。

Rioでサービスメッシュを体験してみる

RioにはIstioが組み込まれており簡単に利用できるようになっているようです。 ここでは

  • ステージング環境のデプロイ
  • カナリアリリース
  • ステージング環境を本番にプロモート

という流れで進めてみます。

サービスの起動 + 外部への公開

まずはサービスを起動し外部からアクセス可能にします。 ここではRioのREADME.mdに乗っているサンプルであるibuildthecloud/demo:v1というイメージを利用してます。 このイメージはHTTPでアクセスするとHello Worldという文字列を返すという単純なものです。

# -p(publish) オプションで80番ポートを公開
$ rio run -p 80/http --name rio-demo --scale=3 ibuildthecloud/demo:v1

確認しておきます。

$ rio ps

NAME       IMAGE                    CREATED          SCALE     STATE     ENDPOINT                                          DETAIL
rio-demo   ibuildthecloud/demo:v1   32 seconds ago   3         active    http://rio-demo.default.cr2ch1.lb.rancher.cloud 

なんだかエンドポイントとしてhttp://rio-demo.default.cr2ch1.lb.rancher.cloudというのが割り当てられてますね。 これはRioが割り当ててくれたもので、ノードのIPアドレスに解決されるようになってます。

# ノードのIPアドレス(この例では133.242.228.115/24)
$ ip a show dev eth0

2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
    link/ether 9c:a3:ba:30:60:dd brd ff:ff:ff:ff:ff:ff
    inet 133.242.228.115/24 brd 133.242.228.255 scope global eth0
       valid_lft forever preferred_lft forever

       
# Aレコードを確認してみる
$ dig rio-demo.default.cr2ch1.lb.rancher.cloud. A

; <<>> DiG 9.10.3-P4-Ubuntu <<>> rio-demo.default.cr2ch1.lb.rancher.cloud. A
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 45513
;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1

;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;rio-demo.default.cr2ch1.lb.rancher.cloud. IN A

;; ANSWER SECTION:
rio-demo.default.cr2ch1.lb.rancher.cloud. 60 IN A 133.242.228.115

;; Query time: 147 msec
;; SERVER: 133.242.0.3#53(133.242.0.3)
;; WHEN: Wed Aug 08 09:35:09 UTC 2018
;; MSG SIZE  rcvd: 85

エンドポイントのホスト名は<ServiceName>.<StackName>.<ClusterID>.<ROOT domain>となってます。
RootドメインRioスタンドアロンで起動した場合はlb.rancher.cloud、Docker for Macなどの場合は127.0.0.1.nip.ioが使われるようです。

この辺の処理は以下のあたりにありますので興味のある方はソース追ってみてください。

そしてRioが裏でIstioをいい感じに設定してくれるようになっており、このエンドポイントを使えばサービスにアクセスできるようになっています。

(Istioがどうなってるのか気になる方は記事の末尾の「おまけ: 段階ごとのkubectlなどの詳細」を参照してください)

起動したサービスにアクセスしてみる

ということで確認してみましょう。

$ curl -s http://rio-demo.default.cr2ch1.lb.rancher.cloud 
Hello World

無事にHello Worldと表示されるはずです。

ステージング環境のデプロイ

次にこのサービスを更新したイメージを用意し、ステージング環境をデプロイしてみます。 ここでは:v3というタグをつけたイメージを更新したイメージとして準備しています。

$ rio stage --image=ibuildthecloud/demo:v3 rio-demo:v3

psもみておきましょう。

$ rio ps
NAME          IMAGE                    CREATED          SCALE     STATE     ENDPOINT                                             DETAIL
rio-demo      ibuildthecloud/demo:v1   32 minutes ago   3         active    http://rio-demo.default.cr2ch1.lb.rancher.cloud      
rio-demo:v3   ibuildthecloud/demo:v3   32 minutes ago   3         active    http://rio-demo-v3.default.cr2ch1.lb.rancher.cloud 

rio-demo:v3というサービスが作成され、専用のエンドポイントが割り当てられています。 このエンドポイントを使ってステージング環境での動作確認が可能です。

$ curl -s http://rio-demo-v3.default.cr2ch1.lb.rancher.cloud
Hello World v3

カナリアリリース

ステージング環境での動作確認が済んだらカナリアリリースしてみます。

まずは元のサービス(この例だとhttp://rio-demo.default.cr2ch1.lb.rancher.cloud)にアクセスした際、20%の確率でv3にアクセスされるようにしてみます。

$ rio weight rio-demo:v3=20%

その後元のサービスのエンドポイントにアクセスすると時折v3の方にアクセスするようになっています。

# URLは同じであることに注目

$ curl -s http://rio-demo.default.cr2ch1.lb.rancher.cloud 
Hello World

$ curl -s http://rio-demo.default.cr2ch1.lb.rancher.cloud 
Hello World v3

ステージング -> 本番へプロモート

カナリアリリースの結果が良好だったのでいよいよステージング環境を本番環境に昇格させます。

$ rio promote rio-demo:v3

その後はv3の方にしかアクセスされなくなっています。

$ curl -s http://rio-demo.default.cr2ch1.lb.rancher.cloud 
Hello World v3

psをみてみるとステージング環境がなくなり、元のサービスと入れ替わっているのが確認できます。

$ rio ps
NAME       IMAGE                    CREATED         SCALE     STATE     ENDPOINT                                          DETAIL
rio-demo   ibuildthecloud/demo:v3   8 minutes ago   3         active    http://rio-demo.default.cr2ch1.lb.rancher.cloud   

ということでサービスメッシュ周りの確認をしてみました。

終わりに

Rancher社が発表した新しいツール「Rio」を試してみました。
Docker風の操作感なのでもともとDockerコマンドに慣れていた方には違和感なく取り組めそうな気がします。
今のところk8s+istioのラッパーといった感が強いですが、今後組み込みのプロダクトは順次増えていくはずです。

なお、現状ではまだまだ開発中ということもあり動作が不安定です。 随所にバグもみられますので今は雰囲気を感じてみる程度の使い方となります。

今後に期待しましょう。

以上です。

おまけ: 段階ごとのkubectlなどの詳細

ここからは各操作ごとにkubectlを実行してみた結果を貼っておきます。
どのようにistioを操作しているのかなどを見てフムフムしたい方向けです。

長いのでgistに貼っておきます。

途中で面倒になったので全ての変化を網羅したわけではないのでご注意ください。

RKEでAWS上にKubernetes(v1.10)をデプロイする

f:id:febc_yamamoto:20180529205711p:plain

Rancher Blogに新しい記事(RKE+AWS)が投稿されてた

今月半ばにRancher Labsのブログに以下の記事が投稿されていました。

Rancher Blog: How To Deploy Kubernetes Clusters On AWS Using RKE

AWS上にRKEを用いてKubernetesクラスタを構築するという内容です。

でもRKEの最新版だと動かない…

手順が丁寧に書かれていてわかりやすい内容なのですが、利用しているRKEのバージョン(v0.1.5)が古く、最新版を利用するとうまく動きませんでした。

そこで、最新版できちんと動かすために必要な作業についてこの記事にまとめてみました。

ついでにTerraformでコード化しました

記事を書くついでにこの構成を手軽に試せるようにTerraformTerraformのRKEプロバイダーを利用してコマンド一発で構築できるようにもしました。

Terraform + RKEプロバイダーのtfファイル

ということで早速RKEの最新版での動かし方をみていきます。

RKE(v0.1.7) + AWSでKubernetes

TL;DR

  • 基本はRancher Blogに記載の手順でOK
  • RKEの最新版であるv0.1.7はデフォルトではKubernetes v1.10がデプロイされる
  • Kubernetes v1.10でAWS向けのCloud Controller Managerを利用する場合、ClusterIDが指定されていないとkubeletの起動に失敗する
  • なので以下リソースにClusterID用のタグを付与すればOK

解説

RKEの最新版であるv0.1.7はデフォルトではKubernetes v1.10がデプロイされる

まず、Rancher Blogの該当記事で利用されているRKEのバージョンはv0.1.5です。
このバージョンではrke upを実行すると(デフォルトでは)Kubernetes v1.8がデプロイされていました。

なので、後述するClusterIDが設定されていなくても問題なく利用できていたようですね。

Kubernetes v1.10でAWS向けのCloud-Controller-Managerを利用する場合、ClusterIDが指定されていないとkubeletの起動に失敗する

Kubernetes v1.10のCHANGE LOGを見ると、以下のPRによるものです。

kubernetes/kubernetes #60125

対応: 各リソースにClusterID用のタグを付与する

ということで、Kubernetes v1.10を使う場合はClusterIDを指定すればOKということですね。
タグの付け方についてはRancherのドキュメントに記載がありました。

Rancher docs: Kubernetes - Cloud Providers / Configuring the ClusterID

このドキュメントによると、 - サブネット - セキュリティグループ - EC2インスタンス に対してkubernetes.io/cluster/CLUSTERID=ownedのようなタグをつければ良いとのことでした。
IDはCLUSTERIDの部分を任意の値に書き換えることで設定可能です。

Terraform + RKEプロバイダーで構築する

ClusterID用のタグをつけるのは割と面倒な作業なのでTerraformでコード化しました。
以下のリポジトリでコードを公開しています。

GitHub: yamamoto-febc/k8s_on_aws_with_terraform

なお、このコードではRKEプロバイダーを利用して、RKEでのKubernetesクラスタ構築までを一気に行なっています。

RKEプロバイダーについては以下の記事を参照ください。

Terraform + RKEでKubernetesクラスタ構築 - TerraformのRKEプロバイダー

以下コードのポイントを解説しておきます。

IAMプロファイルの作成

(※Rancher Blogでの該当部分)

この辺りは以下のtfファイルにまとめています。

https://github.com/yamamoto-febc/k8s_on_aws_with_terraform/blob/master/aws/iam.tf

ClusterID用のタグ付与

サブネット/セキュリティグループ/EC2インスタンスに対してタグを指定しています。
以下のような感じです。

# タグの定義
locals {
  cluster_id_tag = "${map("kubernetes.io/cluster/${var.cluster_id}", "owned")}"
}

# 利用するリージョン内の全AZのデフォルトサブネットを対象にClusterID用のタグを付与
data "aws_availability_zones" "az" {}
resource "aws_default_subnet" "default" {
  availability_zone = "${data.aws_availability_zones.az.names[count.index]}"
  count             = "${length(data.aws_availability_zones.az.names)}"
  
  tags              = "${local.cluster_id_tag}" #タグの指定
}

サブネットについてはデフォルトサブネットに対してタグ付与しています。
また、セキュリティグループについてはRancher Blogと同じく全許可のルールとしています。

ノードのプロビジョニング

(※Rancher Blogでの該当部分)

Dockerをインストールして、SSH接続の際に利用するユーザー(記事ではubuntu)をDockerグループに入れる必要があります。

tfファイル上はremote-execを利用して以下のようにしています。

resource "aws_instance" "rke-node" {
  count = 4

  ami                    = "${data.aws_ami.ubuntu.id}"
  instance_type          = "${var.instance_type}"
  key_name               = "${aws_key_pair.rke-node-key.id}"
  iam_instance_profile   = "${aws_iam_instance_profile.rke-aws.name}"
  vpc_security_group_ids = ["${aws_security_group.allow-all.id}"]
  tags                   = "${local.cluster_id_tag}"

  provisioner "remote-exec" {
    connection {
      user        = "ubuntu"
      private_key = "${tls_private_key.node-key.private_key_pem}"
    }

    # Dockerのインストールとdockerグループへの追加
    inline = [
      "curl releases.rancher.com/install-docker/1.12.sh | bash",
      "sudo usermod -a -G docker ubuntu",
    ]
  }
}

なお、インスタンスタイプは記事ではt2.largeが推奨されていますが、軽く試すだけならt2.microで十分でした。
(tfファイル上はデフォルトでt2.microにしました)

RKEの実行

(※Rancher Blogでの該当部分)

RKEの実行はRKEプロバイダーに任せます。
以下のようなtfファイルとなります。

module "nodes" {
  source = "./aws"
}

resource rke_cluster "cluster" {
  cloud_provider {
    name = "aws"
  }

  nodes = [
    {
      address = "${module.nodes.addresses[0]}"
      user    = "${module.nodes.ssh_username}"
      ssh_key = "${module.nodes.private_key}"
      role    = ["controlplane", "etcd"]
    },
    {
      address = "${module.nodes.addresses[1]}"
      user    = "${module.nodes.ssh_username}"
      ssh_key = "${module.nodes.private_key}"
      role    = ["worker"]
    },
    {
      address = "${module.nodes.addresses[2]}"
      user    = "${module.nodes.ssh_username}"
      ssh_key = "${module.nodes.private_key}"
      role    = ["worker"]
    },
    {
      address = "${module.nodes.addresses[3]}"
      user    = "${module.nodes.ssh_username}"
      ssh_key = "${module.nodes.private_key}"
      role    = ["worker"]
    },
  ]
}

RKEコマンドを直接実行する場合は、rke up実行後にカレントディレクトリにkube_config_cluster.ymlファイルが作成されます。
RKEプロバイダーの場合はデフォルトでは作成されませんので、以下のようにlocal-file機能でファイル出力しています。

resource "local_file" "kube_cluster_yaml" {
  filename = "./kube_config_cluster.yml"
  content  = "${rke_cluster.cluster.kube_config_yaml}"
}

terraform apply実行後にexport KUBECONFIG=$PWD/kube\_config\_cluster.ymlを実行しておけばkubectlが利用できるはずです。

後はRancher Blogの内容をそのまま進めていけるはずです。


ということでRancher Blogの補足をしつつ、Terraform + RKEプロバイダーで環境構築してみました。

なおこの構成は全通信許可などのガバガバ設定になっていますので検証などでのみ利用してくださいね!!

以上です。

Terraform + RKEでKubernetesクラスタ構築 - TerraformのRKEプロバイダー

f:id:febc_yamamoto:20180528165306p:plain

2018/5/18に東京で開催されたRancher2.0リリースパーティで以下のLTをさせていただきました。

このLTで発表したTerraformのRKEプロバイダーについてご紹介いたします。

その前に: RKE(Rancher Kubernetes Engine)とは?

RKEとは、一言で言うと「Kubernetesクラスタのデプロイツール」です。

f:id:febc_yamamoto:20180528155207p:plain

kubernetesクラスタのデプロイツールとしてはkubeadmkopsといったものもありますが、それらと比較するとRKEは以下のような特徴があります。

  • 対象ノードに外部からSSH接続してプロビジョニングを行う
  • kubernetesの各種コンポーネント(etcdやapiserverなど)をDockerコンテナとして起動する
  • 最初からHAなクラスタを構築可能

RKEの使い方

ノードの準備

まずk8sクラスタをプロビジョニングするノードを用意しておく必要があります。 以下の条件を満たすノードを用意します。

Requirements

  • Docker versions 1.11.2 up to 1.13.1 and 17.03.x are validated for Kubernetes versions 1.8, 1.9 and 1.10
  • OpenSSH 7.0+ must be installed on each node for stream local forwarding to work.
  • The SSH user used for node access must be a member of the docker group.
  • Ports 6443, 2379, and 2380 should be opened between cluster nodes.
  • Swap disabled on worker nodes.

https://github.com/rancher/rke#requirements

RKEのドキュメントには記載されていませんが、以下のポートも必要に応じて開けておく必要があります。

f:id:febc_yamamoto:20180528155213p:plain

(初回のみ)RKEのインストール

続いてRKEのインストールを行います。 RKEはGo言語で書かれており、実行ファイルをダウンロードして実行権を付与するだけでインストールできます。

以下のRKEのリリースページから各プラットフォーム向けのバイナリをダウンロードし実行権を付与しておきます。

https://github.com/rancher/rke/releases/latest

※当記事執筆時点での最新バージョンはv0.1.7です。

定義ファイル(cluster.yml)の作成

RKEではどのノードをプロビジョニングするかといった設定をcluster.ymlという定義ファイルで指定します。
(定義ファイル名はデフォルトではcluster.ymlですが、別の名前でもOKです。その場合はrke up時に--configオプションを指定します)

最小の定義ファイルは以下のようになります。

nodes:
  - address: <用意したノードのIPアドレス または ホスト名>
    user: <SSH接続用のユーザー名>
    role: [controlplane,worker,etcd]

nodesにはプロビジョニング対象となるノードをリストで指定します。 ここでは指定していませんが、SSH用にパスワードや秘密鍵SSHエージェント利用有無なども指定可能です。
(RKE v0.1.7以降は踏み台ホスト(bastion_host)も指定可能)

その他の指定できる項目についてはGitHub上にcluster.ymlのサンプルが公開されていますのでそちらを参照してみてください。
https://github.com/rancher/rke/blob/v0.1.7/cluster.yml

rke upコマンドの実行

定義ファイルが用意できたらrke upコマンドを実行することでk8sクラスタのプロビジョニングが行えます。

rke up

プロビジョニングが正常に終わるとkube_config_cluster.ymlというファイルが作成されます。 kubectlコマンドを利用する場合はこのファイルを利用するようにします。 ~/.kube/configを上書きするか以下のようにすればOKです。

# 環境変数を使う場合
$ export KUBECONFIG=${PWD}/kube_config_cluster.yml
$ kubectl get cs

# --kubeconfigオプションを使う場合
$ kubectl --kubeconfig kube_config_cluster.yml get nodes 

RKEについてはRancher Meetup大阪で発表したことがありますので、詳細はこちらも参照ください。

TerraformのRKEプロバイダー

ここまで見てきたように、RKEでクラスタをプロビジョニングするには

  • あらかじめノードを用意し
  • 定義ファイルを作成し
  • rke up実行

というステップを踏む必要があります。

この辺を毎回手作業で行うのは大変なので、RKEをTerraformから直接扱えるようにしたのがTerraformのRKEプロバイダーです。

TerraformのRKEプロバイダー

以下のようなtfファイルを用意してterraform applyを実行することで、RKEでクラスタのプロビジョニングが行えます。

resource rke_cluster "cluster" {
  nodes = [
    {
      address = "<用意したノードのIPアドレス または ホスト名>"
      user    = "<SSH接続用のユーザー名>"
      role    = ["controlplane", "worker", "etcd"]
    }
  ]
}

RKEの定義ファイル(cluster.yml)に書く内容をtfファイルに書けるようにしています。
tfファイルに書けるということは、${}記法などのTerraformの強力な機能をそのまま利用できるということです。

例えばEC2インスタンスを作成し、そこに対しRKEでk8sクラスタのプロビジョニングを行いたい場合は以下のように書けます。

# EC2インスタンス(Ubuntu)
resource "aws_instance" "rke-node" {
  // [...]
  ami = "${data.aws_ami.ubuntu.id}"

  // Dockerのインストール & ubuntuユーザーをdockerグループに追加
  provisioner "remote-exec" {
    connection {
      user        = "ubuntu"
      private_key = "${tls_private_key.node-key.private_key_pem}"
    }
    inline = [
      "curl releases.rancher.com/install-docker/1.12.sh | bash",
      "sudo usermod -a -G docker ubuntu",
    ]
  }
}

# RKE
resource rke_cluster "cluster" {
 nodes = [
    {
      address = "${aws_instance.rke-node.public_dns}"
      user    = "ubuntu"
      ssh_key = "${tls_private_key.node-key.private_key_pem}"
      role    = ["controlplane", "etcd", "worker"]
    },
  ]
}

ここではノードとしてAWSを利用しましたが、DigitalOceanやさくらのクラウドなどのTerraformが対応しているプラットフォームであればもちろん利用可能です。

RKEプロダイバーの便利機能

kubeconfigファイルの出力

以下のようにlocal_fileを利用すればrkeコマンド実行時と同じくkube_config_cluster.ymlを取得できます。

resource "local_file" "kube_cluster_yaml" {
  filename = "${path.root}/kube_config_cluster.yml"
  content = "${rke_cluster.cluster.kube_config_yaml}"
}
TerraformのKubernetesプロバイダーとの連携

TerraformのKubernetesプロバイダーと簡単に連携できるように認証情報などを参照可能な機能も用意しています。 以下のようにすることでRKEで作成したk8sクラスタの認証情報をKubernetesプロダイバーで利用可能です。

provider "kubernetes" {
  host     = "${rke_cluster.cluster.api_server_url}"
  username = "${rke_cluster.cluster.kube_admin_user}"

  client_certificate     = "${rke_cluster.cluster.client_cert}"
  client_key             = "${rke_cluster.cluster.client_key}"
  cluster_ca_certificate = "${rke_cluster.cluster.ca_crt}"
  
  # デフォルトでは~/.kube/configをロードしてしまうので
  # 必要に応じて以下コメントアウトを解除
  
  # load_config_file = false
}

# kubernetesプロバイダーを利用してネームスケースを作成する例
resource "kubernetes_namespace" "example" {
  metadata {
    name = "terraform-example-namespace"
  }
}

まとめ

今回はTerraformのRKEプロバイダーをご紹介しました。

Terraformでノードの作成からkubernetesクラスタのプロビジョニングまで一気に行えることで環境構築が非常に楽になると思います。
一歩進んでk8sクラスタの使い捨て運用なども可能になるかもしれないですね。

と言うことでぜひRKEプロバイダーをお試しください。

以上です。

さくらのクラウド + Kubernetesでマネージドなロードバランサを使う

f:id:febc_yamamoto:20180329174148p:plain

さくらのクラウドのマネージドなL4ロードバランサーをKubernetesから使えるようにCloud Controller Managerを実装してみました。
Kubernetesでserviceを作成する際にtype: LoadBalancerと指定することで動的にマネージドロードバランサーを作成してくれます。

GitHub: sacloud/sakura-cloud-controller-manager

今回はこの仕組みをどう実現しているか/どう使うのかについてご紹介します。

3/30 追記: コメントで「ループバックへのVIP設定は不要」とのご指摘をいただきました。
改めて0からクラスタを再構築して試したところ上手くいきましたのでVIP関連の記述を修正しました。
id:masaya_aoyama さんご指摘ありがとうございました!

Kubernetesでtype: LoadBalancerなserviceを作成するには

GKEやAKSではtype: LoadBalancerと指定してserviceを作成することでマネージドなロードバランサーを利用可能となっています。
せっかくさくらのクラウドでKubernetesを使うならやっぱりtype: LoadBalancerでマネージドなロードバランサでserviceを使いたいですよね。

でも単純にKubernetesクラスタさくらのクラウド上にデプロイしただけではtype: LoadBalancerは利用できません。

というのも、type: LoadBalancerなserviceはKubernetesのCloud Controller Managerというクラウド(等)のプラットフォームとのインテグレーションを担当する部分で 実装されており、各クラウドプラットフォームごとにCloud Controller Managerを実装する必要があるためです。

参考:Kubernetes ドキュメント: Concepts Underlying the Cloud Controller Manager

Cloud Controller Managerの実装としては、Kubernetesのソースツリー配下に以下のプラットフォーム向けの実装があります。(v1.10時点)

  • aws
  • azure
  • cloudstack
  • gce
  • openstack
  • ovirt
  • photon
  • vsphere

ここにないプラットフォームについては独自に実装することでKubernetesと統合可能となっています。 (実装すべきインターフェースはこちらに定義されています -> kubernetes/pkg/cloudprovider/cloud.go)

既にDigitalOceanやOracle Cloud Infrastructureといったプラットフォームについては実装が公開されていますし、既存の実装を改造することでオンプレミス向けにCloud Controller Managerを実装した事例なども公開されています。

参考(スライド): Kubernetes meetup #7 スライド
参考(記事):Kubernetes をいじって Hardware LoadBalancer で “type LoadBalancer” を実現してみた @Kubernetes meetup #7

Cloud Controller Managerの実装については↑↑の記事が素晴らしいですのでオススメです。

ということで、さくらのクラウドtype: LoadBalancerなサービスを使うにはCloud Controller Managerが必要ということなので早速実装してみました。

さくらのクラウド向けのCloud Controlelr Managerの実装

全体としては以下のようになります。

f:id:febc_yamamoto:20180329174217p:plain

順番に解説していきます。

さくらのクラウドで利用できるロードバランサの仕様

まず、今回利用するさくらのクラウドのマネージドなロードバランサの主な仕様を押さえておきます。
主な仕様は以下の通りです。

  • DSR(Direct Server Return)方式のL4ロードバランサ
  • ルータ+スイッチまたはスイッチを使用して構築されたネットワーク内にのみ設置可能
  • VRRPを用いた冗長化に対応
  • VIPは最大10個
  • 実サーバはVIPあたり最大40台まで

参考: さくらのクラウド マニュアル: ロードバランサ

Kubernetesと統合する上で特にポイントとなるのは以下2点です。

  • ルータ+スイッチまたはスイッチを使用して構築されたネットワーク内にのみ設置可能
  • DSR方式であること

ルータ+スイッチとは、さくらのクラウドグローバルIPをブロック単位(/28〜/24)で確保するためのもので、 割り当てられたブロック内のグローバルIPは配下に接続したサーバやロードバランサなどに自由に割り振り可能となっています。

このルータ+スイッチにサーバとロードバランサを接続することでDSRでのロードバランシングを実現しています。 DSR方式自体については以下の資料などを参照ください。

f:id:febc_yamamoto:20180329174228p:plain

出典: JANOG32 OSAKA - ロードバランスを考える

このDSR方式のロードバランサを使う場合は以下のような設定をサーバに対して行う必要があります。

  • VIPに応答するためにループバックにVIPを設定
  • VIP宛のARPに応答しない設定

3/30 修正 & 追記: 今回はロードバランサ作成時に動的にVIPを確保する仕組みとなっており、VIP確保時に各Workerノードに対してVIPをループバックに設定する必要があります。この辺りを動的に行うための仕組みも今回実装しています。 ループバックへのVIP設定はservice作成時にkube-proxyによってiptablesに追加されるルールにより処理されるため設定不要です。

Cloud Controller Managerの処理の流れ

今回中心となるのはControl Plane上で稼働するCloud Controller Managerです。
service作成時に以下のような流れでロードバランサの作成やVIP割り当てなどを行ってくれます。

(1) serviceの作成

まずはkubectl exposeなどでtype: LoadBalancerと指定してserviceを作成します。
この時点ではまだロードバランサが作成されておらず、各WorkerノードにVIPが割り当てられていない状態です。

f:id:febc_yamamoto:20180329174156p:plain

(2) ロードバランサの作成

serviceが作成されるとCloud Controller Managerが動き出します。
まずスイッチ+ルータに割り当てられたグローバルIPブロックから未使用のグローバルIPを探します。
グローバルIPが見つかったらスイッチ+ルータの配下にロードバランサを作成します。

f:id:febc_yamamoto:20180329174200p:plain

(3) VIPの割り当て & 実サーバの登録

次にロードバランサにserviceが利用するVIPを割り当てます。このVIPがkubectl get svcなどで見えるExternal IPとなります。
VIPを割り当てた後は振り分け先となる実サーバを登録します。現時点での実装だと全Workerノードあてに振り分けるようにしています(オプションで変更可能となる予定です。)

なおVIPはIPアドレス+ポート番号の組み合わせで登録するため、service作成時に複数のポートを公開するように指定されていた場合はポート番号ごとにVIPを登録します。

この時点でVIP宛てのリクエストが各Workerノードに振り分けられるようになりました。
しかしまだ各WorkerノードのループバックにVIPが割り当てられていないため、パケットが到着しても反応できない状態です。

f:id:febc_yamamoto:20180329174205p:plain

3/30 追記:
serviceが作成されExternal IPが割り当てられると、kube-proxyによりVIP + 指定ポートへのパケットを処理するルールが各ノードのiptablesに追加されます。
このため、ループバックへのVIPの割り当ては不要です。

--- 3/30 修正: ここから不要 ---

VIP-Agentが各WorkerノードにVIPを割り当てる

次に各WorkerノードにVIPを割り当てます。これはCloud Controller Managerで実装しても良いのですが、今回は別途エージェントを用意しました。
エージェントはVIP-Agentという名前で、Kubernetesオブジェクトの変更を監視するControllerとして実装しています。

画像: https://cdn-ak.f.st-hatena.com/images/fotolife/f/febc_yamamoto/20180329/20180329174211.png

VIP-Agentは以下ようなyamlを用いて特権モード(privilege=true)かつhostのネットワークを直接利用する形で起動します。 DaemonSetですので各Workerノードで起動し常駐することになります。

apiVersion: extensions/v1beta1
kind: DaemonSet
metadata:
  name: sakura-vip-agent
  namespace: kube-system
spec:
  template:
    metadata:
      labels:
        name: sakura-vip-agent
    spec:
      serviceAccountName: sakura-vip-agent
      hostNetwork: true
      containers:
        - image: sacloud/sakura-vip-agent:0.0.1
          name: sakura-vip-agent
          securityContext:
            privileged: true
          volumeMounts:
            - mountPath: /dev
              name: dev
      volumes:
        - name: dev
          hostPath:
            path: /dev

このような形にしておくことでserviceにExternal IPが割り当てられたことを検知し、ホスト側のインターフェースの設定を変更することが可能となります。
今回はserviceのExternal IPにはVIPが割り当てられますので、それをループバックに設定する役割となっています。
これでVIP宛てのリクエストを各workerが処理できるようになりました。

--- 3/30 修正: ここまで不要 ---

ここまでくれば後はkube-proxyがPodまで届けてくれます。
(この辺の詳細はQiita:GKE/Kubernetes でなぜ Pod と通信できるのかが詳しいです)

さくらのクラウド向けCloud Controller Managerの使い方

次に実際の利用方法についてです。さくらのクラウド向けのCloud Controller Managerを利用するには以下の作業が必要です。

  • 各workerノードをスイッチ+ルータ配下に作成
  • 各workerノードでVIP宛てのarpに応答しないための設定
  • kubeletの起動パラメータとして--cloud-provider=externalを指定
  • Cloud Controller Managerのデプロイ(今回はhelmを利用)

各workerノードをスイッチ+ルータ配下に作成

Kubernetesクラスタ構築の際にworkerノードをスイッチ+ルータ配下に配置します。
注意点としては、各ノードのホスト名をクラスタ内で一意にすることと、ホスト名とさくらのクラウド上のサーバ名を同じにしておくことがあります。

これはCloud Controller Managerがworkerノードを検知するのに各ノードのホスト名を元にさくらのクラウドAPIで各サーバを探しに行くようにしているからです。

各workerノードでVIP宛てのarpに応答しないための設定

次にVIP宛てのarpに応答しないようにカーネルパラメータを設定します。
CentOSの場合だと以下のように指定します。

# /etc/sysctl.confに以下2行を追記
net.ipv4.conf.all.arp_ignore = 1
net.ipv4.conf.all.arp_announce = 2

# 追記した内容を反映
$ sysctl -p

kubeletの起動パラメータとして--cloud-provider=externalを指定

次にkubeletの起動パラメータを追加します。Kubernetes本体のソースツリー配下にないCloud Controller Managerを利用する場合は--cloud-provider=externalというパラメータを指定する必要があります。

参考: Kubernetesドキュメント: Running cloud-controller-manager

Kubernetesクラスタのセットアップ方法によって設定方法は異なります。
例えばkubeadmの場合は各ノードの/etc/systemd/system/kubelet.service.d/10-kubeadm.confEnvironment="KUBELET_EXTRA_ARGS=--cloud-provider=externalを追記します。
(追記後にkubeletの再起動などで反映するのをお忘れなく!)

Cloud Controller Managerのデプロイ

最後にCloud Controller Managerをデプロイします。(3/30 修正: VIPの記述を除去)
デプロイは手動でyamlを投入しても良いですが、簡単にデプロイできるようにHelm Chartを用意しています。

GitHub: sacloud/helm-charts/sakura-cloud-controller-manager

まず、Cloud Controller ManagerさくらのクラウドAPIを利用するためAPIキーの設定が必要になります。
helmでのインストール時にAPIキーを指定してください。

# helm initを実行(まだしていない場合のみ)
$ helm init

# helmにsacloudリポジトリを追加
$ helm repo add sacloud https://sacloud.github.io/helm-charts/

# デプロイ実行
$ helm install sacloud/sakura-cloud-controller-manager --name sakura-ccm \
    --set sacloud.accessToken=<APIトークン> \
    --set sacloud.accessTokenSecret=<APIシークレット> \
    --set sacloud.zone=<ゾーン(is1a/is1b/tk1a)>

3/30 修正: VIP-Agentの記述を除去

後は少し待てばCloud Controller ManagerVIP-Agentが起動するはずです。
(kube-systemネームスペースにデプロイされますので、確認はkubectl get all -n kube-systemのようにしてください)

これで準備が整いました。 次に実際にserviceを作成してみます。

Podを作成しtype: LoadBalancerなserviceを作成してみる

まずはserviceでexposeするコンテナを作成します。今回は例としてload-balancer-exampleという名前でnginxを起動してみます。

kubectl run load-balancer-example --replicas=2 --labels="run=load-balancer-example" --image=nginx:latest  --port=80

これでload-balancer-exampleという名前のDeploymentが作成され、ReplicaSet/Podも作成されます。

次に作成されたDeploymentをexposeしてserviceを作成します。その際にtype: LoadBalancerの指定をしておきます。

kubectl expose deployment load-balancer-example --type=LoadBalancer --name=load-balancer-example

service作成直後はExternal IP<pending>となります。

$ kubectl get svc load-balancer-example
NAME                    TYPE           CLUSTER-IP      EXTERNAL-IP   PORT(S)        AGE
load-balancer-example   LoadBalancer   10.107.97.231   <pending>     80:30900/TCP   1m 

External IPが割り当てられるまでしばらく待ちます。割り当てられると以下のような表示となるはずです。

$ kubectl get svc load-balancer-example
NAME                    TYPE           CLUSTER-IP      EXTERNAL-IP       PORT(S)        AGE
load-balancer-example   LoadBalancer   10.107.97.231   nnn.nnn.nnn.nnn   80:30900/TCP   3m

後はブラウザなどでExternal IP宛てにアクセスすると表示されるはずです。

後片付け

serviceを削除するとロードバランサも削除されます。(3/30 修正: VIPの記述を削除)

以下のコマンドでserviceとdeploymentを削除しておきましょう。

$ kubectl delete svc load-balancer-example
$ kubectl delete deploy load-balancer-example

終わりに

ということでさくらのクラウド+Kubernetesでもtype: LoadBalancerなserviceが使えるようになりました。
今回実装したCloud Controller Managerはまだ実験段階ですが、これからドッグフーディングということで実環境で使いつつブラッシュアップしていきたいと考えています。

さくらのクラウドでKubernetesを利用する際はぜひCloud Controller Managerをお試しください〜!!

以上です。

etcdからkubernetesの動きを見る「kube-ectd-helper」

f:id:febc_yamamoto:20180325223207p:plain

多分すごく限られた層にだけ響くツール「kube-etcd-helper」を作りました。

kube-etcd-helperは、kube-apiserverが利用しているetcdに直接アクセスし、 データのダンプや変更の検知を行うためのツールです。

kubernetesの全体のデータの動きを知りたい方や、kubernetesを開発プラットフォームとして利用するインフラエンジニアの方などは便利にお使いいただけると思います。

kube-etcd-helper

Kubernetesオブジェクトの中身を見るには

Kubernetesオブジェクトとは、Kubernetesのクラスタの状態を表す永続化されるエンティティのことです。
podとかserviceとかdeploymentなどですね。

Understanding Kubernetes Objects

これらは通常kube-apiserverによって公開されるAPIを通じて操作します。
kube-apiserverの背後ではetcdが動いており、エンティティの永続化に使われています。

手っ取り早くKubernetesオブジェクトの中身を確認するにはkubectl getコマンドを利用するのが楽です。
例えばpodオブジェクトの中身を見るには以下のようなコマンドを実行します。

$ kubectl get pod <pod名>
NAME                           READY     STATUS    RESTARTS   AGE
hello-world-55c844bc5b-544h6   1/1       Running   0          3d

より詳細に見るには-o yaml-o jsonといったオプションをつければOKです。
よく使うコマンドですので馴染みのある方も多いですよね。

さらに、--watchというオプションをつけることで、指定オブジェクトの変更を追い続けることも可能です。

# --watchオプションをつけると、オブジェクトの変更を検知できる
$ kubectl get pod <pod名> --watch
NAME                           READY     STATUS    RESTARTS   AGE
hello-world-55c844bc5b-544h6   1/1       Running   0          3d

また、kube-apiserverが提供するREST APIを直接利用する方法でもオブジェクトの内容を確認できます。

# kubectl proxyを併用する場合
$ kube proxy --port=8080 &
$ curl http://localhost:8080/api/v1/namespaces/<ネームスペース>/pods/<pod名> 
{
  "kind": "Pod",
  "apiVersion": "v1",
  "metadata": {
    "name": "<pod名>",

   # 以下略
  }
}

これらの方法以外にも、etcdctlなどのetcdクライアントツールで直接データの中身を覗く方法も取れそうなのですがこの方法には問題があります。
というのも、kubernetes 1.6以降はetcd v3がデフォルトとなりバイナリーフォーマット(protobuf)でシリアライズされたデータが格納されているため、
コマンドラインから覗いても(一部を除き)読めないデータとなっているからです。

ということで多くのケースではkubectlまたはREST APIを利用することになると思います。

問題となるケース

通常はkubectlまたはREST APIを利用すれば事足りると思いますが、いくつか面倒なケースというのもあります。

  • kubectl runなどの複数のオブジェクトにまたがる操作を追いたい場合
  • オブジェクトの変更履歴を比較し、どこが変わったのか確認したい場合

例えばkubectl runを実行すると、Deployment/ReplicaSet/Podが作成されます。 これらの動きを追いたい場合--watchオプションを利用することになるのですが、 現在はkubectl get allに対しての--watchオプションは残念ながらサポートされていないためそれぞれに対し個別にkubectl get --watchしないといけません。

また、--watchで変更履歴を追えますが、変更されるごとに個別のファイルに出力といったことはできないためどこが変わったのか比較するのがなかなかに面倒な作業です。

これらの問題を解決するためにkube-etcd-helperを作りました。

kube-etcd-helperは何をするの?

kube-etcd-helperは、kube-apiserverが利用しているetcdに直接アクセスしデータのダンプや変更の検知を行うためのツールです。
前述の通りkubectlREST APIからではネームスペース/オブジェクトを跨いだ全オブジェクトを追うのはなかなか手間ですが、kube-etcd-helperを利用すれば簡単にできちゃいます。

kube-etcd-helperのインストール

kube-etcd-helperはGoで書いているため、インストールは実行ファイルをダウンロードして実行権を付与するだけでOKです。
以下のGitHubリリースページからダウンロードしてください。

kube-etcd-helper ダウンロード

あとはetcdに接続できる環境で実行するだけです。
master上で直接kube-etcd-helperを実行できる場合は問題ないですが、Docker for Macなどの直接etcdと通信できない環境の場合は 事前に以下のようにポートフォワードしておきます。

kubectl port-forward etcd-docker-for-desktop 2379:2379 --namespace=kube-system

なおデフォルトではlocalhost:2379に対して通信しようとしますがオプションで変更も可能です。 同じく証明書の指定などもオプション指定可能です。

kube-etcd-helperの使い方

ダンプ

etcd内でのキー階層をそのままディレクトリ/ファイルにダンプが可能です。

# etcdのデータをoutディレクトリにダンプ
$ kube-etcd-helper dump -o out/ --pretty

f:id:febc_yamamoto:20180325221247p:plain

変更の追跡(watch)

kubectl--watchオプションと同じく、変更を検知するためのwatchサブコマンドを用意しています。
これを利用すれば、全ネームスペースの全オブジェクトの動きを追うことが可能です。

# etcdのデータの変更を検知して標準出力に書き出し
$ kube-etcd-helper watch --pretty

watchサブコマンドはディレクトリ/ファイルへの出力に対応しているため、diffコマンドなどを併用することでどこが変わったのかを追うことも容易です。

# ディレクトリ/ファイルへの出力
$ kube-etcd-helper watch -o out/ --pretty

f:id:febc_yamamoto:20180325221252p:plain

この例はkubectl runhello-worldというdeploymentを作成した時の動きをwatchサブコマンドで記録したところです。
deployment/replicaset/podそれぞれの配下にJSON形式で変更内容を保存しています。
diffコマンドなどを併用するとオブジェクトのどの値が変更されたのか確認できます。

f:id:febc_yamamoto:20180325221256p:plain

この図はPodの作成〜schedulerがスケジューリングする部分ですね。Podのステータスがどう変わったのか一目瞭然です。

また、ファイル名はetcdのリビジョン番号を利用していますので、ファイル名順に並べればkubernetesがどの順番でetcdに対して操作を行なっているのか追うことも可能ですね。

その他のコマンド

その他にはlistgetサブコマンドがあります。 listはetcdのキーのみを一覧表示します。getは指定キーの内容を表示してくれます。

他にもいくつかオプションがありますので、詳細は--helpを参照してください。

終わりに

ということでkube-etcd-helperの紹介でした。 カスタムのコントローラーを書く方やkubernetesの内部構造をもっと知りたいという方には便利だと思いますのでぜひご利用ください!!

以上です。

Terraform公式のモジュールレジストリ「Terraform Registry」でモジュールを公開する方法

f:id:febc_yamamoto:20180201085942p:plain

TerraformにはTerraform Registryという公式のモジュールレジストリが用意されています。 今日はTerraform Registryでモジュールを公開する方法について紹介します。

Terraform Registryでモジュールを公開するまで

Terraform RegistryはGitHubのパブリックなリポジトリに一定のルールに従ったTerraformモジュールを置けば公開できるようになっています。

モジュール公開までの手順

手順としては以下の通りです。

リポジトリ/モジュール作成時のルール

リポジトリ/モジュール作成の際は以下のルールに従う必要があります。

順番に見ていきましょう。

モジュール用のGitHubリポジトリ作成

まずGitHubでパブリックなリポジトリを作成しましょう。
リポジトリ名はterraform-<PROVIDER>-<NAME>という形式にする必要があります。

例えばAWS向けにconsulクラスタをセットアップするようなモジュールであればterraform-aws-consulという名前にします。

<PROVIDER>の部分はモジュールが操作する対象のプロバイダーの名前を指定します。
複数のプロバイダーを利用することもあると思いますが、その場合はメインとなるプロバイダーの名前を指定すればOKです。

<NAME>の部分はモジュールの名前を指定します。
ハイフンを含む名前も指定できます。

モジュールの作成

リポジトリを作成したらモジュールの作成を行います。
ファイル構成はStandard module structureに従う必要があります。

Standard module structureって?

モジュール作成の際のファイル構成の作法です。

  • [必須]ルートモジュールであること
  • READMEファイルを持つこと
  • ライセンスファイルを持つこと
  • main.tf / variables.tf / outputs.tfを持つこと
  • 変数(Input Variables)とアウトプット(Output)はそれぞれ説明(Description)を指定すること
  • ネストしたモジュールがある場合はmodulesディレクトリ配下に置くこと
  • 利用例はexamplesディレクトリ配下に置くこと

ルートモジュールとは、モジュールのルートディレクトリ直下にtfファイルの存在するモジュールのとこです。
大抵のモジュールは問題なくルートモジュールと言えるでしょう。

READMEファイルはREADMEまたはREADME.mdというファイル名である必要があります。

ライセンスは任意のライセンスが利用できるようですが、Apacheライセンス 2.0が多い印象です。

ファイル配置としてはmain.tf/variables.tf/outputs.tfを少なくとも作成します。
もちろんこれ以外の任意の名前のtfファイルやテンプレートなどを含んで構いません。
ただし、ネストしたモジュールを含む場合はmodulesディレクトリに配置します。

READMEファイル作成時の注意点

Terraform Registryで公開する際はもちろんレジストリのURLで公開されます。
このため、READMEに画像ファイルやリンクを含める場合は絶対パスとしなければなりません。

モジュールにタグをつける

モジュールを作成したらセマンティックバージョンに従った名前のタグをつけます。 0.0.0または頭にvをつけたv0.0.0形式とします。
忘れずにGitHubにpushしておきましょう。

# タグの作成
$ git tag v0.0.1

# GitHubにpush
$ git push origin v0.0.1

モジュールの公開

後はTerraform Registryで公開作業をするだけです。

公式ドキュメントに動画がありますのでこちらを参照してください。
ほぼ迷うことはないと思いますが、個人リポジトリではなくオーガニゼーション配下のリポジトリを指定したい場合はOAuth時に忘れずにGrantしておいてください。

f:id:febc_yamamoto:20180315220842g:plain

引用元: https://www.terraform.io/docs/registry/modules/publish.html

以上でモジュールが公開できました。

公開されたモジュールを利用する

公開されたモジュールは<GitHubのアカウント or オーガニゼーション>/<モジュール名>/<プロバイダー名>という形式で利用することになります。

例えば、以下の場合だとfoo/bar/awsということになります。

  • GitHubのアカウントはfoo
  • モジュール名は bar
  • プロバイダーは aws

tfファイルにはこんな感じで記載します。

module "your_module_name" {
  source  = "foo/bar/aws"
  version = "0.0.1"
}

後は通常のTerraformを利用する流れと同じでterraform initを実行後にplanapplyを実行するだけです。

おわりに

Terraformモジュールを作ったことがある方であれば非常に簡単に公開できますね!
ちなみに、Terraform Enterpriseを利用すればプライベートなレジストリも利用できるとのことです。
興味がある方はHashiCorp Japanに問い合わせしてみると良さそうです。

ということでガンガンモジュール作成しましょうー!

以上です。

【さくらのクラウド】Kubernetesクラスタ構築用のモジュールをTerraform Registryに公開しました

f:id:febc_yamamoto:20180314182720p:plain

はじめに

先日 Open Service Broker for さくらのクラウドというプロダクトを公開しました。

参考: Open Service Broker for さくらのクラウドでKubernetes + Service Catalog出来るようになりました

これを試すには以下2つの方法があります。

Docker for Mac/Windowsの方は気軽に試せますが、やはりちゃんと複数台のサーバで構成されたKubernetesクラスタで動かしたいですよね。
でもVPC内に手動でクラスタを構築するのはなかなか大変な作業です。

そこで、Terraform(とTerraform for さくらのクラウド)でコマンド一発で構築できるようにしました。
Terraformの公式モジュールレジストリであるTerraform Registryに公開していますので非常に簡単に利用することができます。

Terraform Registry: sacloud/kubernetes-single-master/sakuracloud

f:id:febc_yamamoto:20180314183244p:plain

今回はこのモジュールの使い方について紹介します。

Terraform RegistryのモジュールでKubernetesクラスタを構築する

準備

terraformterraform for さくらのクラウドのインストールを行っておきます。

以下のドキュメントを参考にインストールし、APIキーの取得/設定などを行っておいてください。

Terraform for さくらのクラウド インストールガイド

構築

まずは以下のようなtfファイルを用意します。

module "kubernetes" {
    source = "sacloud/kubernetes-single-master/sakuracloud"

    // サーバーのrootユーザーのパスワード
    password = "<put-your-password-here>"

    // ワーカーノードの数(0でもOK、0だとマスター上でPodが稼働する)
    worker_count = 3
}

あとは通常のTerraformの流れでterraform initしてterraform applyすればOKです。
簡単ですよね?

あとは構築完了まで数分待ちましょう。

Kubernetesクラスタを使ってみる!

無事構築できましたでしょうか?

構築できたら早速使ってみましょう。

以下2通りの利用方法があります。

  • SSHでマスターノードに接続して利用
  • マスターノードからkubeconfigファイルをダウンロードして利用

順に説明します。

マスターノードにSSH接続

terraform applyを実行したディレクトリにcertsディレクトリが作成されています。
この中にサーバへのSSH接続用の秘密鍵が格納されています。

これを利用すればマスターノードだけでなく、ワーカーノードへもSSH接続が行えます。

さくらのクラウド CLI Usacloudを利用する場合は以下のようにすればSSH接続できます。

# サーバ名 kubernetes-master-01を指定してSSH接続
$ usacloud server ssh -i certs/id_rsa kubernetes-master-01

デフォルトではマスターノードの名前はkubernetes-master-01となっているはずです。
変更している場合はコマンドを適宜読み替えてください。

あとはkubectlコマンドやhelmコマンドが利用できるようになっています。

# クラスタの情報を表示
$ kubectl cluster-info

# ノードの状態を表示
$ kubectl get node

Type: LoadBalancerServiceは動かせませんがIngressなどはちゃんと動きます。

kubeconfigファイルをダウンロードして利用

SSH接続せずともkubeconfigファイルをマスターノードからダウンロードすることでローカルマシン上のkubectlコマンドから操作できるようになります。

kubeconfigファイルはマスターノードの/etc/kubernetes/admin.confに置かれていますのでSCPなどでダウンロードします。
Usacloudの場合は以下のコマンドでダウンロード可能です。

# SCPでダウンロード
$ usacloud server scp -i certs/id_rsa kubernetes-master-01:/etc/kubernetes/admin.conf ./admin.conf

ダウンロード後は--kubeconfigオプションで都度指定 or KUBECONFIG環境変数を設定するなどで利用します。

# コマンドラインオプションで都度指定する場合
$ kubectl --kubeconfig admin.conf cluster-info

# 環境変数で指定することも可能
$ export KUBECONFIG=$(pwd)/admin.conf
$ kubectl cluster-info

注意点

このモジュールはシングルマスタ構成で、耐障害性などは考慮していません。
開発/検証用途など向けとなっています。 必要であれば自分でetcdのバックアップなどを行ってください。

終わりに

ということで非常に簡単に使えますのでぜひご利用ください!!