README
¶
Package Operator
Package Operator is an open source operator for Kubernetes, managing packages as collections of arbitrary objects, to install and maintain applications on one or multiple clusters.
Project Status
Package Operator is used in production and the concepts proven.
The Core APIs are generally stable and breaking changes should only happen in exceptional circumstances.
Be careful to check the change notes for alpha and beta APIs.
Features
- No Surprises
- Ordered Installation and Removal
- Operating Transparency
- Extensible
- Declarative APIs
- Plug and Play
- Cheap Failures and Easy Recovery
- Rollout History
- Rollback
Documentation
Package Operator documentation is available on package-operator.run.
The source of this website is our website repository which is hosted via Netifly, Hugo and using the Doks template.
Getting in touch
Our mailing lists:
Contributing
Thank you for taking time to help to improve Package Operator!
Please see CONTRIBUTING.md for instructions on how to contribute.
License
Package Operator is Apache 2.0 licensed.
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
module
|
|
|
cmd
|
|
|
build
Main package for building PKO and its related components.
|
Main package for building PKO and its related components. |
|
integration
|
|
|
internal
|
|
|
adapters
The adapters package contains interface implementations to use Cluster- and non Cluster- prefixed APIs via the same code.
|
The adapters package contains interface implementations to use Cluster- and non Cluster- prefixed APIs via the same code. |
|
apis/manifests
+k8s:conversion-gen=package-operator.run/apis/manifests/v1alpha1
|
+k8s:conversion-gen=package-operator.run/apis/manifests/v1alpha1 |
|
constants
Package constants contains various constant string values for the project.
|
Package constants contains various constant string values for the project. |
|
controllers/hostedclusters/hypershift/v1beta1
The package v1beta1 contains some API Schema definitions for the v1beta1 version of some Hypershift API group.
|
The package v1beta1 contains some API Schema definitions for the v1beta1 version of some Hypershift API group. |
|
dynamiccache
taken from sigs.k8s.io/controller-runtime@v0.12.3/pkg/cache/internal/selector.go
|
taken from sigs.k8s.io/controller-runtime@v0.12.3/pkg/cache/internal/selector.go |
|
environment
The environment package contains probing functionality to detect information on the Kubernetes cluster environment.
|
The environment package contains probing functionality to detect information on the Kubernetes cluster environment. |
|
packages
The packages package contains a library to import, parse, validate and deploy Package Operator packages.
|
The packages package contains a library to import, parse, validate and deploy Package Operator packages. |
|
packages/internal/packagekickstart/rukpak/operator-registry
Package registry contains the manually vendored type definitions from the operator-framework/operator-registry repository.
|
Package registry contains the manually vendored type definitions from the operator-framework/operator-registry repository. |
|
preflight
package preflight implements preflight checks for PKO APIs.
|
package preflight implements preflight checks for PKO APIs. |
|
package-operator
module
|
|
|
pkg
module
|