How opensearch-project/opensearch-k8s-operator works
The OpenSearch Kubernetes Operator turns Kubernetes custom resources into managed OpenSearch clusters, Dashboards, and in-cluster configuration. Users submit resources; admission validation and controllers reconcile them into Kubernetes workloads and OpenSearch API changes. The README documents scaling, upgrades, TLS, plugins, and multi-namespace management; the tree identifies corresponding runtime modules. Source excerpts establish key controller, builder, Kubernetes-client, migration, and gateway relationships, but many feature reconcilers were not sampled, so their internal call paths are not asserted.
Main entry points: opensearchController.go Cluster Controller · os_client.go OpenSearch Client · opensearchism_types.go Config Resources · opensearch_types.go OpenSearch Resources
Components 24
Custom Resource API
- OpenSearch Resources
opensearch-operator/api/opensearch.org/v1/opensearch_types.go - Config Resources
opensearch-operator/api/opensearch.org/v1/opensearchism_types.go
Operator Control Plane
- Admission Validation
opensearch-operator/webhook/opensearch_cluster_webhook.go - Manager Runtime
opensearch-operator/main.go - Cluster Controller
opensearch-operator/controllers/opensearchController.go - API Migration
opensearch-operator/controllers/migration_controller.go - Resource Reconciler
opensearch-operator/pkg/reconciler/resource.go - Kubernetes Client
opensearch-operator/pkg/reconcilers/k8s/client.go
Cluster Lifecycle
- Cluster Builder
opensearch-operator/pkg/builders/cluster.go - Dashboards Builder
opensearch-operator/pkg/builders/dashboards.go - Scaling and Upgrades
opensearch-operator/pkg/reconcilers - Certificate Management
opensearch-operator/pkg/tls/pki.go
OpenSearch Configuration
- Security Resources
opensearch-operator/pkg/reconcilers/securityconfig.go - Template Resources
opensearch-operator/pkg/reconcilers/componenttemplate.go - ISM Policies
opensearch-operator/pkg/reconcilers/ismpolicy.go - Snapshot Policies
opensearch-operator/pkg/reconcilers/snapshotpolicy.go - Snapshot Repositories
opensearch-operator/pkg/reconcilers/snapshotrepository.go - Cluster API Services
opensearch-operator/opensearch-gateway/services/os_data_service.go - Security API Services
opensearch-operator/opensearch-gateway/services/os_security_service.go - OpenSearch Client
opensearch-operator/opensearch-gateway/services/os_client.go
Other components
- Cluster Operator
- Kubernetes API
- OpenSearch Cluster
- OpenSearch Dashboards
Connections 31
- Cluster Operator → OpenSearch Resources: submits resources
README.md - OpenSearch Resources → Admission Validation: validates
opensearch-operator/webhook/opensearch_cluster_webhook.go - Manager Runtime → Cluster Controller: registers
opensearch-operator/main.go - Manager Runtime → Admission Validation: registers
opensearch-operator/main.go - Manager Runtime → API Migration: registers
opensearch-operator/main.go - Cluster Controller → Cluster Builder: builds workloads
opensearch-operator/controllers/opensearchController.go - Cluster Controller → Kubernetes Client: reconciles resources
opensearch-operator/controllers/opensearchController.go - Cluster Controller → Scaling and Upgrades: manages lifecycle
README.md - Cluster Controller → Dashboards Builder: provisions dashboards
README.md - Cluster Controller → Certificate Management: manages certificates
README.md - Cluster Builder → OpenSearch Resources: reads specification
opensearch-operator/pkg/builders/cluster.go - Kubernetes Client → Resource Reconciler: delegates reconciliation
opensearch-operator/pkg/reconcilers/k8s/client.go - Resource Reconciler → Kubernetes API: applies workloads
- Cluster Builder → Kubernetes API: defines workloads
README.md - API Migration → OpenSearch Resources: converts API resources
opensearch-operator/controllers/migration_controller.go - Config Resources → Security Resources: configures security
- Config Resources → Template Resources: configures templates
- Config Resources → ISM Policies: configures policies
- Config Resources → Snapshot Policies: configures snapshots
- Snapshot Repositories → OpenSearch Client: creates client
opensearch-operator/pkg/reconcilers/snapshotrepository.go - Snapshot Repositories → Cluster API Services: manages repositories
opensearch-operator/pkg/reconcilers/snapshotrepository.go - Security Resources → Security API Services: manages security APIs
- Template Resources → Cluster API Services: manages templates
- ISM Policies → OpenSearch Client: uses cluster API
- Snapshot Policies → OpenSearch Client: uses cluster API
- Cluster API Services → OpenSearch Client: uses client
opensearch-operator/opensearch-gateway/services/os_data_service.go - Security API Services → OpenSearch Client: uses client
opensearch-operator/opensearch-gateway/services/os_security_service.go - OpenSearch Client → OpenSearch Cluster: sends API requests
- Dashboards Builder → OpenSearch Dashboards: deploys
README.md - Scaling and Upgrades → Kubernetes API: scales and upgrades
README.md - Certificate Management → Kubernetes API: manages certificates
README.md