Skip to main content

​
Overview

Cysmiq self-hosted deployments use Replicated. Choose an installer option for your environment.

​
Installer options

Install on an existing Kubernetes cluster with the Replicated Admin Console. Continue with the steps below.

​
Prerequisites

  • Two license files from Cysmiq: a Replicated license (.yaml) and a Cysmiq application license (.lic)
  • Network access for Replicated and Cysmiq endpoints. See network requirements
  • A Kubernetes cluster that meets the self-hosting requirements
  • kubectl configured with cluster-admin access
  • Replicated KOTS CLI installed. Follow the KOTS CLI getting started guide
  • A DNS name or load balancer for your Cysmiq app if you plan to expose it with Ingress or HTTPProxy

​
Steps

1

Install Cysmiq with KOTS

Run the install command provided during onboarding. It prompts you for a namespace and the Admin Console password.
kubectl kots install cysmiq/stable
When the install completes, keep the terminal output. It includes the Admin Console access URL.
2

Open the Admin Console

If your workstation can reach http://localhost:8800, open it and log in with the password you set.
Cysmiq Admin Console login screen with a password field.
If you need to reopen the console later, run:
Reopen the Admin Console
kubectl kots admin-console --namespace <namespace>
If you run kubectl on a remote VM and cannot access http://localhost:8800, expose the kotsadm service and access it via the node IP.
Expose the Admin Console with NodePort
kubectl edit svc kotsadm --namespace <namespace>
Change type: ClusterIP to type: NodePort, save, then run kubectl get svc -n <namespace> to find the assigned port.
3

Upload the Replicated license

Upload the Replicated license file to continue.
Replicated license upload screen with a drag and drop area.
If you see a “Let’s get you started!” sidebar, first enter your Application Domain Name then scroll down and press Continue.
4

Configure Cysmiq

Open the Config tab and set the required fields, including Application Domain Name. Keep defaults unless you need custom storage, database, or exposure settings.
Configuration page showing organization name, application domain, and expose services options.
Select Save config to apply the settings. For a full list of options, see Self-hosting configuration.
5

Run preflight checks and deploy

Review the preflight checks, resolve any failures, then continue.From the Admin Console dashboard, wait for the application status to reach Ready. You might see Missing or Deploying while the installation completes.
Replicated Admin Console dashboard showing the Cysmiq application status.
6

Activate the Cysmiq app license

Navigate to the domain you configured.Create your first admin account, then upload the Cysmiq application license to activate the installation.
Cysmiq license activation page prompting for a .lic file.

​
Next steps