2.9.1 Registering Chef Client
Function
This service template is used to register the Chef Client server to the Chef Server instance.
Before registration to the Chef Server instance, forward the client.rb file, validation.pem file, and crt file to the Chef-Client server.
The prerequisite server for this service template is as follows:
- Chef Client
The Chef Client instance is installed on this server.
The following is a processing outline:
(1) Forward the client.rb file to the Chef Client server.
Forward the client.rb file immediately under the /etc/chef/ directory.
(2) Forward the validation.pem file to the Chef Client server.
Forward the validation.pem file immediately under the /etc/chef/ directory.
(3) Forward the crt file to the Chef Client server if you specified the path (local) for the crt file (chef.crtFilePath property).
Forward the crt file immediately under the /etc/chef/trusted_certs directory.
(4) Register the Chef Client server in the Chef Server instance.
Execute the chef-client command on the Chef Client server to register the Chef Client server to the Chef Server instance.
Notes on property settings are as follows:
(1) If you specify a Windows folder for the folder path (local) of the crt file, specify a backslash (\) at the end of the path. If you specify a Linux directory, specify a forward slash (/) at the end of the
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, and prerequisite products within the service template execution target system.
Prerequisite product within the system:
- JP1/Automatic Operation 12-00 or later
Prerequisite products on the service template execution target server:
- Chef Client 12.0
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) In the step of registering the Chef Client server that executes the chef-client command, the output size for the task log might exceed 100 KB depending on the settings for the recipe. As a result, the service might terminate abnormally with a return value of 72. In that case, check the execution result for the recipe from Management Console for the Chef instance, for example.
Version
02.50.00
Tags
Configure OS,Chef
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Chef Client information |
Specify Chef Client server information. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" 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 |
|---|---|---|---|---|---|---|
|
chef.clientFilePath |
client.rb file path (local) |
Specify the client.rb file you want to transfer from the local server by using a full path. |
Input |
Disabled |
R |
Chef Client information |
|
chef.validationFilePath |
validation.pem file path (local) |
Specify the validation.pem file you want to transfer from the local server by using a full path. |
Input |
Disabled |
R |
Chef Client information |
|
chef.crtDirPath |
crt directory path (local) |
Specify the folder on the crt file to be transferred from the local server by using a full path. |
Input |
Disabled |
O |
Chef Client information |
|
chef.crtFileName |
crt file name |
Specify the crt file name you want to transfer from the local server. |
Input |
Disabled |
O |
Chef Client information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
chef.chefClient |
Host name of the Chef Client server |
Specify the host name or IP address of the Chef Client server you want to register on the Chef Server instance. An IPv6 address cannot be used. |
Input |
Disabled |
R |
Chef Client information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
chef.clientFilePath |
A string that has 256 or fewer characters, does not end with a backslash (\), and does not include the following symbols: < > | ; & * ? " % / |
|
chef.validationFilePath |
A string that has 256 or fewer characters, does not end with a backslash (\), and does not include the following symbols: < > | ; & * ? " % / |
|
chef.crtDirPath |
No more than 256 characters (excluding the following symbols: <, >, |, ;, *, ?, ", %, and &). |
|
chef.crtFileName |
No more than 256 characters (excluding the following symbols: <, >, |, ;, *, ?, ", %, /, \, and &). |
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 |
|---|---|
|
chef.chefClient |
256 or fewer alphanumeric characters, including hyphens (-) and periods (.). |
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 |
sendClientFile |
File-Forwarding Plug-in |
The client.rb file is forwarded to the Chef Client server. |
Remove the error cause, and then execute the processing from this step. |
|
2 |
sendValidationFile |
File-Forwarding Plug-in |
The validation.pem file is forwarded to the Chef Client server. |
Remove the error cause, and then execute the processing from this step. |
|
3 |
JudgeValuePlugin |
Judge Value Plug-in |
Whether to forward the crt file to the Chef Client server is determined. |
Remove the error cause, and then execute the processing from this step. |
|
4 |
sendCrtFile |
File-Forwarding Plug-in |
The crt file is forwarded to the Chef Client server. |
Remove the error cause, and then execute the processing from this step. |
|
5 |
entryClient |
General Command Plug-in |
The chef-client command is executed, and the Chef Client server is registered on the Chef Server. |
Remove the error cause, and then execute the processing from this step. |