phoenixai-kubernetes-operator

Documentation

Guides for deploying and operating PhoenixAI on Kubernetes, grouped by topic. These are the same guides that make up the PhoenixAI Anywhere documentation site.

Get started

• Quick start with Amazon S3
• Quick start with MinIO
• Console tour

Deploy

• Prerequisites — what to have in hand, and the checks to run first.
• Least privilege to deploy
• Install with Helm — the complete step-by-step install, assuming no prior Kubernetes or Helm experience. Start here.
• Install with kubectl
• Migrate from the StarRocks operator
• Console data volume
• Warehouses
• Multiple clusters
• License a cluster
• Upgrade the operator

Configure

• Change Root Password
• Init Root Password When First Deploy
• Connect the Operator to an SSL-Enabled FE
• Mount Persistent Volume
• Mount CSI Ephemeral Volumes
• Mount External ConfigMaps Or Secrets
• Run With a Read-Only Root Filesystem
• Use MinIO for Shared Data

Scale

• HPA Automatic Scaling For CN Nodes
• Scale In FE Nodes

Operate

• Deploy the FE Proxy
• Logging and Related Configurations
• Expand Persistent Volume (FE/CN)
• Kubernetes Node Maintenance and PodDisruptionBudget
• Cluster Snapshot & Restore

Monitor

• Deploy Prometheus and Grafana
• Prometheus And Grafana
• Anywhere Console monitoring
• Datadog

Troubleshoot

• Health checks
• Inspect cluster state
• Generating a support bundle
• Reading a support bundle

Reference

• API Reference — every field of the PhoenixAICluster and PhoenixAIWarehouse CRDs.

Also in this folder

• deprecated/ — documents resources that are no longer shipped.