From d4f2b50a12fecce79fa70690ee48886f4627fcaa Mon Sep 17 00:00:00 2001 From: Lars Francke Date: Sat, 3 Oct 2026 23:02:02 +0200 Subject: [PATCH] docs: Point the CRD links at the Stackable Hub --- docs/modules/nifi/pages/index.adoc | 4 ++-- docs/modules/nifi/pages/reference/crds.adoc | 2 +- docs/modules/nifi/pages/usage_guide/custom-components.adoc | 2 +- .../nifi/pages/usage_guide/resource-configuration.adoc | 4 ++-- docs/modules/nifi/pages/usage_guide/security.adoc | 6 +++--- docs/modules/nifi/partials/nav.adoc | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/modules/nifi/pages/index.adoc b/docs/modules/nifi/pages/index.adoc index f878e102..995810ba 100644 --- a/docs/modules/nifi/pages/index.adoc +++ b/docs/modules/nifi/pages/index.adoc @@ -3,8 +3,8 @@ :keywords: k8s, Kubernetes, Stackable operator, Apache NiFi, open source, operator, data science, data exploration, big data :nifi: https://nifi.apache.org/ :github: https://github.com/stackabletech/nifi-operator/ -:crd: {crd-docs-base-url}/nifi-operator/{crd-docs-version}/ -:crd-nificluster: {crd-docs}/nifi.stackable.tech/nificluster/v1alpha1/ +:crd: {crd-ref}{crd-ref-release}&operator=nifi-operator +:crd-nificluster: {crd-ref}/nifi.stackable.tech/v1alpha1/nificluster{crd-ref-release} :feature-tracker: https://features.stackable.tech/unified [.link-bar] diff --git a/docs/modules/nifi/pages/reference/crds.adoc b/docs/modules/nifi/pages/reference/crds.adoc index 541c8b0a..37b042c4 100644 --- a/docs/modules/nifi/pages/reference/crds.adoc +++ b/docs/modules/nifi/pages/reference/crds.adoc @@ -1,3 +1,3 @@ = CRD Reference -Find all CRD reference for the Stackable Operator for Apache NiFi at: {crd-docs-base-url}/nifi-operator/{crd-docs-version}. +Find all CRD reference for the Stackable Operator for Apache NiFi at: {crd-ref}{crd-ref-release}&operator=nifi-operator. diff --git a/docs/modules/nifi/pages/usage_guide/custom-components.adoc b/docs/modules/nifi/pages/usage_guide/custom-components.adoc index 0ba209ca..48f6718a 100644 --- a/docs/modules/nifi/pages/usage_guide/custom-components.adoc +++ b/docs/modules/nifi/pages/usage_guide/custom-components.adoc @@ -42,7 +42,7 @@ $ kubectl logs nifi-node-default-0 == Synchronize with git-sync Custom NiFi components can be synchronized from a Git repository directly into the NiFi pods with git-sync. -The {crd-docs}/nifi.stackable.tech/nificluster/v1alpha1[NifiCluster CRD] allows the specification of one or multiple Git repositories: +The {crd-ref}/nifi.stackable.tech/v1alpha1/nificluster{crd-ref-release}[NifiCluster CRD] allows the specification of one or multiple Git repositories: [source,yaml] ---- diff --git a/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc b/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc index 8d42bbd8..bc002a53 100644 --- a/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc +++ b/docs/modules/nifi/pages/usage_guide/resource-configuration.adoc @@ -6,7 +6,7 @@ By default, a NiFi Stacklet creates five different persistent volume claims for flow files, provenance, database, content and state directories. Depending on the NiFi cluster definition, another PVC for file-based authorization is added. -You can find the default sizes of the PVCs in the {crd-docs}/nifi.stackable.tech/NifiCluster/v1alpha1/#spec-nodes-config-resources-storage[NifiCluster reference docs {external-link-icon}^], it is recommended that you configure these volume requests according to your needs. +You can find the default sizes of the PVCs in the {crd-ref}/nifi.stackable.tech/v1alpha1/nificluster{crd-ref-release}#nodes.config.resources.storage[NifiCluster reference docs {external-link-icon}^], it is recommended that you configure these volume requests according to your needs. Storage requests can be configured at role or group level, for one or more of the persistent volumes as follows: @@ -45,7 +45,7 @@ A minimal HA setup consisting of 2 NiFi instances has the following https://kube * `8448Mi` memory request and limit * `18432Mi` persistent storage -You can find the default resource configuration values in the {crd-docs}/nifi.stackable.tech/NifiCluster/v1alpha1/#spec-nodes-config-resources[NifiCluster reference docs {external-link-icon}^]. +You can find the default resource configuration values in the {crd-ref}/nifi.stackable.tech/v1alpha1/nificluster{crd-ref-release}#nodes.config.resources[NifiCluster reference docs {external-link-icon}^]. == Content archive retention diff --git a/docs/modules/nifi/pages/usage_guide/security.adoc b/docs/modules/nifi/pages/usage_guide/security.adoc index e2926a17..6bcc196b 100644 --- a/docs/modules/nifi/pages/usage_guide/security.adoc +++ b/docs/modules/nifi/pages/usage_guide/security.adoc @@ -108,7 +108,7 @@ spec: <1> The reference to an AuthenticationClass called `ldap` -You can follow the xref:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the {crd-docs}/authentication.stackable.tech/authenticationclass/v1alpha1/[AuthenticationClass reference {external-link-icon}^]. +You can follow the xref:tutorials:authentication_with_openldap.adoc[] tutorial to learn how to set up an AuthenticationClass for an LDAP server, as well as consulting the {crd-ref}/authentication.stackable.tech/v1alpha1/authenticationclass{crd-ref-release}[AuthenticationClass reference {external-link-icon}^]. If your LDAP server uses TLS, the AuthenticationClass also needs to know how to verify the server's certificate. See xref:concepts:tls-server-verification.adoc[] for how to provide the LDAP server's CA certificate via a SecretClass. @@ -404,7 +404,7 @@ allow := { Some flows require storing a sensitive property like a password or access token, which is then stored on disk. NiFi {nifi-docs-sensitive-properties-key}[encrypts these properties] in flow files. -The sensitive property encryption is configured using the properties `keySecret`, `autoGenerate` and `algorithm` in the {crd-docs}/nifi.stackable.tech/nificluster/v1alpha1/#spec-clusterConfig-sensitiveProperties[`spec.clusterConfig.sensitiveProperties` {external-link-icon}^] configuration section of the NifiCluster resource. +The sensitive property encryption is configured using the properties `keySecret`, `autoGenerate` and `algorithm` in the {crd-ref}/nifi.stackable.tech/v1alpha1/nificluster{crd-ref-release}#clusterConfig.sensitiveProperties[`spec.clusterConfig.sensitiveProperties` {external-link-icon}^] configuration section of the NifiCluster resource. The `keySecret` configures the name of the Secret object that holds the encryption key; it is required to specify a Secret name. The Secret needs to contain the key as a value to the `nifiSensitivePropsKey` key. @@ -412,7 +412,7 @@ You can either specify a key yourself - in which case the key needs to be at lea If `autoGenerate` is false and no Secret with the given name in `keySecret` is found, the operator raises an error. The `algorithm` property configures the encryption algorithm used to encrypt the sensitive properties. -Consult the {crd-docs}/nifi.stackable.tech/nificluster/v1alpha1/#spec-clusterConfig-sensitiveProperties-algorithm[reference documentation {external-link-icon}^] for a list of supported algorithms. +Consult the {crd-ref}/nifi.stackable.tech/v1alpha1/nificluster{crd-ref-release}#clusterConfig.sensitiveProperties.algorithm[reference documentation {external-link-icon}^] for a list of supported algorithms. === Autogenerated sensitive properties key diff --git a/docs/modules/nifi/partials/nav.adoc b/docs/modules/nifi/partials/nav.adoc index 13154db5..a20db62f 100644 --- a/docs/modules/nifi/partials/nav.adoc +++ b/docs/modules/nifi/partials/nav.adoc @@ -26,6 +26,6 @@ * xref:nifi:troubleshooting/index.adoc[] * xref:nifi:reference/index.adoc[] ** xref:nifi:reference/crds.adoc[] -*** {crd-docs}/nifi.stackable.tech/nificluster/v1alpha1/[NiFiCluster {external-link-icon}^] +*** {crd-ref}/nifi.stackable.tech/v1alpha1/nificluster{crd-ref-release}[NiFiCluster {external-link-icon}^] ** xref:nifi:reference/commandline-parameters.adoc[] ** xref:nifi:reference/environment-variables.adoc[]