summaryrefslogtreecommitdiffstats
path: root/base/deploy/src/scriptlets/instance_layout.py
blob: 0df418165ed43bb112e5179985025ebe58c7f0dc (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
#!/usr/bin/python -t
# 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
import os


# PKI Deployment Imports
import pkiconfig as config
from pkiconfig import pki_master_dict as master
import pkihelper as util
import pkimessages as log
import pkiscriptlet
import os


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

    def spawn(self):
        if config.str2bool(master['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)
        # establish instance logs
        util.directory.create(master['pki_instance_log_path'])
        # establish instance configuration
        util.directory.create(master['pki_instance_configuration_path'])
        # establish Apache/Tomcat specific instance
        if master['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS:
            # establish Tomcat instance configuration
            util.directory.copy(master['pki_source_server_path'],
                                master['pki_instance_configuration_path'],
                                overwrite_flag=True)
            # establish Tomcat instance base
            util.directory.create(master['pki_tomcat_common_path'])
            util.directory.create(master['pki_tomcat_common_lib_path'])
            # establish Tomcat instance library
            util.directory.create(master['pki_instance_lib'])
            for name in os.listdir(master['pki_tomcat_lib_path']):
                util.symlink.create(
                    os.path.join(
                        master['pki_tomcat_lib_path'],
                        name),
                    os.path.join(
                        master['pki_instance_lib'],
                        name))
            util.symlink.create(master['pki_instance_conf_log4j_properties'],
                                master['pki_instance_lib_log4j_properties'])
            util.directory.create(master['pki_tomcat_tmpdir_path'])
            util.directory.create(master['pki_tomcat_webapps_path'])
            util.directory.create(master['pki_tomcat_webapps_common_path'])

            common_images = os.path.join(
                master['pki_tomcat_webapps_common_path'],
                "images")

            # Copy /usr/share/pki/common-ui/admin/console/img
            # to <instance>/webapp/pki/images
            util.directory.copy(
                os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    "common-ui",
                    "admin",
                    "console",
                    "img"),
                common_images,
                overwrite_flag=True)

            # Copy /usr/share/pki/common-ui/css
            # to <instance>/webapp/pki/css
            util.directory.copy(
                os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    "common-ui",
                    "css"),
                os.path.join(
                    master['pki_tomcat_webapps_common_path'],
                    "css"),
                overwrite_flag=True)

            # Copy /usr/share/pki/common-ui/img
            # to <instance>/webapp/pki/images
            util.directory.copy(
                os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    "common-ui",
                    "img"),
                common_images,
                overwrite_flag=True)

            # Copy /usr/share/pki/<subsystem>-ui/webapps/<subsystem>/admin/graphics
            # to <instance>/webapp/pki/images
            dir = os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    master['pki_subsystem'].lower() + "-ui",
                    "webapps",
                    master['pki_subsystem'].lower(),
                    "admin",
                    "graphics")
            if (util.directory.exists(dir)):
                util.directory.copy(
                    dir,
                    common_images,
                    overwrite_flag=True)

            # Copy /usr/share/pki/<subsystem>-ui/webapps/<subsystem>/agent/graphics
            # to <instance>/webapp/pki/images
            dir = os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    master['pki_subsystem'].lower() + "-ui",
                    "webapps",
                    master['pki_subsystem'].lower(),
                    "agent",
                    "graphics")
            if (util.directory.exists(dir)):
                util.directory.copy(
                    dir,
                    common_images,
                    overwrite_flag=True)

            # Copy /usr/share/pki/<subsystem>-ui/webapps/<subsystem>/ee/graphics
            # to <instance>/webapp/pki/images
            dir = os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    master['pki_subsystem'].lower() + "-ui",
                    "webapps",
                    master['pki_subsystem'].lower(),
                    "ee",
                    "graphics")
            if (util.directory.exists(dir)):
                util.directory.copy(
                    dir,
                    common_images,
                    overwrite_flag=True)

            util.directory.create(master['pki_tomcat_webapps_root_path'])
            util.directory.copy(
                os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    "server",
                    "webapps",
                    "ROOT"),
                master['pki_tomcat_webapps_root_path'],
                overwrite_flag=True)
            util.directory.create(master['pki_tomcat_work_path'])
            util.directory.create(master['pki_tomcat_work_catalina_path'])
            util.directory.create(master['pki_tomcat_work_catalina_host_path'])
            util.directory.create(
                master['pki_tomcat_work_catalina_host_run_path'])
            util.directory.create(
                master['pki_tomcat_work_catalina_host_subsystem_path'])
            # establish Tomcat instance logs
            # establish Tomcat instance registry
            # establish Tomcat instance convenience symbolic links
            util.symlink.create(master['pki_tomcat_bin_path'],
                                master['pki_tomcat_bin_link'])
            util.symlink.create(master['pki_tomcat_systemd'],
                                master['pki_instance_systemd_link'],
                                uid=0, gid=0)
            # establish Tomcat instance common lib jar symbolic links
            util.symlink.create(master['pki_apache_commons_collections_jar'],
                master['pki_apache_commons_collections_jar_link'])
            util.symlink.create(master['pki_apache_commons_lang_jar'],
                master['pki_apache_commons_lang_jar_link'])
            util.symlink.create(master['pki_apache_commons_logging_jar'],
                master['pki_apache_commons_logging_jar_link'])
            util.symlink.create(master['pki_commons_codec_jar'],
                master['pki_commons_codec_jar_link'])
            util.symlink.create(master['pki_httpclient_jar'],
                master['pki_httpclient_jar_link'])
            util.symlink.create(master['pki_httpcore_jar'],
                master['pki_httpcore_jar_link'])
            util.symlink.create(master['pki_javassist_jar'],
                master['pki_javassist_jar_link'])
            util.symlink.create(master['pki_resteasy_jaxrs_api_jar'],
                master['pki_resteasy_jaxrs_api_jar_link'])
            util.symlink.create(master['pki_jettison_jar'],
                master['pki_jettison_jar_link'])
            util.symlink.create(master['pki_jss_jar'],
                master['pki_jss_jar_link'])
            util.symlink.create(master['pki_ldapjdk_jar'],
                master['pki_ldapjdk_jar_link'])
            util.symlink.create(master['pki_tomcat_jar'],
                master['pki_tomcat_jar_link'])
            util.symlink.create(master['pki_resteasy_atom_provider_jar'],
                master['pki_resteasy_atom_provider_jar_link'])
            util.symlink.create(master['pki_resteasy_jaxb_provider_jar'],
                master['pki_resteasy_jaxb_provider_jar_link'])
            util.symlink.create(master['pki_resteasy_jaxrs_jar'],
                master['pki_resteasy_jaxrs_jar_link'])
            util.symlink.create(master['pki_resteasy_jettison_provider_jar'],
                master['pki_resteasy_jettison_provider_jar_link'])
            util.symlink.create(master['pki_scannotation_jar'],
                master['pki_scannotation_jar_link'])
            if master['pki_subsystem'] == 'TKS':
                util.symlink.create(master['pki_symkey_jar'],
                    master['pki_symkey_jar_link'])
            util.symlink.create(master['pki_tomcatjss_jar'],
                master['pki_tomcatjss_jar_link'])
            util.symlink.create(master['pki_velocity_jar'],
                master['pki_velocity_jar_link'])
            util.symlink.create(master['pki_xerces_j2_jar'],
                master['pki_xerces_j2_jar_link'])
            util.symlink.create(master['pki_xml_commons_apis_jar'],
                master['pki_xml_commons_apis_jar_link'])
            util.symlink.create(master['pki_xml_commons_resolver_jar'],
                master['pki_xml_commons_resolver_jar_link'])
        # establish shared NSS security databases for this instance
        util.directory.create(master['pki_database_path'])
        # establish instance convenience symbolic links
        util.symlink.create(master['pki_database_path'],
                            master['pki_instance_database_link'])
        util.symlink.create(master['pki_instance_configuration_path'],
                            master['pki_instance_conf_link'])
        util.symlink.create(master['pki_instance_log_path'],
                            master['pki_instance_logs_link'])
        return self.rv

    def respawn(self):
        config.pki_log.info(log.INSTANCE_RESPAWN_1, __name__,
                            extra=config.PKI_INDENTATION_LEVEL_1)
        return self.rv

    def destroy(self):
        config.pki_log.info(log.INSTANCE_DESTROY_1, __name__,
                            extra=config.PKI_INDENTATION_LEVEL_1)
        if master['pki_subsystem'] == 'TKS':
            util.symlink.delete(master['pki_symkey_jar_link'])
        if not config.pki_dry_run_flag:
            if master['pki_subsystem'] in config.PKI_APACHE_SUBSYSTEMS and\
               util.instance.apache_instance_subsystems() == 0:
                # remove Apache instance base
                util.directory.delete(master['pki_instance_path'])
                # remove Apache instance logs
                # remove shared NSS security database path for this instance
                util.directory.delete(master['pki_database_path'])
                # remove Apache instance configuration
                util.directory.delete(master['pki_instance_configuration_path'])
                # remove Apache instance registry
                util.directory.delete(master['pki_instance_registry_path'])
                # remove Apache PKI registry (if empty)
                if util.instance.apache_instances() == 0:
                    util.directory.delete(
                        master['pki_instance_type_registry_path'])
            elif master['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS and\
                 util.instance.tomcat_instance_subsystems() == 0:
                # remove Tomcat instance base
                util.directory.delete(master['pki_instance_path'])
                # remove Tomcat instance logs
                util.directory.delete(master['pki_instance_log_path'])
                # remove shared NSS security database path for this instance
                util.directory.delete(master['pki_database_path'])
                # remove Tomcat instance configuration
                util.directory.delete(master['pki_instance_configuration_path'])
                # remove PKI 'tomcat.conf' instance file
                util.file.delete(master['pki_target_tomcat_conf_instance_id'])
                # remove Tomcat instance registry
                util.directory.delete(master['pki_instance_registry_path'])
                # remove Tomcat PKI registry (if empty)
                if util.instance.tomcat_instances() == 0:
                    util.directory.delete(
                        master['pki_instance_type_registry_path'])
        else:
            # ALWAYS display correct information (even during dry_run)
            if master['pki_subsystem'] in config.PKI_APACHE_SUBSYSTEMS and\
               util.instance.apache_instance_subsystems() == 1:
                # remove Apache instance base
                util.directory.delete(master['pki_instance_path'])
                # remove Apache instance logs
                # remove shared NSS security database path for this instance
                util.directory.delete(master['pki_database_path'])
                # remove Apache instance configuration
                util.directory.delete(master['pki_instance_configuration_path'])
                # remove Apache instance registry
                util.directory.delete(master['pki_instance_registry_path'])
                # remove Apache PKI registry (if empty)
                if util.instance.apache_instances() == 1:
                    util.directory.delete(
                        master['pki_instance_type_registry_path'])
            elif master['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS and\
                 util.instance.tomcat_instance_subsystems() == 1:
                # remove Tomcat instance base
                util.directory.delete(master['pki_instance_path'])
                # remove Tomcat instance logs
                util.directory.delete(master['pki_instance_log_path'])
                # remove shared NSS security database path for this instance
                util.directory.delete(master['pki_database_path'])
                # remove Tomcat instance configuration
                util.directory.delete(master['pki_instance_configuration_path'])
                # remove PKI 'tomcat.conf' instance file
                util.file.delete(master['pki_target_tomcat_conf_instance_id'])
                # remove Tomcat instance registry
                util.directory.delete(master['pki_instance_registry_path'])
                # remove Tomcat PKI registry (if empty)
                if util.instance.tomcat_instances() == 1:
                    util.directory.delete(
                        master['pki_instance_type_registry_path'])
        return self.rv