2.9.2 Registering the Puppet Enterprise Agent instance
Function
This service template is used to register the Puppet Enterprise Agent server to the Puppet Enterprise Master instance.
The prerequisite servers for this service template are as follows:
- Puppet Enterprise Master server
The Puppet Enterprise Master instance is installed on this server.
- Puppet Enterprise Agent server
The Puppet Enterprise Agent instance is installed on this server.
The following is a processing outline:
(1) Send the SSL certificate from the Puppet Enterprise Agent server to the Puppet Enterprise Master server.
Execute the "puppet agent -t" command on the Puppet Enterprise Agent server and send the SSL certificate to the Puppet Enterprise Master instance.
(2) Approve the SSL certificate of the Puppet Enterprise Agent instance on the Puppet Enterprise Master server.
Execute the puppet cert sign <SSL-certificate-name> command on the Puppet Enterprise Master server to approve the SSL certificate of the Puppet Enterprise Agent instance.
Use the name specified in the SSL certificate name of the Agent (puppet.puppetAgentCertNameproperty) as the name of the SSL certificate to approve. The SSL certificate name is usually the host name of the Puppet Enterprise Agent server.
(3) Check the registration to the Puppet Enterprise Master instance on the Puppet Enterprise Agent server.
Execute the "puppet agent -t" command on the Puppet Enterprise Agent server, and check the registration to the Puppet Enterprise Master instance.
(4) Check the registration result of step (3).
If the return value of (3) is 0, the system terminates normally.
If the return value of (3) is 2, directories and files might have been reconfigured for the setting of the Puppet Enterprise Agent instance on the Puppet Enterprise Agent server. Re-execute the "puppet agent -t" command to check whether communication with the Puppet Enterprise Master instance is enabled.
If the return value of (3) is other than 0 or 2, the system terminates abnormally.
Prerequisites
For the latest support status of the following items, see the Release Notes: Prerequisite products within the system, prerequisite products on the service template execution target server, running OS for prerequisite products on the service template execution target server.
Prerequisite product within the system:
- JP1/Automatic Operation 12-00 or later
Prerequisite products on the service template execution target server:
- Puppet Enterprise Master 3.8
- Puppet Enterprise Agent 3.8
Running OS for prerequisite products on the service template execution target server:
- Red Hat Enterprise Linux Server 6 (32-bit x86) or Red Hat Enterprise Linux Server 6 (64-bit x86_64)
- Red Hat Enterprise Linux Server 7 (64-bit x86_64)
Cautions
(1) The standard output of the "puppet agent -t" command is not output to the task log in the following situations: (1) when sending an SSL certificate by executing the "puppet agent -t" command, (2) when registering an agent, and (3) when performing each connection confirmation step for an agent. To confirm the execution result of a manifest, confirm the report in, for example, the Web console of Puppet.
Version
02.50.00
Tags
Configure OS,Puppet
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Puppet Enterprise Agent information |
Specify Puppet Enterprise Agent server information. |
Y |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
puppet.puppetMasterServer |
Host name of the Master server |
Specify the host name or IP address of the Puppet Enterprise Master server on which you want to register the Puppet Enterprise Agent instance. An IPv6 address cannot be used. |
Input |
Disabled |
R |
Puppet Enterprise Agent information |
|
puppet.puppetAgentServer |
Host name of the Agent server |
Specify the host name or IP address of the Puppet Enterprise Agent server on which you want to register the Puppet Enterprise Agent instance. An IPv6 address cannot be used. |
Input |
Disabled |
R |
Puppet Enterprise Agent information |
|
puppet.puppetAgentCertName |
SSL certificate name of the Agent |
Specify the name of the SSL certificate that the Puppet Enterprise Master instance approves. |
Input |
Disabled |
R |
Puppet Enterprise Agent information |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
puppet.puppetMasterServer |
256 or fewer alphanumeric characters, including hyphens (-) and periods (.). |
|
puppet.puppetAgentServer |
256 or fewer alphanumeric characters, including hyphens (-) and periods (.). |
|
puppet.puppetAgentCertName |
63 or fewer alphanumeric characters, including hyphens (-), periods (.), and underscores (_). |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
sendSslCertificate |
General Command Plug-in |
The SSL certificate is sent from the Puppet Enterprise Agent server to the Puppet Enterprise Master server. |
Remove the error cause, and then execute the processing from this step. |
|
2 |
signSslCertificate |
General Command Plug-in |
The SSL certificate of the Puppet Enterprise Agent is approved from the Puppet Enterprise Master server. |
Remove the error cause, and then execute the processing from the next step if the SSL certificate has already been approved. If the SSL certificate is yet to be approved, execute the processing from this step. You can check the approval status of the SSL certificate by using the puppet cert list command. |
|
3 |
checkAgentEntry |
General Command Plug-in |
The registration to the Puppet Enterprise Master is checked from the Puppet Enterprise Agent server. |
Remove the error cause, and then execute the processing from this step. |
|
4 |
JudgeValuePlugin |
Judge Value Plug-in |
The registration result of the Puppet Enterprise Agent server to the Puppet Enterprise Master is checked. |
Remove the error cause, and then execute the processing from this step. |
|
5 |
AbnormalEndPlugin |
Abnormal-End Plug-in |
Abnormal termination occurs because the registration of the Puppet Enterprise Agent server to the Puppet Enterprise Master failed. |
Remove the error cause, and then execute the processing from this step. |
|
6 |
JudgeValuePlugin2 |
Judge Value Plug-in |
The registration result of the Puppet Enterprise Agent server to the Puppet Enterprise Master is checked. |
Remove the error cause, and then execute the processing from this step. |
|
7 |
AbnormalEndPlugin2 |
Abnormal-End Plug-in |
Abnormal termination occurs because the registration of the Puppet Enterprise Agent server to the Puppet Enterprise Master failed. |
Remove the error cause, and then execute the processing from this step. |
|
8 |
JudgeValuePlugin3 |
Judge Value Plug-in |
The registration result of the Puppet Enterprise Agent server to the Puppet Enterprise Master is checked. |
Remove the error cause, and then execute the processing from this step. |
|
9 |
checkEntryReTry |
General Command Plug-in |
Communication with the Puppet Enterprise Master is checked from the Puppet Enterprise Agent server. |
Remove the error cause, and then execute the processing from this step. |