IBM Cloud Operator を使ってIBM Cloudのサービス（Database for MongoDB）の接続情報をOpenShiftのSecretsに取り込み、Node.js のアプリから接続してみる

はじめに

IBM Cloud 上で Node.js と MongoDB を使ったアプリケーションの開発を行う上で、アプリケーションコンテナ基盤として、物理サーバ上に OpenShift のクラスターを構築し、データベースとしては、マネージドデータベースサービスである、IBM Cloud Database for MongoDB を利用する環境を用意しました。
OpenShift 上の Node.js アプリケーションから、データベースに接続する上では、MongoDB（IBM Cloud Database for MongoDB サービス）の接続情報が必要となりますが、このIBMのマネージドDBサービスの接続情報を、OpenShiftのSecretsに取り込む（バインドする）一つの方法として、IBM Cloud Operator というツール（仕組み）が提供されており、それを使った一連の手順を簡単にご紹介いたします。
＃ ちなみに、アプリケーションコンテナ基盤として、IBMの提供するマネージドKubernetesサービスである、「OpenShift on IBM Cloud」や「IBM Kubernetes Service」を使っている場合は、CLI上で、「ibmcloud ks cluster service bind」 コマンドを使うことで、サービスのバインド（K8sのSecretsへの接続情報の取り込み）が可能です。

全体ステップ

1. OpenShift上で IBM Cloud Operatorを導入する
2. IBM Cloud Operator を使って、稼働済みのIBM Cloud Database for MongoDB をサービスとして登録する
3. IBM Cloud Operator で、バインドを追加登録する
4. OpenShift 上で、登録されたSecretsを確認する
5. Database for MongoDB にアクセスする Node.js サンプルアプリで、登録されたSecrets情報を使って、実際に接続を試してみる

ステップ１： IBM Cloud Operatorを導入する

OpenShiftポータルの OperatorHub にて、「ibmcloud」で検索し、「IBM Cloud Operator」を選択します。

導入するOperatorの内容を確認し、「Install」ボタンを押します。

デフォルトのまま「Install」ボタンを押します。

Operatorの導入はすぐに完了します。

ステップ2: IBM Cloud Operator を使って、稼働済みのIBM Cloud Database for MongoDB をサービスとして登録する

IBM Cloud Operator の利用方法などについては、以下のGitHub上に詳しく記載されています。
https://github.com/IBM/cloud-operators/blob/master/README.md

OpenShiftのポータルの左のメニューで「Installed Operators」から、「IBM Cloud Operators」の詳細画面に移ります。

Serviceの「Create Instance」を押して、YAML Viewにて、以下のコードを参考にして、自分の環境にあったコードを書き（置き換え）ます。

apiVersion: ibmcloud.ibm.com/v1
kind: Service
metadata:
  name: db4mongodb
  namespace: mongodb-sample
spec:
  plan: Alias
  serviceClass: databases-for-mongodb

name: <稼働済みのDBサービス名>
namespace:　<アプリケーションを配置しているProject（namespace）名>
plan: Alias（稼働済みのサービスの場合の固定値）
serviceClass: databases-for-mongodb（IBM Cloud Database for MongoDBの場合の値）

---

＃補足： 自分の環境の稼働済みのDBサービス名やserviceClass名を確認したい場合は、CLIから

% ibmcloud resource service-instances --long

と実行すると確認できます。

---

（ステップ２続き）
YAMLファイルが作成できたら、下の「Create」ボタンを押します。

サービスが作成され、Statusが 「State: Online」になれば、自身の環境のデータベースサービスが認識された状態となります。

ステップ3： IBM Cloud Operator で、バインドを追加登録する

ステップ２同様、IBM Cloud Operatorの詳細画面にて、Bindingの「Create Instance」を押して、YAML Viewにて、以下のコードを参考にして、自分の環境にあったコードを書き（置き換え）ます。

apiVersion: ibmcloud.ibm.com/v1
kind: Binding
metadata:
  name: binding-mongodb
  namespace: mongodb-sample
spec:
  secretName: binding-db4mongodb
  serviceName: db4mongodb

name: <任意のバインディング名>
namespace:　<アプリケーションを配置しているProject（namespace）名>
secretName: <OpenShift上で利用する任意のSecrets名>
serviceName: <前のステップで定義したサービス名>

YAMLファイルが作成できたら、下の「Create」ボタンを押します。

バインディングが作成され、Statusが 「State: Online」になれば、バインディングが作成された状態となります。

ステップ4： OpenShift 上に登録されたSecretsを確認する

OpenShiftのWebコンソールのSecretsにステップ3のYAMLの「secretName:」で定義した名前のSecretができている事を確認します。

＃表示されない場合は、Projectが正しく選択しているか確認してください。

Secret名を押して、どのような内容がバインドされ（取り込まれ）ているか確認します。


＃以下のSecretsが作成されています。
Key名： connection
Value値: < json形式のDBサービスの接続情報 >

---

ご参考： Database for Mongodb のサービス資格情報にもバインド情報が追加されています。

---

ステップ5: Database for MongoDB にアクセスする Node.js サンプルアプリで、登録されたSecrets情報を使って、実際に接続を試してみる

今回は、Database for MongoDBのDocs上の以下のチュートリアルを参考にしながら、
https://cloud.ibm.com/docs/databases-for-mongodb?topic=cloud-databases-tutorial-k8s-app
その中で提供されている、以下のソースコードを使ってアプリケーションの稼働確認を行いました。
https://github.com/IBM-Cloud/clouddatabases-helloworld-kubernetes-examples/blob/node/mongodb/server.js

---

ご参考までに、サンプルアプリの稼働確認を行った手順を簡単に記載しておきます。

A-1. GitHub上にあるソースコードのリポジトリにアクセス

A-2. ソースコードを一部カスタマイズして利用できるように、自身のGitHubレポジトリにForkする
・右上の「Sign in」ボタンにて、自身のGitHubアカウントでログインする
・右上の「Fork」ボタンを押して、サンプルレポジトリを自身のGitHubアカウントのレポジトリとして取り込む（自身のアカウント配下に正しくレポジトリがコピーされている事を確認）

A-3. 今回利用するサンプルコードの構成と中身を確認
利用するのは「Node」ブランチの中の「mongodb」フォルダ配下にあるコード群なので、ブランチを「master」から「Node」に切り替えてから、mongodbフォルダを押し、以下のファイルの中をみて、サンプルアプリの構造を理解する
今回利用するソースコード
・Dockerfile
・package.json
・server.js
・publicフォルダ配下のUI系ファイル

A-4. サンプルのソースコードの一部を修正
上記のソースコードで、メインとなる server.js では、「はじめに」の章で少し触れた、CLI上で「ibmcloud ks cluster service bind」 コマンドで生成した、Secrets名が「binding」のjson形式のデータを抜き出すように書かれています。
今回バインディングした（Secretsに取り込んだ）「connection」は、「binding」の1階層下に含まれているjson構造の為、少しだけコードを書き換えます。

右のペンのマークを押して編集モードに変更

変更箇所：
49行目 BINDING → CONNECTION
55行目 credentials.connection.mongodb → credentials.mongodb

元コード：

修正後コード：

コード変更後に「Commit Changes」で変更を確定

A-5. mongodb-sample プロジェクトを新規作成

A-6. OpenShiftのビルダーを使ってGitからアプリケーションをデプロイ
Develperパースペクティブで「+Add」から「From Git」を選択

「Import from Git」にて、上記で編集を加えた自身のリポジトリ名と、「Git Reference」（ブランチ名）に「node」、「Context Dir」に「/mongodb」と入力

「Builder」は「Node.js」を選択

「General」では、「Name」に適当な名前を入力し、その下の「Create」ボタンを押す前に、「Deployment」リンクを押す

「Add from Config Map or Secret」を押して、「NAME」には「CONNECTION」を入力し、「VALUE」は「binding-db4mongodb」と「connection」を選択し、余計な1行をマイナスボタンで消して、最後に、「Create」ボタンを押す。

A-7. トポロジービューでデプロイメント（Pod）が正常に稼働した事を確認し、「OpenURL」で、サンプルアプリにアクセスする

A-8. ブラウザーにて、入力欄に適当なデータを入れて「Add」ボタンを押す

＃この時点で、Database for MongoDBに正常にアクセスできており、MongoDBのテーブルにデータが1行追加されたのがわかる

---

以上、IBM Cloud上にて、OpenShift上のNode.jsから、IBM Cloud Database for MongoDBに接続するアプリケーションを作成する際に、IBM Cloud Operatorを使って、Database for MongoDBの接続情報を、OpenShift上のSecretsに取り込む一連の手順についてご紹介させていただきました。

IBM Cloud Operatorはまだ発展途上のOperatorであり、Database for MongoDBの接続情報のOpenShift上への取り込みも、様々な方法があると思いますが、まだ、IBM CloudやOpenShiftなどを、あまり触ったことの無い方にとって、何かのご参考になれば幸いです。