Version:

Managing Kinetica with KAgent

After at least one cluster has been initialized and Kinetica has been installed, cluster management is available using the KAgent user interface (UI) or command line interface (CLI).

UI

The KAgent UI is usually available on port 8081 of the desired machine, so it can be accessed via http://<kagent-host>:8081.

Clusters

The home page for the KAgent management UI is the Clusters page.

  • Click Rings to display the rings related to the clusters managed by this instance of KAgent.
  • Click Add Cluster to begin adding a cluster. See KAgent for more information.
  • Click Jobs to view KAgent jobs.
  • Click Logs to view KAgent logs.
  • Click logout to logout of KAgent.
  • Click console to open the KAgent console log
  • Click the headnode icon in the Nodes column to open a browser tab to the head node's Admin Application (GAdmin -- http://<host>:8080)
  • Click Manage next to a cluster to open the management options for the cluster.
  • Click Delete to remove the cluster from KAgent. This will not uninstall Kinetica or any other services.
../_images/kagent_clusters.png

Jobs

The Jobs page displays all historical and currently active jobs. Click X to cancel a running job.

../_images/kagent_jobs.png

Logs

The Logs page hosts the logs for each KAgent command and result during the verification and installation processes as well as any later interactions with KAgent. Click Clear Activity to clear the selected log and click Refresh to refresh the selected log.

../_images/kagent_logs.png

Console

The Console window hosts a running log of KAgent's activity while it interacts with the local/provisioned instances to install or upgrade Kinetica and its components, create backups, and more. Click Show Details to display detailed information about each interaction.

../_images/kagent_console.png

Manage

Each cluster can have backups scheduled, Kubernetes Docker registries configured, additional security options enabled, and more. At any point, click Clusters to return to the home page.

Nodes

Nodes provides a quick summary of the nodes in the cluster.

../_images/kagent_nodes1.png

Detail

Detail provides information about the cluster, including ring (HA) information, the state of the cluster, the SSH User input during the installation process, and more.

../_images/kagent_detail.png

Security

Security provides the ability to adjust the existing security configuration for the cluster. Click Start Over to reset any changes made.

To update the security configuration:

  1. Select an SSL Update Mode:

    • Cert/key setup not required -- no SSL certificate/key creation/upload required and no updates to security configuration settings
    • User-provided cert/key per node -- user must upload an SSL certificate and key for each node; Kinetica copies the cert/key pair to /opt/gpudb/certs, enables HTTPD, and configures HTTPD to use HTTPS
    • Generate self-signed cert/key per node -- KAgent generates a self-signed certificate and key for each node and places it in /opt/gpudb/certs, enables HTTPD, and configures HTTPD to use HTTPS
  2. Click Update SSL. This will override any existing configuration.

  3. Select an Authentication type and fill the fields as necessary:

    • None -- no authentication or authorization
    • LDAP -- configures Kinetica to authenticate via LDAP; requires authentication to connect to the database, enables authorization, enables external authentication, automatically creates users in the database for LDAP users, and automatically grants roles in the database to LDAP users
    • Active Directory -- configures Kinetica to authenticate via Microsoft Active Directory; requires authentication to connect to the database, enables authorization, enables external authentication, automatically creates users in the database for Active Directory users, and automatically grants roles in the database to Active Directory users
    • Kerberos -- configures Kinetica to authenticate via Kerberos; requires authentication to connect to the database, enables authorization, enables external authentication, automatically creates users in the database for Kerberos users, and automatically grants roles in the database to Kerberos users

    Note

    For more information on security configurations and settings as well as how to manually configure Kinetica for a secure setup, see Security Configuration

  4. Click Update. This will override any existing configuration.

../_images/kagent_security1.png

Backups

Backups provides the ability to schedule backups of your entire database. In this section, the system can also be restored from a previous snapshot. Consult Backing Up/Restoring Kinetica for information on backing up Kinetica using KAgent from the command line.

../_images/kagent_backups.png

Schedule

To enable a backup:

  • Click Backup Now to kick off a backup immediately outside of the set schedule (if one exists). Using Backup Now allows for a custom backup path if desired; not inputting a custom path results in the backup being created using the scheduled backup path.
  • Select Hour, Day, or Month, then select the desired timing of the backup. Next, enter a backup path (must be local to the head node of the cluster), and then click Update.
Snapshots

By default, Snapshots displays all backups in the set backup path directory.

  • Click Restore and confirm to restore the database from a snapshot.
  • Provide an alternate backup path to View Backup Path and click Refresh to display any backups located in the given path.
../_images/kagent_snapshots.png

K8

K8 provides the ability to manage and add Docker registries for use with the Active Analytics Workbench (AAW). Docker registries can only be added if a K8 config is available on the cluster.

To add a registry:

  1. Click Add Registry.
  2. Provide a Location (URL) for the registry and a Username, Password, and E-mail used to access the registry.
../_images/kagent_k8.png

Admin

Admin provides the ability to start, stop, or restart any of the Kinetica-managed services. KAgent will first check for the installed services across the cluster, then each service can be managed.

../_images/kagent_admin.png

Upgrade

Upgrade displays various Kinetica versions to upgrade to from the public Kinetica repository. If the latest version is installed, no other versions are able to be installed.

../_images/kagent_cluster_upgrade.png