Ocular Installation Guide

This guide provides detailed instructions for getting Ocular installed and running on a Kubernetes cluster. You can either install via Helm as described below or build from source as described by the docs/DEVELOPMENT.md file in the GitHub repository.

Installation via Helm

NOTE: Ocular container images support both Linux amd64 and arm64. Please raise an issue if you require support for another.

Crash Override maintains a Helm Chart that can be used to install Ocular. The installation will most likely need to be customized to your environment, but the steps below will show a very basic use case. View the values.yaml for all the options available.

1. Add the Crash Override helm chart repository

helm repo add crashoverride https://crashappsec.github.io/helm-charts

2. Create a values.yaml to configure the application.

# Contents of values.yaml
# THIS IS AN EXAMPLE AND SHOULD BE CUSTOMIZED TO YOUR ENVIRONMENT
# for the full spec see:
# https://artifacthub.io/packages/helm/crashoverride-helm-charts/ocular

ingress:
  enabled: true # we want to enable the creation of an ingress
  hosts:
    # Assume this domain routes to my cluster
  - host: ocular.example.com
    paths:
          - path: /
            pathType: Prefix
    tls:
    hosts:
    - ocular.example.com

3. Install via helm

# NOTE: This will install via `kubectl`,
# so please ensure you've selected the right
# context & namespace
helm install ocular crashoverride/ocular

🎉 4. Profit

curl -fsSL https://ocular.example.com/health
# {"success":true,"response":"ok"}

Next Steps

Navigate to the quick start guide to learn how to start pipelines and searches.