Skip to content

Commit cf2bba8

Browse files
lmillerilmilleri
authored
Merge pull request #318 from lmilleri/must-gather
Must gather
2 parents 917bf32 + 629e534 commit cf2bba8

12 files changed

Lines changed: 703 additions & 0 deletions

File tree

‎must-gather/Dockerfile‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
FROM registry.redhat.io/openshift4/ose-must-gather-rhel9:v4.19 as builder
2+
3+
FROM registry.access.redhat.com/ubi9/ubi-minimal:9.7-1776104705
4+
5+
# For gathering data from nodes
6+
# NOTE for hermetic build: any change to the packages installed here must
7+
# be reflected in the rpms.in.yaml file.
8+
# Also make sure to re-generate the rpms.lock.yaml file when doing so.
9+
# See https://konflux.pages.redhat.com/docs/users/building/prefetching-dependencies.html#rpm
10+
RUN microdnf update -y && microdnf install tar rsync -y && microdnf clean all
11+
12+
COPY --from=builder /usr/bin/oc /usr/bin/oc
13+
14+
# Save original gather script
15+
COPY --from=builder /usr/bin/gather /usr/bin/gather_original
16+
17+
# Copy all collection scripts to /usr/bin
18+
COPY collection-scripts/* /usr/bin/
19+
20+
# Red Hat labels
21+
LABEL name="openshift-trustee-operator/trustee-must-gather-rhel9" \
22+
cpe="cpe:/a:redhat:confidential_compute_attestation:1.101::el9" \
23+
version="1.1.0" \
24+
com.redhat.component="redhat-build-of-trustee-must-gather-container" \
25+
summary="redhat-build-of-trustee-must-gather collects information about RedHat Build of Trustee and its components" \
26+
maintainer="support@redhat.com" \
27+
description="trustee-must-gather collects information about RedHat Build of Trustee" \
28+
io.k8s.display-name="redhat-build-of-trustee-must-gather" \
29+
io.k8s.description="redhat-build-of-trustee-must-gather collects information about RedHat Build of Trustee and its components" \
30+
io.openshift.tags=""
31+
32+
ENTRYPOINT /usr/bin/gather

‎must-gather/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎must-gather/Makefile‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
IMAGE_REGISTRY ?= quay.io
2+
IMAGE_NAMESPACE ?= confidential-containers
3+
IMAGE_NAME ?= trustee-must-gather
4+
IMAGE_TAG ?= latest
5+
6+
MUST_GATHER_IMAGE ?= ${IMAGE_NAMESPACE}/${IMAGE_NAME}
7+
8+
build: podman-build
9+
10+
# Run shellcheck on collection scripts
11+
check:
12+
shellcheck collection-scripts/*
13+
14+
# Build the must-gather image
15+
podman-build:
16+
podman build --squash-all --no-cache . -t ${IMAGE_REGISTRY}/${MUST_GATHER_IMAGE}:${IMAGE_TAG}
17+
18+
# Push the must-gather image
19+
podman-push:
20+
podman push ${IMAGE_REGISTRY}/${MUST_GATHER_IMAGE}:${IMAGE_TAG}
21+
22+
# Build and push
23+
push: podman-build podman-push
24+
25+
# Build with docker
26+
docker-build:
27+
docker build --no-cache . -t ${IMAGE_REGISTRY}/${MUST_GATHER_IMAGE}:${IMAGE_TAG}
28+
29+
# Push with docker
30+
docker-push:
31+
docker push ${IMAGE_REGISTRY}/${MUST_GATHER_IMAGE}:${IMAGE_TAG}
32+
33+
.PHONY: build check podman-build podman-push push docker-build docker-push

‎must-gather/README.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Trustee Operator Must-Gather
2+
3+
This directory contains the must-gather implementation for RedHat Build of Trustee. The must-gather tool collects diagnostic information about the operator and its components to assist with troubleshooting.
4+
5+
## What is collected
6+
7+
The must-gather image collects the following information:
8+
9+
- **Namespaces**: `trustee-operator-system`, `openshift-operator-lifecycle-manager`, `openshift-marketplace`
10+
- **Custom Resource Definitions (CRDs)**:
11+
- `kbsconfigs.confidentialcontainers.org`
12+
- `trusteeconfigs.confidentialcontainers.org`
13+
- **Custom Resources**: All KbsConfig and TrusteeConfig instances
14+
- **OLM Installation Resources**:
15+
- ClusterServiceVersion (CSV)
16+
- Subscription
17+
- OperatorGroup
18+
- InstallPlan
19+
- CatalogSource
20+
- PackageManifest
21+
- **RBAC Resources**:
22+
- ClusterRoles (trustee-operator-manager-role, metrics-reader, proxy-role)
23+
- ClusterRoleBindings
24+
- ServiceAccounts (in trustee-operator-system namespace)
25+
- Roles and RoleBindings (in trustee-operator-system namespace)
26+
- Permission checks for controller-manager ServiceAccount
27+
- **Network Resources**:
28+
- NetworkPolicies
29+
- Routes (OpenShift routes)
30+
- Ingresses
31+
- Endpoints and EndpointSlices
32+
- Cluster network configuration
33+
- DNS configuration
34+
- IngressController configuration
35+
- **Storage Resources**:
36+
- PersistentVolumeClaims (in trustee-operator-system namespace)
37+
- PersistentVolumes (cluster-scoped, filtered for trustee-operator-system)
38+
- StorageClasses
39+
- VolumeAttachments
40+
- PVC descriptions
41+
- **Kubernetes Resources**:
42+
- Deployments
43+
- Pods (descriptions and status)
44+
- Services
45+
- ConfigMaps
46+
- Secrets (metadata only, not the actual secret data)
47+
- Events
48+
- **Logs**: Pod logs from all trustee operator components including:
49+
- trustee-operator controller manager
50+
- KBS (Key Broker Service) pods
51+
- **Cluster Information**: Nodes and Machines
52+
53+
## Usage
54+
55+
To collect diagnostic information using this must-gather image:
56+
57+
```bash
58+
oc adm must-gather --image=<image-registry>/trustee-must-gather:latest
59+
```
60+
61+
The collected data will be saved to a local directory (e.g., `must-gather.local.<timestamp>`).
62+
63+
## Building the Image
64+
65+
To build the must-gather image:
66+
67+
```bash
68+
cd must-gather
69+
podman build -t trustee-must-gather:latest .
70+
```
71+
72+
## Directory Structure
73+
74+
```
75+
must-gather/
76+
├── Dockerfile # Must-gather image definition
77+
├── collection-scripts/
78+
│ ├── gather # Main collection orchestrator
79+
│ ├── gather_crds # Collects CRD definitions
80+
│ ├── gather_olm_resources # Collects OLM installation resources
81+
│ ├── gather_rbac # Collects RBAC resources
82+
│ ├── gather_network # Collects network resources
83+
│ ├── gather_storage # Collects storage resources
84+
│ └── gather_trustee_operator # Collects trustee-specific resources and logs
85+
├── LICENSE # Apache 2.0 license
86+
├── Makefile # Build targets for podman/docker
87+
└── README.md # This file
88+
```
89+
90+
## Troubleshooting
91+
92+
If the must-gather fails to collect certain resources:
93+
94+
1. Verify that the trustee operator is installed in the `trustee-operator-system` namespace
95+
2. Check that you have appropriate RBAC permissions to access the resources
96+
3. Review the must-gather pod logs for specific error messages
97+
98+
## Related Documentation
99+
100+
- [Trustee Operator Documentation](../README.md)
101+
- [OpenShift Must-Gather Documentation](https://docs.openshift.com/container-platform/latest/support/gathering-cluster-data.html)

0 commit comments

Comments
 (0)