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: CHANGELOG.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,12 @@ All notable changes to this project will be documented in this file.
30
30
31
31
- Fix broken link to the NiFi authorization usage guide in the `spec.clusterConfig.authorization` CRD doc (`usage-guide` -> `usage_guide`) ([#924]).
32
32
33
+
### Removed
34
+
35
+
- BREAKING: Remove support for NiFi 1.x.
36
+
This removes the Prometheus reporting-task Job (and its `spec.clusterConfig.createReportingTaskJob` field), the pre-2.x non-rolling upgrade handling, the dedicated metrics port, and the sensitive-properties algorithms that were only supported on NiFi 1.x.
37
+
`status.deployed_version` is retained even though it no longer drives the (now removed) non-rolling upgrade state machine, as we don't want a breaking change to the status just for this ([#954]).
Copy file name to clipboardExpand all lines: docs/modules/nifi/pages/usage_guide/clustering.adoc
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,8 +14,6 @@ CAUTION: The cluster backend of an existing cluster should never be changed. Oth
14
14
[#backend-kubernetes]
15
15
== Kubernetes
16
16
17
-
NOTE: The Kubernetes provider is only supported by Apache NiFi 2.0 or newer. When using NiFi 1.x, use the xref:#backend-zookeeper[] backend instead.
18
-
19
17
The Kubernetes backend is used by default (unless the xref:#backend-zookeeper[] backend is configured), and stores all state in Kubernetes objects, in the same namespace as the `NifiCluster` object.
Copy file name to clipboardExpand all lines: docs/modules/nifi/pages/usage_guide/flow-versioning.adoc
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,7 @@
1
1
= Flow Versioning
2
2
3
-
IMPORTANT: The way described in this document to version flows is only available in NiFi 2.0.0 and later versions. Previous versions of NiFi relied exclusively on the NiFi Registry service for flow versioning.
4
-
5
-
Starting with Apache NiFi 2.0.0, you can connect directly to Git repositories using either GitHub or GitLab as your flow registry without requiring a separate NiFi Registry service. This document explains how to configure and use these registry clients to version your NiFi flows.
3
+
You can connect directly to Git repositories using either GitHub or GitLab as your flow registry without requiring a separate NiFi Registry service.
4
+
This document explains how to configure and use these registry clients to version your NiFi flows.
In November 2024, Apache NiFi released a new major version https://cwiki.apache.org/confluence/display/NIFI/Release+Notes#ReleaseNotes-Version2.0.0[`2.0.0`,window=_blank].
5
+
== Configure metrics
8
6
9
-
The NiFi `2.0.0` release changed the way of exposing Prometheus metrics significantly.
10
-
The following steps explain on how to expose Metrics in NiFi versions `1.x.x` and `2.x.x`.
11
-
12
-
== Configure metrics in NiFi `1.x.x`
13
-
14
-
For NiFi versions `1.x.x`, the operator automatically configures NiFi to export Prometheus metrics.
15
-
This is done by creating a {k8s-job}[Job,window=_blank] that connects to NiFi and configures a https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi/nifi-prometheus-nar/1.26.0/org.apache.nifi.reporting.prometheus.PrometheusReportingTask/index.html[Prometheus Reporting Task,window=_blank].
16
-
17
-
IMPORTANT: Network access from the Job to NiFi is required.
18
-
If you are running a Kubernetes with restrictive {k8s-network-policies}[NetworkPolicies,window=_blank], make sure to allow access from the Job to NiFi.
19
-
20
-
See xref:operators:monitoring.adoc[] for more details.
21
-
22
-
== Disabling create-reporting-task Job
23
-
24
-
It can be helpful to disable the Job, e.g. when you configOverride an authentication mechanism, which the Job currently cannot use to authenticate against NiFi.
25
-
26
-
To achieve this use the following configuration:
27
-
28
-
[source,yaml]
29
-
----
30
-
spec:
31
-
clusterConfig:
32
-
createReportingTaskJob:
33
-
enabled: false
34
-
----
35
-
36
-
== Configure metrics in NiFi `2.x.x`
37
-
38
-
The Prometheus Reporting Task was removed in NiFi `2.x.x` in https://issues.apache.org/jira/browse/NIFI-13507[NIFI-13507,window=_blank].
39
-
Metrics are now always exposed and can be scraped using the NiFi `metrics` Service and the HTTP path `/nifi-api/flow/metrics/prometheus`.
7
+
Metrics are always exposed and can be scraped using the NiFi `metrics` Service and the HTTP path `/nifi-api/flow/metrics/prometheus`.
40
8
41
9
For a deployed NiFi cluster called `simple-nifi`, containing a rolegroup called `default`, the metrics endpoint is reachable under:
42
10
@@ -49,9 +17,9 @@ To scrape metrics from a particular Pod, the FQDN of the Pod and the `headless`
49
17
50
18
IMPORTANT: If NiFi is configured to do any user authentication, requests to the metrics endpoint must be authenticated and authorized.
51
19
52
-
=== Authentication with NiFi `2.x.x`
20
+
=== Authentication with NiFi
53
21
54
-
To authenticate against the NiFi `2.x.x` API, you can configure mTLS between NiFi and the client calling NiFi. For more information about authentication between
22
+
To authenticate against the NiFi API, you can configure mTLS between NiFi and the client calling NiFi. For more information about authentication between
55
23
Kubernetes Pods, check out the xref:home:secret-operator:index.adoc[Secret Operator documentation].
56
24
57
25
The following example illustrates the configuration of a Prometheus scraper for NiFi, using the aforementioned method of configuring mTLS
Copy file name to clipboardExpand all lines: docs/modules/nifi/pages/usage_guide/overrides.adoc
-19Lines changed: 0 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,25 +94,6 @@ Pod overrides allow you to configure any attributes that can be configured on a
94
94
95
95
Read the xref:concepts:overrides.adoc#pod-overrides[Pod overrides concepts page] to learn more.
96
96
97
-
=== Pod overrides on create-reporting-task Job
98
-
99
-
In addition to podOverrides on the created StatefulSet we also support podOverrides on the created Kubernetes Job, which enables the export of Prometheus metrics within NiFi.
100
-
101
-
[source,yaml]
102
-
----
103
-
spec:
104
-
clusterConfig:
105
-
createReportingTaskJob:
106
-
# enabled: false # You can also turn off the Job entirely
107
-
podOverrides: # podOverrides as usual
108
-
spec:
109
-
tolerations:
110
-
- key: "key1"
111
-
operator: "Equal"
112
-
value: "value1"
113
-
effect: "NoSchedule"
114
-
----
115
-
116
97
== JVM argument overrides
117
98
118
99
Stackable operators automatically determine the set of needed JVM arguments, such as memory settings or trust- and keystores.
Copy file name to clipboardExpand all lines: docs/modules/nifi/pages/usage_guide/updating.adoc
+1-13Lines changed: 1 addition & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,16 +17,4 @@ spec:
17
17
18
18
<1> Change the NiFi version here
19
19
20
-
[WARNING]
21
-
====
22
-
NiFi clusters cannot be upgraded or downgraded in a rolling fashion due to a limitation in NiFi prior to version 2.
23
-
24
-
When upgrading between NiFi 1 versions or from NiFi 1 to NiFi 2, any change to the NiFi version in the CRD triggers a full cluster restart with brief downtime.
25
-
However, the Stackable image version can be updated in a rolling manner, provided the NiFi version remains unchanged.
26
-
27
-
Since NiFi version 2, rolling upgrades are supported.
28
-
====
29
-
30
-
== NiFi 2.0.0
31
-
32
-
Before you can upgrade to `2.0.0` you https://cwiki.apache.org/confluence/display/NIFI/Migration+Guidance[need to update] to at least version 1.27.x!
20
+
Rolling upgrades are supported, so changing the NiFi version in the CRD updates the cluster without downtime.
0 commit comments