Package Format

Package Operator packages allow distributing all manifests that make up an application or operator deployment into a single artifact.

This artifact is just an empty container image containing a PackageManifest and the Kubernetes manifests in an optionally nested folder structure.

The Package or the ClusterPackage API is used to load these package container images into the cluster. This loading process will load the image contents into an ObjectDeployment.

Package Scopes

The two possible values for scopes are Cluster and Namespaced.

Cluster scope allows the package to deploy cluster scoped object, such as CRDs. It also allows for deploying namespaced resources in multiple namespaces.

Namespaced scope restricts the package to only installing namespaced resources, and only into the namespace that the package is in.

Just one or both scopes can be specified for a single package.

The scopes given in the Package Manifest file determine which package resource can be used to deploy the package. If only Cluster or only Namespaced is given as a scope, then the package must be deployed as a ClusterPackage or Package respectfully. If both scopes are given, then the package can be deployed as either resource.

Package Structure

FileDescription
manifest.yamlPackageManifest required
README.mdLong description or instructions for the package.
.png/.svgPackage icon referenced from manifest.yaml.

Well-Known Labels

Well-Known Labels are applied automatically to all objects within a Package and the resulting ObjectDeployment to provide additional context.

LabelDescription
package-operator.run/packagePackage object name.
package-operator.run/versionVersion as stated in the PackageManifest.
package-operator.run/providerProvider as stated in the PackageManifest.

Well-Known Annotations

Well-Known Annotations are used to control the loading behavior of an object within a package.

AnnotationDescription
package-operator.run/phaseAssigns the object to a phase when loaded.

Example

PackageManifest - manifest.yaml 

apiVersion: manifests.package-operator.run/v1alpha1
kind: PackageManifest
metadata:
  name: example
spec:
  scopes:
  - Cluster
  - Namespaced
  phases:
  - name: phase-1
  - name: phase-2
  - name: phase-3
  availabilityProbes:
  - probes:
    - condition:
        type: Available
        status: "True"
    - fieldsEqual:
        fieldA: .status.updatedReplicas
        fieldB: .status.replicas
    selector:
      kind:
        group: apps
        kind: Deployment
test: {}

Containerfile 

FROM scratch

ADD . /package

Structure 

package
│   manifest.yaml
│   README.md
│   my-icon.png
│   load-balancer.yaml
│
└───frontend
│   │   frontend-deployment.yaml
│   │   frontend-service.yaml
│   │
│   └───cache
│       │   cache-db.yaml
│       │   cache-config.yaml
│       │   ...
│
└───backend
    │   backend-deployment.yaml
    │   backend-config.yaml
    │   ...
← Revisions
Package Templates →