diff --git a/docs/MachineOSBuilderDesign.md b/docs/MachineOSBuilderDesign.md index 2ae29ef169..a9901fa243 100644 --- a/docs/MachineOSBuilderDesign.md +++ b/docs/MachineOSBuilderDesign.md @@ -22,16 +22,13 @@ flowchart TB Nodes("Nodes") MachineConfigChange--> |Cluster admin applies \n a new MachineConfig| MCC - MCC--> |Produces rendered MachineConfig and updates \n the MachineConfigPool with this new MachineConfig. \n\n -Layered MachineConfigPool will have a special\n label denoting that it serves this purpose. -| MOB--> | Creates ephemeral ConfigMaps containing Dockerfile \n and rendered MachineConfig. \n These are mounted into the image build context. \n Will be deleted upon successful completion of the build.| ImageBuilder--> |Build Success / Failure Status| MOB - MOB--> |Listens for the MachineConfigPool change to a layered pool.\n Fetches the rendered MachineConfig and translates it into a \n form the image builder can understand;\n rendering a Dockerfile and beginning the build process. -| MCD--> |MachineConfigPool is updated annotation indicating the image pull spec. \n NodeController propagates this annotation to all of the nodes \n in the pool. MCD rolls out image to all nodes. -| Nodes + MCC--> |Produces rendered MachineConfig and updates \n the MachineConfigPool with this new MachineConfig. \n\n Layered MachineConfigPool will have a special\n label denoting that it serves this purpose.| MOB + MOB--> | Creates ephemeral ConfigMaps containing Dockerfile \n and rendered MachineConfig. \n These are mounted into the image build context. \n Will be deleted upon successful completion of the build.| ImageBuilder--> |Build Success / Failure Status| MOB + MOB--> |Listens for the MachineConfigPool change to a layered pool.\n Fetches the rendered MachineConfig and translates it into a \n form the image builder can understand;\n rendering a Dockerfile and beginning the build process.| MCD + MCD--> |MachineConfigPool is updated annotation indicating the image pull spec. \n NodeController propagates this annotation to all of the nodes \n in the pool. MCD rolls out image to all nodes.| Nodes ImageBuilder--> |Image Push| ImageRegistry ImageRegistry--> |MCD tells rpm-ostree where to \n pull the OS image from| Nodes - NonMCAssets--> |Changes to non-MachineConfig assets should not \n cause a full image build / rollout cycle. Instead, the MCD will write them \n to the nodes’ disk in-situ, like it does today. -| MCD + NonMCAssets--> |Changes to non-MachineConfig assets should not \n cause a full image build / rollout cycle. Instead, the MCD will write them \n to the nodes’ disk in-situ, like it does today.| MCD ``` ## Sub-components and design diff --git a/docs/OnClusterBuildInstructions.md b/docs/OnClusterBuildInstructions.md index 8e6c90f903..60da8453b3 100644 --- a/docs/OnClusterBuildInstructions.md +++ b/docs/OnClusterBuildInstructions.md @@ -18,9 +18,9 @@ 1. _(Optional)_ Create an OpenShift ImageStream in the MCO namespace: - ```console - $ oc create imagestream os-image -n openshift-machine-config-operator - ``` + ```console + $ oc create imagestream os-image -n openshift-machine-config-operator + ``` 2. The name of a pull secret for the base OS image and the extensions container. This must be created as a Secret within