Steampunk Spotter スタートマニュアル
15. Spotter コマンド集
こちらの記事でSpotterコマンド全件を紹介します。 Spotter CLIで「--help」コマンドを実行することでも、いつでも確認することが可能です。 スキャン $ spotter scan playbook.yml デフォルトスキャンを実行します。 $ spotter scan path/to/playbook プレイブックをスキャンします。 $ spotter scan path/to/taskfile1.yaml タスクファイルをスキャンします。 $ spotter scan ...
14. チーム管理と共同作業
Spotter を使用すると、他のユーザーと簡単に共同作業し、共有ワークスペースを構築し、自動化チェーン内のさまざまなタイプのユーザーとチームを近づけることができます。 自動化の実行方法とタイミングを理解していれば、達成したい結果を提供することに集中できます。 新しいメンバーの招待 組織にユーザーを追加するには、招待を送信するだけです。 [Members]タブに移動し、[Invite new member] をクリックして、ユーザーのメール アドレスを入力します。 [Organizations] ...
13. 分析とレポート
Spotter アプリは、スキャンを実行した場所に関係なく、スキャン履歴と分析を確認できるため、失敗したプレイブックの実行頻度を追跡し、一般的なエラーを特定し、傾向を見つけ、進行状況を監視できます。 問題の原因を探すのに何時間も費やす必要はありません。プレイブックの問題点に対処し、潜在的な解決策を見つけることがより迅速で簡単、明確になります。 ...
16. インテグレーション
Spotter の機能を強化し、ワークフローを合理化し、開発プロジェクトを効率的に管理します。Spotter は作業環境とシームレスに統合されます。 GitLab と GitHub の統合により CI/CD パイプラインに組み込んだり、Spotter Visual Studio Code 拡張機能を使用してお気に入りのコード エディターで使用したり、 追加の機能を発見したりすることもできます。 GitHubアクション Steampunk Spotter GitHub Action ...
12. Playbook作成支援
Spotter Assisted Writing 機能により、プレイブックの作成がさらにスピードアップします。 自動化の目標を定義するだけで、Spotter が適切なタスクや、可能な場合はプレイブック全体を提案します。 この機能は Spotter VSC 拡張機能でのみ使用できることに注意してください 。VSC 拡張機能の詳細については 、 「16.インテグレーション」を参照してください。 インライン提案を取得 ...
11. Playbookの安全な実行の確保
特に数百または数千のプレイブックを扱う場合、プレイブックの安全性を確保するにはどうすればよいでしょうか? Steampunk Spotter のような Ansible Playbook プラットフォームを使用すると、プレイブックを完全に制御できるため、セキュリティの確保は簡単です。 1. プレイブックの詳細な分析を実施 Spotter は、ベスト プラクティスから徹底的なセキュリティ チェックまで、プレイブックの詳細な分析を実行します。また、潜在的な構成ミスやセキュリティ ...
10. Playbookのアップグレード
Spotter は、プレイブックが最新の Ansible バージョンと互換性があるかどうかをチェックし、プレイブックが破損しないようにするためのアドバイスを提供し、 書き換え機能やその他の機能を使用してアップグレード自体を高速化します。 > > spotter scan playbook.yml playbook.yml:8:3: ERROR: [E903] Use a fully-qualified name, such as ansibbuiltin.pip instead of ...
9. サプライチェーンの管理
自動化プレイブックで使用される Ansible コンテンツを厳密に管理します。 Ansible Runtimeや Ansible Collection バージョンなどの自動化依存関係が、セキュリティおよびコンプライアンス ポリシーに準拠していることを確認します。 Spotter を使用すると、セキュリティ チームは安全なバージョンを承認し、脆弱なソフトウェアや未承認のソフトウェアをブロックできます。 一方、プレイブック作成者は、Python の専門知識を必要とせずに自動化ロジックに集中できます。 ...
8. カスタムルールとポリシーの作成
カスタムルールやポリシーの作成により、以下のような事項が実現できます。 セキュリティの強化 コンプライアンスの確保 Spotter を独自の要件に合わせてカスタマイズ プレイブックの標準の確立 モジュールとコレクションの定義 命名規則の適用 特定のモジュールで必要な値の制限 カスタムルールの記述 Spotter は Open Policy Agent (OPA) を使用してカスタム ルールを定義します。 これらのルールは、Rego 言語を使用して人間が読める形式で記述されます。 ...
7. 修正の自動適用
Spotter はあらゆるエラーを検出するだけでなく、特定のエラーを自動的に修正することもできます。 「--rewrite」引数を指定して Spotter スキャン コマンドを実行し、Spotter が Ansible コンテンツを自動的に変更することを確認します。 $ spotter scan --rewrite playbook.yml 通常のスキャン中に、Spotter は書き換え可能なチェックを強調表示します。 > spotter scan playbook.yml ...
6. チェックのスキップと強制
Spotter を使用すると、組織全体でコンプライアンスと品質を達成できるよう、すべての自動化ワークフローでどの Ansibleをスキップし、どのチェックを常に適用するかを一元的に制御できます。つまり、単一の設定ポイントからすべてのユーザーにルールを適用したり、冗長と思われる一部のルールをスキップしたりすることができます。 たとえば、Spotterが潜在的なリスクを検出し、それを評価して受け入れた場合、今後はそれをスキップするように決定できます。 チェックをスキップまたは強制する場合、以下の 3 ...
5. スキャンプロファイルの設定
スキャンを実行する際、特定の目標をターゲットにします。 たとえば、あるプロジェクトでは Ansible 環境を新しいバージョンにアップグレードすることに焦点を当て、別のプロジェクトでは現在のバージョンのプレイブックを強化することを目指す場合があります。 つまり、Steampunk Spotter によって提供される特定のチェック結果は、あるプロジェクトには関連していても、他のプロジェクトには関連していない可能性があります。 Spotter は、「--profile」引数 (選択されたチェック ...
4. スキャン
目次 4-1. Ansibleコンテンツのスキャン 4-2. スキャン結果の分析 4-3. パブリック Git リポジトリの品質の確認 4-4. 対象プロジェクトの選択 4-5. スキャンの設定 4-6. Spotterと共有するデータ量の決定 4-7. 出力のカスタマイズ 4-1. Ansibleコンテンツのスキャン Ansible コンテンツをスキャンしたい場合は、Spotter CLI で実行できます。 コマンドを実行して、あとはスキャン結果を取得するだけです。 $ spotter ...
3. Spotter CLIのインストール
「steampunk-spotter」 は、Python パッケージとして提供されています。※インストールするには Python 3 以上が必要です。 $ pip install steampunk-spotter CLI を起動して実行したら、コマンドとオプションの引数を簡単に確認できます。以下ヘルプコマンドにて、必要な情報をすべて参照することが可能です。 $ spotter –help また全てのコマンドに「--help」または「-h」オプションを以下のように利用できます。 $ ...
2. アカウント作成
Steampunk Spotter アカウントは体験版をお申し込みいただいた後ご案内いたします。 体験版について、弊社営業担当までお問い合わせください。
1. 概要（本マニュアルについて）
本ガイドでは、本製品の利用開始に際して必要な手順をご案内します。 Steampunk Spotter は、Ansible コンテンツを徹底的に分析して改善することで、見つけにくく時間のかかるエラーを特定し、 プレイブックの品質、信頼性、セキュリティを強化し、開発とテストの時間を短縮し、自動化のベスト プラクティスに準拠するのに役立つ製品です。 この強力なプラットフォームは、ユーザー フレンドリな CLI とSpotter アプリで構成されており、自動化に関する洞察を提供します。 ...