Chapter 4. Configuration Hooks The configuration hooks provide a method to inject your own configuration functions into the Overcloud deployment process. This includes hooks for injecting custom configuration before and after the main Overcloud services configuration and hook for modifying and including Puppet-based configuration. 4.1. First Boot: Customizing First Boot Configuration The director provides a mechanism to perform configuration on all nodes upon the initial creation of the Overcloud. The director achieves this through cloud-init , which you can call using the OS::TripleO::NodeUserData resource type. In this example, update the nameserver with a custom IP address on all nodes. First, create a basic Heat template ( /home/stack/templates/nameserver.yaml ) that runs a script to append each node's resolv.conf with a specific nameserver. You can use the OS::TripleO::MultipartMime resource type to send the configuration script. Create an environment file ( /home/stack/templates/firstboot.yaml ) that registers your Heat template as the OS::TripleO::NodeUserData resource type. To add the first boot configuration, add the environment file to the stack along with your other environment files when first creating the Overcloud. For example: The -e applies the environment file to the Overcloud stack. This adds the configuration to all nodes when they are first created and boot for the first time. Subsequent inclusions of these templates, such as updating the Overcloud stack, does not run these scripts. Important You can only register the OS::TripleO::NodeUserData to one Heat template. Subsequent usage overrides the Heat template to use. 4.2. Pre-Configuration: Customizing Specific Overcloud Roles Important versions of this document used the OS::TripleO::Tasks::*PreConfig resources to provide pre-configuration hooks on a per role basis. The director's Heat template collection requires dedicated use of these hooks, which means you should not use them for custom use. Instead, use the OS::TripleO::*ExtraConfigPre hooks outlined below. The Overcloud uses Puppet for the core configuration of OpenStack components. The director provides a set of hooks to provide custom configuration for specific node roles after the first boot completes and before the core configuration begins. These hooks include: OS::TripleO::ControllerExtraConfigPre Additional configuration applied to Controller nodes before the core Puppet configuration. OS::TripleO::ComputeExtraConfigPre Additional configuration applied to Compute nodes before the core Puppet configuration. OS::TripleO::CephStorageExtraConfigPre Additional configuration applied to Ceph Storage nodes before the core Puppet configuration. OS::TripleO::ObjectStorageExtraConfigPre Additional configuration applied to Object Storage nodes before the core Puppet configuration. OS::TripleO::BlockStorageExtraConfigPre Additional configuration applied to Block Storage nodes before the core Puppet configuration. OS::TripleO::[ROLE]ExtraConfigPre Additional configuration applied to custom nodes before the core Puppet configuration. Replace [ROLE] with the composable role name. In this example, you first create a basic Heat template ( /home/stack/templates/nameserver.yaml ) that runs a script to write to a node's resolv.conf with a variable nameserver. In this example, the resources section contains the following parameters: CustomExtraConfigPre This defines a software configuration. In this example, we define a Bash script and Heat replaces _NAMESERVER_IP_ with the value stored in the nameserver_ip parameter. CustomExtraDeploymentPre This executes a software configuration, which is the software configuration from the CustomExtraConfigPre resource. Note the following: The config parameter makes a reference to the CustomExtraConfigPre resource so Heat knows what configuration to apply. The server parameter retrieves a map of the Overcloud nodes. This parameter is provided by the parent template and is mandatory in templates for this hook. The actions parameter defines when to apply the configuration. In this case, apply the configuration when the Overcloud is created. Possible actions include CREATE , UPDATE , DELETE , SUSPEND , and RESUME . input_values contains a parameter called deploy_identifier , which stores the DeployIdentifier from the parent template. This parameter provides a timestamp to the resource for each deployment update. This ensures the resource reapplies on subsequent overcloud updates. Create an environment file ( /home/stack/templates/pre_config.yaml ) that registers your Heat template to the role-based resource type. For example, to apply only to Controller nodes, use the ControllerExtraConfigPre hook: To apply the configuration, add the environment file to the stack along with your other environment files when creating or updating the Overcloud. For example: This applies the configuration to all Controller nodes before the core configuration begins on either the initial Overcloud creation or subsequent updates. Important You can only register each resource to only one Heat template per hook. Subsequent usage overrides the Heat template to use. 4.3. Pre-Configuration: Customizing All Overcloud Roles The Overcloud uses Puppet for the core configuration of OpenStack components. The director provides a hook to configure all node types after the first boot completes and before the core configuration begins: OS::TripleO::NodeExtraConfig Additional configuration applied to all nodes roles before the core Puppet configuration. In this example, create a basic Heat template ( /home/stack/templates/nameserver.yaml ) that runs a script to append each node's resolv.conf with a variable nameserver. In this example, the resources section contains the following parameters: CustomExtraConfigPre This defines a software configuration. In this example, we define a Bash script and Heat replaces _NAMESERVER_IP_ with the value stored in the nameserver_ip parameter. CustomExtraDeploymentPre This executes a software configuration, which is the software configuration from the CustomExtraConfigPre resource. Note the following: The config parameter makes a reference to the CustomExtraConfigPre resource so Heat knows what configuration to apply. The server parameter retrieves a map of the Overcloud nodes. This parameter is provided by the parent template and is mandatory in templates for this hook. The actions parameter defines when to apply the configuration. In this case, we only apply the configuration when the Overcloud is created. Possible actions include CREATE , UPDATE , DELETE , SUSPEND , and RESUME . The input_values parameter contains a sub-parameter called deploy_identifier , which stores the DeployIdentifier from the parent template. This parameter provides a timestamp to the resource for each deployment update. This ensures the resource reapplies on subsequent overcloud updates. , create an environment file ( /home/stack/templates/pre_config.yaml ) that registers your heat template as the OS::TripleO::NodeExtraConfig resource type. To apply the configuration, add the environment file to the stack along with your other environment files when creating or updating the Overcloud. For example: This applies the configuration to all nodes before the core configuration begins on either the initial Overcloud creation or subsequent updates. Important You can only register the OS::TripleO::NodeExtraConfig to only one Heat template. Subsequent usage overrides the Heat template to use. 4.4. Post-Configuration: Customizing All Overcloud Roles Important versions of this document used the OS::TripleO::Tasks::*PostConfig resources to provide post-configuration hooks on a per role basis. The director's Heat template collection requires dedicated use of these hooks, which means you should not use them for custom use. Instead, use the OS::TripleO::NodeExtraConfigPost hook outlined below. A situation might occur where you have completed the creation of your Overcloud but want to add additional configuration to all roles, either on initial creation or on a subsequent update of the Overcloud. In this case, you use the following post-configuration hook: OS::TripleO::NodeExtraConfigPost Additional configuration applied to all nodes roles after the core Puppet configuration. In this example, you first create a basic heat template ( /home/stack/templates/nameserver.yaml ) that runs a script to append each node's resolv.conf with a variable nameserver. In this example, the resources section contains the following: CustomExtraConfig This defines a software configuration. In this example, we define a Bash script and Heat replaces _NAMESERVER_IP_ with the value stored in the nameserver_ip parameter. CustomExtraDeployments This executes a software configuration, which is the software configuration from the CustomExtraConfig resource. Note the following: The config parameter makes a reference to the CustomExtraConfig resource so Heat knows what configuration to apply. The servers parameter retrieves a map of the Overcloud nodes. This parameter is provided by the parent template and is mandatory in templates for this hook. The actions parameter defines when to apply the configuration. In this case, we apply the configuration when the Overcloud is created. Possible actions include CREATE , UPDATE , DELETE , SUSPEND , and RESUME . input_values contains a parameter called deploy_identifier , which stores the DeployIdentifier from the parent template. This parameter provides a timestamp to the resource for each deployment update. This ensures the resource reapplies on subsequent overcloud updates. Create an environment file ( /home/stack/templates/post_config.yaml ) that registers your Heat template as the OS::TripleO::NodeExtraConfigPost: resource type. To apply the configuration, add the environment file to the stack along with your other environment files when creating or updating the Overcloud. For example: This applies the configuration to all nodes after the core configuration completes on either initial Overcloud creation or subsequent updates. Important You can only register the OS::TripleO::NodeExtraConfigPost to only one Heat template. Subsequent usage overrides the Heat template to use. 4.5. Puppet: Customizing Hieradata for Roles The Heat template collection contains a set of parameters to pass extra configuration to certain node types. These parameters save the configuration as hieradata for the node's Puppet configuration. These parameters are: ControllerExtraConfig Configuration to add to all Controller nodes. ComputeExtraConfig Configuration to add to all Compute nodes. BlockStorageExtraConfig Configuration to add to all Block Storage nodes. ObjectStorageExtraConfig Configuration to add to all Object Storage nodes. CephStorageExtraConfig Configuration to add to all Ceph Storage nodes. [ROLE]ExtraConfig Configuration to add to a composable role. Replace [ROLE] with the composable role name. ExtraConfig Configuration to add to all nodes. To add extra configuration to the post-deployment configuration process, create an environment file that contains these parameters in the parameter_defaults section. For example, to increase the reserved memory for Compute hosts to 1024 MB and set the VNC keymap to Japanese: Include this environment file when running openstack overcloud deploy . Important You can only define each parameter once. Subsequent usage overrides values. 4.6. Puppet: Customizing Hieradata for Individual Nodes You can set Puppet hieradata for individual nodes using the Heat template collection. To accomplish this, acquire the system UUID saved as part of the introspection data for a node: This outputs a system UUID. For example: Use this system UUID in an environment file that defines node-specific hieradata and registers the per_node.yaml template to a pre-configuration hook. For example: Include this environment file when running openstack overcloud deploy . The per_node.yaml template generates a set of heiradata files on nodes that correspond to each system UUID and contains the hieradata you defined. If a UUID is not defined, the resulting hieradata file is empty. In the example, the per_node.yaml template runs on all Compute nodes (as per the OS::TripleO::ComputeExtraConfigPre hook), but only the Compute node with system UUID F5055C6C-477F-47FB-AFE5-95C6928C407F receives hieradata. This provides a method of tailoring each node to specific requirements. For more information about NodeDataLookup, see Configuring Ceph Storage Cluster Setting in the Deploying an Overcloud with Containerized Red Hat Ceph guide. 4.7. Puppet: Applying Custom Manifests In certain circumstances, you might need to install and configure some additional components to your Overcloud nodes. You can achieve this with a custom Puppet manifest that applies to nodes after the main configuration completes. As a basic example, you might intend to install motd to each node. The process for accomplishing this is to first create a Heat template ( /home/stack/templates/custom_puppet_config.yaml ) that launches Puppet configuration. This includes the /home/stack/templates/motd.pp within the template and passes it to nodes for configuration. The motd.pp file itself contains the Puppet classes to install and configure motd . Create an environment file ( /home/stack/templates/puppet_post_config.yaml ) that registers your heat template as the OS::TripleO::NodeExtraConfigPost: resource type. Include this environment file along with your other environment files when creating or updating the Overcloud stack: This applies the configuration from motd.pp to all nodes in the Overcloud.

Commands:
heat_template_version: 2014-10-16 description: > Extra hostname configuration resources: userdata: type: OS::Heat::MultipartMime properties: parts: - config: {get_resource: nameserver_config} nameserver_config: type: OS::Heat::SoftwareConfig properties: config: | #!/bin/bash echo "nameserver 192.168.1.1" >> /etc/resolv.conf outputs: OS::stack_id: value: {get_resource: userdata}
resource_registry: OS::TripleO::NodeUserData: /home/stack/templates/nameserver.yaml
openstack overcloud deploy --templates -e /home/stack/templates/firstboot.yaml
heat_template_version: 2014-10-16 description: > Extra hostname configuration parameters: server: type: json nameserver_ip: type: string DeployIdentifier: type: string resources: CustomExtraConfigPre: type: OS::Heat::SoftwareConfig properties: group: script config: str_replace: template: | #!/bin/sh echo "nameserver _NAMESERVER_IP_" > /etc/resolv.conf params: _NAMESERVER_IP_: {get_param: nameserver_ip} CustomExtraDeploymentPre: type: OS::Heat::SoftwareDeployment properties: server: {get_param: server} config: {get_resource: CustomExtraConfigPre} actions: ['CREATE','UPDATE'] input_values: deploy_identifier: {get_param: DeployIdentifier} outputs: deploy_stdout: description: Deployment reference, used to trigger pre-deploy on changes value: {get_attr: [CustomExtraDeploymentPre, deploy_stdout]}
resource_registry: OS::TripleO::ControllerExtraConfigPre: /home/stack/templates/nameserver.yaml parameter_defaults: nameserver_ip: 192.168.1.1
openstack overcloud deploy --templates -e /home/stack/templates/pre_config.yaml
heat_template_version: 2014-10-16 description: > Extra hostname configuration parameters: server: type: string nameserver_ip: type: string DeployIdentifier: type: string resources: CustomExtraConfigPre: type: OS::Heat::SoftwareConfig properties: group: script config: str_replace: template: | #!/bin/sh echo "nameserver _NAMESERVER_IP_" >> /etc/resolv.conf params: _NAMESERVER_IP_: {get_param: nameserver_ip} CustomExtraDeploymentPre: type: OS::Heat::SoftwareDeployment properties: server: {get_param: server} config: {get_resource: CustomExtraConfigPre} actions: ['CREATE','UPDATE'] input_values: deploy_identifier: {get_param: DeployIdentifier} outputs: deploy_stdout: description: Deployment reference, used to trigger pre-deploy on changes value: {get_attr: [CustomExtraDeploymentPre, deploy_stdout]}
resource_registry: OS::TripleO::NodeExtraConfig: /home/stack/templates/nameserver.yaml parameter_defaults: nameserver_ip: 192.168.1.1
openstack overcloud deploy --templates -e /home/stack/templates/pre_config.yaml
heat_template_version: 2014-10-16 description: > Extra hostname configuration parameters: servers: type: json nameserver_ip: type: string DeployIdentifier: type: string EndpointMap: default: {} type: json resources: CustomExtraConfig: type: OS::Heat::SoftwareConfig properties: group: script config: str_replace: template: | #!/bin/sh echo "nameserver _NAMESERVER_IP_" >> /etc/resolv.conf params: _NAMESERVER_IP_: {get_param: nameserver_ip} CustomExtraDeployments: type: OS::Heat::SoftwareDeploymentGroup properties: servers: {get_param: servers} config: {get_resource: CustomExtraConfig} actions: ['CREATE','UPDATE'] input_values: deploy_identifier: {get_param: DeployIdentifier}
resource_registry: OS::TripleO::NodeExtraConfigPost: /home/stack/templates/nameserver.yaml parameter_defaults: nameserver_ip: 192.168.1.1
openstack overcloud deploy --templates -e /home/stack/templates/post_config.yaml
parameter_defaults: ComputeExtraConfig: nova::compute::reserved_host_memory: 1024 nova::compute::vnc_keymap: ja
openstack baremetal introspection data save 9dcc87ae-4c6d-4ede-81a5-9b20d7dc4a14 | jq .extra.system.product.uuid
"F5055C6C-477F-47FB-AFE5-95C6928C407F"
resource_registry: OS::TripleO::ComputeExtraConfigPre: /usr/share/openstack-tripleo-heat-templates/puppet/extraconfig/pre_deploy/per_node.yaml parameter_defaults: NodeDataLookup: '{"F5055C6C-477F-47FB-AFE5-95C6928C407F": {"nova::compute::vcpu_pin_set": [ "2", "3" ]}}'
heat_template_version: 2014-10-16 description: > Run Puppet extra configuration to set new MOTD parameters: servers: type: json resources: ExtraPuppetConfig: type: OS::Heat::SoftwareConfig properties: config: {get_file: motd.pp} group: puppet options: enable_hiera: True enable_facter: False ExtraPuppetDeployments: type: OS::Heat::SoftwareDeploymentGroup properties: config: {get_resource: ExtraPuppetConfig} servers: {get_param: servers}
resource_registry: OS::TripleO::NodeExtraConfigPost: /home/stack/templates/custom_puppet_config.yaml
openstack overcloud deploy --templates -e /home/stack/templates/puppet_post_config.yaml