Skip to content

Commit

Permalink
Some kustomization field renaming.
Browse files Browse the repository at this point in the history
  • Loading branch information
monopole committed Apr 13, 2018
1 parent 96f4633 commit da0682c
Show file tree
Hide file tree
Showing 13 changed files with 118 additions and 45 deletions.
4 changes: 2 additions & 2 deletions app/application.go
Original file line number Diff line number Diff line change
Expand Up @@ -213,13 +213,13 @@ func (a *applicationImpl) getTransformer(patches []*resource.Resource) (transfor
}
ts = append(ts, npt)

lt, err := transformers.NewDefaultingLabelsMapTransformer(a.kustomization.ObjectLabels)
lt, err := transformers.NewDefaultingLabelsMapTransformer(a.kustomization.LabelsToAdd)
if err != nil {
return nil, err
}
ts = append(ts, lt)

at, err := transformers.NewDefaultingAnnotationsMapTransformer(a.kustomization.ObjectAnnotations)
at, err := transformers.NewDefaultingAnnotationsMapTransformer(a.kustomization.AnnotationsToAdd)
if err != nil {
return nil, err
}
Expand Down
6 changes: 3 additions & 3 deletions app/application_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ import (
)

func setupTest(t *testing.T) loader.Loader {
kustomizationContent := []byte(`kustomizationName: nginx-app
kustomizationContent := []byte(`
namePrefix: foo-
objectLabels:
labelsToAdd:
app: nginx
objectAnnotations:
annotationsToAdd:
note: This is a test annotation
resources:
- deployment.yaml
Expand Down
96 changes: 96 additions & 0 deletions commands/init.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/*
Copyright 2017 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 commands

import (
"fmt"
"io"

"errors"

"github.com/spf13/cobra"
"k8s.io/kubectl/pkg/kustomize/constants"
"k8s.io/kubectl/pkg/kustomize/util/fs"
)

const kustomizationTemplate = `
namePrefix: some-prefix
# Labels to add to all objects and selectors.
# These labels would also be used to form the selector for apply --prune
# Named differently than “labels” to avoid confusion with metadata for this object
labelsToAdd:
app: helloworld
annotationsToAdd:
note: This is an example annotation
resources: []
#- service.yaml
#- ../some-dir/
# There could also be configmaps in Base, which would make these overlays
configMapGenerator: []
# There could be secrets in Base, if just using a fork/rebase workflow
secretGenerator: []
`

type initOptions struct {
}

// NewCmdInit makes the init command.
func newCmdInit(out, errOut io.Writer, fs fs.FileSystem) *cobra.Command {
var o initOptions

cmd := &cobra.Command{
Use: "init",
Short: "Creates a file called \"" + constants.KustomizationFileName + "\" in the current directory",
Long: "Creates a file called \"" +
constants.KustomizationFileName + "\" in the current directory with example values.",
Example: `init`,
SilenceUsage: true,
RunE: func(cmd *cobra.Command, args []string) error {
err := o.Validate(cmd, args)
if err != nil {
return err
}
err = o.Complete(cmd, args)
if err != nil {
return err
}
return o.RunInit(out, errOut, fs)
},
}
return cmd
}

// Validate validates init command.
func (o *initOptions) Validate(cmd *cobra.Command, args []string) error {
if len(args) > 0 {
return errors.New("The init command takes no arguments.")
}
return nil
}

// Complete completes init command.
func (o *initOptions) Complete(cmd *cobra.Command, args []string) error {
return nil
}

// RunInit writes a kustomization file.
func (o *initOptions) RunInit(out, errOut io.Writer, fs fs.FileSystem) error {
if _, err := fs.Stat(constants.KustomizationFileName); err == nil {
return fmt.Errorf("%q already exists", constants.KustomizationFileName)
}
return fs.WriteFile(constants.KustomizationFileName, []byte(kustomizationTemplate))
}
5 changes: 2 additions & 3 deletions commands/testdata/testcase-base-only/in/kustomize.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
kustomizationName: nginx-app
namePrefix: team-foo-
objectLabels:
labelsToAdd:
app: mynginx
org: example.com
team: foo
objectAnnotations:
annotationsToAdd:
note: This is a test annotation
resources:
- deployment.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
kustomizationName: nginx-app
namePrefix: staging-
objectLabels:
labelsToAdd:
env: staging
patches:
- deployment-patch2.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
kustomizationName: nginx-app
namePrefix: team-foo-
objectLabels:
labelsToAdd:
app: mynginx
org: example.com
team: foo
objectAnnotations:
annotationsToAdd:
note: This is a test annotation
resources:
- deployment.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
kustomizationName: nginx-app
namePrefix: staging-
objectLabels:
labelsToAdd:
env: staging
patches:
- deployment-patch1.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
kustomizationName: nginx-app
namePrefix: team-foo-
objectLabels:
labelsToAdd:
app: mynginx
org: example.com
team: foo
objectAnnotations:
annotationsToAdd:
note: This is a test annotation
resources:
- deployment.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
kustomizationName: nginx-app
namePrefix: staging-
objectLabels:
labelsToAdd:
env: staging
team: override-foo
patches:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
kustomizationName: nginx-app
namePrefix: team-foo-
objectLabels:
labelsToAdd:
app: mynginx
org: example.com
team: foo
objectAnnotations:
annotationsToAdd:
note: This is a test annotation
resources:
- deployment.yaml
Expand Down
11 changes: 2 additions & 9 deletions examples/simple/instances/exampleinstance/kustomize.yaml
Original file line number Diff line number Diff line change
@@ -1,27 +1,20 @@
kustomizationName: test-infra-mungebot
namePrefix: test-infra-
# Labels to add to all objects and selectors.
# These labels would also be used to form the selector for apply --prune
# Named differently than “labels” to avoid confusion with metadata for this object
objectLabels:
labelsToAdd:
app: mungebot
org: kubernetes
repo: test-infra
objectAnnotations:
annotationsToAdd:
note: This is a test annotation
bases:
- ../../package/
#These are strategic merge patch overlays in the form of API resources
patches:
- deployment/deployment.yaml
#There could also be configmaps in Base, which would make these overlays
configMapGenerator:
- name: app-env
env: configmap/app.env
- name: app-config
files:
- configmap/app-init.ini
#There could be secrets in Base, if just using a fork/rebase workflow
secretGenerator:
- name: app-tls
commands:
Expand Down
8 changes: 2 additions & 6 deletions examples/simple/package/kustomize.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
kustomizationName: mungebot
namePrefix: baseprefix-
# Labels to add to all objects and selectors.
# These labels would also be used to form the selector for apply --prune
# Named differently than “labels” to avoid confusion with metadata for this object
objectLabels:
labelsToAdd:
foo: bar
objectAnnotations:
annotationsToAdd:
baseAnno: This is an base annotation
resources:
- deployment/deployment.yaml
Expand Down
9 changes: 2 additions & 7 deletions types/kustomization.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,6 @@ package types

// Kustomization holds the information needed to generate customized k8s api resources.
type Kustomization struct {
// KustomizationName is a documentation field - a name for the customizations
// in a marshalled version of this struct, that survives YAML unmarshalling
// that discards comments.
KustomizationName string `json:"kustomizationName,omitempty" yaml:"kustomizationName,omitempty"`

// NamePrefix will prefix the names of all resources mentioned in the kustomization
// file including generated configmaps and secrets.
NamePrefix string `json:"namePrefix,omitempty" yaml:"namePrefix,omitempty"`
Expand All @@ -31,10 +26,10 @@ type Kustomization struct {
// These labels would also be used to form the selector for apply --prune
// Named differently than “labels” to avoid confusion with metadata for
// this object
ObjectLabels map[string]string `json:"objectLabels,omitempty" yaml:"objectLabels,omitempty"`
LabelsToAdd map[string]string `json:"labelsToAdd,omitempty" yaml:"labelsToAdd,omitempty"`

// Annotations to add to all objects.
ObjectAnnotations map[string]string `json:"objectAnnotations,omitempty" yaml:"objectAnnotations,omitempty"`
AnnotationsToAdd map[string]string `json:"annotationsToAdd,omitempty" yaml:"annotationsToAdd,omitempty"`

// Bases contain the paths to other packages that this kustomization depends on.
// Each path should be either a path to a kustomize.yaml or a path of
Expand Down

0 comments on commit da0682c

Please sign in to comment.