mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-13 10:00:56 +00:00
Make the replica transformer kind aware.
The previous implementation had a bug and poorly handled types that should not have a `spec: replica:` field. Documentation is updated to reflect the change in behavior, and better highlights the cases where a patch should be used instead of this shorthand.
This commit is contained in:
Damien Robichaud
@@ -7,19 +7,17 @@ import (
|
||||
"sigs.k8s.io/kustomize/pkg/ifc"
|
||||
"sigs.k8s.io/kustomize/pkg/resid"
|
||||
"sigs.k8s.io/kustomize/pkg/resmap"
|
||||
"sigs.k8s.io/kustomize/pkg/transformers"
|
||||
"sigs.k8s.io/kustomize/pkg/transformers/config"
|
||||
"sigs.k8s.io/kustomize/pkg/types"
|
||||
"sigs.k8s.io/yaml"
|
||||
)
|
||||
|
||||
const (
|
||||
fldReplica = "replicas"
|
||||
fldSpec = "spec"
|
||||
)
|
||||
|
||||
// Find matching replicas declarations and replace the count.
|
||||
// Eases the kustomization configuration of replica changes.
|
||||
type ReplicaCountTransformerPlugin struct {
|
||||
Replica types.Replica `json:"replica,omitempty" yaml:"replica,omitempty"`
|
||||
Replica types.Replica `json:"replica,omitempty" yaml:"replica,omitempty"`
|
||||
FieldSpecs []config.FieldSpec `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"`
|
||||
}
|
||||
|
||||
//noinspection GoUnusedGlobalVariable
|
||||
@@ -31,30 +29,46 @@ func (p *ReplicaCountTransformerPlugin) Config(
|
||||
ldr ifc.Loader, rf *resmap.Factory, c []byte) (err error) {
|
||||
|
||||
p.Replica = types.Replica{}
|
||||
p.FieldSpecs = nil
|
||||
return yaml.Unmarshal(c, p)
|
||||
}
|
||||
|
||||
func (p *ReplicaCountTransformerPlugin) Transform(m resmap.ResMap) error {
|
||||
matcher := func(r resid.ResId) bool {
|
||||
return r.Name == p.Replica.Name
|
||||
}
|
||||
|
||||
for _, r := range m.GetMatchingResourcesByOriginalId(matcher) {
|
||||
kMap := r.Map()
|
||||
|
||||
specInterface, ok := kMap[fldSpec]
|
||||
if !ok {
|
||||
return fmt.Errorf("object %s missing field %s, cannot update %s",
|
||||
p.Replica.Name, fldSpec, fldReplica)
|
||||
}
|
||||
|
||||
if spec, ok := specInterface.(map[string]interface{}); ok {
|
||||
spec[fldReplica] = p.Replica.Count
|
||||
kMap[fldSpec] = spec
|
||||
} else {
|
||||
return fmt.Errorf("object %s has a malformed %s", p.Replica.Name, fldSpec)
|
||||
for i, replicaSpec := range p.FieldSpecs {
|
||||
for _, res := range m.GetMatchingResourcesByOriginalId(p.createMatcher(i)) {
|
||||
err := transformers.MutateField(
|
||||
res.Map(), replicaSpec.PathSlice(),
|
||||
replicaSpec.CreateIfNotPresent, p.addReplicas)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Match Replica.Name and FieldSpec
|
||||
func (p *ReplicaCountTransformerPlugin) createMatcher(i int) resmap.IdMatcher {
|
||||
return func(r resid.ResId) bool {
|
||||
return r.Name == p.Replica.Name &&
|
||||
r.Gvk.IsSelected(&p.FieldSpecs[i].Gvk)
|
||||
}
|
||||
}
|
||||
|
||||
func (p *ReplicaCountTransformerPlugin) addReplicas(in interface{}) (interface{}, error) {
|
||||
switch m := in.(type) {
|
||||
case int64:
|
||||
// Was already in the field.
|
||||
case map[string]interface{}:
|
||||
if len(m) != 0 {
|
||||
// A map was already in the replicas field, don't want to
|
||||
// discard this data silently.
|
||||
return nil, fmt.Errorf("%#v is expected to be %T", in, m)
|
||||
}
|
||||
// Just got added, default type is map, but we can return anything.
|
||||
default:
|
||||
return nil, fmt.Errorf("%#v is expected to be %T", in, m)
|
||||
}
|
||||
return p.Replica.Count, nil
|
||||
}
|
||||
|
||||
@@ -10,19 +10,17 @@ import (
|
||||
"sigs.k8s.io/kustomize/pkg/ifc"
|
||||
"sigs.k8s.io/kustomize/pkg/resid"
|
||||
"sigs.k8s.io/kustomize/pkg/resmap"
|
||||
"sigs.k8s.io/kustomize/pkg/transformers"
|
||||
"sigs.k8s.io/kustomize/pkg/transformers/config"
|
||||
"sigs.k8s.io/kustomize/pkg/types"
|
||||
"sigs.k8s.io/yaml"
|
||||
)
|
||||
|
||||
const (
|
||||
fldReplica = "replicas"
|
||||
fldSpec = "spec"
|
||||
)
|
||||
|
||||
// Find matching replicas declarations and replace the count.
|
||||
// Eases the kustomization configuration of replica changes.
|
||||
type plugin struct {
|
||||
Replica types.Replica `json:"replica,omitempty" yaml:"replica,omitempty"`
|
||||
Replica types.Replica `json:"replica,omitempty" yaml:"replica,omitempty"`
|
||||
FieldSpecs []config.FieldSpec `json:"fieldSpecs,omitempty" yaml:"fieldSpecs,omitempty"`
|
||||
}
|
||||
|
||||
//noinspection GoUnusedGlobalVariable
|
||||
@@ -32,30 +30,46 @@ func (p *plugin) Config(
|
||||
ldr ifc.Loader, rf *resmap.Factory, c []byte) (err error) {
|
||||
|
||||
p.Replica = types.Replica{}
|
||||
p.FieldSpecs = nil
|
||||
return yaml.Unmarshal(c, p)
|
||||
}
|
||||
|
||||
func (p *plugin) Transform(m resmap.ResMap) error {
|
||||
matcher := func(r resid.ResId) bool {
|
||||
return r.Name == p.Replica.Name
|
||||
}
|
||||
|
||||
for _, r := range m.GetMatchingResourcesByOriginalId(matcher) {
|
||||
kMap := r.Map()
|
||||
|
||||
specInterface, ok := kMap[fldSpec]
|
||||
if !ok {
|
||||
return fmt.Errorf("object %s missing field %s, cannot update %s",
|
||||
p.Replica.Name, fldSpec, fldReplica)
|
||||
}
|
||||
|
||||
if spec, ok := specInterface.(map[string]interface{}); ok {
|
||||
spec[fldReplica] = p.Replica.Count
|
||||
kMap[fldSpec] = spec
|
||||
} else {
|
||||
return fmt.Errorf("object %s has a malformed %s", p.Replica.Name, fldSpec)
|
||||
for i, replicaSpec := range p.FieldSpecs {
|
||||
for _, res := range m.GetMatchingResourcesByOriginalId(p.createMatcher(i)) {
|
||||
err := transformers.MutateField(
|
||||
res.Map(), replicaSpec.PathSlice(),
|
||||
replicaSpec.CreateIfNotPresent, p.addReplicas)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Match Replica.Name and FieldSpec
|
||||
func (p *plugin) createMatcher(i int) resmap.IdMatcher {
|
||||
return func(r resid.ResId) bool {
|
||||
return r.Name == p.Replica.Name &&
|
||||
r.Gvk.IsSelected(&p.FieldSpecs[i].Gvk)
|
||||
}
|
||||
}
|
||||
|
||||
func (p *plugin) addReplicas(in interface{}) (interface{}, error) {
|
||||
switch m := in.(type) {
|
||||
case int64:
|
||||
// Was already in the field.
|
||||
case map[string]interface{}:
|
||||
if len(m) != 0 {
|
||||
// A map was already in the replicas field, don't want to
|
||||
// discard this data silently.
|
||||
return nil, fmt.Errorf("%#v is expected to be %T", in, m)
|
||||
}
|
||||
// Just got added, default type is map, but we can return anything.
|
||||
default:
|
||||
return nil, fmt.Errorf("%#v is expected to be %T", in, m)
|
||||
}
|
||||
return p.Replica.Count, nil
|
||||
}
|
||||
|
||||
@@ -24,26 +24,130 @@ apiVersion: builtin
|
||||
kind: ReplicaCountTransformer
|
||||
metadata:
|
||||
name: notImportantHere
|
||||
|
||||
replica:
|
||||
name: deploy1
|
||||
name: myapp
|
||||
count: 23
|
||||
fieldSpecs:
|
||||
- path: spec/replicas
|
||||
create: true
|
||||
kind: Deployment
|
||||
|
||||
- path: spec/replicas
|
||||
create: true
|
||||
kind: ReplicationController
|
||||
|
||||
- path: spec/replicas
|
||||
create: true
|
||||
kind: ReplicaSet
|
||||
|
||||
- path: spec/replicas
|
||||
create: true
|
||||
kind: StatefulSet
|
||||
`, `
|
||||
group: apps
|
||||
apiVersion: v1
|
||||
apiVersion: builtin
|
||||
kind: Service
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
ports:
|
||||
- port: 1111
|
||||
targetport: 1111
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: deploy1
|
||||
name: otherapp
|
||||
spec:
|
||||
replicas: 1
|
||||
replicas: 5
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
replicas: 5
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: StatefulSet
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
selector:
|
||||
matchLabels:
|
||||
app: app
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: ReplicaSet
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
selector:
|
||||
matchLabels:
|
||||
app: app
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: ReplicationController
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
selector:
|
||||
matchLabels:
|
||||
app: app
|
||||
`)
|
||||
|
||||
th.AssertActualEqualsExpected(rm, `
|
||||
apiVersion: v1
|
||||
group: apps
|
||||
apiVersion: builtin
|
||||
kind: Service
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
ports:
|
||||
- port: 1111
|
||||
targetport: 1111
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: deploy1
|
||||
name: myapp
|
||||
spec:
|
||||
replicas: 23
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: otherapp
|
||||
spec:
|
||||
replicas: 5
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: StatefulSet
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
replicas: 23
|
||||
selector:
|
||||
matchLabels:
|
||||
app: app
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: ReplicaSet
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
replicas: 23
|
||||
selector:
|
||||
matchLabels:
|
||||
app: app
|
||||
---
|
||||
apiVersion: builtin
|
||||
kind: ReplicationController
|
||||
metadata:
|
||||
name: myapp
|
||||
spec:
|
||||
replicas: 23
|
||||
selector:
|
||||
matchLabels:
|
||||
app: app
|
||||
`)
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user