Template Scanner

• Template Scannerとは何ですか?
• サポートされているクラウドプロバイダ
• サポートされている機能
• UI経由でスキャン
  • CloudFormationテンプレートのスキャン
  • AWS Cloud Development Kit (CDK) のスキャン
  • Serverless Frameworkをスキャン中
  • Terraformのスキャン
• API経由でスキャン
• サポートされているRule
• GitHubプルリクエストによるスキャン
• スキャン結果が表示されないのはなぜですか?

Template Scannerとは何ですか?

サポートされているクラウドプロバイダ

1. AWS
2. Azure
3. GCP

サポートされている機能

• アプリケーションUIを使用してテンプレートをアップロードする
• テンプレートを使用してリクエストを投稿するためのAPIの使用
• Template Scanner GitHub Appをインストールし、プルリクエストを作成することによって。

機能	Template Scanner UI/API	GitHubアプリケーション
ファイルを読み込むためのグラフィカルインターフェース
パブリックAPI
アカウントとProfileのRule settings
GitHub統合
AWS CloudFormation
AWS クラウド開発キット (CDK)
Serverless Framework (AWS)
Terraform (AWS、Azure、GCP)	Terraform Planファイル (.json) およびHCLテンプレート (.tf) をサポート	複数のTerraform言語機能を解釈できます: 入力変数、ローカル値、参照式、jsonencode関数呼び出し。 Terraformでは子モジュールもサポートされています。

UI経由でスキャン

1. スキャンするルール設定の種類を選択してください:
   • [Default rule settings]: 組織のRule settingsを使用してアップロードおよびスキャンします。
   • [Profile rule settings]: 選択したProfileのRule settingsを使用してアップロードおよびスキャンします。
   • [Account rule settings]: 選択したアカウントのRule settingsを使用してアップロードおよびスキャンします。

CloudFormationテンプレートをスキャンしています

• CloudFormation テンプレートは、JSON または YAML 形式でアップロードできます。
• YAMLテンプレートで!条件も使用できます。

AWS Cloud Development Kit (CDK) をスキャンしています

1. AWS CDK CLIをインストールする
2. CDKコードがあるディレクトリでcdk synthを実行します。これにより、YAML CloudFormationファイルが出力されます (必要に応じて--jsonを使用することもできます)。
3. Template Scanner UIまたはAPIエンドポイントを使用して、cdk synthによって生成されたCloudFormationファイルをスキャンします。

Serverless Frameworkをスキャン中

1. serverlessファイルがあるディレクトリで、serverless packageを実行して .serverless/cloudformation-template-update-stack.jsonにJSONファイルをGenerateします。
2. Template Scanner UIまたはAPIエンドポイントを使用して、serverless packageによって生成されたCloudFormationファイルをスキャンします。

Terraformプランのスキャン

1. Terraformテンプレートは、以下の手順に従ってコマンドラインツールからJSON形式のTerraformプランに変換する必要があります:
   1. 同じディレクトリにある.tfテンプレートで、プロバイダの[access key]、[secret key,]、[export region]をエクスポートします (例: `export AWS_REGION=us-east-1`)
   2. コマンドterraform initを実行してください
   3. コマンドterraform plan -out=your_fileを実行します
   4. コマンドterraform show -json your_file > your_file.jsonを実行します。Terraform JSONプランは、.tfファイルと同じフォルダからTemplate Scannerにアップロードする準備ができました。
2. [Upload and scan]をクリックして、選択したRule settingsのスキャン結果を表示します。
3. テンプレートをスキャン中にパラメータが不足しているというメッセージが表示されます。スキャンプロセスを[Proceed]するか[キャンセル]するかを決定してください。

   注意 パラメータが欠落しているリソースはスキャンされず、その結果、部分的なスキャン結果となります。

4. 検索結果からチェックを確認します。失敗したチェックには、解決手順へのリンクがある解決ボタンが表示されます。ルールの構造についての詳細は、Rulesを参照してください。

   注意 失敗したチェックに対して提供される解決手順は、CLIまたはコンソール経由のワークフロー用です。これらの手順をCloudFormation内での解決のガイドとして使用することもできます。

Terraform HCLテンプレートをスキャンしています

1. あなたの.tfファイルを含むZIPファイルを作成してください
2. Template Scannerメニューをクリックしてください
3. Terraformタブをクリックしてください
4. ZIPファイルを参照
5. アップロードして検索をクリックします。

API経由でスキャン

• AWS CloudFormationの例
• AWS Cloud Development Kit (CDK) の例
• Serverless Framework (AWS) 例
• Terraformプラン
• Terraform HCL

GitHubプルリクエストを介してスキャン

サポートされているルール

• CloudFormationテンプレート

• Terraform

なぜスキャン結果が表示されないのですか?

1. サポートされていないリソースタイプまたはルール - Template Scannerはリソースレベルのルールのみをサポートしています。サポートされているルールとリソースタイプの一覧についてはAPIを参照してください。今後、より多くのソースタイプのサポートを追加する予定です。優先的に必要な特定のリソースタイプがある場合は、Conformityにログインしてサポートチームにチケットを提出してください。
2. デフォルト値のないパラメーター - デフォルト値のないパラメーターを持つCloudFormationテンプレートは処理に失敗する可能性があります。
3. サポートされていないAWS CloudFormationの組み込み関数 - サポートされていない組み込み関数を含むCloudFormationテンプレートは処理されないか、完全な結果を生成しない可能性があります。以下はCloudFormationテンプレートの[supported]組み込み関数です:
   • Fn::Base64
   • Fn::And
   • Fn::Equals
   • Fn::If
   • Fn::Not
   • Fn::Or
   • Fn::FindInMap
   • Fn::GetAtt
   • Fn::GetAZs
   • Fn::Join
   • Fn::Select
   • Fn::Split
   • Fn::Sub
   • 参照