From de6fa9fd19b25495231c6f317455ede08df6982a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Fri, 11 Mar 2022 15:32:59 +0100 Subject: [PATCH] fix: generate api reference docs (#3377) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- Makefile | 20 +- docs/crd/v1/index.html | 1790 ++++++---------------------------- docs/crd/v1alpha1/index.html | 203 ++++ docs/crd/v1alpha2/index.html | 203 ++++ 4 files changed, 732 insertions(+), 1484 deletions(-) create mode 100644 docs/crd/v1alpha1/index.html create mode 100644 docs/crd/v1alpha2/index.html diff --git a/Makefile b/Makefile index c7c2d9d2dc..c4dfdb2a93 100644 --- a/Makefile +++ b/Makefile @@ -144,9 +144,25 @@ docker-get-kyverno-digest-dev: # Generate Docs for types.go ################################## -generate-api-docs: - go run gen-crd-api-reference-docs -api-dir ./api -config docs/config.json -template-dir docs/template -out-file docs/crd/v1/index.html +.PHONY: gen-crd-api-reference-docs +gen-crd-api-reference-docs: ## Install gen-crd-api-reference-docs + go install github.com/ahmetb/gen-crd-api-reference-docs@latest +.PHONY: gen-crd-api-reference-docs +generate-api-docs: gen-crd-api-reference-docs ## Generate api reference docs + rm -rf docs/crd + mkdir docs/crd + gen-crd-api-reference-docs -v 6 -api-dir ./api/kyverno/v1alpha1 -config docs/config.json -template-dir docs/template -out-file docs/crd/v1alpha1/index.html + gen-crd-api-reference-docs -v 6 -api-dir ./api/kyverno/v1alpha2 -config docs/config.json -template-dir docs/template -out-file docs/crd/v1alpha2/index.html + gen-crd-api-reference-docs -v 6 -api-dir ./api/kyverno/v1 -config docs/config.json -template-dir docs/template -out-file docs/crd/v1/index.html + +.PHONY: verify-api-docs +verify-api-docs: generate-api-docs ## Check api reference docs are up to date + git add --all + git diff docs + @echo 'If this test fails, it is because the git diff is non-empty after running "make generate-api-docs".' + @echo 'To correct this, locally run "make generate-api-docs", commit the changes, and re-run tests.' + git diff --quiet --exit-code docs ################################## # CLI diff --git a/docs/crd/v1/index.html b/docs/crd/v1/index.html index e9af06927e..cad25877c6 100644 --- a/docs/crd/v1/index.html +++ b/docs/crd/v1/index.html @@ -20,18 +20,6 @@ background-color: #1589dd;
  • kyverno.io/v1
    • -
  • -kyverno.io/v1alpha1 -
    • -
  • -kyverno.io/v1alpha2 -
    • -
  • -wgpolicyk8s.io/v1alpha1 -
    • -
  • -wgpolicyk8s.io/v1alpha2 -

    • kyverno.io/v1

    @@ -138,7 +126,6 @@ Kubernetes admission/v1beta1.Operation

    (Appears on: -Attestation, ForEachMutation, ForEachValidation)

    @@ -195,10 +182,6 @@ Here, all of the conditions need to pass

    Attestation

    -(Appears on: -ImageVerification) -

    -

    Attestation are checks for signed in-toto Statements that are used to verify the image. See https://github.com/in-toto/attestation. Kyverno fetches signed attestations from the OCI registry and decodes them into a list of Statements.

    @@ -226,8 +209,8 @@ string conditions
    - -[]AnyAllConditions + +[]*./api/kyverno/v1.AnyAllConditions @@ -240,6 +223,61 @@ the attestation check is satisfied as long there are predicates that match the p
    +

    AutogenStatus +

    +

    +(Appears on: +PolicyStatus) +

    +

    +

    AutogenStatus contains autogen status information. +It indicates requested, supported and effective autogen controllers used when +automatically generating rules.

    +

    + + + + + + + + + + + + + + + + + + + + + +
    FieldDescription
    +requested
    + +[]string + +    		 +

    Requested indicates the autogen requested controllers

    +
    +supported
    + +[]string + +    		 +

    Supported indicates the autogen supported controllers

    +
    +activated
    + +[]string + +    		 +

    Activated indicates the autogen activated controllers

    +
    +

    CloneFrom

    @@ -371,6 +409,21 @@ and report an error in a policy report. Optional. The default value is “au +validationFailureActionOverrides
    + + +[]ValidationFailureActionOverride + + + + +(Optional) +

    ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction +namespace-wise. It overrides ValidationFailureAction for the specified namespaces.

    + + + + background
    bool @@ -450,7 +503,7 @@ PolicyStatus key
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON @@ -467,15 +520,17 @@ ConditionOperator     -

    Operator is the operation to perform. Valid operators -are Equals, NotEquals, In, AnyIn, AllIn and NotIn, AnyNotIn, AllNotIn.

    +

    Operator is the conditional operation to perform. Valid operators are: +Equals, NotEquals, In, AnyIn, AllIn, NotIn, AnyNotIn, AllNotIn, GreaterThanOrEquals, +GreaterThan, LessThanOrEquals, LessThan, DurationGreaterThanOrEquals, DurationGreaterThan, +DurationLessThanOrEquals, DurationLessThan

    value
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON @@ -596,6 +651,20 @@ APICall data retrieved is stored in the context.

    + + +imageRegistry
    + + +ImageRegistry + + + + +

    ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image +details.

    + +
    @@ -621,7 +690,7 @@ data retrieved is stored in the context.

    conditions
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON @@ -727,11 +796,7 @@ Please specify under “any” or “all” instead.

    ForEachMutation

    -(Appears on: -Mutation) -

    -

    -

    ForEachMutation applies policy rule changes to nested elements.

    +

    ForEach applies mutation rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.

    @@ -787,7 +852,7 @@ See: https://k + + + +
    patchStrategicMerge
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON     		@@ -797,17 +862,26 @@ See https://kubectl.docs.kubernetes.io/references/kustomize/patchesstrategicmerge/.
    +patchesJson6902
    + +string + +    		 +(Optional) +

    PatchesJSON6902 is a list of RFC 6902 JSON Patch declarations used to modify resources. +See https://tools.ietf.org/html/rfc6902 and https://kubectl.docs.kubernetes.io/references/kustomize/patchesjson6902/.

    +

    ForEachValidation

    -(Appears on: -Validation) -

    -

    -

    ForEachValidation applies policy rule checks to nested elements.

    +

    ForEach applies validate rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.

    @@ -831,6 +905,20 @@ to which the validation logic is applied.

    + + + +
    +elementScope
    + +bool + +    		 +(Optional) +

    ElementScope specifies whether to use the current list element as the scope for validation. Defaults to “true” if not specified. +When set to “false”, “request.object” is used as the validation scope within the foreach +block to allow referencing other elements in the subtree.

    +
    context
    @@ -863,7 +951,7 @@ See: https://k     		pattern
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON     		@@ -875,7 +963,7 @@ k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON anyPattern
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON     		@@ -1219,7 +1307,7 @@ Optional. Defaults to “false” if not specified.

    		 data
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON     		@@ -1248,13 +1336,56 @@ resource will be created with default data only.

    -

    ImageVerification +

    ImageRegistry

    (Appears on: -Rule) +ContextEntry)

    +

    ImageRegistry defines requests to an OCI/Docker V2 registry to fetch image +details.

    +

    + + + + + + + + + + + + + + + + + +
    FieldDescription
    +reference
    + +string + +    		 +

    Reference is image reference to a container image in the registry. +Example: ghcr.io/kyverno/kyverno:latest

    +
    +jmesPath
    + +string + +    		 +(Optional) +

    JMESPath is an optional JSON Match Expression that can be used to +transform the ImageData struct returned as a result of processing +the image reference.

    +
    +
    +

    ImageVerification +

    +

    ImageVerification validates that images that match the specified pattern are signed with the supplied public key. Once the image is verified it is mutated to include the SHA digest retrieved during the registration.

    @@ -1314,6 +1445,30 @@ string +issuer
    + +string + + + +

    Issuer is the certificate issuer used for keyless signing.

    + + + + +annotations
    + +map[string]string + + + +

    Annotations are used for image verification. +Every specified key-value pair must exist and match in the verified payload. +The payload may contain other key-value pairs.

    + + + + repository
    string @@ -1328,8 +1483,8 @@ If specified Repository will override the default OCI image repository configure attestations
    - -[]Attestation + +[]*./api/kyverno/v1.Attestation @@ -1443,39 +1598,9 @@ Please specify under “any” or “all” instead.

    -overlay
    - -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON - - - -(Optional) -

    Overlay specifies an overlay pattern to modify resources. -DEPRECATED. Use PatchStrategicMerge instead. Scheduled for -removal in release 1.5+.

    - - - - -patches
    - - -[]Patch - - - - -(Optional) -

    Patches specifies a RFC 6902 JSON Patch to modify resources. -DEPRECATED. Use PatchesJSON6902 instead. Scheduled for -removal in release 1.5+.

    - - - - patchStrategicMerge
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON @@ -1502,70 +1627,14 @@ See https://tools.ietf.org/html/rf foreach
    -     -[]ForEachMutation + +[]*./api/kyverno/v1.ForEachMutation (Optional) -

    ForEachMutation applies policy rule changes to nested elements.

    - - - - -
    -

    Patch -

    -

    -(Appears on: -Mutation) -

    -

    -

    Patch is a RFC 6902 JSON Patch. -See: https://tools.ietf.org/html/rfc6902

    -

    - - - - - - - - - - - - - - - - - - - @@ -1659,6 +1728,21 @@ and report an error in a policy report. Optional. The default value is “au + + + + + + + + + + + +
    FieldDescription
    -path
    - -string - -    		 -

    Path specifies path of the resource.

    -
    -op
    - -string - -    		 -

    Operation specifies operations supported by JSON Patch. -i.e:- add, replace and delete.

    -
    -value
    - -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON - -    		 -(Optional) -

    Value specifies the value to be applied.

    +

    ForEach applies mutation rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.
    +validationFailureActionOverrides
    + + +[]ValidationFailureActionOverride + + +    		 +(Optional) +

    ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction +namespace-wise. It overrides ValidationFailureAction for the specified namespaces.

    +
    background
    bool @@ -1749,6 +1833,34 @@ bool

    Ready indicates if the policy is ready to serve the admission request
    +autogen
    + + +AutogenStatus + + +    		 +(Optional) +

    Autogen contains autogen status information

    +
    +rules
    + + +[]Rule + + +    		 +

    Rules is a list of Rule instances. It contains original rules defined in the spec +auto generated rules added for pod controllers

    +
    @@ -1977,7 +2089,7 @@ ResourceDescription

    ResourceFilters -([]github.com/kyverno/kyverno/api/kyverno/v1.ResourceFilter alias)

    +([]./api/kyverno/v1.ResourceFilter alias)

    (Appears on: ExcludeResources, @@ -2058,6 +2170,7 @@ string

    (Appears on: +PolicyStatus, Spec)

    @@ -2134,7 +2247,7 @@ and admission review request information like the name or role.

    preconditions
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON @@ -2192,8 +2305,8 @@ Generation verifyImages
    - -[]ImageVerification + +[]*./api/kyverno/v1.ImageVerification @@ -2269,6 +2382,21 @@ and report an error in a policy report. Optional. The default value is “au +validationFailureActionOverrides
    + + +[]ValidationFailureActionOverride + + + + +(Optional) +

    ValidationFailureActionOverrides is a Cluster Policy attribute that specifies ValidationFailureAction +namespace-wise. It overrides ValidationFailureAction for the specified namespaces.

    + + + + background
    bool @@ -2403,21 +2531,21 @@ string foreach
    - -[]ForEachValidation + +[]*./api/kyverno/v1.ForEachValidation (Optional) -

    ForEach applies policy rule changes to nested elements.

    +

    ForEach applies validate rules to a list of sub-elements by creating a context for each entry in the list and looping over it to apply the specified logic.

    pattern
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON @@ -2429,7 +2557,7 @@ k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON anyPattern
    -k8s.io/apiextensions-apiserver/pkg/apis/apiextensions.JSON +k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON @@ -2455,6 +2583,45 @@ Deny
    +

    ValidationFailureActionOverride +

    +

    +(Appears on: +Spec) +

    +

    +

    + + + + + + + + + + + + + + + + + +
    FieldDescription
    +action
    + +string + +    		 +
    +namespaces
    + +[]string + +    		 +
    +

    ViolatedRule

    @@ -2516,1347 +2683,6 @@ string

    -

    kyverno.io/v1alpha1

    -

    -

    Package v1alpha1 contains API Schema definitions for the policy v1alpha1 API group

    -

    -Resource Types: -
      -
      -

      ClusterReportChangeRequest -

      -

      -

      ClusterReportChangeRequest is the Schema for the ClusterReportChangeRequests API

      -

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      FieldDescription
      -metadata
      - - -Kubernetes meta/v1.ObjectMeta - - -      		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
      -scope
      - - -Kubernetes core/v1.ObjectReference - - -      		 -(Optional) -

      Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

      -
      -scopeSelector
      - - -Kubernetes meta/v1.LabelSelector - - -      		 -(Optional) -

      ScopeSelector is an optional selector for multiple scopes (e.g. Pods). -Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

      -
      -summary
      - - -PolicyReportSummary - - -      		 -(Optional) -

      PolicyReportSummary provides a summary of results

      -
      -results
      - - -[]PolicyReportResult - - -      		 -(Optional) -

      PolicyReportResult provides result details

      -
      -
      -

      ReportChangeRequest -

      -

      -

      ReportChangeRequest is the Schema for the ReportChangeRequests API

      -

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      FieldDescription
      -metadata
      - - -Kubernetes meta/v1.ObjectMeta - - -      		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
      -scope
      - - -Kubernetes core/v1.ObjectReference - - -      		 -(Optional) -

      Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

      -
      -scopeSelector
      - - -Kubernetes meta/v1.LabelSelector - - -      		 -(Optional) -

      ScopeSelector is an optional selector for multiple scopes (e.g. Pods). -Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

      -
      -summary
      - - -PolicyReportSummary - - -      		 -(Optional) -

      PolicyReportSummary provides a summary of results

      -
      -results
      - - -[]PolicyReportResult - - -      		 -(Optional) -

      PolicyReportResult provides result details

      -
      -
      -

      kyverno.io/v1alpha2

      -

      -

      Package v1alpha2 contains API Schema definitions for the policy v1alpha2 API group

      -

      -Resource Types: -
        -
        -

        ClusterReportChangeRequest -

        -

        -

        ClusterReportChangeRequest is the Schema for the ClusterReportChangeRequests API

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -metadata
        - - -Kubernetes meta/v1.ObjectMeta - - -        		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
        -scope
        - - -Kubernetes core/v1.ObjectReference - - -        		 -(Optional) -

        Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

        -
        -scopeSelector
        - - -Kubernetes meta/v1.LabelSelector - - -        		 -(Optional) -

        ScopeSelector is an optional selector for multiple scopes (e.g. Pods). -Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

        -
        -summary
        - - -PolicyReportSummary - - -        		 -(Optional) -

        PolicyReportSummary provides a summary of results

        -
        -results
        - - -[]PolicyReportResult - - -        		 -(Optional) -

        PolicyReportResult provides result details

        -
        -
        -

        ReportChangeRequest -

        -

        -

        ReportChangeRequest is the Schema for the ReportChangeRequests API

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -metadata
        - - -Kubernetes meta/v1.ObjectMeta - - -        		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
        -scope
        - - -Kubernetes core/v1.ObjectReference - - -        		 -(Optional) -

        Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

        -
        -scopeSelector
        - - -Kubernetes meta/v1.LabelSelector - - -        		 -(Optional) -

        ScopeSelector is an optional selector for multiple scopes (e.g. Pods). -Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

        -
        -summary
        - - -PolicyReportSummary - - -        		 -(Optional) -

        PolicyReportSummary provides a summary of results

        -
        -results
        - - -[]PolicyReportResult - - -        		 -(Optional) -

        PolicyReportResult provides result details

        -
        -
        -

        wgpolicyk8s.io/v1alpha1

        -

        -

        Package v1alpha1 contains API Schema definitions for the policy v1alpha1 API group

        -

        -Resource Types: - -
        -

        ClusterPolicyReport -

        -

        -

        ClusterPolicyReport is the Schema for the clusterpolicyreports API

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -apiVersion
        -string        		 - -wgpolicyk8s.io/v1alpha1 - -
        -kind
        -string -        		ClusterPolicyReport
        -metadata
        - - -Kubernetes meta/v1.ObjectMeta - - -        		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
        -scope
        - - -Kubernetes core/v1.ObjectReference - - -        		 -(Optional) -

        Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

        -
        -scopeSelector
        - - -Kubernetes meta/v1.LabelSelector - - -        		 -(Optional) -

        ScopeSelector is an optional selector for multiple scopes (e.g. Pods). -Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

        -
        -summary
        - - -PolicyReportSummary - - -        		 -(Optional) -

        PolicyReportSummary provides a summary of results

        -
        -results
        - - -[]PolicyReportResult - - -        		 -(Optional) -

        PolicyReportResult provides result details

        -
        -
        -

        PolicyReport -

        -

        -

        PolicyReport is the Schema for the policyreports API

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -apiVersion
        -string        		 - -wgpolicyk8s.io/v1alpha1 - -
        -kind
        -string -        		PolicyReport
        -metadata
        - - -Kubernetes meta/v1.ObjectMeta - - -        		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
        -scope
        - - -Kubernetes core/v1.ObjectReference - - -        		 -(Optional) -

        Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

        -
        -scopeSelector
        - - -Kubernetes meta/v1.LabelSelector - - -        		 -(Optional) -

        ScopeSelector is an optional selector for multiple scopes (e.g. Pods). -Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

        -
        -summary
        - - -PolicyReportSummary - - -        		 -(Optional) -

        PolicyReportSummary provides a summary of results

        -
        -results
        - - -[]PolicyReportResult - - -        		 -(Optional) -

        PolicyReportResult provides result details

        -
        -
        -

        PolicyReportResult -

        -

        -(Appears on: -ClusterPolicyReport, -PolicyReport, -ClusterReportChangeRequest, -ReportChangeRequest) -

        -

        -

        PolicyReportResult provides the result for an individual policy

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -policy
        - -string - -        		 -

        Policy is the name of the policy

        -
        -rule
        - -string - -        		 -(Optional) -

        Rule is the name of the policy rule

        -
        -resources
        - - -[]Kubernetes core/v1.ObjectReference - - -        		 -(Optional) -

        Resources is an optional reference to the resource checked by the policy and rule

        -
        -resourceSelector
        - - -Kubernetes meta/v1.LabelSelector - - -        		 -(Optional) -

        ResourceSelector is an optional selector for policy results that apply to multiple resources. -For example, a policy result may apply to all pods that match a label. -Either a Resource or a ResourceSelector can be specified. If neither are provided, the -result is assumed to be for the policy report scope.

        -
        -message
        - -string - -        		 -

        Message is a short user friendly description of the policy rule

        -
        -status
        - - -PolicyStatus - - -        		 -

        Status indicates the result of the policy rule check

        -
        -scored
        - -bool - -        		 -

        Scored indicates if this policy rule is scored

        -
        -data
        - -map[string]string - -        		 -

        Data provides additional information for the policy rule

        -
        -category
        - -string - -        		 -(Optional) -

        Category indicates policy category

        -
        -severity
        - - -PolicySeverity - - -        		 -(Optional) -

        Severity indicates policy severity

        -
        -
        -

        PolicyReportSummary -

        -

        -(Appears on: -ClusterPolicyReport, -PolicyReport, -ClusterReportChangeRequest, -ReportChangeRequest) -

        -

        -

        PolicyReportSummary provides a status count summary

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -pass
        - -int - -        		 -(Optional) -

        Pass provides the count of policies whose requirements were met

        -
        -fail
        - -int - -        		 -(Optional) -

        Fail provides the count of policies whose requirements were not met

        -
        -warn
        - -int - -        		 -(Optional) -

        Warn provides the count of unscored policies whose requirements were not met

        -
        -error
        - -int - -        		 -(Optional) -

        Error provides the count of policies that could not be evaluated

        -
        -skip
        - -int - -        		 -(Optional) -

        Skip indicates the count of policies that were not selected for evaluation

        -
        -
        -

        PolicySeverity -(string alias)

        -

        -(Appears on: -PolicyReportResult) -

        -

        -

        PolicySeverity has one of the following values: -- high -- low -- medium

        -

        -

        PolicyStatus -(string alias)

        -

        -(Appears on: -PolicyReportResult) -

        -

        -

        PolicyStatus has one of the following values: -- pass: indicates that the policy requirements are met -- fail: indicates that the policy requirements are not met -- warn: indicates that the policy requirements and not met, and the policy is not scored -- error: indicates that the policy could not be evaluated -- skip: indicates that the policy was not selected based on user inputs or applicability

        -

        -

        wgpolicyk8s.io/v1alpha2

        -

        -

        Package v1alpha2 contains API Schema definitions for the policy v1alpha2 API group

        -

        -Resource Types: - -
        -

        ClusterPolicyReport -

        -

        -

        ClusterPolicyReport is the Schema for the clusterpolicyreports API

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -apiVersion
        -string        		 - -wgpolicyk8s.io/v1alpha2 - -
        -kind
        -string -        		ClusterPolicyReport
        -metadata
        - - -Kubernetes meta/v1.ObjectMeta - - -        		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
        -scope
        - - -Kubernetes core/v1.ObjectReference - - -        		 -(Optional) -

        Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

        -
        -scopeSelector
        - - -Kubernetes meta/v1.LabelSelector - - -        		 -(Optional) -

        ScopeSelector is an optional selector for multiple scopes (e.g. Pods). -Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

        -
        -summary
        - - -PolicyReportSummary - - -        		 -(Optional) -

        PolicyReportSummary provides a summary of results

        -
        -results
        - - -[]PolicyReportResult - - -        		 -(Optional) -

        PolicyReportResult provides result details

        -
        -
        -

        PolicyReport -

        -

        -

        PolicyReport is the Schema for the policyreports API

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -apiVersion
        -string        		 - -wgpolicyk8s.io/v1alpha2 - -
        -kind
        -string -        		PolicyReport
        -metadata
        - - -Kubernetes meta/v1.ObjectMeta - - -        		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
        -scope
        - - -Kubernetes core/v1.ObjectReference - - -        		 -(Optional) -

        Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

        -
        -scopeSelector
        - - -Kubernetes meta/v1.LabelSelector - - -        		 -(Optional) -

        ScopeSelector is an optional selector for multiple scopes (e.g. Pods). -Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

        -
        -summary
        - - -PolicyReportSummary - - -        		 -(Optional) -

        PolicyReportSummary provides a summary of results

        -
        -results
        - - -[]PolicyReportResult - - -        		 -(Optional) -

        PolicyReportResult provides result details

        -
        -
        -

        PolicyReportResult -

        -

        -(Appears on: -ClusterPolicyReport, -PolicyReport, -ClusterReportChangeRequest, -ReportChangeRequest) -

        -

        -

        PolicyReportResult provides the result for an individual policy

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -source
        - -string - -        		 -(Optional) -

        Source is an identifier for the policy engine that manages this report

        -
        -policy
        - -string - -        		 -

        Policy is the name of the policy

        -
        -rule
        - -string - -        		 -(Optional) -

        Rule is the name of the policy rule

        -
        -resources
        - - -[]Kubernetes core/v1.ObjectReference - - -        		 -(Optional) -

        Resources is an optional reference to the resource checked by the policy and rule

        -
        -resourceSelector
        - - -Kubernetes meta/v1.LabelSelector - - -        		 -(Optional) -

        ResourceSelector is an optional selector for policy results that apply to multiple resources. -For example, a policy result may apply to all pods that match a label. -Either a Resource or a ResourceSelector can be specified. If neither are provided, the -result is assumed to be for the policy report scope.

        -
        -message
        - -string - -        		 -

        Message is a short user friendly description of the policy rule

        -
        -result
        - - -PolicyResult - - -        		 -

        Result indicates the outcome of the policy rule execution

        -
        -scored
        - -bool - -        		 -

        Scored indicates if this policy rule is scored

        -
        -properties
        - -map[string]string - -        		 -

        Properties provides additional information for the policy rule

        -
        -timestamp
        - - -Kubernetes meta/v1.Timestamp - - -        		 -

        Timestamp indicates the time the result was found

        -
        -category
        - -string - -        		 -(Optional) -

        Category indicates policy category

        -
        -severity
        - - -PolicySeverity - - -        		 -(Optional) -

        Severity indicates policy severity

        -
        -
        -

        PolicyReportSummary -

        -

        -(Appears on: -ClusterPolicyReport, -PolicyReport, -ClusterReportChangeRequest, -ReportChangeRequest) -

        -

        -

        PolicyReportSummary provides a status count summary

        -

        - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
        FieldDescription
        -pass
        - -int - -        		 -(Optional) -

        Pass provides the count of policies whose requirements were met

        -
        -fail
        - -int - -        		 -(Optional) -

        Fail provides the count of policies whose requirements were not met

        -
        -warn
        - -int - -        		 -(Optional) -

        Warn provides the count of unscored policies whose requirements were not met

        -
        -error
        - -int - -        		 -(Optional) -

        Error provides the count of policies that could not be evaluated

        -
        -skip
        - -int - -        		 -(Optional) -

        Skip indicates the count of policies that were not selected for evaluation

        -
        -
        -

        PolicyResult -(string alias)

        -

        -(Appears on: -PolicyReportResult) -

        -

        -

        PolicyResult has one of the following values: -- pass: indicates that the policy requirements are met -- fail: indicates that the policy requirements are not met -- warn: indicates that the policy requirements and not met, and the policy is not scored -- error: indicates that the policy could not be evaluated -- skip: indicates that the policy was not selected based on user inputs or applicability

        -

        -

        PolicySeverity -(string alias)

        -

        -(Appears on: -PolicyReportResult) -

        -

        -

        PolicySeverity has one of the following values: -- high -- low -- medium

        -

        diff --git a/docs/crd/v1alpha1/index.html b/docs/crd/v1alpha1/index.html new file mode 100644 index 0000000000..df50a51b45 --- /dev/null +++ b/docs/crd/v1alpha1/index.html @@ -0,0 +1,203 @@ + + + + + + +Kyverno API + + + +
        + +

        kyverno.io/v1alpha1

        +

        +

        Package v1alpha1 contains API Schema definitions for the policy v1alpha1 API group

        +

        +Resource Types: +
          +
          +

          ClusterReportChangeRequest +

          +

          +

          ClusterReportChangeRequest is the Schema for the ClusterReportChangeRequests API

          +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          FieldDescription
          +metadata
          + + +Kubernetes meta/v1.ObjectMeta + + +          		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
          +scope
          + + +Kubernetes core/v1.ObjectReference + + +          		 +(Optional) +

          Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

          +
          +scopeSelector
          + + +Kubernetes meta/v1.LabelSelector + + +          		 +(Optional) +

          ScopeSelector is an optional selector for multiple scopes (e.g. Pods). +Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

          +
          +summary
          + +github.com/kyverno/kyverno/api/policyreport/v1alpha1.PolicyReportSummary + +          		 +(Optional) +

          PolicyReportSummary provides a summary of results

          +
          +results
          + +[]*github.com/kyverno/kyverno/api/policyreport/v1alpha1.PolicyReportResult + +          		 +(Optional) +

          PolicyReportResult provides result details

          +
          +
          +

          ReportChangeRequest +

          +

          +

          ReportChangeRequest is the Schema for the ReportChangeRequests API

          +

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          FieldDescription
          +metadata
          + + +Kubernetes meta/v1.ObjectMeta + + +          		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
          +scope
          + + +Kubernetes core/v1.ObjectReference + + +          		 +(Optional) +

          Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

          +
          +scopeSelector
          + + +Kubernetes meta/v1.LabelSelector + + +          		 +(Optional) +

          ScopeSelector is an optional selector for multiple scopes (e.g. Pods). +Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

          +
          +summary
          + +github.com/kyverno/kyverno/api/policyreport/v1alpha1.PolicyReportSummary + +          		 +(Optional) +

          PolicyReportSummary provides a summary of results

          +
          +results
          + +[]*github.com/kyverno/kyverno/api/policyreport/v1alpha1.PolicyReportResult + +          		 +(Optional) +

          PolicyReportResult provides result details

          +
          +
          +
          + + + + + diff --git a/docs/crd/v1alpha2/index.html b/docs/crd/v1alpha2/index.html new file mode 100644 index 0000000000..f3a377ea69 --- /dev/null +++ b/docs/crd/v1alpha2/index.html @@ -0,0 +1,203 @@ + + + + + + +Kyverno API + + + +
          + +

          kyverno.io/v1alpha2

          +

          +

          Package v1alpha2 contains API Schema definitions for the policy v1alpha2 API group

          +

          +Resource Types: +
            +
            +

            ClusterReportChangeRequest +

            +

            +

            ClusterReportChangeRequest is the Schema for the ClusterReportChangeRequests API

            +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            FieldDescription
            +metadata
            + + +Kubernetes meta/v1.ObjectMeta + + +            		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
            +scope
            + + +Kubernetes core/v1.ObjectReference + + +            		 +(Optional) +

            Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

            +
            +scopeSelector
            + + +Kubernetes meta/v1.LabelSelector + + +            		 +(Optional) +

            ScopeSelector is an optional selector for multiple scopes (e.g. Pods). +Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

            +
            +summary
            + +github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportSummary + +            		 +(Optional) +

            PolicyReportSummary provides a summary of results

            +
            +results
            + +[]*github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportResult + +            		 +(Optional) +

            PolicyReportResult provides result details

            +
            +
            +

            ReportChangeRequest +

            +

            +

            ReportChangeRequest is the Schema for the ReportChangeRequests API

            +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            FieldDescription
            +metadata
            + + +Kubernetes meta/v1.ObjectMeta + + +            		 +Refer to the Kubernetes API documentation for the fields of the +metadata field. +
            +scope
            + + +Kubernetes core/v1.ObjectReference + + +            		 +(Optional) +

            Scope is an optional reference to the report scope (e.g. a Deployment, Namespace, or Node)

            +
            +scopeSelector
            + + +Kubernetes meta/v1.LabelSelector + + +            		 +(Optional) +

            ScopeSelector is an optional selector for multiple scopes (e.g. Pods). +Either one of, or none of, but not both of, Scope or ScopeSelector should be specified.

            +
            +summary
            + +github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportSummary + +            		 +(Optional) +

            PolicyReportSummary provides a summary of results

            +
            +results
            + +[]*github.com/kyverno/kyverno/api/policyreport/v1alpha2.PolicyReportResult + +            		 +(Optional) +

            PolicyReportResult provides result details

            +
            +
            +
            + + + + +