Bug 2062355: Collect NMState resources when operator is installed #292

creydr · 2022-03-16T10:37:44Z

Currently we are missing the NMState resources in the must-gathers. This is especially a problem as the kubernetes-nmstate-operator became GA in 4.10.
This PR addresses it and adds the NMState resources (namespace resources & CRs) to the must-gathers when the operator is installed.

Hints for reviewers:
I was following a similar approach to how MetalLB is collecting its resources (./collection-scripts/gather_metallb_logs). If there is an easier way (e.g. by adding a certain annotation), please let me know.

How to verify:

Deploy a cluster and install the NMState operator (e.g. via the marketplace)

Add the NMState CR:

cat <<EOF | oc apply -f -
apiVersion: nmstate.io/v1
kind: NMState
metadata:
  name: nmstate
EOF

Wait for the handler being deployed on all nodes (e.g. oc -n openshift-nmstate get po -w)

Add a simple nodenetworkconfigurationpolicy. e.g.:

cat <<EOF | oc apply -f -
apiVersion: nmstate.io/v1
kind: NodeNetworkConfigurationPolicy
metadata:
  name: br1-eth0
spec:
  desiredState:
    interfaces:
    - name: br1
      type: linux-bridge
      state: up
      ipv4:
        dhcp: true
        enabled: true
      bridge:
        port:
        - name: eth0
EOF

Collect the must-gathers and check for the nmstate resouces (e.g. omg get nnce)

openshift-ci · 2022-03-16T10:37:47Z

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

creydr · 2022-03-16T10:40:10Z

/retitle Bug 2062355: Collect NMState resources when operator is installed

openshift-ci · 2022-03-16T10:40:16Z

@creydr: This pull request references Bugzilla bug 2062355, which is invalid:

expected the bug to target the "4.11.0" release, but it targets "---" instead

Comment /bugzilla refresh to re-evaluate validity if changes to the Bugzilla bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

Bug 2062355: Collect NMState resources when operator is installed

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

creydr · 2022-03-16T10:40:29Z

/test all

creydr · 2022-03-16T10:42:29Z

/bugzilla refresh

openshift-ci · 2022-03-16T10:42:36Z

@creydr: This pull request references Bugzilla bug 2062355, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.11.0) matches configured target release for branch (4.11.0)
bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @amalykhi

In response to this:

/bugzilla refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci · 2022-03-16T11:49:09Z

@creydr: This pull request references Bugzilla bug 2062355, which is valid.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.11.0) matches configured target release for branch (4.11.0)
bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @amalykhi

In response to this:

Bug 2062355: Collect NMState resources when operator is installed

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

creydr · 2022-03-16T11:52:02Z

@cybertron @qinqon @rhrazdil: fyi

openshift-ci · 2022-03-16T11:54:11Z

@creydr: This pull request references Bugzilla bug 2062355, which is valid.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.11.0) matches configured target release for branch (4.11.0)
bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @amalykhi

In response to this:

Bug 2062355: Collect NMState resources when operator is installed

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

qinqon · 2022-03-16T11:57:40Z

@creydr we have a must-gather bits to retrieve knmstate stuff at openshift virtualization, maybe you can take inspiration from there.

UPDATE: This is the place https://github.com/kubevirt/must-gather/blob/main/collection-scripts/gather#L16

collection-scripts/gather_nmstate_logs

openshift-ci · 2022-03-16T12:23:30Z

@creydr: This pull request references Bugzilla bug 2062355, which is valid.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target release (4.11.0) matches configured target release for branch (4.11.0)
bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

Requesting review from QA contact:
/cc @amalykhi

In response to this:

Bug 2062355: Collect NMState resources when operator is installed

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

collection-scripts/gather

qinqon · 2022-03-16T12:25:36Z

collection-scripts/gather_nmstate_logs

@@ -0,0 +1,28 @@
+#!/bin/bash


Do we fail must-gather if one of the script fails ? for that we need to do set -e

That's probably something @RickJWagner or @sferich888 can answer better

Given that must-gather might run in clusters that are having problems, we should probably tend to be more forgiving of errors. (And let things run as bullet-proof as possible, even if it means we give extra leniency to components that don't complete their jobs error-free.) We'd prefer to get as much information as possible, even if some pieces of information are unavailable.

Signed-off-by: Christoph Stäbler <cstabler@redhat.com>

creydr · 2022-03-16T14:51:27Z

/assign @RickJWagner

RickJWagner

This looks good to me.

One point to consider: There's a lot of similarity between gather_nmstate and scripts like gather_metallb_logs. Maybe consider factoring out the common stuff into a script that could be sourced by other scripts. (DRY).

cybertron · 2022-03-17T20:17:18Z

Tried it locally, looks like it captured everything we need.
/lgtm

amalykhi · 2022-03-20T06:57:09Z

/lgtm

openshift-ci · 2022-03-20T06:57:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: amalykhi, creydr, cybertron, RickJWagner

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~collection-scripts/OWNERS~~ [RickJWagner]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

creydr · 2022-03-22T07:37:22Z

/test all

creydr · 2022-03-22T08:51:53Z

/retest-required

creydr · 2022-03-22T10:10:13Z

/retest-required

creydr · 2022-03-22T14:27:58Z

/test e2e-aws

creydr · 2022-03-22T14:42:51Z

/test e2e-aws

creydr · 2022-03-22T15:17:18Z

/test e2e-aws

creydr · 2022-03-22T15:27:43Z

/retest-required

creydr · 2022-03-22T18:23:49Z

/test e2e-aws

openshift-bot · 2022-03-22T19:14:09Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-03-22T20:02:08Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-bot · 2022-03-22T21:16:55Z

/retest-required

Please review the full test history for this PR and help us cut down flakes.

openshift-ci · 2022-03-22T23:30:14Z

@creydr: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

openshift-ci · 2022-03-22T23:31:22Z

@creydr: All pull requests linked via external trackers have merged:

openshift/must-gather#292

Bugzilla bug 2062355 has been moved to the MODIFIED state.

In response to this:

Bug 2062355: Collect NMState resources when operator is installed

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

creydr · 2022-03-29T07:14:45Z

/cherry-pick release-4.10

openshift-cherrypick-robot · 2022-03-29T07:15:24Z

@creydr: new pull request created: #294

In response to this:

/cherry-pick release-4.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 16, 2022

openshift-ci bot requested review from RickJWagner and sferich888 March 16, 2022 10:38

openshift-ci bot changed the title ~~Collect NMState resources when operator is installed~~ Bug 2062355: Collect NMState resources when operator is installed Mar 16, 2022

openshift-ci bot added bugzilla/severity-medium Referenced Bugzilla bug's severity is medium for the branch this PR is targeting. bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. labels Mar 16, 2022

openshift-ci bot added bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. and removed bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. labels Mar 16, 2022

openshift-ci bot requested a review from amalykhi March 16, 2022 10:42

creydr marked this pull request as ready for review March 16, 2022 11:49

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 16, 2022

openshift-ci bot requested a review from davemulford March 16, 2022 11:49

qinqon suggested changes Mar 16, 2022

View reviewed changes

collection-scripts/gather_nmstate_logs Outdated Show resolved Hide resolved

creydr force-pushed the collect-nmstate-logs branch from 110a945 to 5cf76c5 Compare March 16, 2022 12:21

creydr requested a review from qinqon March 16, 2022 12:22

qinqon suggested changes Mar 16, 2022

View reviewed changes

Collect nmstate resources when operator is installed

45e1589

Signed-off-by: Christoph Stäbler <cstabler@redhat.com>

creydr force-pushed the collect-nmstate-logs branch from 5cf76c5 to 45e1589 Compare March 16, 2022 13:46

openshift-ci bot assigned RickJWagner Mar 16, 2022

RickJWagner approved these changes Mar 16, 2022

View reviewed changes

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 16, 2022

RickJWagner removed their assignment Mar 17, 2022

openshift-ci bot assigned cybertron Mar 17, 2022

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Mar 17, 2022

openshift-ci bot assigned amalykhi Mar 20, 2022

openshift-merge-robot merged commit b22ad2b into openshift:master Mar 22, 2022

creydr mentioned this pull request Mar 23, 2022

Simplify CRD collection #293

Merged

openshift-cherrypick-robot mentioned this pull request Mar 29, 2022

[release-4.10] Bug 2069554: Collect NMState resources when operator is installed #294

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug 2062355: Collect NMState resources when operator is installed #292

Bug 2062355: Collect NMState resources when operator is installed #292

creydr commented Mar 16, 2022 •

edited

openshift-ci bot commented Mar 16, 2022

creydr commented Mar 16, 2022

openshift-ci bot commented Mar 16, 2022

creydr commented Mar 16, 2022

creydr commented Mar 16, 2022

openshift-ci bot commented Mar 16, 2022

openshift-ci bot commented Mar 16, 2022

creydr commented Mar 16, 2022

openshift-ci bot commented Mar 16, 2022

qinqon commented Mar 16, 2022 •

edited

openshift-ci bot commented Mar 16, 2022

qinqon Mar 16, 2022 •

edited

creydr Mar 16, 2022

RickJWagner Mar 16, 2022 •

edited

creydr commented Mar 16, 2022

RickJWagner left a comment

cybertron commented Mar 17, 2022

amalykhi commented Mar 20, 2022

openshift-ci bot commented Mar 20, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

openshift-bot commented Mar 22, 2022

openshift-bot commented Mar 22, 2022

openshift-bot commented Mar 22, 2022

openshift-ci bot commented Mar 22, 2022

openshift-ci bot commented Mar 22, 2022

creydr commented Mar 29, 2022

openshift-cherrypick-robot commented Mar 29, 2022

Bug 2062355: Collect NMState resources when operator is installed #292

Bug 2062355: Collect NMState resources when operator is installed #292

Conversation

creydr commented Mar 16, 2022 • edited

openshift-ci bot commented Mar 16, 2022

creydr commented Mar 16, 2022

openshift-ci bot commented Mar 16, 2022

creydr commented Mar 16, 2022

creydr commented Mar 16, 2022

openshift-ci bot commented Mar 16, 2022

openshift-ci bot commented Mar 16, 2022

creydr commented Mar 16, 2022

openshift-ci bot commented Mar 16, 2022

qinqon commented Mar 16, 2022 • edited

openshift-ci bot commented Mar 16, 2022

qinqon Mar 16, 2022 • edited

Choose a reason for hiding this comment

creydr Mar 16, 2022

Choose a reason for hiding this comment

RickJWagner Mar 16, 2022 • edited

Choose a reason for hiding this comment

creydr commented Mar 16, 2022

RickJWagner left a comment

Choose a reason for hiding this comment

cybertron commented Mar 17, 2022

amalykhi commented Mar 20, 2022

openshift-ci bot commented Mar 20, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

creydr commented Mar 22, 2022

openshift-bot commented Mar 22, 2022

openshift-bot commented Mar 22, 2022

openshift-bot commented Mar 22, 2022

openshift-ci bot commented Mar 22, 2022

openshift-ci bot commented Mar 22, 2022

creydr commented Mar 29, 2022

openshift-cherrypick-robot commented Mar 29, 2022

creydr commented Mar 16, 2022 •

edited

qinqon commented Mar 16, 2022 •

edited

qinqon Mar 16, 2022 •

edited

RickJWagner Mar 16, 2022 •

edited