Merge pull request #21 from Sh4d1/update_doc

doc: docuement release branches and tags management

Author: Sh4d1

README.md

@@ -24,9 +24,23 @@ Currently `scaleway-cloud-controller-manager` currently implements:
 
 ## Compatibility matrix
 
-|         | K8S 1.14 | K8S 1.15 | K8S 1.16 | K8S 1.17 |
+|         | K8S 1.15 | K8S 1.16 | K8S 1.17 | K8S 1.18 |
 |---------|----------|----------|----------|----------|
-|  v0.1.x | ✓        | ✓        | ✓        | ✓        |
+|  v0.1.x | ~        | ~        | ✓        | ~        |
+| v0.18.x | ~        | ~        | ~        | ✓        |
+
+- `✓` fully supported
+- `~` some features may not be supported (usually a Kubernetes version mismatch)
+
+### Branches and releases
+
+There is two types of branches:
+- `matser` which is the main branch
+- `release-x.y` which are the release branches. Each branch is built againt Kubernetes 1.y
+
+Most of the PRs on `master` will be backported to the supported `release-x.y` branches.
+
+Each release will be cut from the `release-x.y` branch, and will be in the form of `x.y.z` where `z` will be the Scaleway Cloud Controller patch version.
 
 ## Getting Started
 

docs/tags.md

@@ -0,0 +1,23 @@
+# Tag management
+
+The Scaleway CCM will also sync the tags of the Scaleway Instance to Kubernetes Labels on the nodes.
+
+**When using Scaleway's managed Kubernetes, Kapsule, the tags on the pool will be transformed into tags on the pool's instances, so applying to all Kubernetes nodes of the pool.**
+
+## Labels
+
+In order for a tag to be synced to a label, it needs to be of the form `foo=bar`.
+In this case, the Kuebrnetes nodes will have the label `k8s.scaleway.com/foo=bar`.
+
+Once the tag is removed from the instance, it will also be removed as a label on the node.
+
+## Taints
+
+In order for a tag to be synced to a taint, it needs to be of the form `taint=foo:bar:Effect`, where `Effect` is one of `NoExecute`, `NoSchedule` or `PreferNoSchedule`.
+In this case, the Kubernetes nodes will have the tain `k8s.scaleway.com/foo=bar` with the effect `Effect`.
+
+Once the tag is removed from the instance, it will also be removed as a taint on the node.
+
+## Special Kubernetes Labels
+
+- `node.kubernetes.io/exclude-from-external-load-balancers` can be set on the Kubernetes nodes if this same value is set as a tag on the instance. It will have the value `managed-by-scaleway-ccm` and will be deleted if deleted from the tags.