Install On-Prem Platform

This part of the documentation is only intended in the context of a supported PoC (Proof of Concept) together with the Steadybit team. Please, book an appointment to scope your PoC before continuing to evaluate the on-prem solution.

If you just want to try out Steadybit, we recommend you sign up for our SaaS platform.

This guide helps you with the initial installation and deployment of our Steadybit platform On-Premise. It is intended for situations where you cannot yet take advantage of our Software as a Service (SaaS) platform and need to host the platform yourself. After completing this getting started, continue by setting up Steadybit.

Installing and deploying the Steadybit platform on your servers is simple:

• Step 0 - Check Prerequisites

• Step 1 - Get your keys

• Step 2 - Deploy Platform

If you need help, please reach out to us.

Step 0 - Check Prerequisites

Before continuing, make sure that access to the following URLs via HTTPS (443) is possible from your location of installation:

• https://docker.steadybit.io and https://index.docker.io (Docker Image)

• https://packages.steadybit.com (Agent Linux Installation)

• https://get.steadybit.com (Setup Scripts)

• https://steadybit.github.io/helm-charts (when using Kubernetes and Helm)

The platform itself exposes the following ports:

• Port 8080: Application port for UI/API/agents

• Port 7878: WebSocket port for agents

Database

The platform needs a PostgreSQL 15 database. For a quick evaluation, the Helm chart can deploy one for you (see Step 2); for production use, bring your own PostgreSQL instance. In that case prepare the following before the first start:

• An empty database (e.g. steadybitdb) and an application user for the platform. The user does not need to be a superuser, but it must be allowed to CONNECT to and CREATE schemas in that database: the platform creates the schemas steadybit and sb_onprem on startup and owns all objects inside them.

• The PostgreSQL extensions pg_trgm and btree_gin in the public schema. Both are trusted extensions, so the platform installs missing ones itself if the user has CREATE on schema public; alternatively, install them beforehand. No superuser is required at any point.

• Database and platform clocks in sync.

The exact GRANT and CREATE EXTENSION statements are listed under Database Permissions.

Step 1 - Get your keys

To install the platform on-premise and connect the agents against it you need an agent key and a valid license. Get in touch with us, and we will provide you with an on-prem license key and an agent key.

The agent key is also used to authenticate against our Docker registry docker.steadybit.io hosting the platform images. The username is _ and the password is the agent key.

Step 2 - Deploy Platform

It is our goal to make the installation as easy as possible for you, that's why we recommend using our Helm chart that takes a lot of the work out of it and only requires a few parameters from you. If you are not familiar with Helm and would like to learn more about it, check out Helm's quickstart guide.

In case you can't use Helm or Kubernetes at all, get in touch with us and we'll find the best solution. The platform can be deployed without Helm and also on plain Docker hosts.

When pulling the platform images manually, e.g., on plain Docker hosts or to mirror them into an internal registry, log in to our Docker registry first using your agent key from Step 1 - Get your keys:

docker login docker.steadybit.io --username _ --password <replace-with-agent-key>

Please replace the placeholders replace-with-agent-key and replace-with-license-key with your agent key and license key of Step 1 - Get your keys:

helm repo add steadybit https://steadybit.github.io/helm-charts
helm repo update
helm install steadybit-platform \
  --create-namespace \
  --namespace steadybit-platform \
  --set platform.tenant.agentKey=<replace-with-agent-key> \
  --set platform.tenant.license=<replace-with-license-key> \
  steadybit/steadybit-platform

The Helm chart automatically creates the Kubernetes image pull secret for docker.steadybit.io from your agent key, so no manual docker login is required.

To make it convenient for you, we have a default for everything. That's also why we include the necessary Postgres database and set up everything for you automatically. Nevertheless, feel free to adjust parameters after having a look at the Helm chart in our public GitHub repository.

BE AWARE: The database is not backed up and if the pod is deleted the data is lost!

For production use, we strongly recommend setting up your own Postgres database and configuring the Steadybit platform as described here.

What's next?

Done, the platform is running. The default login for the on-prem platform is

• username: admin

• password: admin

Now you can set it up by connecting the first agents to it.

We'll show you how to do that in Install Agent and Extensions, at step 1.

Production Use

As mentioned above, this guide helped you set up a Steadybit platform quickly.

Before using Steadybit in production:

• Configure your own Postgres database as described here, and make sure the database user has the required permissions.

• Connect your internal authentication service, such as LDAP or an OIDC provider, as described here. We strongly recommend this.

Advanced Configuration

More configuration options can be found in Advanced Configuration.

Troubleshooting

If you have any problems, check our Troubleshooting page. Or please reach out to us.