Desired Manifests

The desired manifest is fully computed manifest, before it’s split into smaller ‘instance group’ manifests.

A desired manifest is a BOSH deployment manifest that has already been calculated so that it’s the actual final state that the user wishes his software to be in. All ops files have been applied, variables have been calculated and replaced. This manifest is persisted and versioned.

Ops files are applied by the operator. Variables are replaced by an QuarksJob that runs the operator’s image. The QuarksJob writes the manifest on stdout, which is persisted using a Versioned Secret.

Each manifest version that goes live is immutable. A manifest’s version is an integer that gets incremented. The current version of the manifest is the greatest version.

These manifests are kept in secrets named using the following rule:

1
<operator-namespace>/<deployment-name>.desired-manifest-v<version>
  • deployment-name: the name of deployment manifest
  • version: the version of manifest

Each secret is also annotated and labeled with information such as:

  • the deployment name
  • the secret kind
  • its version
  • a description of the “sources” used to render the manifest (e.g. the location of the CRD that generated it).
Last modified September 3, 2020: Change URL to quarks-v6 (a286c04)