123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316 |
- /*
- Copyright 2018 The Kubernetes Authors.
- 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 target implements state for the set of all resources to customize.
- package target
- import (
- "bytes"
- "encoding/json"
- "fmt"
- "strings"
- "github.com/ghodss/yaml"
- "github.com/pkg/errors"
- "sigs.k8s.io/kustomize/pkg/constants"
- "sigs.k8s.io/kustomize/pkg/ifc"
- "sigs.k8s.io/kustomize/pkg/ifc/transformer"
- interror "sigs.k8s.io/kustomize/pkg/internal/error"
- patchtransformer "sigs.k8s.io/kustomize/pkg/patch/transformer"
- "sigs.k8s.io/kustomize/pkg/resmap"
- "sigs.k8s.io/kustomize/pkg/resource"
- "sigs.k8s.io/kustomize/pkg/transformers"
- "sigs.k8s.io/kustomize/pkg/transformers/config"
- "sigs.k8s.io/kustomize/pkg/types"
- )
- // KustTarget encapsulates the entirety of a kustomization build.
- type KustTarget struct {
- kustomization *types.Kustomization
- ldr ifc.Loader
- rFactory *resmap.Factory
- tFactory transformer.Factory
- }
- // NewKustTarget returns a new instance of KustTarget primed with a Loader.
- func NewKustTarget(
- ldr ifc.Loader,
- rFactory *resmap.Factory,
- tFactory transformer.Factory) (*KustTarget, error) {
- content, err := loadKustFile(ldr)
- if err != nil {
- return nil, err
- }
- content = types.DealWithDeprecatedFields(content)
- var k types.Kustomization
- err = unmarshal(content, &k)
- if err != nil {
- return nil, err
- }
- errs := k.EnforceFields()
- if len(errs) > 0 {
- return nil, fmt.Errorf("Failed to read kustomization file under %s:\n"+strings.Join(errs, "\n"), ldr.Root())
- }
- return &KustTarget{
- kustomization: &k,
- ldr: ldr,
- rFactory: rFactory,
- tFactory: tFactory,
- }, nil
- }
- func quoted(l []string) []string {
- r := make([]string, len(l))
- for i, v := range l {
- r[i] = "'" + v + "'"
- }
- return r
- }
- func commaOr(q []string) string {
- return strings.Join(q[:len(q)-1], ", ") + " or " + q[len(q)-1]
- }
- func loadKustFile(ldr ifc.Loader) ([]byte, error) {
- var content []byte
- match := 0
- for _, kf := range constants.KustomizationFileNames {
- c, err := ldr.Load(kf)
- if err == nil {
- match += 1
- content = c
- }
- }
- switch match {
- case 0:
- return nil, fmt.Errorf(
- "unable to find one of %v in directory '%s'",
- commaOr(quoted(constants.KustomizationFileNames)), ldr.Root())
- case 1:
- return content, nil
- default:
- return nil, fmt.Errorf("Found multiple kustomization files under: %s\n", ldr.Root())
- }
- }
- func unmarshal(y []byte, o interface{}) error {
- j, err := yaml.YAMLToJSON(y)
- if err != nil {
- return err
- }
- dec := json.NewDecoder(bytes.NewReader(j))
- dec.DisallowUnknownFields()
- return dec.Decode(o)
- }
- // MakeCustomizedResMap creates a ResMap per kustomization instructions.
- // The Resources in the returned ResMap are fully customized.
- func (kt *KustTarget) MakeCustomizedResMap() (resmap.ResMap, error) {
- ra, err := kt.AccumulateTarget()
- if err != nil {
- return nil, err
- }
- err = ra.Transform(kt.tFactory.MakeHashTransformer())
- if err != nil {
- return nil, err
- }
- // Given that names have changed (prefixs/suffixes added),
- // fix all the back references to those names.
- err = ra.FixBackReferences()
- if err != nil {
- return nil, err
- }
- // With all the back references fixed, it's OK to resolve Vars.
- err = ra.ResolveVars()
- return ra.ResMap(), err
- }
- func (kt *KustTarget) shouldAddHashSuffixesToGeneratedResources() bool {
- return kt.kustomization.GeneratorOptions == nil ||
- !kt.kustomization.GeneratorOptions.DisableNameSuffixHash
- }
- // AccumulateTarget returns a new ResAccumulator,
- // holding customized resources and the data/rules used
- // to do so. The name back references and vars are
- // not yet fixed.
- func (kt *KustTarget) AccumulateTarget() (
- ra *ResAccumulator, err error) {
- // TODO(monopole): Get rid of the KustomizationErrors accumulator.
- // It's not consistently used, and complicates tests.
- errs := &interror.KustomizationErrors{}
- ra, errs = kt.accumulateBases()
- resources, err := kt.rFactory.FromFiles(
- kt.ldr, kt.kustomization.Resources)
- if err != nil {
- errs.Append(errors.Wrap(err, "rawResources failed to read Resources"))
- }
- if len(errs.Get()) > 0 {
- return ra, errs
- }
- err = ra.MergeResourcesWithErrorOnIdCollision(resources)
- if err != nil {
- errs.Append(errors.Wrap(err, "MergeResourcesWithErrorOnIdCollision"))
- }
- tConfig, err := config.MakeTransformerConfig(
- kt.ldr, kt.kustomization.Configurations)
- if err != nil {
- return nil, err
- }
- err = ra.MergeConfig(tConfig)
- if err != nil {
- errs.Append(errors.Wrap(err, "MergeConfig"))
- }
- err = ra.MergeVars(kt.kustomization.Vars)
- if err != nil {
- errs.Append(errors.Wrap(err, "MergeVars"))
- }
- crdTc, err := config.LoadConfigFromCRDs(kt.ldr, kt.kustomization.Crds)
- if err != nil {
- errs.Append(errors.Wrap(err, "LoadCRDs"))
- }
- err = ra.MergeConfig(crdTc)
- if err != nil {
- errs.Append(errors.Wrap(err, "merge CRDs"))
- }
- resMap, err := kt.generateConfigMapsAndSecrets(errs)
- if err != nil {
- errs.Append(errors.Wrap(err, "generateConfigMapsAndSecrets"))
- }
- err = ra.MergeResourcesWithOverride(resMap)
- if err != nil {
- return nil, err
- }
- patches, err := kt.rFactory.RF().SliceFromPatches(
- kt.ldr, kt.kustomization.PatchesStrategicMerge)
- if err != nil {
- errs.Append(errors.Wrap(err, "SliceFromPatches"))
- }
- if len(errs.Get()) > 0 {
- return nil, errs
- }
- t, err := kt.newTransformer(patches, ra.tConfig)
- if err != nil {
- return nil, err
- }
- err = ra.Transform(t)
- if err != nil {
- return nil, err
- }
- return ra, nil
- }
- func (kt *KustTarget) generateConfigMapsAndSecrets(
- errs *interror.KustomizationErrors) (resmap.ResMap, error) {
- kt.rFactory.Set(kt.ldr)
- cms, err := kt.rFactory.NewResMapFromConfigMapArgs(
- kt.kustomization.ConfigMapGenerator, kt.kustomization.GeneratorOptions)
- if err != nil {
- errs.Append(errors.Wrap(err, "NewResMapFromConfigMapArgs"))
- }
- secrets, err := kt.rFactory.NewResMapFromSecretArgs(
- kt.kustomization.SecretGenerator, kt.kustomization.GeneratorOptions)
- if err != nil {
- errs.Append(errors.Wrap(err, "NewResMapFromSecretArgs"))
- }
- return resmap.MergeWithErrorOnIdCollision(cms, secrets)
- }
- // accumulateBases returns a new ResAccumulator
- // holding customized resources and the data/rules
- // used to customized them from only the _bases_
- // of this KustTarget.
- func (kt *KustTarget) accumulateBases() (
- ra *ResAccumulator, errs *interror.KustomizationErrors) {
- errs = &interror.KustomizationErrors{}
- ra = MakeEmptyAccumulator()
- for _, path := range kt.kustomization.Bases {
- ldr, err := kt.ldr.New(path)
- if err != nil {
- errs.Append(errors.Wrap(err, "couldn't make loader for "+path))
- continue
- }
- subKt, err := NewKustTarget(
- ldr, kt.rFactory, kt.tFactory)
- if err != nil {
- errs.Append(errors.Wrap(err, "couldn't make target for "+path))
- ldr.Cleanup()
- continue
- }
- subRa, err := subKt.AccumulateTarget()
- if err != nil {
- errs.Append(errors.Wrap(err, "AccumulateTarget"))
- ldr.Cleanup()
- continue
- }
- err = ra.MergeAccumulator(subRa)
- if err != nil {
- errs.Append(errors.Wrap(err, path))
- }
- ldr.Cleanup()
- }
- return ra, errs
- }
- // newTransformer makes a Transformer that does a collection
- // of object transformations.
- func (kt *KustTarget) newTransformer(
- patches []*resource.Resource, tConfig *config.TransformerConfig) (
- transformers.Transformer, error) {
- var r []transformers.Transformer
- t, err := kt.tFactory.MakePatchTransformer(patches, kt.rFactory.RF())
- if err != nil {
- return nil, err
- }
- r = append(r, t)
- r = append(r, transformers.NewNamespaceTransformer(
- string(kt.kustomization.Namespace), tConfig.NameSpace))
- t, err = transformers.NewNamePrefixSuffixTransformer(
- string(kt.kustomization.NamePrefix),
- string(kt.kustomization.NameSuffix),
- tConfig.NamePrefix,
- )
- if err != nil {
- return nil, err
- }
- r = append(r, t)
- t, err = transformers.NewLabelsMapTransformer(
- kt.kustomization.CommonLabels, tConfig.CommonLabels)
- if err != nil {
- return nil, err
- }
- r = append(r, t)
- t, err = transformers.NewAnnotationsMapTransformer(
- kt.kustomization.CommonAnnotations, tConfig.CommonAnnotations)
- if err != nil {
- return nil, err
- }
- r = append(r, t)
- t, err = patchtransformer.NewPatchJson6902Factory(kt.ldr).
- MakePatchJson6902Transformer(kt.kustomization.PatchesJson6902)
- if err != nil {
- return nil, err
- }
- r = append(r, t)
- t, err = transformers.NewImageTransformer(kt.kustomization.Images)
- if err != nil {
- return nil, err
- }
- r = append(r, t)
- return transformers.NewMultiTransformer(r), nil
- }
|