-
Notifications
You must be signed in to change notification settings - Fork 101
/
client_test.go
346 lines (297 loc) · 8.71 KB
/
client_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
package helmclient
import (
"bytes"
"context"
"helm.sh/helm/v3/pkg/chartutil"
"helm.sh/helm/v3/pkg/action"
"helm.sh/helm/v3/pkg/repo"
"k8s.io/client-go/rest"
)
func ExampleNew() {
var outputBuffer bytes.Buffer
opt := &Options{
Namespace: "default", // Change this to the namespace you wish the client to operate in.
RepositoryCache: "/tmp/.helmcache",
RepositoryConfig: "/tmp/.helmrepo",
Debug: true,
Linting: true,
DebugLog: func(format string, v ...interface{}) {},
Output: &outputBuffer, // Not mandatory, leave open for default os.Stdout
}
helmClient, err := New(opt)
if err != nil {
panic(err)
}
_ = helmClient
}
func ExampleNewClientFromRestConf() {
opt := &RestConfClientOptions{
Options: &Options{
Namespace: "default", // Change this to the namespace you wish the client to operate in.
RepositoryCache: "/tmp/.helmcache",
RepositoryConfig: "/tmp/.helmrepo",
Debug: true,
Linting: true, // Change this to false if you don't want linting.
DebugLog: func(format string, v ...interface{}) {
// Change this to your own logger. Default is 'log.Printf(format, v...)'.
},
},
RestConfig: &rest.Config{},
}
helmClient, err := NewClientFromRestConf(opt)
if err != nil {
panic(err)
}
_ = helmClient
}
func ExampleNewClientFromKubeConf() {
opt := &KubeConfClientOptions{
Options: &Options{
Namespace: "default", // Change this to the namespace you wish to install the chart in.
RepositoryCache: "/tmp/.helmcache",
RepositoryConfig: "/tmp/.helmrepo",
Debug: true,
Linting: true, // Change this to false if you don't want linting.
DebugLog: func(format string, v ...interface{}) {
// Change this to your own logger. Default is 'log.Printf(format, v...)'.
},
},
KubeContext: "",
KubeConfig: []byte{},
}
helmClient, err := NewClientFromKubeConf(opt, Burst(100), Timeout(10e9))
if err != nil {
panic(err)
}
_ = helmClient
}
func ExampleHelmClient_AddOrUpdateChartRepo_public() {
// Define a public chart repository.
chartRepo := repo.Entry{
Name: "stable",
URL: "https://charts.helm.sh/stable",
}
// Add a chart-repository to the client.
if err := helmClient.AddOrUpdateChartRepo(chartRepo); err != nil {
panic(err)
}
}
func ExampleHelmClient_AddOrUpdateChartRepo_private() {
// Define a private chart repository
chartRepo := repo.Entry{
Name: "stable",
URL: "https://private-chartrepo.somedomain.com",
Username: "foo",
Password: "bar",
// Since helm 3.6.1 it is necessary to pass 'PassCredentialsAll = true'.
PassCredentialsAll: true,
}
// Add a chart-repository to the client.
if err := helmClient.AddOrUpdateChartRepo(chartRepo); err != nil {
panic(err)
}
}
func ExampleHelmClient_InstallOrUpgradeChart() {
// Define the chart to be installed
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "stable/etcd-operator",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
}
// Install a chart release.
// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
panic(err)
}
}
func ExampleHelmClient_InstallOrUpgradeChart_useChartDirectory() {
// Use an unpacked chart directory.
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "/path/to/stable/etcd-operator",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
}
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
panic(err)
}
}
func ExampleHelmClient_InstallOrUpgradeChart_useLocalChartArchive() {
// Use an archived chart directory.
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "/path/to/stable/etcd-operator.tar.gz",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
}
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
panic(err)
}
}
func ExampleHelmClient_InstallOrUpgradeChart_useURL() {
// Use an archived chart directory via URL.
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "http://helm.whatever.com/repo/etcd-operator.tar.gz",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
}
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, nil); err != nil {
panic(err)
}
}
func ExampleHelmClient_InstallOrUpgradeChart_useDefaultRollBackStrategy() {
// Define the chart to be installed
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "stable/etcd-operator",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
}
// Use the default rollback strategy offer by HelmClient (revert to the previous version).
opts := GenericHelmOptions{
RollBack: helmClient,
}
// Install a chart release.
// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, &opts); err != nil {
panic(err)
}
}
type customRollBack struct {
HelmClient
}
var _ RollBack = &customRollBack{}
func (c customRollBack) RollbackRelease(spec *ChartSpec) error {
client := action.NewRollback(c.ActionConfig)
client.Force = true
return client.Run(spec.ReleaseName)
}
func ExampleHelmClient_InstallOrUpgradeChart_useCustomRollBackStrategy() {
// Define the chart to be installed
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "stable/etcd-operator",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
}
// Use a custom rollback strategy (customRollBack needs to implement RollBack).
rollBacker := customRollBack{}
opts := GenericHelmOptions{
RollBack: rollBacker,
}
// Install a chart release.
// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
if _, err := helmClient.InstallOrUpgradeChart(context.Background(), &chartSpec, &opts); err != nil {
panic(err)
}
}
func ExampleHelmClient_LintChart() {
// Define a chart with custom values to be tested.
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "stable/etcd-operator",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
ValuesYaml: `deployments:
etcdOperator: true
backupOperator: false`,
}
if err := helmClient.LintChart(&chartSpec); err != nil {
panic(err)
}
}
func ExampleHelmClient_TemplateChart() {
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "stable/etcd-operator",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
ValuesYaml: `deployments:
etcdOperator: true
backupOperator: false`,
}
options := &HelmTemplateOptions{
KubeVersion: &chartutil.KubeVersion{
Version: "v1.23.10",
Major: "1",
Minor: "23",
},
APIVersions: []string{
"helm.sh/v1/Test",
},
}
_, err := helmClient.TemplateChart(&chartSpec, options)
if err != nil {
panic(err)
}
}
func ExampleHelmClient_UpdateChartRepos() {
// Update the list of chart repositories.
if err := helmClient.UpdateChartRepos(); err != nil {
panic(err)
}
}
func ExampleHelmClient_UninstallRelease() {
// Define the released chart to be installed.
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "stable/etcd-operator",
Namespace: "default",
Wait: true,
DryRun: true,
KeepHistory: true,
}
// Uninstall the chart release.
// Note that helmclient.Options.Namespace should ideally match the namespace in chartSpec.Namespace.
if err := helmClient.UninstallRelease(&chartSpec); err != nil {
panic(err)
}
}
func ExampleHelmClient_UninstallReleaseByName() {
// Uninstall a release by name.
if err := helmClient.UninstallReleaseByName("etcd-operator"); err != nil {
panic(err)
}
}
func ExampleHelmClient_ListDeployedReleases() {
// List all deployed releases.
if _, err := helmClient.ListDeployedReleases(); err != nil {
panic(err)
}
}
func ExampleHelmClient_GetReleaseValues() {
// Get the values of a deployed release.
if _, err := helmClient.GetReleaseValues("etcd-operator", true); err != nil {
panic(err)
}
}
func ExampleHelmClient_GetRelease() {
// Get specific details of a deployed release.
if _, err := helmClient.GetRelease("etcd-operator"); err != nil {
panic(err)
}
}
func ExampleHelmClient_RollbackRelease() {
// Define the released chart to be installed
chartSpec := ChartSpec{
ReleaseName: "etcd-operator",
ChartName: "stable/etcd-operator",
Namespace: "default",
UpgradeCRDs: true,
Wait: true,
}
// Rollback to the previous version of the release.
if err := helmClient.RollbackRelease(&chartSpec); err != nil {
return
}
}