Skip to content

Installation Instructions

Installation

To install using Embedded Cluster follow:

  1. 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

  2. Extract the Pixee installer: 

    tar -xvzf pixee.tgz

  3. 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

  4. You will be prompted to set an admin password, this password will grant access to the admin console later

  5. When the installer completes, visit the admin console url in your browser: https://<domain name or vm ip>:30000

  6. You may receive a self-signed certificate warning from your browser, this is expected

  7. 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

  8. 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:

  1. Authenticate against the Pixee Helm Registry: 

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

  2. 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.

  3. 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

Tip

Be sure to replace <release channel> with your actual assigned channel, this is likely stable or unstable