Install Dash Enterprise on a Bare Metal Server

This guide can help you if you are a new Dash Enterprise customer looking to start with a Dash Enterprise 5 installation, or if you are upgrading from Dash Enterprise 4.X.

About Dash Enterprise: Use Cases

Dash Enterprise puts data and AI into action with the creation of production-grade data apps for your business. Python is the premier language of AI and data and Dash Enterprise is the leading vehicle for delivering Python-based, interactive insights and analytics to business users.

Cost Model and Billable Services

Dash Enterprise pricing is based on the number of instances, number of license seats, and server capacity that your organization requires.
Exact pricing is established via private offer. There are no optional features.

Plotly also offers paid Professional Services hours where app developers can
receive direct assistance to develop data apps that meet their users’ needs.
These hours are negotiated and billed separately from Dash Enterprise.

About the Installation

Installing Dash Enterprise is an automated process: You’ll run a script on your bare metal server that creates a Kubernetes cluster using kURL and installs Dash Enterprise on it.

You’ll be installing Dash Enterprise as the single tenant on the cluster—that is, no other software is installed on the cluster (except mandatory supporting software). Single-tenancy is well-suited for Dash Enterprise because it is a complex platform, organizing resources on the fly when developers perform tasks like deploying Dash apps and creating databases. Multi-tenancy is not currently supported.

You can configure Dash Enterprise to use an HTTP/HTTPS proxy (address like http://my.proxy.url:port) that is already present in your environment. Secure HTTP proxies (addresses like https://my.proxy.url:port) are not supported.

Plotly uses Replicated to package and deliver Dash Enterprise. You’ll be interacting with the KOTS Admin Console, part of the Replicated toolset, in the configuration step of this installation. After the installation, you’ll continue to use the KOTS Admin Console for system administration such as performing Dash Enterprise upgrades.

Before You Install

Here are some important notices and details about supported configurations before you get started.

If your server is in a public network, a TLS certificate is generated for you automatically by default. This automatically generated certificate works as follows:
* The TLS certificate is issued by Let’s Encrypt, a globally-trusted certificate authority (CA), so it is already in the root of trust stores used by major browsers, operating systems, and applications. Internet traffic is authenticated and encrypted with no additional configuration.
* Let’s Encrypt uses the Automatic Certificate Management Environment (ACME) protocol for automated management of the certificate. The certificate is automatically renewed every 90 days.
* Cert Manager, a Kubernetes-native component that is installed with Dash Enterprise, takes care of creating the required ACME client.
* You cannot view or download the automatically generated certificate.
* It is not compatible with private container registries.

If an automatically generated certificate is not appropriate for your organization, you can choose to upload a TLS/SSL certificate. This guide can help you do so. Be sure to read the certificate requirements in the Prerequisites carefully.

If configuring your installation to use a private container registry, you must upload a TLS/SSL certificate; the automatically generated certificate is not supported.

Prerequisites

Minimum specifications for the bare metal server change depending on which offering of Dash Enterprise your organization has purchased.

The root certificate can be issued by an external/globally-trusted CA or by a CA that is internal to your organization.

If you obtained your certificate chain as multiple files, you need to combine them into a single .pem file. You can do this with cat server.pem intermediate.pem trustedroot.pem > fullchain.pem on Linux or copy server.pem+intermediate.pem+trustedroot.pem fullchain.pem on Windows, replacing the file names if yours are different. Using multiple certificates or self-signed certificates are not supported.

You’ll upload the full certificate chain and unencrypted private key during the configuration, and they will be used to terminate TLS/SSL.

Name Type Value
<base-domain> A record <server-ip>
api-<base-domain> CNAME <base-domain>
ws-<base-domain> CNAME <base-domain>
git-<base-domain> CNAME <base-domain>
registry-<base-domain> CNAME <base-domain>
auth-<base-domain> CNAME <base-domain>
admin-<base-domain> CNAME <base-domain>

where <base-domain> is a fully qualified domain name (FQDN) that you want to use as the base domain for your Dash Enterprise instance and <server-ip> is the IP address of your bare metal server.

Preparing Your Installation

Contact our Customer Success team to get started. We’ll ask you:

Obtaining Your Installation Plan

When we have all the information we need, we’ll send you a zipped folder called your Installation Plan. Your Installation Plan is tailor-made based on your conversation with Customer Success and contains everything you need to install Dash Enterprise for your organization.

Your Installation Plan contains:

Defining Variables in the Script

Unzip your Installation Plan and open the config file. At the top, edit the following variable values:

About storing and resetting this password: We recommend storing this password in your organization’s password manager, and giving access to any other members of your team who will be managing the Dash Enterprise system (notably performing upgrades and obtaining support bundles). This password is not retrievable with a kubectl command. It can be changed in the Admin Console UI by anyone who is able to log in with the current password. If lost, reset it by running bash enter_bootstrap_pod.sh on your server and then kubectl kots reset-password -n plotly-system.

If your organization uses its own custom CA (with the internal root CA certificate installed on users’ systems), you can add the internal root CA certificate to Dash Enterprise with INTERNAL_CA_CERTIFICATE. It must be a .crt file and contain the root certificate only—not the full chain. Provide it as follows:

Moving Files to Your Server

Move the following files to the home directory of your bare metal server:

To achieve this using secure copy protocol (SCP), use:
sh scp -i path/to/private/key path/to/installation/script path/to/config/file path/to/bootstrap/pod/script path/to/root/ca <username>@<server-ip>:~
where:
* path/to/private/key is the path to the SSH private key corresponding to the public key you added to your bare metal server
* path/to/installation/script is the path to install_de_single_server.sh in your Installation Plan
* path/to/config/file is the path to config.local.sh in your Installation Plan
* path/to/bootstrap/pod/script is the path to enter_bootstrap_pod.sh in your Installation Plan
* path/to/root/ca is the path to your internal root CA certificate, if using
* <username> is the username of your bare metal server
* <server-ip> is the IP of your bare metal server

Configuring the SSH Port

By default, Dash Enterprise expects app deployments over SSH to use port 22. In this step, you’ll map the Linux OpenSSH daemon (sshd) to a different port to free up port 22 for Dash Enterprise.

If you plan to customize the Git SSH port when configuring Dash Enterprise, then you can skip this step.

This procedure differs based on the operating system of your bare metal server.

If SSHing into the server in the future, you’ll need to append the new SSH port to the ssh command (for example, -p 2222).

Installation

In this step, you’ll run the installation script from your server. This script does the following: * Installs Kubernetes via kURL. * Creates the plotly-system namespace. * Creates a bootstrap pod, de5-bootstrap, inside the plotly-system namespace. * Authenticates your user to your private container registry, if applicable. * Generates a kubeconfig file (~/.kube/config) to run kubectl commands against the Kubernetes cluster. * Port-forwards the Admin Console so that you can use it to configure Dash Enterprise.

The script takes several minutes to complete. Continue when you see the message Forwarding from 127.0.0.1:8800 -> 3000 (do not exit yet).

If you exit by mistake, restart the port-forward with kubectl port-forward -n plotly-system svc/kotsadm 8800:3000.

Configuration

Now that your single-node cluster is created and Dash Enterprise is installed on it, you’re ready for configuration. The KOTS Admin Console will take you through several configuration options.

To access the KOTS Admin Console and configure Dash Enterprise:

  1. On your workstation, open an SSH tunnel:
    sh ssh -i /path/to/private/key <username>@<server-ip> -p 2222 -L 8800:localhost:8800
    where /path/to/private/key is the path to the private key, <username> is the username of your VM, and <server-ip> is the IP address you are using. Omit -p 2222 if you did not remap the SSH port, or change 2222 if you chose a different port.

  2. On your workstation, go to http://localhost:8800.

  3. Enter the password that you set for ADMIN_PASSWORD in Defining Variables in the Script; then select Log in. You are prompted to upload your license.
  4. Drag or browse to the license file in your Installation Plan; then select Upload license. The Admin Console opens to the Configure Dash Enterprise page.
  5. In Hostname Settings, make sure your Dash Enterprise hostname is entered. If it isn’t, enter it, making sure it corresponds to the value for DE_HOSTNAME in your config file.
  6. In TLS Settings, do one of the following:
    * Select Upload TLS Certificate and Key and then upload your TLS/SSL certificate and key.
    * Leave Upload TLS Certificate and Key cleared to let the system generate a certificate (supported if your server is in a public network only).
  7. In Git Settings, review the Git SSH Port. The Git SSH port is set to 22 by default. If you change this port, consider the following carefully:
    * App developers will need to modify their SSH config in order to deploy over SSH from their workstations.
    * You don’t need to open your chosen port to any IPs; it just needs to be available (not bound to any other service).
    * You cannot use ports 80 or 443 for the Git SSH port.
    * After changing the default Git SSH port, you can close or restrict port 22.
  8. If you plan to set up Dash Enterprise authentication with an external SAML, OIDC, or LDAP server, and this server uses a self-signed certificate, configure Dash Enterprise to trust the server:
  9. Under Auth Settings, select Upload Self-signed / Internal Public CA Certificate. A file upload field appears.

  10. Drag or browse to the certificate that will establish trust. This certificate has the following requirements:

    • It must be a DER or base64-encoded file.
    • The Common Name (Server Name) in the certificate must be set to the fully qualified domain name (FQDN) that Dash Enterprise will use to reach your server.

    Depending on how the IdP certificate is signed, and whether there are intermediate certificate authorities (CAs), you may need to use the full certificate chain.

    You can upload this certificate later, but Dash Enterprise will be unable to communicate with the server until it can establish trust.

    Learn more about which authentication methods are supported.
    9. If applicable, in PIP_EXTRA_INDEX_URL, enter the URL of your organization’s private Python package index (recommended when Dash Enterprise does not have network access to PyPI.org). This will cause all apps and workspaces on Dash Enterprise to be able to fetch dependencies from this index.
    10. Select Continue. The Admin Console runs preflight checks, which can take up to a few minutes.
    11. Wait for the preflight checks to run. Then, do one of the following:
    * If you are not using a private container registry: If all the preflight checks are successful, select Deploy. If you encounter an error, contact Customer Success.
    * If you are using a private container registry: The preflight checks display a warning message prompting you to configure your private container registry. (If you encounter any other errors, contact Customer Success.) To configure your private container registry:
    1. Select the Plotly logo (<img>) in the top left to go to the dashboard (do not select Deploy).
    2. Go to Registry Settings.
    3. Enter the Hostname, Username, Password, and Registry Namespace for your private container registry.
    4. If you have retrieved the Dash Enterprise images into your private container registry, select Disable Pushing Images to Registry. (Note that this setting will be saved and applied when you upgrade Dash Enterprise.)

    <img>

    1. Optional: Select Test connection to check the connection to your private container registry.
    2. Select Save changes.
    3. Go to the Dashboard.
    4. Select Deploy.

  11. Wait for the status to change to Ready. This can take up to a few minutes.

<img>

  1. On your bare metal server, press Ctrl+C to disconnect from the Admin Console.

You can now access the Admin Console using its sub-domain: https://admin-&lt;your-dash-enterprise-server&gt;.

Accessing Dash Enterprise

Dash Enterprise uses Keycloak for identity and access management. During the installation, an initial Keycloak admin user was created to allow you to access the Keycloak Administration Console. As part of Keycloak security best practices, you’ll create a second Keycloak admin user. With this new Keycloak admin user, you’ll create the Dash Enterprise account that you’ll use to log in to https://&lt;your-dash-enterprise-server&gt;.

Creating the Keycloak Admin User

In this step, you’ll retrieve the password for the initial Keycloak admin user and use it to create a new admin user.

To create the new Keycloak admin user:

  1. On your VM, retrieve the password for the initial Keycloak admin user (this displays the password in plain text):

sh kubectl get secret keycloak-secrets -n plotly-system -o jsonpath='{.data.KEYCLOAK_PASSWORD}' | base64 -d && echo

  1. Copy the password.
  2. Go to https://auth-&lt;your-dash-enterprise-server&gt;
  3. Select Administration Console.
  4. Enter the username admin and the password that you retrieved in step 1; then select Sign In.

<img>

A warning message is displayed that recommends you create a new admin user and delete the existing one. Important: Do not delete nor edit the initial Keycloak admin user. This user is managed by Dash Enterprise.

  1. Make sure that Keycloak (master) is selected in the realm list in the top left corner.
  2. Select Users > Add User.
  3. In Username, enter the username that you want for the Keycloak admin user.
  4. Select Create. Additional settings become available.
  5. Go to Credentials.
  6. Select Set password.
  7. In Password and Password confirmation, enter the password you want to use.
  8. Select Save; then Save password to confirm.
  9. (Recommended) Add the username and password to your organization’s password manager or other secure storage. You can share these credentials with other members in your organization who need to access Keycloak.
  10. Assign the Keycloak admin role:
    1. Go to Role mapping.
    2. Select Assign role.
    3. Change the filter to Filter by realm roles.
    4. Find and select the role called “admin”.
    5. Select Assign.

Use this user from now on when logging in to Keycloak.

You can rotate the password for this user in Keycloak by going back to the Keycloak (master) realm, editing the user, and changing the Password that is set. Note that managing this user is the only reason to go to the Keycloak (master) realm. All Dash Enterprise user management is done in a different realm.

Creating Your Dash Enterprise User

In this step, you’ll log in to Keycloak using the newly created admin user and create a Dash Enterprise user that has admin permissions at the Dash Enterprise level. Dash Enterprise administrators have access to the Admin section of the Dash Enterprise App Manager, which you’ll use to configure system limits in a later step. Learn more about Dash Enterprise permissions.

To create your Dash Enterprise user:

  1. If you’re still logged in to Keycloak with the initial admin user, log out and back in with the new admin user.

  2. Go to the realm responsible for Dash Enterprise users by selecting dash from the realm list in the top left corner.

    Dash realm

  3. Select Users > Add User.

  4. In Username, enter the username that you want to use when logging in to Dash Enterprise.
  5. Select Create. Additional settings become available.
  6. Go to Credentials.
  7. Select Set password.
  8. In Password and Password confirmation, enter the password you want to use.
  9. Select Save; then Save password to confirm.
  10. Assign the Dash Enterprise admin role:
    1. Go to Role mapping.
    2. Select Assign role.
    3. Change the filter to Filter by clients.
    4. Find and select the role called “dash admin”. Note that if you intend on deploying apps, you’ll also need the “dash licensed_user” role, and assigning this role consumes a license seat.
    5. Select Assign.

You can now log in to https://&lt;your-dash-enterprise-server&gt; using the credentials for the newly created Dash Enterprise user. Dash Enterprise opens to the Portal. Go to the App Manager by selecting Apps > App Manager.

<img>

Setting System Limits

In this step, you’ll safeguard Dash Enterprise against usage that would cause the Kubernetes cluster to exceed the resources it can support. Specifically, you’ll add limits to the amount of pods and volumes (PVC) that can exist, temporarily preventing app developers from performing actions that would create more pods and volumes on the cluster when the limit is reached. To do so, you’ll use the System Limits setting in the Admin section of the App Manager. To learn how to calculate and set limits that are appropriate for your cluster, go to Pod and Volume Limits.