Skip to content

docs: Point the CRD links at the Stackable Hub #1008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lfrancke wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Point the CRD links at the Stackable Hub #1008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/modules/nifi/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/nifi/pages/reference/crds.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/modules/nifi/pages/usage_guide/custom-components.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/nifi/pages/usage_guide/resource-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/modules/nifi/pages/usage_guide/security.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -404,15 +404,15 @@ 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.
You can either specify a key yourself - in which case the key needs to be at least 12 characters long - or just specify the name of the Secret and set `autoGenerate` to `true` (the default is false).
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

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/nifi/partials/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Loading