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.
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.
Dash Enterprise pricing is based on the number of instances and license seats 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.
Installing Dash Enterprise is an automated process: You’ll run a script on the VM that creates a Kubernetes cluster using kURL and installs Dash Enterprise on it. No internet connection is required.
This guide describes how to use your cloud provider’s virtual machine (VM) service to provision a VM that will act as the server, but you can still follow this guide if you already have a VM ready to go.
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.
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.
Here are some important notices and details about supported configurations before you get started.
Before committing to an airgapped Dash Enterprise installation, make sure your organization can provide an internal index. Dash Enterprise requires that the index have a TLS/SSL certificate from a globally trusted certificate authority (CA). A common strategy is to create a mirror of pypi.org.
Important: Apps deployed to Dash Enterprise use Python 3.10.11 by default, though developers can change the Python version. For a full list of supported versions, see the App Structure page.
Similarly, if Dash app developers plan to deploy apps that depend on APT packages, you’ll need to prepare a custom APT repository with a TLS/SSL certificate from a globally trusted certificate authority (CA).
Restarting the VM: Stopping and restarting the VM that Dash Enterprise is installed on (often called parking) is not supported. The VM must be left on for Dash Enterprise to remain in a healthy state.
Changing the VM IP: Changing the internal and/or public IP of the VM after installation, such as by moving the VM to a different subnet, is not supported.
Load balancing: Dash Enterprise on a single server does not come with a load balancer. If you need to place a load balancer in front of the VM, make sure that it supports websocket connections.
Contact our Customer Success team to get started. We’ll ask you:
When we have this information, we’ll send you a tailor-made installation script as well as a link and password to a download portal from which you’ll need to download an airgap bundle. 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:
install_de_ss_airgap.sh
, which creates the Kubernetes cluster and installs Dash Enterprise as well as supporting software.config.local.sh
, which contains variables used by the installation script. You’ll define some of these variables as part of the install preparation.setup-tools.tar.gz
, which contains kURL as well as other tools required for the installation.enter_bootstrap_pod.sh
, which is intended for post-install operations. The bootstrap pod is where key tools will be located after the installation.sha256sums.txt
, provided for support purposes.In this step, you’ll download the airgap bundle required to install Dash Enterprise. Note that the Dash Enterprise airgap bundle is approximately 21 GB.
To download the airgap bundle:
Unzip your Installation Plan and open the config file. Edit the following variable values:
ADMIN_PASSWORD
: The password you want to set for the KOTS Admin Console.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 runningenter_bootstrap_pod.sh
on your server and thenkubectl kots reset-password -n plotly-system
.
HOST_INTERNAL_REGISTRY
: The hostname of the private container registry you are using for Dash Enterprise images, including the desired namespace. Must not include a trailing slash.HOST_INTERNAL_REGISTRY_USER
: The username for the account you’ll use to push images to your private container registry.HOST_INTERNAL_REGISTRY_PASSWORD
: The password for the account you’ll use to push images to your private container registry.AUTH_REGISTRY_PULLS
: Leave false
if the private container registry does not require authentication to pull images. If authentication is required to pull images, change to true
.HOST_INTERNAL_REGISTRY_BASE
: If AUTH_REGISTRY_PULLS
is set to true
, provide the hostname of the private container registry without namespaces. Otherwise, leave empty.SKIP_PUSH_IMAGES
: Set to true
if you have retrieved the Dash Enterprise images into your private container registry before the installation. Otherwise, leave false
.SKIP_REGISTRY_CHECK
: Set to true
if you have retrieved the Dash Enterprise images into your private container registry before the installation. Otherwise, leave false
.INSTALL_ISTIO
: Leave false
unless instructed to modify this (and allowing access to istio.io
over 443
on your bootstrap node) by our Customer Success team.KURL_PRIVATE_IP
: If your server has more than one network interface, specify the IP address for kURL to use when creating the Kubernetes cluster. If your server has a single network interface, leave this blank.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:
INTERNAL_CA_CERTIFICATE
(optional): The name of your internal root CA certificate file, including its .crt
extension.Move the following files to the home directory of your VM:
install_de_ss_airgap.sh
config.local.sh
setup-tools.tar.gz
enter_bootstrap_pod.sh
One way to do this is to use secure copy protocol (SCP).
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 VM.
Don’t forget that to SSH into the VM in the future, you’ll need to append the new SSH port to the ssh
command (for example, -p 2222
).
In this step, you’ll run the installation script from your server. This script does the following:
plotly-system
namespace.de5-bootstrap
, inside the plotly-system
namespace.~/.kube/config
) to run kubectl
commands against the Kubernetes cluster.To create the cluster and port-forward the KOTS Admin Console:
sudo bash install_de_ss_airgap.sh
kots
install location by Enter installation path (leave blank for /usr/local/bin)
, press Enter
to accept the default./usr/local/bin
, press y
(you will not be prompted for a password).The script takes several minutes to complete. Continue when you see the message Forwarding from 0.0.0.0:8800 -> 3000
(do not exit yet).
If you exit by mistake, restart the port-forward with
kubectl port-forward -n plotly-system svc/kotsadm --address 0.0.0.0 8800:3000
.
The next time you SSH into your Dash Enterprise server, you’ll need to append the new SSH port to the ssh
command.
Now that your cluster is created, you’re ready to install Dash Enterprise on it. The KOTS Admin Console will take you through uploading your Dash Enterprise license and airgap bundle.
To access the KOTS Admin Console and install Dash Enterprise:
On a machine with a web browser, 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 bare metal server, and <server-ip>
is the IP address of your bare metal server. Omit -p 2222
if you did not remap the SSH port, or change 2222
if you chose a different port.
On the same machine, go to http://localhost:8800
.
ADMIN_PASSWORD
in Defining Variables in the Script; then select Log in. You are prompted to upload your license..airgap
file you downloaded earlier.SKIP_PUSH_IMAGES
and SKIP_REGISTRY_CHECK
are false
in your config file), clear the Disable Pushing Images to Registry checkbox. (Note that this setting will be saved and applied when you upgrade Dash Enterprise. Change it in the Admin Console registry settings if you don’t want to keep this workflow for Dash Enterprise upgrades).When the upload is complete, the KOTS Admin Console opens to the Configure Dash Enterprise page.
Now that Dash Enterprise is installed, you’re ready for configuration. The KOTS Admin Console will take you through several configuration options.
On the Configure Dash Enterprise page, do the following:
DE_HOSTNAME
in your config file.Drag or browse to the certificate that will establish trust. This certificate has the following requirements:
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.
5. In PIP_EXTRA_INDEX_URL, enter the URL of your organization’s private Python package index (you can also configure it later). This will cause all apps and workspaces on Dash Enterprise to be able to fetch dependencies from this index.
6. Select Continue. The Admin Console runs preflight checks, which can take up to a few minutes.
7. Wait for the preflight checks to complete. If the results are all successful, select Deploy. If you encounter an error, contact Customer Success.
The Admin Console opens to the dashboard, where the status of the system is displayed.
8. Wait for the status to change to Ready. This can take up to a few minutes.
<img>
Ctrl+C
to disconnect from the Admin Console.You can now access the Admin Console using its sub-domain: https://admin-<your-dash-enterprise-server>
.
Before you can log in to Dash Enterprise at https://<your-dash-enterprise-server>
, you’ll need to create a Dash Enterprise user in Keycloak. Keycloak is the identity and access management solution for Dash Enterprise.
In this step, you’ll retrieve the Keycloak password that is stored as a secret in your cluster and save it according to your organization’s best practices.
To obtain and store the Keycloak password:
sh
kubectl get secret keycloak-secrets -n plotly-system -o jsonpath='{.data.KEYCLOAK_PASSWORD}' | base64 -d && echo
Note about recovering the Keycloak password: Changing this password requires Plotly support. Do not rotate it without contacting us.
In this step, you’ll log in to Keycloak using the stored credentials and create a new user with the admin
role. The admin
role grants 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 the admin role.
To access Keycloak and create your admin user:
https://auth-<your-dash-enterprise-server>
<img>
Make sure Dash is selected in the realm list in the top left corner.
Select Users > Add User.
admin
role:admin
; then select Add selected. Note that if you intend on deploying Dash apps, you’ll also need the licensed_user
role, and assigning this role consumes a license seat.To log into Dash Enterprise with this user, go to https://<your-dash-enterprise-server>
and enter the credentials that you saved in Keycloak. Dash Enterprise opens to the Portal. Go to the App Manager by selecting Apps > App Manager.
<img>
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 Dash 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.
In order to upgrade Dash Enterprise, you’ll need a VM from which to run Plotly-provided, kubectl
-based scripts. The bastion that you may have used as part of the installation already meets these requirements, so while it is safe to delete it, your organization may want to reuse it for upgrades. If reusing the bastion, be sure to leave your config file on it (upgrade scripts will source it) and, if applicable, keep the outbound rule for dl.plotly.com
.
If you’re deleting the bastion, keep a copy of your config file that you can move to a new bastion when performing upgrades, and remember to allow communication to dl.plotly.com
on it.