README
¶
openCenter CLI
openCenter CLI manages declarative Kubernetes cluster configurations and generates GitOps assets for provider-specific cluster workflows. The built-in provider paths are OpenStack, VMware, Baremetal, Kind, and Magnum; AWS, GCP, and Azure are rejected as unavailable providers.
What it does
- Creates and validates schema 2.0 cluster configuration.
- Generates infrastructure, Flux, and application-overlay assets.
- Runs cluster lifecycle, service, worker-pool, backup, drift, and import operations.
- Provides SOPS/Age secret and key-management commands.
Build and try it
This repository builds the CLI from source with mise:
mise install
mise run build
./bin/opencenter cluster init my-cluster --org my-org --type kind
# Edit the generated configuration, then:
./bin/opencenter cluster validate my-cluster
./bin/opencenter cluster generate my-cluster
./bin/opencenter cluster deploy my-cluster
Provider prerequisites and configuration details vary. Start with the documentation index, especially Getting Started and the provider reference.
Documentation
- Documentation index — reader-facing source index.
- CLI command reference — command groups, flags, and generated per-command references.
- Configuration schema — fields and validation surface.
- Provider reference — provider boundaries.
- Documentation maintenance guide — contributor workflow.
- Glossary — repository terminology.
Code-oriented navigation is available in llms.txt. It complements the documentation index and is not a replacement for command reference pages.
Development
See Development Environment Setup, Testing Guide, and Contributing.
Support and security
License
Licensed under the Apache License 2.0.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
opencenter-local
command
|
|
|
internal
|
|
|
cloud
Package cloud provides cloud provider abstractions for infrastructure drift detection.
|
Package cloud provides cloud provider abstractions for infrastructure drift detection. |
|
cloud/magnum
Package magnum provides a small, standalone client for Magnum cluster lifecycle operations.
|
Package magnum provides a small, standalone client for Magnum cluster lifecycle operations. |
|
cloud/openstack
Package openstack provides OpenStack-specific functionality.
|
Package openstack provides OpenStack-specific functionality. |
|
cloud/vmware
Package vmware provides VMware vSphere-specific infrastructure drift detection.
|
Package vmware provides VMware vSphere-specific infrastructure drift detection. |
|
cluster
Package cluster provides domain services for cluster lifecycle management.
|
Package cluster provides domain services for cluster lifecycle management. |
|
config
Package config provides functionality for managing cluster configurations.
|
Package config provides functionality for managing cluster configurations. |
|
config/v2
Package v2 owns the authoritative typed cluster configuration schema and its load, normalization, reference resolution, defaulting, validation, and save behavior.
|
Package v2 owns the authoritative typed cluster configuration schema and its load, normalization, reference resolution, defaulting, validation, and save behavior. |
|
core/paths
Package paths provides centralized path resolution for opencenter-cli clusters.
|
Package paths provides centralized path resolution for opencenter-cli clusters. |
|
core/validation
Package validation provides a unified validation engine for all validation operations.
|
Package validation provides a unified validation engine for all validation operations. |
|
core/validation/validators
Package validators provides built-in validators for common validation tasks.
|
Package validators provides built-in validators for common validation tasks. |
|
di
Package di constructs the application's runtime dependency graph.
|
Package di constructs the application's runtime dependency graph. |
|
gitops
Package gitops provides functionality for managing GitOps templates.
|
Package gitops provides functionality for managing GitOps templates. |
|
localdev/rustfs
Package rustfs manages the disposable RustFS instance used by local Kind development.
|
Package rustfs manages the disposable RustFS instance used by local Kind development. |
|
logging
Package logging provides the global logging system for opencenter-cli.
|
Package logging provides the global logging system for opencenter-cli. |
|
operations
Package operations provides operational components for cluster management, including drift detection, backup management, and disaster recovery.
|
Package operations provides operational components for cluster management, including drift detection, backup management, and disaster recovery. |
|
provision
Package provision provides functionality for managing provisioning templates.
|
Package provision provides functionality for managing provisioning templates. |
|
secretartifacts
Package secretartifacts plans secret manifests without depending on a secret backend or a GitOps renderer.
|
Package secretartifacts plans secret manifests without depending on a secret backend or a GitOps renderer. |
|
secrets
Package secrets provides multi-cluster secrets management for openCenter-cli.
|
Package secrets provides multi-cluster secrets management for openCenter-cli. |
|
sops
Package sops integrates opencenter with SOPS and age for repository secret encryption, decryption, key management, configuration generation, and Git hooks.
|
Package sops integrates opencenter with SOPS and age for repository secret encryption, decryption, key management, configuration generation, and Git hooks. |
|
template
Package template provides a clean, extensible template engine abstraction for rendering Go templates with caching, validation, and error reporting.
|
Package template provides a clean, extensible template engine abstraction for rendering Go templates with caching, validation, and error reporting. |
|
testing
Package testing provides unified test helper utilities for opencenter-cli.
|
Package testing provides unified test helper utilities for opencenter-cli. |
|
ui
Package ui provides user interface utilities for the opencenter CLI.
|
Package ui provides user interface utilities for the opencenter CLI. |
|
util
Package util provides utility functions for opencenter.
|
Package util provides utility functions for opencenter. |
|
util/crypto
Package crypto provides cryptographic utilities for key generation, validation, and management.
|
Package crypto provides cryptographic utilities for key generation, validation, and management. |
|
util/errors
Package errors provides structured error handling utilities with actionable suggestions.
|
Package errors provides structured error handling utilities with actionable suggestions. |
|
util/files
Package files contains the legacy atomic write helper still used by key management code.
|
Package files contains the legacy atomic write helper still used by key management code. |
|
util/fs
Package fs provides safe file system operations with consistent error handling.
|
Package fs provides safe file system operations with consistent error handling. |
|
util/metrics
Package metrics provides performance tracking and metrics collection for opencenter operations.
|
Package metrics provides performance tracking and metrics collection for opencenter operations. |
|
util/security
Package security provides security utilities for handling sensitive data, credential masking, secure temporary file operations, and audit logging.
|
Package security provides security utilities for handling sensitive data, credential masking, secure temporary file operations, and audit logging. |
|
tests
|
|
Click to show internal directories.
Click to hide internal directories.