-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
- Loading branch information
1 parent
bf1322d
commit 4e06f72
Showing
11 changed files
with
308 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| hiddenMemberFields: | ||
| - TypeMeta | ||
|
|
||
| hideTypePatterns: | ||
| - ParseError$ | ||
| - List$ | ||
|
|
||
| externalPackages: | ||
| - match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.Duration$ | ||
| target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration | ||
| - match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.GroupVersionKind$ | ||
| target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionKind | ||
| - match: ^k8s\.io/apimachinery/pkg/apis/meta/v1\.GroupVersionResource$ | ||
| target: https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#GroupVersionResource | ||
| - match: ^k8s\.io/apimachinery/pkg/types\.UID$ | ||
| target: https://pkg.go.dev/k8s.io/apimachinery/pkg/types#UID | ||
| - match: ^k8s\.io/apimachinery/pkg/runtime\.RawExtension$ | ||
| target: https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime/#RawExtension | ||
| - match: ^k8s\.io/apimachinery/pkg/api/resource\.QuantityValue$ | ||
| target: https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#QuantityValue | ||
| - match: ^k8s\.io/apimachinery/pkg/api/resource\.Quantity$ | ||
| target: https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity | ||
| - match: ^k8s\.io/apimachinery/pkg/runtime\.Unknown$ | ||
| target: https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#Unknown | ||
| - match: ^time\.Duration$ | ||
| target: https://pkg.go.dev/time#Duration | ||
| - match: ^io.Writer$ | ||
| target: https://pkg.go.dev/io#Writer | ||
| - match: ^k8s\.io/(api|apimachinery/pkg/apis)/ | ||
| target: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#{{- lower .TypeIdentifier -}}-{{- arrIndex .PackageSegments -1 -}}-{{- arrIndex .PackageSegments -2 -}} | ||
|
|
||
| markdownDisabled: false | ||
|
|
||
| stripPrefix: | ||
| - k8s.io/api/ | ||
| - k8s.io/apimachinery/pkg/apis/ | ||
| - github.com/kyverno/kyverno-json/pkg/apis/ | ||
| - github.com/tengqm/kubeconfig/config/kubeadm/v1beta2. | ||
| - github.com/tengqm/kubeconfig/config/kubeadm/v1beta3. | ||
| - github.com/tengqm/kubeconfig/config/bootstraptoken/v1. | ||
|
|
||
| apis: | ||
| - name: policy | ||
| title: policy (v1alpha1) | ||
| package: github.com/kyverno/kyverno-envoy-plugin | ||
| path: apis/v1alpha1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| {{- define "comment" -}} | ||
| {{- $comment := "" -}} | ||
| {{- range . -}} | ||
| {{- if . -}} | ||
| {{- if not (eq (index . 0) '+') -}} | ||
| {{- if $comment -}} | ||
| {{- $comment = print $comment " " . -}} | ||
| {{- else -}} | ||
| {{- $comment = . -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
| {{- if $comment -}} | ||
| <p>{{ $comment }}</p> | ||
| {{- else -}} | ||
| *No description provided.* | ||
| {{- end -}} | ||
| {{- end -}} | ||
|
|
||
| {{- define "typ" -}} | ||
| {{- if .Link -}} | ||
| [`{{ .DisplayName }}`]({{ .Link }}) | ||
| {{- else -}} | ||
| `{{ .DisplayName }}` | ||
| {{- end -}} | ||
| {{- end -}} | ||
|
|
||
| {{- define "members" }} | ||
| {{- range .GetMembers }} | ||
| {{- if not .Hidden }} | ||
| {{- $name := .FieldName }} | ||
| {{- $optional := .IsOptional }} | ||
| {{- $type := .GetType }} | ||
| {{- $inline := .IsInline }} | ||
| {{- $comment := .GetComment }} | ||
| | `{{ $name }}` | {{ template "typ" $type }} | {{ if not $optional }}:white_check_mark:{{ end }} | {{ if $inline }}:white_check_mark:{{ end }} | {{ template "comment" .CommentLines }} | | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| {{ define "packages" -}} | ||
|
|
||
| {{- range $idx, $val := .packages -}} | ||
| {{/* Special handling for kubeconfig */}} | ||
| {{- if eq .Title "kubeconfig (v1)" -}} | ||
| --- | ||
| title: {{ .Title }} | ||
| content_type: tool-reference | ||
| package: v1 | ||
| auto_generated: true | ||
| --- | ||
| {{- else -}} | ||
| {{- if and .IsMain (ne .GroupName "") -}} | ||
| --- | ||
| title: {{ .Title }} | ||
| content_type: tool-reference | ||
| package: {{ .DisplayName }} | ||
| auto_generated: true | ||
| --- | ||
| {{ .GetComment -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
| {{- end }} | ||
|
|
||
| ## Resource Types | ||
|
|
||
| {{ range .packages -}} | ||
| {{- range .VisibleTypes -}} | ||
| {{- if .IsExported }} | ||
| - [{{ .DisplayName }}]({{ .Link }}) | ||
| {{- end -}} | ||
| {{- end -}} | ||
| {{- end -}} | ||
|
|
||
| {{ range .packages }} | ||
| {{ if ne .GroupName "" -}} | ||
| {{/* For package with a group name, list all type definitions in it. */}} | ||
| {{- range .VisibleTypes }} | ||
| {{- if or .Referenced .IsExported -}} | ||
| {{ template "type" . }} | ||
| {{- end -}} | ||
| {{ end }} | ||
| {{ else }} | ||
| {{/* For package w/o group name, list only types referenced. */}} | ||
| {{ $pkgTitle := .Title }} | ||
| {{- range .VisibleTypes -}} | ||
| {{- if or .Referenced (eq $pkgTitle "kubeconfig (v1)") -}} | ||
| {{ template "type" . }} | ||
| {{- end -}} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| {{- define "type" }} | ||
| ## {{ .Name.Name }} {#{{ .Anchor }}} | ||
| {{- if eq .Kind "Alias" }} | ||
|
|
||
| (Alias of `{{ .Underlying }}`) | ||
| {{- end }} | ||
| {{- with .References }} | ||
|
|
||
| **Appears in:** | ||
| {{ range . }} | ||
| {{- if or .Referenced .IsExported }} | ||
| - [{{ .DisplayName }}]({{ .Link }}) | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- if .GetComment }} | ||
|
|
||
| {{ .GetComment }} | ||
| {{- end }} | ||
| {{- if .GetMembers }} | ||
|
|
||
| | Field | Type | Required | Inline | Description | | ||
| |---|---|---|---|---| | ||
| {{- /* . is a apiType */}} | ||
| {{- if .IsExported }} | ||
| {{- /* Add apiVersion and kind rows if deemed necessary */}} | ||
| | `apiVersion` | `string` | :white_check_mark: | | `{{- .APIGroup -}}` | | ||
| | `kind` | `string` | :white_check_mark: | | `{{- .Name.Name -}}` | | ||
| {{- end }} | ||
| {{- /* The actual list of members is in the following template */}} | ||
| {{- template "members" . }} | ||
| {{- end }} | ||
| {{ end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: policy (v1alpha1) | ||
| content_type: tool-reference | ||
| package: envoy.kyverno.io/v1alpha1 | ||
| auto_generated: true | ||
| --- | ||
|
|
||
|
|
||
| ## Resource Types | ||
|
|
||
|
|
||
| - [AuthorizationPolicy](#envoy-kyverno-io-v1alpha1-AuthorizationPolicy) | ||
|
|
||
| ## AuthorizationPolicy {#envoy-kyverno-io-v1alpha1-AuthorizationPolicy} | ||
|
|
||
| <p>AuthorizationPolicy defines an authorization policy resource</p> | ||
|
|
||
|
|
||
| | Field | Type | Required | Inline | Description | | ||
| |---|---|---|---|---| | ||
| | `apiVersion` | `string` | :white_check_mark: | | `envoy.kyverno.io/v1alpha1` | | ||
| | `kind` | `string` | :white_check_mark: | | `AuthorizationPolicy` | | ||
| | `metadata` | [`meta/v1.ObjectMeta`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta) | :white_check_mark: | | *No description provided.* | | ||
| | `spec` | [`AuthorizationPolicySpec`](#envoy-kyverno-io-v1alpha1-AuthorizationPolicySpec) | :white_check_mark: | | *No description provided.* | | ||
|
|
||
| ## Authorization {#envoy-kyverno-io-v1alpha1-Authorization} | ||
|
|
||
| **Appears in:** | ||
|
|
||
| - [AuthorizationPolicySpec](#envoy-kyverno-io-v1alpha1-AuthorizationPolicySpec) | ||
|
|
||
| <p>Authorization defines an authorization policy rule</p> | ||
|
|
||
|
|
||
| | Field | Type | Required | Inline | Description | | ||
| |---|---|---|---|---| | ||
| | `expression` | `string` | :white_check_mark: | | <p>Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to CEL variables as well as some other useful variables: - 'object' - The object from the incoming request. (https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto#service-auth-v3-checkrequest) CEL expressions are expected to return an envoy CheckResponse (https://www.envoyproxy.io/docs/envoy/latest/api-v3/service/auth/v3/external_auth.proto#service-auth-v3-checkresponse).</p> | | ||
|
|
||
| ## AuthorizationPolicySpec {#envoy-kyverno-io-v1alpha1-AuthorizationPolicySpec} | ||
|
|
||
| **Appears in:** | ||
|
|
||
| - [AuthorizationPolicy](#envoy-kyverno-io-v1alpha1-AuthorizationPolicy) | ||
|
|
||
| <p>AuthorizationPolicySpec defines the spec of an authorization policy</p> | ||
|
|
||
|
|
||
| | Field | Type | Required | Inline | Description | | ||
| |---|---|---|---|---| | ||
| | `failurePolicy` | [`admissionregistration/v1.FailurePolicyType`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#failurepolicytype-v1-admissionregistration) | | | <p>FailurePolicy defines how to handle failures for the policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy definitions. FailurePolicy does not define how validations that evaluate to false are handled. Allowed values are Ignore or Fail. Defaults to Fail.</p> | | ||
| | `variables` | [`[]admissionregistration/v1.Variable`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#variable-v1-admissionregistration) | | | <p>Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under `variables` in other expressions of the policy except MatchConditions because MatchConditions are evaluated before the rest of the policy. The expression of a variable can refer to other variables defined earlier in the list but not those after. Thus, Variables must be sorted by the order of first appearance and acyclic.</p> | | ||
| | `authorizations` | [`[]Authorization`](#envoy-kyverno-io-v1alpha1-Authorization) | | | <p>Authorizations contain CEL expressions which is used to apply the authorization.</p> | | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Reference documentation | ||
|
|
||
| !!! info | ||
| Select an item in the navigation menu to browse a specific page. |
Oops, something went wrong.