Merge "Remove unsafe "unset" defaults"
[apex-tripleo-heat-templates.git] / puppet / swift-storage.yaml
1 heat_template_version: 2015-04-30
2 description: 'OpenStack swift storage node configured by Puppet'
3 parameters:
4   Flavor:
5     description: Flavor for Swift storage nodes to request when deploying.
6     type: string
7     constraints:
8       - custom_constraint: nova.flavor
9   HashSuffix:
10     description: A random string to be used as a salt when hashing to determine mappings
11       in the ring.
12     hidden: true
13     type: string
14   Image:
15     default: overcloud-swift-storage
16     type: string
17   KeyName:
18     default: default
19     description: Name of an existing Nova key pair to enable SSH access to the instances
20     type: string
21   MountCheck:
22     default: 'false'
23     description: Value of mount_check in Swift account/container/object -server.conf
24     type: boolean
25   MinPartHours:
26     type: number
27     default: 1
28     description: The minimum time (in hours) before a partition in a ring can be moved following a rebalance.
29   PartPower:
30     default: 10
31     description: Partition Power to use when building Swift rings
32     type: number
33   Replicas:
34     type: number
35     default: 3
36     description: How many replicas to use in the swift rings.
37   SnmpdReadonlyUserName:
38     default: ro_snmp_user
39     description: The user name for SNMPd with readonly rights running on all Overcloud nodes
40     type: string
41   SnmpdReadonlyUserPassword:
42     description: The user password for SNMPd with readonly rights running on all Overcloud nodes
43     type: string
44     hidden: true
45   NtpServer:
46     default: ''
47     description: Comma-separated list of ntp servers
48     type: comma_delimited_list
49   EnablePackageInstall:
50     default: 'false'
51     description: Set to true to enable package installation via Puppet
52     type: boolean
53   UpdateIdentifier:
54     default: ''
55     type: string
56     description: >
57       Setting to a previously unused value during stack-update will trigger
58       package update on all nodes
59   ServiceNetMap:
60     default: {}
61     description: Mapping of service_name -> network name. Typically set
62                  via parameter_defaults in the resource registry.
63     type: json
64   Hostname:
65     type: string
66     default: '' # Defaults to Heat created hostname
67   ExtraConfig:
68     default: {}
69     description: |
70       Additional hiera configuration to inject into the cluster. Note
71       that ObjectStorageExtraConfig takes precedence over ExtraConfig.
72     type: json
73   ObjectStorageExtraConfig:
74     default: {}
75     description: |
76       Role specific additional hiera configuration to inject into the cluster.
77     type: json
78   NetworkDeploymentActions:
79     type: comma_delimited_list
80     description: >
81       Heat action when to apply network configuration changes
82     default: ['CREATE']
83   SoftwareConfigTransport:
84     default: POLL_SERVER_CFN
85     description: |
86       How the server should receive the metadata required for software configuration.
87     type: string
88     constraints:
89     - allowed_values: [POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE]
90   CloudDomain:
91     default: ''
92     type: string
93     description: >
94       The DNS domain used for the hosts. This should match the dhcp_domain
95       configured in the Undercloud neutron. Defaults to localdomain.
96   ServerMetadata:
97     default: {}
98     description: >
99       Extra properties or metadata passed to Nova for the created nodes in
100       the overcloud. It's accessible via the Nova metadata API.
101     type: json
102   SchedulerHints:
103     type: json
104     description: Optional scheduler hints to pass to nova
105     default: {}
106
107 resources:
108
109   SwiftStorage:
110     type: OS::Nova::Server
111     properties:
112       image: {get_param: Image}
113       flavor: {get_param: Flavor}
114       key_name: {get_param: KeyName}
115       networks:
116         - network: ctlplane
117       user_data_format: SOFTWARE_CONFIG
118       user_data: {get_resource: UserData}
119       name: {get_param: Hostname}
120       software_config_transport: {get_param: SoftwareConfigTransport}
121       metadata: {get_param: ServerMetadata}
122       scheduler_hints: {get_param: SchedulerHints}
123
124   # Combine the NodeAdminUserData and NodeUserData mime archives
125   UserData:
126     type: OS::Heat::MultipartMime
127     properties:
128       parts:
129       - config: {get_resource: NodeAdminUserData}
130         type: multipart
131       - config: {get_resource: NodeUserData}
132         type: multipart
133
134   # Creates the "heat-admin" user if configured via the environment
135   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
136   NodeAdminUserData:
137     type: OS::TripleO::NodeAdminUserData
138
139   # For optional operator additional userdata
140   # Should return a OS::Heat::MultipartMime reference via OS::stack_id
141   NodeUserData:
142     type: OS::TripleO::NodeUserData
143
144   InternalApiPort:
145     type: OS::TripleO::SwiftStorage::Ports::InternalApiPort
146     properties:
147       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
148
149   StoragePort:
150     type: OS::TripleO::SwiftStorage::Ports::StoragePort
151     properties:
152       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
153
154   StorageMgmtPort:
155     type: OS::TripleO::SwiftStorage::Ports::StorageMgmtPort
156     properties:
157       ControlPlaneIP: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
158
159   NetworkConfig:
160     type: OS::TripleO::ObjectStorage::Net::SoftwareConfig
161     properties:
162       ControlPlaneIp: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
163       InternalApiIpSubnet: {get_attr: [InternalApiPort, ip_subnet]}
164       StorageIpSubnet: {get_attr: [StoragePort, ip_subnet]}
165       StorageMgmtIpSubnet: {get_attr: [StorageMgmtPort, ip_subnet]}
166
167   NetIpMap:
168     type: OS::TripleO::Network::Ports::NetIpMap
169     properties:
170       ControlPlaneIp: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
171       InternalApiIp: {get_attr: [InternalApiPort, ip_address]}
172       StorageIp: {get_attr: [StoragePort, ip_address]}
173       StorageMgmtIp: {get_attr: [StorageMgmtPort, ip_address]}
174
175   NetworkDeployment:
176     type: OS::TripleO::SoftwareDeployment
177     properties:
178       config: {get_resource: NetworkConfig}
179       server: {get_resource: SwiftStorage}
180       actions: {get_param: NetworkDeploymentActions}
181
182   SwiftStorageHieraConfig:
183     type: OS::Heat::StructuredConfig
184     properties:
185       group: os-apply-config
186       config:
187         hiera:
188           hierarchy:
189             - '"%{::uuid}"'
190             - heat_config_%{::deploy_config_name}
191             - object_extraconfig
192             - extraconfig
193             - object
194             - swift_devices_and_proxy # provided by SwiftDevicesAndProxyConfig
195             - all_nodes # provided by allNodesConfig
196             - '"%{::osfamily}"'
197             - common
198           datafiles:
199             common:
200               raw_data: {get_file: hieradata/common.yaml}
201             object_extraconfig:
202               mapped_data: {get_param: ObjectStorageExtraConfig}
203             extraconfig:
204               mapped_data: {get_param: ExtraConfig}
205             object:
206               raw_data: {get_file: hieradata/object.yaml}
207               mapped_data: # data supplied directly to this deployment configuration, etc
208                 swift::swift_hash_suffix: { get_input: swift_hash_suffix }
209                 tripleo::ringbuilder::part_power: { get_input: swift_part_power }
210                 tripleo::ringbuilder::replicas: {get_input: swift_replicas }
211                 # Swift
212                 swift::storage::all::storage_local_net_ip: {get_input: swift_management_network}
213                 swift_mount_check: {get_input: swift_mount_check }
214                 tripleo::ringbuilder::min_part_hours: { get_input: swift_min_part_hours }
215                 ntp::servers: {get_input: ntp_servers}
216                 # NOTE(dprince): build_ring support is currently not wired in.
217                 # See: https://review.openstack.org/#/c/109225/
218                 tripleo::ringbuilder::build_ring: True
219                 snmpd_readonly_user_name: {get_input: snmpd_readonly_user_name}
220                 snmpd_readonly_user_password: {get_input: snmpd_readonly_user_password}
221                 tripleo::packages::enable_install: {get_input: enable_package_install}
222                 tripleo::packages::enable_upgrade: {get_input: enable_package_upgrade}
223
224
225   SwiftStorageHieraDeploy:
226     type: OS::Heat::StructuredDeployment
227     depends_on: NetworkDeployment
228     properties:
229       server: {get_resource: SwiftStorage}
230       config: {get_resource: SwiftStorageHieraConfig}
231       input_values:
232         local_ip: {get_attr: [SwiftStorage, networks, ctlplane, 0]}
233         snmpd_readonly_user_name: {get_param: SnmpdReadonlyUserName}
234         snmpd_readonly_user_password: {get_param: SnmpdReadonlyUserPassword}
235         swift_hash_suffix: {get_param: HashSuffix}
236         swift_mount_check: {get_param: MountCheck}
237         swift_min_part_hours: {get_param: MinPartHours}
238         swift_part_power: {get_param: PartPower}
239         swift_replicas: { get_param: Replicas}
240         ntp_servers: {get_param: NtpServer}
241         enable_package_install: {get_param: EnablePackageInstall}
242         enable_package_upgrade: {get_attr: [UpdateDeployment, update_managed_packages]}
243         swift_management_network: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, SwiftMgmtNetwork]}]}
244
245   # Resource for site-specific injection of root certificate
246   NodeTLSCAData:
247     depends_on: SwiftStorageHieraDeploy
248     type: OS::TripleO::NodeTLSCAData
249     properties:
250       server: {get_resource: SwiftStorage}
251
252   # Hook for site-specific additional pre-deployment config,
253   # applying to all nodes, e.g node registration/unregistration
254   NodeExtraConfig:
255     depends_on: NodeTLSCAData
256     type: OS::TripleO::NodeExtraConfig
257     properties:
258         server: {get_resource: SwiftStorage}
259
260   UpdateConfig:
261     type: OS::TripleO::Tasks::PackageUpdate
262
263   UpdateDeployment:
264     type: OS::Heat::SoftwareDeployment
265     properties:
266       config: {get_resource: UpdateConfig}
267       server: {get_resource: SwiftStorage}
268       input_values:
269         update_identifier:
270           get_param: UpdateIdentifier
271
272 outputs:
273   hosts_entry:
274     value:
275       str_replace:
276         template: "IP HOST.DOMAIN HOST"
277         params:
278           IP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, ObjectStorageHostnameResolveNetwork]}]}
279           DOMAIN: {get_param: CloudDomain}
280           HOST: {get_attr: [SwiftStorage, name]}
281   nova_server_resource:
282     description: Heat resource handle for the swift storage server
283     value:
284       {get_resource: SwiftStorage}
285   swift_device:
286     description: Swift device formatted for swift-ring-builder
287     value:
288       str_replace:
289         template: 'r1z1-IP:%PORT%/d1'
290         params:
291           IP: {get_attr: [NetIpMap, net_ip_map, {get_param: [ServiceNetMap, SwiftMgmtNetwork]}]}
292   internal_api_ip_address:
293     description: IP address of the server in the internal_api network
294     value: {get_attr: [InternalApiPort, ip_address]}
295   storage_ip_address:
296     description: IP address of the server in the storage network
297     value: {get_attr: [StoragePort, ip_address]}
298   storage_mgmt_ip_address:
299     description: IP address of the server in the storage_mgmt network
300     value: {get_attr: [StorageMgmtPort, ip_address]}
301   config_identifier:
302     description: identifier which changes if the node configuration may need re-applying
303     value:
304       list_join:
305         - ','
306         - - {get_attr: [SwiftStorageHieraDeploy, deploy_stdout]}
307           - {get_attr: [NodeTLSCAData, deploy_stdout]}
308           - {get_param: UpdateIdentifier}