Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/redhat-cop/must-gather-operator
An operator to simplify the creation and upload of cluster diagnostics from the must-gather tool
https://github.com/redhat-cop/must-gather-operator
container-cop k8s-operator
Last synced: 3 months ago
JSON representation
An operator to simplify the creation and upload of cluster diagnostics from the must-gather tool
- Host: GitHub
- URL: https://github.com/redhat-cop/must-gather-operator
- Owner: redhat-cop
- License: apache-2.0
- Created: 2019-11-26T16:36:47.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-07T08:50:55.000Z (7 months ago)
- Last Synced: 2024-06-19T00:19:37.725Z (5 months ago)
- Topics: container-cop, k8s-operator
- Language: Go
- Homepage:
- Size: 396 KB
- Stars: 10
- Watchers: 10
- Forks: 15
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Must Gather Operator
[](https://goreportcard.com/report/github.com/redhat-cop/must-gather-operator)
The must gather operator helps collecting must gather information on a cluster and uploading it to a case.
To use the operator a cluster administrator can create the following must gather CR:
```yaml
apiVersion: redhatcop.redhat.io/v1alpha1
kind: MustGather
metadata:
name: example-mustgather
spec:
caseID: '02527285'
caseManagementAccountSecretRef:
name: case-management-creds
```
this request will collect the standard must gather info and upload it to case `#02527285` using the credentials found in the `caseManagementCreds` secret.
A more complex example:
```yaml
apiVersion: redhatcop.redhat.io/v1alpha1
kind: MustGather
metadata:
name: full-mustgather
spec:
caseID: '02527285'
caseManagementAccountSecretRef:
name: case-management-creds
serviceAccountRef:
name: must-gather-admin
mustGatherImages:
- quay.io/kubevirt/must-gather:latest
- quay.io/ocs-dev/ocs-must-gather
```
in this example we are using a specific service account (which must have cluster admin permissions as per must-gather requirements) and we are specifying a couple of additional must gather images to be run for the `kubevirt` and `ocs` subsystem. If not specified serviceAccountRef.Name will default to `default`. Also the standard must gather image: `quay.io/openshift/origin-must-gather:latest` is always added by default.
## Proxy Support
The MustGather operator supports using a proxy. The proxy setting can be specified in the MustGather object. If not specified, the cluster default proxy setting will be used. Here is an example:
```yaml
apiVersion: redhatcop.redhat.io/v1alpha1
kind: MustGather
metadata:
name: example-mustgather
spec:
caseID: '02527285'
caseManagementAccountSecretRef:
name: case-management-creds
proxyConfig:
httpProxy: http://myproxy
httpsProxy: https://my_http_proxy
noProxy: master-api
```
## Garbage collection
MustGather instances are cleaned up by the Must Gather operator about 6 hours after completion, regardless of whether they were successful.
This is a way to prevent the accumulation of unwanted MustGather resources and their corresponding job resources.
## Deploying the Operator
This is a cluster-level operator that you can deploy in any namespace, `must-gather-operator` is recommended.
It is recommended to deploy this operator via [`OperatorHub`](https://operatorhub.io/), but you can also deploy it using [`Helm`](https://helm.sh/).
### Multiarch Support
| Arch | Support |
|:-:|:-:|
| amd64 | ✅ |
| arm64 | ✅ |
| ppc64le | ✅ |
| s390x | ❌ |
### Deploying from OperatorHub
> **Note**: This operator supports being installed disconnected environments
If you want to utilize the Operator Lifecycle Manager (OLM) to install this operator, you can do so in two ways: from the UI or the CLI.
#### Deploying from OperatorHub UI
* If you would like to launch this operator from the UI, you'll need to navigate to the OperatorHub tab in the console.Before starting, make sure you've created the namespace that you want to install this operator to with the following:
```shell
oc new-project must-gather-operator
```
* Once there, you can search for this operator by name: `must gather`. This will then return an item for our operator and you can select it to get started. Once you've arrived here, you'll be presented with an option to install, which will begin the process.
* After clicking the install button, you can then select the namespace that you would like to install this to as well as the installation strategy you would like to proceed with (`Automatic` or `Manual`).
* Once you've made your selection, you can select `Subscribe` and the installation will begin. After a few moments you can go ahead and check your namespace and you should see the operator running.
#### Deploying from OperatorHub using CLI
If you'd like to launch this operator from the command line, you can use the manifests contained in this repository by running the following:
```shell
oc new-project must-gather-operator
oc apply -f config/operatorhub -n must-gather-operator
```
This will create the appropriate OperatorGroup and Subscription and will trigger OLM to launch the operator in the specified namespace.
### Deploying with Helm
Here are the instructions to install the latest release with Helm.
```shell
oc new-project must-gather-operator
helm repo add must-gather-operator https://redhat-cop.github.io/must-gather-operator
helm repo update
helm install must-gather-operator must-gather-operator/must-gather-operator
```
This can later be updated with the following commands:
```shell
helm repo update
helm upgrade must-gather-operator must-gather-operator/must-gather-operator
```
## Metrics
Prometheus compatible metrics are exposed by the Operator and can be integrated into OpenShift's default cluster monitoring. To enable OpenShift cluster monitoring, label the namespace the operator is deployed in with the label `openshift.io/cluster-monitoring="true"`.
```shell
oc label namespace openshift.io/cluster-monitoring="true"
```
### Testing metrics
```sh
export operatorNamespace=must-gather-operator-local # or must-gather-operator
oc label namespace ${operatorNamespace} openshift.io/cluster-monitoring="true"
oc rsh -n openshift-monitoring -c prometheus prometheus-k8s-0 /bin/bash
export operatorNamespace=must-gather-operator-local # or must-gather-operator
curl -v -s -k -H "Authorization: Bearer $(cat /var/run/secrets/kubernetes.io/serviceaccount/token)" https://must-gather-operator-controller-manager-metrics.${operatorNamespace}.svc.cluster.local:8443/metrics
exit
```
## Development
### Running the operator locally
```shell
make install
export repo=raffaelespazzoli #replace with yours
docker login quay.io/$repo/must-gather-operator
make docker-build IMG=quay.io/$repo/must-gather-operator:latest
make docker-push IMG=quay.io/$repo/must-gather-operator:latest
oc new-project must-gather-operator-local
kustomize build ./config/local-development | oc apply -f - -n must-gather-operator-local
export DEFAULT_MUST_GATHER_IMAGE='quay.io/openshift/origin-must-gather:4.6'
export JOB_TEMPLATE_FILE_NAME=./config/templates/job.template.yaml
export token=$(oc serviceaccounts get-token 'must-gather-controller-manager' -n must-gather-operator-local)
oc login --token ${token}
make run ENABLE_WEBHOOKS=false
```
### Test helm chart locally
Define an image and tag. For example...
```shell
export imageRepository="quay.io/redhat-cop/must-gather-operator"
export imageTag="$(git -c 'versionsort.suffix=-' ls-remote --exit-code --refs --sort='version:refname' --tags https://github.com/redhat-cop/must-gather-operator.git '*.*.*' | tail --lines=1 | cut --delimiter='/' --fields=3)"
```
Deploy chart...
```shell
make helmchart IMG=${imageRepository} VERSION=${imageTag}
helm upgrade -i must-gather-operator-local charts/must-gather-operator -n must-gather-operator-local --create-namespace
```
Delete...
```shell
helm delete must-gather-operator-local -n must-gather-operator-local
kubectl delete -f charts/must-gather-operator/crds/crds.yaml
```
### Building/Pushing the operator image
```shell
export repo=raffaelespazzoli #replace with yours
docker login quay.io/$repo/must-gather-operator
make docker-build IMG=quay.io/$repo/must-gather-operator:latest
make docker-push IMG=quay.io/$repo/must-gather-operator:latest
```
### Deploy to OLM via bundle
```shell
make manifests
make bundle IMG=quay.io/$repo/must-gather-operator:latest
operator-sdk bundle validate ./bundle --select-optional name=operatorhub
make bundle-build BUNDLE_IMG=quay.io/$repo/must-gather-operator-bundle:latest
docker login quay.io/$repo/must-gather-operator-bundle
docker push quay.io/$repo/must-gather-operator-bundle:latest
operator-sdk bundle validate quay.io/$repo/must-gather-operator-bundle:latest --select-optional name=operatorhub
oc new-project must-gather-operator
oc label namespace must-gather-operator openshift.io/cluster-monitoring="true"
operator-sdk cleanup must-gather-operator -n must-gather-operator
operator-sdk run bundle --install-mode AllNamespaces -n must-gather-operator quay.io/$repo/must-gather-operator-bundle:latest
```
### Releasing
```shell
git tag -a "" -m ""
git push upstream
```
If you need to remove a release:
```shell
git tag -d
git push upstream --delete
```
If you need to "move" a release to the current main
```shell
git tag -f
git push upstream -f
```
### Cleaning up
```shell
operator-sdk cleanup must-gather-operator -n must-gather-operator
oc delete operatorgroup operator-sdk-og
oc delete catalogsource must-gather-operator-catalog
```