mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-17 18:25:26 +00:00
412 lines
10 KiB
Go
412 lines
10 KiB
Go
// Copyright 2019 The Kubernetes Authors.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Package target implements state for the set of all
|
|
// resources to customize.
|
|
package target
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"fmt"
|
|
"log"
|
|
"strings"
|
|
|
|
"github.com/pkg/errors"
|
|
"sigs.k8s.io/kustomize/api/ifc"
|
|
"sigs.k8s.io/kustomize/api/internal/accumulator"
|
|
"sigs.k8s.io/kustomize/api/pgmconfig"
|
|
"sigs.k8s.io/kustomize/api/plugins/builtinconfig"
|
|
"sigs.k8s.io/kustomize/api/plugins/builtinhelpers"
|
|
"sigs.k8s.io/kustomize/api/plugins/builtins"
|
|
"sigs.k8s.io/kustomize/api/plugins/loader"
|
|
"sigs.k8s.io/kustomize/api/resmap"
|
|
"sigs.k8s.io/kustomize/api/transform"
|
|
"sigs.k8s.io/kustomize/api/types"
|
|
"sigs.k8s.io/yaml"
|
|
)
|
|
|
|
// KustTarget encapsulates the entirety of a kustomization build.
|
|
type KustTarget struct {
|
|
kustomization *types.Kustomization
|
|
ldr ifc.Loader
|
|
validator ifc.Validator
|
|
rFactory *resmap.Factory
|
|
tFactory resmap.PatchFactory
|
|
pLdr *loader.Loader
|
|
}
|
|
|
|
// NewKustTarget returns a new instance of KustTarget primed with a Loader.
|
|
func NewKustTarget(
|
|
ldr ifc.Loader,
|
|
validator ifc.Validator,
|
|
rFactory *resmap.Factory,
|
|
tFactory resmap.PatchFactory,
|
|
pLdr *loader.Loader) (*KustTarget, error) {
|
|
content, err := loadKustFile(ldr)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
content = types.FixKustomizationPreUnmarshalling(content)
|
|
var k types.Kustomization
|
|
err = unmarshal(content, &k)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
k.FixKustomizationPostUnmarshalling()
|
|
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,
|
|
validator: validator,
|
|
rFactory: rFactory,
|
|
tFactory: tFactory,
|
|
pLdr: pLdr,
|
|
}, 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 pgmconfig.RecognizedKustomizationFileNames() {
|
|
c, err := ldr.Load(kf)
|
|
if err == nil {
|
|
match += 1
|
|
content = c
|
|
}
|
|
}
|
|
switch match {
|
|
case 0:
|
|
return nil, NewErrMissingKustomization(ldr.Root())
|
|
case 1:
|
|
return content, nil
|
|
default:
|
|
return nil, fmt.Errorf(
|
|
"Found multiple kustomization files under: %s\n", ldr.Root())
|
|
}
|
|
}
|
|
|
|
type errMissingKustomization struct {
|
|
path string
|
|
}
|
|
|
|
func (e *errMissingKustomization) Error() string {
|
|
return fmt.Sprintf(
|
|
"unable to find one of %v in directory '%s'",
|
|
commaOr(quoted(pgmconfig.RecognizedKustomizationFileNames())),
|
|
e.path)
|
|
}
|
|
|
|
func NewErrMissingKustomization(p string) *errMissingKustomization {
|
|
return &errMissingKustomization{path: p}
|
|
}
|
|
|
|
func IsMissingKustomizationFileError(err error) bool {
|
|
_, ok := err.(*errMissingKustomization)
|
|
if ok {
|
|
return true
|
|
}
|
|
_, ok = errors.Cause(err).(*errMissingKustomization)
|
|
return ok
|
|
}
|
|
|
|
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) {
|
|
return kt.makeCustomizedResMap(types.GarbageIgnore)
|
|
}
|
|
|
|
func (kt *KustTarget) MakePruneConfigMap() (resmap.ResMap, error) {
|
|
return kt.makeCustomizedResMap(types.GarbageCollect)
|
|
}
|
|
|
|
func (kt *KustTarget) makeCustomizedResMap(
|
|
garbagePolicy types.GarbagePolicy) (resmap.ResMap, error) {
|
|
ra, err := kt.AccumulateTarget()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// The following steps must be done last, not as part of
|
|
// the recursion implicit in AccumulateTarget.
|
|
|
|
err = kt.addHashesToNames(ra)
|
|
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()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = kt.computeInventory(ra, garbagePolicy)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return ra.ResMap(), nil
|
|
}
|
|
|
|
func (kt *KustTarget) addHashesToNames(
|
|
ra *accumulator.ResAccumulator) error {
|
|
p := builtins.NewHashTransformerPlugin()
|
|
err := kt.configureBuiltinPlugin(p, nil, builtinhelpers.HashTransformer)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return ra.Transform(p)
|
|
}
|
|
|
|
func (kt *KustTarget) computeInventory(
|
|
ra *accumulator.ResAccumulator, garbagePolicy types.GarbagePolicy) error {
|
|
inv := kt.kustomization.Inventory
|
|
if inv == nil {
|
|
return nil
|
|
}
|
|
if inv.Type != "ConfigMap" {
|
|
return fmt.Errorf("don't know how to do that")
|
|
}
|
|
|
|
if inv.ConfigMap.Namespace != kt.kustomization.Namespace {
|
|
return fmt.Errorf("namespace mismatch")
|
|
}
|
|
|
|
var c struct {
|
|
Policy string
|
|
types.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"`
|
|
}
|
|
c.Name = inv.ConfigMap.Name
|
|
c.Namespace = inv.ConfigMap.Namespace
|
|
c.Policy = garbagePolicy.String()
|
|
p := builtins.NewInventoryTransformerPlugin()
|
|
err := kt.configureBuiltinPlugin(p, c, builtinhelpers.InventoryTransformer)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return ra.Transform(p)
|
|
}
|
|
|
|
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 *accumulator.ResAccumulator, err error) {
|
|
ra = accumulator.MakeEmptyAccumulator()
|
|
err = kt.accumulateResources(ra, kt.kustomization.Resources)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "accumulating resources")
|
|
}
|
|
tConfig, err := builtinconfig.MakeTransformerConfig(
|
|
kt.ldr, kt.kustomization.Configurations)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
err = ra.MergeConfig(tConfig)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(
|
|
err, "merging config %v", tConfig)
|
|
}
|
|
crdTc, err := accumulator.LoadConfigFromCRDs(kt.ldr, kt.kustomization.Crds)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(
|
|
err, "loading CRDs %v", kt.kustomization.Crds)
|
|
}
|
|
err = ra.MergeConfig(crdTc)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(
|
|
err, "merging CRDs %v", crdTc)
|
|
}
|
|
err = kt.runGenerators(ra)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
err = kt.runTransformers(ra)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
err = ra.MergeVars(kt.kustomization.Vars)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(
|
|
err, "merging vars %v", kt.kustomization.Vars)
|
|
}
|
|
return ra, nil
|
|
}
|
|
|
|
func (kt *KustTarget) runGenerators(
|
|
ra *accumulator.ResAccumulator) error {
|
|
var generators []resmap.Generator
|
|
gs, err := kt.configureBuiltinGenerators()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
generators = append(generators, gs...)
|
|
gs, err = kt.configureExternalGenerators()
|
|
if err != nil {
|
|
return errors.Wrap(err, "loading generator plugins")
|
|
}
|
|
generators = append(generators, gs...)
|
|
for _, g := range generators {
|
|
resMap, err := g.Generate()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
err = ra.AbsorbAll(resMap)
|
|
if err != nil {
|
|
return errors.Wrapf(err, "merging from generator %v", g)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (kt *KustTarget) configureExternalGenerators() ([]resmap.Generator, error) {
|
|
ra := accumulator.MakeEmptyAccumulator()
|
|
err := kt.accumulateResources(ra, kt.kustomization.Generators)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return kt.pLdr.LoadGenerators(kt.ldr, kt.validator, ra.ResMap())
|
|
}
|
|
|
|
func (kt *KustTarget) runTransformers(ra *accumulator.ResAccumulator) error {
|
|
var r []resmap.Transformer
|
|
tConfig := ra.GetTransformerConfig()
|
|
lts, err := kt.configureBuiltinTransformers(tConfig)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
r = append(r, lts...)
|
|
lts, err = kt.configureExternalTransformers()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
r = append(r, lts...)
|
|
t := transform.NewMultiTransformer(r)
|
|
return ra.Transform(t)
|
|
}
|
|
|
|
func (kt *KustTarget) configureExternalTransformers() ([]resmap.Transformer, error) {
|
|
ra := accumulator.MakeEmptyAccumulator()
|
|
err := kt.accumulateResources(ra, kt.kustomization.Transformers)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return kt.pLdr.LoadTransformers(kt.ldr, kt.validator, ra.ResMap())
|
|
}
|
|
|
|
// accumulateResources fills the given resourceAccumulator
|
|
// with resources read from the given list of paths.
|
|
func (kt *KustTarget) accumulateResources(
|
|
ra *accumulator.ResAccumulator, paths []string) error {
|
|
for _, path := range paths {
|
|
ldr, err := kt.ldr.New(path)
|
|
if err == nil {
|
|
err = kt.accumulateDirectory(ra, ldr)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
} else {
|
|
err2 := kt.accumulateFile(ra, path)
|
|
if err2 != nil {
|
|
// Log ldr.New() error to highlight git failures.
|
|
log.Print(err.Error())
|
|
return err2
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (kt *KustTarget) accumulateDirectory(
|
|
ra *accumulator.ResAccumulator, ldr ifc.Loader) error {
|
|
defer ldr.Cleanup()
|
|
subKt, err := NewKustTarget(
|
|
ldr, kt.validator, kt.rFactory, kt.tFactory, kt.pLdr)
|
|
if err != nil {
|
|
return errors.Wrapf(
|
|
err, "couldn't make target for path '%s'", ldr.Root())
|
|
}
|
|
subRa, err := subKt.AccumulateTarget()
|
|
if err != nil {
|
|
return errors.Wrapf(
|
|
err, "recursed accumulation of path '%s'", ldr.Root())
|
|
}
|
|
err = ra.MergeAccumulator(subRa)
|
|
if err != nil {
|
|
return errors.Wrapf(
|
|
err, "recursed merging from path '%s'", ldr.Root())
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (kt *KustTarget) accumulateFile(
|
|
ra *accumulator.ResAccumulator, path string) error {
|
|
resources, err := kt.rFactory.FromFile(kt.ldr, path)
|
|
if err != nil {
|
|
return errors.Wrapf(err, "accumulating resources from '%s'", path)
|
|
}
|
|
err = ra.AppendAll(resources)
|
|
if err != nil {
|
|
return errors.Wrapf(err, "merging resources from '%s'", path)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (kt *KustTarget) configureBuiltinPlugin(
|
|
p resmap.Configurable, c interface{}, bpt builtinhelpers.BuiltinPluginType) (err error) {
|
|
var y []byte
|
|
if c != nil {
|
|
y, err = yaml.Marshal(c)
|
|
if err != nil {
|
|
return errors.Wrapf(
|
|
err, "builtin %s marshal", bpt)
|
|
}
|
|
}
|
|
err = p.Config(resmap.NewPluginHelpers(kt.ldr, kt.validator, kt.rFactory), y)
|
|
if err != nil {
|
|
return errors.Wrapf(err, "builtin %s config: %v", bpt, y)
|
|
}
|
|
return nil
|
|
}
|