perses-operator

Perses Operator

An operator to install Perses in a k8s cluster.

Getting Started

Install the Perses Operator in your Kubernetes cluster. You can use KIND to get a local cluster for testing, or run against a remote cluster.

Prerequisites

You’ll need:

• a Kubernetes cluster to run against. You can use KIND or minikube to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).
• kubectl installed and configured to use your cluster.

Running on the cluster

1. Install custom resource definitions:

make install-crds

1. Deploy the operator:

Option A: Using cert-manager

make install-cert-manager
make deploy

[!IMPORTANT] This will deploy the controller with the default image 'docker.io/perses/perses-operator:latest'. To > use a different image, set the IMG variable:

make deploy IMG=<your-image>

Option B: Using self-signed certificates (for development/testing)

make deploy-local

1. Create a namespace for the resources:

kubectl create namespace perses-dev

1. Install custom resources:

kubectl apply -k config/samples

1. Check the Perses UI:

kubectl -n perses-dev port-forward svc/perses-sample 8080:8080

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller from the cluster:

make undeploy

Docs

• API Docs
• Developer Docs
• Sample CRDs
  • Kubernetes
  • OpenShift
  • Using TLS

License

Copyright 2025 The Perses Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.