Skip to content

Commit 5ad55a9

Browse files
authored
doc : add note clarifying defaultContainerResources behavior and add reference link (#2053)
Added a note to the GoDoc for DefaultContainerResources explaining how actual resource values are calculated — as the sum of CheCluster defaults and editor overhead. Included a link to the official Che documentation for more details. Signed-off-by: Rohan Kumar <rohaan@redhat.com>
1 parent 599e27e commit 5ad55a9

9 files changed

Lines changed: 52 additions & 3 deletions

api/v2/checluster_types.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,13 @@ type CheClusterDevEnvironments struct {
127127
DefaultComponents []devfile.Component `json:"defaultComponents,omitempty"`
128128
// DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
129129
// container components that do not define limits or requests.
130+
// Note: The actual pod container resource values exactly match the sum of:
131+
// - The resource requirements configured via this field, plus
132+
// - The used Editor overhead (varies from editor to editor).
133+
//
134+
// For more details, see:
135+
// https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/
136+
//
130137
// +optional
131138
DefaultContainerResources *corev1.ResourceRequirements `json:"defaultContainerResources,omitempty"`
132139
// ContainerResourceCaps defines the maximum resource requirements enforced for workspace

bundle/next/eclipse-che/manifests/che-operator.clusterserviceversion.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ metadata:
8686
categories: Developer Tools
8787
certified: "false"
8888
containerImage: quay.io/eclipse/che-operator:next
89-
createdAt: "2026-04-15T15:08:42Z"
89+
createdAt: "2026-04-20T08:28:08Z"
9090
description: A Kube-native development solution that delivers portable and collaborative
9191
developer workspaces.
9292
features.operators.openshift.io/cnf: "false"
@@ -108,7 +108,7 @@ metadata:
108108
operatorframework.io/arch.amd64: supported
109109
operatorframework.io/arch.arm64: supported
110110
operatorframework.io/os.linux: supported
111-
name: eclipse-che.v7.117.0-973.next
111+
name: eclipse-che.v7.117.0-974.next
112112
namespace: placeholder
113113
spec:
114114
apiservicedefinitions: {}
@@ -1144,7 +1144,7 @@ spec:
11441144
name: gateway-authorization-sidecar-k8s
11451145
- image: quay.io/che-incubator/header-rewrite-proxy:latest
11461146
name: gateway-header-sidecar
1147-
version: 7.117.0-973.next
1147+
version: 7.117.0-974.next
11481148
webhookdefinitions:
11491149
- admissionReviewVersions:
11501150
- v1

bundle/next/eclipse-che/manifests/org.eclipse.che_checlusters.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16480,6 +16480,12 @@ spec:
1648016480
description: |-
1648116481
DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
1648216482
container components that do not define limits or requests.
16483+
Note: The actual pod container resource values exactly match the sum of:
16484+
- The resource requirements configured via this field, plus
16485+
- The used Editor overhead (varies from editor to editor).
16486+
16487+
For more details, see:
16488+
https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/
1648316489
properties:
1648416490
claims:
1648516491
description: |-

config/crd/bases/org.eclipse.che_checlusters.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16398,6 +16398,12 @@ spec:
1639816398
description: |-
1639916399
DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
1640016400
container components that do not define limits or requests.
16401+
Note: The actual pod container resource values exactly match the sum of:
16402+
- The resource requirements configured via this field, plus
16403+
- The used Editor overhead (varies from editor to editor).
16404+
16405+
For more details, see:
16406+
https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/
1640116407
properties:
1640216408
claims:
1640316409
description: |-

deploy/deployment/kubernetes/combined.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16419,6 +16419,12 @@ spec:
1641916419
description: |-
1642016420
DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
1642116421
container components that do not define limits or requests.
16422+
Note: The actual pod container resource values exactly match the sum of:
16423+
- The resource requirements configured via this field, plus
16424+
- The used Editor overhead (varies from editor to editor).
16425+
16426+
For more details, see:
16427+
https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/
1642216428
properties:
1642316429
claims:
1642416430
description: |-

deploy/deployment/kubernetes/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16414,6 +16414,12 @@ spec:
1641416414
description: |-
1641516415
DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
1641616416
container components that do not define limits or requests.
16417+
Note: The actual pod container resource values exactly match the sum of:
16418+
- The resource requirements configured via this field, plus
16419+
- The used Editor overhead (varies from editor to editor).
16420+
16421+
For more details, see:
16422+
https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/
1641716423
properties:
1641816424
claims:
1641916425
description: |-

deploy/deployment/openshift/combined.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16419,6 +16419,12 @@ spec:
1641916419
description: |-
1642016420
DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
1642116421
container components that do not define limits or requests.
16422+
Note: The actual pod container resource values exactly match the sum of:
16423+
- The resource requirements configured via this field, plus
16424+
- The used Editor overhead (varies from editor to editor).
16425+
16426+
For more details, see:
16427+
https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/
1642216428
properties:
1642316429
claims:
1642416430
description: |-

deploy/deployment/openshift/objects/checlusters.org.eclipse.che.CustomResourceDefinition.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16414,6 +16414,12 @@ spec:
1641416414
description: |-
1641516415
DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
1641616416
container components that do not define limits or requests.
16417+
Note: The actual pod container resource values exactly match the sum of:
16418+
- The resource requirements configured via this field, plus
16419+
- The used Editor overhead (varies from editor to editor).
16420+
16421+
For more details, see:
16422+
https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/
1641716423
properties:
1641816424
claims:
1641916425
description: |-

helmcharts/next/crds/checlusters.org.eclipse.che.CustomResourceDefinition.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16414,6 +16414,12 @@ spec:
1641416414
description: |-
1641516415
DefaultContainerResources defines the resource requirements (memory/cpu limit/request) used for
1641616416
container components that do not define limits or requests.
16417+
Note: The actual pod container resource values exactly match the sum of:
16418+
- The resource requirements configured via this field, plus
16419+
- The used Editor overhead (varies from editor to editor).
16420+
16421+
For more details, see:
16422+
https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/
1641716423
properties:
1641816424
claims:
1641916425
description: |-

0 commit comments

Comments
 (0)