README.md

RustFS Operator Helm Chart

Helm chart for deploying the RustFS Kubernetes operator.

Prerequisites

• Kubernetes v1.30+
• Helm 3.0+

Installing the Chart

To install the chart with the release name rustfs-operator:

helm install rustfs-operator deploy/rustfs-operator/

To install in a specific namespace:

helm install rustfs-operator deploy/rustfs-operator/ --namespace rustfs-system --create-namespace

Uninstalling the Chart

To uninstall/delete the rustfs-operator deployment:

helm uninstall rustfs-operator --namespace rustfs-system

Configuration

The following table lists the configurable parameters of the RustFS Operator chart and their default values.

Operator Configuration

Parameter	Description	Default
operator.replicas	Number of operator replicas	1
operator.image.repository	Operator image repository	rustfs/operator
operator.image.tag	Operator image tag	latest
operator.image.pullPolicy	Image pull policy	IfNotPresent
operator.imagePullSecrets	Image pull secrets	[]
operator.resources.requests.cpu	CPU resource requests	100m
operator.resources.requests.memory	Memory resource requests	128Mi
operator.resources.limits.cpu	CPU resource limits	500m
operator.resources.limits.memory	Memory resource limits	512Mi
operator.env	Environment variables	[{name: RUST_LOG, value: info}]
operator.nodeSelector	Node selector for pod placement	{}
operator.tolerations	Tolerations for pod scheduling	[]
operator.affinity	Affinity rules for pod scheduling	{}

RBAC Configuration

Parameter	Description	Default
rbac.create	Create RBAC resources	true
serviceAccount.create	Create service account	true
serviceAccount.name	Service account name	"" (auto-generated)
serviceAccount.annotations	Service account annotations	{}

Other Configuration

Parameter	Description	Default
namespace	Namespace to deploy to	"" (uses release namespace)
commonLabels	Labels to add to all resources	{}
commonAnnotations	Annotations to add to all resources	{}

Examples

Custom Image and Tag

helm install rustfs-operator deploy/rustfs-operator/ \
  --set operator.image.repository=myregistry/operator \
  --set operator.image.tag=v0.2.0

Increased Resources

helm install rustfs-operator deploy/rustfs-operator/ \
  --set operator.resources.requests.cpu=200m \
  --set operator.resources.requests.memory=256Mi \
  --set operator.resources.limits.cpu=1000m \
  --set operator.resources.limits.memory=1Gi

Using a Values File

Create a custom values.yaml:

operator:
  replicas: 2
  image:
    repository: myregistry/rustfs-operator
    tag: v0.2.0
  resources:
    requests:
      cpu: 200m
      memory: 256Mi
    limits:
      cpu: 1000m
      memory: 1Gi
  env:
    - name: RUST_LOG
      value: debug

Install with your custom values:

helm install rustfs-operator deploy/rustfs-operator/ -f custom-values.yaml

Creating Tenant Resources

After installing the operator, you can create Tenant resources. See the project root examples/ directory for sample manifests:

kubectl apply -f examples/simple-tenant.yaml

Upgrading

To upgrade the operator:

helm upgrade rustfs-operator deploy/rustfs-operator/

Console UI (Frontend + Backend in K8s)

The console has a backend (Rust API, /api/v1/*) and an optional frontend (static web app, console-web). To have the browser reach the API correctly when both run in Kubernetes:

Same-origin deployment (recommended)

Serve the frontend and the API under one host so the browser sends requests to the same origin (no CORS, cookies work):

1. Enable the frontend and Ingress in values.yaml:

   console:
     enabled: true
     frontend:
       enabled: true
       image:
         repository: your-registry/console-web
         tag: latest
     ingress:
       enabled: true
       className: nginx
       hosts:
         - host: console.example.com
           paths: []   # ignored when frontend.enabled; / and /api are used

2. Build and push the frontend image from the repo root:

   docker build -t your-registry/console-web:latest console-web/
   docker push your-registry/console-web:latest

3. Install/upgrade the chart. The Ingress will route /api to the console backend and / to the frontend. The frontend is built with NEXT_PUBLIC_API_BASE_URL=/api/v1 (default), so all API calls are same-origin.

No CORS configuration is needed on the backend for this setup.

Backend CORS (when frontend is on a different host)

If the frontend is served from another host (e.g. https://ui.example.com) and the API at https://api.example.com, set allowed origins on the console backend:

console:
  env:
    - name: CORS_ALLOWED_ORIGINS
      value: "https://ui.example.com"

Multiple origins (e.g. dev + prod): comma-separated, e.g. "https://ui.example.com,http://localhost:3000".

Verifying the Installation

Check that the operator is running:

kubectl get pods -n rustfs-system -l app.kubernetes.io/name=rustfs-operator

View operator logs:

kubectl logs -n rustfs-system -l app.kubernetes.io/name=rustfs-operator -f