Merge branch 'main' into fix-emoji

kyverno · Oct 6, 2023 · d09db18 · d09db18
2 parents e8c3f4a + 5d8d376
commit d09db18
Show file tree

Hide file tree

Showing 29 changed files with 1,146 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 .tools
 .gopath
 kyverno-json
+website/site
diff --git a/Makefile b/Makefile
@@ -118,8 +118,19 @@ codegen-jp-docs: ## Generate JP docs
 .PHONY: codegen-docs
 codegen-docs: codegen-api-docs-md codegen-cli-docs codegen-jp-docs ## Generate docs
 
+.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
+	@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
+	@mkdocs build -f ./website/mkdocs.yaml
+
 .PHONY: codegen-all
-codegen-all: codegen-crds codegen-deepcopy codegen-register codegen-docs ## Rebuild all generated code and docs
+codegen-all: codegen-crds codegen-deepcopy codegen-register codegen-docs codegen-mkdocs ## Rebuild all generated code and docs
 
 .PHONY: verify-codegen
 verify-codegen: codegen-all ## Verify all generated code and docs are up to date

diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/website/docs/apis/kyverno-json.v1alpha1.md b/website/docs/apis/kyverno-json.v1alpha1.md
@@ -0,0 +1,359 @@
+---
+title: kyverno-json (v1alpha1)
+content_type: tool-reference
+package: json.kyverno.io/v1alpha1
+auto_generated: true
+---
+<p>Package v1alpha1 contains API Schema definitions for the policy v1alpha1 API group</p>
+
+
+## Resource Types 
+
+
+- [Policy](#json-kyverno-io-v1alpha1-Policy)
+
+
+## `Policy`     {#json-kyverno-io-v1alpha1-Policy}
+
+
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+<tr><td><code>apiVersion</code><br/>string</td><td><code>json.kyverno.io/v1alpha1</code></td></tr>
+<tr><td><code>kind</code><br/>string</td><td><code>Policy</code></td></tr>
+
+
+<tr><td><code>TypeMeta</code> <B>[Required]</B><br/>
+<code>k8s.io/apimachinery/pkg/apis/meta/v1.TypeMeta</code>
+</td>
+<td>(Members of <code>TypeMeta</code> are embedded into this type.)
+   <span class="text-muted">No description provided.</span></td>
+</tr>
+<tr><td><code>metadata</code> <B>[Required]</B><br/>
+<code>k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta</code>
+</td>
+<td>
+   <span class="text-muted">No description provided.</span>Refer to the Kubernetes API documentation for the fields of the <code>metadata</code> field.</td>
+</tr>
+<tr><td><code>spec</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-PolicySpec"><code>PolicySpec</code></a>
+</td>
+<td>
+   <span class="text-muted">No description provided.</span></td>
+</tr>
+</tbody>
+</table>
+
+## `Any`     {#json-kyverno-io-v1alpha1-Any}
+
+
+**Appears in:**
+
+- [ContextEntry](#json-kyverno-io-v1alpha1-ContextEntry)
+
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>Value</code> <B>[Required]</B><br/>
+<code>interface{}</code>
+</td>
+<td>(Members of <code>Value</code> are embedded into this type.)
+   <span class="text-muted">No description provided.</span></td>
+</tr>
+</tbody>
+</table>
+
+## `Assertions`     {#json-kyverno-io-v1alpha1-Assertions}
+
+(Alias of `[]github.com/kyverno/kyverno-json/pkg/apis/v1alpha1.Any`)
+
+**Appears in:**
+
+- [Match](#json-kyverno-io-v1alpha1-Match)
+
+
+
+
+
+## `ContextEntry`     {#json-kyverno-io-v1alpha1-ContextEntry}
+
+
+**Appears in:**
+
+- [Rule](#json-kyverno-io-v1alpha1-Rule)
+
+
+<p>ContextEntry adds variables and data sources to a rule Context.</p>
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>name</code> <B>[Required]</B><br/>
+<code>string</code>
+</td>
+<td>
+   <p>Name is the variable name.</p>
+</td>
+</tr>
+<tr><td><code>variable</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-Any"><code>Any</code></a>
+</td>
+<td>
+   <p>Variable defines an arbitrary JMESPath context variable that can be defined inline.</p>
+</td>
+</tr>
+<tr><td><code>imageRegistry</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-ImageRegistry"><code>ImageRegistry</code></a>
+</td>
+<td>
+   <p>ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.</p>
+</td>
+</tr>
+</tbody>
+</table>
+
+## `ImageRegistry`     {#json-kyverno-io-v1alpha1-ImageRegistry}
+
+
+**Appears in:**
+
+- [ContextEntry](#json-kyverno-io-v1alpha1-ContextEntry)
+
+
+<p>ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image details.</p>
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>reference</code> <B>[Required]</B><br/>
+<code>string</code>
+</td>
+<td>
+   <p>Reference is image reference to a container image in the registry.
+Example: ghcr.io/kyverno/kyverno:latest</p>
+</td>
+</tr>
+<tr><td><code>imageRegistryCredentials</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-ImageRegistryCredentials"><code>ImageRegistryCredentials</code></a>
+</td>
+<td>
+   <p>ImageRegistryCredentials provides credentials that will be used for authentication with registry.</p>
+</td>
+</tr>
+</tbody>
+</table>
+
+## `ImageRegistryCredentials`     {#json-kyverno-io-v1alpha1-ImageRegistryCredentials}
+
+
+**Appears in:**
+
+- [ImageRegistry](#json-kyverno-io-v1alpha1-ImageRegistry)
+
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>allowInsecureRegistry</code> <B>[Required]</B><br/>
+<code>bool</code>
+</td>
+<td>
+   <p>AllowInsecureRegistry allows insecure access to a registry.</p>
+</td>
+</tr>
+<tr><td><code>providers</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-ImageRegistryCredentialsProvider"><code>[]ImageRegistryCredentialsProvider</code></a>
+</td>
+<td>
+   <p>Providers specifies a list of OCI Registry names, whose authentication providers are provided.
+It can be of one of these values: AWS, ACR, GCP, GHCR.</p>
+</td>
+</tr>
+<tr><td><code>secrets</code> <B>[Required]</B><br/>
+<code>[]string</code>
+</td>
+<td>
+   <p>Secrets specifies a list of secrets that are provided for credentials.
+Secrets must live in the Kyverno namespace.</p>
+</td>
+</tr>
+</tbody>
+</table>
+
+## `ImageRegistryCredentialsProvider`     {#json-kyverno-io-v1alpha1-ImageRegistryCredentialsProvider}
+
+(Alias of `string`)
+
+**Appears in:**
+
+- [ImageRegistryCredentials](#json-kyverno-io-v1alpha1-ImageRegistryCredentials)
+
+
+<p>ImageRegistryCredentialsProvider provides the list of credential providers required.</p>
+
+
+
+
+## `Match`     {#json-kyverno-io-v1alpha1-Match}
+
+
+**Appears in:**
+
+- [Rule](#json-kyverno-io-v1alpha1-Rule)
+
+- [Validation](#json-kyverno-io-v1alpha1-Validation)
+
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>any</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-Assertions"><code>Assertions</code></a>
+</td>
+<td>
+   <p>Any allows specifying resources which will be ORed.</p>
+</td>
+</tr>
+<tr><td><code>all</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-Assertions"><code>Assertions</code></a>
+</td>
+<td>
+   <p>All allows specifying resources which will be ANDed.</p>
+</td>
+</tr>
+</tbody>
+</table>
+
+## `PolicySpec`     {#json-kyverno-io-v1alpha1-PolicySpec}
+
+
+**Appears in:**
+
+- [Policy](#json-kyverno-io-v1alpha1-Policy)
+
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>rules</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-Rule"><code>[]Rule</code></a>
+</td>
+<td>
+   <p>Rules is a list of Rule instances. A Policy contains multiple rules and each rule can validate, mutate, or generate resources.</p>
+</td>
+</tr>
+</tbody>
+</table>
+
+## `Rule`     {#json-kyverno-io-v1alpha1-Rule}
+
+
+**Appears in:**
+
+- [PolicySpec](#json-kyverno-io-v1alpha1-PolicySpec)
+
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>name</code> <B>[Required]</B><br/>
+<code>string</code>
+</td>
+<td>
+   <p>Name is a label to identify the rule, It must be unique within the policy.</p>
+</td>
+</tr>
+<tr><td><code>context</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-ContextEntry"><code>[]ContextEntry</code></a>
+</td>
+<td>
+   <p>Context defines variables and data sources that can be used during rule execution.</p>
+</td>
+</tr>
+<tr><td><code>match</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-Match"><code>Match</code></a>
+</td>
+<td>
+   <p>Match defines when this policy rule should be applied. The match
+criteria can include resource information (e.g. kind, name, namespace, labels)
+and admission review request information like the user name or role.
+At least one kind is required.</p>
+</td>
+</tr>
+<tr><td><code>exclude</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-Match"><code>Match</code></a>
+</td>
+<td>
+   <p>Exclude defines when this policy rule should not be applied. The exclude
+criteria can include resource information (e.g. kind, name, namespace, labels)
+and admission review request information like the name or role.</p>
+</td>
+</tr>
+<tr><td><code>validate</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-Validation"><code>Validation</code></a>
+</td>
+<td>
+   <p>Validation is used to validate matching resources.</p>
+</td>
+</tr>
+</tbody>
+</table>
+
+## `Validation`     {#json-kyverno-io-v1alpha1-Validation}
+
+
+**Appears in:**
+
+- [Rule](#json-kyverno-io-v1alpha1-Rule)
+
+
+<p>Validation defines checks to be performed on matching resources.</p>
+
+
+<table class="table">
+<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
+<tbody>
+
+
+<tr><td><code>message</code> <B>[Required]</B><br/>
+<code>string</code>
+</td>
+<td>
+   <p>Message specifies a custom message to be displayed on failure.</p>
+</td>
+</tr>
+<tr><td><code>assert</code> <B>[Required]</B><br/>
+<a href="#json-kyverno-io-v1alpha1-Match"><code>Match</code></a>
+</td>
+<td>
+   <p>Assert specifies an overlay-style pattern used to check resources.</p>
+</td>
+</tr>
+</tbody>
+</table>
+
diff --git a/website/docs/blog/index.md b/website/docs/blog/index.md
@@ -0,0 +1,3 @@
+# Blog
+
+TODO
diff --git a/website/docs/catalog/index.md b/website/docs/catalog/index.md
@@ -0,0 +1,3 @@
+# Policy catalog
+
+TODO