diff --git a/docs/modules/nifi/examples/getting_started/getting_started.sh b/docs/modules/nifi/examples/getting_started/getting_started.sh index fb25f97b..4c0a1c80 100755 --- a/docs/modules/nifi/examples/getting_started/getting_started.sh +++ b/docs/modules/nifi/examples/getting_started/getting_started.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash set -euo pipefail -# DO NOT EDIT THE SCRIPT +# DO NOT EDIT THE RENDERED SCRIPT # Instead, update the j2 template, and regenerate it for dev with `make render-docs`. # The getting started guide script @@ -29,7 +29,6 @@ echo "Installing Operators with Helm" helm install --wait commons-operator oci://oci.stackable.tech/sdp-charts/commons-operator --version 0.0.0-dev helm install --wait secret-operator oci://oci.stackable.tech/sdp-charts/secret-operator --version 0.0.0-dev helm install --wait listener-operator oci://oci.stackable.tech/sdp-charts/listener-operator --version 0.0.0-dev -helm install --wait zookeeper-operator oci://oci.stackable.tech/sdp-charts/zookeeper-operator --version 0.0.0-dev helm install --wait nifi-operator oci://oci.stackable.tech/sdp-charts/nifi-operator --version 0.0.0-dev # end::helm-install-operators[] ;; @@ -40,7 +39,6 @@ stackablectl operator install \ commons=0.0.0-dev \ secret=0.0.0-dev \ listener=0.0.0-dev \ - zookeeper=0.0.0-dev \ nifi=0.0.0-dev # end::stackablectl-install-operators[] ;; @@ -50,62 +48,6 @@ exit 1 ;; esac -internal=true -if [ $# -eq 2 ] -then - case "$2" in - "InternalIP") - internal=true - ;; - "ExternalIP") - internal=false - ;; - *) - echo "Need to provide 'InternalIP' or 'ExternalIP' as the connection type argument." - exit 1 - ;; - esac -fi - -echo "Installing ZooKeeper" -# tag::install-zookeeper[] -kubectl apply -f - <> by querying the REST API. == Setup -Two things need to be installed to create a NiFi cluster: - -* A ZooKeeper cluster for internal use by NiFi -* The NiFi cluster itself - -Create them in this order, each one is created by applying a manifest file. -The operators create the resources according to the manifest. - -=== Apache ZooKeeper - -To create a ZooKeeper instance run the following command: - -[source,bash] ----- -include::example$getting_started/getting_started.sh[tag=install-zookeeper] ----- - -Create a Znode object: - -[source,bash] ----- -include::example$getting_started/getting_started.sh[tag=install-znode] ----- - -The xref:zookeeper:znodes.adoc[ZNode] makes sure that the NiFi cluster operates in its own separated directory in ZooKeeper. - -=== Apache NiFi +We are going to install a NiFi cluster by applying a manifest file. +The operators create the resources according to the manifests. The NiFi cluster requires authentication. Create a set of credentials for this purpose: @@ -42,7 +17,7 @@ Create a set of credentials for this purpose: include::example$getting_started/getting_started.sh[tag=install-nifi-credentials] ---- -Finally create a NiFi instance: +Afterwards create a NiFi instance: [source,bash] ---- @@ -92,11 +67,8 @@ stackablectl stacklet list which should return something like this: ---- - PRODUCT NAME NAMESPACE ENDPOINTS EXTRA INFOS - - nifi simple-nifi default https https://172.18.0.3:32595 - - zookeeper simple-zk default zk 172.18.0.3:30173 + PRODUCT NAME NAMESPACE ENDPOINTS CONDITIONS + nifi simple-nifi default node-https https://172.18.0.2:30528 Available, Reconciling, Running ---- You can also use the `json` output and parse the endpoint: @@ -106,71 +78,27 @@ You can also use the `json` output and parse the endpoint: include::example$getting_started/getting_started.sh[tag=stackablectl-nifi-url] ---- -Then connect to `https://172.18.0.3:32595/nifi` and you should see the NiFi web login. After providing the username `admin` and password `admin` you are redirected to the NiFi web interface. +Then connect to `https://172.18.0.2:30528/nifi` and you should see the NiFi web login. After providing the username `admin` and password `admin` you are redirected to the NiFi web interface. image::nifi-web-ui.png[] ==== Via kubectl -Extracting the IP and port via `kubectl` is cumbersome. We recommend using `stackablectl` instead. The following `kubectl` commands store their output for further use in a variable and write its content to stdout afterwards. Make sure to run these commands in the same terminal: - -[source,bash] ----- -include::example$getting_started/getting_started.sh[tag=get-nifi-node-name] ----- - -which should output a single node name where a NiFi pod is scheduled: - -[source] ----- -NodeName: kind-worker ----- - -Retrieve the IP of that node: - -[source,bash] ----- -include::example$getting_started/getting_started.sh[tag=get-nifi-node-ip-internal] ----- - -which should output the internal IP of that node: - -[source] ----- -NodeIp: 172.18.0.3 ----- - -You might need to replace `InternalIP` with `ExternalIP` depending on how you connect to your Kubernetes cluster. - -Finally, retrieve the NodePort of the `simple-nifi` service: - -[source,bash] ----- -include::example$getting_started/getting_started.sh[tag=get-nifi-service-port] ----- - -which should output the NodePort: - -[source] ----- -NodePort: 32595 ----- - -Now build the full URL: +You can also extract the endpoint from the xref:listener-operator:listener.adoc[Listener] status via `kubectl`: [source,bash] ---- -include::example$getting_started/getting_started.sh[tag=create-nifi-url] +include::example$getting_started/getting_started.sh[tag=get-nifi-url] ---- -which should output a URL to connect to the NiFi web interface: +should output a URL to connect to the NiFi web interface: [source] ---- -NiFi web interface: https://172.18.0.3:32595 +NiFi URL: https://172.18.0.2:30528 ---- -Then connect to `https://172.18.0.3:32595/nifi` and you should see the NiFi web login. After providing the username `admin` and password `admin` you are redirected to the NiFi web interface. +Then connect to `https://172.18.0.2:30528/nifi` and you should see the NiFi web login. After providing the username `admin` and password `admin` you are redirected to the NiFi web interface. == What's next diff --git a/docs/modules/nifi/pages/getting_started/installation.adoc b/docs/modules/nifi/pages/getting_started/installation.adoc index 017ba0fa..649b55c4 100644 --- a/docs/modules/nifi/pages/getting_started/installation.adoc +++ b/docs/modules/nifi/pages/getting_started/installation.adoc @@ -1,8 +1,8 @@ = Installation :description: Install the Stackable operator for Apache NiFi and its dependencies using stackablectl or Helm. Follow steps for a complete setup on Kubernetes. -On this page you install the Stackable operator for Apache NiFi and operators for its dependencies -- ZooKeeper -- -as well as the commons, secret and listener operator which are required by all Stackable operators. +On this page you install the Stackable operator for Apache NiFi as well as the commons, secret and listener operator, +which are required by all Stackable operators. There are multiple ways to install the Stackable operators. xref:management:stackablectl:index.adoc[] is the preferred way, but Helm is also supported. diff --git a/docs/modules/nifi/partials/supported-versions.adoc b/docs/modules/nifi/partials/supported-versions.adoc index c5bad944..f9d44aed 100644 --- a/docs/modules/nifi/partials/supported-versions.adoc +++ b/docs/modules/nifi/partials/supported-versions.adoc @@ -2,7 +2,7 @@ // This is a separate file, since it is used by both the direct NiFi-Operator documentation, and the overarching // Stackable Platform documentation. -* 2.4.0 (experimental) - Please note that you need to upgrade to at least 1.27.x before upgrading to 2.x.x! +* 2.4.0 (Please note that you need to upgrade to at least 1.27.x before upgrading to 2.x.x!) * 1.28.1 * 1.27.0 (LTS)