Tweet
Tweet

Slide 1

Slide 1 text

LangGraphとFlaskを用いた 社内資料検索ボットの実装 ③アプリケーション構築編 2025/2/22 機械学習の社会実装勉強会 第44回 熊懐 葵

Slide 2

Slide 2 text

目次 • Sofiaについて • 背景と目的 • 使い方 • これまでの実装 • アプリケーション構築 • インフラパート • アプリパート 2

Slide 3

Slide 3 text

プロジェクト・業務データ 背景と目的 ディースタッツでは、複数のソフトを連携させてプロジェクトを推進している Slack Jira Confluence Github 連携・通知 タスク管理 業務資料 開発 データ・ノウハウを活かして業務効率化をしたい 3

Slide 4

Slide 4 text

社内資料検索ボット Sofia Sofia…Slack上で質問すると、Jira・Confluence・Github(←New!)の情報を元に 回答してくれるチャットボット Slack @Sofia <質問> 回答 + 参考URL 4

Slide 5

Slide 5 text

Github 社内資料検索ボット Sofia 社内情報にすぐ アクセスできる 5 Sofia…Slack上で質問すると、Jira・Confluence・Github(←New!)の情報を元に 回答してくれるチャットボット

Slide 6

Slide 6 text

社内資料検索ボット Sofia 概念図 Slack App Jira Confluence Cloud Run 6 Github 1. 質問 2. HTTPリクエスト 3. 資料検索 4. 回答生成 7. レスポンス 6. 返信

Slide 7

Slide 7 text

社内資料検索ボット Sofia 第2回までの実装 7 Sofia Jira Confluence Github 資料検索 回答生成

Slide 8

Slide 8 text

社内資料検索ボット Sofia 今回の実装 8 Sofia Jira Confluence Github 資料検索 回答生成 Slack App 質問 HTTPリクエスト レスポンス Flask 返信 Cloud Run リクエストを処理する アプリケーション Sofiaの実行環境

Slide 9

Slide 9 text

社内資料検索ボット Sofia 今回の実装 9 Sofia Slack App Flask Cloud Run アプリケーション構築をインフラパートとアプリパートに分けて説明する アプリパート インフラパート ※少ない

Slide 10

Slide 10 text

社内資料検索ボット Sofia 今回の実装 10 Sofia Slack App Flask Cloud Run Sofia リポジトリ Terraform用 リポジトリ アプリケーション構築をインフラパートとアプリパートに分けて説明する アプリパート (+開発環境) インフラパート (+ 開発環境)

Slide 11

Slide 11 text

Terraformとは 11 クラウド環境をコードベースで一括管理できるツール → クラウド環境をGithubで一括管理できるツール Terraformがないと... リソースのセットアップが面倒 ポチ...あっ (間違えた) ポチポチ... インフラの把握が面倒 あのPJはどのリソースを 使ってたっけ... クラウド増やしたら管理ツール も増えた…覚えきれない…

Slide 12

Slide 12 text

Terraformとは 12 クラウド環境をコードベースで一括管理できるツール → クラウド環境をGithubで一括管理できるツール Terraformがあると... コードベースで一括でセットアップ コードベースで一括管理 ...楽 テンプレ用意 でさらに便利 インフラ環境の全 貌を把握できる

Slide 13

Slide 13 text

アプリ構築工程 13 インフラ (開発環境) GCP/Terraform Cloud Run アプリ Slack App main.py (開発環境) デプロイ

Slide 14

Slide 14 text

アプリ構築 > インフラ > GCP/Terraform 1. GCPセットアップ(コンソール) • GCPプロジェクト作成 • 請求先アカウント紐付け 14

Slide 15

Slide 15 text

アプリ構築 > インフラ > GCP/Terraform 2. Terraformセットアップ • Github, GCSの環境構築・連携 • GithubActions実装 15 Cloud Run Terraform用 リポジトリ GCS コード管理 最新状態を 保存 Githubでコードを修正したら GCP側も自動で更新する

Slide 16

Slide 16 text

アプリ構築 > インフラ > GCP/Terraform Github, GCSの環境構築・連携(概要) 1. Githubリポジトリを作る $ gh repo create sofia 2. GCSバケットを作る $ gcloud auth login $ gcloud storage buckets create gs://sofia-terraform --project sofia--location asia-northeast1 16 3. 連携する (↓必要な設定ファイルをリポジトリに用意して...) $ terraform init $ terraform apply これでGithubからGCSを更新できるようになる

Slide 17

Slide 17 text

アプリ構築 > インフラ > GCP/Terraform (必要な設定ファイルとは...) 17 詳しくはこちら→ https://github.com/nakamasato/cloud-run-app-template 関連ファイル 詳しいセットアップ方法 はここに書かれている Cloud Runアプリ向けの Terraform用リポジトリ のテンプレート

Slide 18

Slide 18 text

アプリ構築 > インフラ > GCP/Terraform GithubActions実装(概要) 1. ワークフローを作る 18 (中身↓※一部) PR更新時に • terraform init • terraform apply などが自動で動く apply: 更新内容と 比較し差分を更新 Terraform リポ init: 保存して いる最新状態 を取得 Cloud Run GCS

Slide 19

Slide 19 text

アプリ構築 > インフラ > GCP/Terraform GithubActions実装(概要) 2. ワークフローがGCPにアクセスできるようにOIDC(認証プロセス)を用意 19 OIDC(OpenID Connect)ではない認証とはどういうものか 認証 「本物です。更新し たいです」 発行 Secret に保存 SAキーによる認証: 有効期限がなく漏洩すると危険・管理が手動で面倒 SAキー GithubActions GithubActionsのSA (サービスアカウント) GCPリソース サービスの実行権限 (IAM権限) 実行

Slide 20

Slide 20 text

アプリ構築 > インフラ > GCP/Terraform 20 OIDCトークン (証明書)発行 GithubActions GithubActionsのSA (サービスアカウント) GCPリソース OIDC: 有効期限の短いトークンを自動発行する認証方法 Workload Identity Pool Secrity Token Service Identity Provider 今回の外部Workloads: Github STSトークンで認証 権限借用 OIDCトークンを渡す 外部Workloadsの ID発行・登録 検証 STSトークン発行 実行 IAM権限

Slide 21

Slide 21 text

アプリ構築 > インフラ > GCP/Terraform 21 OIDCトークン (証明書)発行 GithubActions GithubActionsのSA (サービスアカウント) GCPリソース 外部エンジニアに、社内のリソースを使わせたいときのようなイメージ Workload Identity Pool Secrity Token Service Identity Provider 今回の外部Workloads: Github STSトークンで認証 権限借用 OIDCトークンを渡す 外部Workloadsの ID発行・登録 検証 STSトークン発行 実行 IAM権限 A社 B社 人事部 受付 総務部 ICカード エンジニア 高性能な機械 B社入館 許可証

Slide 22

Slide 22 text

アプリ構築 > インフラ > GCP/Terraform 22 GithubActions実装(概要) 2. ワークフローがGCPにアクセスできるようにOIDC(認証プロセス)を用意 → Terraformから用意できる Terraformで用意するもの • 使用するサービスのAPI有効化(IAM, STSなど) • サービスアカウント • サービスアカウントが使うGCPリソース実行用のRole • Workload Identity Pool + IdPとの連携 • Workload Identity Poolのサービスアカウント権限借用の設定 $ terraform init $ terraform apply これでPRでリソースを更新したときに、本番環境も自動的に更新するようになる

Slide 23

Slide 23 text

アプリ構築 > インフラ > GCP/Terraform GithubActionsの認証に関連する主な設定ファイル 23 テンプレ→ https://github.com/nakamasato/cloud-run-app-template • 使用するサービスのAPI有効化(IAM, STSなど) • サービスアカウント • サービスアカウントが使うGCPリソース実行用のRole • Workload Identity Pool + IdPとの連携 • Workload Identity Poolのサービスアカウント権限借用 の設定 テンプレートではモジュールを使っている ↓ 一から設定したい場合は Workload Identity GithubActions OIDC連携 などで検索

Slide 24

Slide 24 text

アプリ構築 > インフラ > GCP/Terraform 1. GCPセットアップ(コンソール) • GCPプロジェクト作成 • 請求先アカウント紐付け 2. Terraformセットアップ • Github, GCSの環境構築・連携 • GithubActions実装 24 →完了！

Slide 25

Slide 25 text

アプリ構築 > インフラ > Cloud Run 25 Cloud Run: • Sofiaの実行環境 • コンテナを実行するサービス • コンテナ: ソースコードや 実行環境をまとめてパッケージ化したもの • コンテナを作ることはできない→他のどこかに保存する Artifact Registry: • コンテナを置いておけるサービス • 実装: 基本的なもの • Google Cloud: https://cloud.google.com/artifact- registry/docs/repositories/terraform?hl=ja Sofia Artifact Registry Cloud Run

Slide 26

Slide 26 text

アプリ構築 > アプリ > Slack App @Sofia メッセージに反応し、Sofiaにリクエストを飛ばすAppを作成&install 26 Slack App Cloud Run • Scope • app_mentions:read • chat:write • reactions:write • search:read • Event • app_mention 以下のSecretを取得しておく • Signing Secret • Bot Oauth Token • User Oauth Token Appを作成した後 Scopeを 設定した後 Event URL(エンドポイント) はアプリ作成後に設定 Bot User

Slide 27

Slide 27 text

アプリ構築 > アプリ > main.py 27 発表① 発表③ 発表②

Slide 28

Slide 28 text

アプリ構築 > アプリ > main.py 28 1. FlaskとSlackのインスタンスを作る 2. Graphを用意する 第1回で作ったもの 第2回で作ったもの 別の機会に説明したい

Slide 29

Slide 29 text

アプリ構築 > アプリ > main.py 29 3. Graphの出力は辞書データなので、Slackのメッセージ向きに加工する try-except 回答メッセージの 表示調整

Slide 30

Slide 30 text

アプリ構築 >アプリ > main.py 30 4. Sofiaの処理プロセスを書く リクエスト認証 ルート設定 SlackのリクエストURL “Cloud Runのエンドポイント” + “/slack/events” リクエストのリトライを無視 Slack Eventはレスポンスが返ってく るまでリクエストを飛ばす リクエストURLを有効化した時に飛んでくるリクエストを無視

Slide 31

Slide 31 text

アプリ構築 >アプリ > main.py 31 5. Sofiaの処理プロセスを書く graph回答 生成&送信

Slide 32

Slide 32 text

アプリ構築 >アプリ > main.py 32 6. アプリを起動する これでSofiaが始めから終わりまで動くようになった

Slide 33

Slide 33 text

アプリ構築 > アプリ > デプロイ 33 完成したSofiaをArtifact Registry経由でCloud Runにデプロイしたい → GithubでSofiaを更新したら、Cloud RunにデプロイするGithubActionsを実装 する merge・PRによる 更新でトリガー 並列実行対策 古い実行中ワークフ ローはキャンセル 権限 デプロイとは 関係なし

Slide 34

Slide 34 text

アプリ構築 > アプリ > デプロイ 34 デプロイジョブの前に pytestを通している デプロイ用のpoetryセットアップ ※カスタムアクション コードを取得

Slide 35

Slide 35 text

アプリ構築 > アプリ > デプロイ 35 最新コミットの識別子(コ ミットハッシュ)で コンテナイメージの識別子 (タグ)を設定 カスタムアクションでデプロイ https://github.com/nakamasat o/github-actions Artifact Registryのリポジトリ名 このGithubActions用の サービスアカウント

Slide 36

Slide 36 text

アプリ構築 > アプリ > デプロイ 36 ワークフローがGCPにアクセスできるようにOIDC(認証プロセス)を用意 ※ Terraformリポジトリとアプリのリポジトリが別の場合、OIDCの設定も別に作 る必要がある リポジトリが別な らトークンも別 Sofia リポジトリ Sofia Flask Cloud Run

Slide 37

Slide 37 text

社内資料検索ボット Sofia 概念図 Slack App Jira Confluence Cloud Run 37 Github 1. 質問 2. HTTPリクエスト 3. 資料検索 4. 回答生成 7. レスポンス 6. 返信

Slide 38

Slide 38 text

アプリ構築 > インフラ > Cloud Runなど 38 Cloud Runの実装について • →のテンプレートなどが参考になる • Secretを環境変数に入れる Secretは、gcloudコマンドorコンソール経由で登録する $ echo -n "xxx" | gcloud secrets create sofia-openai-api-key -- replication-policy automatic --project $PROJECT --data-file=-

Slide 39

Slide 39 text

アプリ構築 > インフラ > Cloud Runなど 39 Secretの具体的な設定プロセス 1. TerraformでSecretリソースを作成 2. Secretの値を登録(gcloud・コンソール) 3. Cloud RunにSecretへのアクセス権を付与 4. Cloud Runの環境変数にSecretを設定 参考: Google Cloudの公式など https://cloud.google.com/run/docs/configuring/services/secrets?hl=ja#acc ess-secrets tfファイルに直接書くとGithub から誰でも見れてしまうから

Slide 40

Slide 40 text

ご清聴ありがとうございました