You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASE.md
+40-4Lines changed: 40 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,59 @@
1
1
## Releasing process
2
2
3
-
### Sub-components
3
+
### Related components - draft release
4
4
5
5
All components deployed by this operator can be released separatly, at their own pace.
6
6
7
-
Before releasing, it's a good opportunity to check for image upgrades: Go, [node.js](https://catalog.redhat.com/software/containers/ubi9/nodejs-18/62e8e7ed22d1d3c2dfe2ca01) and [ubi9-minimal](https://catalog.redhat.com/software/containers/ubi9-minimal/61832888c0d15aff4912fe0d).
8
-
9
7
To release them, a tag in the format "v1.6.0-community" or "v1.6.0-crc0" must be set on the desired clean HEAD state (generally, up-to-date `main` branch; "crc" stands for "community release candidate"), then pushed. It applies to [the console plugin](https://github.com/netobserv/network-observability-console-plugin/), [flowlogs-pipeline](https://github.com/netobserv/flowlogs-pipeline) and [netobserv-ebpf-agent](https://github.com/netobserv/netobserv-ebpf-agent).
10
8
11
9
E.g:
12
10
13
11
```bash
14
-
version="v1.9.1-community"
12
+
version="v1.9.2-community"
15
13
git tag -a "$version" -m "$version"
16
14
git push upstream --tags
17
15
```
18
16
19
17
The release script should be triggered (check github actions). It will automatically draft a new release, with artifacts attached.
20
18
19
+
### Operator - draft release
20
+
21
+
When all those components are pre-released, we can proceed with the operator.
22
+
23
+
Edit the [Makefile](./Makefile) to update `BUNDLE_VERSION`.
24
+
25
+
```bash
26
+
make update-bundle
27
+
28
+
# Set desired operator version - CAREFUL, no leading "v" here
29
+
version="1.9.2-community"
30
+
vv=v$version
31
+
test_branch=test-$vv
32
+
33
+
git commit -a -m "Prepare release $vv"
34
+
# Push to a test branch, and tag for release
35
+
git push upstream HEAD:$test_branch
36
+
git tag -a "$version" -m "$version"
37
+
git push upstream --tags
38
+
```
39
+
40
+
The release script should be triggered ([check github actions](https://github.com/netobserv/network-observability-operator/actions)).
41
+
42
+
At this point, you can test the bundle / catalog on your cluster:
43
+
44
+
```bash
45
+
BUNDLE_VERSION="$version" USER=netobserv make catalog-deploy
46
+
```
47
+
48
+
When everything is ok, push to main and delete the test branch
49
+
50
+
```bash
51
+
git push upstream HEAD:main
52
+
git push upstream :$test_branch
53
+
```
54
+
55
+
56
+
21
57
If the release looks good, you can publish it via the github interface:
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/config/samples/flows_v1beta2_flowcollector.yaml).
709
+
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/config/samples/flows_v1beta2_flowcollector.yaml).
710
710
711
711
To edit configuration in cluster, run:
712
712
@@ -722,7 +722,7 @@ spec:
722
722
723
723
- Loki (`spec.loki`): configure here how to reach Loki. The default values match the Loki quick install paths mentioned above, but you might have to configure differently if you used another installation method. Make sure to disable it (`spec.loki.enable`) if you don't want to use Loki.
724
724
725
-
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/QuickFilters.md).
725
+
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/QuickFilters.md).
726
726
727
727
- Kafka (`spec.deploymentModel: KAFKA` and `spec.kafka`): when enabled, integrates the flow collection pipeline with Kafka, by splitting ingestion from transformation (kube enrichment, derived metrics, ...). Kafka can provide better scalability, resiliency and high availability ([view more details](https://www.redhat.com/en/topics/integration/what-is-apache-kafka)). Assumes Kafka is already deployed and a topic is created.
728
728
@@ -758,7 +758,7 @@ spec:
758
758
This documentation includes:
759
759
760
760
- An [overview](https://github.com/netobserv/network-observability-operator#openshift-console) of the features, with screenshots
761
-
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/Metrics.md).
761
+
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/Metrics.md).
762
762
- A [performance](https://github.com/netobserv/network-observability-operator#performance-fine-tuning) section, for fine-tuning
763
763
- A [security](https://github.com/netobserv/network-observability-operator#securing-data-and-communications) section
764
764
- An [F.A.Q.](https://github.com/netobserv/network-observability-operator#faq--troubleshooting) section
Copy file name to clipboardExpand all lines: config/descriptions/ocp.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ In that case, you can still get the Prometheus metrics or export raw flows to a
38
38
39
39
## Configuration
40
40
41
-
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/config/samples/flows_v1beta2_flowcollector.yaml).
41
+
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/config/samples/flows_v1beta2_flowcollector.yaml).
42
42
43
43
To edit configuration in cluster, run:
44
44
@@ -54,7 +54,7 @@ A couple of settings deserve special attention:
54
54
55
55
- Loki (`spec.loki`): configure here how to reach Loki. The default values match the Loki quick install paths mentioned above, but you might have to configure differently if you used another installation method. Make sure to disable it (`spec.loki.enable`) if you don't want to use Loki.
56
56
57
-
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/QuickFilters.md).
57
+
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/QuickFilters.md).
58
58
59
59
- Kafka (`spec.deploymentModel: KAFKA` and `spec.kafka`): when enabled, integrates the flow collection pipeline with Kafka, by splitting ingestion from transformation (kube enrichment, derived metrics, ...). Kafka can provide better scalability, resiliency and high availability ([view more details](https://www.redhat.com/en/topics/integration/what-is-apache-kafka)). Assumes Kafka is already deployed and a topic is created.
60
60
@@ -90,7 +90,7 @@ Please refer to the documentation on GitHub for more information.
90
90
This documentation includes:
91
91
92
92
- An [overview](https://github.com/netobserv/network-observability-operator#openshift-console) of the features, with screenshots
93
-
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/Metrics.md).
93
+
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/Metrics.md).
94
94
- A [performance](https://github.com/netobserv/network-observability-operator#performance-fine-tuning) section, for fine-tuning
95
95
- A [security](https://github.com/netobserv/network-observability-operator#securing-data-and-communications) section
96
96
- An [F.A.Q.](https://github.com/netobserv/network-observability-operator#faq--troubleshooting) section
Copy file name to clipboardExpand all lines: config/descriptions/upstream.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ In that case, you can still get the Prometheus metrics or export raw flows to a
42
42
43
43
## Configuration
44
44
45
-
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/config/samples/flows_v1beta2_flowcollector.yaml).
45
+
The `FlowCollector` resource is used to configure the operator and its managed components. A comprehensive documentation is [available here](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/FlowCollector.md), and a full sample file [there](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/config/samples/flows_v1beta2_flowcollector.yaml).
46
46
47
47
To edit configuration in cluster, run:
48
48
@@ -58,7 +58,7 @@ A couple of settings deserve special attention:
58
58
59
59
- Loki (`spec.loki`): configure here how to reach Loki. The default values match the Loki quick install paths mentioned above, but you might have to configure differently if you used another installation method. Make sure to disable it (`spec.loki.enable`) if you don't want to use Loki.
60
60
61
-
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/QuickFilters.md).
61
+
- Quick filters (`spec.consolePlugin.quickFilters`): configure preset filters to be displayed in the Console plugin. They offer a way to quickly switch from filters to others, such as showing / hiding pods network, or infrastructure network, or application network, etc. They can be tuned to reflect the different workloads running on your cluster. For a list of available filters, [check this page](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/QuickFilters.md).
62
62
63
63
- Kafka (`spec.deploymentModel: KAFKA` and `spec.kafka`): when enabled, integrates the flow collection pipeline with Kafka, by splitting ingestion from transformation (kube enrichment, derived metrics, ...). Kafka can provide better scalability, resiliency and high availability ([view more details](https://www.redhat.com/en/topics/integration/what-is-apache-kafka)). Assumes Kafka is already deployed and a topic is created.
64
64
@@ -94,7 +94,7 @@ Please refer to the documentation on GitHub for more information.
94
94
This documentation includes:
95
95
96
96
- An [overview](https://github.com/netobserv/network-observability-operator#openshift-console) of the features, with screenshots
97
-
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.9.1-community/docs/Metrics.md).
97
+
- More information on [configuring metrics](https://github.com/netobserv/network-observability-operator/blob/1.9.2-community/docs/Metrics.md).
98
98
- A [performance](https://github.com/netobserv/network-observability-operator#performance-fine-tuning) section, for fine-tuning
99
99
- A [security](https://github.com/netobserv/network-observability-operator#securing-data-and-communications) section
100
100
- An [F.A.Q.](https://github.com/netobserv/network-observability-operator#faq--troubleshooting) section
0 commit comments