OSPRH-5904: Integration of the OpenStack CRs into the insights-operator #951

slawqo · 2024-06-21T09:13:13Z

Control Plan of the Red Hat OpenStack starting from the version 18 (RHOSO 18) will be deployed using OpenShift operators as a set of OpenShift applications. Compute nodes will be deployed still as RHEL nodes and will be outside of the OpenShift cluster but all will be mangaged by the Dataplane-operator and only interface for OpenStack operators will be though the CRs:
- OpenStackControlPlane CR for the control plane,
- OpenStackDataplaneNodeSet and OpenStackDataplaneDeployment CRs for the
compute nodes.
This PR adds those OpenStack CRs to the insights-operator so that whole configuration of the OpenStack control plane may be gathered by the insights-operator and send to analysis to the Insights server.

Sample Archive

docs/insights-archive-sample/customresources/core.openstack.org/openstackcontrolplanes/openstack/openstack-galera-network-isolation.json
docs/insights-archive-sample/customresources/dataplane.openstack.org/openstackdataplanedeployments/openstack/edpm-deployment.json
docs/insights-archive-sample/customresources/dataplane.openstack.org/openstackdataplanenodesets/openstack/openstack-edpm.json

Unit Tests

pkg/gatherers/clusterconfig/gather_openstack_controlplanes_test.go
pkg/gatherers/clusterconfig/gather_openstack_dataplane_deployments_test.go
pkg/gatherers/clusterconfig/gather_openstack_dataplane_node_sets_test.go

Privacy

Anonymization functions are added and used while collecting OpenStack CRs. Anonymized data:

OpenstackControlplanes
- Spec.dns.template.options
OpenstackDataplaneNodeSets
- ansibleUser
- edpm_sshd_allowed_ranges
- dnsClusterAddresses
- Status.allHostnames

Changelog

No

Breaking Changes

No

References

https://issues.redhat.com/browse/OSPRH-5904

Additional Info

To test what data are collected by the insights-operator with those changes, OpenStack has to be deployed on top of the OpenShift cluster. The easiest way to do this is to use CRC OpenShift and install_yamls tool. Please follow the guide to deploy OpenStack Control Plane and OpenStackDataPlane CRs.

pkg/gatherers/clusterconfig/gather_openstack_helpers.go

docs/insights-archive-sample/insights-operator/gathers.json

docs/gathered-data.md

.../core.openstack.org/openstackcontrolplanes/openstack/openstack-galera-network-isolation.json

pkg/gatherers/clusterconfig/gather_openstack_dataplane_deployments.go

pkg/gatherers/clusterconfig/gather_openstack_dataplane_deployments_test.go

pkg/gatherers/clusterconfig/gather_openstack_dataplane_node_sets.go

pkg/gatherers/clusterconfig/const.go

pkg/gatherers/clusterconfig/gather_openstack_controlplanes.go

SeanMooney · 2024-06-25T13:42:28Z

pkg/gatherers/clusterconfig/gather_openstack_dataplane_node_sets.go

+	data.Object = anonymizeIpAddresses(data.Object)
+	data.Object = anonymizeFields(data.Object, fieldsToAnonymize)
+	data.Object = anonymizeCustomPathFields(data.Object, customFieldsToAnonymize)
+	data.Object = anonymizeStatusHostNames(data.Object)


each node object in the node set can have multiple hostnames assocrrated with it too.

there is a hostname subsection
https://github.com/openstack-k8s-operators/openstack-operator/blob/main/apis/core/v1beta1/openstackcontrolplane_types.go#L361-L370

the AnsibleOpts also contained sensitive info in general but that is a mapping filed with arbiary keys.

mouch of the value comes form processing those value but its harder to Anonymize in general.

at a minium we should be Anonymize ansibleHost

https://github.com/openstack-k8s-operators/openstack-operator/blob/main/apis/core/v1beta1/openstackcontrolplane_types.go#L361-L370

and any fixed ipes that exixits in the networks struct
https://github.com/openstack-k8s-operators/openstack-operator/blob/main/apis/core/v1beta1/openstackcontrolplane_types.go#L361-L370

ansibleHost field added to be anonymized, fixed ips should be anonymized by the anonymizeIpAddresses() function. If not, please give me example of the CR where it is not anonymized, so I can fix it

pkg/gatherers/clusterconfig/gather_openstack_controlplanes.go

manifests/03-clusterrole.yaml

slawqo · 2024-07-19T11:03:59Z

/retest

slawqo · 2024-07-22T11:08:53Z

/retest

pkg/gatherers/clusterconfig/gather_openstack_dataplane_node_sets.go

tremes · 2024-07-26T12:00:37Z

pkg/gatherers/clusterconfig/gather_openstack_helpers.go

+				// so that its string representation is empty, it is easier to just
+				// put 'xxx' in that place
+				if len(fieldValueStr) == 0 {
+					data[fieldName] = "xxx"


It's not a blocker, but I don't understand this logic much. Why overwriting an empty string? It's not necessary, is it?

So it seems if fieldValue is e.g. list of items or is of type map[string]interface{} then in L59 mapping fieldValueStr will be empty string and in such case, I want to simply put 'xxx' instead of try to go deeper and look into that other nested type and iterate over it's fields.

OK you're right https://play.golang.com/p/5RrmRPcrTnT. I thought it would panic, but it's not the case. Putting the xxx still seems a bit unnecessary but OK. Thank you.

It panics "only" when one return value is used for the "type casting", which make sense....and I didn't realize that.

tremes · 2024-07-26T12:00:49Z

pkg/gatherers/clusterconfig/gather_openstack_helpers.go

+		fieldAnonymized = false
+		for _, fieldToAnonymize := range fieldsToAnonymize {
+			if fieldName == fieldToAnonymize {
+				fieldValueStr, _ := fieldValue.(string)


Similar her. This can panic AFAIK

I think that in this case it will be ok, because if fieldValue will be of type like list or map[string]interface{} then fieldValueStr will be empty string and that will be handled in the if condition in L63

OK. Discussed in the thread below. Thanks.

pkg/gatherers/clusterconfig/gather_openstack_controlplanes_test.go

tremes · 2024-07-26T12:06:41Z

I was able to create only openstackcontrolplanes and openstackversions CRs in my cluster. It works good! Thank you! I added few comments which would be good to address.

/approve

openshift-ci · 2024-07-26T12:07:40Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: slawqo, tremes

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:

~~OWNERS~~ [tremes]

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

For now it will drop only 'metadata/annotations/kubectl.kubernetes.io/last-applied-configuration' but other fields can be added to that list too.

Control Plan of the Red Hat OpenStack starting from the version 18 (RHOSO 18) will be deployed using OpenShift operators as a set of OpenShift applications. Compute nodes will be deployed still as RHEL nodes and will be outside of the OpenShift cluster but all will be mangaged by the Dataplane-operator and only interface for OpenStack operators will be though the CRs: - OpenStackControlPlane CR for the control plane, - OpenStackDataplaneNodeSet and OpenStackDataplaneDeployment CRs for the compute nodes. This patch adds OpenStackDataplaneNodeSet CR to the insights-operator so that whole configuration of the OpenStack control plane may be gathered by the insights-operator and send to analysis to the Insights server. Co-Authored-By: Yatin Karel <ykarel@redhat.com> Related: #OSPRH-5904

Control Plan of the Red Hat OpenStack starting from the version 18 (RHOSO 18) will be deployed using OpenShift operators as a set of OpenShift applications. Compute nodes will be deployed still as RHEL nodes and will be outside of the OpenShift cluster but all will be mangaged by the Dataplane-operator and only interface for OpenStack operators will be though the CRs: - OpenStackControlPlane CR for the control plane, - OpenStackDataplaneNodeSet and OpenStackDataplaneDeployment CRs for the compute nodes. This patch adds OpenStackDataplaneDeployment CR to the insights-operator so that whole configuration of the OpenStack control plane may be gathered by the insights-operator and send to analysis to the Insights server. Co-Authored-By: Yatin Karel <ykarel@redhat.com> Related: #OSPRH-5904

Related: #OSPRH-5904

Red Hat's openstack-operator in addition to the OpenStackControlPlane and OpenStackDataPlane CRs uses also additonal CR 'openstackversions' which reports version of the openstack(s) deployed in the OCP cluster. This patch adds support for gathering also this CRs from the cluster if they exists. Related: #OSPRH-5904

slawqo · 2024-07-29T09:58:11Z

Today I run locally insights-operator with those changes so if you want to see them, you can search for clusterID "f043c1f4-f148-4030-9f16-9d5c242d2c8c"

tremes · 2024-07-29T10:03:35Z

/lgtm

tremes · 2024-07-29T12:53:22Z

insights-operator-e2e-tests are failing, but this is a known failure.

slawqo · 2024-07-29T13:23:09Z

/retest

BaiyangZhou · 2024-07-30T05:47:12Z

/label qe-approved

openshift-ci-robot · 2024-07-30T05:47:16Z

@slawqo: This pull request references OSPRH-5904 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.17.0" version, but no target version was set.

In response to this:

Control Plan of the Red Hat OpenStack starting from the version 18 (RHOSO 18) will be deployed using OpenShift operators as a set of OpenShift applications. Compute nodes will be deployed still as RHEL nodes and will be outside of the OpenShift cluster but all will be mangaged by the Dataplane-operator and only interface for OpenStack operators will be though the CRs:

OpenStackControlPlane CR for the control plane,

OpenStackDataplaneNodeSet and OpenStackDataplaneDeployment CRs for the
compute nodes.
This PR adds those OpenStack CRs to the insights-operator so that whole configuration of the OpenStack control plane may be gathered by the insights-operator and send to analysis to the Insights server.

Categories

Bugfix

Data Enhancement

Feature

Backporting

Others (CI, Infrastructure, Documentation)

Sample Archive

docs/insights-archive-sample/customresources/core.openstack.org/openstackcontrolplanes/openstack/openstack-galera-network-isolation.json

docs/insights-archive-sample/customresources/dataplane.openstack.org/openstackdataplanedeployments/openstack/edpm-deployment.json

docs/insights-archive-sample/customresources/dataplane.openstack.org/openstackdataplanenodesets/openstack/openstack-edpm.json

Unit Tests

pkg/gatherers/clusterconfig/gather_openstack_controlplanes_test.go

pkg/gatherers/clusterconfig/gather_openstack_dataplane_deployments_test.go

pkg/gatherers/clusterconfig/gather_openstack_dataplane_node_sets_test.go

Privacy

Anonymization functions are added and used while collecting OpenStack CRs. Anonymized data:

OpenstackControlplanes

Spec.dns.template.options

OpenstackDataplaneNodeSets

ansibleUser

edpm_sshd_allowed_ranges

dnsClusterAddresses

Status.allHostnames

Changelog

No

Breaking Changes

No

References

https://issues.redhat.com/browse/OSPRH-5904

Additional Info

To test what data are collected by the insights-operator with those changes, OpenStack has to be deployed on top of the OpenShift cluster. The easiest way to do this is to use CRC OpenShift and install_yamls tool. Please follow the guide to deploy OpenStack Control Plane and OpenStackDataPlane CRs.

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 openshift-eng/jira-lifecycle-plugin repository.

karelyatin · 2024-07-30T06:08:31Z

/lgtm

karelyatin · 2024-07-30T06:08:41Z

/test insights-operator-e2e-tests

tremes · 2024-07-30T08:06:39Z

@karelyatin @slawqo the test failure is persistent. We need to override the test for now.

openshift-ci-robot · 2024-07-30T08:29:01Z

/retest-required

Remaining retests: 0 against base HEAD b03bdbd and 2 for PR HEAD d0d5cc7 in total

tremes · 2024-07-30T08:34:52Z

The test failure is a known problem. We just need a new JIRA ticket to track it. cc @BaiyangZhou
/override ci/prow/insights-operator-e2e-tests

openshift-ci · 2024-07-30T08:35:33Z

@tremes: Overrode contexts on behalf of tremes: ci/prow/insights-operator-e2e-tests

In response to this:

The test failure is a known problem. We just need a new JIRA ticket to track it. cc @BaiyangZhou
/override ci/prow/insights-operator-e2e-tests

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-sigs/prow repository.

openshift-ci · 2024-07-30T08:38:13Z

@slawqo: 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-sigs/prow repository. I understand the commands that are listed here.

openshift-bot · 2024-07-30T11:50:17Z

[ART PR BUILD NOTIFIER]

Distgit: ose-insights-operator
This PR has been included in build ose-insights-operator-container-v4.18.0-202407301115.p0.g8024649.assembly.stream.el9.
All builds following this will include this PR.

openshift-bot · 2024-07-30T11:50:18Z

[ART PR BUILD NOTIFIER]

Distgit: ose-insights-operator
This PR has been included in build ose-insights-operator-container-v4.17.0-202407301116.p0.g8024649.assembly.stream.el9.
All builds following this will include this PR.

slawqo marked this pull request as draft June 21, 2024 09:13

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 Jun 21, 2024

openshift-ci bot requested review from ncaak and tremes June 21, 2024 09:16

tremes reviewed Jun 21, 2024

View reviewed changes

pkg/gatherers/clusterconfig/gather_openstack_helpers.go Outdated Show resolved Hide resolved

karelyatin reviewed Jun 21, 2024

View reviewed changes

tremes reviewed Jun 21, 2024

View reviewed changes

pkg/gatherers/clusterconfig/gather_openstack_controlplanes.go Outdated Show resolved Hide resolved

SeanMooney reviewed Jun 25, 2024

View reviewed changes

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 27, 2024

slawqo force-pushed the OSPRH-5904 branch from 37a359b to e8c8790 Compare June 28, 2024 12:29

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 28, 2024

slawqo force-pushed the OSPRH-5904 branch from e8c8790 to 9f6edd8 Compare July 10, 2024 09:45

slawqo marked this pull request as ready for review July 10, 2024 09:51

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 Jul 10, 2024

openshift-ci bot requested a review from tremes July 10, 2024 09:51

slawqo force-pushed the OSPRH-5904 branch from 9f6edd8 to 826abe6 Compare July 11, 2024 11:00

tremes reviewed Jul 11, 2024

View reviewed changes

pkg/gatherers/clusterconfig/gather_openstack_controlplanes.go Outdated Show resolved Hide resolved

tremes reviewed Jul 11, 2024

View reviewed changes

manifests/03-clusterrole.yaml Outdated Show resolved Hide resolved

slawqo force-pushed the OSPRH-5904 branch from 826abe6 to 7b9a411 Compare July 17, 2024 09:23

tremes reviewed Jul 26, 2024

View reviewed changes

pkg/gatherers/clusterconfig/gather_openstack_dataplane_node_sets.go Outdated Show resolved Hide resolved

tremes reviewed Jul 26, 2024

View reviewed changes

pkg/gatherers/clusterconfig/gather_openstack_dataplane_node_sets.go Outdated Show resolved Hide resolved

tremes reviewed Jul 26, 2024

View reviewed changes

pkg/gatherers/clusterconfig/gather_openstack_controlplanes_test.go Outdated Show resolved Hide resolved

openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 26, 2024

tremes changed the title ~~Integration of the OpenStack CRs into the insights-operator~~ OSPRH-5904: Integration of the OpenStack CRs into the insights-operator Jul 26, 2024

slawqo added 8 commits July 29, 2024 11:15

Add test module for the oscp CR gatherer

1573f08

Add way to drop some fields from the gathered oscp CR

c697f3d

For now it will drop only 'metadata/annotations/kubectl.kubernetes.io/last-applied-configuration' but other fields can be added to that list too.

Add 'ansibleHost' field to be annonymized

933ac23

Rename names of the collected OpenStackDataPlane resources

5a82b6b

Update examples of the OpenStack CRs to their latest versions

c6feae6

Related: #OSPRH-5904

slawqo force-pushed the OSPRH-5904 branch from 7b9a411 to d0d5cc7 Compare July 29, 2024 09:39

openshift-ci bot assigned tremes Jul 29, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jul 29, 2024

openshift-ci bot added the qe-approved Signifies that QE has signed off on this PR label Jul 30, 2024

openshift-ci bot assigned karelyatin Jul 30, 2024

openshift-merge-bot bot merged commit 8024649 into openshift:master Jul 30, 2024
9 checks passed

openshift-ci-robot mentioned this pull request Sep 4, 2024

[release-4.16] OCPBUGS-38021: Integration of the OpenStack CRs into the insights-operator #974

Merged

5 tasks

OSPRH-5904: Integration of the OpenStack CRs into the insights-operator #951

OSPRH-5904: Integration of the OpenStack CRs into the insights-operator #951

Conversation

slawqo commented Jun 21, 2024 • edited Loading

Categories

Sample Archive

Unit Tests

Privacy

Changelog

Breaking Changes

References

Additional Info

Choose a reason for hiding this comment

Choose a reason for hiding this comment

slawqo commented Jul 19, 2024

slawqo commented Jul 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tremes commented Jul 26, 2024

openshift-ci bot commented Jul 26, 2024

slawqo commented Jul 29, 2024

tremes commented Jul 29, 2024

tremes commented Jul 29, 2024

slawqo commented Jul 29, 2024

BaiyangZhou commented Jul 30, 2024

openshift-ci-robot commented Jul 30, 2024 • edited by openshift-ci bot Loading

Categories

Sample Archive

Unit Tests

Privacy

Changelog

Breaking Changes

References

Additional Info

karelyatin commented Jul 30, 2024

karelyatin commented Jul 30, 2024

tremes commented Jul 30, 2024

openshift-ci-robot commented Jul 30, 2024

tremes commented Jul 30, 2024

openshift-ci bot commented Jul 30, 2024

openshift-ci bot commented Jul 30, 2024

openshift-bot commented Jul 30, 2024

openshift-bot commented Jul 30, 2024

slawqo commented Jun 21, 2024 •

edited

Loading

openshift-ci-robot commented Jul 30, 2024 •

edited by openshift-ci bot

Loading