Installation Instructions¶

Installation¶

Embedded ClusterHelm Deployment

To install using Embedded Cluster follow:

From your virtual machine, download the Pixee installer:

curl -f "https://distribution.pixee.ai/embedded/pixee/<release channel>" -H "Authorization: <your license ID>" -o pixee.tgz

Extract the Pixee installer:
```
tar -xvzf pixee.tgz
```
Run the Pixee installer:
```
sudo ./pixee install --license license.yaml
```
Info

The directory used for data storage can be changed by passing the --data-dir
You will be prompted to set an admin password, this password will grant access to the admin console later
When the installer completes, visit the admin console url in your browser: https://<domain name or vm ip>:30000
You may receive a self-signed certificate warning from your browser, this is expected
If you have a domain name and TLS certificate available you can configure the admin console to use them by following the prompts, or you can
The admin console will then load the configuration page. You will be directed through a workflow that will step you through configuring Pixee Enterprise Server.

To install using Helm Deployment follow:

Authenticate against the Pixee Helm Registry:

helm registry login registry.pixee.ai --username <your email address> --password <your license key>

Preflight checks - If there are any known issues that would prevent successful installation, the preflight checks will report them. To run the preflight checks:
```
helm template oci://registry.pixee.ai/pixee/<release channel>/pixee-enterprise-server --values values.yaml | kubectl preflight -
```
If there are no issues, or you are able to address all reported issues, continue with the installation using helm.

Helm install - Execute helm against the Kubernetes cluster to install, be sure to replace your release channel below (likely stable or unstable):

helm upgrade --install pixee-enterprise-server oci://registry.pixee.ai/pixee/<release channel>/pixee-enterprise-server -f values.yaml -n pixee-enterprise-server --create-namespace

Install the documentation site (optional) - The MkDocs-rendered Pixee documentation site ships as a separate sibling chart. Helm does not install sibling charts automatically, so install it explicitly:
```
helm upgrade --install pixee-enterprise-server-docs oci://registry.pixee.ai/pixee/<release channel>/pixee-enterprise-server-docs -f values.yaml -n pixee-enterprise-server
```
Install the analytics dashboards (optional) - The Superset dashboard payload + post-install import Job also ship as a separate sibling chart. Install only when you have Superset enabled in the main chart's values:
```
helm upgrade --install pixee-enterprise-server-dashboards oci://registry.pixee.ai/pixee/<release channel>/pixee-enterprise-server-dashboards -f values.yaml -n pixee-enterprise-server
```

The dashboards chart references the Superset Service and platform-database Secret created by the main chart, so install it into the same namespace and after the main chart's Superset pods are running.

Tip

Be sure to replace <release channel> with your actual assigned channel, this is likely stable or unstable. All three charts (main, docs, dashboards) are version-locked and released together — use the same chart version for each.