管理エージェント設定の使用 Git

リポジトリ Git を自身でホストする場合、自己署名証明書を使用できます。 エージェントがリポジトリに Git 安全に接続するには、自己署名証明書をJavaのトラストストアにインポートする必要があります。 詳細については、 自己署名証明書を参照してください。

リポジトリ Git へのアクセスは、パスワードまたはアクセストークンを .netrc 提供するファイルを使用して認証できます。 .netrc は広く使用されており、その詳細については、 .netrc マニュアル・ページを参照してください。

Instanaホストエージェントが実行されているユーザーのホームディレクトリ（例： root）にある .netrc ファイルを設定できます。 リポジトリ github.com については、以下のサンプル .netrc ファイルを参照してください：

machine github.com
login oauth2
password <access_token>

リポジトリ Git 内では、と同じディレクトリ構造を持つ *instanaAgentDir*/etc必要があります。 例えば、という Git 名前のファイルからデータを configuration-mysql.yaml取得したい場合、この Git ファイルはという名前のディレクトリ instana （つまりファイル instana/configuration-mysql.yaml）に配置する必要があります。 そうでない場合、リポジトリ Git からファイルを取得すると、サーバー上の誤った場所に配置され、Instanaホストエージェントによって使用されません。

次の図はリポジトリ Git の例示構造を示しています：

repository-root/
├── instana/
│   ├── configuration-mysql.yaml
│   └── com.instana.agent.main.config.UpdateManager.cfg
└── org.ops4j.pax.url.mvn.cfg

systemdを使用する場合、追加パラメータを指定する最も簡単な方法はドロップインファイルを使用することです。 ドロップインディレクトリのパスを表示するには、次のコマンドを実行します:

systemctl status instana-agent

このディレクトリ内のファイルは拡張子を持たなければなりません。さもなければ .conf、それらのファイルは無視されます。

1. ディレクトリ /etc/systemd/system/instana-agent.service.d/ 内に拡張子付きの新しいファイル .confを作成します。例えば git-configuration-environments.conf. などです。
2. 以下の内容をファイルに追加します。

   [Service]
   Environment=INSTANA_GIT_REMOTE_BRANCH=<branch>
   Environment=INSTANA_GIT_REMOTE_REPOSITORY=<repository_url>
   Environment=INSTANA_GIT_REMOTE_USERNAME=<username>
   Environment=INSTANA_GIT_REMOTE_PASSWORD=<access_token>
   ```   **Notes:**
    - Replace *<branch>* with the name of the remote branch that the Instana host agent connects to.
    - Replace *<repository_url>* with the URL of the remote Git repository; for example, `https://github.com/<your_account>/<your_repo>.git`.
    - Replace *<username>* with a username or access token (for basic authentication). If you are using a `.netrc` file or a public repository, you can remove the whole line `Environment=INSTANA_GIT_REMOTE_USERNAME=<username>`.
    - Replace *<access_token>* with an access token. If you are using an access token as username (basic authentication), a `.netrc` file, or a public repository, you can remove the whole line `Environment=INSTANA_GIT_REMOTE_PASSWORD=<access_token>`.
   
   

ドロップインファイルを追加または変更した後、次の手順を完了してください：

1. systemctl daemon-reload コマンドを実行して、ドロップインファイルを再読み込みします。
2. システムctl restart instana-agent コマンドを実行して、Instana ホストエージェントを再起動します。

以下の環境変数を設定している場合、ホストエージェントが起動されると、ローカルリポジトリが Git フォルダ *instanaAgentDir*/etc/ 内に存在するかどうかを確認します。 ローカルリポジトリ Git が存在しない場合、ホストエージェントはリモートリポジトリに接続されたローカルリポジトリを作成します。

Instanaエージェントがホスト上で直接実行されている場合、以下の環境変数をホスト上で設定する必要があります。 ホストエージェントがコンテナ化された環境で実行されている場合、コンテナレベルで変数を設定してください。

ドキュメント OneLiner 内の 、 -b、 -u -gおよび -p オプションを参照してください。これらは環境メソッドの、 INSTANA_GIT_REMOTE_BRANCH、 INSTANA_GIT_REMOTE_USERNAME INSTANA_GIT_REMOTE_REPOSITORYおよび INSTANA_GIT_REMOTE_PASSWORD 環境変数に対応します。

以下の表は、環境変数とワンライナーコマンドのパラメータ間の対応関係を示しています：

手順は基本的に環境メソッドと同様であり、コンテナに`ENV INSTANA_GIT_REMOTE_REPOSITORY`変数`ENV_PATH` INSTANA_GIT_REMOTE_USERNAMEINSTANA_GIT_REMOTE_BRANCH 、`ENV_TIME` Docker、 INSTANA_GIT_REMOTE_PASSWORD `ENV_TIME`、`ENV_TIME`を追加します。

たとえば、次のコードサンプルは、コンテナ内でホストエージェントを起動するために必要なパラメータと、ベースの構成管理 Git を有効にするために必要な Git パラメータを示しています:

# Please enter proper values for all --env arguments.
docker run \
   --detach \
   --name instana-agent \
   --volume /var/run:/var/run \
   --volume /run:/run \
   --volume /dev:/dev:ro \
   --volume /sys:/sys:ro \
   --volume /var/log:/var/log:ro \
   --privileged \
   --net=host \
   --pid=host \
   --env="INSTANA_AGENT_ENDPOINT=" \
   --env="INSTANA_AGENT_ENDPOINT_PORT=" \
   --env="INSTANA_AGENT_KEY=" \
   --env="INSTANA_DOWNLOAD_KEY=" \
   --env="INSTANA_AGENT_ZONE=" \
   --env="INSTANA_GIT_REMOTE_BRANCH=" \
   --env="INSTANA_GIT_REMOTE_PASSWORD=" \
   --env="INSTANA_GIT_REMOTE_REPOSITORY=" \
   --env="INSTANA_GIT_REMOTE_USERNAME=" \
   icr.io/instana/agent

-ベース Git の構成管理は、エージェント管理ダッシュボードの 「構成管理 」セクションで設定できます。

Gitベースの構成管理は、 Web REST API 資料の Host Agent セクションで説明されているように、API を使用して初期化および構成できます。

手動セットアップでは、 *instanaAgentDir*/etc/ フォルダー内の Git リポジトリーを初期化し、 configurationという名前の remote を追加します。

ホスト・エージェントは、 configuration リモートから構成済みのトラッキング・ブランチを使用して、ローカル main ブランチをプルします。 Git リポジトリーをセットアップする方法は複数あります。ユーザーはセットアップに適した方法を自由に選択できます。

例えば、以下のセットアップでは、ホスト・エージェントに configuration リモートの main ブランチから構成をプルさせることができます。

etc> git init
etc> git remote add -m main -t main configuration <git-repository-url>
etc> git fetch configuration
etc> git checkout -f -b main --track configuration/main

以下の例では、 configuration リモートの my-configurations ブランチから構成をプルできます。

etc> git init
etc> git remote add -m main -t my-configurations configuration <git-repository-url>
etc> git fetch configuration
etc> git checkout -f -b main --track configuration/my-configurations

可能な <git-repository-url> 形式については、 Git の URLの公式資料で説明されています。

Git フックは、リポジトリーの .git/hooks ディレクトリーに置くことができるプログラムであり、 Git リポジトリーのライフサイクルのさまざまな時点でトリガーされます。 Git には 多くの異なるフックが用意されています。 post-update フックは、ホスト・エージェントの Gitベースの構成管理との統合に最も適しています。

この GitOps-Demo リポジトリは、リポジトリ内のブランチが更新されるたびにホストエージェントの更新をトリガーするサンプル Gitpost-update フックを提供します。

プッシュをトリガーした後、スクリプトの予期される出力が Git クライアントに返送されることが分かります。

$ gitops-test# git push origin HEAD:main
[detached HEAD 9632c09] origin
 1 file changed, 1 insertion(+), 1 deletion(-)
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
Delta compression using up to 12 threads
Compressing objects: 100% (3/3), done.
Writing objects: 100% (4/4), 376 bytes | 376.00 KiB/s, done.
Total 4 (delta 1), reused 0 (delta 0)
remote: GitOps update: Triggering the configuration update of agents matching the following query: 'entity.zone:"test"' ... OK
   699ada9..9632c09  HEAD -> main

Instana GitHub のアクションを使用すると、InstanaのWeb APIを介して GitOps ホストエージェントのリモートを簡単にトリガーできます。

GitOps-デモ・リポジトリー は、ホスト・エージェント構成を管理するために GitHub 上にリポジトリーをセットアップする方法、および GitOps の Instana GitHub アクションを使用して更新を自動的にトリガーする方法を示しています。

GitHub は、トークンを使用した HTTPS 認証をサポートします。これは、このセクションで説明されているように、ホスト・エージェントで使用できます。

GitHub リポジトリーを使用するには、まず個人用アクセス・トークンを作成する必要があります。 その方法の詳細は、「個人用アクセス トークンの作成GitHub 」ドキュメント ページに記載されています。 このトークンでは、リポジトリーにアクセスするための読み取りアクセス権のみ必要です。

GitHub トークンが基本認証 HTTPS のユーザー名として提供され、パスワードは空であることを期待しています。 したがって、以下の環境変数を設定することで、GitHub リポジトリーに対して HTTPS 基本認証を使用するようにホスト・エージェントを構成できます。

INSTANA_GIT_REMOTE_REPOSITORY='https://github.com/<user/organization>/<repository>.git
INSTANA_GIT_REMOTE_BRANCH='<branch>'
INSTANA_GIT_REMOTE_USERNAME='<token>'
INSTANA_GIT_REMOTE_PASSWORD=''

空のパスワードとユーザー名としての個人トークンという同じ原則は、 Gitベースの構成管理用にホスト・エージェントを構成する他の手段でも機能することに注意してください。 可能な設定方法の概要については、 「セットアップ 」セクションを参照してください。

本番環境にデプロイされたホストエージェントのバージョン更新を制御するには、複数の方法を利用できます。 静的エージェントを使用する場合、必要に応じてホストエージェントを手動で更新する必要があります。 動的エージェントを使用する場合、更新間隔や固定バージョンなどの設定を構成できます。 詳細については、 「動的ホストエージェントの更新設定」 を参照してください。 設定が指定されていない場合、更新は毎日自動的に動的エージェントに適用されます。 さらに、ホストエージェントのバージョン更新をより厳密に制御する必要がある場合は、動的エージェントバージョン固定と Git ベース構成管理を組み合わせて使用できます。 テスト環境がある場合、本番環境と同様のシナリオでエージェントのデプロイメントをテストしてから、本番環境へ更新を適用できます。