Add HostnameMap to allow granular control of hostnames
[apex-tripleo-heat-templates.git] / puppet / cinder-storage.yaml
1 heat_template_version: 2015-04-30
2 description: 'OpenStack cinder storage configured by Puppet'
3 parameters:
4   Image:
5     default: overcloud-cinder-volume
6     type: string
7   CinderEnableIscsiBackend:
8     default: true
9     description: Whether to enable or not the Iscsi backend for Cinder
10     type: boolean
11   CinderISCSIHelper:
12     default: tgtadm
13     description: The iSCSI helper to use with cinder.
14     type: string
15   CinderLVMLoopDeviceSize:
16     default: 5000
17     description: The size of the loopback file used by the cinder LVM driver.
18     type: number
19   CinderPassword:
20     description: The password for the cinder service and db account, used by cinder-api.
21     type: string
22     hidden: true
23   Debug:
24     default: ''
25     description: Set to True to enable debugging on all services.
26     type: string
27   VirtualIP: # deprecated. Use per service VIPs instead.
28     default: ''
29     type: string
30   ExtraConfig:
31     default: {}
32     description: |
33       Additional hiera configuration to inject into the cluster. Note
34       that BlockStorageExtraConfig takes precedence over ExtraConfig.
35     type: json
36   BlockStorageExtraConfig:
37     default: {}
38     description: |
39       Role specific additional hiera configuration to inject into the cluster.
40     type: json
41   Flavor:
42     description: Flavor for block storage nodes to request when deploying.
43     type: string
44     constraints:
45       - custom_constraint: nova.flavor
46   KeyName:
47     default: default
48     description: Name of an existing Nova key pair to enable SSH access to the instances
49     type: string
50   RabbitPassword:
51     default: 'guest'
52     type: string
53     hidden: true
54   RabbitUserName:
55     default: 'guest'
56     type: string
57   RabbitClientUseSSL:
58     default: false
59     description: >
60         Rabbit client subscriber parameter to specify
61         an SSL connection to the RabbitMQ host.
62     type: string
63   RabbitClientPort:
64     default: 5672
65     description: Set rabbit subscriber port, change this if using SSL
66     type: number
67   SnmpdReadonlyUserName:
68     default: ro_snmp_user
69     description: The user name for SNMPd with readonly rights running on all Overcloud nodes
70     type: string
71   SnmpdReadonlyUserPassword:
72     description: The user password for SNMPd with readonly rights running on all Overcloud nodes
73     type: string
74     hidden: true
75   NtpServer:
76     default: ''
77     description: Comma-separated list of ntp servers
78     type: comma_delimited_list
79   EnablePackageInstall:
80     default: 'false'
81     description: Set to true to enable package installation via Puppet
82     type: boolean
83   UpdateIdentifier:
84     default: ''
85     type: string
86     description: >
87       Setting to a previously unused value during stack-update will trigger
88       package update on all nodes
89   Hostname:
90     type: string
91     default: '' # Defaults to Heat created hostname
92   HostnameMap:
93     type: json
94     default: {}
95     description: Optional mapping to override hostnames
96   ServiceNetMap:
97     default: {}
98     description: Mapping of service_name -> network name. Typically set
99                  via parameter_defaults in the resource registry.
100     type: json
101   EndpointMap:
102     default: {}
103     description: Mapping of service endpoint -> protocol. Typically set
104                  via parameter_defaults in the resource registry.
105     type: json
106   TimeZone:
107     default: 'UTC'
108     description: The timezone to be set on Cinder nodes.
109     type: string
110   GlanceApiVirtualIP:
111     type: string
112     default: ''
113   MysqlVirtualIP:
114     type: string
115     default: ''
116   NetworkDeploymentActions:
117     type: comma_delimited_list
118     description: >
119       Heat action when to apply network configuration changes
120     default: ['CREATE']
121   SoftwareConfigTransport:
122     default: POLL_SERVER_CFN
123     description: |
124       How the server should receive the metadata required for software configuration.
125     type: string
126     constraints:
127     - allowed_values: [POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE]
128   CloudDomain:
129     default: ''
130     type: string
131     description: >
132       The DNS domain used for the hosts. This should match the dhcp_domain
133       configured in the Undercloud neutron. Defaults to localdomain.
134   ServerMetadata:
135     default: {}
136     description: >
137       Extra properties or metadata passed to Nova for the created nodes in
138       the overcloud. It's accessible via the Nova metadata API.
139     type: json
140   SchedulerHints:
141     type: json
142     description: Optional scheduler hints to pass to nova
143     default: {}
144
145
146 resources:
147   BlockStorage:
148     type: OS::Nova::Server
149     properties:
150       image:
151         {get_param: Image}
152       flavor: {get_param: Flavor}
153       key_name: {get_param: KeyName}
154       networks:
155         - network: ctlplane
156       user_data_format: SOFTWARE_CONFIG
157       user_data: {get_resource: UserData}
158       name:
159         str_replace:
160             template: {get_param: Hostname}
161             params: {get_param: HostnameMap}
162       software_config_transport: {get_param: SoftwareConfigTransport}
163       metadata: {get_param: ServerMetadata}
164       scheduler_hints: {get_param: SchedulerHints}
165
166   # Combine the NodeAdminUserData and NodeUserData mime archives
167   UserData:
168     type: OS::Heat::MultipartMime
169     properties:
170       parts:
171       - config: {get_resource: NodeAdminUserData}
172         type: multipart
173       - config: {get_resource: NodeUserData}
174         type: multipart
175
176   # Creates the "heat-admin" user if configured via the environment
177   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
178   NodeAdminUserData:
179     type: OS::TripleO::NodeAdminUserData
180
181   # For optional operator additional userdata
182   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
183   NodeUserData:
184     type: OS::TripleO::NodeUserData
185
186   ExternalPort:
187     type: OS::TripleO::BlockStorage::Ports::ExternalPort
188     properties:
189       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
190
191   InternalApiPort:
192     type: OS::TripleO::BlockStorage::Ports::InternalApiPort
193     properties:
194       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
195
196   StoragePort:
197     type: OS::TripleO::BlockStorage::Ports::StoragePort
198     properties:
199       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
200
201   StorageMgmtPort:
202     type: OS::TripleO::BlockStorage::Ports::StorageMgmtPort
203     properties:
204       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
205
206   TenantPort:
207     type: OS::TripleO::BlockStorage::Ports::TenantPort
208     properties:
209       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
210
211   ManagementPort:
212     type: OS::TripleO::BlockStorage::Ports::ManagementPort
213     properties:
214       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
215
216   NetworkConfig:
217     type: OS::TripleO::BlockStorage::Net::SoftwareConfig
218     properties:
219       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
220       ExternalIpSubnet: {get_attr: [ExternalPort, ip_subnet]}
221       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
222       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
223       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
224       TenantIpSubnet: {get_attr: [TenantPort, ip_subnet]}
225       ManagementIpSubnet: {get_attr: [ManagementPort, ip_subnet]}
226
227   NetIpMap:
228     type: OS::TripleO::Network::Ports::NetIpMap
229     properties:
230       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
231       ExternalIp: {get_attr: [ExternalPort, ip_address]}
232       InternalApiIp: {get_attr: [InternalApiPort, ip_address]}
233       StorageIp: {get_attr: [StoragePort, ip_address]}
234       StorageMgmtIp: {get_attr: [StorageMgmtPort, ip_address]}
235       TenantIp: {get_attr: [TenantPort, ip_address]}
236       ManagementIp: {get_attr: [ManagementPort, ip_address]}
237
238   NetworkDeployment:
239     type: OS::TripleO::SoftwareDeployment
240     properties:
241       name: NetworkDeployment
242       config: {get_resource: NetworkConfig}
243       server: {get_resource: BlockStorage}
244       actions: {get_param: NetworkDeploymentActions}
245
246   BlockStorageDeployment:
247     type: OS::Heat::StructuredDeployment
248     depends_on: NetworkDeployment
249     properties:
250       name: BlockStorageDeployment
251       server: {get_resource: BlockStorage}
252       config: {get_resource: BlockStorageConfig}
253       input_values:
254         debug: {get_param: Debug}
255         cinder_dsn: {list_join: ['', ['mysql+pymysql://cinder:', {get_param: CinderPassword}, '@', {get_param: MysqlVirtualIP} , '/cinder']]}
256         snmpd_readonly_user_name: {get_param: SnmpdReadonlyUserName}
257         snmpd_readonly_user_password: {get_param: SnmpdReadonlyUserPassword}
258         cinder_lvm_loop_device_size:
259           str_replace:
260             template: sizeM
261             params:
262               size: {get_param: CinderLVMLoopDeviceSize}
263         cinder_enable_iscsi_backend: {get_param: CinderEnableIscsiBackend}
264         cinder_iscsi_helper: {get_param: CinderISCSIHelper}
265         cinder_iscsi_ip_address: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, CinderIscsiNetwork]}]}
266         glance_api_servers: {get_param: [EndpointMap, GlanceInternal, uri]}
267         rabbit_username: {get_param: RabbitUserName}
268         rabbit_password: {get_param: RabbitPassword}
269         rabbit_client_use_ssl: {get_param: RabbitClientUseSSL}
270         rabbit_client_port: {get_param: RabbitClientPort}
271         ntp_servers: {get_param: NtpServer}
272         timezone: {get_param: TimeZone}
273         enable_package_install: {get_param: EnablePackageInstall}
274         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
275
276   # Map heat metadata into hiera datafiles
277   BlockStorageConfig:
278     type: OS::Heat::StructuredConfig
279     properties:
280       group: os-apply-config
281       config:
282         hiera:
283           hierarchy:
284             - '"%{::uuid}"'
285             - heat_config_%{::deploy_config_name}
286             - volume_extraconfig
287             - extraconfig
288             - volume
289             - all_nodes # provided by allNodesConfig
290             - '"%{::osfamily}"'
291             - common
292           datafiles:
293             common:
294               raw_data: {get_file: hieradata/common.yaml}
295             volume_extraconfig:
296               mapped_data: {get_param: BlockStorageExtraConfig}
297             extraconfig:
298               mapped_data: {get_param: ExtraConfig}
299             volume:
300               raw_data: {get_file: hieradata/volume.yaml}
301               mapped_data:
302                 # Cinder
303                 cinder::debug: {get_input: debug}
304                 cinder::setup_test_volume::size: {get_input: cinder_lvm_loop_device_size}
305                 cinder_iscsi_helper: {get_input: cinder_iscsi_helper}
306                 cinder::database_connection: {get_input: cinder_dsn}
307                 cinder::rabbit_userid: {get_input: rabbit_username}
308                 cinder::rabbit_password: {get_input: rabbit_password}
309                 cinder::rabbit_use_ssl: {get_input: rabbit_client_use_ssl}
310                 cinder::rabbit_port: {get_input: rabbit_client_port}
311                 cinder_enable_iscsi_backend: {get_input: cinder_enable_iscsi_backend}
312                 cinder_iscsi_ip_address: {get_input: cinder_iscsi_ip_address}
313                 cinder::glance::glance_api_servers: {get_input: glance_api_servers}
314                 ntp::servers: {get_input: ntp_servers}
315                 timezone::timezone: {get_input: timezone}
316                 tripleo::packages::enable_install: {get_input: enable_package_install}
317                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
318                 snmpd_readonly_user_name: {get_input: snmpd_readonly_user_name}
319                 snmpd_readonly_user_password: {get_input: snmpd_readonly_user_password}
320
321   # Resource for site-specific injection of root certificate
322   NodeTLSCAData:
323     depends_on: BlockStorageDeployment
324     type: OS::TripleO::NodeTLSCAData
325     properties:
326       server: {get_resource: BlockStorage}
327
328   # Hook for site-specific additional pre-deployment config,
329   # applying to all nodes, e.g node registration/unregistration
330   NodeExtraConfig:
331     depends_on: NodeTLSCAData
332     type: OS::TripleO::NodeExtraConfig
333     properties:
334         server: {get_resource: BlockStorage}
335
336   UpdateConfig:
337     type: OS::TripleO::Tasks::PackageUpdate
338
339   UpdateDeployment:
340     type: OS::Heat::SoftwareDeployment
341     properties:
342       name: UpdateDeployment
343       config: {get_resource: UpdateConfig}
344       server: {get_resource: BlockStorage}
345       input_values:
346         update_identifier:
347           get_param: UpdateIdentifier
348
349 outputs:
350   hosts_entry:
351     value:
352       str_replace:
353         template: "IP HOST.DOMAIN HOST"
354         params:
355           IP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, BlockStorageHostnameResolveNetwork]}]}
356           DOMAIN: {get_param: CloudDomain}
357           HOST: {get_attr: [BlockStorage, name]}
358   nova_server_resource:
359     description: Heat resource handle for the block storage server
360     value:
361       {get_resource: BlockStorage}
362   external_ip_address:
363     description: IP address of the server in the external network
364     value: {get_attr: [ExternalPort, ip_address]}
365   internal_api_ip_address:
366     description: IP address of the server in the internal_api network
367     value: {get_attr: [InternalApiPort, ip_address]}
368   storage_ip_address:
369     description: IP address of the server in the storage network
370     value: {get_attr: [StoragePort, ip_address]}
371   storage_mgmt_ip_address:
372     description: IP address of the server in the storage_mgmt network
373     value: {get_attr: [StorageMgmtPort, ip_address]}
374   tenant_ip_address:
375     description: IP address of the server in the tenant network
376     value: {get_attr: [TenantPort, ip_address]}
377   management_ip_address:
378     description: IP address of the server in the management network
379     value: {get_attr: [ManagementPort, ip_address]}
380   config_identifier:
381     description: identifier which changes if the node configuration may need re-applying
382     value:
383       list_join:
384         - ''
385         - - {get_attr: [BlockStorageDeployment, deploy_stdout]}
386           - {get_attr: [NodeTLSCAData, deploy_stdout]}
387           - {get_param: UpdateIdentifier}