Azure× Github × 自作Webアプリの開発・公開環境について整理してみた

この記事の目的

この記事では、
Nzenの開発・公開環境の整理をした時のメモ
を目的としています。

本題

★全体の構成について

---

コードの構成管理をしつつ、CI/CDの環境も構築したい。

…ということで、

最小限の投資でできる範囲の開発環境を構築することにしました。

既にある程度の開発をGithubで進めていたので、
ソースコードのリポジトリはGithubを使います。
しかし、Githubには、Ci/CDをするための設定がないため、
ほかのサービスの機能を使って、CI/CDを構築することにしました。


Githubと連携し、自由にCI/CD環境を構築することができるもの…

ということで、Azure DevopsのPiplinesを利用することにしました。
テスト…というテストはまだ整備していないですが、
CI/CD環境は基本的にすべてをPiplineの機能を使って実現していこうと思います。

アプリの公開については、アカウントがあるのでAzureを使うことにしました。
Azureのどのサービスを利用するか…という点については、当初、
Webアプリの公開になるので、WebAppsでいいかと思っていましたが、

・結構な頻度で更新する
・すぐに立ち上がってほしい
・細かいアプリ設定は環境変数で変更できるようにしたい

という気持ちが高まってきたので、コンテナーをデプロイできるものにしようと考えなおしました。
ということで、今回は、Azure Container Instanseを利用してアプリを公開します。

コンテナを使ってアプリを公開することになったので、
コンテナのためのリポジトリ（レジストリ？）も必要になりました。
レジストリについては、Docker hubか、Azure Container Registoryか迷っていますが、
動作確認のために使っていた環境があるので、Azureを使っていこうと思います。


いずれ利用料金的なところで問題が出てきたら
Docker hubやその他のサービスに切り替えていこうと思います。

ということで、第一弾の開発・公開環境の構成はこのようになりました。

★各種設定１）Azure Piplines

---

Azure Piplinesでは、以下のことを実行します。
１）Webアプリケーションのビルド
２）ビルドしたモジュールの単体テスト
３）Docker Imageのビルド
４）Docker ImageをAzure Container Registoryに登録
５）ACIで動いているコンテナのDocker Imageの更新

ASP,NETの「Dockerサポート」では、
上記の１）と、３）を実行するDockerfileを作成してくれます。


これに単体テスト実行処理を追加するか、
すべてを分けて実行するようにするか検討する必要があります。

…が、まだテストの実装まで至っていないので、
１～３）までをDocker Imageのビルドと一緒に行ってしまう方向で進めます。
いずれ、テストをするようになったときに再度検討します。

★各種設定２）環境変数

---

（今後作っていく）DBへの接続文字列や、
Cognitive Searcviceへの接続情報など、
ローカルの開発環境と、公開環境で異なる情報が存在します。

今までは、Configファイルに外だししてきましたが、
コンテナ化されたアプリケーションに対しては、
環境変数で切り替えるのがベストプラクティスとされています。
＜ここに参考URL＞

Nzenもこのプラクティスにならって、環境依存の情報は環境変数に外だしすることにしました。
こんな感じのクラスを使って、環境変数に外だしした情報を管理しようと思います。

    public class ApplicationEnv
    {
        public static ApplicationEnv Env = new ApplicationEnv();

        private ApplicationEnv()
        {
            var config = new ConfigurationBuilder().AddEnvironmentVariables().Build();
            var propList = typeof(ApplicationEnv).GetProperties();
            foreach (var item in propList)
            {
                var temp = string.Empty;
                try
                {
                    temp = config.GetValue<string>(item.Name.ToString());
                }
                catch (Exception) { }
                if (temp != null) item.SetValue(this, temp);
            }
        }

        #region プロパティ

        /// <summary>
        /// (いずれ実装する)DBへの接続文字列
        /// </summary>
        public string ConnectionString { get; set; } = string.Empty;

        /// <summary>
        /// Cognitive ServiceのAPI設定
        /// </summary>
        public string SpeechAPI_Key { get; set; } = string.Empty;

        /// <summary>
        /// Cognitive Serviceのリージョン設定
        /// </summary>
        public string SpeechAPI_Region { get; set; } = string.Empty;

        #endregion
    }

環境変数に設定した情報を使ってアプリケーションを動かす仕組みは完成しました。

が

その環境依存の環境変数の情報はどこに設定すればよいのでしょうか…
いくつか方法はあると思いますが、思いついたのは以下の３パターンでした。
①Dockerfile中に埋め込む
②Azure Piplineの処理の中（ACI更新時）
③初回のACI作成時

Githubにコミットしたとき、パスワードなどの情報が含まれないようにしたいので、
①は除外しました。
初回だけだと、やり方を忘れてしまいそうなので、③も除外しました。

ということで、②のAzure Piplineの処理の中で、ACIの更新を行う処理に
環境変数を設定する処理を追加することにしました。

まとめ（られなかったこと）、今後の課題

ひとまず、GithubとAzureを使ってそれっぽい開発環境の構築ができました。
ただ、まだ暫定対応しているところもいろいろあるので、今後ブラッシュアップしていこうと思います。


課題１；単体テスト計画について考える
課題２：テストの実装
課題３：CI/CDをステップごとに定義するか、Docker build時に一気にやってしまうか決める