Skip to content

Commit 1120f27

Browse files
committed
docs: Update README with breaking change regarding container resource requests and limits
1 parent 769dab5 commit 1120f27

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,16 @@ With the **2.3.0 release**, the helm chart has been updated to use the latest Az
3636

3737
- :white_check_mark: [Upgrade VSTS agent to 4.255.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/38)
3838
- :white_check_mark: [Add git-lfs support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/37)
39+
- :white_check_mark: [BREAKING CHANGE: Change container resources requests and limits to NULL / empty / `{}`](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/39)
40+
41+
42+
#### IMPORTANT & BREAKING CHANGE
43+
44+
- The values of **requests and limits for the container resources** have been changed from specific values to NULL / empty / `{}`.
45+
46+
> This means that the container will use the default values of the Kubernetes cluster for CPU and memory resources. Please make sure to adjust the values according to your needs if you want to set specific values for CPU and memory resources.
47+
48+
**To see the changes**, please visit the [values.yaml changes for PR 39](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/39/files)
3949

4050
### 2.2.0
4151

@@ -230,20 +240,17 @@ volumeMounts:
230240

231241
### Other parameters
232242

233-
| Name | Description | Value |
234-
| --------------------------- | ------------------------------------- | ---------------------------- |
235-
| `image.registry` | Azure DevOps agent image registry | `docker.io` |
236-
| `image.repository` | Azure DevOps agent image repository | `btungut/azure-devops-agent` |
237-
| `image.tag` | Azure DevOps agent image tag | refer to values.yaml |
238-
| `image.pullPolicy` | Azure DevOps agent image pull policy | `IfNotPresent` |
239-
| `image.pullSecrets` | Azure DevOps agent image pull secrets | `[]` |
240-
| `replicaCount` | Replica count for deployment | `1` |
241-
| `resources.requests.cpu` | CPU request value for scheduling | `"100m"` |
242-
| `resources.requests.memory` | Memory request value for scheduling | `"128Mi"` |
243-
| `resources.limits.cpu` | CPU limit value for scheduling | `"500m"` |
244-
| `resources.limits.memory` | Memory limit value for scheduling | `"512Mi"` |
245-
| `volumes` | Volumes for the container | `[]` |
246-
| `volumeMounts` | Volume mountings | `[]` |
243+
| Name | Description | Value |
244+
| --------------------------- | ---------------------------------------------- | ---------------------------- |
245+
| `image.registry` | Azure DevOps agent image registry | `docker.io` |
246+
| `image.repository` | Azure DevOps agent image repository | `btungut/azure-devops-agent` |
247+
| `image.tag` | Azure DevOps agent image tag | refer to values.yaml |
248+
| `image.pullPolicy` | Azure DevOps agent image pull policy | `IfNotPresent` |
249+
| `image.pullSecrets` | Azure DevOps agent image pull secrets | `[]` |
250+
| `replicaCount` | Replica count for deployment | `1` |
251+
| `resources` | Resource requests and limits for the container | `{}` |
252+
| `volumes` | Volumes for the container | `[]` |
253+
| `volumeMounts` | Volume mountings | `[]` |
247254

248255
Please refer the values.yaml for other parameters.
249256

0 commit comments

Comments
 (0)