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
|
# Copyright (C) 2015 Red Hat, Inc., Lee Yarwood <lyarwood@redhat.com>
# Copyright (C) 2017 Red Hat, Inc., Martin Schuppert <mschuppert@redhat.com>
# This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.
import os
from sos.report.plugins import Plugin, RedHatPlugin, DebianPlugin, UbuntuPlugin
class OpenStackIronic(Plugin):
short_desc = 'OpenStack Ironic'
plugin_name = "openstack_ironic"
profiles = ('openstack', 'openstack_undercloud')
containers = ('.*ironic_api',)
var_puppet_gen = "/var/lib/config-data/puppet-generated/ironic"
ins_puppet_gen = var_puppet_gen + "_inspector"
conf_list = []
osc_available = False
def setup(self):
in_container = self.container_exists('.*ironic_api')
if in_container:
self.conf_list = [
self.var_puppet_gen + "/etc/ironic/*",
self.var_puppet_gen + "/etc/ironic-inspector/*",
self.var_puppet_gen + "_api/etc/ironic/*",
self.ins_puppet_gen + "/etc/ironic-inspector/*",
self.ins_puppet_gen + "/var/lib/httpboot/inspector.ipxe"
]
self.add_copy_spec([
"/var/lib/ironic-inspector/",
"/var/log/containers/ironic-inspector/ramdisk/",
self.var_puppet_gen + "/etc/xinetd.conf",
self.var_puppet_gen + "/etc/xinetd.d/",
self.var_puppet_gen + "/etc/ironic/",
self.var_puppet_gen + "/etc/ironic-inspector/",
self.var_puppet_gen + "/etc/httpd/conf/",
self.var_puppet_gen + "/etc/httpd/conf.d/",
self.var_puppet_gen + "/etc/httpd/conf.modules.d/*.conf",
self.var_puppet_gen + "/etc/my.cnf.d/tripleo.cnf",
self.var_puppet_gen + "_api/etc/ironic/",
self.var_puppet_gen + "_api/etc/httpd/conf/",
self.var_puppet_gen + "_api/etc/httpd/conf.d/",
self.var_puppet_gen + "_api/etc/httpd/conf.modules.d/*.conf",
self.var_puppet_gen + "_api/etc/my.cnf.d/tripleo.cnf",
self.ins_puppet_gen + "/etc/ironic-inspector/*",
self.ins_puppet_gen + "/var/lib/httpboot/inspector.ipxe"
])
if self.get_option("all_logs"):
self.add_copy_spec([
"/var/log/containers/ironic/",
"/var/log/containers/ironic-inspector/"
])
else:
self.add_copy_spec([
"/var/log/containers/ironic/*.log",
"/var/log/containers/ironic-inspector/*.log",
])
for path in ['/var/lib/ironic', '/httpboot', '/tftpboot',
self.ins_puppet_gen + '/var/lib/httpboot/',
self.ins_puppet_gen + '/var/lib/tftpboot/']:
self.add_cmd_output(f'ls -laRt {path}')
self.add_cmd_output(f'ls -laRt {self.var_puppet_gen + path}')
# Let's get the packages from the containers, always helpful when
# troubleshooting.
for container_name in ['ironic_inspector_dnsmasq',
'ironic_inspector', 'ironic_pxe_http',
'ironic_pxe_tftp', 'ironic_neutron_agent',
'ironic_conductor', 'ironic_api']:
if self.container_exists('.*' + container_name):
self.add_cmd_output('rpm -qa', container=container_name)
else:
self.conf_list = [
"/etc/ironic/*",
"/etc/ironic-inspector/*",
]
self.add_copy_spec([
"/etc/ironic/",
"/etc/ironic-inspector/",
"/var/lib/ironic-inspector/",
"/var/log/ironic-inspector/ramdisk/",
"/etc/my.cnf.d/tripleo.cnf",
"/var/lib/httpboot/inspector.ipxe"
])
if self.get_option("all_logs"):
self.add_copy_spec([
"/var/log/ironic/",
"/var/log/ironic-inspector/",
])
else:
self.add_copy_spec([
"/var/log/ironic/*.log",
"/var/log/ironic-inspector/*.log",
])
for path in ['/var/lib/ironic', '/httpboot', '/tftpboot']:
self.add_cmd_output(f'ls -laRt {path}')
self.add_file_tags({
".*/etc/ironic/ironic.conf": "ironic_conf"
})
vars_all = [p in os.environ for p in [
'OS_USERNAME', 'OS_PASSWORD']]
vars_any = [p in os.environ for p in [
'OS_TENANT_NAME', 'OS_PROJECT_NAME']]
self.osc_available = all(vars_all) and any(vars_any)
if not self.osc_available:
self.soslog.warning("Not all environment variables set. Source "
"the environment file for the user intended "
"to connect to the OpenStack environment.")
else:
self.add_cmd_output("openstack baremetal driver list --long")
self.add_cmd_output("openstack baremetal node list --long")
self.add_cmd_output("openstack baremetal port list --long")
self.add_cmd_output("openstack baremetal port group list --long")
def apply_regex_sub(self, regexp, subst):
""" Apply regex substitution """
for conf in self.conf_list:
self.do_path_regex_sub(conf, regexp, subst)
def postproc(self):
protect_keys = [
"dns_passkey", "memcache_secret_key", "rabbit_password",
"password", "qpid_password", "admin_password", "ssl_key_password",
"os_password", "transport_url"
]
connection_keys = ["connection", "sql_connection"]
join_con_keys = "|".join(connection_keys)
self.apply_regex_sub(
fr"(^\s*({'|'.join(protect_keys)})\s*=\s*)(.*)",
r"\1*********"
)
self.apply_regex_sub(
fr"(^\s*({join_con_keys})\s*=\s*(.*)://(\w*):)(.*)(@(.*))",
r"\1*********\6"
)
class DebianIronic(OpenStackIronic, DebianPlugin, UbuntuPlugin):
packages = ('ironic-api', 'ironic-common', 'ironic-conductor')
class RedHatIronic(OpenStackIronic, RedHatPlugin):
packages = ('openstack-selinux',)
discoverd_packages = [
'openstack-ironic-discoverd',
'openstack-ironic-discoverd-ramdisk'
]
def collect_introspection_data(self):
""" Capture baremetal introspection data """
uuids_result = self.collect_cmd_output(
'openstack baremetal node list -f value -c UUID'
)
if uuids_result['status']:
self.soslog.warning('Failed to fetch list of ironic node UUIDs, '
'introspection data won\'t be collected')
return
uuids = [uuid for uuid in uuids_result['output'].split()
if uuid.strip()]
for uuid in uuids:
self.add_cmd_output('openstack baremetal introspection '
f'data save {uuid}')
def setup(self):
super().setup()
# ironic-discoverd was renamed to ironic-inspector in Liberty
# is the optional ironic-discoverd service installed?
if any(self.is_installed(p) for p in self.discoverd_packages):
self.conf_list.append('/etc/ironic-discoverd/*')
self.add_copy_spec('/etc/ironic-discoverd/')
self.add_copy_spec('/var/lib/ironic-discoverd/')
self.add_copy_spec('/var/log/ironic-discoverd/')
self.add_journal(units="openstack-ironic-discoverd")
self.add_journal(units="openstack-ironic-discoverd-dnsmasq")
self.add_journal(units="openstack-ironic-inspector-dnsmasq")
if self.osc_available:
self.add_cmd_output("openstack baremetal introspection list")
if self.get_option("all_logs"):
self.collect_introspection_data()
# vim: set et ts=4 sw=4 :
|
