Merge pull request #416 from Qovery/fix_resource_overcommit

fix: add cross doc references for limit/request
Qovery · May 29, 2024 · d87a771 · d87a771
2 parents 0379d46 + c1f2538
commit d87a771
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/website/docs/using-qovery/configuration/advanced-settings.md b/website/docs/using-qovery/configuration/advanced-settings.md
@@ -297,6 +297,7 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 |---------|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
 | integer | Define the CPU overcommit (pod cpu limit) of the service.| A service require more CPU at startup than during the running phase. You can reduce the configured CPU for the service and just increase the resources.override.limit.cpu_in_milli to reduce the resources used by the service at runtime | `null` (i.e. request = limit) |
 
+This settings can be changed only if the advanced settings [allow_service_cpu_overcommit][docs.using-qovery.configuration.cluster-advanced-settings#service] is set to `true`.
 
 #### resources.override.limit.ram_in_mib  ![](/img/advanced_settings/application.svg) ![](/img/advanced_settings/container.svg) ![](/img/advanced_settings/cronjob.svg) ![](/img/advanced_settings/job.svg)
 
@@ -310,6 +311,8 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 |---------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
 | integer | Define the memory overcommit (pod memory limit) of the service.| A service require more memory at startup than during the running phase. You can reduce the configured memory for the service and just increase the resources.override.limit.ram_in_mib to reduce the resources used by the service at runtime | `null` (i.e. request = limit) |
 
+This settings can be changed only if the advanced settings [allow_service_ram_overcommit][docs.using-qovery.configuration.cluster-advanced-settings#service] is set to `true`.
+
 ## Security
 
 #### security.service_account_name ![](/img/advanced_settings/application.svg) ![](/img/advanced_settings/container.svg) ![](/img/advanced_settings/cronjob.svg) ![](/img/advanced_settings/job.svg)
@@ -325,4 +328,5 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 | boolean | Automount Kubernetes service account token to have access to Kubernetes API from pods | `false`       |
 
 
+[docs.using-qovery.configuration.cluster-advanced-settings#service]: /docs/using-qovery/configuration/cluster-advanced-settings/#service
 [docs.using-qovery.deployment.deployment-strategies]: /docs/using-qovery/deployment/deployment-strategies/
diff --git a/website/docs/using-qovery/configuration/advanced-settings.md.erb b/website/docs/using-qovery/configuration/advanced-settings.md.erb
@@ -285,6 +285,7 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 |---------|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
 | integer | Define the CPU overcommit (pod cpu limit) of the service.| A service require more CPU at startup than during the running phase. You can reduce the configured CPU for the service and just increase the resources.override.limit.cpu_in_milli to reduce the resources used by the service at runtime | `null` (i.e. request = limit) |
 
+This settings can be changed only if the advanced settings [allow_service_cpu_overcommit][docs.using-qovery.configuration.cluster-advanced-settings#service] is set to `true`.
 
 #### resources.override.limit.ram_in_mib  ![](/img/advanced_settings/application.svg) ![](/img/advanced_settings/container.svg) ![](/img/advanced_settings/cronjob.svg) ![](/img/advanced_settings/job.svg)
 
@@ -298,6 +299,8 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 |---------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|
 | integer | Define the memory overcommit (pod memory limit) of the service.| A service require more memory at startup than during the running phase. You can reduce the configured memory for the service and just increase the resources.override.limit.ram_in_mib to reduce the resources used by the service at runtime | `null` (i.e. request = limit) |
 
+This settings can be changed only if the advanced settings [allow_service_ram_overcommit][docs.using-qovery.configuration.cluster-advanced-settings#service] is set to `true`.
+
 ## Security
 
 #### security.service_account_name ![](/img/advanced_settings/application.svg) ![](/img/advanced_settings/container.svg) ![](/img/advanced_settings/cronjob.svg) ![](/img/advanced_settings/job.svg)

diff --git a/website/docs/using-qovery/configuration/cluster-advanced-settings.md b/website/docs/using-qovery/configuration/cluster-advanced-settings.md
@@ -216,7 +216,9 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 
 | Type    | Description                                                                                    | Default Value   |
 |---------|------------------------------------------------------------------------------------------------|-----------------|
-| boolean | Authorize CPU overcommit (limit > request) for the services deployed within this cluster       | `false`          |
+| boolean | Authorize CPU overcommit (limit > request) for the services deployed within this cluster       | `false`         |
+
+Once enabled, you can update the advanced setting [resources.override.limit.cpu_in_mib][docs.using-qovery.configuration.advanced-settings#resources] of your service.
 
 #### allow_service_ram_overcommit ![](/img/advanced_settings/aws.svg) ![](/img/advanced_settings/scaleway.svg) ![](/img/advanced_settings/gcp.svg)
 
@@ -228,7 +230,9 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 
 | Type    | Description                                                                                    | Default Value   |
 |---------|------------------------------------------------------------------------------------------------|-----------------|
-| boolean | Authorize memory overcommit (limit > request) for the services deployed within this cluster    | `false`          |
+| boolean | Authorize memory overcommit (limit > request) for the services deployed within this cluster    | `false`         |
+
+Once enabled, you can update the advanced setting [resources.override.limit.ram_in_mib][docs.using-qovery.configuration.advanced-settings#resources] of your service.
 
 ## IAM
 
@@ -277,5 +281,6 @@ It won't be possible to go back once this feature is activated.
 
 
 [docs.getting-started.install-qovery.aws.cluster-managed-by-qovery.quickstart#attach-aws-credentials]: /docs/getting-started/install-qovery/aws/cluster-managed-by-qovery/quickstart/#attach-aws-credentials
+[docs.using-qovery.configuration.advanced-settings#resources]: /docs/using-qovery/configuration/advanced-settings/#resources
 [docs.using-qovery.deployment.image-mirroring]: /docs/using-qovery/deployment/image-mirroring/
 [guides.tutorial.how-to-activate-sso-to-connect-to-your-eks-cluster]: /guides/tutorial/how-to-activate-sso-to-connect-to-your-eks-cluster/
diff --git a/website/docs/using-qovery/configuration/cluster-advanced-settings.md.erb b/website/docs/using-qovery/configuration/cluster-advanced-settings.md.erb
@@ -207,7 +207,9 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 
 | Type    | Description                                                                                    | Default Value   |
 |---------|------------------------------------------------------------------------------------------------|-----------------|
-| boolean | Authorize CPU overcommit (limit > request) for the services deployed within this cluster       | `false`          |
+| boolean | Authorize CPU overcommit (limit > request) for the services deployed within this cluster       | `false`         |
+
+Once enabled, you can update the advanced setting [resources.override.limit.cpu_in_mib][docs.using-qovery.configuration.advanced-settings#resources] of your service.
 
 #### allow_service_ram_overcommit ![](/img/advanced_settings/aws.svg) ![](/img/advanced_settings/scaleway.svg) ![](/img/advanced_settings/gcp.svg)
 
@@ -219,7 +221,9 @@ Using overcommit on pod resources can lead to instability on your cluster and we
 
 | Type    | Description                                                                                    | Default Value   |
 |---------|------------------------------------------------------------------------------------------------|-----------------|
-| boolean | Authorize memory overcommit (limit > request) for the services deployed within this cluster    | `false`          |
+| boolean | Authorize memory overcommit (limit > request) for the services deployed within this cluster    | `false`         |
+
+Once enabled, you can update the advanced setting [resources.override.limit.ram_in_mib][docs.using-qovery.configuration.advanced-settings#resources] of your service.
 
 ## IAM