WESEEK Tech Blog

WESEEK のエンジニアブログです

もう知らずにはいられないGitOpsを ArgoCDで学ぶ!

この記事は、 2021/5/13 に行われた WESEEK Tech Conference の内容です。

ArgoCDを使用したGitOpsについてお話ししました。実際のArgoCDの設定例などを紹介しながら、デモ形式でのGitOps構築までの道のりを紹介しました。

目次

GitOpsとは

DevOps のベストプラクティスを多く取り入れ、さらにインフラのコードの自動反映、バージョンコントロールもGitリポジトリの変更を起点にして行おう!というのがGitOpsという新しい開発・運用のフレームワークです。

GitOpsを導入していない場合の課題

まずGitOps を導入していない場合に起こり得る問題として以下のようなものがあります。

権限問題

CIにクラスターへの反映権限を持たせなければいけないので、最小権限管理ができない(乗っ取られたらやばい)

マニュアル作業によるオペレーションミス

kubectl describe deploy hogehoge を入力しようとしたら、kubectl delete deploy hogehoge を入力してしまい、一時的にサービスが落ちてしまった

リポジトリマニフェストはあるが反映されていない

リポジトリに含まれている、本来クラスターに反映されているはずのリソースが、反映されていないせいで他の作業者がタスクで詰まってしまう(あるはずのリソースがないから)

ArgoCDでGitOpsをしてみた理由

今回ArgoCDを選択してGitOpsをしてみた理由には以下のようなものがありました。

感情的動機

  • 新しい技術に触れてみたい
  • 自動化大好き

ちょっと真面目な理由

f:id:mugi-o:20210518215751j:plain

かなり見やすいですよね!

GitOps を実現できるツール

今回はKubernetesをインフラの環境としてGitOpsをしたので、Kubernetes ネイティブに設定できるものをいくつかピックアップしました。

  • ArgoCD
    • 視認性に優れたUI
    • プルーン機能による不要リソースの削除 や、セルフヒーリング機能などの提供
    • SSO のビルトインサポート、RBACが可能
  • FluxCD
    • GitOps toolkit の提供をしているので、他のCDツールと組み合わせて使うことが可能
    • Container Image Registry を監視することで image tag の自動更新(Live manifet and Gitリポジトリマニフェスト
    • UIがない...
  • PipeCD
    • 視認性に優れたUI
    • Kubernetes 以外の運用環境も対応(Terraform, Cloud Run, AWS Lambda)
    • カナリーリリース・シークレットマネジメントのビルトインサポート

ArgoCD のアーキテクチャ

ArgoCD を構成するコンポーネントとして主にクラスターへの反映に関わるコンポーネントは三つあります。

三つのコアコンポーネント

f:id:mugi-o:20210518220844j:plain

f:id:mugi-o:20210518220943j:plain

f:id:mugi-o:20210518221008j:plain

ArgoCD の主なCRD

CRD とはKubernetes デフォルトではないCR(カスタムリソース)をクラスターに反映するために定義し反映するリソースです。

ArgoCD では Application/AppProject CRD をインストール時に反映しCRとしてそのリソースを反映し実際にアプリケーションマニフェストを自動でデプロイします。

Application

  • Application CRD は ArgoCDをインストールした際、一緒にインストールされている
  • Application は必ずいずれかのAppProjectに結びついている必要がある
  • 主に定義すること
    • どのGitリポジトリからマニフェストを取得するか
    • どのクラスターにアプリケーションをデプロイするか
    • どのネームスペースにアプリケーションをデプロイするか
    • 自動同期を有効にするか

f:id:mugi-o:20210518221513j:plain

AppProject

  • Application CRD は ArgoCDをインストールした際、一緒にインストールされている
  • Application は必ずいずれかのAppProjectに結びついている必要がある
  • 主に定義すること

f:id:mugi-o:20210518221831j:plain

SSO での RBAC

ArgoCDへのアクセスコントロールGitHub のオーガニゼーション・チームベースやGitLabのグループベースで行いたくないですか?

ArgoCDではそんなアクセスコントロールを簡単に実現することができます。

サポート方式

主に二つの方式があります。

  • ArgoCD に組み込まれている OSSDex を使用
  • 既存OIDCプロバイダーを使用する

ArgoCD における Dex の役割

  • 外部認証プロバイダーに認証を委任する
  • 外部認証プロバイダーからユーザー情報を取得し、その情報を元にIDTokenを作成し提供する

設定例(helm values)

f:id:mugi-o:20210518222248j:plain

ロールの作成・割り当て

ただSSOで認証を行うだけでは、ロールが割り当てられていないので、ログインしても何も行えません。

なので、認証されたユーザーに対してロールを結びつける必要があります。

  • ビルトインロール
    • role:readonly
      • 全てのリソースに対してリード操作のみが可能
    • role:admin
      • 全てのリソースに対して全ての操作が可能
  • カスタムロール
    • argocd-rbac-cm に csv形式でロールの作成・割り当てが可能

f:id:mugi-o:20210518222809j:plain

サポートしているマニフェスト定義ツール

ArgoCD で自動デプロイする際に、サポートしているマニフェストの定義方式のようなものを紹介します。

4つの標準ツール

  • Jsonnet
  • Ksonnet
  • Kustomize
  • Helm

サポートされていないマニフェスト定義ツールを使用したい場合

サポートされていないマニフェスト定義ツールでも下記拡張機能を使用することで、使用できるようになります。

マニフェストの依存関係の考慮

なぜ依存関係を考慮する必要があるのか

複雑なクラスター構成になればなるほど、リソース同士の依存関係も複雑になります。 例えば、CalicoNetworkPolicyリソースは反映順序を間違えるとクラスター外への通信が全て拒否されるようなネットワーク構成になってしまうといった事も起こり得ます。

ArgoCD の Sync にはいくつかのフェーズがあり依存関係の考慮ができる

上記に書いたような課題の解決するためリソースの反映順序を考慮する機能をArgoCDでは提供しています。

  • Resource hooksWaveといった概念が存在する
    • Resource hooks は五つのフェーズ
      • ex. PostSync というフェーズはSync後に実行されるフェーズなので、Slack通知のJobマニフェストの反映などに適している
    • Wave は 数値による反映順序の優先付
  • 両方ともアノテーションから設定する
metadata:
  annotations:
    argocd.argoproj.io/hook: PostSync
    argocd.argoproj.io/sync-wave: “5”

Resource Hooks

下記のフェーズが上から順番に実行されていきます。

  • PreSync
    • DBのmigrationなどのJob実行
  • Sync
    • アプリケーションのデプロイ
  • Skip
  • PostSync
    • デプロイが完了した際にJob実行(Slack に通知など)
  • SyncFail
    • デプロイが失敗した際のクリーンアップ

Waves

  • デフォルトは全て0
  • 負の値も設定可能
  • 低い数字のものから反映されていく

まとめ

ArgoCD

  • ドキュメントが整備されているので簡単な設定であれば困ることはない
  • 費用対効果は高い
    • ArgoCDに費やす必要のある学習時間は少ない
      • How の部分は隠蔽してくれてくれている
      • マニフェストは直感的で、設定項目もそんなに多くない
    • 得られる恩恵は大きい
      • UI、自動化、 SSOによるRBAC...
  • ArgoCDだけでは、いい感じに構成できない機能もある
    • Slack通知など

実務に取り入れるための課題

  • 複雑なオペレーションを安全に自動化できるか
    • ex. リソースAを削除した後に、リソースBを反映し、リソースCはその後に消す
  • マルチクラスターを一つのArgoCDで管理するのか否か
    • ArgoCDに全てのクラスターの権限を持たせる必要がある
      • 権限管理的にどうなの?
  • 動的なマニフェスト変更
    • HPA などによる Deployment replicas の変更
      • OutOfSync になってしまい、セルフヒーリングを有効にしていた場合リバートされてしまう
      • ↑を防ぐために Diffing customization などの機構もある

著者プロフィール

岡 麦

株式会社WESEEK / バックエンドエンジニア

2020年6月より長期インターンシップに参画中の文系大学生。
主な担当業務は、大手IX企業様のポータルサイトの構築・保守、インフラ基盤の構築・運用を行っています。

株式会社WESEEKについて

株式会社WESEEKは、システム開発のプロフェッショナル集団です。

【現在の主な事業】

  1. 通信大手企業の業務フロー自動化プロジェクト
  2. ソーシャルゲームの受託開発
  3. 自社発オープンソースプロダクト「GROWI」「GROWI.cloud」の開発

GROWI

GROWIは、Markdown記法でページを記述できるオープンソースWikiシステムです。

【主な特徴】

  • テキストも図表もどんどん書ける、強力な編集機能
  • チーム拡大に迅速に対応できる管理者向け機能を提供
  • 充実した機能・サポートでエンタープライズにも対応

GROWI.cloud

GROWI.cloudOSSのGROWIを専門的知識がなくても簡単に運用・管理できる、法人・個人向けの商用サービスです。

大手SierISPから中小企業・大学などの教育機関まで幅広くご利用いただき、さらに個人や大学サークルでもご利用いただいています。

【導入事例記事】
インターネットマルチフィード株式会社様 growi.cloud

株式会社HIKKY(VR法人HIKKY)様 growi.cloud

WESEEK Tech Conference

WESEEK Tech Conferenceは、株式会社WESEEKが主催するエンジニア向けの勉強会です。
月に2回ほど、WESEEKに所属するエンジニアが様々なテーマで発表を行う予定です。

次回は、5/27(木) 19:00~20:00に開催予定です。 SaaS運用での大障害の対策の共有を、システムエンジニアの佐藤がお話します。

現在、connpassやTECH PLAYで参加受付中です。皆様のご参加をお待ちしております! weseek.connpass.com TECH PLAYはこちらから

一緒に働く仲間を募集しています

東京の高田馬場オフィス、大分にある別府サテライトオフィスにてエンジニアを募集しております。
中途採用だけではなく、インターンシップも積極的に受け入れています!

詳しい募集要項は、弊社HPの採用ページからご確認ください。