Puppet Enterpriseクライアントツールパッケージのインストール

Included in Puppet Enterprise 2017.2.

Puppet Enterpriseクライアントツールは、Puppet Enterpriseサービスにワークステーションからアクセスするためのコマンドラインツールのセットです。対象となるワークステーションには、Puppet Enterpriseで管理されているものと管理されていないものが含まれます。 これらのツールは安全にリモート実行できるので、コマンドを実行するためにPuppet masterにSSHでログインする必要がなくなります。 情報を表示して操作を実行するためのパーミッションは、Puppet Enterpriseのロールベースのアクセス制御(RBAC)で制御されます。 ユーザのアクティビティは、rootユーザやpe-puppetユーザではなく、それぞれのユーザ名でロギングされます。

このパッケージには以下のサービスに対応するクライアントが含まれます。

  • Puppetオーケストレータ: このツールを使用すると、インフラ内での変更の伝搬を制御することができます。また、Puppetアプリケーションオーケストレーションサービスのインターフェースとして使用できます。このツールには、puppet-jobpuppet-appが含まれます。
  • Puppetアクセス: このツールを使用すると、Puppet EnterpriseのRBACトークンベース認証サービスで認証を実行して、その他の機能やAPIを使用することができます。
  • コードマネージャ: このツールは、コードマネージャサービスとファイル同期サービスのインターフェースとして使用でき、puppet-codeを含みます。
  • PuppetDB CLI: このツールを使用すると、クエリの構築やエクスポートの処理など、PuppetDBの操作を実行できます。

対応するオペレーティングシステム

Puppet Enterpriseクライアントツールパッケージは、以下のプラットフォームにインストールできます。

オペレーティングシステム バージョン アーキテクチャ
Red Hat Enterprise Linux 6、7 x86_64
CentOS 6、7 x86_64
Oracle Linux 6、7 x86_64
Scientific Linux 6、7 x86_64
SUSE Linux Enterprise Server 11、12 x86_64
Ubuntu 14.04、16.04 x86_64
Microsoft Windows (コンシューマOS) 7、8.1、10 x86_64
Microsoft Windows (サーバーOS) 2012, 2012R2, 2012R2コア x86_64
Mac OS X 10.10、10.11 x86_64

クライアントツールのバージョンとPuppet Enterpriseバージョンの対応

Puppet Enterpriseクライアントツールのバージョンは、Puppet Enterpriseバージョンのリリース年とリリース整理番号(「x.y」)と同じものを使用してください。 たとえば、Puppet Enterprise 2017.2.1を実行している場合、2017.2.1のクライアントツールを使用します。

Puppet Enterpriseまたはクライアントツールに対して、パッチリリース(「x.y.z」)が発行される場合がありますが、 このパッチ番号をPuppet Enterpriseとクライアントツール間で揃える必要はありません。 「x.y」の番号は一致させる必要があります。

Puppet Enterpriseを新しい「x.y」バージョンにアップグレードしたら、該当する「x.y」バージョンのPuppet Enterpriseクライアントツールをインストールする必要があります。

Puppet masterへのインストール(デフォルト)

Puppet Enterpriseのインストール用tarballには、pe-client-toolsパッケージが含まれています。 Puppet Enterpriseをインストールすると、Puppet masterと同じノード上に、クライアントツールが自動でインストールされます。

Puppet Enterpriseで管理されたワークステーションへのインストール

注: Puppet agentノードにpe-client-toolsパッケージをインストールする場合、このノードがPuppet masterと同じOSを実行していることが必須になります。

  1. Puppet agentのインストールマニュアル(*nix用Windows用OS X用)に従って、コントローラマシンとして使用するPuppet agentをインストールします。
  2. Puppet Enterprise Webコンソールで、コントローラ分類グループを作成して名前(例: PE Controller)を付け、[親名]にAll Nodesを設定します。
  3. PE Controllerグループを選択し、puppet_enterprise::profile::controllerクラスを追加します。

    Puppet Enterpriseは、puppet_enterprise::profile::controllerクラスを使用してクライアントツールのグローバル設定ファイルを管理します。

  4. PE Controllerグループにコントローラマシンを追加します。

    a. [ルール]タブで、ピン留めされたノードのセクションまで下にスクロールします。

    b. [Certname]フィールドにノードのcertnameを入力します。

    c. [ノードをピンして追加します]をクリックし、[変更を保存]ボタンをクリックします。

  5. コントローラマシン上でPuppetを実行します。
  6. クライアントツールの設定が必要な場合、グローバル設定ファイルの管理を参照してください。

Puppet Enterpriseで管理されていないワークステーションへのインストール

注: サポート対象のOSを実行していれば、どのワークステーションでもpe-client-toolsパッケージをインストールできます。 Puppet masterと同じOSを実行している必要はありません。

インストールを開始する前に、時間管理、名前解決、ファイアウォール設定について、システム設定要件を確認してください。

重要: ワークステーション上で以下のポートを使用できることを確認します。

ポート8143:オーケストレータクライアントは、このポートを使用して、Puppet master上で実行されているオーケストレーションサービスと通信します。

ポート4433: Puppetアクセスクライアントは、このポートを使用して、Puppet master上で実行されているRBACサービスと通信します。

ポート8170:Code Managerサービスを使用する場合は、このポートが必要です。

Linuxワークステーションへのインストール

Linuxワークステーションの準備

  1. ワークステーションで/etc/puppetlabs/puppet/ssl/certsディレクトリを作成します。

    たとえば、mkdir /etc/puppetlabs/puppet/ssl/certsを実行します。

  2. Puppet masterで/etc/puppetlabs/puppet/ssl/certs/に移動し、前のステップで作成したワークステーション上のディレクトリにca.pemをコピーします。
  3. ワークステーションでchmod 444 /etc/puppetlabs/puppet/ssl/certs/ca.pemを実行して、ファイルパーミッションが正しいことを確認します。
  4. ワークステーション上にあるca.pemのチェックサムが、Puppet master上にある同ファイルのチェックサムと一致することを確認します。

パッケージ管理を用いたインストール

  1. 適切なサポート対象OS用のpe-client-toolsパッケージをワークステーションにダウンロードします。
  2. tarballを展開し、packages/<PLATFORM>ディレクトリに移動します。
  3. ワークステーションのパッケージ管理ツールを使用して、pe-client-toolsをインストールします (パッケージインストールツールは、プラットフォームによって異なります )。

    たとえば、RHELプラットフォームでは以下のコマンドを実行します。

    rpm -Uvh pe-client-tools-<VERSION-and-PLATFORM>.rpm
    

Windowsワークステーションへのインストール

Windowsワークステーションでは、セットアップウィザードまたはコマンドラインを使用して、Puppet Enterpriseクライアントツールをインストールできます。

Windowsワークステーションの準備

  1. ワークステーションでC:\ProgramData\PuppetLabs\puppet\etc\ssl\certsディレクトリを作成します。

    たとえば、mkdir C:\ProgramData\PuppetLabs\puppet\etc\ssl\certsを実行します。

  2. Puppet masterで/etc/puppetlabs/puppet/ssl/certs/に移動し、前のステップで作成したワークステーション上のディレクトリにca.pemをコピーします。
  3. ワークステーションでC:\ProgramData\PuppetLabs\puppet\etc\ssl\certs\ca.pemのファイルパーミッションが読み取り専用に設定されていることを確認します。
  4. ワークステーション上にあるca.pemのチェックサムが、Puppet master上にある同ファイルのチェックサムと一致することを確認します。

セットアップウィザードを用いたインストール

  1. Windows pe-client-toolsパッケージをダウンロードします。
  2. pe-client-tools .msiファイルをダブルクリックします。
  3. 表示されるプロンプトに従ってライセンス契約に同意し、インストール先を選びます。
  4. [Install]をクリックします。

コマンドラインを用いたインストール

  1. Windows pe-client-toolsパッケージをダウンロードします。
  2. コマンドラインで、msiexec /i <PATH TO PE-CLIENT-TOOLS.MSI> TARGETDIR="<INSTALLATION DIRECTORY>"を実行します。

    TARGETDIRは省略可能です。

Windowsワークステーションでクライアントツールを使用し始めるには、 [スタート]メニューから[PE ClientTools Console]を選択します。

OS Xワークステーションへのインストール

OS Xワークステーションでは、Finderまだはコマンドラインを使用して、Puppet Enterpriseクライアントツールをインストールできます。

OS Xワークステーションの準備

  1. ワークステーションで/etc/puppetlabs/puppet/ssl/certsディレクトリを作成します。

    たとえば、mkdir -p /etc/puppetlabs/puppet/ssl/certsを実行します。

  2. Puppet masterで/etc/puppetlabs/puppet/ssl/certs/に移動し、前のステップで作成したワークステーション上のディレクトリにca.pemをコピーします。
  3. ワークステーションでchmod 444 /etc/puppetlabs/puppet/ssl/certs/ca.pemを実行して、ファイルパーミッションが正しいことを確認します。
  4. ワークステーション上にあるca.pemのチェックサムが、Puppet master上にある同ファイルのチェックサムと一致することを確認します。

OS X Finderを用いたインストール

  1. OS X pe-client-tools packageをダウンロードします。
  2. pe-client-tools .dmgを開いてinstaller .pkgをクリックします。
  3. インストーラのダイアログの指示に従います。

コマンドラインを用いたインストール

  1. OS X pe-client-tools packageをダウンロードします。
  2. sudo hdiutil mount <DMGFILE>を実行します。 (DMGFILEは、ダウンロードしたパッケージで置き換えます) )。

    /Volumes/pe-client-tools-<VERSION>で終わる行が表示されます。 これは、ディスクイメージから作成された仮想ボリュームのマウントポイントです。

  3. cd /Volumes/pe-client-tools-VERSIONを実行します。
  4. sudo installer -pkg pe-client-tools-<VERSION>-installer.pkg -target /を実行します。
  5. cd ~を実行してから、sudo umount /Volumes/pe-client-tools-VERSIONを実行します。

クライアントツールの設定と使用

ツールをインストールしたら、該当するマニュアルを参照し、クライアントツールを設定して使用を開始します。 Puppetアクセス、Puppetコード、Puppetオーケストレータの各クライアントでは、サービスごとにグローバル設定ファイルを使用することも、ユーザごとに各サービス用の設定ファイルを作成することもできます。 設定ファイルの作成方法については、対応するマニュアルを参照してください。

グローバル設定ファイルの管理

Puppet Enterpriseで管理されたマシンで、PuppetコードクライアントまたはPuppetオーケストレータクライアントを実行している場合、puppet_enterprise::profile::controllerクラスを使用すると、Puppet Enterpriseによるグローバル設定ファイルの管理を利用できます。 このクラスは、/etc/puppetlabs/client-tools/内のグローバル設定ファイルを管理します。

ワークステーションからクライアントを実行している場合、グローバルファイルを作成して、設定ファイル内に正しい設定を入力する必要があります。 ワークステーションがPuppet Enterpriseで管理されていない場合、Puppet Enterpriseはこのワークステーションから設定ファイルを管理することはできません。

設定ファイルの詳細については、該当するマニュアルを参照してください。

↑ Back to top