chore: update documentation

Author: nox-404

README.md

@@ -9,19 +9,25 @@ cloud-provider specific control loops required for Kubernetes to function.
 Read more about kubernetes cloud controller managers in the
 [kubernetes documentation](https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/).
 
-**WARNING**: this project is under active development and should be considered alpha.
+This is the cloud controller manager that is deployed by default on
+[Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule) (Scaleway Managed Kubernetes)
+clusters, but it can also be deployed on self-managed Kubernetes clusters running on Scaleway
+Instances or Elastic Metal servers.
 
 ## Features
 
-Currently `scaleway-cloud-controller-manager` currently implements:
+`scaleway-cloud-controller-manager` implements:
 
- - Instances interface - updates nodes with cloud provider specific labels and
+ - Instances/InstancesV2 interface - updates nodes with cloud provider specific labels and
    addresses, also deletes kubernetes nodes when deleted from the
-   cloud-provider.
+   cloud-provider. Supports both Scaleway Instances and Elastic Metal (baremetal) servers.
  - LoadBalancer interface - responsible for creating load balancers when a service
-   of `type: LoadBalancer` is created in Kubernetes.
+   of `type: LoadBalancer` is created in Kubernetes. See the available
+   [annotations](docs/loadbalancer-annotations.md) and [examples](docs/loadbalancer-examples.md).
  - Zone interface - makes Kubernetes aware of the failure domain of each node.
 
+It also synchronizes [Scaleway tags to Kubernetes labels and taints](docs/tags.md) on nodes.
+
 ## Branches and releases
 
 There are two types of branches:
@@ -38,28 +44,38 @@ Learn more about running `scaleway-cloud-controller-manager` [here](docs/getting
 
 **WARNING**: This cloud controller manager is installed by default on [Scaleway Kapsule](https://www.scaleway.com/en/kubernetes-kapsule) (Scaleway Managed Kubernetes), you don't have to do it yourself or it might cause conflicts.
 
-### Quick start
+### Configuration
+
+The CCM is configured entirely through environment variables (Scaleway credentials, region/zone,
+and behavior tuning). See the [configuration reference](docs/configuration.md) for the full list.
+
+### Documentation
+
+- [Getting started](docs/getting-started.md)
+- [Configuration (environment variables)](docs/configuration.md)
+- [LoadBalancer annotations](docs/loadbalancer-annotations.md)
+- [LoadBalancer examples](docs/loadbalancer-examples.md)
+- [Tag, label and taint synchronization](docs/tags.md)
+- [Development setup](docs/development-setup.md)
 
 ## Build
 
 You can build the CCM executable using the following commands:
 
 ```bash
-make build
+make compile
 ```
 
-You can build a local docker image named scaleway-cloud-controller for your current architecture using the following command:
+You can build a local docker image for your current architecture using the following command.
+Set `REGISTRY` to your own registry/namespace to avoid building into the `scaleway` namespace:
 
 ```bash
-make docker-build
+REGISTRY=[registry] make docker-build
 ```
 
 ## Test
 
-You need to have a kubernetes cluster that is NOT a Kapsule cluster to launch the tests.
-If you want to follow a tutorial about bootstrapping your own Kubernetes cluster on Scaleway follow the getting starting documentation [here](docs/getting-started.md)
-
-Once this is done, run the tests using
+The unit tests do not require a Kubernetes cluster or Scaleway credentials:
 
 ```bash
 make test

docs/configuration.md

@@ -0,0 +1,70 @@
+# Configuration
+
+`scaleway-cloud-controller-manager` is configured entirely through environment variables.
+The example [Secret manifest](../examples/k8s-scaleway-secret.yml) shows how to provide these
+values when running on Kubernetes.
+
+## Scaleway credentials and location
+
+These are the standard Scaleway SDK environment variables, used to authenticate and to determine
+where resources (load balancers, etc.) are managed.
+
+### `SCW_ACCESS_KEY`
+**Required.** The access key of the [API key](https://www.scaleway.com/en/docs/generate-an-api-token/) used by the CCM.
+
+### `SCW_SECRET_KEY`
+**Required.** The secret key of the API key used by the CCM.
+
+### `SCW_DEFAULT_REGION`
+**Required.** The default region (e.g. `fr-par`, `nl-ams`, `pl-waw`) used for regional resources
+such as load balancers. The CCM will fail to start if no region can be determined.
+
+### `SCW_DEFAULT_ZONE`
+The default zone (e.g. `fr-par-1`) used for zonal resources such as Instances and Elastic Metal
+servers. If not set, the first zone of `SCW_DEFAULT_REGION` is generally used.
+
+### `SCW_DEFAULT_PROJECT_ID`
+The default Project ID used when creating resources (e.g. load balancers, IPs).
+
+### `SCW_DEFAULT_ORGANIZATION_ID`
+The default Organization ID. Can be used instead of, or in addition to, `SCW_DEFAULT_PROJECT_ID`.
+
+## CCM behavior
+
+### `PN_ID`
+The ID of the Private Network to attach managed load balancers to, and to use for routing
+traffic to nodes. Can be overridden per-service with the
+[`service.beta.kubernetes.io/scw-loadbalancer-pn-ids`](loadbalancer-annotations.md#servicebetakubernetesioscw-loadbalancer-pn-ids)
+annotation.
+
+### `LB_DEFAULT_TYPE`
+The default load balancer commercial offer type (e.g. `LB-S`, `LB-GP-M`) used when creating new
+load balancers. Can be overridden per-service with the
+[`service.beta.kubernetes.io/scw-loadbalancer-type`](loadbalancer-annotations.md#servicebetakubernetesioscw-loadbalancer-type)
+annotation. If unset, Scaleway's default load balancer type is used.
+
+### `SCW_CCM_PREFIX`
+A prefix prepended to the name of load balancers created by the CCM. Useful to distinguish
+load balancers managed by different clusters or environments.
+
+### `SCW_CCM_TAGS`
+A list of additional tags to apply to every load balancer created by the CCM. Tags are split
+using the delimiter configured by `SCW_CCM_TAGS_DELIMITER`.
+
+### `SCW_CCM_TAGS_DELIMITER`
+The delimiter used to split `SCW_CCM_TAGS` into individual tags. Defaults to `,`.
+
+### `EXTRA_USER_AGENT`
+A string appended to the user agent sent to the Scaleway API
+(`scaleway/ccm <version> (<git-commit>) <EXTRA_USER_AGENT>`). Useful for tracking requests made
+by a specific deployment.
+
+### `DISABLE_INTERFACES`
+A comma-separated list of cloud-provider interfaces to disable. Possible values are:
+- `instances` - disables the Instances/InstancesV2 interface (node lifecycle, addresses, types).
+- `loadbalancer` - disables the LoadBalancer interface (no LB creation/management).
+- `zones` - disables the Zones interface (no failure-domain labeling).
+
+### `DISABLE_TAGS_SYNC`
+If set to any non-empty value, disables synchronization of Scaleway Instance/server tags to
+Kubernetes node labels and taints. See [tag synchronization](tags.md) for details.

docs/development-setup.md

@@ -4,14 +4,51 @@ The CCM has a simple build system based on make.
 
 ## Requirements
 
-- Go (1.23+)
+- Go (1.26+)
 - make
 - docker
 
 ## Unit testing
 
-Run the following command for run the unit tests.
+Run the following command to run the unit tests.
 
 ```
 make test
 ```
+
+## Building
+
+Build the `scaleway-cloud-controller-manager` binary:
+
+```
+make compile
+```
+
+Format the code with `gofmt`:
+
+```
+make fmt
+```
+
+Remove build artifacts:
+
+```
+make clean
+```
+
+## Docker images
+
+Build a local docker image for your current architecture. Set `REGISTRY` to your own
+registry/namespace to avoid building into the `scaleway` namespace:
+
+```
+REGISTRY=[registry] make docker-build
+```
+
+Build and push a multi-arch image (amd64 and arm64) and create the manifest:
+
+```
+REGISTRY=[registry] make docker-push-all
+```
+
+`make release` is an alias for `make docker-push-all`.