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