Big Packages

The most straightforward way of using the Package Operator APIs ObjectDeployment and ObjectSet is to define objects inline directly when creating an instance of these APIs.

etcd - the default Kubernetes database - has an object size limit of 1 MiB (etcd <=v3.2) or 1.5 MiB (etcd >v3.2).

Building packages containing multiple large objects, like CustomResourceDefinitions, or just contain a large number of objects, might run into these limits, when defining objects inline.

Slices API

To get around this limitation, Package Operator allows offloading big objects into an auxiliary API ObjectSlice. Instead of all objects being defined inline in the parent ObjectDeployment or ObjectSet one or multiple ObjectSlices can be specified.

In contrast to ObjectDeployments, ObjectSlices are immutable.
When updating an ObjectDeployment a new ObjectSlice needs to be created, which contains the desired changes. Only when referencing this new slice instead of the current slice from the ObjectDeployment, will the change be applied.

Example 

apiVersion: package-operator.run/v1alpha1
kind: ObjectSet
metadata:
  name: example
  namespace: default
spec:
  availabilityProbes: []
  phases:
  - name: phase-1
    objects:
    - object: # inline defined object
        apiVersion: apps/v1
        kind: Deployment
        metadata:
          name: example-deployment
    slices: # objects referenced from ObjectSlice API.
    - example-slice-001
    - example-slice-002
    - example-slice-003
---
apiVersion: package-operator.run/v1alpha1
kind: ObjectSlice
metadata:
  name: example-slice-001
  namespace: default
spec:
  objects:
  - object: # defined object
      apiVersion: apps/v1
      kind: Deployment
      metadata:
        name: example-deployment-1
# ...
Multi-Component Packages →