K8s Coredump Handler: initial package
Currently, it is not possible to set the core_pattern [1] on a per Pod basis. That is, the kernel.core_pattern sysctl is not namespaced and applies to the entire node. Applications demands exclusive access to the core dump data for debugging and support without enabling full access to the host OS files. In order to meet both the platform and application requirements, a new Kubernetes aware core dump handler is proposed. This review covers the initial code and packaging of this handler, which still represents limited functionality, only applying to very basic testing. Reference to coredump configuration: 1. https://man7.org/linux/man-pages/man5/coredump.conf.5.html Test Plan: PASS: Basic functionality after bootstrap (call handler directly) PASS: Check handler is called upon coredump (core_pattern config) Story: 2010261 Task: 46156 Depends-On: https://review.opendev.org/c/starlingx/integ/+/854682 Co-Authored-By: Samuel Presa Toledo <samuel.presatoledo@windriver.com> Co-Authored-By: Heron Vieira <heron.vieira@windriver.com> Signed-off-by: Adriano Oliveira <adriano.oliveira@windriver.com> Change-Id: I7e18b27a6de1e74d8df3e4c28661959763ce7468
This commit is contained in:
Adriano Oliveira
parent
c213a3832d
commit
a203821616
@ -5,6 +5,7 @@ tools/collector
|
||||
tools/engtools/hostdata-collectors
|
||||
tools/pcm
|
||||
utilities/build-info
|
||||
utilities/k8s-coredump
|
||||
utilities/logmgmt
|
||||
utilities/namespace-utils
|
||||
utilities/nfscheck
|
||||
|
||||
202
utilities/k8s-coredump/LICENSE
Normal file
202
utilities/k8s-coredump/LICENSE
Normal file
@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
13
utilities/k8s-coredump/PKG-INFO
Normal file
13
utilities/k8s-coredump/PKG-INFO
Normal file
@ -0,0 +1,13 @@
|
||||
Metadata-Version: 1.1
|
||||
Name: k8s-coredump
|
||||
Version: 1.0
|
||||
Summary: Intercepts raw coredump and apply specific core pattern and namespace
|
||||
Home-page:
|
||||
Author: Windriver
|
||||
Author-email: info@windriver.com
|
||||
License: Apache-2.0
|
||||
|
||||
Description: Intercepts raw coredump and apply specific core pattern and namespace
|
||||
|
||||
|
||||
Platform: UNKNOWN
|
||||
5
utilities/k8s-coredump/debian/deb_folder/changelog
Normal file
5
utilities/k8s-coredump/debian/deb_folder/changelog
Normal file
@ -0,0 +1,5 @@
|
||||
k8s-coredump (1.0-1) unstable; urgency=medium
|
||||
|
||||
* Initial release.
|
||||
|
||||
-- Samuel Presa Toledo <samuel.presatoledo@windriver.com> Mon, 01 Aug 2022 16:11:00 -0300
|
||||
25
utilities/k8s-coredump/debian/deb_folder/control
Normal file
25
utilities/k8s-coredump/debian/deb_folder/control
Normal file
@ -0,0 +1,25 @@
|
||||
Source: k8s-coredump
|
||||
Section: admin
|
||||
Priority: optional
|
||||
Maintainer: StarlingX Developers <starlingx-discuss@lists.starlingx.io>
|
||||
Build-Depends: debhelper-compat (= 13),
|
||||
dh-python,
|
||||
python3-setuptools,
|
||||
python3-wheel,
|
||||
python3-all
|
||||
Standards-Version: 4.4.1
|
||||
Homepage: https://www.starlingx.io
|
||||
|
||||
Package: k8s-coredump
|
||||
Architecture: all
|
||||
Depends: ${python3:Depends}, ${misc:Depends},
|
||||
python3-requests,
|
||||
python3-nsenter
|
||||
Description: K8s Pod Coredump Handler
|
||||
This package controls coredump using individual pods.
|
||||
|
||||
Package: k8s-coredump-wheels
|
||||
Architecture: all
|
||||
Depends: ${python3:Depends}, ${misc:Depends},
|
||||
Description: Contains python wheels for k8s-coredump
|
||||
This package contains python wheels for specific k8s-coredump
|
||||
27
utilities/k8s-coredump/debian/deb_folder/copyright
Normal file
27
utilities/k8s-coredump/debian/deb_folder/copyright
Normal file
@ -0,0 +1,27 @@
|
||||
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
||||
Upstream-Name: k8s-coredump
|
||||
Source: https://opendev.org/starlingx/utilities/
|
||||
|
||||
Files: *
|
||||
Copyright: (c) 2022 Wind River Systems, Inc
|
||||
License: Apache-2
|
||||
|
||||
Files: debian/*
|
||||
Copyright: 2022 Wind River Systems, Inc
|
||||
License: Apache-2
|
||||
|
||||
License: Apache-2
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
.
|
||||
https://www.apache.org/licenses/LICENSE-2.0
|
||||
.
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
.
|
||||
On Debian-based systems the full text of the Apache version 2.0 license
|
||||
can be found in `/usr/share/common-licenses/Apache-2.0'.
|
||||
@ -0,0 +1 @@
|
||||
wheels/k8s-coredump/*.whl
|
||||
@ -0,0 +1,3 @@
|
||||
etc/k8s-coredump
|
||||
usr/lib/python3/dist-packages/k8s_coredump
|
||||
usr/lib/python3/dist-packages/k8s_coredump-1.0.0.egg-info
|
||||
@ -0,0 +1,4 @@
|
||||
etc/k8s-coredump/*
|
||||
usr/bin/k8s-coredump
|
||||
usr/lib/python3/dist-packages/k8s_coredump/*
|
||||
usr/lib/python3/dist-packages/k8s_coredump-1.0.0.egg-info/*
|
||||
21
utilities/k8s-coredump/debian/deb_folder/rules
Executable file
21
utilities/k8s-coredump/debian/deb_folder/rules
Executable file
@ -0,0 +1,21 @@
|
||||
#!/usr/bin/make -f
|
||||
#export DH_VERBOSE = 1
|
||||
|
||||
export PYBUILD_NAME = k8s-coredump
|
||||
export PBR_VERSION=1.0.0
|
||||
export ROOT = debian/tmp
|
||||
export ETC_K8S_DIR = $(ROOT)/etc/k8s-coredump
|
||||
|
||||
%:
|
||||
dh $@ --with python3 --buildsystem=pybuild
|
||||
|
||||
override_dh_install:
|
||||
python3 setup.py install --install-layout=deb --root=$(ROOT)
|
||||
|
||||
python3 setup.py bdist_wheel --universal \
|
||||
-d $(ROOT)/wheels/$(PYBUILD_NAME)
|
||||
|
||||
install -d -m 755 $(ETC_K8S_DIR)
|
||||
install -p -D -m 644 files/k8s-coredump.yaml $(ETC_K8S_DIR)
|
||||
install -p -D -m 644 files/pods.json $(ETC_K8S_DIR)
|
||||
dh_install
|
||||
9
utilities/k8s-coredump/debian/meta_data.yaml
Normal file
9
utilities/k8s-coredump/debian/meta_data.yaml
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
debname: k8s-coredump
|
||||
debver: 1.0-1
|
||||
src_path: k8s-coredump
|
||||
src_files:
|
||||
- files
|
||||
revision:
|
||||
dist: $STX_DIST
|
||||
PKG_GITREVCOUNT: true
|
||||
46
utilities/k8s-coredump/files/k8s-coredump.yaml
Normal file
46
utilities/k8s-coredump/files/k8s-coredump.yaml
Normal file
@ -0,0 +1,46 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: ServiceAccount
|
||||
metadata:
|
||||
name: coredump
|
||||
namespace: kube-system
|
||||
secrets:
|
||||
- name: coredump-secret-token
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: coredump-secret-token
|
||||
namespace: kube-system
|
||||
annotations:
|
||||
kubernetes.io/service-account.name: coredump
|
||||
type: kubernetes.io/service-account-token
|
||||
---
|
||||
apiVersion: rbac.authorization.k8s.io/v1
|
||||
kind: ClusterRole
|
||||
metadata:
|
||||
name: coredump-clusterrole
|
||||
namespace: kube-system
|
||||
rules:
|
||||
- apiGroups: [""]
|
||||
resources:
|
||||
- nodes
|
||||
- nodes/proxy
|
||||
- pods
|
||||
verbs: ["get", "list"]
|
||||
- nonResourceURLs: ["/pods"]
|
||||
verbs: ["get"]
|
||||
---
|
||||
apiVersion: rbac.authorization.k8s.io/v1
|
||||
kind: ClusterRoleBinding
|
||||
metadata:
|
||||
name: coredump-clusterrole-binding
|
||||
namespace: kube-system
|
||||
roleRef:
|
||||
kind: ClusterRole
|
||||
name: coredump-clusterrole
|
||||
apiGroup: rbac.authorization.k8s.io
|
||||
subjects:
|
||||
- kind: ServiceAccount
|
||||
name: coredump
|
||||
namespace: kube-system
|
||||
18883
utilities/k8s-coredump/files/pods.json
Normal file
18883
utilities/k8s-coredump/files/pods.json
Normal file
File diff suppressed because it is too large
Load Diff
202
utilities/k8s-coredump/k8s-coredump/LICENSE
Normal file
202
utilities/k8s-coredump/k8s-coredump/LICENSE
Normal file
@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
18
utilities/k8s-coredump/k8s-coredump/k8s_coredump/__main__.py
Normal file
18
utilities/k8s-coredump/k8s-coredump/k8s_coredump/__main__.py
Normal file
@ -0,0 +1,18 @@
|
||||
import sys
|
||||
|
||||
from . import coredump
|
||||
|
||||
def main():
|
||||
# https://man7.org/linux/man-pages/man5/core.5.html
|
||||
kwargs = {
|
||||
'pid': sys.argv[1], # %P
|
||||
'uid': sys.argv[2], # %u
|
||||
'gid': sys.argv[3], # %g
|
||||
'signal': sys.argv[4], # %s
|
||||
'timestamp': sys.argv[5], # %t
|
||||
'comm': sys.argv[6], # %e
|
||||
}
|
||||
coredump.CoreDumpHandler(**kwargs)
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@ -0,0 +1,6 @@
|
||||
|
||||
K8S_COREDUMP_LOG = "/var/log/k8s-coredump.log"
|
||||
K8S_COREDUMP_CONF = "/etc/k8s-coredump-conf.json"
|
||||
K8S_COREDUMP_TOKEN = "k8s_coredump_token"
|
||||
LOCALHOST_URL = "https://localhost:10250/pods"
|
||||
SYSTEMD_COREDUMP = "/usr/lib/systemd/systemd-coredump"
|
||||
142
utilities/k8s-coredump/k8s-coredump/k8s_coredump/coredump.py
Normal file
142
utilities/k8s-coredump/k8s-coredump/k8s_coredump/coredump.py
Normal file
@ -0,0 +1,142 @@
|
||||
import io
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
import nsenter
|
||||
import requests
|
||||
|
||||
from .common.constants import K8S_COREDUMP_CONF
|
||||
from .common.constants import K8S_COREDUMP_LOG
|
||||
from .common.constants import K8S_COREDUMP_TOKEN
|
||||
from .common.constants import LOCALHOST_URL
|
||||
from .common.constants import SYSTEMD_COREDUMP
|
||||
|
||||
logging.basicConfig(filename=K8S_COREDUMP_LOG, level=logging.DEBUG)
|
||||
LOG = logging.getLogger("k8s-coredump")
|
||||
|
||||
|
||||
def _getToken():
|
||||
try:
|
||||
with open(K8S_COREDUMP_CONF, 'r') as token_file:
|
||||
data = json.loads(token_file.read())
|
||||
token = data.get(K8S_COREDUMP_TOKEN)
|
||||
return token
|
||||
except IOError:
|
||||
LOG.error("Error: File does not appear to exist.")
|
||||
return None
|
||||
|
||||
|
||||
# TODO (spresato) Need to be implemented
|
||||
def _parseCoredumpPattern(pattern):
|
||||
pass
|
||||
|
||||
|
||||
def _getPodUID(pid):
|
||||
try:
|
||||
pattern = re.compile("\d+:.+:/[^/]+/kubepods/[^/]+/pod([^/]+)/([0-9a-f]{64})")
|
||||
cgroups = os.path.join("/proc", pid, "cgroup")
|
||||
with io.open(cgroups, "r") as f:
|
||||
for line in f:
|
||||
match = re.match(pattern, line)
|
||||
if match:
|
||||
# extract pod UID from pod cgroup path
|
||||
return match.group(1)
|
||||
except IOError as e:
|
||||
LOG.error("Failed to read process cgroups: {}".format(e))
|
||||
sys.exit(-1)
|
||||
return None # normal for processes not running in a container
|
||||
|
||||
|
||||
def _lookupPod(pid):
|
||||
podUID = _getPodUID(pid)
|
||||
LOG.debug("lookupPod: podUID={}".format(podUID))
|
||||
# retrieve pod details from kubelet
|
||||
if podUID:
|
||||
url = LOCALHOST_URL
|
||||
token = _getToken()
|
||||
headers = {"Authorization": "Bearer %s" % token}
|
||||
timeout = 1
|
||||
pods = requests.get(url=url, headers=headers, timeout=timeout, verify=False).json()
|
||||
for pod in pods.get('items'):
|
||||
metadata = pod.get('metadata')
|
||||
uid = metadata.get('uid')
|
||||
if uid == podUID:
|
||||
return pod
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def _systemCoreFile():
|
||||
# delegate handling to systemd coredump handler
|
||||
try:
|
||||
cmd = [SYSTEMD_COREDUMP] + sys.argv[1:]
|
||||
subprocess.run(cmd)
|
||||
except subprocess.CalledProcessError as e:
|
||||
LOG.error("Failed to call systemd-coredump: {}".format(e))
|
||||
sys.exit(-1)
|
||||
|
||||
|
||||
def _podCoreFile(pid, corefile):
|
||||
# create core file relative to dumping process if not an absolute path
|
||||
if not os.path.isabs(corefile):
|
||||
try:
|
||||
path = os.path.join("/proc", pid, "cwd")
|
||||
cwd = os.path.realpath(path)
|
||||
corefile = os.path.join(cwd, corefile)
|
||||
except os.OSError as e:
|
||||
LOG.error("Failed to get current working directory: {}".format(e))
|
||||
sys.exit(-1)
|
||||
|
||||
LOG.debug("podCoreFile: corefile={}".format(corefile))
|
||||
|
||||
with nsenter.Namespace(pid, 'mnt') as ns:
|
||||
try:
|
||||
with io.open(corefile, "wb") as f:
|
||||
f.write(sys.stdin.buffer.read())
|
||||
f.flush()
|
||||
except IOError as e:
|
||||
LOG.error("failed to create core file: {}".format(e))
|
||||
sys.exit(-1)
|
||||
|
||||
|
||||
def CoreDumpHandler(**kwargs):
|
||||
pid = kwargs['pid']
|
||||
uid = kwargs['uid']
|
||||
exe = kwargs['comm']
|
||||
|
||||
LOG.critical("Process %s (%s) of user %s dumped core." % (pid, exe, uid))
|
||||
|
||||
pod = _lookupPod(pid)
|
||||
if pod:
|
||||
try:
|
||||
metadata = pod['metadata']
|
||||
annotations = metadata['annotations']
|
||||
core_pattern = annotations.get("starlingx.io/core_pattern")
|
||||
if core_pattern is not None:
|
||||
LOG.info("Pod %s/%s handling core dump for %s" % \
|
||||
(metadata['namespace'], metadata['name'], pid))
|
||||
if not core_pattern:
|
||||
# default core pattern
|
||||
corefile = "core.%s.%s" % (exe, pid)
|
||||
else:
|
||||
# https://man7.org/linux/man-pages/man5/core.5.html
|
||||
corefile = _parseCoredumpPattern(core_pattern)
|
||||
|
||||
_podCoreFile(pid, corefile)
|
||||
return # core dump handled by Pod
|
||||
else:
|
||||
LOG.debug("Pod %s/%s does not define annotation core_pattern" % \
|
||||
(metadata['namespace'], metadata['name']))
|
||||
except ValueError as e:
|
||||
LOG.error("Pod defined an invalid core dump annotation: {}".format(e))
|
||||
sys.exit(-1)
|
||||
except KeyError:
|
||||
LOG.debug("Pod does have annotations defined")
|
||||
pass
|
||||
|
||||
# not handled by pod, redirect to systemd coredump handler
|
||||
_systemCoreFile()
|
||||
2
utilities/k8s-coredump/k8s-coredump/requirements.txt
Normal file
2
utilities/k8s-coredump/k8s-coredump/requirements.txt
Normal file
@ -0,0 +1,2 @@
|
||||
nsenter
|
||||
requests
|
||||
27
utilities/k8s-coredump/k8s-coredump/setup.cfg
Normal file
27
utilities/k8s-coredump/k8s-coredump/setup.cfg
Normal file
@ -0,0 +1,27 @@
|
||||
[metadata]
|
||||
name = k8s_coredump
|
||||
summary = A python handler for k8s coredump
|
||||
author = StarlingX
|
||||
author-email = starlingx-discuss@lists.starlingx.io
|
||||
home-page = https://opendev.org/starlingx/utilities
|
||||
classifier =
|
||||
|
||||
[global]
|
||||
setup-hooks =
|
||||
pbr.hooks.setup_hook
|
||||
|
||||
[files]
|
||||
packages =
|
||||
k8s_coredump
|
||||
|
||||
[entry_points]
|
||||
console_scripts =
|
||||
k8s-coredump = k8s_coredump.__main__:main
|
||||
|
||||
[egg_info]
|
||||
tag_build =
|
||||
tag_date = 0
|
||||
tag_svn_revision = 0
|
||||
|
||||
[wheel]
|
||||
universal = 1
|
||||
21
utilities/k8s-coredump/k8s-coredump/setup.py
Normal file
21
utilities/k8s-coredump/k8s-coredump/setup.py
Normal file
@ -0,0 +1,21 @@
|
||||
#!/usr/bin/env python
|
||||
#
|
||||
# Copyright (c) 2022 Wind River Systems, Inc.
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
import setuptools
|
||||
|
||||
setuptools.setup(
|
||||
name='k8s_coredump',
|
||||
version='1.0.0',
|
||||
description='K8s coredump handler',
|
||||
license='Apache-2.0',
|
||||
install_requires=['requests', 'nsenter'],
|
||||
packages=['k8s_coredump'],
|
||||
include_package_data=True,
|
||||
setup_requires=['pbr>=2.0.0'],
|
||||
pbr=True,
|
||||
entry_points={
|
||||
}
|
||||
)
|
||||
Loading…
x
Reference in New Issue
Block a user