Management
The Management view is accessed via the Global Menu and allows you to set global settings and configure centrally accessible functions.
Global settings
In the general settings, you can adjust the number of threads and the time zone used by the application.
The setting “ Maximum Timer Driven Thread Count ” specifies the maximum number of threads globally for all Processors, which is then distributed among the Processors.
If only one thread is allowed globally and two Processors each have only one thread, then they must wait for each other.
If a thread is configured on a Processor and that Processor takes a very long time to execute—for example, during an SQL query—then that Processor is unavailable for another FlowFile during that time.
Typically, it does not make sense to configure the number of threads on a Processor to be much higher than 10. You should start with one thread and adjust the number if a bottleneck forms on that Processor (i.e., FlowFiles are piling up in the queue in front of it).
If you have I/O-intensive flows, it may be useful to set the ` Maximum Timer Driven Thread Count ` parameter to a value higher than the number of available Processor cores.
In such a case, the threads wait a long time for I/O, and other threads from the pool can be executed.
At a certain point, however, the context switch becomes too costly, and additional threads have a negative impact.
|
As a guideline, there should be 2 to 4 times as many threads as there are processor cores, which provides a good baseline. |
Additionally, this section includes the option to set the time zone based on the browser. To do this, you can use the checkbox in the menu, which automatically adopts the browser’s current time zone.
Counters
Counters are values that can be used to increase or decrease specific deltas. This is useful when you need to monitor certain values in your workflow. The easiest way to do this is to use the UpdateCounter Processor.
Certificates
|
Starting with IGUASU version 4.3.0, the Parameter Context is used to generate keys and certificates. You can find detailed information on this in the section: Add Asset Parameter. |
General
In the application’s Certificate Manager, existing certificates can be edited and customized to enable secure communication with other applications.
This section offers various options for generating a keystore or certificates.
By clicking the “ Add Keystore ” button above the table, you can generate, upload, import, or export keystores.
JKS, PKCS12, and PFX formats can be uploaded directly here. All other formats are converted to JKS data before use.
In addition to the option to upload keystores, this view also allows you to generate a new keystore using either the appropriate keys or a certificate. Uploading this data works similarly to uploading keystores; selecting this option opens another window where you can select and add local data.
Additionally, you can regenerate a private key and the corresponding certificate using the Certificate Manager in IGUASU.
To do this, select the “ Generate Private Key / Certificate ” option, which opens a new view.
In this new view, you must first specify the domain without the protocol or Port, and then set a key password. Once both entries have been confirmed, a new window opens displaying the keystore filename, the password, and the certificate.
|
The password is not stored on the server. Therefore, it should be copied at this point and stored outside of IGUASU. |
Next, there is an overview screen where you can still change the alias or copy the assigned password before the process is completed by saving.
Admin Settings
You can also use the key button next to the certificate to download the public and private keys, which can be used to communicate with other applications. You can also customize the alias or delete the certificate.
Existing keystores in the Certificate Manager can be customized after entering the corresponding password. You can also download the keystores listed in the table. With these options, IGUASU offers various functions to customize certificates and keystores as needed within your own application and to use them for communication with other applications.
Parameter Providers
Properties of Processors, Process Groups, and Services can be centrally configured and managed using parameters. This allows configurations to be externalized. Parameter Providers enable the storage of parameters from sources outside of IGUASU, such as AWS Secrets. The parameters retrieved from a provider can be queried by all referencing Parameter Contexts.
On the left side of the Parameter Provider interface, there is a list of the available Parameter Providers and their types. The right side is used to define configurations for the selected Parameter Provider.
Parameter Providers are closely linked to Management Services.
The required Service must be activated after assignment so that the Parameter Provider can be actively used.
Under Referencing Parameter Contexts, all Parameter Contexts that use this provider’s parameters are listed.
Parameter Contexts
Parameters are managed through assignment to a Parameter Context.
A parameter context can contain multiple parameters and, through inheritance (Inheritance), inherit parameters from one or more other contexts.
This allows configurations to be externalized and, if necessary, exported or imported.
Create a Parameter Context
A new parameter context is created via Add a new parameter context.
The name of the context must be unique.
After saving, the new context appears in the overview and is now ready for use.
Add Asset Parameters
Use Add Asset Parameter to add the following asset parameters:
By clicking on Generate Private Key/Certificate, you can generate a new keystore with a key and certificate and add it to the context.
This requires a filename and password, as well as the Common Name (domain, without the protocol and/or Port of the URL) for which the keystore is being generated. A private key password can be created, but is not required.
|
Passwords are not stored on the server. Therefore, they should be copied at this point and stored outside of IGUASU. |
By clicking on “ Generate Keystore from Key Pair (Private Key/Certificate),” you can generate a keystore from an existing private key and associated certificate and add it to the context. A filename and password are required for this.
Files for the private key and a certificate can be uploaded as .pem files.
Created keystores can be opened in the parameter dialog and downloaded from there.
The private key and certificate can also be downloaded individually. By opening the keystore, accessing the edit function, and entering the password, you’ll be taken to the Key button, where both files can be downloaded.
Assigning a Context
In the Process Group Settings, you can now assign a context to the Process Group. Afterward, the parameters of this context are available to all Services and Processors in this Process Group.
Using Parameters
Once a parameter context has been assigned to a Process Group, the parameter can be accessed either by entering #{parametername} or by clicking the icon
next to the selected Processor’s properties.
This works in drop-down lists, checkboxes, and text fields.
Parameters are evaluated immediately after selection, and the result of the evaluation is displayed.
You can also use the menu to:
-
create a parameter from a property (provided no parameter has been selected yet)
-
jump directly to parameter management (provided a parameter has already been selected)
-
jump directly to parameter context management
Inheritance of Contexts
A Parameter Context can inherit parameters from one or more contexts. To do this, select the desired contexts from the drop-down menu. To delete a single context, click the X. If you want to delete all selected contexts, click the eraser icon.
For parameters with the same name, the following order applies:
-
The parameter from the inheriting context overrides inherited parameters
-
The order of inheritance: from top to bottom
Inherited parameters cannot be modified or deleted within the inheriting context. Changes can only be made to parameters you have created yourself.
Exporting/Importing Parameter Contexts
Parameter Contexts can be downloaded individually using the download button.
Use Import parameter context to import them again.
If the context to be imported inherits from another context, that context must be imported first, or a context with the same name must already exist.
Otherwise, the import will be aborted with an error message.
Information that was previously marked as sensitive will not be exported. In this case, the parameter is exported without an associated value.
Download example as JSON: parametercontext.json
Management Services
Management Services are shared services that ultimately do not differ significantly from Process Group Services. These services can only be used by Parameter Providers and other services, such as Reporting Tasks, for configuration or task execution. These services cannot be used in Processors or other services at the process group level.
At Referencing Components, you can find a list of Parameter Providers or other Services that use this Service.
Reporting Tasks
Reporting Tasks run in the background to generate statistical reports on the operations within the IGUASU instance.
Once the new component is complete, it must be explicitly started by clicking the Play button.
Flow Analysis Rules
Flow Analysis Rules can analyze components or (parts of) the diagram flow. They can result in rule violations, which can help adjust or maintain an optimal flow design.
Under Flow Analysis Rules, restrictions can be set for users to exclude certain components or configurations when creating a flow.
For example, if a specific Processor is not to be used, a Flow Analysis rule can warn the relevant users or prevent its use altogether, depending on the default settings.
The Violations tab in the Management area provides an overview of the components that are currently violating the configured rule.
Alternatively, rule violations can also be monitored in the Monitoring view.
Registries
In the Registries section, you can configure registries that can be used for the reuse and versioning of configured Process Groups. A comprehensive description of how to use versioning in IGUASU can be found in the section Versioning.
Registry Configuration
An IGUASU instance can optionally be connected to one or more registries. If this option is not selected, certain information related to versioning will not be displayed in the User interface. Configuration takes place in the Settings under the " Registries" section.
To open a registry’s settings, you must click on it once. The only registry that cannot be further configured is the “Shared Registry,” since it is shared.
Within a registry, any number of buckets can be created.
A bucket is a grouping of versioned flows to which different permissions—and thus user groups—can be assigned.
For this example, you can check the “ Publicly available ” box so that the bucket is visible to all users.
Users/Groups
In the "Users and Groups" section of the settings, you can view the users and existing user groups. The menu displays both the existing user groups and the registered users of the platform in a table. The identity provider Keycloak is used to manage users and their groups.
At the top of the table are the groups, which can be slightly modified by clicking the Edit button on the right. In addition to the existing user groups, the original table also displays all users of the platform. This also lists the user groups to which these individuals already belong.
Clicking the Edit button opens a new window displaying the users.
Those who already belong to the group are indicated by a checked checkbox.
The minimal customization within the group ultimately involves the checkbox Can acess restricted components.
This allows every user in the group to select restricted Processors.
|
User groups can be used to control the visibility of Process Groups in the Diagram. In the " Configuration area " of the corresponding Process Groups, you can define which user groups should be able to see the Process Group. |
Endpoints
HTTP endpoints can be managed here. Endpoints can be of the type "Internal," "External," or "External with TLS Termination."
Internal: Internal endpoints are accessible only within your own namespace (e.g., by other flows or the BPC) and cannot be used from outside. Internal Ports are accessed via the Service name https://iguasu-nifi:<port>.
External: External endpoints are publicly available and should be secured accordingly*.* The request is made via https://<domain>/<path> and is then forwarded to https://iguasu-nifi:<port> .
External with TLS Termination: Unlike the External type, TLS is terminated directly at the endpoint here rather than at the HTTP proxy in front of it. This is required to use TLS.
To do this, you must create a subdomain.
The request is made via https://<subdomain>.<domain>/<path> and is then forwarded to https://iguasu-nifi:<port>.
Endpoints that cannot be modified or deleted are part of the standard endpoints required for the application to function.
Updates
Under the "Updates" tab, IGUASU can be updated to the selected new version.
This can be done immediately or at a specific time (e.g., at night).
The update may take a few minutes.
Clicking the “ Change Version ” option triggers the update process.
Database Drivers
In this view, JDBC drivers can be customized or uploaded in IGUASU to enable connections to databases. Existing drivers are listed in a table, showing not only the filename but also when they were added.
When uploading drivers, it is important that the filenames have the extension .jar in order to be used in the system.
Uploaded drivers are stored at opt/iguasu/shared/driver.