Install SystemLink Enterprise using Helm commands.

Creating Namespaces

Create namespaces to organize your cluster.

  1. Open the Command Prompt and run the following command.

    kubectl create namespace namespace

    Where
    • namespace is the namespace created for the application.
  2. Run the following command.

    kubectl create namespace namespace

    Where
    • namespace is the namespace created for the systemlink-admin Helm chart.

Preparing Certificates

Obtain certificate files for authentication. Reference these certificates when installing SystemLink Enterprise.

Note NI recommends using Transport Layer Security (TLS) for all communication between SystemLink Enterprise and outside resources. If you enable TLS for a database, you must supply a certificate authority (CA) for the database.
  1. Obtain a public certificate from your PostgreSQL database administrator.
  2. To use TLS for external data store resources, obtain CA certificates from the administrators for the following services.
    • PostgreSQL
    • MongoDB: Required only if you are using an external MongoDB.
    • S3 file storage
  3. If you need a private CA, you must deploy a copy of the public certificate trust chain for the CA before deploying SystemLink Enterprise. For more information, refer to Related tasks.

Installing Cluster Prerequisites

Install prerequisite resources globally on the cluster.

One of the following users must complete the following steps on the systemlink-admin Helm chart.
  • A cluster administrator with full access rights.
  • A user with a cluster role that includes privileges to create CustomResourceDefinitions, ClusterRoles, and ClusterRoleBindings.
Note The Jupyter Enterprise Gateway creates prerequisite resources during installation.
  1. Download a copy of systemlink-admin-values.yaml.
  2. Open the Command Prompt and run the following commands to install prerequisites to the systemlink-admin namespace.

    helm upgrade admin-release oci://downloads.artifacts.ni.com/ni-docker/ni/helm-charts/systemlinkadmin --install --version version --namespace admin-namespace --values systemlink-admin-values.yaml --values systemlink-values.yaml --values systemlink-secrets.yaml --wait --timeout 20m0s

    Where,
    • admin-release is the release name for installing the systemlink-admin Helm chart.
    • downloads.artifacts.ni.com/ni-docker is the URL of the registry. If using a local mirror, replace this URL with the URL of the mirror registry.
    • version is the specific version of the software to install.
    • admin-namespace is the namespace for the systemlink-admin Helm chart.
    This command waits for up to the configured timeout for the install to complete and for all resources to enter a ready state. The default timeout is 20 minutes. The timeout is conservative but installation times might vary due to a variety of factors. Adjust the timeout if needed.

Installing the Application

Install SystemLink Enterprise on the cluster.

The user who performs the installation does not need access to the full cluster. However, the user must have full access to the namespace created for the application. This topic assumes that you named the database certificate postgres.pem, but you can use any name. SystemLink Enterprise deploys the certificate as a ConfigMap resource.
To install SystemLink Enterprise, open the command prompt and run the following commands.

helm upgrade release oci://downloads.artifacts.ni.com/ni-docker/ni/helm-charts/systemlink --install --version version --namespace namespace --values systemlink-values.yaml --values systemlink-secrets.yaml --set-file database.postgresCertificate=postgres.pem --wait --timeout 20m0s

Where,
  • release is the name Helm assigns to the installed collection of software.
  • downloads.artifacts.ni.com/ni-docker is the URL of the registry. If using a local mirror, replace this URL with the URL of the mirror registry.
  • version is the specific version of the software to install.
  • namespace is the namespace for the application.
Note You can install multiple instances of SystemLink Enterprise on the same cluster. To install multiple instances, repeat the preceding commands with a different namespace and different values for each instance. Cluster prerequisites install only once for all instances.
This command waits for up to the configured timeout for the install to complete and for all resources to enter a ready state. The default timeout is 20 minutes. The timeout is conservative but installation times might vary due to a variety of factors. Adjust the timeout if needed.

Validating the Install

Test that SystemLink Enterprise installed correctly.

  1. Run a set of Helm tests to help validate a new installation.
    1. Open the Command Prompt.
    2. Run the following command.

      helm test release --namespace namespace

      Where
      • release is the name Helm assigns to the installed collection of software.
      • namespace is the namespace created for the application.
    This command deploys a series of pods that each perform a validation test on the cluster. This operation will run for several minutes before displaying results. If the tests pass, the command deletes most deployed pods. If a test fails, deployed pods remain in place so you can inspect the pod log.
  2. Navigate to the UI hostname you configured to login to SystemLink Enterprise as the configured system administrator.