Skip to main content

Online installation

Goal: install Octostar on a cluster that can reach Docker Hub and the upstream chart repositories. For sites without internet, see Air-gapped installation.

Before you begin​

Steps​

1. Download the installer​

curl -fsSL https://install.octostar.com/install-octostar-raw.sh | bash -s -- --nightly
sudo chown -R "$USER" /opt/octostar
cd /opt/octostar

2. Configure​

cp local-env.template.yaml local-env.yaml

Edit local-env.yaml. Set at least dockerHub.token and timbrAdminPassword. Set the token in this file. The DOCKERHUB_TOKEN variable alone does not let the nodes pull the images. Keep a safe copy of the file. It holds secrets that exist nowhere else.

3. Install​

./bin/install.sh --context <context-name>
OptionUse
--dry-runPreview without changing the cluster
--no-wait-downloadsDo not wait for the map data at the end
--log-level debugMore output, to find a problem

Run ./bin/install.sh -h for all options.

⚠️ Do not run install.sh over a working installation. To change a running install, use update-existing.sh. See Upgrading.

4. Trust the certificate (default domain only)​

Trust the root CA (certs/rootCA.crt) on the machine with your browser. --install-cert trusts it only on the host that runs install.sh. It does not stop after that step: it runs a full install, or, on a working installation, it ends with an "already installed" error.

For production, use your own certificate or ZeroSSL. See Configuration → Certificates.

5. Verify​

The install uses the release's own kubectl. To run it from your shell, put the release's tools on your PATH first, from the directory the release is in (see Prerequisites):

export PATH="$PWD/bin/tools/$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m | sed 's/x86_64/amd64/; s/aarch64/arm64/'):$PATH"
kubectl get pods -n octostar-main

When the pods are Running or Completed, open:

  • https://home.<domain> — the platform and its API
  • https://fusion.<domain> — Fusion

Log in as admin with timbrAdminPassword, or as Configuration → Admin access describes when Keycloak is on.

If it fails​

  • Collect the logs. First select the cluster with kubectl config use-context <context-name>: --dump-logs ignores --context. Then run ./bin/install.sh --dump-logs --context <context-name>.
  • Read the message. The installer checks the cluster first and names the problem. For cluster-level conflicts, see Shared clusters.
  • Pods in ImagePullBackOff: check the Docker Hub token and the outbound access in Prerequisites.
  • See Operations & uninstallation, or contact Octostar support with the log file.

Next steps​