第1章 Hammer の概要
Hammer は、Red Hat Satellite 6 で提供される強力なコマンドラインツールです。Hammer を使用して、CLI コマンドまたはシェルスクリプトの自動化により Red Hat Satellite Server を設定/管理することができます。Hammer は対話式のシェルも提供します。
Hammer と Satellite Web UI の比較
Web UI を使用した移動と比較すると、Hammer を使用する場合には環境変数やエイリアスなどのシェル機能が自由に使えるので Satellite Server との対話がはるかに早くなります。また、Hammer のコマンドを再利用可能なスクリプトに組み込み、あらゆるレベルの複雑性を持つタスクを自動化することもできます。Hammer コマンドからの出力を他のツールにリダイレクトして、既存の環境と統合することができます。Hammer コマンドは、Red Hat Satellite を実行するベースのオペレーティングシステムに直接発行することができます。
Hammer コマンドを発行するには、Satellite Server のベースのオペレーティングシステムにアクセスする必要があるので、Web UI と比較すると、潜在的なユーザー数が限定されてしまいます。Hammer と Web UI の違いはほぼありませんが、Web UI の開発の優先度は高く、特に新しく導入される機能についてはこちら優勢となっています。
Hammer と Satellite API の比較
多くのタスクで、Hammer も Satellite API も同等に利用可能です。Hammer は、スクリプトに適用する前に API の呼び出しの応答をテストするなど、Satellite API よりも使いやすいインターフェースとして利用できます (hammer -d organization list など、Hammer で発行した API の呼び出しを検査するには -d オプションを使用します)。API での変更は自動的に Hammer に適用されますが、API を直接使用するスクリプトは手動で更新する必要があります。
バックグラウンドで、各 Hammer コマンドは最初に API へのバインドを確立し、要求を送信します。大量の Hammer コマンドを順番に実行する場合には、パフォーマンスに影響が出る可能性があります。反対に、API で直接通信するスクリプトではバインドを確立するのは 1 度だけです。詳しい情報は、『Red Hat Satellite API ガイド』を参照してください。
1.1. ヘルプ
hammer オプションおよびサブコマンドの完全な一覧を表示するには以下を実行します。
$ hammer --help
以下のように --help を使用してサブコマンドを確認します。
$ hammer organization --help
以下のように grep を使用して help の出力を検索するか、テキストビューワーにリダイレクトすることができます。
$ hammer | less
1.2. 認証
デフォルトでは hammer は、コマンドをハックするたびに、Satellite の認証情報を求めます。以下のようにコマンド実行時に認証情報を指定できます。
$ hammer -u <username> -p <password> <subcommands>
または、以下の手順に従い、保存した認証情報を使用してください。
~/.hammer/cli_config.ymlファイルを作成して、このファイルに以下の内容を追加します。:foreman: :host: 'https://satellite.example.com/' :username: 'username' :password: 'password'
例の値は、自分の情報に置き換えます。ファイルではタブを使用せずに常にスペースでインデントを入れるようにしてください。
現在のユーザーのみがファイルを読み取りできるようにして、パスワードを保護します。
$ chmod 600 ~/.hammer/cli_config.yml
ファイルを保存して閉じます。以降、Hammer を起動すると
~/.hammer/cli_config.ymlファイルの認証情報が使用されます。重要Hammer の設定ファイルではインデントにスペースのみを使用するようにしてください。Hammer 設定ファイルのインデントに、タブは使用しないでください。
本ガイドの例では、認証情報が保存されていることを前提としています。
1.3. Hammer のスタンドアロンでの使用
Satellite がインストールされていないサーバーで個別に hammer をインストールして、そのサーバーをリモートの Satellite と接続して使用することができます。
このパッケージのインストールには、rhel-X-server-satellite-6.X-rpms リポジトリーが必要です。接続にワークステーションを使用するには、リポジトリーを手動でインストールする必要があります。詳細は『Red Hat Satellite インストールガイド』を参照してください。
hammer をインストールします。
# yum install tfm-rubygem-hammer_cli_katello
-
希望の Satellite を参照するように
/etc/hammer/cli.modules.d/foreman.ymlを編集します。
1.4. デフォルトの組織の設定
多くの hammer コマンドは組織固有のものです。--organization-id パラメーターを毎回指定しなくても良いように、Hammer コマンドにデフォルトの組織や、場所を設定することができます。これには以下を実行します。
$ hammer defaults add --param-name organization_id --param-value <org_ID>
hammer organization list コマンドの出力で <org_ID> を検索します。同様に、以下のようにデフォルトの場所を設定することができます。
$ hammer defaults add --param-name location_id --param-value <loc_ID>現在指定しているデフォルトの設定を表示するには、以下のコマンドを実行します。
$ hammer defaults list
単一の組織を管理することが多い場合には、コマンドを省略できるのでデフォルトの組織を指定すると便利です。ただし、別の組織に切り替える場合には、コマンドラインオプションを使用して指定する必要があります。本ガイドの例は、デフォルトの組織を指定していないことを前提としており、注記のようにシェル変数のアプローチを使用します。
1.5. Hammer の設定
デフォルトでは、グローバルの hammer 設定は以下の場所に配置されています。
-
一般的な
hammerの設定は /etc/hammer/cli_config.yml - CLI モジュールの設定ファイルは /etc/hammer/cli.modules.d/
hammer (~/.hammer/cli_config.yml) または CLI モジュール (~/.hammer/cli.modules.d/ の適切な .yml ファイル) に対してユーザー固有のディレクティブを設定できます。
設定ファイルの読み込み順および読み込んだモジュールのバージョンを表示するには、以下を実行します。
$ hammer -d --version
多くの CLI モジュールの設定を読み込むと、hammer コマンドの実行の速度が遅くなる可能性があります。このような場合に、定期的に使用しない CLI モジュールを無効化することを検討してください。
「認証」に記載されているような認証情報を保存する以外に、~/.hammer/ 設定ディレクトリーに他の複数のオプションを設定できます。たとえば、~/.hammer/cli_config.yml でデフォルトのログレベルを変更して、以下のディレクティブを使用してログの回転を設定することができます。これらのディレクティブは、現在のユーザーのみに影響を与え、グローバルには適用されない点に注意してください。
:log_level: 'warning' :log_size: 5 #in MB
同様に hammer の出力で一度に表示される行数を設定することができます (--per-page オプションと同等)。
:per-page: 30
1.6. Hammer ロギングの設定
hammer を設定して、さまざまな Satellite コンポーネントのデバッグ情報をロギングすることができます。
全 Satellite コンポーネントに対してデバッグまたは通常の設定オプションを設定できます。
全コンポーネントのデバッグレベルを設定するには、以下のコマンドを使用します。
# hammer admin logging --all --level-debug
実稼動レベルのロギングを設定するには、以下のコマンドを使用します。
# hammer admin logging --all --level-production
ロギングが設定可能なコンポーネントで現在認識されているものを表示するには、以下を実行します。
# hammer admin logging --list
このツールで利用可能なオプションをすべて表示するには、以下を実行します。
# hammer admin logging --help Usage: hammer admin logging [OPTIONS]
1.7. Hammer シェルの呼び出し
対話型シェルで hammer コマンドを発行することができます。このシェルを呼び出すには、以下のコマンドを発行します。
$ hammer shell
このシェルで、「hammer」と入力せずに直接サブコマンドを入力できるので、スクリプトで使用する前にコマンドをテストする際に便利です。このシェルを終了するには、exit と入力するか、[Ctrl + D] を押してください。
1.8. フォーマット済みの出力の生成
hammer コマンドのデフォルトの出力形式を変更して、他のコマンドラインツールやアプリケーションでの出力の処理を簡素化することができます。たとえば、CSV 形式で、カスタムの区切り文字を利用して (今回はセミコロン) 組織を表示するには、以下のコマンドを実行します。
$ hammer --csv --csv-separator ";" organization list
CSV 形式での出力は、ID を解析したり for ループで使用したりする必要がある場合に便利です (例2.6「ACME 組織の全リポジトリーの同期」または例2.8「複数製品への同期プランの割り当て」を参照してください)。
--output オプションには、他に複数のフォーマットオプションがあります。
$ hammer --output <output_format> organization list<output_format> は以下のいずれかに置き換えます。
-
table: 人間が判読できる表 (デフォルト) 形式で出力を生成します。 -
base: キーと値のペアの形式で出力を生成します。 -
yaml: YAML 形式で出力を生成します。 -
csv: コンマ区切りの値形式で出力を生成します。カスタムの区切り文字を定義するには、代わりに--csvおよび--csv-separatorオプションを使用してください。 -
json: JavaScript Object Notation (JSON) 形式の出力を生成します。 -
silent: 出力を表示しません。
1.9. Hammer でのトラブルシューティング
hammer ping コマンドを使用して、コアの Satellite サービスのステータスを確認することができます。katello-service status コマンドと併用すると、Satellite の問題の診断、トラブルシューティングに役立ちます。すべてのサービスが予想どおりに実行されている場合には、出力は以下のようになります。
$ hammer ping
candlepin:
Status: ok
Server Response: Duration: 22ms
candlepin_auth:
Status: ok
Server Response: Duration: 17ms
pulp:
Status: ok
Server Response: Duration: 41ms
pulp_auth:
Status: ok
Server Response: Duration: 23ms
foreman_tasks:
Status: ok
Server Response: Duration: 33ms
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.