Get started in less than 5 minInstall now
OSSEnterprise

Operator Manual

Deploy, configure, and maintain knodex in production

This manual covers production deployment, configuration, and operations for knodex.

Requirements

  • Kubernetes 1.32+
  • KRO installed (version 0.7.1)
  • Helm 4.x
  • Redis (included or external)

Installation & Configuration

GuideDescription
InstallationProduction deployment with architecture patterns, HA setup, and security hardening
ConfigurationComplete reference for server, web, Redis, and OIDC settings

Security & Access Control

GuideDescription
RBAC SetupRole-based access control with 5 built-in roles and group mapping
OIDC IntegrationSSO setup for Okta, Auth0, Azure AD, Google, and Keycloak
Kubernetes RBACServiceAccount, ClusterRole, and CRD permissions

Operations

GuideDescription
Declarative RepositoriesConfigure repository credentials via Kubernetes Secrets
ConstraintTemplate DevelopmentCreate Gatekeeper policies for knodex compliance (Enterprise)
TroubleshootingDiagnostic procedures, common issues, and monitoring

Architecture

┌─────────────┐    ┌─────────────┐    ┌─────────────┐
│   Browser   │───▶│     Web     │───▶│   Server    │
└─────────────┘    │  (React)    │    │    (Go)     │
                   └─────────────┘    └──────┬──────┘
                                             │
                   ┌─────────────────────────┼─────────────────────────┐
                   │                         │                         │
                   ▼                         ▼                         ▼
            ┌─────────────┐          ┌─────────────┐          ┌─────────────┐
            │    Redis    │          │  K8s API    │          │    OIDC     │
            │   (Cache)   │          │   (RGDs)    │          │  Provider   │
            └─────────────┘          └─────────────┘          └─────────────┘

Quick Start

# Install
helm install knodex oci://ghcr.io/knodex/charts/knodex \
  --namespace knodex \
  --create-namespace \
  --values production-values.yaml
 
# Verify
kubectl get pods -n knodex
kubectl logs -n knodex -l app=knodex-server

Support


Start with: Installation