Skip to content

Commit 7f5fab4

Browse files
btungutbtungut
committed
docs: Update README with release notes for version 2.3.0 and add git-lfs support
1 parent ed2ff14 commit 7f5fab4

File tree

2 files changed

+105
-39
lines changed

2 files changed

+105
-39
lines changed

‎README.md‎

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ You can watch the tutorial video below to learn how to deploy Azure DevOps agent
1414
1515
[![Azure DevOps Agent on Kubernetes - How to deploy build agents on Kubernetes - Tutorial](https://img.youtube.com/vi/qep2l1oxknk/0.jpg)](https://www.youtube.com/watch?v=qep2l1oxknk)
1616

17-
1817
## Compatibility Matrix
1918

2019
The table presented below outlines the correspondence between Helm chart versions, Docker tags, and the Azure DevOps agent versions included within those Docker images.
2120

2221
| Helm Version | Docker Tag | Agent Version |
2322
| ------------ | --------------------- | ------------- |
23+
| 2.3.0 | v2.3.0-vsts-v2.255.0 | 4.255.0 |
2424
| 2.2.0 | 4.251.0-stable-v2.2.0 | 4.251.0 |
2525
| 2.1.1 | 3.248.0-stable-v2.1.0 | 3.248.0 |
2626
| 2.1.0 | 3.248.0-stable-v2.1.0 | 3.248.0 |
@@ -30,6 +30,13 @@ The table presented below outlines the correspondence between Helm chart version
3030

3131
## Important Release Notes
3232

33+
### 2.3.0
34+
35+
With the **2.3.0 release**, the helm chart has been updated to use the latest Azure DevOps agent version **4.255.0** and `git-lfs` support has been added.
36+
37+
- :white_check_mark: [Upgrade VSTS agent to 4.255.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/38)
38+
- :white_check_mark: [Add git-lfs support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/37)
39+
3340
### 2.2.0
3441

3542
This helm release uses the latest stable Azure Devops Agent version which is **4.251.0**.
@@ -44,13 +51,11 @@ This helm release deploys the same agent version but contains `sideContainers` s
4451
- :white_check_mark: [Feature add sideContainers support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/33)
4552
- :white_check_mark: [Add sidecar containers](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/31)
4653

47-
4854
### 2.1.0
4955

5056
This release includes the same agent version but different Docker image tag and **different bash invocations**!
51-
- :white_check_mark: [Add sudo and docker support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/27)
52-
5357

58+
- :white_check_mark: [Add sudo and docker support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/27)
5459

5560
### 2.0.1
5661

@@ -59,16 +64,13 @@ This release includes the same agent version but different Docker image tag and
5964
- :white_check_mark: [Upgrade VSTS agent to 3.248.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/23)
6065
- :white_check_mark: Optimize the Dockerfile steps and add comment lines.
6166

62-
63-
6467
### 2.0.0
6568

6669
- :white_check_mark: [ubuntu 20.04 based image](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/13)
6770
- :white_check_mark: [yq upgrade to 4.40.7](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/12)
6871
- :white_check_mark: [docker command could be executed without sudo](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/11)
6972
- :white_check_mark: [Support for VSTS agent 3.232.3](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/10)
7073

71-
7274
### 1.0.9
7375

7476
- Pod Annotations have been implemented
@@ -78,19 +80,19 @@ This release includes the same agent version but different Docker image tag and
7880

7981
:white_check_mark: PR: https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/8
8082

81-
8283
### 1.0.8
83-
Since the **1.0.8 release** , the Dockerfile and Helm chart have been configured to utilize a non-root user.
84+
85+
Since the **1.0.8 release** , the Dockerfile and Helm chart have been configured to utilize a non-root user.
8486

8587
:white_check_mark: [Issue : Non-root user should be implemented](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/3)
8688

8789
:white_check_mark: [Issue : docker could be called without sudo](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/5)
8890

8991
## Prerequisites
92+
9093
- Helm
9194
- Personal Access Token (**PAT**) with `Agent Pool manage` scope
9295

93-
9496
You don't need to follow any more instructions beyond the **standard self-hosted agent installation** in order to utilize this helm chart.
9597

9698
## Generate PAT on Azure DevOps
@@ -104,8 +106,8 @@ It is pretty straight-forward process with sufficient scope. Please choose **one
104106

105107
## Installing the Chart
106108

107-
108109
1. First you need to add repository _(if you haven't done yet before)_
110+
109111
```bash
110112
helm repo add btungut https://btungut.github.io
111113
```
@@ -120,7 +122,7 @@ helm install {RELEASE-NAME} btungut/azure-devops-agent \
120122
--namespace {YOUR-NS}
121123
```
122124

123-
2. Install the helm chart with existing secret that stores PAT
125+
1. Install the helm chart with existing secret that stores PAT
124126

125127
```bash
126128
helm install {RELEASE-NAME} btungut/azure-devops-agent \
@@ -153,7 +155,6 @@ volumeMounts: []
153155
mountPath: "/var/run/docker.sock"
154156
```
155157
156-
157158
## Example overriden values.yaml for running instance
158159
159160
This the example values.yaml that you can use to run an instance with provided PAT secret and Docker CLI support.
@@ -206,7 +207,6 @@ volumeMounts:
206207
mountPath: "/var/run/docker.sock"
207208
```
208209

209-
210210
## Parameters
211211

212212
### Agent authentication parameters
@@ -219,15 +219,14 @@ volumeMounts:
219219
| `agent.patSecret` | (2nd Option) Already existing secret name that stores PAT | `""` |
220220
| `agent.patSecretKey` | (2nd Option) Key (field) name of the PAT that is stored in secret | `"pat"` |
221221

222-
223222
### Agent configuration parameters
224223

225-
| Name | Description | Value |
226-
| ------------------------ | ----------------------------------------------------------------------------- | ----------- |
227-
| `agent.organizationUrl` | Server / organization url, e.g.: https://dev.azure.com/your-organization-name | `""` |
228-
| `agent.pool` | Agent pool name which the build agent is placed into | `"Default"` |
229-
| `agent.workingDirectory` | Working directory of the agent | `"_work"` |
230-
| `agent.extraEnv` | Additional environment variables as dictionary | `{}` |
224+
| Name | Description | Value |
225+
| ------------------------ | ------------------------------------------------------------------------------- | ----------- |
226+
| `agent.organizationUrl` | Server / organization url, e.g.: `https://dev.azure.com/your-organization-name` | `""` |
227+
| `agent.pool` | Agent pool name which the build agent is placed into | `"Default"` |
228+
| `agent.workingDirectory` | Working directory of the agent | `"_work"` |
229+
| `agent.extraEnv` | Additional environment variables as dictionary | `{}` |
231230

232231
### Other parameters
233232

@@ -248,19 +247,19 @@ volumeMounts:
248247

249248
Please refer the values.yaml for other parameters.
250249

251-
252-
253250
## Built-in binaries & packages
251+
254252
The binaries and packages listed below are included in the docker image used by the helm chart:
253+
255254
- Ubuntu 20.04
256255
- unzip
257256
- jq
258257
- yq
259258
- git
259+
- git-lfs
260260
- helm
261261
- kubectl
262262
- Powershell Core
263263
- Docker CLI
264264
- Azure CLI
265265
- with Azure DevOps extension
266-

‎chart/README.md‎

Lines changed: 82 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,93 @@
22

33
The easiest and most effective method for creating and managing Azure DevOps agents on Kubernetes, without the need to spend time and effort wrestling with settings! Scale-out as much as is necessary and demolish them gracefully.
44

5+
## YouTube Tutorial Video
6+
7+
You can watch the tutorial video below to learn how to deploy Azure DevOps agents on Kubernetes.
8+
9+
> LET'S CLICK ON THE IMAGE BELOW TO WATCH THE TUTORIAL VIDEO!
10+
11+
[![Azure DevOps Agent on Kubernetes - How to deploy build agents on Kubernetes - Tutorial](https://img.youtube.com/vi/qep2l1oxknk/0.jpg)](https://www.youtube.com/watch?v=qep2l1oxknk)
12+
513
## Compatibility Matrix
614

715
The table presented below outlines the correspondence between Helm chart versions, Docker tags, and the Azure DevOps agent versions included within those Docker images.
816

917
| Helm Version | Docker Tag | Agent Version |
1018
| ------------ | --------------------- | ------------- |
19+
| 2.3.0 | v2.3.0-vsts-v2.255.0 | 4.255.0 |
1120
| 2.2.0 | 4.251.0-stable-v2.2.0 | 4.251.0 |
1221
| 2.1.1 | 3.248.0-stable-v2.1.0 | 3.248.0 |
1322
| 2.1.0 | 3.248.0-stable-v2.1.0 | 3.248.0 |
1423
| 2.0.1 | 3.248.0 | 3.248.0 |
1524
| 2.0.0 | 3.232.3 | 3.232.3 |
1625
| 1.0.7 | 2.214.1 | 2.214.1 |
1726

27+
## Important Release Notes
28+
29+
### 2.3.0
30+
31+
With the **2.3.0 release**, the helm chart has been updated to use the latest Azure DevOps agent version **4.255.0** and `git-lfs` support has been added.
32+
33+
- :white_check_mark: [Upgrade VSTS agent to 4.255.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/38)
34+
- :white_check_mark: [Add git-lfs support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/37)
35+
36+
### 2.2.0
37+
38+
This helm release uses the latest stable Azure Devops Agent version which is **4.251.0**.
39+
40+
- :white_check_mark: [Upgrade VSTS agent to 4.251.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/35)
41+
- :white_check_mark: [Issue: Upgrade VSTS agent to 4.251.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/34)
42+
43+
### 2.1.1
44+
45+
This helm release deploys the same agent version but contains `sideContainers` support for helm chart.
46+
47+
- :white_check_mark: [Feature add sideContainers support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/33)
48+
- :white_check_mark: [Add sidecar containers](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/31)
49+
50+
### 2.1.0
51+
52+
This release includes the same agent version but different Docker image tag and **different bash invocations**!
53+
54+
- :white_check_mark: [Add sudo and docker support](https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/27)
55+
56+
### 2.0.1
57+
58+
- :white_check_mark: [duplicate apt install command](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/16)
59+
- :white_check_mark: [yq download the latest version](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/22)
60+
- :white_check_mark: [Upgrade VSTS agent to 3.248.0](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/23)
61+
- :white_check_mark: Optimize the Dockerfile steps and add comment lines.
62+
63+
### 2.0.0
64+
65+
- :white_check_mark: [ubuntu 20.04 based image](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/13)
66+
- :white_check_mark: [yq upgrade to 4.40.7](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/12)
67+
- :white_check_mark: [docker command could be executed without sudo](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/11)
68+
- :white_check_mark: [Support for VSTS agent 3.232.3](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/10)
69+
70+
### 1.0.9
71+
72+
- Pod Annotations have been implemented
73+
- Service Account support has been implemented
74+
75+
:white_check_mark: Thanks for contribitions to [Alexandre Saison](https://github.com/saisona)
76+
77+
:white_check_mark: PR: https://github.com/btungut/azure-devops-agent-on-kubernetes/pull/8
78+
79+
### 1.0.8
80+
81+
Since the **1.0.8 release** , the Dockerfile and Helm chart have been configured to utilize a non-root user.
82+
83+
:white_check_mark: [Issue : Non-root user should be implemented](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/3)
84+
85+
:white_check_mark: [Issue : docker could be called without sudo](https://github.com/btungut/azure-devops-agent-on-kubernetes/issues/5)
86+
1887
## Prerequisites
88+
1989
- Helm
2090
- Personal Access Token (**PAT**) with `Agent Pool manage` scope
2191

22-
2392
You don't need to follow any more instructions beyond the **standard self-hosted agent installation** in order to utilize this helm chart.
2493

2594
## Generate PAT on Azure DevOps
@@ -33,8 +102,8 @@ It is pretty straight-forward process with sufficient scope. Please choose **one
33102

34103
## Installing the Chart
35104

36-
37105
1. First you need to add repository _(if you haven't done yet before)_
106+
38107
```bash
39108
helm repo add btungut https://btungut.github.io
40109
```
@@ -49,7 +118,7 @@ helm install {RELEASE-NAME} btungut/azure-devops-agent \
49118
--namespace {YOUR-NS}
50119
```
51120

52-
2. Install the helm chart with existing secret that stores PAT
121+
1. Install the helm chart with existing secret that stores PAT
53122

54123
```bash
55124
helm install {RELEASE-NAME} btungut/azure-devops-agent \
@@ -82,7 +151,6 @@ volumeMounts: []
82151
mountPath: "/var/run/docker.sock"
83152
```
84153
85-
86154
## Example overriden values.yaml for running instance
87155
88156
This the example values.yaml that you can use to run an instance with provided PAT secret and Docker CLI support.
@@ -135,7 +203,6 @@ volumeMounts:
135203
mountPath: "/var/run/docker.sock"
136204
```
137205

138-
139206
## Parameters
140207

141208
### Agent authentication parameters
@@ -148,15 +215,14 @@ volumeMounts:
148215
| `agent.patSecret` | (2nd Option) Already existing secret name that stores PAT | `""` |
149216
| `agent.patSecretKey` | (2nd Option) Key (field) name of the PAT that is stored in secret | `"pat"` |
150217

151-
152218
### Agent configuration parameters
153219

154-
| Name | Description | Value |
155-
| ------------------------ | ----------------------------------------------------------------------------- | ----------- |
156-
| `agent.organizationUrl` | Server / organization url, e.g.: https://dev.azure.com/your-organization-name | `""` |
157-
| `agent.pool` | Agent pool name which the build agent is placed into | `"Default"` |
158-
| `agent.workingDirectory` | Working directory of the agent | `"_work"` |
159-
| `agent.extraEnv` | Additional environment variables as dictionary | `{}` |
220+
| Name | Description | Value |
221+
| ------------------------ | ------------------------------------------------------------------------------- | ----------- |
222+
| `agent.organizationUrl` | Server / organization url, e.g.: `https://dev.azure.com/your-organization-name` | `""` |
223+
| `agent.pool` | Agent pool name which the build agent is placed into | `"Default"` |
224+
| `agent.workingDirectory` | Working directory of the agent | `"_work"` |
225+
| `agent.extraEnv` | Additional environment variables as dictionary | `{}` |
160226

161227
### Other parameters
162228

@@ -177,18 +243,19 @@ volumeMounts:
177243

178244
Please refer the values.yaml for other parameters.
179245

180-
181-
182246
## Built-in binaries & packages
247+
183248
The binaries and packages listed below are included in the docker image used by the helm chart:
249+
184250
- Ubuntu 20.04
185251
- unzip
186252
- jq
187253
- yq
188254
- git
255+
- git-lfs
189256
- helm
190257
- kubectl
191258
- Powershell Core
192259
- Docker CLI
193260
- Azure CLI
194-
- with Azure DevOps extension
261+
- with Azure DevOps extension

0 commit comments

Comments
 (0)