Puppet Enterprise 2017.2

pe.confパラメータリファレンス

以下のセクションでは、インストールまたはアップグレードの際に、pe.confで必須またはオプションとなるパラメータの詳細を説明します。

pe.confファイルは、HOCON形式のファイルで、Puppet Enterpriseをインストールして構成する際に必要なパラメータと値を明示するものです。

以下に、有効なパラメータと値の表現の例を示します。

FQDN "puppet_enterprise::puppet_master_host": "master.example.com"
文字列 "console_admin_password": "mypassword"
ブール値 "puppet_enterprise::profile::master::app_management": true
有効なブール値は、trueまたはfalse(大文字と小文字を区別、クォーテーションマークなし)です。Yes (y)、No (n)、1、0を使用しないでください
JSONハッシュ "puppet_enterprise::profile::orchestrator::java_args": {"Xmx": "256m", "Xms": "256m"}
整数 "puppet_enterprise::profile::console::rbac_session_timeout": "60"

警告:パラメータ値にシングルクォーテーションを使わないでください。 例に示したように、ダブルクォーテーションを使用してください。

インストーラのディレクトリにパッケージされているpe.conf例には、モノリシックインストールまたは分割インストールに必要な必須パラメータが含まれています。 このファイル例を使えば、自身で作成する必要はありません。

モノリシックインストールのパラメータ

以下のパラメータは、モノリシックインストールの必須パラメータです。

パラメータ
console_admin_password Puppet Enterprise Webコンソールのログインに使用するパラメータ。例: "myconsolepassword"
puppet_enterprise::puppet_master_host Puppet masterをホストするノードのFQDN。例:"PUPPET MASTER NODE FQDN"
(モノリシックインストールでは、この設定の値を"%{::trusted.certname}"のままにできます。)

分割インストールのパラメータ

以下のパラメータは、分割インストールの必須パラメータです。

パラメータ
console_admin_password Puppet Enterprise Webコンソールのログインに使用するパラメータ。例: "myconsolepassword"
puppet_enterprise::puppet_master_host Puppet masterをホストするノードのFQDN。例:"PUPPET MASTER NODE FQDN"
(分割インストールでは、Puppet masterに対して"%{::trusted.certname}"を使わないでください。)
puppet_enterprise::console_host Puppet Enterprise WebコンソールをホストするノードのFQDN。例:"PE CONSOLE NODE FQDN"
puppet_enterprise::puppetdb_host The FQDN of the node hosting PuppetDB. For example, "PUPPETDB NODE FQDN"

データベース設定パラメータ

以下に、Puppet Enterpriseデータベースにデフォルトで提供されるパラメータと値を示します。 これらの値を変更したり、カスタマイズしたりしないでください。

パラメータ
puppet_enterprise::activity_database_name pe-activity (デフォルト)
アクティビティデータベースの名前。
puppet_enterprise::activity_database_read_user pe-activity-read(デフォルト)
read関数のみを実行できるアクティビティデータベースユーザの名前。
puppet_enterprise::activity_database_write_user pe-activity-write(デフォルト)
read およびwrite関数のみを実行できるアクティビティデータベースユーザの名前。
puppet_enterprise::activity_database_super_user pe-activity(デフォルト)
アクティビティデータベーススーパーユーザの名前。
puppet_enterprise::activity_service_migration_db_user pe-activity(デフォルト)
アクティビティサービスが移行時に使用するデータベースユーザ。
puppet_enterprise::activity_service_regular_db_user pe-activity-write(デフォルト)
アクティビティサービスが通常処理に使用するデータベースユーザ。
puppet_enterprise::classifier_database_name pe-classifier(デフォルト)
クラシファイアデータベースの名前。
puppet_enterprise::classifier_database_read_user pe-classifier-read(デフォルト)
read関数のみを実行できるクラシファイアデータベースユーザの名前。
puppet_enterprise::classifier_database_write_user pe-classifier-write(デフォルト)
readおよびwrite関数のみを実行できるクラシファイアデータベースユーザの名前。
puppet_enterprise::classifier_database_super_user pe-classifier(デフォルト)
クラシファイアデータベーススーパーユーザの名前。
puppet_enterprise::classifier_service_migration_db_user pe-classifier(デフォルト)
クラシファイアサービスが移行時に使用するデータベースユーザ。
puppet_enterprise::classifier_service_regular_db_user pe-classifier-write(デフォルト)
クラシファイアサービスが通常処理に使用するデータベースユーザ。
puppet_enterprise::orchestrator_database_name pe-orchestrator(デフォルト)
オーケストレータデータベースの名前。
puppet_enterprise::orchestrator_database_read_user pe-orchestrator-read(デフォルト)
read関数のみを実行できるオーケストレータデータベースユーザの名前。
puppet_enterprise::orchestrator_database_write_user pe-orchestrator-write(デフォルト)
readおよびwrite関数のみを実行できるオーケストレータデータベースユーザの名前。
puppet_enterprise::orchestrator_database_super_user pe-orchestrator(デフォルト)
オーケストレータデータベーススーパーユーザの名前。
puppet_enterprise::orchestrator_service_migration_db_user pe-orchestrator(デフォルト)
オーケストレータサービスが移行時に使用するデータベースユーザ。
puppet_enterprise::orchestrator_service_regular_db_user pe-orchestrator-write(デフォルト)
オーケストレータサービスが通常処理に使用するデータベースユーザ。
puppet_enterprise::puppetdb_database_name pe-puppetdb(デフォルト)
PuppetDBデータベースの名前。
puppet_enterprise::puppetdb_database_user pe-puppetdb(デフォルト)
PuppetDBデータベースユーザの名前。
puppet_enterprise::rbac_database_name pe-rbac(デフォルト)
RBACデータベースの名前。
puppet_enterprise::rbac_database_read_user pe-rbac-read(デフォルト)
read関数のみを実行できるRBACデータベースユーザの名前。
puppet_enterprise::rbac_database_write_user pe-rbac-write(デフォルト)
readおよびwrite関数のみを実行できるRBACデータベースユーザの名前。
puppet_enterprise::rbac_database_super_user pe-rbac(デフォルト)
RBACデータベーススーパーユーザの名前。
puppet_enterprise::rbac_service_migration_db_user pe-rbac(デフォルト)
RBACサービスが移行時に使用するデータベースユーザ。
puppet_enterprise::rbac_service_regular_db_user pe-rbac-write(デフォルト)
RBACサービスが通常処理に使用するデータベースユーザ。

外部PostgreSQLパラメータ

以下のパラメータは、外部postgreSQLをインストールする際に必要となるものです。 必要に応じて、パスワードパラメータを標準インストールに追加することができます。

パラメータ
puppet_enterprise::database_host データベースコンポーネントをホストするノードのFQDN。
puppet_enterprise::database_ssl "true"または"false"(デフォルトは"false")
この値は外部PostgreSQLと同じままにします。
puppet_enterprise::database_cert_auth "true"または"false"(デフォルトは"false")
この値は外部PostgreSQLと同じままにします。
puppet_enterprise::puppetdb_database_password PuppetDBデータベースユーザのパスワード。文字列でなければなりません。例:"mypassword"
puppet_enterprise::classifier_database_password クラシファイアデータベースユーザのパスワード。文字列でなければなりません。例:"mypassword"
puppet_enterprise::classifier_service_regular_db_user "pe-classifier"(デフォルト)
クラシファイアサービスが通常処理に使用するデータベースユーザ。
puppet_enterprise::classifier_service_migration_db_user "pe-classifier" (デフォルト)
クラシファイアサービスが移行時に使用するデータベースユーザ。
puppet_enterprise::activity_database_password アクティビティデータベースユーザのパスワード。文字列でなければなりません。例:"mypassword"
puppet_enterprise::activity_service_regular_db_user "pe-activity" (デフォルト)
アクティビティサービスが通常処理に使用するデータベースユーザ。
puppet_enterprise::activity_service_migration_db_user "pe-activity" (デフォルト)
アクティビティサービスが移行時に使用するデータベースユーザ。
puppet_enterprise::rbac_database_password RBACデータベースユーザのパスワード。文字列でなければなりません。例:"mypassword"
puppet_enterprise::rbac_service_regular_db_user "pe-rbac" (デフォルト)
RBACサービスが通常処理に使用するデータベースユーザ。
puppet_enterprise::rbac_service_migration_db_user "pe-rbac" (デフォルト)
RBACサービスが移行時に使用するデータベースユーザ。
puppet_enterprise::orchestrator_database_password オーケストレータデータベースユーザのパスワード。文字列でなければなりません。例:"mypassword"
puppet_enterprise::orchestrator_service_regular_db_user "pe-orchestrator" (デフォルト)
オーケストレータサービスが通常処理に使用するデータベースユーザ。
puppet_enterprise::orchestrator_service_migration_db_user "pe-orchestrator" (デフォルト)
オーケストレータサービスが移行時に使用するデータベースユーザ。

Puppet Enterpriseの設定およびチューニングのためのパラメータ

以下のパラメータを使えば、必要に応じてPuppet Enterpriseを設定およびチューニングすることができます。

Puppet masterの設定およびチューニングのためのパラメータ

パラメータ
pe_install::puppet_master_dnsaltnames 文字列でなければなりません。Puppet masterノード向けに生成されたSSL証明書に追加されるDNSオルトネーム。
何も指定しない場合、デフォルトの["puppet"]が使用されます。
puppet_enterprise::profile::certificate_authority /certificate_status
APIエンドポイントへのアクセスを許可する追加証明書の配列を含みます。これはベースとなるPuppet Enterprise証明書リストに追加されます。例:"examplevm.puppet.com"
puppet_enterprise::profile::master::code_manager_auto_configure コードマネージャサービスを自動設定するかどうかを、trueまたはfalse
で指定します。
puppet_enterprise::profile::master::r10k_remote 文字列でなければなりません
r10k.yamlファイルに渡されるgitのURL。
例:"git@your.git.server.com:puppet/control.git"
r10k (および、通常はgit)でサポートされる任意のURLを指定できます。この指定が必要になるのは、
Puppet Enterpriseのインストール時にr10kを設定する場合のみです。
puppet_enterprise::profile::master::r10k_private_key 文字列でなければなりません。
r10kによりSSHプライベートキーを検索および使用できるPuppet master上のローカルファイルシステムパス
例:"/etc/puppetlabs/puppetserver/ssh/id-control_repo.rsa")
この指定が必要になるのは、Puppet Enterpriseのインストール時にr10kを設定する場合のみです。
これはpuppet_enterprise::profile::master::r10k_remoteと連動して指定する必要があります。
puppet_enterprise::profile::master::check_for_updates pe-puppetserverサービスを再起動するたびにアップデートをチェックするかどうかを
trueまたはfalseで指定します(デフォルトはtrue)。
デフォルトではアップデートチェックが有効化(true)されます。
詳細については、「アップデートチェックの無効化」を参照してください。
puppet_enterprise::profile::mcollective::peadmin::mco_loglevel MCollectiveクライアントログファイルのパスを表す文字列。必要に応じて変更します。

Puppet Enterprise Webコンソールとコンソールサービスの設定およびチューニングのためのパラメータ

パラメータ
puppet_enterprise::profile::console::classifier_synchronization_period 整数でなければなりません。分類子同期期間。
ノード分類子(NC)がPuppet masterからクラスを引き出す時間の長さを制御します。
デフォルトは"600"秒(10分)です。
puppet_enterprise::api_port Puppet Enterpriseがノード分類子にサービスを提供するSSLポート。デフォルトは "[4433]"
puppet_enterprise::profile::console::rbac_session_timeout 整数でなければなりません。ユーザセッションの持続時間を分単位で指定します。このセッションはノードの分類、RBAC、コンソール間で同一です。デフォルト値は"60"です。
puppet_enterprise::profile::console::session_maximum_lifetime 整数でなければなりません。コンソールセッションの有効性を維持する最大許容期間を指定します。指定できる単位は、 "s" (秒)、"m" (分)、"h" (時間)、"d" (日)、"y" (年)です。トークンの最長ライフタイムまで期限切れにしない場合は、"0"に設定できます。
単位は、整数の後に1文字で指定します。例:"1d" (1日)。単位を指定しない場合、整数は秒数と見なされます。
puppet_enterprise::profile::console::console_ssl_listen_port 整数でなければなりません。コンソールを使用できるポート。
デフォルトは"[443]"
puppet_enterprise::profile::console::ssl_listen_address Puppet EnterpriseのPuppet Enterprise Webコンソール用リスニングアドレス。
デフォルトは"0.0.0.0"
puppet_enterprise::profile::console::classifier_prune_threshold 整数でなければなりません。クラシファイアデータベースのサイズを縮小するまでの日数。
値を"0"に設定すると、ノード分類子サービスはデータベースを縮小しません。
puppet_enterprise::profile::console::pcp_timeout コンソールの[Run Puppet]ボタンからPuppetを実行するには、Puppet agentがPCPブローカに接続する必要があります。接続がタイムアウトするまでの時間を整数で指定します。
[Run Puppet]ボタンのデフォルトは"5"秒です。この時間内にagentがブローカに接続できない場合、実行はタイムアウトになります。
puppet_enterprise::profile::console::proxy::http_redirect::enable_http_redirect HTTPを介して接続しようとすると、Puppet Enterprise WebコンソールはHTTPSにリダイレクトします。デフォルト設定はtrueです。リダイレクトを無効にするには、falseに設定します。
puppet_enterprise::profile::console::classifier_node_check_in_storage 分類先グループに対してルールが一致した方法を示す分類がリクエストされると、ノード分類子サービスは各ノードのチェックインを保存します。デフォルトではfalseとして無効に設定されているので、有効にする場合はtrueを設定します。
puppet_enterprise::profile::console::display_local_time デフォルトでは、コンソールに表示されるタイムスタンプはUTCフォーマット(別名Zulu Time)です。必要な場合、すべてのタイムスタンプを現地時間で表示し、マウスを合わせたときにUTC時間を表示するように、コンソール設定を変更できます。trueを設定すると、タイムスタンプが現地時間で表示され、ホバーテキストにUTC時間が表示されます。false(デフォルト)を設定すると、タイムスタンプがUTC時間で表示されます。
puppet_enterprise::console_services::no_longer_reporting_cutoff 最後のレポートを送信してからノードが応答なしと見なされるまでの時間を規定します。秒数を表す整数値を指定します。デフォルトは3600秒です。

オーケストレータとオーケストレーションサービスの設定およびチューニングのためのパラメータ

パラメータ
puppet_enterprise::profile::master::app_management アプリケーション管理を有効にするかどうかを、trueまたはfalseで指定します。
デフォルトでは、有効(true)になっています。
puppet_enterprise::profile::orchestrator::run_service オーケストレーションサービスを有効にするかどうかを、trueまたはfalseで指定します。
デフォルトでは、有効(true) になっています。
puppet_enterprise::profile::agent::pxp_enabled PXPサービスを有効にするかどうかを、trueまたはfalseで指定します。
この設定を無効にした場合、オーケストレータとコンソールの[Run Puppet]ボタンは使用できません。
デフォルトでは、有効(true)になっています。
puppet_enterprise::profile::orchestrator::global_concurrent_compiles すべてのオーケストレータジョブを通じてPuppet masterに送信できる同時コンパイル要求の最大数を整数で指定します。
デフォルト値は"8"です。
puppet_enterprise::profile::orchestrator::pcp_timeout PuppetオーケストレータからPuppetを実行するには、Puppet agentがPCPブローカに接続する必要があります。接続がタイムアウトするまでの時間を整数で指定します。
Puppetオーケストレータのデフォルトは"30"秒です。この時間内にagentがブローカに接続できない場合、実行はタイムアウトになります。
puppet_enterprise::pxp_agent::pxp_logfile PXP agentログファイルのパスを表す文字列。必要に応じて変更します。ログファイルはデフォルトで、 /var/log/puppetlabs/pxp-agent/pxp-agent.log (*nixの場合)、またはC:/ProgramData/PuppetLabs/pxp-agent/var/log/pxp-agent.log (Windowsの場合)にあります。
puppet_enterprise::pxp_agent::ping_interval PXP agentがPCPブローカにpingを送信する頻度を制御します。agentは、応答を受け取るまで再接続を試みます。
デフォルト設定は"120" 秒です。

PuppetDBの設定およびチューニングのためのパラメータ

パラメータ
puppet_enterprise::puppetdb::command_processing_threads 整数でなければなりません。
PuppetDBが受信データの分類に用いるコマンド処理スレッドの数を定義します。各スレッドが一度に処理できるのは1つのコマンドです。
この設定はデフォルトで、システム内のコア数の1/2に設定されています。例:"8"
puppet_enterprise::profile::master::puppetdb_report_processor_ensure Puppet masterはPuppet実行のたびにagent実行レポートを生成して、
PuppetDBに送信します。
presentまたはabsentを指定します。デフォルトではpresent(有効)に設定されています。
puppet_enterprise::puppetdb_port PuppetDBがリスニングするSSLポート。整数を"[]"で括ります。
例:"[8081]"
puppet_enterprise::profile::puppetdb::node_purge_ttl 停止されたノードや有効期限切れのノードが自動的に削除されるまでの「有効期間」を設定します。
ノードが削除されると、そのノードのfact、カタログ、レポートもすべて削除されます。
たとえば、 "14d"という値を指定すると、有効期間が14日間に設定されます。

Java引数の設定およびチューニングのためのパラメータ

パラメータ
puppet_enterprise::profile::master::java_args Puppetサーバーサービスに割り当てられるJVM (Java Virtual Machine) メモリ。
JSONハッシュとして設定します。例:{"Xmx": "4096m", "Xms": "4096m"}
puppet_enterprise::profile::puppetdb::java_args PuppetDBサービスに割り当てられるJVMメモリ。
JSONハッシュとして設定します。例:{"Xmx": "512m", "Xms": "512m"}
puppet_enterprise::profile::console::java_args コンソールサービスに割り当てられるJVMメモリ。
JSONハッシュとして設定します。例:{"Xmx": "512m", "Xms": "512m"}
puppet_enterprise::profile::orchestrator::java_args オーケストレーションサービスに割り当てられるJVMメモリ。
JSONハッシュとして設定します。例: {"Xmx": "256m", "Xms": "256m"}
Back to top