Skip to content

Commit 7efdc4b

Browse files
yuwenmayuwenma
committed
add functoin set-standard-labels
1 parent f361a33 commit 7efdc4b

File tree

18 files changed

+611
-0
lines changed

18 files changed

+611
-0
lines changed

‎functions/go/set-standard-labels/const.go

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
package main
2+
3+
4+
// https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/
5+
const (
6+
AppLabelPrefix = "app.kubernetes.io/"
7+
AppName = AppLabelPrefix + "name"
8+
AppInstance = AppLabelPrefix + "instance"
9+
10+
// TBD
11+
AppVersion = AppLabelPrefix + "version"
12+
AppComponent = AppLabelPrefix + "component"
13+
AppPartOf = AppLabelPrefix + "part-of"
14+
AppManagedBy = AppLabelPrefix + "managed-by"
15+
)
16+
17+
const (
18+
PackageContextKind = "ConfigMap"
19+
PackageContextName = "kptfile.kpt.dev"
20+
)
21+
22+
23+
const (
24+
SetLabelFnKind = "ConfigMap"
25+
SetLabelFnName = "recommended-labels"
26+
)

‎functions/go/set-standard-labels/go.mod

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
module github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/set-standard-labels
2+
3+
go 1.19
4+
5+
require (
6+
github.com/GoogleContainerTools/kpt-functions-catalog/functions/go/set-labels v0.0.0-20221018012752-f361a33ec921
7+
github.com/GoogleContainerTools/kpt-functions-sdk/go/fn v0.0.0-20221018174030-e63010a12b00
8+
k8s.io/apimachinery v0.25.3
9+
)
10+
11+
require (
12+
github.com/GoogleContainerTools/kpt-functions-sdk/go/api v0.0.0-20221018174030-e63010a12b00 // indirect
13+
github.com/davecgh/go-spew v1.1.1 // indirect
14+
github.com/go-errors/errors v1.4.2 // indirect
15+
github.com/go-logr/logr v1.2.3 // indirect
16+
github.com/go-openapi/jsonpointer v0.19.5 // indirect
17+
github.com/go-openapi/jsonreference v0.20.0 // indirect
18+
github.com/go-openapi/swag v0.22.3 // indirect
19+
github.com/gogo/protobuf v1.3.2 // indirect
20+
github.com/golang/protobuf v1.5.2 // indirect
21+
github.com/google/gnostic v0.6.9 // indirect
22+
github.com/google/go-cmp v0.5.9 // indirect
23+
github.com/google/gofuzz v1.2.0 // indirect
24+
github.com/josharian/intern v1.0.0 // indirect
25+
github.com/mailru/easyjson v0.7.7 // indirect
26+
github.com/monochromegane/go-gitignore v0.0.0-20200626010858-205db1a8cc00 // indirect
27+
github.com/xlab/treeprint v1.1.0 // indirect
28+
golang.org/x/sys v0.1.0 // indirect
29+
google.golang.org/protobuf v1.28.1 // indirect
30+
gopkg.in/yaml.v2 v2.4.0 // indirect
31+
gopkg.in/yaml.v3 v3.0.1 // indirect
32+
k8s.io/klog/v2 v2.80.1 // indirect
33+
k8s.io/kube-openapi v0.0.0-20221012153701-172d655c2280 // indirect
34+
sigs.k8s.io/kustomize/kyaml v0.13.9 // indirect
35+
)

‎functions/go/set-standard-labels/go.sum

Lines changed: 221 additions & 0 deletions
Large diffs are not rendered by default.

‎functions/go/set-standard-labels/golden_test.go

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Copyright 2022 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
package main
15+
16+
import (
17+
"context"
18+
"testing"
19+
20+
"github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"
21+
"github.com/GoogleContainerTools/kpt-functions-sdk/go/fn/testhelpers"
22+
)
23+
24+
const TestDataPath = "testdata"
25+
26+
27+
func TestFunction(t *testing.T) {
28+
// Read the `testdata/source` YAML krm resources
29+
fnRunner := fn.WithContext(context.TODO(), &SetStandardLabels{})
30+
testhelpers.RunGoldenTests(t, TestDataPath, fnRunner)
31+
}

‎functions/go/set-standard-labels/main.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
package main
2+
3+
import (
4+
"context"
5+
"os"
6+
7+
"github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"
8+
)
9+
10+
func main() {
11+
runner := fn.WithContext(context.Background(), &SetStandardLabels{})
12+
if err := fn.AsMain(runner); err != nil {
13+
os.Exit(1)
14+
}
15+
}

‎functions/go/set-standard-labels/testdata/abstract-base-app/Kptfile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: kpt.dev/v1
2+
kind: Kptfile
3+
metadata:
4+
name: base-app
5+
annotations:
6+
config.kubernetes.io/local-config: "true"
7+
info:
8+
description: sample description

‎functions/go/set-standard-labels/testdata/abstract-base-app/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This test is a blueprint package. It expects the label "app.kubernetes.io/name" is added using the package name "base-app"

‎functions/go/set-standard-labels/testdata/abstract-base-app/_expected.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
apiVersion: config.kubernetes.io/v1
2+
kind: ResourceList
3+
items:
4+
- apiVersion: apps/v1
5+
kind: Deployment
6+
metadata:
7+
name: base-app
8+
namespace: example
9+
labels:
10+
app.kubernetes.io/name: base-app
11+
spec:
12+
selector:
13+
matchLabels:
14+
test: abstract-base-app
15+
app.kubernetes.io/name: base-app
16+
template:
17+
metadata:
18+
labels:
19+
test: abstract-base-app
20+
app.kubernetes.io/name: base-app
21+
- apiVersion: kpt.dev/v1
22+
kind: Kptfile
23+
metadata:
24+
name: base-app
25+
annotations:
26+
config.kubernetes.io/local-config: "true"
27+
info:
28+
description: sample description
29+
results:
30+
- message: '`FunctionConfig` is not given'
31+
severity: info
32+
- message: set 3 labels in total
33+
severity: info

‎functions/go/set-standard-labels/testdata/abstract-base-app/resources.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
apiVersion: apps/v1
3+
kind: Deployment
4+
metadata:
5+
name: base-app
6+
namespace: example
7+
spec:
8+
selector:
9+
matchLabels:
10+
test: abstract-base-app
11+
template:
12+
metadata:
13+
labels:
14+
test: abstract-base-app

‎functions/go/set-standard-labels/testdata/blueprint-frontend/Kptfile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: kpt.dev/v1
2+
kind: Kptfile
3+
metadata:
4+
name: frontend
5+
annotations:
6+
config.kubernetes.io/local-config: "true"
7+
info:
8+
description: sample description

‎functions/go/set-standard-labels/testdata/blueprint-frontend/_expected.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
apiVersion: config.kubernetes.io/v1
2+
kind: ResourceList
3+
items:
4+
- apiVersion: apps/v1
5+
kind: Deployment
6+
metadata:
7+
name: base-app
8+
namespace: example
9+
labels:
10+
test: abstract-base-app
11+
app.kubernetes.io/name: frontend
12+
spec:
13+
selector:
14+
matchLabels:
15+
test: abstract-base-app
16+
app.kubernetes.io/name: frontend
17+
template:
18+
metadata:
19+
labels:
20+
test: abstract-base-app
21+
app.kubernetes.io/name: frontend
22+
- apiVersion: kpt.dev/v1
23+
kind: Kptfile
24+
metadata:
25+
name: frontend
26+
annotations:
27+
config.kubernetes.io/local-config: "true"
28+
info:
29+
description: sample description
30+
results:
31+
- message: '`FunctionConfig` is not given'
32+
severity: info
33+
- message: set 3 labels in total
34+
severity: info

‎functions/go/set-standard-labels/testdata/blueprint-frontend/resources.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
apiVersion: apps/v1
2+
kind: Deployment
3+
metadata:
4+
name: base-app
5+
namespace: example
6+
labels:
7+
test: abstract-base-app
8+
app.kubernetes.io/name: base-app
9+
spec:
10+
selector:
11+
matchLabels:
12+
test: abstract-base-app
13+
app.kubernetes.io/name: base-app
14+
template:
15+
metadata:
16+
labels:
17+
test: abstract-base-app
18+
app.kubernetes.io/name: base-app

‎functions/go/set-standard-labels/testdata/deployment-dev/Kptfile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: kpt.dev/v1
2+
kind: Kptfile
3+
metadata:
4+
name: frontend-dev
5+
annotations:
6+
config.kubernetes.io/local-config: "true"
7+
info:
8+
description: sample description

‎functions/go/set-standard-labels/testdata/deployment-dev/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This test is a deployment package.
2+
It expects the "app.kubernetes.io/name" label is preserved from its upstream blueprint package
3+
and the "app.kubernetes.io/instance" label is added using the package name "frontend-dev"

‎functions/go/set-standard-labels/testdata/deployment-dev/_expected.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
apiVersion: config.kubernetes.io/v1
2+
kind: ResourceList
3+
items:
4+
- apiVersion: apps/v1
5+
kind: Deployment
6+
metadata:
7+
name: base-app
8+
namespace: example
9+
labels:
10+
test: abstract-base-app
11+
app.kubernetes.io/name: frontend
12+
app.kubernetes.io/instance: frontend-dev
13+
spec:
14+
selector:
15+
matchLabels:
16+
test: abstract-base-app
17+
app.kubernetes.io/name: frontend
18+
app.kubernetes.io/instance: frontend-dev
19+
template:
20+
metadata:
21+
labels:
22+
test: abstract-base-app
23+
app.kubernetes.io/name: frontend
24+
app.kubernetes.io/instance: frontend-dev
25+
- apiVersion: kpt.dev/v1
26+
kind: Kptfile
27+
metadata:
28+
name: frontend-dev
29+
annotations:
30+
config.kubernetes.io/local-config: "true"
31+
info:
32+
description: sample description
33+
- apiVersion: v1
34+
kind: ConfigMap
35+
metadata:
36+
name: kptfile.kpt.dev
37+
annotations:
38+
config.kubernetes.io/local-config: "true"
39+
data:
40+
name: frontend-dev
41+
results:
42+
- message: '`FunctionConfig` is not given'
43+
severity: info
44+
- message: set 3 labels in total
45+
severity: info

‎functions/go/set-standard-labels/testdata/deployment-dev/package-context.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
apiVersion: v1
2+
kind: ConfigMap
3+
metadata:
4+
name: kptfile.kpt.dev
5+
annotations:
6+
config.kubernetes.io/local-config: "true"
7+
data:
8+
name: frontend-dev

‎functions/go/set-standard-labels/testdata/deployment-dev/resources.yaml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
apiVersion: apps/v1
2+
kind: Deployment
3+
metadata:
4+
name: base-app
5+
namespace: example
6+
labels:
7+
test: abstract-base-app
8+
app.kubernetes.io/name: frontend
9+
spec:
10+
selector:
11+
matchLabels:
12+
test: abstract-base-app
13+
app.kubernetes.io/name: frontend
14+
template:
15+
metadata:
16+
labels:
17+
test: abstract-base-app
18+
app.kubernetes.io/name: frontend

0 commit comments

Comments
 (0)