Working with Draft Software Specifications

You create a draft software specification to describe the components of the desired state that you want to apply on a cluster.

The draft software specification is the working copy of the desired software state. Only one user at a time is allowed to edit a single draft for a cluster. Before saving the changes to the edited draft version, you can validate the content of the draft.

Figure 1. Drafts Workflow

A workflow diagram that visualizes the steps you need to take to apply a desired software specification to a cluster.

A typical workflow for working with draft software specifications starts with creating a draft software specification for a specific cluster. If the cluster already has a software specification defined, this action takes the latest committed draft and you can edit its contents according to your needs. If the cluster has no software specification created yet, this method creates an empty draft. The only mandatory item for a draft is a base image of a specific version.

After you complete adding components, an add-on, and a base image, you can save your changes by committing the draft. This operation results in setting the committed draft as the current desired state of the cluster. Before committing the draft software specification, you can validate the contents of the draft or check whether all hosts in the cluster are compliant with the draft.

If the commit operation is successful, the draft becomes the desired state for the cluster. You can now export the software specification and use it, for example, in a ROBO cluster scenario. You can also validate the compliance of the hosts in the cluster against the desired state and then apply the software specification, if feasible.