IBM Cloud から提供されている 30 日間無料 Kubernetes サービス（IBM Kubernetes Service 、以下 "IKS"）環境を使って利用することのできるコンテナイメージを１日に１個ずつ 30 日間連続で紹介していきます。

環境のセットアップや制約事項については Day0 のこちらの記事を参照してください。

Day 19 からはプログラミング・開発系コンテナとその GUI ツールを中心に紹介してます。Day 22 は実行可能な API ドキュメントを記述するエディタである Swagger Editor イメージをデプロイする例を紹介します。




【イメージの概要】
アプリケーション開発において、ドキュメント準備は（直接、プログラミングと関わる点が少ないという意味においても）比較的面倒な作業です。が、最近は Swagger  API ドキュメントとか Open API ドキュメントと呼ばれる、画面上で直接実行可能なドキュメンテーション技術が生まれたことで、プログラマーにとっても大事かつ役立つ作業となりました。

この Swagger API ドキュメントは特殊な JSON や YAML フォーマットで記述することで実現できるのですが、この特殊なフォーマットを知らなくても作れるようになるのが Swagger Editor です。今回紹介するのは、この Swagger Editor が使えるようになるコンテナイメージです。


【イメージのデプロイ】
まずはこちらのファイルを自分の PC にダウンロードしてください：
https://raw.githubusercontent.com/dotnsf/yamls_for_iks/main/swaggereditor.yaml

今回の Swagger Editor も特にパラメータ指定不要で、そのままデプロイすることができます。以下のコマンドを実行する前に Day 0 の内容を参照して ibmcloud CLI ツールで IBM Cloud にログインし、クラスタに接続するまでを済ませておいてください。

そして以下のコマンドを実行します：

$ kubectl apply -f swaggereditor.yaml

以下のコマンドで Swagger Editor 関連の Deployment, Service, Pod, Replicaset が１つずつ生成されたことと、サービスが 30080 番ポートで公開されていることを確認します：

$ kubectl get all

NAME                                  READY   STATUS    RESTARTS   AGE
pod/swagger-editor-6f94c7c8d6-6rc58   1/1     Running   0          6s

NAME                     TYPE        CLUSTER-IP       EXTERNAL-IP   PORT(S)          AGE
service/kubernetes       ClusterIP   172.21.0.1       <none>        443/TCP          27d
service/swagger-editor   NodePort    172.21.237.213   <none>        8080:30080/TCP   8s

NAME                             READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/swagger-editor   1/1     1            1           7s

NAME                                        DESIRED   CURRENT   READY   AGE
replicaset.apps/swagger-editor-6f94c7c8d6   1         1         1       8s

この後に実際にサービスを利用するため、以下のコマンドでワーカーノードのパブリック IP アドレスを確認します（以下の例であれば 161.51.204.190）：

$ ibmcloud ks worker ls --cluster=mycluster-free
OK
ID                                                       パブリック IP    プライベート IP   フレーバー   状態     状況    ゾーン   バージョン
kube-c3biujbf074rs3rl76t0-myclusterfr-default-000000df   169.51.204.190   10.144.185.144    free         normal   Ready   mil01    1.20.7_1543*

つまりこの時点で（上述の結果であれば）アプリケーションは http://169.51.204.190:30080/ で稼働している、ということになります。HATOYA はこの URL が管理ダッシュボードの URL になっているので早速実行してみます。ウェブブラウザを使って、アプリケーションの URL（上述の方法で確認した URL）にアクセスしてみます：



この GUI 画面（プレビュー画面）を使いながら Swagger API を作り、必要であればローカルファイルにエクスポートすることも可能です：



【YAML ファイルの解説】
YAML ファイルはこちらを使っています：

apiVersion: v1
kind: Service
metadata:
  name: swagger-editor
spec:
  selector:
    app: swagger-editor
  ports:
  - port: 8080
    protocol: TCP
    targetPort: 8080
    nodePort: 30080
  type: NodePort
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: swagger-editor
spec:
  replicas: 1
  selector:
    matchLabels:
      app: swagger-editor
  template:
    metadata:
      labels:
        app: swagger-editor
    spec:
      containers:
      - name: swagger-editor
        image: swaggerapi/swagger-editor
        ports:
        - containerPort: 8080

Deployment １つと、Service １つのシンプルな YAML ファイルです。一応解説を加えておきます。アプリケーションそのものは 8080 番ポートで動作するように作られているため、NodePort 30080 番を指定して、外部からは 30080 番ポートでアクセスできるようにしています（NodePort として指定可能な番号の範囲は 30000 ～ 32767 です、指定しない場合は空いている番号がランダムに割り振られます）。また ReplicaSet は１つだけで作りました。


デプロイしたコンテナイメージを削除する場合はデプロイ時に使った YAML ファイルを再度使って、以下のコマンドを実行します。不要であれば削除しておきましょう：

$ kubectl delete -f swaggereditor.yaml

【紹介したイメージ】
https://hub.docker.com/r/swaggerapi/swagger-editor


【紹介記録】

Day	カテゴリー	デプロイ内容
0	準備	準備作業
1	ウェブサーバー	hostname
2		Apache HTTP
3		Nginx
4		Tomcat
5		Websphere Liberty
6	データベース	MySQL
7		phpMyAdmin
8		PostgreSQL
9		pgAdmin4
10		MongoDB
11		Mongo-Express
12		Redis
13		RedisCommander
14		ElasticSearch
15		Kibana
16		CouchDB
17		CouchBase
18		HATOYA
19	プログラミング	Node-RED
20		Scratch
21		Eclipse Orion
22		Swagger Editor
23		R Studio
24		Jenkins
25	アプリケーション	FX
26		2048
27		DOS Box
28		VNC Server(Lubuntu)
29		Drupal
30		WordPress

タグ ：

#swagger

#swaggereditor

#editor

#ibm

#cloud

#k8s

#iks

#30days