Polycrate Operator
Installs the Polycrate operator into a Kubernetes cluster. It discovers workloads in that cluster and can report them to a Polycrate API. The API is any instance you run; set its URL yourself.
Actions
polycrate run polycrate-operator install
polycrate run polycrate-operator deploy
polycrate run polycrate-operator status
polycrate run polycrate-operator info
polycrate run polycrate-operator uninstall
install applies the operator. deploy updates a running installation.
Connect your API
Leave API sync off until you have an API and a token. api_url is the base URL of that API.
blocks:
- name: polycrate-operator
from: cargo.ayedo.cloud/ayedo/k8s/polycrate-operator
config:
operator_config:
api_sync:
enabled: true
api_url: https://polycrate.example.com
credentials:
api_token: ""
local_cluster:
enabled: true
cluster_name: example-cluster
Put the token in secrets.poly, not in the workspace file:
blocks:
- name: cargo.ayedo.cloud/ayedo/k8s/polycrate-operator
config:
operator_config:
api_sync:
credentials:
api_token: "replace-with-token"
The token carries the workspace and organization. You do not set those ids on the block.
What it does
Turn features on or off under config.operator_config.
On by default:
- Endpoints from Ingress and HTTPRoute objects that are marked for monitoring. Unmarked ingresses are ignored. The older "watch everything" behavior is
endpoint_discovery.mode: auto. - Apps from Polycrate meta-secrets.
- Nodes, Velero and CloudNativePG backups, cert-manager certificates, and persistent volumes.
- S3 bucket provisioning and the external-dns webhook.
- Removal of objects that have not been seen again.
Off until you enable them:
- API sync and registration of this cluster.
- Active endpoint checks (
operator_config.agent). ICMP checks needNET_RAW. - Cloud-controller load balancer handling. Enable it only when this operator is the only cloud controller in the cluster.
- The cert-manager DNS-01 webhook.
Container-image discovery and the Artifact CRD are no longer part of the operator. Label-based app discovery is off.
Private image registry
config:
image_credentials:
enabled: true
registry: registry.example.com
username: ""
password: ""
Logs
kubectl logs -f deployment/polycrate-operator -n polycrate
kubectl get operatorconfig -n polycrate