Steampunk Spotter オンプレミスのインストール
オンプレミスのインストール方法
まずは、インストーラーをダウンロードします。接続が切断された場合でもダウンロードが自動的に再開されるため、wgetコマンドを使用することをお勧めします。
※インストーラーのURLはご利用開始時にご案内します。
- wget -O spotter.run https://cdn.spotter.steampunk.si/public/<installer>.run
ホストを確認し、インストール対象のファイルシステムのパスを見つけてメモしてください。インストールプロセスで当該ディレクトリを指定する必要があります。
- df -h
インストーラーは、Spotterをどこにインストールするか質問をしますので十分な空き領域があるパスを確認してください。
インストーラーの転送が完了した後、ファイルを実行可能としてマークします。
- chmod u+x spotter.run
root ユーザーのログイン シェルに切り替えます。
- sudo su -
インストーラーは、rootユーザーで実行する必要があります。一部のディストリビューションでは、sudo ./spotter.runで十分ですが、エラーが発生する場合があります。最大限の互換性を確保するには、sudo su -を使用してrootユーザーのログインシェルに切り替えます。
インストーラーを実行します。--keep引数を使用して、自己解凍型実行ファイルをinstall/サブディレクトリに解凍するか、--target <dir>を使用して別のターゲットを選択できます。エラーが発生した場合でも解凍手順を実行せずにインストーラーを再実行できるようになります。
- ./spotter.run --keep
インストールにはしばらく時間がかかりますが、コンソールで進行状況を確認できます。また、エラーが発生した場合はログファイルが生成され、その詳細がデバッグ用にコンソールに出力されます。
インストールに成功すると、Instance adminユーザーを自動的に作成し、資格情報がコンソールに出力されます。忘れずにパスワードマネージャーなどに保存してください。
ライセンス管理
インストール後、ライセンスキーを登録する必要があります。ブラウザを開き、SpotterホストのIPアドレス（http://<machine-ip>/）にアクセスして、Instance adminの資格情報でログインします。
- [Admin] > [License]に移動します。サイドバーが折りたたまれている場合は展開してください。
- [Update License]ボタンをクリックします。
- [Upload License]をクリックしてシステムのファイルダイアログを開き、ライセンスファイルをアップロードします。または、空のテキストボックスをクリックして、ライセンスファイルの内容を貼り付けることもできます。[Save license]をクリックして設定を保存します。
ライセンスをアップロードすると、Spotterは整合性と信頼性を検証します。検証に成功すると、サブスクリプションに割り当てられた機能がロック解除されます。
ライセンスの検証で問題が発生した場合は、ライセンスファイルが改ざんされていないこと、指定されたオンプレミスサーバーに正しく配置されていることを確認してください。サポートが必要な場合は、エラーログとともにサポートにお問い合わせください。
CLIのセットアップ
pipコマンドでsteampunk-spotter CLIをインストールします。アプリケーション間の依存関係の競合を防ぐために、仮想環境（venv）を使用することをお勧めします。
- python3 -m venv .venv/
- source .venv/bin/activate
- pip install steampunk-spotter
CLIを使用するには、APIエンドポイントと認証情報を環境変数に設定する必要があります。認証にはAPIトークンを利用できます。ブラウザからSpotterにアクセスし、右上のアカウントメニューを開いて[My settings]をクリック、[API tokens]タブに切り替えて生成できます。
- export SPOTTER_ENDPOINT=http://<machine-ip>/api
- export SPOTTER_TOKEN=<generated-token>
ログインしてスキャンを開始できることを確認します。
- spotter login
- spotter scan <path-to-playbook>.yml
Related Articles
3. Spotter CLIのインストール
「steampunk-spotter」 は、Python パッケージとして提供されています。※インストールするには Python 3 以上が必要です。 $ pip install steampunk-spotter CLI を起動して実行したら、コマンドとオプションの引数を簡単に確認できます。以下ヘルプコマンドにて、必要な情報をすべて参照することが可能です。 $ spotter –help また全てのコマンドに「--help」または「-h」オプションを以下のように利用できます。 $ ...15. Spotter コマンド集
こちらの記事でSpotterコマンド全件を紹介します。 Spotter CLIで「--help」コマンドを実行することでも、いつでも確認することが可能です。 スキャン $ spotter scan playbook.yml デフォルトスキャンを実行します。 $ spotter scan path/to/playbook プレイブックをスキャンします。 $ spotter scan path/to/taskfile1.yaml タスクファイルをスキャンします。 $ spotter scan ...2. アカウント作成
Steampunk Spotter アカウントは体験版をお申し込みいただいた後ご案内いたします。 体験版について、弊社営業担当までお問い合わせください。16. インテグレーション
Spotter の機能を強化し、ワークフローを合理化し、開発プロジェクトを効率的に管理します。Spotter は作業環境とシームレスに統合されます。 GitLab と GitHub の統合により CI/CD パイプラインに組み込んだり、Spotter Visual Studio Code 拡張機能を使用してお気に入りのコード エディターで使用したり、 追加の機能を発見したりすることもできます。 GitHubアクション Steampunk Spotter GitHub Action ...7. 修正の自動適用
Spotter はあらゆるエラーを検出するだけでなく、特定のエラーを自動的に修正することもできます。 「--rewrite」引数を指定して Spotter スキャン コマンドを実行し、Spotter が Ansible コンテンツを自動的に変更することを確認します。 $ spotter scan --rewrite playbook.yml 通常のスキャン中に、Spotter は書き換え可能なチェックを強調表示します。 > spotter scan playbook.yml ...