From 4861bcc2c8be98c2cb58a52b8393e15191551aba Mon Sep 17 00:00:00 2001 From: Marc Vornetran Date: Fri, 10 Oct 2025 16:08:56 +0200 Subject: [PATCH 1/2] docs: Use lowercase filename for FAQ --- README.md | 2 +- docs/{FAQ.md => faq.md} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename docs/{FAQ.md => faq.md} (99%) diff --git a/README.md b/README.md index fe5a20bd6..a5d019d4d 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ Along with the above Custom Controllers and Resources, MCM requires the `Machine To start using or developing the Machine Controller Manager, see the documentation in the `/docs` repository. ## FAQ -An FAQ is available [here](docs/FAQ.md). +An FAQ is available [here](docs/faq.md). ## cluster-api Implementation - `cluster-api` branch of machine-controller-manager implements the machine-api aspect of the [cluster-api project](https://github.com/kubernetes-sigs/cluster-api). diff --git a/docs/FAQ.md b/docs/faq.md similarity index 99% rename from docs/FAQ.md rename to docs/faq.md index d56ef882e..8909e6c7d 100644 --- a/docs/FAQ.md +++ b/docs/faq.md @@ -72,7 +72,7 @@ A machine is deleted by MCM generally for 2 reasons- - Machine is unhealthy for at least `MachineHealthTimeout` period. The default `MachineHealthTimeout` is 10 minutes. - By default, a machine is considered unhealthy if any of the following node conditions - `DiskPressure`, `KernelDeadlock`, `FileSystem`, `Readonly` is set to `true`, or `KubeletReady` is set to `false`. However, this is something that is configurable using the following [flag](../kubernetes/deployment/out-of-tree/deployment.yaml#L30). - Machine is scaled down by the `MachineDeployment` resource. - - This is very usual when an external controller cluster-autoscaler (aka CA) is used with MCM. CA deletes the under-utilized machines by scaling down the `MachineDeployment`. Read more about cluster-autoscaler's scale down behavior [here](https://github.com/gardener/autoscaler/blob/machine-controller-manager-provider/cluster-autoscaler/FAQ.md#how-does-scale-down-work). + - This is very usual when an external controller cluster-autoscaler (aka CA) is used with MCM. CA deletes the under-utilized machines by scaling down the `MachineDeployment`. Read more about cluster-autoscaler's scale down behavior [here](https://github.com/gardener/autoscaler/blob/machine-controller-manager-provider/cluster-autoscaler/faq.md#how-does-scale-down-work). ### What are the different sub-controllers in MCM? From 0e21544a267f728b7ce5a4099ec2fcbd9c04b710 Mon Sep 17 00:00:00 2001 From: Marc Vornetran Date: Wed, 22 Oct 2025 10:52:35 +0200 Subject: [PATCH 2/2] docs: Revert lowercase FAQ for reference to CA (PR review) --- docs/faq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq.md b/docs/faq.md index 8909e6c7d..d56ef882e 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -72,7 +72,7 @@ A machine is deleted by MCM generally for 2 reasons- - Machine is unhealthy for at least `MachineHealthTimeout` period. The default `MachineHealthTimeout` is 10 minutes. - By default, a machine is considered unhealthy if any of the following node conditions - `DiskPressure`, `KernelDeadlock`, `FileSystem`, `Readonly` is set to `true`, or `KubeletReady` is set to `false`. However, this is something that is configurable using the following [flag](../kubernetes/deployment/out-of-tree/deployment.yaml#L30). - Machine is scaled down by the `MachineDeployment` resource. - - This is very usual when an external controller cluster-autoscaler (aka CA) is used with MCM. CA deletes the under-utilized machines by scaling down the `MachineDeployment`. Read more about cluster-autoscaler's scale down behavior [here](https://github.com/gardener/autoscaler/blob/machine-controller-manager-provider/cluster-autoscaler/faq.md#how-does-scale-down-work). + - This is very usual when an external controller cluster-autoscaler (aka CA) is used with MCM. CA deletes the under-utilized machines by scaling down the `MachineDeployment`. Read more about cluster-autoscaler's scale down behavior [here](https://github.com/gardener/autoscaler/blob/machine-controller-manager-provider/cluster-autoscaler/FAQ.md#how-does-scale-down-work). ### What are the different sub-controllers in MCM?