From f1ffd94a7a941cf3461b8d1ee4f0d198a0215063 Mon Sep 17 00:00:00 2001 From: Joel Takvorian Date: Tue, 12 Sep 2023 10:58:43 +0200 Subject: [PATCH] sed netobserv=>network observability --- api/v1beta1/flowcollector_types.go | 1 - .../flows.netobserv.io_flowcollectors.yaml | 3 +- .../flows.netobserv.io_flowcollectors.yaml | 3 +- docs/FlowCollector.md | 2 +- ...wcollector-flows-netobserv-io-v1beta1.adoc | 38 +++++++++---------- hack/asciidoc-gen.sh | 1 + 6 files changed, 23 insertions(+), 25 deletions(-) diff --git a/api/v1beta1/flowcollector_types.go b/api/v1beta1/flowcollector_types.go index c69797516..6733476b2 100644 --- a/api/v1beta1/flowcollector_types.go +++ b/api/v1beta1/flowcollector_types.go @@ -47,7 +47,6 @@ type FlowCollectorSpec struct { // Important: Run "make generate" to regenerate code after modifying this file // Namespace where NetObserv pods are deployed. - // If empty, the namespace of the operator is going to be used. // +kubebuilder:default:=netobserv Namespace string `json:"namespace,omitempty"` diff --git a/bundle/manifests/flows.netobserv.io_flowcollectors.yaml b/bundle/manifests/flows.netobserv.io_flowcollectors.yaml index ac96e58e2..ea1eb1ec8 100644 --- a/bundle/manifests/flows.netobserv.io_flowcollectors.yaml +++ b/bundle/manifests/flows.netobserv.io_flowcollectors.yaml @@ -3845,8 +3845,7 @@ spec: type: object namespace: default: netobserv - description: Namespace where NetObserv pods are deployed. If empty, - the namespace of the operator is going to be used. + description: Namespace where NetObserv pods are deployed. type: string processor: description: '`processor` defines the settings of the component that diff --git a/config/crd/bases/flows.netobserv.io_flowcollectors.yaml b/config/crd/bases/flows.netobserv.io_flowcollectors.yaml index a986f77c2..41f08beca 100644 --- a/config/crd/bases/flows.netobserv.io_flowcollectors.yaml +++ b/config/crd/bases/flows.netobserv.io_flowcollectors.yaml @@ -3832,8 +3832,7 @@ spec: type: object namespace: default: netobserv - description: Namespace where NetObserv pods are deployed. If empty, - the namespace of the operator is going to be used. + description: Namespace where NetObserv pods are deployed. type: string processor: description: '`processor` defines the settings of the component that diff --git a/docs/FlowCollector.md b/docs/FlowCollector.md index 8514bb74d..15e530e14 100644 --- a/docs/FlowCollector.md +++ b/docs/FlowCollector.md @@ -3967,7 +3967,7 @@ Defines the desired state of the FlowCollector resource.

*: the mention namespace string - Namespace where NetObserv pods are deployed. If empty, the namespace of the operator is going to be used.
+ Namespace where NetObserv pods are deployed.

Default: netobserv
diff --git a/docs/flowcollector-flows-netobserv-io-v1beta1.adoc b/docs/flowcollector-flows-netobserv-io-v1beta1.adoc index 7e788721d..be522652a 100644 --- a/docs/flowcollector-flows-netobserv-io-v1beta1.adoc +++ b/docs/flowcollector-flows-netobserv-io-v1beta1.adoc @@ -101,7 +101,7 @@ Type:: | `namespace` | `string` -| Namespace where NetObserv pods are deployed. +| Namespace where Network Observability pods are deployed. | `processor` | `object` @@ -136,7 +136,7 @@ Type:: | `type` | `string` | `type` selects the flows tracing agent. Possible values are: + - - `EBPF` (default) to use NetObserv eBPF agent. + + - `EBPF` (default) to use Network Observability eBPF agent. + - `IPFIX` [deprecated (*)] - to use the legacy IPFIX collector. + `EBPF` is recommended as it offers better performances and should work regardless of the CNI installed on the cluster. `IPFIX` works with OVN-Kubernetes CNI (other CNIs could work if they support exporting IPFIX, but they would require manual configuration). @@ -196,7 +196,7 @@ Type:: | `logLevel` | `string` -| `logLevel` defines the log level for the NetObserv eBPF Agent +| `logLevel` defines the log level for the Network Observability eBPF Agent | `privileged` | `boolean` @@ -634,7 +634,7 @@ Required:: | `topic` | `string` -| Kafka topic to use. It must exist, NetObserv does not create it. +| Kafka topic to use. It must exist, Network Observability does not create it. |=== == .spec.exporters[].kafka.sasl @@ -694,7 +694,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -728,7 +728,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -800,7 +800,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -838,7 +838,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -879,7 +879,7 @@ Required:: | `topic` | `string` -| Kafka topic to use. It must exist, NetObserv does not create it. +| Kafka topic to use. It must exist, Network Observability does not create it. |=== == .spec.kafka.sasl @@ -939,7 +939,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -973,7 +973,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -1045,7 +1045,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -1083,7 +1083,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -1237,7 +1237,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -1275,7 +1275,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -1347,7 +1347,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -1385,7 +1385,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -1651,7 +1651,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing certificates. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` @@ -1685,7 +1685,7 @@ Type:: | `namespace` | `string` -| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where NetObserv is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. +| Namespace of the config map or secret containing the file. If omitted, the default is to use the same namespace as where Network Observability is deployed. If the namespace is different, the config map or the secret is copied so that it can be mounted as required. | `type` | `string` diff --git a/hack/asciidoc-gen.sh b/hack/asciidoc-gen.sh index 97256941d..2fbd5195e 100755 --- a/hack/asciidoc-gen.sh +++ b/hack/asciidoc-gen.sh @@ -31,6 +31,7 @@ sed -i -r '/^== Specification$/d ' $ADOC sed -i -r 's/^==/=/g' $ADOC sed -i -r '/^= API endpoints/Q' $ADOC sed -i -r 's/OpenShift/{product-title}/g' $ADOC +sed -i -r 's/\/Network Observability/g' $ADOC sed -i -r 's/
/ +\n/g' $ADOC sed -i -r 's//_/g' $ADOC sed -i -r 's/<\/i>/_/g' $ADOC