Using single quote style when setting annotations

Annotations must be strings.  Use single-quote style
so tools don't get confused about the type.
This commit is contained in:
Phillip Wittrock
2019-12-16 17:44:45 -08:00
parent 01105af14d
commit eaaefc128f
12 changed files with 127 additions and 118 deletions

View File

@@ -90,8 +90,8 @@ metadata:
name: foo
annotations:
app: nginx2
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
replicas: 1
---
@@ -100,8 +100,8 @@ metadata:
name: foo
annotations:
app: nginx
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
selector:
app: nginx
@@ -196,8 +196,8 @@ metadata:
name: foo
annotations:
app: nginx2
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
replicas: 1
---
@@ -206,8 +206,8 @@ metadata:
name: foo
annotations:
app: nginx
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
selector:
app: nginx
@@ -233,8 +233,8 @@ metadata:
name: bar
annotations:
app: nginx
config.kubernetes.io/package: .
config.kubernetes.io/path: f2.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f2.yaml'
spec:
replicas: 3
`, b.String()) {
@@ -414,8 +414,8 @@ metadata:
name: foo
annotations:
app: nginx2
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
replicas: 1
---
@@ -424,8 +424,8 @@ metadata:
name: foo
annotations:
app: nginx
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
selector:
app: nginx
@@ -536,8 +536,8 @@ metadata:
name: foo
annotations:
app: nginx2
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
replicas: 1
---
@@ -546,8 +546,8 @@ metadata:
name: foo
annotations:
app: nginx
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
selector:
app: nginx

View File

@@ -78,7 +78,7 @@ items:
name: test
app: nginx
annotations:
config.kubernetes.io/index: 0
config.kubernetes.io/index: "0"
config.kubernetes.io/path: config/test_deployment.yaml
spec:
replicas: 11
@@ -109,7 +109,7 @@ items:
name: test
app: nginx
annotations:
config.kubernetes.io/index: 0
config.kubernetes.io/index: "0"
config.kubernetes.io/path: config/test_service.yaml
spec:
selector:
@@ -133,7 +133,7 @@ items:
name: test
app: nginx
annotations:
config.kubernetes.io/index: 0
config.kubernetes.io/index: "0"
config.kubernetes.io/path: config/test_deployment.yaml
spec:
replicas: 11
@@ -161,7 +161,7 @@ items:
name: test
app: nginx
annotations:
config.kubernetes.io/index: 0
config.kubernetes.io/index: "0"
config.kubernetes.io/path: config/test_service.yaml
spec:
selector:
@@ -185,7 +185,7 @@ items:
name: test
app: nginx
annotations:
config.kubernetes.io/index: 0
config.kubernetes.io/index: "0"
config.kubernetes.io/path: config/test_deployment.yaml
spec:
replicas: 11
@@ -216,7 +216,7 @@ items:
name: test
app: nginx
annotations:
config.kubernetes.io/index: 0
config.kubernetes.io/index: "0"
config.kubernetes.io/path: config/test_service.yaml
spec:
selector:

View File

@@ -75,9 +75,9 @@ metadata:
name: foo
annotations:
app: nginx2
config.kubernetes.io/index: 0
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/index: '0'
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
replicas: 1
---
@@ -86,9 +86,9 @@ metadata:
name: foo
annotations:
app: nginx
config.kubernetes.io/index: 1
config.kubernetes.io/package: .
config.kubernetes.io/path: f1.yaml
config.kubernetes.io/index: '1'
config.kubernetes.io/package: '.'
config.kubernetes.io/path: 'f1.yaml'
spec:
selector:
app: nginx
@@ -145,7 +145,7 @@ metadata:
name: foo
annotations:
app: nginx2
config.kubernetes.io/index: 0
config.kubernetes.io/index: '0'
spec:
replicas: 1
---
@@ -154,7 +154,7 @@ metadata:
name: foo
annotations:
app: nginx
config.kubernetes.io/index: 1
config.kubernetes.io/index: '1'
spec:
selector:
app: nginx

View File

@@ -292,16 +292,17 @@ Resource Configuration may be read / written from / to sources such as directori
stdin|out or network. Tools may be composed using pipes such that the tools writing
Resource Configuration may be a different tool from the one that read the configuration.
In order for tools to be composed in this way, while preserving origin information --
such as the original file, index, etc.
such as the original file, index, etc.:
Tools **SHOULD** write the following annotations when reading from sources,
and **SHOULD** respect the annotations when writing to sinks.
Tools **SHOULD** insert the following annotations when reading from sources,
and **SHOULD** delete the annotations when writing to sinks.
### ` + "`" + `config.kubernetes.io/path` + "`" + `
Records the slash-delimited, OS-agnostic, relative file path to a Resource.
This annotation **SHOULD** be set when reading Resources from files.
It **SHOULD** be unset when writing Resources to files.
When writing Resources to a directory, the Resource **SHOULD** be written to the corresponding
path relative to that directory.
@@ -313,10 +314,11 @@ Example:
### ` + "`" + `config.kubernetes.io/index` + "`" + `
Records the index of a Resource in file. In a multi-object files YAML file, Resources are separated
Records the index of a Resource in file. In a multi-object YAML file, Resources are separated
by three dashes (` + "`" + `---` + "`" + `), and the index represents the positon of the Resource starting from zero.
This annotation **SHOULD** be set when reading Resources from files.
It **SHOULD** be unset when writing Resources to files.
When writing multiple Resources to the same file, the Resource **SHOULD** be written in the
relative order matching the index.