Merge pull request #7 from Nordix/readme-v1a3-mael

📖 Update documentation for release v1alpha3

README.md

@@ -9,6 +9,16 @@ Kubernetes [Cluster API](https://github.com/kubernetes-sigs/cluster-api/).
 For more information about this actuator and related repositories, see
 [metal3.io](http://metal3.io/).
 
+## Compatibility with Cluster API
+
+| CAPM3 version | Cluster API version | Release |
+|---------------|---------------------|---------|
+| v1alpha2      | v1alpha2            | v0.2.X  |
+| v1alpha3      | v1alpha3            | v0.3.X  |
+
+You can find information on how to use this provider with Cluster API and
+clusterctl in the [getting-started](docs/getting-started.md).
+
 ## Development Environment
 
 * See [metal3-dev-env](https://github.com/metal3-io/metal3-dev-env) for an

docs/getting-started.md

@@ -22,7 +22,10 @@ The pre-requisite for the deployment of CAPM3 are the following:
 Please refer to
 [Clusterctl documentation](https://master.cluster-api.sigs.k8s.io/clusterctl/overview.html).
 Once the Pre-requisites are fulfilled, you can follow the normal clusterctl
-flow.
+flow for the `init`, `config`, `upgrade` and `delete` workflow. The `move`
+command is supported only if the baremetalhosts are moved independently first,
+and their status is preserved during the move. Please refer to the *Pivoting
+Ironic* section.
 
 ### Cluster templates variables
 
@@ -203,9 +206,14 @@ WORKERS_KUBEADM_EXTRA_CONFIG="
 
 ## Pivoting Ironic
 
-Before running the move command of Clusterctl. Elements such as Baremetal
+Before running the move command of Clusterctl, elements such as Baremetal
 Operator, Ironic if applicable, and the BareMetalHost CRs need to be moved to
 the target cluster. During the move, the BareMetalHost object must be annotated
 with `baremetalhost.metal3.io/paused` key. The value does not matter. The
 presence of this annotation will stop the reconciliation loop for that object.
-More information TBA.
+
+In addition, it is critical that the move of the BMHs does not lead to a lost
+status for those objects. If the status is lost, BMO will register the nodes
+as available, and introspect them again.
+
+More information TBA on move commands.