Merge "Fix typo in HostsEntry output description"
[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 Nova key pair 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   CloudDomain:
116     default: ''
117     type: string
118     description: >
119       The DNS domain used for the hosts. This should match the dhcp_domain
120       configured in the Undercloud neutron. Defaults to localdomain.
121   ServerMetadata:
122     default: {}
123     description: >
124       Extra properties or metadata passed to Nova for the created nodes in
125       the overcloud. It's accessible via the Nova metadata API.
126     type: json
127   SchedulerHints:
128     type: json
129     description: Optional scheduler hints to pass to nova
130     default: {}
131
132
133 resources:
134   BlockStorage:
135     type: OS::Nova::Server
136     properties:
137       image:
138         {get_param: Image}
139       flavor: {get_param: Flavor}
140       key_name: {get_param: KeyName}
141       networks:
142         - network: ctlplane
143       user_data_format: SOFTWARE_CONFIG
144       user_data: {get_resource: UserData}
145       name: {get_param: Hostname}
146       metadata: {get_param: ServerMetadata}
147       scheduler_hints: {get_param: SchedulerHints}
148
149   # Combine the NodeAdminUserData and NodeUserData mime archives
150   UserData:
151     type: OS::Heat::MultipartMime
152     properties:
153       parts:
154       - config: {get_resource: NodeAdminUserData}
155         type: multipart
156       - config: {get_resource: NodeUserData}
157         type: multipart
158
159   # Creates the "heat-admin" user if configured via the environment
160   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
161   NodeAdminUserData:
162     type: OS::TripleO::NodeAdminUserData
163
164   # For optional operator additional userdata
165   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
166   NodeUserData:
167     type: OS::TripleO::NodeUserData
168
169   InternalApiPort:
170     type: OS::TripleO::BlockStorage::Ports::InternalApiPort
171     properties:
172       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
173
174   StoragePort:
175     type: OS::TripleO::BlockStorage::Ports::StoragePort
176     properties:
177       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
178
179   StorageMgmtPort:
180     type: OS::TripleO::BlockStorage::Ports::StorageMgmtPort
181     properties:
182       ControlPlaneIP: {get_attr: [BlockStorage, networks, ctlplane, 0]}
183
184   NetworkConfig:
185     type: OS::TripleO::BlockStorage::Net::SoftwareConfig
186     properties:
187       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
188       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
189       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
190       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
191
192   NetIpMap:
193     type: OS::TripleO::Network::Ports::NetIpMap
194     properties:
195       ControlPlaneIp: {get_attr: [BlockStorage, networks, ctlplane, 0]}
196       InternalApiIp: {get_attr: [InternalApiPort, ip_address]}
197       StorageIp: {get_attr: [StoragePort, ip_address]}
198       StorageMgmtIp: {get_attr: [StorageMgmtPort, ip_address]}
199
200   NetworkDeployment:
201     type: OS::TripleO::SoftwareDeployment
202     properties:
203       config: {get_resource: NetworkConfig}
204       server: {get_resource: BlockStorage}
205       actions: {get_param: NetworkDeploymentActions}
206
207   BlockStorageDeployment:
208     type: OS::Heat::StructuredDeployment
209     depends_on: NetworkDeployment
210     properties:
211       server: {get_resource: BlockStorage}
212       config: {get_resource: BlockStorageConfig}
213       input_values:
214         debug: {get_param: Debug}
215         cinder_dsn: {list_join: ['', ['mysql://cinder:', {get_param: CinderPassword}, '@', {get_param: MysqlVirtualIP} , '/cinder']]}
216         snmpd_readonly_user_name: {get_param: SnmpdReadonlyUserName}
217         snmpd_readonly_user_password: {get_param: SnmpdReadonlyUserPassword}
218         cinder_lvm_loop_device_size:
219           str_replace:
220             template: sizeM
221             params:
222               size: {get_param: CinderLVMLoopDeviceSize}
223         cinder_enable_iscsi_backend: {get_param: CinderEnableIscsiBackend}
224         cinder_iscsi_helper: {get_param: CinderISCSIHelper}
225         cinder_iscsi_ip_address: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, CinderIscsiNetwork]}]}
226         glance_api_servers: {get_param: [EndpointMap, GlanceInternal, uri]}
227         rabbit_username: {get_param: RabbitUserName}
228         rabbit_password: {get_param: RabbitPassword}
229         rabbit_client_use_ssl: {get_param: RabbitClientUseSSL}
230         rabbit_client_port: {get_param: RabbitClientPort}
231         ntp_servers: {get_param: NtpServer}
232         enable_package_install: {get_param: EnablePackageInstall}
233         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
234
235   # Map heat metadata into hiera datafiles
236   BlockStorageConfig:
237     type: OS::Heat::StructuredConfig
238     properties:
239       group: os-apply-config
240       config:
241         hiera:
242           hierarchy:
243             - '"%{::uuid}"'
244             - heat_config_%{::deploy_config_name}
245             - volume_extraconfig
246             - extraconfig
247             - volume
248             - all_nodes # provided by allNodesConfig
249             - '"%{::osfamily}"'
250             - common
251           datafiles:
252             common:
253               raw_data: {get_file: hieradata/common.yaml}
254             volume_extraconfig:
255               mapped_data: {get_param: BlockStorageExtraConfig}
256             extraconfig:
257               mapped_data: {get_param: ExtraConfig}
258             volume:
259               raw_data: {get_file: hieradata/volume.yaml}
260               mapped_data:
261                 # Cinder
262                 cinder::debug: {get_input: debug}
263                 cinder::setup_test_volume::size: {get_input: cinder_lvm_loop_device_size}
264                 cinder_iscsi_helper: {get_input: cinder_iscsi_helper}
265                 cinder::database_connection: {get_input: cinder_dsn}
266                 cinder::rabbit_userid: {get_input: rabbit_username}
267                 cinder::rabbit_password: {get_input: rabbit_password}
268                 cinder::rabbit_use_ssl: {get_input: rabbit_client_use_ssl}
269                 cinder::rabbit_port: {get_input: rabbit_client_port}
270                 cinder_enable_iscsi_backend: {get_input: cinder_enable_iscsi_backend}
271                 cinder_iscsi_ip_address: {get_input: cinder_iscsi_ip_address}
272                 cinder::glance::glance_api_servers: {get_input: glance_api_servers}
273                 ntp::servers: {get_input: ntp_servers}
274                 tripleo::packages::enable_install: {get_input: enable_package_install}
275                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
276                 snmpd_readonly_user_name: {get_input: snmpd_readonly_user_name}
277                 snmpd_readonly_user_password: {get_input: snmpd_readonly_user_password}
278
279   # Resource for site-specific injection of root certificate
280   NodeTLSCAData:
281     depends_on: BlockStorageDeployment
282     type: OS::TripleO::NodeTLSCAData
283     properties:
284       server: {get_resource: BlockStorage}
285
286   # Hook for site-specific additional pre-deployment config,
287   # applying to all nodes, e.g node registration/unregistration
288   NodeExtraConfig:
289     depends_on: NodeTLSCAData
290     type: OS::TripleO::NodeExtraConfig
291     properties:
292         server: {get_resource: BlockStorage}
293
294   UpdateConfig:
295     type: OS::TripleO::Tasks::PackageUpdate
296
297   UpdateDeployment:
298     type: OS::Heat::SoftwareDeployment
299     properties:
300       config: {get_resource: UpdateConfig}
301       server: {get_resource: BlockStorage}
302       input_values:
303         update_identifier:
304           get_param: UpdateIdentifier
305
306 outputs:
307   hosts_entry:
308     value:
309       str_replace:
310         template: "IP HOST.DOMAIN HOST"
311         params:
312           IP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, BlockStorageHostnameResolveNetwork]}]}
313           DOMAIN: {get_param: CloudDomain}
314           HOST: {get_attr: [BlockStorage, name]}
315   nova_server_resource:
316     description: Heat resource handle for the block storage server
317     value:
318       {get_resource: BlockStorage}
319   internal_api_ip_address:
320     description: IP address of the server in the internal_api network
321     value: {get_attr: [InternalApiPort, ip_address]}
322   storage_ip_address:
323     description: IP address of the server in the storage network
324     value: {get_attr: [StoragePort, ip_address]}
325   storage_mgmt_ip_address:
326     description: IP address of the server in the storage_mgmt network
327     value: {get_attr: [StorageMgmtPort, ip_address]}
328   config_identifier:
329     description: identifier which changes if the node configuration may need re-applying
330     value:
331       list_join:
332         - ''
333         - - {get_attr: [BlockStorageDeployment, deploy_stdout]}
334           - {get_attr: [NodeTLSCAData, deploy_stdout]}
335           - {get_param: UpdateIdentifier}