Skip to content

Commit b8dadcf

Browse files
sbernauersbernauer
committed
chore: Rename stacklet names to better reflect state of NiFi 2
1 parent d89e1bb commit b8dadcf

23 files changed

Lines changed: 86 additions & 86 deletions

File tree

‎docs/modules/nifi/examples/getting_started/getting_started.sh‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ stringData:
6262
apiVersion: authentication.stackable.tech/v1alpha1
6363
kind: AuthenticationClass
6464
metadata:
65-
name: simple-nifi-users
65+
name: broken-nifi-users
6666
spec:
6767
provider:
6868
static:
@@ -78,13 +78,13 @@ kubectl apply -f - <<EOF
7878
apiVersion: nifi.stackable.tech/v1alpha1
7979
kind: NifiCluster
8080
metadata:
81-
name: simple-nifi
81+
name: broken-nifi
8282
spec:
8383
image:
8484
productVersion: 2.4.0
8585
clusterConfig:
8686
authentication:
87-
- authenticationClass: simple-nifi-users
87+
- authenticationClass: broken-nifi-users
8888
sensitiveProperties:
8989
keySecret: nifi-sensitive-property-key
9090
autoGenerate: true
@@ -99,22 +99,22 @@ EOF
9999

100100
echo "Awaiting NiFi rollout finish"
101101
# tag::wait-nifi-rollout[]
102-
kubectl wait --for=condition=available --timeout=20m nificluster/simple-nifi
102+
kubectl wait --for=condition=available --timeout=20m nificluster/broken-nifi
103103
# end::wait-nifi-rollout[]
104104

105105
case "$1" in
106106
"helm")
107107
echo "Getting the NiFi URL with kubectl"
108108

109109
# tag::get-nifi-url[]
110-
nifi_url=$(kubectl get listener simple-nifi-node -o 'jsonpath=https://{.status.ingressAddresses[0].address}:{.status.ingressAddresses[0].ports.https}') && \
110+
nifi_url=$(kubectl get listener broken-nifi-node -o 'jsonpath=https://{.status.ingressAddresses[0].address}:{.status.ingressAddresses[0].ports.https}') && \
111111
echo "NiFi URL: $nifi_url"
112112
# end::get-nifi-url[]
113113
;;
114114
"stackablectl")
115115
echo "Getting NiFi URL with stackablectl ..."
116116
# tag::stackablectl-nifi-url[]
117-
nifi_url=$(stackablectl stacklet ls -o json | jq --raw-output '.[] | select(.name == "simple-nifi") | .endpoints["node-https"]')
117+
nifi_url=$(stackablectl stacklet ls -o json | jq --raw-output '.[] | select(.name == "broken-nifi") | .endpoints["node-https"]')
118118
# end::stackablectl-nifi-url[]
119119
echo "NiFi URL: $nifi_url"
120120
;;

‎docs/modules/nifi/examples/getting_started/getting_started.sh.j2‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ stringData:
6262
apiVersion: authentication.stackable.tech/v1alpha1
6363
kind: AuthenticationClass
6464
metadata:
65-
name: simple-nifi-users
65+
name: broken-nifi-users
6666
spec:
6767
provider:
6868
static:
@@ -78,13 +78,13 @@ kubectl apply -f - <<EOF
7878
apiVersion: nifi.stackable.tech/v1alpha1
7979
kind: NifiCluster
8080
metadata:
81-
name: simple-nifi
81+
name: broken-nifi
8282
spec:
8383
image:
8484
productVersion: 2.4.0
8585
clusterConfig:
8686
authentication:
87-
- authenticationClass: simple-nifi-users
87+
- authenticationClass: broken-nifi-users
8888
sensitiveProperties:
8989
keySecret: nifi-sensitive-property-key
9090
autoGenerate: true
@@ -99,22 +99,22 @@ EOF
9999

100100
echo "Awaiting NiFi rollout finish"
101101
# tag::wait-nifi-rollout[]
102-
kubectl wait --for=condition=available --timeout=20m nificluster/simple-nifi
102+
kubectl wait --for=condition=available --timeout=20m nificluster/broken-nifi
103103
# end::wait-nifi-rollout[]
104104

105105
case "$1" in
106106
"helm")
107107
echo "Getting the NiFi URL with kubectl"
108108

109109
# tag::get-nifi-url[]
110-
nifi_url=$(kubectl get listener simple-nifi-node -o 'jsonpath=https://{.status.ingressAddresses[0].address}:{.status.ingressAddresses[0].ports.https}') && \
110+
nifi_url=$(kubectl get listener broken-nifi-node -o 'jsonpath=https://{.status.ingressAddresses[0].address}:{.status.ingressAddresses[0].ports.https}') && \
111111
echo "NiFi URL: $nifi_url"
112112
# end::get-nifi-url[]
113113
;;
114114
"stackablectl")
115115
echo "Getting NiFi URL with stackablectl ..."
116116
# tag::stackablectl-nifi-url[]
117-
nifi_url=$(stackablectl stacklet ls -o json | jq --raw-output '.[] | select(.name == "simple-nifi") | .endpoints["node-https"]')
117+
nifi_url=$(stackablectl stacklet ls -o json | jq --raw-output '.[] | select(.name == "broken-nifi") | .endpoints["node-https"]')
118118
# end::stackablectl-nifi-url[]
119119
echo "NiFi URL: $nifi_url"
120120
;;

‎docs/modules/nifi/pages/getting_started/first_steps.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The output should show all pods ready:
4545
[source]
4646
----
4747
NAME READY AGE
48-
simple-nifi-node-default 2/2 5m
48+
broken-nifi-node-default 2/2 5m
4949
simple-zk-server-default 3/3 7m
5050
----
5151

@@ -68,7 +68,7 @@ which should return something like this:
6868

6969
----
7070
PRODUCT NAME NAMESPACE ENDPOINTS CONDITIONS
71-
nifi simple-nifi default node-https https://172.18.0.2:30528 Available, Reconciling, Running
71+
nifi broken-nifi default node-https https://172.18.0.2:30528 Available, Reconciling, Running
7272
----
7373

7474
You can also use the `json` output and parse the endpoint:

‎docs/modules/nifi/pages/usage_guide/clustering.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This is enabled by setting the `spec.clusterConfig.zookeeperConfigMapName` to a
3333
----
3434
spec:
3535
clusterConfig:
36-
zookeeperConfigMapName: simple-nifi-znode
36+
zookeeperConfigMapName: broken-nifi-znode
3737
----
3838

3939
The ConfigMap needs to contain two keys: `ZOOKEEPER_HOSTS` containing the value being the ZooKeeper connection string, and `ZOOKEEPER_CHROOT` containing the ZooKeeper chroot.

‎docs/modules/nifi/pages/usage_guide/custom-components.adoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,21 +151,21 @@ Afterwards, we need to mount the ConfigMap as described in xref:nifi:usage_guide
151151
apiVersion: nifi.stackable.tech/v1alpha1
152152
kind: NifiCluster
153153
metadata:
154-
name: simple-nifi
154+
name: broken-nifi
155155
spec:
156156
image:
157157
productVersion: 2.2.0
158158
clusterConfig:
159159
authentication:
160-
- authenticationClass: simple-nifi-admin-user
160+
- authenticationClass: broken-nifi-admin-user
161161
extraVolumes: # <1>
162162
- name: nifi-processors
163163
configMap:
164164
name: nifi-processors
165165
sensitiveProperties:
166166
keySecret: nifi-sensitive-property-key
167167
autoGenerate: true
168-
zookeeperConfigMapName: simple-nifi-znode
168+
zookeeperConfigMapName: broken-nifi-znode
169169
nodes:
170170
roleConfig:
171171
listenerClass: external-unstable
@@ -271,21 +271,21 @@ After this is done, your components are available within the NiFi Pods and NiFi
271271
apiVersion: nifi.stackable.tech/v1alpha1
272272
kind: NifiCluster
273273
metadata:
274-
name: simple-nifi
274+
name: broken-nifi
275275
spec:
276276
image:
277277
productVersion: 2.2.0
278278
clusterConfig:
279279
authentication:
280-
- authenticationClass: simple-nifi-admin-user
280+
- authenticationClass: broken-nifi-admin-user
281281
extraVolumes: # <1>
282282
- name: nifi-processors
283283
persistentVolumeClaim:
284284
claimName: nifi-processors
285285
sensitiveProperties:
286286
keySecret: nifi-sensitive-property-key
287287
autoGenerate: true
288-
zookeeperConfigMapName: simple-nifi-znode
288+
zookeeperConfigMapName: broken-nifi-znode
289289
nodes:
290290
roleConfig:
291291
listenerClass: external-unstable

‎docs/modules/nifi/pages/usage_guide/exposing-processors/http.adoc‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,19 @@ image:listen-http-1.png[A ListenHTTP processor]
2424
Afterwards you need to expose the processor to the outside world.
2525

2626
For that to work, first create a Service object as follows.
27-
In this guide, the NifiCluster is called `simple-nifi`. The name of the Nifi cluster must match the value of the `app.kubernetes.io/instance` as shown below.
27+
In this guide, the NifiCluster is called `broken-nifi`. The name of the Nifi cluster must match the value of the `app.kubernetes.io/instance` as shown below.
2828

2929
[source,yaml]
3030
----
3131
apiVersion: v1
3232
kind: Service
3333
metadata:
34-
name: simple-nifi-listen-http # Update according to NifiCluster name
34+
name: broken-nifi-listen-http # Update according to NifiCluster name
3535
spec:
3636
type: ClusterIP
3737
selector:
3838
app.kubernetes.io/component: node
39-
app.kubernetes.io/instance: simple-nifi # Update according to NifiCluster name
39+
app.kubernetes.io/instance: broken-nifi # Update according to NifiCluster name
4040
app.kubernetes.io/name: nifi
4141
ports:
4242
- name: http
@@ -53,17 +53,17 @@ If you are using an ingress controller, an Ingress could look something like
5353
apiVersion: networking.k8s.io/v1
5454
kind: Ingress
5555
metadata:
56-
name: simple-nifi-listen-http # Update according to NifiCluster name
56+
name: broken-nifi-listen-http # Update according to NifiCluster name
5757
spec:
5858
rules:
59-
- host: simple-nifi-listen-http.my.corp # Update to your host
59+
- host: broken-nifi-listen-http.my.corp # Update to your host
6060
http:
6161
paths:
6262
- pathType: Prefix
6363
path: /
6464
backend:
6565
service:
66-
name: simple-nifi-listen-http # Update to your Service name
66+
name: broken-nifi-listen-http # Update to your Service name
6767
port:
6868
number: 8042
6969
----
@@ -78,7 +78,7 @@ Start the `ListenHTTP` processor.
7878
image:listen-http-2.png[´RouteOnAttribute connected to ListenHTTP processor]
7979

8080
The `ListenHTTP` processor should now generate a FlowFile for every incoming HTTP request.
81-
You can test this by calling `curl --verbose --data '{"hello":"NiFi"}' https://simple-nifi-listen-http.my.corp`, you should get a `HTTP/2 200` response.
81+
You can test this by calling `curl --verbose --data '{"hello":"NiFi"}' https://broken-nifi-listen-http.my.corp`, you should get a `HTTP/2 200` response.
8282

8383
TIP: If you get a `503 Service Temporarily Unavailable`, this probably means your Ingress controller was not able to
8484
reach your `ListenHTTP` processor. Check that the processor is running and configured correctly.

‎docs/modules/nifi/pages/usage_guide/exposing-processors/tcp.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Stackable doesn't place any restriction on the type of service that can be used
99
== Example
1010

1111
An example for this is shown below.
12-
It consists of a NiFi cluster with three nodes called `simple-nifi` and has a processor that listens to a TCP port and forwards lines written into that port as flowfiles.
12+
It consists of a NiFi cluster with three nodes called `broken-nifi` and has a processor that listens to a TCP port and forwards lines written into that port as flowfiles.
1313

1414
image:listening-processor-example.png[A ListenTCP processor]
1515

@@ -30,7 +30,7 @@ spec:
3030
selector:
3131
app.kubernetes.io/name: nifi
3232
app.kubernetes.io/component: node
33-
app.kubernetes.io/instance: simple-nifi
33+
app.kubernetes.io/instance: broken-nifi
3434
ports:
3535
- name: tcp-port
3636
protocol: TCP
@@ -55,7 +55,7 @@ spec:
5555
selector:
5656
app.kubernetes.io/name: nifi
5757
app.kubernetes.io/component: node
58-
app.kubernetes.io/instance: simple-nifi
58+
app.kubernetes.io/instance: broken-nifi
5959
ports:
6060
- port: 8123
6161
protocol: TCP

‎docs/modules/nifi/pages/usage_guide/index.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ The following listing shows an example configuration:
1414
apiVersion: nifi.stackable.tech/v1alpha1
1515
kind: NifiCluster
1616
metadata:
17-
name: simple-nifi
17+
name: broken-nifi
1818
spec:
1919
image:
2020
productVersion: 1.27.0
2121
clusterConfig:
22-
zookeeperConfigMapName: simple-nifi-znode # <1>
22+
zookeeperConfigMapName: broken-nifi-znode # <1>
2323
authentication: # <2>
24-
- authenticationClass: simple-nifi-admin-user
24+
- authenticationClass: broken-nifi-admin-user
2525
extraVolumes: # <3>
2626
- name: nifi-client-certs
2727
secret:

‎docs/modules/nifi/pages/usage_guide/monitoring.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ spec:
3838
The Prometheus Reporting Task was removed in NiFi `2.x.x` in https://issues.apache.org/jira/browse/NIFI-13507[NIFI-13507,window=_blank].
3939
Metrics are now always exposed and can be scraped using the NiFi `metrics` Service and the HTTP path `/nifi-api/flow/metrics/prometheus`.
4040
41-
For a deployed NiFi cluster called `simple-nifi`, containing a rolegroup called `default`, the metrics endpoint is reachable under:
41+
For a deployed NiFi cluster called `broken-nifi`, containing a rolegroup called `default`, the metrics endpoint is reachable under:
4242
4343
```
44-
https://simple-nifi-node-default-metrics.<namespace>.svc.cluster.local:8443/nifi-api/flow/metrics/prometheus
44+
https://broken-nifi-node-default-metrics.<namespace>.svc.cluster.local:8443/nifi-api/flow/metrics/prometheus
4545
```
4646
4747
NOTE: The above URL connects to one of the Pods, reachable through the specified Service, therefore scraping metrics produced by that Pod only.
48-
To scrape metrics from a particular Pod, the FQDN of the Pod and the `headless` Service need to be used. For example: `\https://simple-nifi-node-default-0.simple-nifi-node-default-headless.<namespace>.svc.cluster.local:8443/nifi-api/flow/metrics/prometheus`
48+
To scrape metrics from a particular Pod, the FQDN of the Pod and the `headless` Service need to be used. For example: `\https://broken-nifi-node-default-0.broken-nifi-node-default-headless.<namespace>.svc.cluster.local:8443/nifi-api/flow/metrics/prometheus`
4949
5050
IMPORTANT: If NiFi is configured to do any user authentication, requests to the metrics endpoint must be authenticated and authorized.
5151

‎docs/modules/nifi/pages/usage_guide/security.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ However, due to it being a single user with all rights, this is not recommended
4747
apiVersion: authentication.stackable.tech/v1alpha1
4848
kind: AuthenticationClass
4949
metadata:
50-
name: simple-nifi-users # <1>
50+
name: broken-nifi-users # <1>
5151
spec:
5252
provider:
5353
static:
@@ -82,7 +82,7 @@ stringData:
8282
spec:
8383
clusterConfig:
8484
authentication:
85-
- authenticationClass: simple-nifi-users # <1>
85+
- authenticationClass: broken-nifi-users # <1>
8686
----
8787

8888
<1> The reference to an AuthenticationClass. NiFi only supports one authentication mechanism at a time.
@@ -437,7 +437,7 @@ Alternatively, you can use this shell script to automatically execute this in ea
437437
[source,bash]
438438
----
439439
NAMESPACE="default"
440-
STATEFULSET_NAME="simple-nifi-node-default"
440+
STATEFULSET_NAME="broken-nifi-node-default"
441441
COMMAND="/stackable/nifi/bin/nifi.sh set-sensitive-properties-algorithm NIFI_PBKDF2_AES_GCM_256"
442442
443443
kubectl get pods -n "$NAMESPACE" --no-headers -o custom-columns=":metadata.name" | grep "^$STATEFULSET_NAME" | \

0 commit comments

Comments
 (0)