メインコンテンツまでスキップ

Takumi Guard の一括セットアップが設定ファイルの直接編集に対応

· 約5分
Yoshiaki Matsutomo
Software Engineer @ GMO Flatt Security Inc.

Takumi Guard の管理ツールによる一括セットアップに、設定ファイルを直接編集するモードを追加しました。パッケージマネージャーの CLI に依存せずにセットアップを実行できるほか、未導入のパッケージマネージャーに対しても事前に Guard の設定ができます。

概要

管理ツールによる一括セットアップ」では、既定で Guard の設定対象となるパッケージマネージャーを検出し、設定対象が存在する場合にのみ Guard の設定を行います。これは、保護対象となるパッケージマネージャーを利用していない端末に対する不要な設定やトークン発行を防ぐためです。

今回追加した直接編集モードでは、この事前検証を行わず、パッケージマネージャーの CLI(npm config setpoetry configgo env -w など)を実行する代わりに設定ファイルを直接編集して Guard の設定を反映します。

これにより、パッケージマネージャーがまだインストールされていない端末に対しても事前に Guard の設定ができるため、後からツールを導入した場合でも初回利用時から Guard を経由するようになります。

詳しい利用方法や注意事項については、管理ツールによる一括セットアップガイドの「事前検証をせずに設定する」を参照してください。

トークン発行に関する注意

このモードでは、設定対象が存在しない端末に対しても組織ユーザートークンが発行されます。利用状況によってはコストに影響するため、状況に応じて既定の動作と使い分けてください。

利用方法

新しいセットアップスクリプト v0.8.0 は以下から取得できます。

直接編集モードを有効にするには、スクリプト実行時に TG_DIRECT_WRITE 環境変数を設定してください。組織ユーザートークンの発行と Guard の設定をまとめて行う場合でも、発行済みの組織ユーザートークンを使用する install サブコマンドを利用する場合でも指定できます。

# 組織ユーザートークンの発行と Guard の設定をまとめて行う場合
TG_DIRECT_WRITE=true TG_BOT_API_KEY="..." ./setup.sh <BOT_ID> <USER_IDENTIFIER>

# 発行済みの組織ユーザートークンを使用して Guard の設定のみを行う場合
TG_DIRECT_WRITE=true ./setup.sh install <TOKEN>
すでに一括セットアップで導入済みの場合

サンプルとして提供しているラッパースクリプトが更新されている可能性があります。必要に応じて、セットアップスクリプトとラッパースクリプトの両方を最新版へ更新してください。

有料機能

この機能を利用するには、Guard を有効化した Takumi サブスクリプションが必要です。詳しくは料金と請求を参照してください。

組織向け機能を利用する

Takumi Guard の組織向け機能(一括セットアップ、インストールログの検索など)を利用するには、Takumi サブスクリプションの契約と Guard の有効化が必要です。

  1. https://cloud.shisho.dev/hello/takumi にアクセスし、サインインしてください
  2. 組織を登録し、Takumi サブスクリプションを契約してください
  3. 画面左のサイドバーから Guard > 設定 にアクセスしてください
  4. 「有効化する」ボタンをクリックして Guard を有効化してください

Guard 設定画面

有効化が完了したら、管理ツールによる一括セットアップガイドに従ってセットアップを進めてください。