-
Notifications
You must be signed in to change notification settings - Fork 113
/
helm_release.go
1724 lines (1512 loc) · 54.4 KB
/
helm_release.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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2016-2022, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package provider
import (
"context"
"encoding/json"
"errors"
"fmt"
"io/fs"
"net/url"
"os"
"path/filepath"
"reflect"
"strings"
"time"
pbempty "github.com/golang/protobuf/ptypes/empty"
"github.com/imdario/mergo"
"github.com/mitchellh/mapstructure"
"github.com/pulumi/pulumi-kubernetes/provider/v4/pkg/clients"
"github.com/pulumi/pulumi-kubernetes/provider/v4/pkg/helm"
"github.com/pulumi/pulumi-kubernetes/provider/v4/pkg/host"
"github.com/pulumi/pulumi/sdk/v3/go/common/diag"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
"github.com/pulumi/pulumi/sdk/v3/go/common/resource/plugin"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
logger "github.com/pulumi/pulumi/sdk/v3/go/common/util/logging"
pulumirpc "github.com/pulumi/pulumi/sdk/v3/proto/go"
"helm.sh/helm/v3/pkg/action"
helmchart "helm.sh/helm/v3/pkg/chart"
"helm.sh/helm/v3/pkg/chart/loader"
"helm.sh/helm/v3/pkg/cli"
"helm.sh/helm/v3/pkg/downloader"
"helm.sh/helm/v3/pkg/getter"
"helm.sh/helm/v3/pkg/helmpath"
"helm.sh/helm/v3/pkg/postrender"
"helm.sh/helm/v3/pkg/registry"
"helm.sh/helm/v3/pkg/release"
"helm.sh/helm/v3/pkg/repo"
"helm.sh/helm/v3/pkg/storage/driver"
"k8s.io/apimachinery/pkg/util/strategicpatch"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/clientcmd"
"k8s.io/client-go/tools/clientcmd/api"
"sigs.k8s.io/yaml"
)
// Default timeout for awaited install and uninstall operations
const defaultTimeoutSeconds = 300
// errReleaseNotFound is the error when a Helm release is not found
var errReleaseNotFound = errors.New("release not found")
// Release should explicitly track the shape of helm.sh/v3:Release resource
type Release struct {
// When combinging Values with mergeMaps, allow Nulls
AllowNullValues bool `json:"allowNullValues,omitempty"`
// If set, installation process purges chart on fail. The wait flag will be set automatically if atomic is used
Atomic bool `json:"atomic,omitempty"`
// Chart name to be installed. A path may be used.
Chart string `json:"chart,omitempty"`
// Allow deletion of new resources created in this upgrade when upgrade fails
CleanupOnFail bool `json:"cleanupOnFail,omitempty"`
// Create the namespace if it does not exist
CreateNamespace bool `json:"createNamespace,omitempty"`
// Run helm dependency update before installing the chart
DependencyUpdate bool `json:"dependencyUpdate,omitempty"`
// Add a custom description
Description string `json:"description,omitempty"`
// Use chart development versions, too. Equivalent to version '>0.0.0-0'. If `version` is set, this is ignored
Devel bool `json:"devel,omitempty"`
// Prevent CRD hooks from running, but run other hooks. See helm install --no-crd-hook
DisableCRDHooks bool `json:"disableCRDHooks,omitempty"`
// If set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema
DisableOpenapiValidation bool `json:"disableOpenapiValidation,omitempty"`
// Prevent hooks from running.
DisableWebhooks bool `json:"disableWebhooks,omitempty"`
// Force resource update through delete/recreate if needed.
ForceUpdate bool `json:"forceUpdate,omitempty"`
// Location of public keys used for verification. Used only if `verify` is true
Keyring string `json:"keyring,omitempty"`
// Run helm lint when planning
Lint bool `json:"lint,omitempty"`
// Limit the maximum number of revisions saved per release. Use 0 for no limit
MaxHistory *int `json:"maxHistory,omitempty"`
// Release name.
Name string `json:"name,omitempty"`
// Namespace to install the release into.
Namespace string `json:"namespace,omitempty"`
// Postrender command to run.
Postrender string `json:"postrender,omitempty"`
// Perform pods restart during upgrade/rollback
RecreatePods bool `json:"recreatePods,omitempty"`
// If set, render subchart notes along with the parent
RenderSubchartNotes bool `json:"renderSubchartNotes,omitempty"`
// Re-use the given name, even if that name is already used. This is unsafe in production
Replace bool `json:"replace,omitempty"`
// Specification defining the Helm chart repository to use.
RepositoryOpts *RepositoryOpts `json:"repositoryOpts,omitempty"`
// When upgrading, reset the values to the ones built into the chart
ResetValues bool `json:"resetValues,omitempty"`
// When upgrading, reuse the last release's values and merge in any overrides. If 'reset_values' is specified, this is ignored
ReuseValues bool `json:"reuseValues,omitempty"`
// Custom values to be merged with items loaded from values.
Values map[string]any `json:"values,omitempty"`
// If set, no CRDs will be installed. By default, CRDs are installed if not already present
SkipCrds bool `json:"skipCrds,omitempty"`
// Time in seconds to wait for any individual kubernetes operation.
Timeout int `json:"timeout,omitempty"`
// Verify the package before installing it.
Verify bool `json:"verify,omitempty"`
// Specify the exact chart version to install. If this is not specified, the latest version is installed.
Version string `json:"version,omitempty"`
// By default, the provider waits until all resources are in a ready state before marking the release as successful. Setting this to true will skip such await logic.
SkipAwait bool `json:"skipAwait,omitempty"`
// Will wait until all Jobs have been completed before marking the release as successful. This is ignored if `skipAwait` is enabled.
WaitForJobs bool `json:"waitForJobs,omitempty"`
// The rendered manifests.
// Manifest map[string]interface{} `json:"manifest,omitempty"`
// Names of resources created by the release grouped by "kind/version".
ResourceNames map[string][]string `json:"resourceNames,omitempty"`
// Status of the deployed release.
Status *ReleaseStatus `json:"status,omitempty"`
}
type ReleaseSpec struct {
}
// Specification defining the Helm chart repository to use.
type RepositoryOpts struct {
// Repository where to locate the requested chart. If is a URL the chart is installed without installing the repository.
Repo string `json:"repo,omitempty"`
// The Repositories CA File
CAFile string `json:"caFile,omitempty"`
// The repositories cert file
CertFile string `json:"certFile,omitempty"`
// The repositories cert key file
KeyFile string `json:"keyFile,omitempty"`
// Password for HTTP basic authentication
Password string `json:"password,omitempty"`
// Username for HTTP basic authentication
Username string `json:"username,omitempty"`
}
type ReleaseStatus struct {
// The version number of the application being deployed.
AppVersion string `json:"appVersion,omitempty"`
// The name of the chart.
Chart string `json:"chart,omitempty"`
// Name is the name of the release.
Name string `json:"name,omitempty"`
// Namespace is the kubernetes namespace of the release.
Namespace string `json:"namespace,omitempty"`
// Version is an int32 which represents the version of the release.
Revision *int `json:"revision,omitempty"`
// Status of the release.
Status string `json:"status,omitempty"`
// A SemVer 2 conformant version string of the chart.
Version string `json:"version,omitempty"`
}
type helmReleaseProvider struct {
host host.HostClient
canceler *cancellationContext
helmDriver string
apiConfig *api.Config
defaultOverrides *clientcmd.ConfigOverrides
restConfig *rest.Config
clientSet *clients.DynamicClientSet
defaultNamespace string
enableSecrets bool
clusterUnreachable bool
clusterUnreachableReason string
name string
settings *cli.EnvSettings
}
func newHelmReleaseProvider(
host host.HostClient,
canceler *cancellationContext,
apiConfig *api.Config,
defaultOverrides *clientcmd.ConfigOverrides,
restConfig *rest.Config,
clientSet *clients.DynamicClientSet,
helmDriver,
namespace string,
enableSecrets bool,
pluginsDirectory,
registryConfigPath,
repositoryConfigPath,
repositoryCache string,
clusterUnreachable bool,
clusterUnreachableReason string,
) (customResourceProvider, error) {
settings := cli.New()
settings.PluginsDirectory = pluginsDirectory
settings.RegistryConfig = registryConfigPath
settings.RepositoryConfig = repositoryConfigPath
settings.RepositoryCache = repositoryCache
settings.Debug = true
return &helmReleaseProvider{
host: host,
canceler: canceler,
apiConfig: apiConfig,
defaultOverrides: defaultOverrides,
restConfig: restConfig,
clientSet: clientSet,
helmDriver: helmDriver,
defaultNamespace: namespace,
enableSecrets: enableSecrets,
clusterUnreachable: clusterUnreachable,
clusterUnreachableReason: clusterUnreachableReason,
name: "kubernetes:helmrelease",
settings: settings,
}, nil
}
func debug(format string, a ...any) {
logger.V(6).Infof("[DEBUG] %s", fmt.Sprintf(format, a...))
}
func (r *helmReleaseProvider) getActionConfig(namespace string) (*action.Configuration, error) {
conf := new(action.Configuration)
var overrides clientcmd.ConfigOverrides
if r.defaultOverrides != nil {
overrides = *r.defaultOverrides
}
// This essentially points the client to use the specified namespace when a namespaced
// object doesn't have the namespace specified. This allows us to interpolate the
// release's namespace as the default namespace on charts with templates that don't
// explicitly set the namespace (e.g. through namespace: {{ .Release.Namespace }}).
overrides.Context.Namespace = namespace
var clientConfig clientcmd.ClientConfig
if r.apiConfig != nil {
clientConfig = clientcmd.NewDefaultClientConfig(*r.apiConfig, &overrides)
} else {
// Use client-go to resolve the final configuration values for the client. Typically these
// values would reside in the $KUBECONFIG file, but can also be altered in several
// places, including in env variables, client-go default values, and (if we allowed it) CLI
// flags.
loadingRules := clientcmd.NewDefaultClientConfigLoadingRules()
loadingRules.DefaultClientConfig = &clientcmd.DefaultClientConfig
clientConfig = clientcmd.NewNonInteractiveDeferredLoadingClientConfig(loadingRules, &overrides)
}
kc := NewKubeConfig(r.restConfig, clientConfig)
if err := conf.Init(kc, namespace, r.helmDriver, debug); err != nil {
return nil, err
}
logger.V(9).Infof("Setting registry client with config file: %q and debug: %v", r.settings.RegistryConfig,
r.settings.Debug)
registryClient, err := registry.NewClient(
registry.ClientOptDebug(r.settings.Debug),
registry.ClientOptCredentialsFile(r.settings.RegistryConfig),
)
if err != nil {
return nil, err
}
conf.RegistryClient = registryClient
return conf, nil
}
var (
// mapReplExtractValues extracts pure values from the property map.
mapReplExtractValues = combineMapReplv(mapReplStripSecrets, mapReplStripComputed)
)
func decodeRelease(pm resource.PropertyMap, label string) (*Release, error) {
var release Release
values := map[string]any{}
stripped := pm.MapRepl(nil, mapReplExtractValues)
logger.V(9).Infof("[%s] Decoding release: %#v", label, stripped)
if v, ok := stripped["valueYamlFiles"]; ok {
switch reflect.TypeOf(v).Kind() {
case reflect.Slice, reflect.Array:
s := reflect.ValueOf(v)
for i := 0; i < s.Len(); i++ {
val := s.Index(i).Interface()
switch t := val.(type) {
case *resource.Asset:
b, err := t.Bytes()
if err != nil {
return nil, err
}
valuesMap := map[string]any{}
if err = yaml.Unmarshal(b, &valuesMap); err != nil {
return nil, err
}
values = helm.MergeMaps(values, valuesMap)
default:
return nil, fmt.Errorf("unsupported type for 'valueYamlFiles' arg: %T", v)
}
}
}
}
var err error
if err = mapstructure.Decode(stripped, &release); err != nil {
return nil, fmt.Errorf("decoding failure: %w", err)
}
release.Values, err = mergeMaps(values, release.Values, release.AllowNullValues)
if err != nil {
return nil, err
}
return &release, nil
}
func (r *helmReleaseProvider) Check(ctx context.Context, req *pulumirpc.CheckRequest) (*pulumirpc.CheckResponse, error) {
urn := resource.URN(req.GetUrn())
label := fmt.Sprintf("Provider[%s].Check(%s)", r.name, urn)
var failures []*pulumirpc.CheckFailure
// Obtain old resource inputs. This is the old version of the resource(s) supplied by the user as
// an update.
oldResInputs := req.GetOlds()
olds, err := plugin.UnmarshalProperties(oldResInputs, plugin.MarshalOptions{
Label: fmt.Sprintf("%s.olds", label), KeepUnknowns: true, SkipNulls: true, KeepSecrets: true,
})
if err != nil {
return nil, err
}
// Obtain new resource inputs. This is the new version of the resource(s) supplied by the user as
// an update.
newResInputs := req.GetNews()
news, err := plugin.UnmarshalProperties(newResInputs, plugin.MarshalOptions{
Label: fmt.Sprintf("%s.news", label),
KeepUnknowns: true,
SkipNulls: true,
KeepSecrets: true,
})
if err != nil {
return nil, fmt.Errorf("check failed because malformed resource inputs: %w", err)
}
if len(olds) > 0 {
adoptOldNameIfUnnamed(news, olds)
}
assignNameIfAutonameable(news, urn)
r.setDefaults(news)
logger.V(9).Infof("Decoding new release.")
new, err := decodeRelease(news, fmt.Sprintf("%s.news", label))
if err != nil {
return nil, err
}
if !news.ContainsUnknowns() {
logger.V(9).Infof("Loading Helm chart.")
chart, err := r.helmLoad(ctx, urn, new)
if err != nil {
failures = append(failures, &pulumirpc.CheckFailure{
Property: "chart",
Reason: fmt.Sprintf("%v; check the chart name and repository configuration.", err),
})
} else {
// determine the desired state of the resource, i.e the specific chart version
// as opposed to the program input (which is a constraint such as ">= 1.2.3").
// with this we may determine whether the Helm release needs to be upgraded.
new.Version = chart.Metadata.Version
}
}
logger.V(9).Infof("New: %+v", new)
news = resource.NewPropertyMap(new)
// remove deprecated inputs
delete(news, "resourceNames")
newInputs, err := plugin.UnmarshalProperties(newResInputs, plugin.MarshalOptions{
Label: fmt.Sprintf("%s.newInputs", label),
KeepUnknowns: true,
SkipNulls: true,
KeepSecrets: true,
})
if err != nil {
return nil, fmt.Errorf("check failed because malformed resource inputs: %w", err)
}
// ensure we don't leak secrets into state, and preserve the computedness of inputs.
annotateComputed(news, newInputs)
annotateSecrets(news, newInputs)
autonamedInputs, err := plugin.MarshalProperties(news, plugin.MarshalOptions{
Label: fmt.Sprintf("%s.autonamedInputs", label),
KeepUnknowns: true,
SkipNulls: true,
KeepSecrets: r.enableSecrets,
})
if err != nil {
return nil, err
}
// Return new, possibly-autonamed inputs.
return &pulumirpc.CheckResponse{Inputs: autonamedInputs, Failures: failures}, nil
}
func (r *helmReleaseProvider) setDefaults(target resource.PropertyMap) {
namespace, ok := target["namespace"]
if !ok || (namespace.IsString() && namespace.StringValue() == "") {
target["namespace"] = resource.NewStringProperty(r.defaultNamespace)
}
skipAwaitVal, ok := target["skipAwait"]
if !ok || (skipAwaitVal.IsBool() && !skipAwaitVal.BoolValue()) {
// If timeout is specified (even if zero value), use that. Otherwise use default.
_, has := target["timeout"]
if !has {
target["timeout"] = resource.NewNumberProperty(defaultTimeoutSeconds)
}
}
// Discover the keyring if chart verification is requested, and a keyring is not explicitly specified.
verify, ok := target["verify"]
if ok && verify.IsBool() && verify.BoolValue() {
keyringVal, ok := target["keyring"]
if !ok || (keyringVal.IsString() && keyringVal.StringValue() == "") {
target["keyring"] = resource.NewStringProperty(os.ExpandEnv("$HOME/.gnupg/pubring.gpg"))
}
}
}
func (r *helmReleaseProvider) helmLoad(ctx context.Context, urn resource.URN, newRelease *Release) (*helmchart.Chart, error) {
conf, err := r.getActionConfig(newRelease.Namespace)
if err != nil {
return nil, err
}
client := action.NewInstall(conf)
c, path, err := getChart(&client.ChartPathOptions, conf.RegistryClient, r.settings, newRelease)
if err != nil {
logger.V(9).Infof("getChart failed: %v", err)
logger.V(9).Infof("Settings: %#v", r.settings)
return nil, err
}
logger.V(9).Infof("Checking chart dependencies for chart: %q with path: %q", newRelease.Chart, path)
// check and update the chart's dependencies if needed
updated, err := checkChartDependencies(
c,
path,
newRelease.Keyring,
r.settings,
conf.RegistryClient,
newRelease.DependencyUpdate)
if err != nil {
return nil, err
} else if updated {
// load the chart again if its dependencies have been updated
c, err = loader.Load(path)
if err != nil {
return nil, err
}
}
return c, nil
}
func (r *helmReleaseProvider) helmCreate(ctx context.Context, urn resource.URN, newRelease *Release) error {
conf, err := r.getActionConfig(newRelease.Namespace)
if err != nil {
return err
}
client := action.NewInstall(conf)
c, path, err := getChart(&client.ChartPathOptions, conf.RegistryClient, r.settings, newRelease)
if err != nil {
logger.V(9).Infof("getChart failed: %+v", err)
logger.V(9).Infof("Settings: %#v", r.settings)
return err
}
logger.V(9).Infof("Checking chart dependencies for chart: %q with path: %q", newRelease.Chart, path)
// check and update the chart's dependencies if needed
updated, err := checkChartDependencies(
c,
path,
newRelease.Keyring,
r.settings,
conf.RegistryClient,
newRelease.DependencyUpdate)
if err != nil {
return err
} else if updated {
// load the chart again if its dependencies have been updated
c, err = loader.Load(path)
if err != nil {
return err
}
}
logger.V(9).Infof("Fetching values for release: %q", newRelease.Name)
values, err := getValues(newRelease)
if err != nil {
return err
}
logger.V(9).Infof("Values: %+v", values)
err = isChartInstallable(c)
if err != nil {
return err
}
client.ClientOnly = false
client.DisableHooks = newRelease.DisableWebhooks
client.Wait = !newRelease.SkipAwait
client.WaitForJobs = !newRelease.SkipAwait && newRelease.WaitForJobs
client.Devel = newRelease.Devel
client.DependencyUpdate = newRelease.DependencyUpdate
client.Timeout = getTimeoutOrDefault(newRelease.Timeout)
client.Namespace = newRelease.Namespace
client.ReleaseName = newRelease.Name
client.GenerateName = false
client.NameTemplate = ""
client.OutputDir = ""
client.Atomic = newRelease.Atomic
client.SkipCRDs = newRelease.SkipCrds
client.SubNotes = newRelease.RenderSubchartNotes
client.DisableOpenAPIValidation = newRelease.DisableOpenapiValidation
client.Replace = newRelease.Replace
client.Description = newRelease.Description
client.CreateNamespace = newRelease.CreateNamespace
if cmd := newRelease.Postrender; cmd != "" {
pr, err := postrender.NewExec(cmd)
if err != nil {
return err
}
client.PostRenderer = pr
}
logger.V(9).Infof("install helm chart")
rel, err := client.RunWithContext(r.canceler.context, c, values)
if err != nil && rel == nil {
return err
}
if err != nil && rel != nil {
_, exists, existsErr := resourceReleaseLookup(newRelease.Name, conf)
if existsErr != nil {
return err
}
if !exists {
return err
}
// Don't expect this to fail
if err := setReleaseAttributes(newRelease, rel, false); err != nil {
return err
}
_ = r.host.Log(ctx, diag.Warning, urn, fmt.Sprintf("Helm release %q was created but has a failed status. Use the `helm` command to investigate the error, correct it, then retry. Reason: %v", client.ReleaseName, err))
return &releaseFailedError{release: newRelease, err: err}
}
err = setReleaseAttributes(newRelease, rel, false)
return err
}
type releaseFailedError struct {
release *Release
err error
}
func (e *releaseFailedError) Error() string {
var s strings.Builder
s.WriteString("Helm Release ")
if e.release != nil {
s.WriteString(fmt.Sprintf("%s/%s: ", e.release.Namespace, e.release.Name))
}
s.WriteString(e.err.Error())
return "failed to become available within allocated timeout. Error: " + s.String()
}
func (r *helmReleaseProvider) helmUpdate(newRelease, oldRelease *Release) error {
logger.V(9).Infof("getChart: %q settings: %#v", newRelease.Chart, r.settings)
actionConfig, err := r.getActionConfig(oldRelease.Namespace)
if err != nil {
return err
}
client := action.NewUpgrade(actionConfig)
cpo := &client.ChartPathOptions
// Get Chart metadata, if we fail - we're done
chart, path, err := getChart(cpo, actionConfig.RegistryClient, r.settings, newRelease)
if err != nil {
return err
}
// check and update the chart's dependencies if needed
updated, err := checkChartDependencies(
chart,
path,
newRelease.Keyring,
r.settings,
actionConfig.RegistryClient,
newRelease.DependencyUpdate)
if err != nil {
return err
} else if updated {
// load the chart again if its dependencies have been updated
chart, err = loader.Load(path)
if err != nil {
return err
}
}
values, err := getValues(newRelease)
if err != nil {
return fmt.Errorf("error getting values for a diff: %w", err)
}
if newRelease.Lint {
if err := lintChart(path, values); err != nil {
return err
}
}
client.Devel = newRelease.Devel
client.Namespace = newRelease.Namespace
client.Timeout = getTimeoutOrDefault(newRelease.Timeout)
client.Wait = !newRelease.SkipAwait
client.DisableHooks = newRelease.DisableCRDHooks
client.Atomic = newRelease.Atomic
client.SubNotes = newRelease.RenderSubchartNotes
client.WaitForJobs = !newRelease.SkipAwait && newRelease.WaitForJobs
client.Force = newRelease.ForceUpdate
client.ResetValues = newRelease.ResetValues
client.ReuseValues = newRelease.ReuseValues
client.Recreate = newRelease.RecreatePods
client.MaxHistory = 0
if newRelease.MaxHistory != nil {
client.MaxHistory = *newRelease.MaxHistory
}
client.CleanupOnFail = newRelease.CleanupOnFail
client.Description = newRelease.Description
if cmd := newRelease.Postrender; cmd != "" {
pr, err := postrender.NewExec(cmd)
if err != nil {
return err
}
client.PostRenderer = pr
}
rel, err := client.RunWithContext(r.canceler.context, newRelease.Name, chart, values)
if err != nil && rel == nil {
return err
}
if err != nil && errors.Is(err, driver.ErrNoDeployedReleases) {
logger.V(9).Infof("No existing release found.")
return err
}
if err != nil {
if err := setReleaseAttributes(newRelease, rel, false); err != nil {
return err
}
return fmt.Errorf("error running update: %w", &releaseFailedError{release: newRelease, err: err})
}
err = setReleaseAttributes(newRelease, rel, false)
return err
}
func adoptOldNameIfUnnamed(new, old resource.PropertyMap) {
if _, ok := new["name"]; ok {
return
}
contract.Assertf(old["name"].StringValue() != "", "expected 'name' value to be nonempty: %v", old)
new["name"] = old["name"]
}
func assignNameIfAutonameable(pm resource.PropertyMap, urn resource.URN) {
name, ok := pm["name"]
if !ok || (name.IsString() && name.StringValue() == "") {
prefix := urn.Name() + "-"
autoname, err := resource.NewUniqueHex(prefix, 0, 0)
contract.AssertNoErrorf(err, "unexpected error while executing NewUniqueHex")
pm["name"] = resource.NewStringProperty(autoname)
}
}
func (r *helmReleaseProvider) Diff(ctx context.Context, req *pulumirpc.DiffRequest) (*pulumirpc.DiffResponse, error) {
urn := resource.URN(req.GetUrn())
label := fmt.Sprintf("Provider[%s].Diff(%s)", r.name, urn)
// Get old state. This is an object of the form {inputs: {...}, live: {...}} where `inputs` is the
// previous resource inputs supplied by the user, and `live` is the computed state of that inputs
// we received back from the API server.
olds, err := plugin.UnmarshalProperties(req.GetOlds(), plugin.MarshalOptions{
Label: fmt.Sprintf("%s.olds", label), KeepUnknowns: true, SkipNulls: true, KeepSecrets: true,
})
if err != nil {
return nil, err
}
// Get new resource inputs. The user is submitting these as an update.
news, err := plugin.UnmarshalProperties(req.GetNews(), plugin.MarshalOptions{
Label: fmt.Sprintf("%s.news", label),
KeepUnknowns: true,
SkipNulls: true,
KeepSecrets: true,
})
if err != nil {
return nil, fmt.Errorf("diff failed because malformed resource inputs: %w", err)
}
// Extract old inputs from the `__inputs` field of the old state.
oldInputs, _ := parseCheckpointRelease(olds)
// apply ignoreChanges
for _, ignore := range req.GetIgnoreChanges() {
if ignore == "version" {
news["version"] = olds["version"]
}
}
// remove deprecated inputs from old inputs, to avoid producing a delete op w.r.t. the new state.
delete(oldInputs, "checksum")
delete(oldInputs, "resourceNames")
oldRelease, err := decodeRelease(olds, fmt.Sprintf("%s.olds", label))
if err != nil {
return nil, err
}
newRelease, err := decodeRelease(news, fmt.Sprintf("%s.news", label))
if err != nil {
return nil, err
}
logger.V(9).Infof("Diff: Old release: %#v", oldRelease)
logger.V(9).Infof("Diff: New release: %#v", newRelease)
// Generate a patch to apply the new inputs to the old state, including deletions.
// Computed values are mapped to null, and secrets are mapped to plain values.
// Later, we'll use this patch to generate a diff response, with special handling for the computed values.
oldInputsJSON, err := json.Marshal(oldInputs.MapRepl(nil, mapReplExtractValues))
if err != nil {
return nil, fmt.Errorf("internal error: json.Marshal(oldInputsJson): %w", err)
}
logger.V(9).Infof("oldInputsJSON: %s", string(oldInputsJSON))
newInputsJSON, err := json.Marshal(news.MapRepl(nil, mapReplExtractValues))
if err != nil {
return nil, fmt.Errorf("internal error: json.Marshal(oldInputsJson): %w", err)
}
logger.V(9).Infof("newInputsJSON: %s", string(newInputsJSON))
oldStateJSON, err := json.Marshal(olds.MapRepl(nil, mapReplExtractValues))
if err != nil {
return nil, fmt.Errorf("internal error: json.Marshal(oldStateJson): %w", err)
}
logger.V(9).Infof("oldStateJSON: %s", string(oldStateJSON))
strategicPatchJSON, err := strategicpatch.CreateThreeWayMergePatch(oldInputsJSON, newInputsJSON, oldStateJSON, &noSchema{}, true)
if err != nil {
return nil, fmt.Errorf("internal error: CreateThreeWayMergePatch: %w", err)
}
logger.V(9).Infof("strategicPatchJSON: %s", string(strategicPatchJSON))
patchObj := map[string]any{}
if err = json.Unmarshal(strategicPatchJSON, &patchObj); err != nil {
return nil, fmt.Errorf(
"Failed to check for changes in Helm release %s/%s because of an error serializing "+
"the JSON patch describing resource changes: %w",
oldRelease.Namespace, oldRelease.Name, err)
}
// Pack up PB, ship response back.
hasChanges := pulumirpc.DiffResponse_DIFF_NONE
var changes, replaces []string
var detailedDiff map[string]*pulumirpc.PropertyDiff
if len(patchObj) != 0 {
hasChanges = pulumirpc.DiffResponse_DIFF_SOME
for k := range patchObj {
changes = append(changes, k)
}
logger.V(9).Infof("patchObj: %+v", patchObj)
logger.V(9).Infof("oldLiveState: %+v", olds.Mappable())
logger.V(9).Infof("news: %+v", news.Mappable())
logger.V(9).Infof("oldInputs: %+v", oldInputs.Mappable())
strip := func(pm resource.PropertyMap) map[string]interface{} {
// strip the secretness but retain computedness (as is understood by convertPatchToDiff)
return pm.MapRepl(nil, mapReplStripSecrets)
}
forceNewFields := []string{".name", ".namespace"}
if detailedDiff, err = convertPatchToDiff(patchObj, strip(olds), strip(news), strip(oldInputs), forceNewFields...); err != nil {
return nil, fmt.Errorf(
"Failed to check for changes in helm release %s/%s because of an error "+
"converting JSON patch describing resource changes to a diff: %w",
oldRelease.Namespace, oldRelease.Name, err)
}
for k, v := range detailedDiff {
switch v.Kind {
case pulumirpc.PropertyDiff_ADD_REPLACE, pulumirpc.PropertyDiff_DELETE_REPLACE, pulumirpc.PropertyDiff_UPDATE_REPLACE:
replaces = append(replaces, k)
}
}
}
return &pulumirpc.DiffResponse{
Changes: hasChanges,
Replaces: replaces,
Stables: []string{},
DeleteBeforeReplace: false, // TODO: revisit this.
Diffs: changes,
DetailedDiff: detailedDiff,
HasDetailedDiff: len(detailedDiff) > 0,
}, nil
}
func lintChart(path string, values map[string]any) (err error) {
l := action.NewLint()
result := l.Run([]string{path}, values)
return resultToError(result)
}
func resultToError(r *action.LintResult) error {
if len(r.Errors) == 0 {
return nil
}
messages := []string{}
for _, msg := range r.Messages {
for _, err := range r.Errors {
if err == msg.Err {
messages = append(messages, fmt.Sprintf("%s: %s", msg.Path, msg.Err))
break
}
}
}
return fmt.Errorf("malformed chart or values: \n\t%s", strings.Join(messages, "\n\t"))
}
func (r *helmReleaseProvider) Create(ctx context.Context, req *pulumirpc.CreateRequest) (*pulumirpc.CreateResponse, error) {
urn := resource.URN(req.GetUrn())
label := fmt.Sprintf("Provider[%s].Create(%s)", r.name, urn)
news, err := plugin.UnmarshalProperties(req.GetProperties(), plugin.MarshalOptions{
Label: fmt.Sprintf("%s.properties", label),
KeepUnknowns: true,
SkipNulls: true,
KeepSecrets: true,
})
if err != nil {
return nil, fmt.Errorf("create failed because malformed resource inputs: %w", err)
}
newRelease, err := decodeRelease(news, fmt.Sprintf("%s.news", label))
if err != nil {
return nil, err
}
id := ""
var creationError error
if !req.GetPreview() {
if r.clusterUnreachable {
return nil, fmt.Errorf("can't create Helm Release with unreachable cluster: %s", r.clusterUnreachableReason)
}
id = fqName(newRelease.Namespace, newRelease.Name)
if err := r.helmCreate(ctx, urn, newRelease); err != nil {
var failedErr *releaseFailedError
if errors.As(err, &failedErr) {
creationError = failedErr
} else {
return nil, err
}
}
}
obj := checkpointRelease(news, newRelease, fmt.Sprintf("%s.news", label), req.GetPreview())
inputsAndComputed, err := plugin.MarshalProperties(
obj, plugin.MarshalOptions{
Label: fmt.Sprintf("%s.inputsAndComputed", label),
KeepUnknowns: true,
SkipNulls: true,
KeepSecrets: r.enableSecrets,
})
if err != nil {
return nil, err
}
if creationError != nil {
return nil, partialError(
id,
fmt.Errorf(
"Helm release %q was created, but failed to initialize completely. "+
"Use Helm CLI to investigate: %w", id, creationError),
inputsAndComputed,
nil)
}
logger.V(9).Infof("Create: [id: %q] properties: %+v", id, inputsAndComputed)
return &pulumirpc.CreateResponse{Id: id, Properties: inputsAndComputed}, nil
}
func (r *helmReleaseProvider) Read(ctx context.Context, req *pulumirpc.ReadRequest) (*pulumirpc.ReadResponse, error) {
urn := resource.URN(req.GetUrn())
label := fmt.Sprintf("Provider[%s].Read(%s)", r.name, urn)
logger.V(9).Infof("%s Starting", label)
oldState, err := plugin.UnmarshalProperties(req.GetProperties(), plugin.MarshalOptions{
Label: fmt.Sprintf("%s.olds", label), KeepUnknowns: true, SkipNulls: true, KeepSecrets: true,
})
if err != nil {
return nil, err
}
if err != nil {
return nil, err
}
existingRelease, err := decodeRelease(oldState, fmt.Sprintf("%s.olds", label))
if err != nil {
return nil, err
}
logger.V(9).Infof("%s decoded release: %#v", label, existingRelease)
var namespace, name string
if len(oldState) == 0 {
namespace, name = parseFqName(req.GetId())
logger.V(9).Infof("%s Starting import for %s/%s", label, namespace, name)
} else {
name = existingRelease.Name
namespace = existingRelease.Namespace
}
actionConfig, err := r.getActionConfig(namespace)
if err != nil {
return nil, err
}
liveObj, exists, err := resourceReleaseLookup(name, actionConfig)
if !exists && err == nil {
// If not found, this resource was probably deleted.
return deleteResponse, nil
}
if err != nil {
return nil, err
}
err = setReleaseAttributes(existingRelease, liveObj, false)
if err != nil {
return nil, err
}
logger.V(9).Infof("%s Found release %s/%s", label, namespace, name)
oldInputs, _ := parseCheckpointRelease(oldState)
if oldInputs == nil {
// No old inputs suggests this is an import. Hydrate the state from the current live object.
// A subsequent Check operation will apply the computed inputs.
err = r.importRelease(ctx, urn, existingRelease, liveObj)
if err != nil {
return nil, err
}
logger.V(9).Infof("%s Imported release: %#v", label, existingRelease)
oldInputs = r.serializeImportInputs(existingRelease)
r.setDefaults(oldInputs)
}
// Return a new "checkpoint object".
state, err := plugin.MarshalProperties(
checkpointRelease(oldInputs, existingRelease, fmt.Sprintf("%s.olds", label), false), plugin.MarshalOptions{
Label: fmt.Sprintf("%s.state", label),
KeepUnknowns: true,
SkipNulls: true,
KeepSecrets: r.enableSecrets,
})
if err != nil {
return nil, err
}
inputs, err := plugin.MarshalProperties(oldInputs, plugin.MarshalOptions{
Label: label + ".inputs", KeepUnknowns: true, SkipNulls: true, KeepSecrets: r.enableSecrets, //nolint:goconst