YAML設定
YAML設定ファイルを使用して、Contrastエージェントの設定プロパティを指定できます。YAML設定ファイルの値は、環境変数またはコマンドラインの引数で上書きできます。
すべてのContrastエージェントで、YAML設定ファイルのプロパティは同じフォーマットを使用できますが、各エージェントに適用される固有のプロパティがあるため、各エージェントで固有の指定ファイルを使用する必要があります。
設定ファイルはcontrast_security.yamlという名前で、ロードパスに正しく置かれている必要があります。
Contrast Webインターフェイスからエージェントの設定ファイルをダウンロードすると、設定ファイルにはContrastサーバと通信するために最低限必要な基本のプロパティが入ります。独自の設定ファイルを作成する場合は、基本のキーを自分で追加してください。
最新バージョンのエージェントに最低限必要なcontrast_security.yamlの内容は、以下のようになります。
最新バージョンのエージェントに最低限必要なcontrast_security.yamlの内容は、以下のようになります。
api:
url: https://<environment>-agents.contrastsecurity.com/Contrast
user_name: contrast_user
api_key: demo
service_key: demoヒント
Contrastエージェント設定エディタを使用すると、 YAML設定ファイルの作成やアップロード、YAMLの検証、推奨される設定値の表示などができます。
YAMLはJSONのスーパーセットとなっているため、YAMLファイルでJSONを使用してContrastエージェントを設定することもできます。
以下より参照できるYAMLテンプレートを使用して、各エージェントのcontrast_security.yamlを作成できます。
注意
YAMLテンプレートでは空白が認識されます。スペースは使用できますがタブは使用できないため、編集時には注意が必要です。各プロパティの説明は、テンプレート内のコメントとして記載されています(スペースの後にシャープ記号「#」で続く行がコメントになります)。