Skip to content

POC: Add ConfigMapGenerator & NativeConfigAdaptor #893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions functions/go/configmap-generator/generator/generator.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
package generator

import (
"fmt"
"strings"

"github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/native-config-adaptor/augeasclient"
generator "github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/native-config-adaptor/generator"
"github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"
corev1 "k8s.io/api/core/v1"
)

type BuiltinGeneratorKind string

const NativeConfigAdaptor BuiltinGeneratorKind = "NativeConfigAdaptor"

var BuiltinGenerators = map[BuiltinGeneratorKind]fn.Runner{
NativeConfigAdaptor: nil,
// ... others
}

var _ fn.Generator = &ConfigMapGenerator{}

type ConfigMapGenerator struct {
Spec ConfigMapGeneratorSpec `json:"spec,omitempty" yaml:"spec,omitempty"`
}

type ConfigMapGeneratorSpec struct {
Source []*SourceObjectReference `json:"source,omitempty" yaml:"source,omitempty"`
}

type SourceObjectReference struct {
corev1.TypedLocalObjectReference `json:",inline,omitempty" yaml:",inline,omitempty"`
augeasclient.AugeasConfigSource `json:",inline,omitempty" yaml:",inline,omitempty"`
}

func (r *ConfigMapGenerator) Generate(ctx *fn.Context, functionConfig *fn.KubeObject, items fn.KubeObjects) fn.KubeObjects {
var newObjects []*fn.KubeObject
data := map[string]string{}
rawConfigMapName := ""
var nativeFnConfig *fn.KubeObject
for _, source := range r.Spec.Source {
if source.LocalFile == "" && source.LocalFileRef == "" {
ctx.ResultErrAndDie("required either `spec.source.localFilePath` or `spec.source.localFileRef`", functionConfig)
}
// configmap generator always expects a ConfigMap object from NativeConfigAdaptor, not custom typed object.
source.AugeasConfigSource.AsConfigMap = true
if source.Kind != "" {
if source.Kind != string(NativeConfigAdaptor) {
ctx.ResultWarn(fmt.Sprintf("unknown generator type %s", r.Spec.Source), functionConfig)
return nil
}
nativeFnConfig = SelectNativeFnConfig(ctx, source, items)
if nativeFnConfig == nil {
continue
}
} else {
var err error
nativeFnConfig, err = generator.NewFromSource(&source.AugeasConfigSource)
if err != nil {
ctx.ResultErrAndDie(fmt.Sprintf("bad source: %v", err), functionConfig)
}
}
nativeFnConfig.SetName(functionConfig.GetName())
nativeConfigAdaptor := generator.NewNativeConfigAdaptor(nativeFnConfig)
nativeConfigObjects := nativeConfigAdaptor.Generate(ctx, nativeFnConfig, items)
if source.Name != "" {
nativeFnConfig.SetName(source.Name)
}
if nativeConfigObjects == nil || len(nativeConfigObjects) == 0 {
ctx.ResultErr("no native configuration generated", nativeFnConfig)
continue
}
granularObj := new(fn.KubeObject)
rawObject := new(fn.KubeObject)
for _, newObj := range nativeConfigObjects {
if strings.HasSuffix(newObj.GetName(), "-internal") {
granularObj = newObj
} else {
rawObject = newObj
}
}
// Update ConfigMap data from Raw granular object.
{
newData, found, err := granularObj.NestedStringMap("data")
if !found || err != nil {
ctx.ResultErrAndDie(err.Error(), granularObj)
return nil
}
for k, v := range newData {
if _, ok := data[k]; ok {
ctx.ResultErrAndDie("duplicate key value %v", nil)
}
data[k] = v
}
}
// RawObject is exposed to user as immutable ConfigMap.
{
SetRawConfigMapObject(functionConfig, rawObject)
newObjects = append(newObjects, rawObject)
rawConfigMapName = rawObject.GetName()
}
}
cmObject, err := r.CreateConfigMap(functionConfig, data)
if err != nil {
ctx.ResultErrAndDie(err.Error(), nil)
}
newObjects = append(newObjects, cmObject)
UpdateConfigMapReference(items, functionConfig.GetName(), rawConfigMapName)
return newObjects
}

func SetRawConfigMapObject(fnConfig *fn.KubeObject, object *fn.KubeObject) {
hashsuffix, _ := Hash(object)
hashedName := fmt.Sprintf("%s-%s", fnConfig.GetName(), hashsuffix)
object.SetName(hashedName)
object.SetAnnotation(fn.GeneratorIdentifier, fnConfig.GetOriginId().String())
object.SetNestedBool(true, "immutable")
}

func SelectNativeFnConfig(ctx *fn.Context, source *SourceObjectReference, items fn.KubeObjects) *fn.KubeObject {
nativeFnConfigs := items.Where(func(o *fn.KubeObject) bool {
switch true {
case o.GetKind() != source.Kind:
return false
case o.GetName() != source.Name:
return false
default:
return true
}
})
if len(nativeFnConfigs) > 1 {
ctx.ResultWarn(fmt.Sprintf("found more than one %v", source.Kind), nativeFnConfigs[0])
return nil
}
if len(nativeFnConfigs) == 0 {
ctx.ResultWarn(fmt.Sprintf("unable to find source %v", source.Kind), nil)
return nil
}
return nativeFnConfigs[0]
}

func UpdateConfigMapReference(items fn.KubeObjects, oldName, newName string) {
for _, object := range items {
if object.IsGVK("apps", "v1", "StatefulSet") {
volumes := object.GetMap("spec").GetMap("template").GetMap("spec").GetSlice("volumes")
for _, volume := range volumes {
var v corev1.Volume
volume.As(&v)
if v.ConfigMap != nil && v.ConfigMap.Name == oldName {
volume.GetMap("configMap").SetNestedString(newName, "name")
}
}
}
}
}

func (r *ConfigMapGenerator) CreateConfigMap(functionConfig *fn.KubeObject, data map[string]string) (*fn.KubeObject, error) {
name := functionConfig.GetName() + "-internal"
namespace := functionConfig.GetNamespace()

object := fn.NewEmptyKubeObject()
object.SetKind("ConfigMap")
object.SetAPIVersion("v1")
object.SetName(name)
if namespace != "" {
object.SetNamespace(namespace)
}
object.SetNestedStringMap(data, "data")
hashsuffix, err := Hash(object)
if err != nil {
return nil, err
}
hashedName := fmt.Sprintf("%s-%s", name, hashsuffix)
object.SetName(hashedName)
object.SetAnnotation(fn.IndexAnnotation, "0")
object.SetAnnotation(fn.PathAnnotation, object.GetKind()+"_"+object.GetName()+".yaml")
object.SetAnnotation(fn.GeneratorBuiltinIdentifier, functionConfig.GetOriginId().String())
return object, nil
}
61 changes: 61 additions & 0 deletions functions/go/configmap-generator/generator/hash.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
package generator

import (
"crypto/sha256"
"encoding/json"
"fmt"

"github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"
)

func Hash(object *fn.KubeObject) (string, error) {
content, err := effectiveContent(object)
if err != nil {
return "", nil
}
hex256 := fmt.Sprintf("%x", sha256.Sum256([]byte(content)))
return encode(hex256)
}

// Copied from https://github.com/kubernetes/kubernetes
// /blob/master/pkg/kubectl/util/hash/hash.go
func encode(hex string) (string, error) {
if len(hex) < 10 {
return "", fmt.Errorf(
"input length must be at least 10")
}
enc := []rune(hex[:10])
for i := range enc {
switch enc[i] {
case '0':
enc[i] = 'g'
case '1':
enc[i] = 'h'
case '3':
enc[i] = 'k'
case 'a':
enc[i] = 'm'
case 'e':
enc[i] = 't'
}
}
return string(enc), nil
}

func effectiveContent(object *fn.KubeObject) (string, error) {
data, _, err := object.NestedStringMap("data")
if err != nil {
return "", err
}
m := map[string]interface{}{
"kind": object.GetKind(),
"name": object.GetName(),
"data": data,
}
// skip binaryData
content, err := json.Marshal(m)
if err != nil {
return "", err
}
return string(content), nil
}
50 changes: 50 additions & 0 deletions functions/go/configmap-generator/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
module github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/configmap-generator

go 1.17

require (
github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/native-config-adaptor v0.0.0-00010101000000-000000000000
github.com/GoogleContainerTools/kpt-functions-sdk/go/fn v0.0.0-20220723081830-33aee7fe8a2e
k8s.io/api v0.24.3
)

require (
github.com/GoogleContainerTools/kpt-functions-sdk/go/api v0.0.0-20220723081830-33aee7fe8a2e // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/go-errors/errors v1.4.2 // indirect
github.com/go-logr/logr v1.2.3 // indirect
github.com/go-openapi/jsonpointer v0.19.5 // indirect
github.com/go-openapi/jsonreference v0.20.0 // indirect
github.com/go-openapi/swag v0.21.1 // indirect
github.com/gogo/protobuf v1.3.2 // indirect
github.com/golang/protobuf v1.5.2 // indirect
github.com/google/gnostic v0.6.9 // indirect
github.com/google/gofuzz v1.1.0 // indirect
github.com/josharian/intern v1.0.0 // indirect
github.com/json-iterator/go v1.1.12 // indirect
github.com/mailru/easyjson v0.7.7 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/monochromegane/go-gitignore v0.0.0-20200626010858-205db1a8cc00 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/stretchr/testify v1.8.0 // indirect
github.com/xlab/treeprint v1.1.0 // indirect
golang.org/x/net v0.0.0-20220728211354-c7608f3a8462 // indirect
golang.org/x/sys v0.0.0-20220731174439-a90be440212d // indirect
golang.org/x/text v0.3.7 // indirect
google.golang.org/protobuf v1.28.1 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
honnef.co/go/augeas v0.0.0-20161110001225-ca62e35ed6b8 // indirect
k8s.io/apimachinery v0.24.3 // indirect
k8s.io/klog/v2 v2.70.1 // indirect
k8s.io/kube-openapi v0.0.0-20220627174259-011e075b9cb8 // indirect
k8s.io/utils v0.0.0-20220210201930-3a6ce19ff2f9 // indirect
sigs.k8s.io/json v0.0.0-20211208200746-9f7c6b3444d2 // indirect
sigs.k8s.io/kustomize/kyaml v0.13.8 // indirect
sigs.k8s.io/structured-merge-diff/v4 v4.2.1 // indirect
)

replace github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/native-config-adaptor => ../native-config-adaptor
replace github.com/GoogleContainerTools/kpt-functions-sdk/go/fn => ../../../../kpt-functions-sdk/go/fn
Loading