Merge branch 'main' into add_dockerfile_sample

kyverno · Oct 10, 2023 · 8da04c1 · 8da04c1
2 parents 792bd01 + 88cbfdf
commit 8da04c1
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 39 deletions.
diff --git a/Makefile b/Makefile
@@ -150,9 +150,9 @@ codegen-docs: codegen-api-docs-md codegen-cli-docs codegen-jp-docs ## Generate d
 .PHONY: codegen-mkdocs
 codegen-mkdocs: codegen-docs ## Generate mkdocs website
 	@echo Generate mkdocs website... >&2
-	@pip3 install mkdocs
-	@pip3 install --upgrade pip
-	@pip3 install -U mkdocs-material mkdocs-redirects mkdocs-minify-plugin mkdocs-include-markdown-plugin lunr mkdocs-rss-plugin
+	@pip install mkdocs
+	@pip install --upgrade pip
+	@pip install -U mkdocs-material mkdocs-redirects mkdocs-minify-plugin mkdocs-include-markdown-plugin lunr mkdocs-rss-plugin
 	@rm -rf ./website/docs/apis && mkdir -p ./website/docs/apis && cp docs/user/apis/md/* ./website/docs/apis
 	@rm -rf ./website/docs/commands && mkdir -p ./website/docs/commands && cp docs/user/commands/* ./website/docs/commands
 	@rm -rf ./website/docs/jp && mkdir -p ./website/docs/jp && cp docs/user/jp/* ./website/docs/jp

diff --git a/README.md b/README.md
@@ -330,7 +330,7 @@ foo:
 ```
 
 Here the `(bar)` key conflict with the projection syntax used.
-To workaround this issue, you can escape a projection by surrounding it with `/` characters like this:
+To workaround this issue, you can escape a projection by surrounding it with `\` characters like this:
 
 ```yaml
 apiVersion: json.kyverno.io/v1alpha1
@@ -344,17 +344,17 @@ spec:
         assert:
           all:
           - foo:
-              /(bar)/: 10
+              \(bar)\: 10
 ```
 
-In this case, the leading and trailing `/` characters will be erased and the projection won't be applied.
+In this case, the leading and trailing `\` characters will be erased and the projection won't be applied.
 
 Note that it's still possible to use the `~` modifier or to create a named binding with and escaped projection.
 
 Keys like this are perfectly valid:
-- `~index./baz/`
-- `/baz/@foo`
-- `~index./baz/@foo`
+- `~index.\baz\`
+- `\baz\@foo`
+- `~index.\baz\@foo`
 
 ## SDK
 

diff --git a/pkg/engine/assert/expression.go b/pkg/engine/assert/expression.go
@@ -11,7 +11,7 @@ import (
 var (
 	foreachRegex = regexp.MustCompile(`^~(\w+)?\.(.*)`)
 	bindingRegex = regexp.MustCompile(`(.*)@(\w+)$`)
-	escapeRegex  = regexp.MustCompile(`^/(.+)/$`)
+	escapeRegex  = regexp.MustCompile(`^\\(.+)\\$`)
 	engineRegex  = regexp.MustCompile(`^\((?:(\w+):)?(.+)\)$`)
 )
 

diff --git a/pkg/engine/assert/expression_test.go b/pkg/engine/assert/expression_test.go
@@ -115,7 +115,7 @@ func Test_parseExpressionRegex(t *testing.T) {
 		},
 	}, {
 		name: "escape",
-		in:   "/~(test)@foo/",
+		in:   `\~(test)@foo\`,
 		want: &expression{
 			foreach:     false,
 			foreachName: "",
@@ -124,7 +124,7 @@ func Test_parseExpressionRegex(t *testing.T) {
 		},
 	}, {
 		name: "escape",
-		in:   "/test/",
+		in:   `\test\`,
 		want: &expression{
 			foreach:     false,
 			foreachName: "",
@@ -133,7 +133,7 @@ func Test_parseExpressionRegex(t *testing.T) {
 		},
 	}, {
 		name: "escape",
-		in:   "/(test)/",
+		in:   `\(test)\`,
 		want: &expression{
 			foreach:     false,
 			foreachName: "",
@@ -142,7 +142,7 @@ func Test_parseExpressionRegex(t *testing.T) {
 		},
 	}, {
 		name: "escape",
-		in:   "//test//",
+		in:   `\/test/\`,
 		want: &expression{
 			foreach:     false,
 			foreachName: "",
@@ -151,7 +151,7 @@ func Test_parseExpressionRegex(t *testing.T) {
 		},
 	}, {
 		name: "escape",
-		in:   "~index./(test)/",
+		in:   `~index.\(test)\`,
 		want: &expression{
 			foreach:     true,
 			foreachName: "index",
@@ -160,7 +160,7 @@ func Test_parseExpressionRegex(t *testing.T) {
 		},
 	}, {
 		name: "escape",
-		in:   "~index./(test)/@name",
+		in:   `~index.\(test)\@name`,
 		want: &expression{
 			foreach:     true,
 			foreachName: "index",

diff --git a/testdata/escaped/policy.yaml b/testdata/escaped/policy.yaml
@@ -9,17 +9,17 @@ spec:
         assert:
           all:
           - foo:
-              /(bar)/: 4
+              \(bar)\: 4
           - foo:
-              /(bar)/@test:
+              \(bar)\@test:
                 ($test): 4
           - foo:
-              /(bar)@test/: 6
+              \(bar)@test\: 6
           - foo:
-              /(bar)@test/@test:
+              \(bar)@test\@test:
                 ($test): 6
           - foo:
-              /~foos/:
+              \~foos\:
               - 1
               - 2
               - 3
diff --git a/website/docs/policies/escaping.md b/website/docs/policies/escaping.md
@@ -14,7 +14,7 @@ foo:
 ```
 
 Here the `(bar)` key conflict with the projection syntax.
-To workaround this situation, you can escape a projection by surrounding it with `/` characters like this:
+To workaround this situation, you can escape a projection by surrounding it with `\` characters like this:
 
 ```yaml
 apiVersion: json.kyverno.io/v1alpha1
@@ -28,15 +28,15 @@ spec:
         assert:
           all:
           - foo:
-              /(bar)/: 10
+              \(bar)\: 10
 ```
 
-In this case, the leading and trailing `/` characters will be erased and the projection won't be applied.
+In this case, the leading and trailing `\` characters will be erased and the projection won't be applied.
 
 Note that it's still possible to use the `~` modifier or to create a named binding with and escaped projection.
 
 Keys like this are perfectly valid:
 
-- `~index./baz/`
-- `/baz/@foo`
-- `~index./baz/@foo`
+- `~index.\baz\`
+- `\baz\@foo`
+- `~index.\baz\@foo`
diff --git a/website/mkdocs.yaml b/website/mkdocs.yaml
@@ -24,6 +24,17 @@ theme:
   favicon: static/favicon.ico
   include_search_page: false
   search_index_only: true
+  features:
+  - announce.dismiss
+  - search.suggest
+  - search.highlight
+  - search.share
+  - content.code.copy
+  - content.action.edit
+  - navigation.footer
+  - navigation.instant
+  - navigation.tracking
+  - navigation.tabs
   palette:
   - media: "(prefers-color-scheme: light)" # Light mode
     scheme: default
@@ -37,17 +48,6 @@ theme:
     toggle:
       icon: material/lightbulb
       name: Switch to dark mode
-  features:
-  - announce.dismiss
-  - search.suggest
-  - search.highlight
-  - search.share
-  - content.code.copy
-  - content.action.edit
-  - navigation.footer
-  - navigation.instant
-  - navigation.tracking
-  - navigation.tabs
 
 plugins:
 - search
@@ -67,7 +67,8 @@ plugins:
 - minify:
     minify_html: true
 - include-markdown
-- tags
+- tags:
+    enabled: true
 - blog:
     post_url_format: "{slug}"