この章では、Kubernetes上でGitOpsを可能とするCDツールであるArgo CDについて紹介し、導入します。
CI/CDは、継続的インテグレーション（CI）と継続的デリバリー/デプロイメント（CD）を実現するための手法です。 CIは、アプリケーションのビルド、テスト、およびコードの統合を自動化するプロセス CDは、アプリケーションのデプロイメントを自動化するプロセスです。 テストやデプロイを自動化することで、オペミスや作業量を減らすことで余ったリソースでアリケーションやソフトウェアの品質を高めたり、リソースサイクルを早めることを目的としている。
GitOpsは、CI/CDを実現するための手法の一つで、Gitのリポジトリの変更をトリガーにCI/CDを実行することで、アプリケーションのデプロイメントを自動化するプロセスです。
Kubrnetes用のGitOpsツールで、Gitリポジトリに格納されたマニフェストをデプロイすることができます。WEB GUIとCLIの両方で操作することができ、アプリケーションやKuberenetesのリソースの状態を可視化し簡単に管理する事が可能になっています。 ArgoCDはGitHub等からのWebhookを受け取り、Gitリポジトリに格納されたマニフェストをデプロイすることができるため、開発者のコードPushやPRをトリガーにデプロイまで実行することができます。
Argo CDは三つのコアコンポーネントで構成されています。
- API Server
- Repository Server
- Application Controller
アプリケーションがGitリポジトリの定義と設定と一致しているかどうかを示すステータスです。
Gitリポジトリとアプリケーションの状態が一致せず、アプリケーションに変更があったか、同期エラーが発生したことを示します。
Gitリポジトリとアプリケーションの状態が一致し、アプリケーションが期待どおりに機能していることを示します。
アプリケーションの状態を示す異なるステータスで、アプリケーションの健全性や動作状態を示すステータスです。
アプリケーションのコンポーネントやサーバーが期待どおりに応答し、エラーや障害がない状態です。
アプリケーションが完全に停止していないが、一部の問題が存在する状態です。
アプリケーションやサービスが現在、新しいリクエストやデプロイメントなどの操作を処理していることを示し"Healthy" または "Degraded" の状態に変わります。
これらの三つの処理は、GitレポジトリとArgo CDの状態を同期させるための処理ですが細かな違いが存在します。
最新のGit上のマニフェストとRepository Server内にあるマニフェストを比較し、差分を反映します。 通常の更新はデフォルトで3分ごとに行われます。
HelmやKustomizeなどのコードから生成されたマニフェストをキャッシュしているマニフェストキャッシュをクリアし、新たにRefresh処理を行う操作です。これにより、マニフェストの変更の有無にかかわらず、マニフェストを再生成できます。 デフォルトで24時間ごとに、マニフェストキャッシュの有効期限が切れたときに行われます。
Kubernetes clusterをGitの状態に同期させるため、マニフェストの反映（デプロイ）をします。
Argo CDを利用する上では、GitHubへのPush等の変更が必要不可欠になります。そのため、このハンズオンのリポジトリをforkして操作する為の準備をします。
このハンズオンにアクセスし、forkをクリックします
Create fork をクリックします
自身のアカウントでforkされていることが確認できます
GitHubのリポジトリの登録やPushはforkした自身のリポジトリを利用して下さい
helmファイルを利用してArgo CDをインストールします。
helmfile sync -f helm/helmfile.yaml
作成されるリソースは下記の通りです。
kubectl get service,deployment -n argo-cd
# 実行結果
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/argo-cd-argocd-applicationset-controller ClusterIP 10.96.209.173 <none> 7000/TCP 26d
service/argo-cd-argocd-dex-server ClusterIP 10.96.116.27 <none> 5556/TCP,5557/TCP 26d
service/argo-cd-argocd-redis ClusterIP 10.96.28.90 <none> 6379/TCP 26d
service/argo-cd-argocd-repo-server ClusterIP 10.96.249.188 <none> 8081/TCP 26d
service/argo-cd-argocd-server ClusterIP 10.96.152.238 <none> 80/TCP,443/TCP 26d
NAME READY UP-TO-DATE AVAILABLE AGE
deployment.apps/argo-cd-argocd-applicationset-controller 1/1 1 1 26d
deployment.apps/argo-cd-argocd-dex-server 1/1 1 1 26d
deployment.apps/argo-cd-argocd-notifications-controller 1/1 1 1 26d
deployment.apps/argo-cd-argocd-redis 1/1 1 1 26d
deployment.apps/argo-cd-argocd-repo-server 1/1 1 1 26d
deployment.apps/argo-cd-argocd-server 1/1 1 1 26d
ingressを作成し、Argo CDのWEB UIにアクセス出来るようにします。
kubectl apply -f ingress/ingress.yaml
http://argocd.example.com/ へアクセスします。下記のページにアクセス出来るか確認して下さい。
- ユーザ名: admin
- パスワード: 以下のコマンドをサーバ上で実行した値
kubectl -n argo-cd get secret argocd-initial-admin-secret -o jsonpath="{.data.password}" | base64 -d ; echo
同期させるGitのレポジトリを登録します。
Settings - > Repositories と進み CONEECT REPOをクリックします
上の画面上で各項目を次のように設定
Choose your connection method: VIA HTTPS
Type: git
Project: default
Repository URL: https://github.com/自身のアカウント名/cndt2023-handson
CONNECTをクリックして、下記のように表示されていることを確認して下さい。
試しにデモアプリのデプロイを行い、Argo CDの一連の操作を行います。
Argo CDに同期させるGitリポジトリをを準備します。
git clone https://github.com/自身のアカウント名/cndt2023-handson.gitApplicationsの画面において + NEW APPをクリックします
上の画面上で各項目を次のように設定します。
GENERAL
Application Name: argocd-demo
Project Name: default
SYNC POLICY: Manual
SYNC OPTIONS: AUTO CREATE NAMESPACE [v]
SOURCE
Repository URL: https://github.com/自身のアカウント名/cndt2023-handson
Revision: main
Path: chapter05_argocd/app/default
DESTINATION
Cluster URL: https://kubernetes.default.svc
Namespace: argocd-demo
設定できたら、CREATEをクリックして、下記のように表示されていることを確認して下さい。
ページ上部にあるSYNCをクリックして、無事デプロイされると下記のように表示されていることを確認して下さい。
ブラウザから
http://app.argocd.example.com
へアクセスして確認してみてください。アプリケーションが表示され青い色のタイルが出てくるのが確認できます。
上記の手順でGitに保存しているマニフェストを参照して、アプリケーションのデプロイを行いました。次にGitの変更にKubernetes Clusterを同期させます。
app/default/deployment.yamlの編集を行います。 imageのtagをblueからgreenに変更します。
image: chmikata/rollouts-demo:green
差分をforkしたmainブランチ（Argo CDのappを作成する際に指定したブランチ）に取り込みます。
git push origin main
Argo CDはデフォルトでは3分に一回の頻度でブランチを確認し、差分を検出しています。 3分待てない場合には、ページ上部にある [REFRESH]をクリックします。下記のようにdeploymentにおいて差分が検出されます。（黄色で表示されているOutOfSyncが差分があることを示しています） ちなみにAppの設定において、SYNC POLICYをManualでなくAutoにしていた場合には、ここでOutOfSyncを検知すると自動でArgoCDがSyncを実行します。
Gitの変更をKubernetes Clusterに反映させるためにページ上部にあるSYNCをクリックして、下記のように表示されていることを確認して下さい。
http://app.argocd.example.com
へアクセスして確認するとタイルが青から緑に変わったことが確認できます。
ArgoCD上でマニフェストの管理ツールである「Kustomize」を利用した、開発環境と本番環境の2つのマニフェスト管理を行います。
Applicationsの画面において + NEW APPをクリックし、本番環境・開発環境それぞれのアプリケーションを作成します。 Applications 上の画面上で各項目を次のように設定します。(開発環境と本番環境で分けて表示してある項目は、それぞれ設定してください)
GENERAL
Application Name:
開発環境: argocd-kustomize-dev
本番環境: argocd-kustomize-prd
Project Name: default
SYNC POLICY: Manual
SYNC OPTIONS: AUTO CREATE NAMESPACE [v]
SOURCE
Repository URL: https://github.com/自身のアカウント名/cndt2023-handson
Revision: main
Path:
開発環境: chapter05_argocd/app/Kustomize/overlays/dev
本番環境: chapter05_argocd/app/Kustomize/overlays/prd
DESTINATION
Cluster URL: https://kubernetes.default.svc
Namespace:
開発環境: argocd-kustomize-dev
本番環境: argocd-kustomize-prd
設定できたら、CREATEをクリックします
ページ上部にある SYNCをクリックします(開発環境の場合はpodが1個、本番環境の場合はpodが2個出来るのが確認できます。)
ブラウザで各環境へアクセスして確認してみてください。タイルの色が開発環境と本番環境で違う事が確認できます。
- 開発環境: dev.kustomize.argocd.example.com
- 本番環境: prd.kustomize.argocd.example.com
KubernetesのパッケージマネージャーのHelmを利用したデプロイを行います。
Applicationsの画面において + NEW APPをクリックします
上の画面上で各項目を次のように設定します。
GENERAL
Application Name: argocd-helm
Project Name: default
SYNC POLICY: Manual
SYNC OPTIONS: AUTO CREATE NAMESPACE [v]
SOURCE
Repository URL: https://github.com/自身のアカウント名/cndt2023-handson
Revision: main
Path: chapter05_argocd/app/Helm/rollouts-demo
DESTINATION
Cluster URL: https://kubernetes.default.svc
Namespace: argocd-helm
設定できたら、CREATEをクリックします
ページ上部にある SYNCをクリックします（無事デプロイされると下記のようになります）
ブラウザで
helm.argocd.example.com
アクセスして確認してみてください。Helmを使ってデプロイが出来ている事が確認できます。
各アプリのDELETEをクリックします
Applications画面の場合は、一番右下の端に、
詳細画面の場合は、右上の2番目にあります。
削除する際にアプリケーション名の入力があるので入力してOKをクリックします。
全てのアプリケーションを削除して、初めてアクセスした画面と同じようにして下さい。
namespaceの削除を行います。
kubectl delete namespace argocd-demo argocd-kustomize-dev argocd-kustomize-prd argocd-helm