Management

Federation is managed from Admin → Federation, available to users with the federation-admin role.

Add Node

Adding a node makes that node available for federation, but does not federate with it yet (that happens when it is enabled).

A quick check of the node’s availability and identification information (name, version, classification) is performed, so it can be included in the table listing.

It’s OK if the node is unavailable at the time it is added. Its identification information will be checked again when it is enabled.

  1. Click the Add Node button in the upper right.

  2. Input the URL of the other node to be federated with.

    The URL should not contain any trailing forward slash "/" character at the end of the URL.

  3. Click Confirm.

  4. The new node is added to the table. If the node is available, it’s Name, Version and Classification details will be set.

Enable Node

Enabling a node initiates federation with the remote node.

You will be prompted for the client credentials the local node is to use when communicating with the remote node. These credentials are stored as long as federation with the node is enabled.

  1. In the Actions column, click the network icon. Its tooltip should display the text "Enable", if it says "Disable" then it is already enabled.

  2. This will present a modal asking for OAuth Credentials for the target node. This should be a client that has privileges to pull data from the remote node. Typically, this can be the df-federation client from the remote node’s Keycloak.

  3. Click Enable.

The client credentials you use to enable the federated node must have access to any/all data you wish to have federated access to. For example, catalog data can be restricted to certain user groups. In order for group-protected data to be federated, the client must also be part of those groups.

At this point the local node will begin crawling the remote node’s catalog in the background. It is synchronizing the local catalog with the datasources and datasets that are available from the remote node.

These will appear as "Federated" enablements in the local catalog.

Disable Node

Disabling a node stops all federation activity with the remote node, and removes all remnants of the federated enablements from the local catalog.

This is a destructive operation to the local catalog. Any data that has been pulled from the remote node is deleted when its federated enablements are removed.

To disable a node, click the same network icon you used to enable it.

To delete a node, click the trash can icon.

Deleting a node performs both disable and delete in one operation.

Delete Node

Deleting a node removes it from the federation list, and forgets the node entirely.

If the node happens to be enabled, it is first disabled and then deleted.