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

* Collect oscp CRs

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 OpenStackControlPlane 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 <[email protected]>

Conflicts:
    docs/gathered-data.md
    pkg/gatherers/clusterconfig/clusterconfig_gatherer.go

Related: #OSPRH-5904
(cherry picked from commit 999cbf5)

* Add anonymization for data in the oscp CR

Some fields in the collected OpenStackControlPlane CRs should be
anonymized. This is for example field 'options' from the 'dns'
service spec.

Related: #OSPRH-5904
(cherry picked from commit d725c1f)

* Add test module for the oscp CR gatherer

(cherry picked from commit 1573f08)

* Add way to drop some fields from the gathered oscp CR

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

(cherry picked from commit c697f3d)

* Collect osdpns CRs

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 <[email protected]>

Related: #OSPRH-5904
(cherry picked from commit 809ea80)

* Collect osdpd CRs

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 <[email protected]>

Related: #OSPRH-5904
(cherry picked from commit 52659ff)

* Add 'ansibleHost' field to be annonymized

(cherry picked from commit 933ac23)

* Rename names of the collected OpenStackDataPlane resources

(cherry picked from commit 5a82b6b)

* Update examples of the OpenStack CRs to their latest versions

Related: #OSPRH-5904
(cherry picked from commit c6feae6)

* Collect OpenStackVersion CRs

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
(cherry picked from commit d0d5cc7)

Author: slawqo

docs/anonymized-data.md

@@ -79,3 +79,13 @@ anonymized by the Insights Operator. This list is subject to change.
   - Status.HTTPProxy
   - Status.HTTPSProxy
   - Status.NoProxy
+- OpenstackControlplanes
+  - IP Addresses
+  - Spec.dns.template.options
+- OpenstackDataplaneNodeSets
+  - IP Addresses
+  - ansibleHost
+  - ansibleUser
+  - edpm_sshd_allowed_ranges
+  - dnsClusterAddresses
+  - Status.allHostnames

docs/gathered-data.md

@@ -1681,6 +1681,104 @@ Collects logs from pods in `openshift-sdn` namespace with following substrings:
 None
 
 
+## PodDefinition
+
+## OpenstackControlplanes
+
+Collects `openstackcontrolplanes.core.openstack.org`
+resources from all namespaces
+
+### API Reference
+None
+
+### Sample data
+- [docs/insights-archive-sample/namespaces/openstack/core.openstack.org/openstackcontrolplanes/openstack-galera-network-isolation.json](./insights-archive-sample/namespaces/openstack/core.openstack.org/openstackcontrolplanes/openstack-galera-network-isolation.json)
+
+### Location in archive
+- `namespaces/{namespace}/core.openstack.org/openstackcontrolplanes/{name}.json`
+
+### Config ID
+`clusterconfig/openstack_controlplanes`
+
+### Released version
+- 4.17
+
+### Changes
+None
+
+
+## OpenstackDataplaneDeployments
+
+Collects `openstackdataplanedeployments.dataplane.openstack.org`
+resources from all namespaces
+
+### API Reference
+None
+
+### Sample data
+- [docs/insights-archive-sample/namespaces/openstack/dataplane.openstack.org/openstackdataplanedeployments/edpm-deployment.json](./insights-archive-sample/namespaces/openstack/dataplane.openstack.org/openstackdataplanedeployments/edpm-deployment.json)
+
+### Location in archive
+- `namespaces/{namespace}/dataplane.openstack.org/openstackdataplanedeployments/{name}.json`
+
+### Config ID
+`clusterconfig/openstack_dataplanedeployments`
+
+### Released version
+- 4.17
+
+### Changes
+None
+
+
+## OpenstackDataplaneNodeSets
+
+Collects `openstackdataplanenodesets.dataplane.openstack.org`
+resources from all namespaces
+
+### API Reference
+None
+
+### Sample data
+- [docs/insights-archive-sample/namespaces/openstack/dataplane.openstack.org/openstackdataplanenodesets/openstack-edpm-ipam.json](./insights-archive-sample/namespaces/openstack/dataplane.openstack.org/openstackdataplanenodesets/openstack-edpm-ipam.json)
+
+### Location in archive
+- `namespaces/{namespace}/dataplane.openstack.org/openstackdataplanenodesets/{name}.json`
+
+### Config ID
+`clusterconfig/openstack_dataplanenodesets`
+
+### Released version
+- 4.17
+
+### Changes
+None
+ 
+
+## Openstackversions
+
+Collects `openstackversion.core.openstack.org`
+resources from all namespaces
+
+### API Reference
+None
+
+### Sample data
+- [docs/insights-archive-sample/namespaces/openstack/core.openstack.org/openstackversions/openstack-galera-network-isolation.json](./insights-archive-sample/namespaces/openstack/core.openstack.org/openstackversions/openstack-galera-network-isolation.json)
+
+### Location in archive
+- `namespaces/{namespace}/core.openstack.org/openstackversions/{name}.json`
+
+### Config ID
+`clusterconfig/openstack_version`
+
+### Released version
+- 4.17
+
+### Changes
+None
+
+
 ## PodDefinition
 
 Collects pod definition from pods that are

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

@@ -129,6 +129,38 @@
       "warnings": null,
       "panic": null
     },
+    {
+      "name": "clusterconfig/openstack_controlplanes",
+      "duration_in_ms": 25,
+      "records_count": 1,
+      "errors": null,
+      "warnings": null,
+      "panic": null
+    },
+    {
+      "name": "clusterconfig/openstack_dataplanedeployments",
+      "duration_in_ms": 9,
+      "records_count": 1,
+      "errors": null,
+      "warnings": null,
+      "panic": null
+    },
+    {
+      "name": "clusterconfig/openstack_dataplanenodesets",
+      "duration_in_ms": 9,
+      "records_count": 1,
+      "errors": null,
+      "warnings": null,
+      "panic": null
+    },
+    {
+      "name": "clusterconfig/openstack_version",
+      "duration_in_ms": 25,
+      "records_count": 1,
+      "errors": null,
+      "warnings": null,
+      "panic": null
+    },
     {
       "name": "clusterconfig/scheduler_logs",
       "duration_in_ms": 617,