summaryrefslogtreecommitdiffstats
path: root/base/server/python/pki/server/deployment/scriptlets/instance_layout.py
blob: eeca2bc0f9217988f9dcd74179ea1ba7498a4019 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# Authors:
# Matthew Harmsen <mharmsen@redhat.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright (C) 2012 Red Hat, Inc.
# All rights reserved.
#

# System Imports
from __future__ import absolute_import
import os

# PKI Deployment Imports
from .. import pkiconfig as config
from .. import pkimessages as log
from .. import pkiscriptlet


# PKI Deployment Instance Layout Scriptlet
class PkiScriptlet(pkiscriptlet.AbstractBasePkiScriptlet):
    rv = 0

    def spawn(self, deployer):

        if config.str2bool(deployer.mdict['pki_skip_installation']):
            config.pki_log.info(log.SKIP_INSTANCE_SPAWN_1, __name__,
                                extra=config.PKI_INDENTATION_LEVEL_1)
            return self.rv

        config.pki_log.info(log.INSTANCE_SPAWN_1, __name__,
                            extra=config.PKI_INDENTATION_LEVEL_1)

        # if this is the first subsystem
        if len(deployer.instance.tomcat_instance_subsystems()) == 1:

            # establish instance logs
            deployer.directory.create(deployer.mdict['pki_instance_log_path'])

            # copy /usr/share/pki/server/conf tree into
            # /var/lib/pki/<instance>/conf
            # except common ldif files and theme deployment descriptor
            deployer.directory.copy(
                deployer.mdict['pki_source_server_path'],
                deployer.mdict['pki_instance_configuration_path'],
                ignore_cb=file_ignore_callback_src_server)

            # Deploy ROOT web application
            deployer.deploy_webapp(
                "ROOT",
                os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    "server",
                    "webapps",
                    "ROOT"),
                os.path.join(
                    deployer.mdict['pki_source_server_path'],
                    "Catalina",
                    "localhost",
                    "ROOT.xml"))

            if os.path.exists(deployer.mdict['pki_theme_server_dir']):
                # Deploy theme web application if available
                deployer.deploy_webapp(
                    "pki",
                    deployer.mdict['pki_theme_server_dir'],
                    os.path.join(
                        deployer.mdict['pki_source_server_path'],
                        "Catalina",
                        "localhost",
                        "pki.xml"))

            # Deploy admin templates
            deployer.deploy_webapp(
                "pki#admin",
                os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    "server",
                    "webapps",
                    "pki",
                    "admin"),
                os.path.join(
                    deployer.mdict['pki_source_server_path'],
                    "Catalina",
                    "localhost",
                    "pki#admin.xml"))

            # Deploy JS library
            deployer.deploy_webapp(
                "pki#js",
                os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    "server",
                    "webapps",
                    "pki",
                    "js"),
                os.path.join(
                    deployer.mdict['pki_source_server_path'],
                    "Catalina",
                    "localhost",
                    "pki#js.xml"))

            # establish Tomcat instance base
            deployer.directory.create(deployer.mdict['pki_tomcat_common_path'])
            deployer.directory.create(
                deployer.mdict['pki_tomcat_common_lib_path'])
            # establish Tomcat instance library
            deployer.directory.create(deployer.mdict['pki_instance_lib'])
            for name in os.listdir(deployer.mdict['pki_tomcat_lib_path']):
                deployer.symlink.create(
                    os.path.join(
                        deployer.mdict['pki_tomcat_lib_path'],
                        name),
                    os.path.join(
                        deployer.mdict['pki_instance_lib'],
                        name))
            deployer.symlink.create(
                deployer.mdict['pki_instance_conf_log4j_properties'],
                deployer.mdict['pki_instance_lib_log4j_properties'])
            deployer.directory.create(deployer.mdict['pki_tomcat_tmpdir_path'])

            deployer.directory.create(deployer.mdict['pki_tomcat_work_path'])
            deployer.directory.create(
                deployer.mdict['pki_tomcat_work_catalina_path'])
            deployer.directory.create(
                deployer.mdict['pki_tomcat_work_catalina_host_path'])
            deployer.directory.create(
                deployer.mdict['pki_tomcat_work_catalina_host_run_path'])
            deployer.directory.create(
                deployer.mdict['pki_tomcat_work_catalina_host_subsystem_path'])
            # establish Tomcat instance logs
            # establish Tomcat instance registry
            # establish Tomcat instance convenience symbolic links
            deployer.symlink.create(
                deployer.mdict['pki_tomcat_bin_path'],
                deployer.mdict['pki_tomcat_bin_link'])
            deployer.symlink.create(
                deployer.mdict['pki_tomcat_systemd'],
                deployer.mdict['pki_instance_systemd_link'],
                uid=0, gid=0)
            # establish Tomcat instance common lib jar symbolic links
            deployer.symlink.create(
                deployer.mdict['pki_apache_commons_collections_jar'],
                deployer.mdict['pki_apache_commons_collections_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_apache_commons_io_jar'],
                deployer.mdict['pki_apache_commons_io_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_apache_commons_lang_jar'],
                deployer.mdict['pki_apache_commons_lang_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_apache_commons_logging_jar'],
                deployer.mdict['pki_apache_commons_logging_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_commons_codec_jar'],
                deployer.mdict['pki_commons_codec_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_httpclient_jar'],
                deployer.mdict['pki_httpclient_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_httpcore_jar'],
                deployer.mdict['pki_httpcore_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_javassist_jar'],
                deployer.mdict['pki_javassist_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_jss_jar'],
                deployer.mdict['pki_jss_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_ldapjdk_jar'],
                deployer.mdict['pki_ldapjdk_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_tomcat_jar'],
                deployer.mdict['pki_tomcat_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_scannotation_jar'],
                deployer.mdict['pki_scannotation_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_tomcatjss_jar'],
                deployer.mdict['pki_tomcatjss_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_velocity_jar'],
                deployer.mdict['pki_velocity_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_xerces_j2_jar'],
                deployer.mdict['pki_xerces_j2_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_xml_commons_apis_jar'],
                deployer.mdict['pki_xml_commons_apis_jar_link'])
            deployer.symlink.create(
                deployer.mdict['pki_xml_commons_resolver_jar'],
                deployer.mdict['pki_xml_commons_resolver_jar_link'])

            # Jackson
            deployer.symlink.create(
                deployer.mdict['pki_jackson_core_asl_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'jackson-core-asl.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_jackson_jaxrs_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'jackson-jaxrs.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_jackson_mapper_asl_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'jackson-mapper-asl.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_jackson_mrbean_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'jackson-mrbean.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_jackson_smile_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'jackson-smile.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_jackson_xc_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'jackson-xc.jar'))

            # RESTEasy
            deployer.symlink.create(
                deployer.mdict['pki_resteasy_atom_provider_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'resteasy-atom-provider.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_resteasy_client_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'resteasy-client.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_resteasy_jaxb_provider_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'resteasy-jaxb-provider.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_resteasy_jaxrs_api_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'jaxrs-api.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_resteasy_jaxrs_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'resteasy-jaxrs.jar'))
            deployer.symlink.create(
                deployer.mdict['pki_resteasy_jackson_provider_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'resteasy-jackson-provider.jar'))

            # nuxwdog
            deployer.symlink.create(
                deployer.mdict['pki_nuxwdog_client_jar'],
                os.path.join(
                    deployer.mdict['pki_tomcat_common_lib_path'],
                    'nuxwdog.jar'))

            # establish shared NSS security databases for this instance
            deployer.directory.create(deployer.mdict['pki_database_path'])
            # establish instance convenience symbolic links
            deployer.symlink.create(
                deployer.mdict['pki_database_path'],
                deployer.mdict['pki_instance_database_link'])
            deployer.symlink.create(
                deployer.mdict['pki_instance_configuration_path'],
                deployer.mdict['pki_instance_conf_link'])
            deployer.symlink.create(
                deployer.mdict['pki_instance_log_path'],
                deployer.mdict['pki_instance_logs_link'])

            # create the sym link to symkey regardless of subsystem
            # as long as pki-symkey is installed on the system
            if os.path.exists(deployer.mdict['pki_symkey_jar']):
                if not os.path.exists(deployer.mdict['pki_symkey_jar_link']):
                    deployer.symlink.create(
                        deployer.mdict['pki_symkey_jar'],
                        deployer.mdict['pki_symkey_jar_link'])
        return self.rv

    def destroy(self, deployer):

        config.pki_log.info(log.INSTANCE_DESTROY_1, __name__,
                            extra=config.PKI_INDENTATION_LEVEL_1)

        if len(deployer.instance.tomcat_instance_subsystems()) == 0:
            # remove Tomcat instance base
            deployer.directory.delete(deployer.mdict['pki_instance_path'])
            # remove Tomcat instance logs
            deployer.directory.delete(deployer.mdict['pki_instance_log_path'])
            # remove shared NSS security database path for this instance
            deployer.directory.delete(deployer.mdict['pki_database_path'])
            # remove Tomcat instance configuration
            deployer.directory.delete(
                deployer.mdict['pki_instance_configuration_path'])
            # remove PKI 'tomcat.conf' instance file
            deployer.file.delete(
                deployer.mdict['pki_target_tomcat_conf_instance_id'])
            # remove Tomcat instance registry
            deployer.directory.delete(
                deployer.mdict['pki_instance_registry_path'])
            # remove Tomcat PKI registry (if empty)
            if deployer.instance.tomcat_instances() == 0:
                deployer.directory.delete(
                    deployer.mdict['pki_instance_type_registry_path'])

        return self.rv


# Callback only when the /usr/share/pki/server/conf directory
# Is getting copied to the etc tree.
# Don't copy the shared ldif files:
# schema.ldif, manager.ldif, database.ldif
def file_ignore_callback_src_server(src, names):
    config.pki_log.info(log.FILE_EXCLUDE_CALLBACK_2, src, names,
                        extra=config.PKI_INDENTATION_LEVEL_1)

    excludes = {'schema.ldif', 'database.ldif', 'manager.ldif', 'pki.xml'}
    return excludes