Ansibleロール for Cloud Ops

このAnsibleロールは、Cloud Opsエージェントをインストールします。

ロールのインストール

• [推奨] 依存関係を管理するためにAnsible Galaxyを使用する場合は、このコマンドを使ってインストールします：

  ansible-galaxy install googlecloudplatform.google_cloud_ops_agents

• 依存関係を管理するためにGitHubのサブモジュールを使用する場合は、次のディレクトリを あなたのロールのパス（通常はプレイブックと同じロールディレクトリに）内に googlecloudplatform.google_cloud_ops_agentsという名前でインストールします：

  git clone <この-git-repo> roles/googlecloudplatform.google_cloud_ops_agents

詳細なチュートリアルもあります。

要件

Google Cloud APIへの権限。古いCompute Engineインスタンスやデフォルトの認証情報なしに作成されたCompute Engineインスタンスを使用している場合は、 次のステップを完了する必要があります：https://cloud.google.com/monitoring/agent/authorization#before_you_begin。

ロール変数

agent_typeは、どのエージェントが設定されるかを指定するために使用する必須の変数です。利用可能なオプションはmonitoring、logging、ops-agentです。

package_state変数は、エージェントの望ましい状態を指定するために使用できます。許可される値は、present（デフォルト）およびabsentです。

version変数は、インストールするエージェントのバージョンを指定するために使用できます。許可される値は、latest（デフォルト）、MAJOR_VERSION.*.*および MAJOR_VERSION.MINOR_VERSION.PATCH_VERSIONで、詳しくは以下に説明します。

version=latest この設定はエージェントのバージョンを最新の状態に保つのを容易にしますが、潜在的なリスクも伴います。新しいメジャーバージョンがリリースされると、ポリシーにより、新しいメジャーリリースからの最新バージョンのエージェントがインストールされ、壊れる変更が導入される可能性があります。本番環境では、より安全なエージェント展開のために、以下のversion=MAJOR_VERSION.*.*設定の使用を検討してください。

version=MAJOR_VERSION.*.* 新しいメジャーリリースが出た場合、この設定は指定されたメジャーバージョンからの最新のバージョンだけがインストールされることを保証し、偶然に壊れる変更を導入することを避けます。これは本番環境でのより安全なエージェント展開を保証するために推奨されます。

version=MAJOR_VERSION.MINOR_VERSION.PATCH_VERSIONこの設定は推奨されません。なぜなら、バグ修正やその他の改善を含む新しいバージョンのエージェントのアップグレードを防ぐからです。

main_config_file変数は、カスタム設定ファイルへの絶対パスまたは相対パスを提供するために使用できます。このファイルは、ターゲットVM上の設定ファイルを上書きします。

詳しくは、Monitoring Agentの設定、Logging Agentの設定、または Ops Agentの設定を参照してください。

デフォルトでは、エージェントはCPU、メモリ、ディスクなどのシステムリソースのみを監視し、ログを記録します。サードパーティのアプリケーションの監視とログ記録は、additional_config_dir変数を使ってプラグイン設定ファイルを含むディレクトリへのパスを提供することで設定できます。このディレクトリ内のすべての.confファイルは、ターゲットVMのエージェントのプラグインディレクトリにデプロイされます。メイン設定ファイルには、このディレクトリを含む行が必要です。この変数は、監視またはログエージェントの設定時にのみ指定できますのでご注意ください。

詳しくは、サードパーティアプリケーションの監視を参照してください。

サンプルプレイブック

# MonitoringとLoggingエージェントのインストール
- hosts: all
  become: true
  roles:
    - role: googlecloudplatform.google_cloud_ops_agents
      vars:
        agent_type: monitoring

    - role: googlecloudplatform.google_cloud_ops_agents
      vars:
        agent_type: logging

# カスタム設定でMonitoringとLoggingエージェントをインストール
- hosts: all
  become: true
  roles:
    - role: googlecloudplatform.google_cloud_ops_agents
      vars:
        agent_type: monitoring
        version: latest
        main_config_file: monitoring_agent.conf
        additional_config_dir: monitoring_agent_dir/

    - role: googlecloudplatform.google_cloud_ops_agents
      vars:
        agent_type: logging
        version: 1.*.*
        main_config_file: logging_agent.conf
        additional_config_dir: logging_agent_dir/

# Ops-Agentのインストール
- hosts: all
  become: true
  roles:
    - role: googlecloudplatform.google_cloud_ops_agents
      vars:
        agent_type: ops-agent

# カスタム設定でOps-Agentをインストール
- hosts: all
  become: true
  roles:
    - role: googlecloudplatform.google_cloud_ops_agents
      vars:
        agent_type: ops-agent
        version: 1.0.1
        main_config_file: ops_agent.yaml

互換性

下の表は、このAnsibleロールのバージョンと、それがサポートするエージェントバージョンの一覧です。

• Ops Agent リリース
• Logging Agent リリース
• Monitoring Agent リリース

バグ報告と機能リクエスト

公式サポートを受けるには、https://cloud.google.com/support-hubからケースを提出してください。これはSLOに従います。

ライセンス

Copyright 2020 Google Inc. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License.  You may obtain a copy of the
License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied.  See the License for the
specific language governing permissions and limitations under the License.