summaryrefslogtreecommitdiffstats
path: root/base/server/python/pki/server/deployment/scriptlets/instance_layout.py
blob: 86968e22ee9cde74b733d12a3d23eff9a4c509cc (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
#!/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
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.master_dict['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 deployer.master_dict['pki_subsystem'] in config.PKI_TOMCAT_SUBSYSTEMS and\
            len(deployer.instance.tomcat_instance_subsystems()) == 1:

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

            # establish Tomcat instance configuration
            deployer.directory.copy(
                deployer.master_dict['pki_source_server_path'],
                deployer.master_dict['pki_instance_configuration_path'])

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

            # Copy /usr/share/pki/server/webapps to <instance>/webapps
            deployer.directory.copy(
                os.path.join(
                    config.PKI_DEPLOYMENT_SOURCE_ROOT,
                    "server",
                    "webapps"),
                deployer.master_dict['pki_tomcat_webapps_path'])

            # If desired and available,
            # copy selected server theme
            # to <instance>/webapps/pki
            if config.str2bool(deployer.master_dict['pki_theme_enable']) and\
                os.path.exists(deployer.master_dict['pki_theme_server_dir']):
                deployer.directory.copy(
                    deployer.master_dict['pki_theme_server_dir'],
                    os.path.join(
                        deployer.master_dict['pki_tomcat_webapps_path'],
                        "pki"),
                    overwrite_flag=True)

            deployer.directory.create(deployer.master_dict['pki_tomcat_work_path'])
            deployer.directory.create(deployer.master_dict['pki_tomcat_work_catalina_path'])
            deployer.directory.create(deployer.master_dict['pki_tomcat_work_catalina_host_path'])
            deployer.directory.create(
                deployer.master_dict['pki_tomcat_work_catalina_host_run_path'])
            deployer.directory.create(
                deployer.master_dict['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.master_dict['pki_tomcat_bin_path'],
                                deployer.master_dict['pki_tomcat_bin_link'])
            deployer.symlink.create(deployer.master_dict['pki_tomcat_systemd'],
                                deployer.master_dict['pki_instance_systemd_link'],
                                uid=0, gid=0)
            # establish Tomcat instance common lib jar symbolic links
            deployer.symlink.create(deployer.master_dict['pki_apache_commons_collections_jar'],
                deployer.master_dict['pki_apache_commons_collections_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_apache_commons_io_jar'],
                deployer.master_dict['pki_apache_commons_io_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_apache_commons_lang_jar'],
                deployer.master_dict['pki_apache_commons_lang_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_apache_commons_logging_jar'],
                deployer.master_dict['pki_apache_commons_logging_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_commons_codec_jar'],
                deployer.master_dict['pki_commons_codec_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_httpclient_jar'],
                deployer.master_dict['pki_httpclient_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_httpcore_jar'],
                deployer.master_dict['pki_httpcore_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_javassist_jar'],
                deployer.master_dict['pki_javassist_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_resteasy_jaxrs_api_jar'],
                deployer.master_dict['pki_resteasy_jaxrs_api_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_jettison_jar'],
                deployer.master_dict['pki_jettison_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_jss_jar'],
                deployer.master_dict['pki_jss_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_ldapjdk_jar'],
                deployer.master_dict['pki_ldapjdk_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_tomcat_jar'],
                deployer.master_dict['pki_tomcat_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_resteasy_atom_provider_jar'],
                deployer.master_dict['pki_resteasy_atom_provider_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_resteasy_jaxb_provider_jar'],
                deployer.master_dict['pki_resteasy_jaxb_provider_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_resteasy_jaxrs_jar'],
                deployer.master_dict['pki_resteasy_jaxrs_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_resteasy_jettison_provider_jar'],
                deployer.master_dict['pki_resteasy_jettison_provider_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_scannotation_jar'],
                deployer.master_dict['pki_scannotation_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_tomcatjss_jar'],
                deployer.master_dict['pki_tomcatjss_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_velocity_jar'],
                deployer.master_dict['pki_velocity_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_xerces_j2_jar'],
                deployer.master_dict['pki_xerces_j2_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_xml_commons_apis_jar'],
                deployer.master_dict['pki_xml_commons_apis_jar_link'])
            deployer.symlink.create(deployer.master_dict['pki_xml_commons_resolver_jar'],
                deployer.master_dict['pki_xml_commons_resolver_jar_link'])

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

        if deployer.master_dict['pki_subsystem'] == 'TKS':
            deployer.symlink.create(deployer.master_dict['pki_symkey_jar'],
                deployer.master_dict['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 deployer.master_dict['pki_subsystem'] == 'TKS':
            deployer.symlink.delete(deployer.master_dict['pki_symkey_jar_link'])

        if deployer.master_dict['pki_subsystem'] in config.PKI_APACHE_SUBSYSTEMS and\
           deployer.instance.apache_instance_subsystems() == 0:
            # remove Apache instance base
            deployer.directory.delete(deployer.master_dict['pki_instance_path'])
            # remove Apache instance logs
            # remove shared NSS security database path for this instance
            deployer.directory.delete(deployer.master_dict['pki_database_path'])
            # remove Apache instance configuration
            deployer.directory.delete(deployer.master_dict['pki_instance_configuration_path'])
            # remove Apache instance registry
            deployer.directory.delete(deployer.master_dict['pki_instance_registry_path'])
            # remove Apache PKI registry (if empty)
            if deployer.instance.apache_instances() == 0:
                deployer.directory.delete(
                    deployer.master_dict['pki_instance_type_registry_path'])

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

        return self.rv