Update Kubewarden SBOMscanner CRD reference documentation

[github-actions]

Automatically sync the CRD reference documentation from the kubewarden/sbomscanner repository

---

Updates CRD reference documentation files

updates docs/sbom-scanner/version-0.13/modules/en/partials/crd-reference.adoc file

1 file(s) updated with "// Generated documentation. Please do not edit.\n:anchor_prefix: k8s-api\n\n[id=\"{p}-api-reference\"]\n== API Reference\n\n.Packages\n- xref:{anchor_prefix}-sbomscanner-kubewarden-io-v1alpha1[$$sbomscanner.kubewarden.io/v1alpha1$$]\n- xref:{anchor_prefix}-storage-sbomscanner-kubewarden-io-v1alpha1[$$storage.sbomscanner.kubewarden.io/v1alpha1$$]\n\n\n[id=\"{anchor_prefix}-sbomscanner-kubewarden-io-v1alpha1\"]\n=== sbomscanner.kubewarden.io/v1alpha1\n\nPackage v1alpha1 contains API Schema definitions for the SBOMscanner v1alpha1 API group.\n\n.Resource Types\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfiguration[$$NodeScanConfiguration$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfigurationlist[$$NodeScanConfigurationList$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjob[$$NodeScanJob$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjoblist[$$NodeScanJobList$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registry[$$Registry$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registrylist[$$RegistryList$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjob[$$ScanJob$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjoblist[$$ScanJobList$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhub[$$VEXHub$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhublist[$$VEXHubList$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfiguration[$$WorkloadScanConfiguration$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfigurationlist[$$WorkloadScanConfigurationList$$]\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-matchcondition\"]\n==== MatchCondition\n\n\n\nMatchCondition defines a CEL expression to filter image tags.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-repository[$$Repository$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name is an identifier for this match condition, used for strategic merging of MatchConditions, +\nas well as providing an identifier for logging purposes. +\nA good name should be descriptive of the associated expression. + | | \n| *`expression`* __string__ | Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. +\nDocumentation on CEL: https://kubernetes.io/docs/reference/using-api/cel/ + | | \n| *`labels`* __object (keys:string, values:string)__ | Labels are key-value pairs that can be used to organize and categorize match conditions. + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-matchoperator\"]\n==== MatchOperator\n\n_Underlying type:_ _string_\n\nMatchOperator defines how multiple match conditions are combined.\n\n.Validation:\n- Enum: [And Or]\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-repository[$$Repository$$]\n****\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfiguration\"]\n==== NodeScanConfiguration\n\n\n\nNodeScanConfiguration is the Schema for the nodescanconfigurations API.\nThis is a singleton resource - only one instance named \"default\" is allowed.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfigurationlist[$$NodeScanConfigurationList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `NodeScanConfiguration` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`spec`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfigurationspec[$$NodeScanConfigurationSpec$$]__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfigurationlist\"]\n==== NodeScanConfigurationList\n\n\n\nNodeScanConfigurationList contains a list of NodeScanConfiguration.\n\n\n\n\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `NodeScanConfigurationList` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`items`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfiguration[$$NodeScanConfiguration$$] array__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfigurationspec\"]\n==== NodeScanConfigurationSpec\n\n\n\nNodeScanConfigurationSpec defines the desired configuration for node scanning.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfiguration[$$NodeScanConfiguration$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`enabled`* __boolean__ | Enabled controls whether node scanning is active. + | true | \n| *`nodeSelector`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#labelselector-v1-meta[$$LabelSelector$$]__ | NodeSelector filters which nodes are scanned. +\nIf not specified, all the nodes are scanned. + | | Optional: \\{} +\n\n| *`scanInterval`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#duration-v1-meta[$$Duration$$]__ | ScanInterval is the interval at which nodes are scanned. + | | Optional: \\{} +\n\n| *`skipPatterns`* __string__ | SkipPatterns specifies gitignore-style patterns for directories and files to skip during node scanning. +\nPatterns ending with \"/\" are treated as directories. +\nAll other patterns are treated as files. +\nGlob patterns like \"**/vendor/\" or \"*.min.js\" are supported. +\n\nIf unset, container-runtime state is skipped by default: +\n- /var/lib/containerd/ +\n- /var/lib/docker/ +\n- /var/lib/rancher/k3s/agent/containerd/ +\n- /var/lib/rancher/rke2/agent/containerd/ +\n- /var/lib/containers/ +\n- /run/containerd/ +\n- /run/k3s/containerd/ +\nSet to an empty list to scan everything, including the paths above. + | | Optional: \\{} +\n\n| *`platforms`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-platform[$$Platform$$] array__ | Platforms allows to specify the list of platforms to scan. +\nIf not set, all nodes are scanned regardless of their platform. + | | Optional: \\{} +\n\n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjob\"]\n==== NodeScanJob\n\n\n\nNodeScanJob is the Schema for the nodescanjobs API.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjoblist[$$NodeScanJobList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `NodeScanJob` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`spec`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjobspec[$$NodeScanJobSpec$$]__ | | | \n| *`status`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjobstatus[$$NodeScanJobStatus$$]__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjoblist\"]\n==== NodeScanJobList\n\n\n\nNodeScanJobList contains a list of NodeScanJob.\n\n\n\n\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `NodeScanJobList` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`items`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjob[$$NodeScanJob$$] array__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjobspec\"]\n==== NodeScanJobSpec\n\n\n\nNodeScanJobSpec defines the desired state of NodeScanJob.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjob[$$NodeScanJob$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`nodeName`* __string__ | NodeName specifies the name of the node to be scanned. + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjobstatus\"]\n==== NodeScanJobStatus\n\n\n\nNodeScanJobStatus defines the observed state of NodeScanJob.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanjob[$$NodeScanJob$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`conditions`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta[$$Condition$$] array__ | Conditions represent the latest available observations of ScanJob state + | | Optional: \\{} +\n\n| *`startTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#time-v1-meta[$$Time$$]__ | StartTime is when the job started processing. + | | Optional: \\{} +\n\n| *`completionTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#time-v1-meta[$$Time$$]__ | CompletionTime is when the job completed or failed. + | | Optional: \\{} +\n\n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-platform\"]\n==== Platform\n\n\n\nPlatform describes the platform which the image in the manifest runs on.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-nodescanconfigurationspec[$$NodeScanConfigurationSpec$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registryspec[$$RegistrySpec$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfigurationspec[$$WorkloadScanConfigurationSpec$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`arch`* __string__ | Architecture field specifies the CPU architecture, for example +\n`amd64` or `ppc64le`. + | | \n| *`os`* __string__ | OS specifies the operating system, for example `linux` or `windows`. + | | \n| *`variant`* __string__ | Variant is an optional field specifying a variant of the CPU, for +\nexample `v7` to specify ARMv7 when architecture is `arm`. + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registry\"]\n==== Registry\n\n\n\nRegistry is the Schema for the registries API\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registrylist[$$RegistryList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `Registry` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`spec`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registryspec[$$RegistrySpec$$]__ | | | \n| *`status`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registrystatus[$$RegistryStatus$$]__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registrylist\"]\n==== RegistryList\n\n\n\nRegistryList contains a list of Registry\n\n\n\n\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `RegistryList` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`items`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registry[$$Registry$$] array__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registryspec\"]\n==== RegistrySpec\n\n\n\nRegistrySpec defines the desired state of Registry\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registry[$$Registry$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`uri`* __string__ | URI is the URI of the container registry + | | \n| *`catalogType`* __string__ | CatalogType is the type of catalog used to list the images within the registry. + | | \n| *`repositories`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-repository[$$Repository$$] array__ | Repositories is the list of the repositories to be scanned +\nAn empty list means all the repositories found in the registry are going to be scanned. + | | \n| *`authSecret`* __string__ | AuthSecret is the name of the secret in the same namespace that contains the credentials to access the registry. +\nThe secret must be in dockerconfigjson format. See: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ + | | \n| *`scanInterval`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#duration-v1-meta[$$Duration$$]__ | ScanInterval is the interval at which the registry is scanned. +\nIf not set, automatic scanning is disabled. + | | \n| *`caBundle`* __string__ | CABundle is the CA bundle to use when connecting to the registry. + | | \n| *`insecure`* __boolean__ | Insecure allows insecure connections to the registry when set to true. + | | \n| *`platforms`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-platform[$$Platform$$] array__ | Platforms allows to specify the list of platform to scan. +\nIf not set, all the available platforms of a container image will be scanned. + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registrystatus\"]\n==== RegistryStatus\n\n\n\nRegistryStatus defines the observed state of Registry\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registry[$$Registry$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`conditions`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta[$$Condition$$] array__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-repository\"]\n==== Repository\n\n\n\nRepository specifies an OCI repository and which image tags to scan.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-registryspec[$$RegistrySpec$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name is the repository name. + | | \n| *`matchConditions`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-matchcondition[$$MatchCondition$$] array__ | MatchConditions filters image tags using CEL expressions. + | | \n| *`matchOperator`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-matchoperator[$$MatchOperator$$]__ | MatchOperator specifies how this condition is combined with other conditions. +\nWhen set to \"And\" (default), all conditions must pass for the filter to match. +\nWhen set to \"Or\", at least one condition must pass for the filter to match. + | And | Enum: [And Or] +\nOptional: \\{} +\n\n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjob\"]\n==== ScanJob\n\n\n\nScanJob is the Schema for the scanjobs API.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjoblist[$$ScanJobList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `ScanJob` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`spec`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjobspec[$$ScanJobSpec$$]__ | | | \n| *`status`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjobstatus[$$ScanJobStatus$$]__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjoblist\"]\n==== ScanJobList\n\n\n\nScanJobList contains a list of ScanJob.\n\n\n\n\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `ScanJobList` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`items`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjob[$$ScanJob$$] array__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjobrepository\"]\n==== ScanJobRepository\n\n\n\nScanJobRepository selects a Registry repository (and optionally a subset of its match conditions) for a targeted ScanJob.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-rescanrequest[$$RescanRequest$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjobspec[$$ScanJobSpec$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name is the name of a repository declared on the Registry. + | | Required: \\{} +\n\n| *`matchConditions`* __string array__ | MatchConditions optionally narrows the scan to a subset of the MatchConditions declared on the targeted repository. +\nEach entry must reference an existing MatchCondition by name. +\nWhen empty, all MatchConditions of the repository apply. + | | Optional: \\{} +\n\n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjobspec\"]\n==== ScanJobSpec\n\n\n\nScanJobSpec defines the desired state of ScanJob.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjob[$$ScanJob$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`registry`* __string__ | Registry is the registry in the same namespace to scan. + | | Required: \\{} +\n\n| *`repositories`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjobrepository[$$ScanJobRepository$$] array__ | Repositories optionally narrows the scan to a subset of the repositories configured on the targeted Registry. +\nWhen empty, all repositories of the Registry are scanned. + | | Optional: \\{} +\n\n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjobstatus\"]\n==== ScanJobStatus\n\n\n\nScanJobStatus defines the observed state of ScanJob.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-scanjob[$$ScanJob$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`conditions`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#condition-v1-meta[$$Condition$$] array__ | Conditions represent the latest available observations of ScanJob state + | | Optional: \\{} +\n\n| *`imagesCount`* __integer__ | ImagesCount is the number of images in the registry. + | | \n| *`scannedImagesCount`* __integer__ | ScannedImagesCount is the number of images that have been scanned. + | | \n| *`startTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#time-v1-meta[$$Time$$]__ | StartTime is when the job started processing. + | | Optional: \\{} +\n\n| *`completionTime`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#time-v1-meta[$$Time$$]__ | CompletionTime is when the job completed or failed. + | | Optional: \\{} +\n\n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhub\"]\n==== VEXHub\n\n\n\nVEXHub is the Schema for the vexhubs API\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhublist[$$VEXHubList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `VEXHub` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | Optional: \\{} +\n\n| *`spec`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhubspec[$$VEXHubSpec$$]__ | spec defines the desired state of VEXHub + | | Required: \\{} +\n\n| *`status`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhubstatus[$$VEXHubStatus$$]__ | status defines the observed state of VEXHub + | | Optional: \\{} +\n\n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhublist\"]\n==== VEXHubList\n\n\n\nVEXHubList contains a list of VEXHub\n\n\n\n\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `VEXHubList` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`items`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhub[$$VEXHub$$] array__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhubspec\"]\n==== VEXHubSpec\n\n\n\nVEXHubSpec defines the desired state of VEXHub\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhub[$$VEXHub$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`url`* __string__ | URL is the URL of the VEXHub repository + | | \n| *`enabled`* __boolean__ | Enabled tells if the VEX Hub is enabled for processing + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhubstatus\"]\n==== VEXHubStatus\n\n\n\nVEXHubStatus defines the observed state of VEXHub.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-vexhub[$$VEXHub$$]\n****\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfiguration\"]\n==== WorkloadScanConfiguration\n\n\n\nWorkloadScanConfiguration is the Schema for the workloadscanconfigurations API.\nThis is a singleton resource - only one instance named \"default\" is allowed.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfigurationlist[$$WorkloadScanConfigurationList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `WorkloadScanConfiguration` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`spec`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfigurationspec[$$WorkloadScanConfigurationSpec$$]__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfigurationlist\"]\n==== WorkloadScanConfigurationList\n\n\n\nWorkloadScanConfigurationList contains a list of WorkloadScanConfiguration.\n\n\n\n\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`apiVersion`* __string__ | `sbomscanner.kubewarden.io/v1alpha1` | |\n| *`kind`* __string__ | `WorkloadScanConfigurationList` | |\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#listmeta-v1-meta[$$ListMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`items`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfiguration[$$WorkloadScanConfiguration$$] array__ | | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfigurationspec\"]\n==== WorkloadScanConfigurationSpec\n\n\n\nWorkloadScanConfigurationSpec defines the desired configuration for workload scanning.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-workloadscanconfiguration[$$WorkloadScanConfiguration$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`enabled`* __boolean__ | Enabled controls whether workload scanning is active. + | true | \n| *`namespaceSelector`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#labelselector-v1-meta[$$LabelSelector$$]__ | NamespaceSelector filters which namespaces are scanned for workloads. +\nIf not specified, workloads in all namespaces are scanned. + | | Optional: \\{} +\n\n| *`artifactsNamespace`* __string__ | ArtifactsNamespace is the namespace where scan artifacts (Registry, ScanJob, SBOM, VulnerabilityReport) are created. +\nWhen empty, artifacts are created in the workload's own namespace. +\nCan only be changed when Enabled is false. +\nNote: WorkloadScanReport resources are always created in the workload's namespace, regardless of this setting. + | | Optional: \\{} +\n\n| *`scanInterval`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#duration-v1-meta[$$Duration$$]__ | ScanInterval is the interval at which discovered registries are scanned. + | | Optional: \\{} +\n\n| *`scanOnChange`* __boolean__ | ScanOnChange triggers a scan when a managed Registry resource is created or updated. +\nDefaults to true. + | true | Optional: \\{} +\n\n| *`authSecret`* __string__ | AuthSecret is the name of a secret in the installation namespace containing credentials to access registries. +\nThe secret must be in dockerconfigjson format. See: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ + | | Optional: \\{} +\n\n| *`caBundle`* __string__ | CABundle is the CA bundle to use when connecting to registries. + | | Optional: \\{} +\n\n| *`insecure`* __boolean__ | Insecure allows insecure connections to registries when set to true. + | | Optional: \\{} +\n\n| *`platforms`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-v1alpha1-platform[$$Platform$$] array__ | Platforms specifies which platforms to scan for container images. +\nIf not specified, all platforms available in the image manifest will be scanned. + | | Optional: \\{} +\n\n|===\n\n\n\n[id=\"{anchor_prefix}-storage-sbomscanner-kubewarden-io-v1alpha1\"]\n=== storage.sbomscanner.kubewarden.io/v1alpha1\n\nPackage v1alpha1 contains the storage v1alpha1 types for SBOMscanner.\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-cvss\"]\n==== CVSS\n\n\n\nCVSS holds Common Vulnerability Scoring System data for a vulnerability.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vulnerability[$$Vulnerability$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`v3vector`* __string__ | V3Vector string (e.g., \"AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H\") + | | \n| *`v3score`* __string__ | V3Score numerical score + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-class\"]\n==== Class\n\n_Underlying type:_ _string_\n\n\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-result[$$Result$$]\n****\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerref\"]\n==== ContainerRef\n\n\n\nContainerRef identifies a container and its image reference for vulnerability lookup.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreportspec[$$WorkloadScanReportSpec$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name is the name of the container. + | | \n| *`imageRef`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imageref[$$ImageRef$$]__ | ImageRef identifies which VulnerabilityReports to associate with this container. + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerresult\"]\n==== ContainerResult\n\n\n\nContainerResult contains the vulnerability scan results for a single container.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreport[$$WorkloadScanReport$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name is the name of the container (matches ContainerRef.Name). + | | \n| *`vulnerabilityReports`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanvulnerabilityreport[$$WorkloadScanVulnerabilityReport$$] array__ | VulnerabilityReports contains the vulnerability reports for this container's image. +\nMultiple reports may exist for multi-arch images (one per platform). + | | Optional: \\{} +\n\n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerstatus\"]\n==== ContainerStatus\n\n\n\nContainerStatus contains the scan status for a single container.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreportstatus[$$WorkloadScanReportStatus$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name is the name of the container (matches ContainerRef.Name). + | | \n| *`scanStatus`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-scanstatus[$$ScanStatus$$]__ | ScanStatus indicates the scan status for this container. + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-image\"]\n==== Image\n\n\n\nImage is the Schema for the images API\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagelist[$$ImageList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`imageMetadata`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagemetadata[$$ImageMetadata$$]__ | Metadata of the image + | | \n| *`layers`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagelayer[$$ImageLayer$$] array__ | List of the layers that make the image + | | \n| *`status`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagestatus[$$ImageStatus$$]__ | Status of the image + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagelayer\"]\n==== ImageLayer\n\n\n\nImageLayer define a layer part of an OCI Image\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-image[$$Image$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`command`* __string__ | command is the command that led to the creation +\nof the layer. The contents are base64 encoded + | | \n| *`digest`* __string__ | digest is the Hash of the compressed layer + | | \n| *`diffID`* __string__ | diffID is the Hash of the uncompressed layer + | | \n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagemetadata\"]\n==== ImageMetadata\n\n\n\nImageMetadata contains the metadata details of an image.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-image[$$Image$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-sbom[$$SBOM$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vulnerabilityreport[$$VulnerabilityReport$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanvulnerabilityreport[$$WorkloadScanVulnerabilityReport$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`registry`* __string__ | Registry specifies the name of the Registry object in the same namespace where the image is stored. + | | \n| *`registryURI`* __string__ | RegistryURI specifies the URI of the registry where the image is stored. Example: \"registry-1.docker.io:5000\".` + | | \n| *`repository`* __string__ | Repository specifies the repository path of the image. Example: \"kubewarden/sbomscanner\". + | | \n| *`tag`* __string__ | Tag specifies the tag of the image. Example: \"latest\". + | | \n| *`platform`* __string__ | Platform specifies the platform of the image. Example \"linux/amd64\". + | | \n| *`digest`* __string__ | Digest specifies the image manifest digest. + | | \n| *`indexDigest`* __string__ | IndexDigest specifies the image index digest that referenced this manifest. Set only for multi-arch images. + | | \n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imageref\"]\n==== ImageRef\n\n\n\nImageRef identifies a set of VulnerabilityReports by image reference.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerref[$$ContainerRef$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`registry`* __string__ | Registry is the name of the Registry custom resource. + | | \n| *`namespace`* __string__ | Namespace is the namespace where the VulnerabilityReports are stored. + | | \n| *`repository`* __string__ | Repository is the repository path of the image. + | | \n| *`tag`* __string__ | Tag is the tag of the image. + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagestatus\"]\n==== ImageStatus\n\n\n\nImageStatus contains the observed state of the Image\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-image[$$Image$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`workloadScanReports`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imageworkloadscanreports[$$ImageWorkloadScanReports$$] array__ | WorkloadScanReports is the list of workloads referencing this image + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imageworkloadscanreports\"]\n==== ImageWorkloadScanReports\n\n\n\nImageWorkloadScanReports identifies a workload that references this image\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagestatus[$$ImageStatus$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name of the WorkloadScanReport + | | \n| *`namespace`* __string__ | Namespace of the WorkloadScanReport + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodemetadata\"]\n==== NodeMetadata\n\n\n\nNodeMetadata contains the metadata details of a node.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodesbom[$$NodeSBOM$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodevulnerabilityreport[$$NodeVulnerabilityReport$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name specifies the name of the node. + | | \n| *`platform`* __string__ | Platform specifies the platform of the image. Example \"linux/amd64\". + | | \n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodesbom\"]\n==== NodeSBOM\n\n\n\nNodeSBOM represents a Software Bill of Materials of a node\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodesbomlist[$$NodeSBOMList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`nodeMetadata`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodemetadata[$$NodeMetadata$$]__ | | | \n| *`spdx`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#rawextension-runtime-pkg[$$RawExtension$$]__ | SPDX contains the SPDX document of the SBOM in JSON format + | | \n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodevulnerabilityreport\"]\n==== NodeVulnerabilityReport\n\n\n\nNodeVulnerabilityReport is the Schema for the scanresults API\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodevulnerabilityreportlist[$$NodeVulnerabilityReportList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`nodeMetadata`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodemetadata[$$NodeMetadata$$]__ | NodeMetadata contains info about the scanned node + | | \n| *`report`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-report[$$Report$$]__ | Report is the actual vulnerability scan report + | | \n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-report\"]\n==== Report\n\n\n\nReport contains metadata about the scanned image and a list of vulnerability results.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-nodevulnerabilityreport[$$NodeVulnerabilityReport$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vulnerabilityreport[$$VulnerabilityReport$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanvulnerabilityreport[$$WorkloadScanVulnerabilityReport$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`summary`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-summary[$$Summary$$]__ | Summary of vulnerabilities found + | | \n| *`results`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-result[$$Result$$] array__ | Results per target (e.g., layer, package type) + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-result\"]\n==== Result\n\n\n\nResult represents scan findings for a specific target and class of packages\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-report[$$Report$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`target`* __string__ | Target is the specific target scanned + | | \n| *`class`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-class[$$Class$$]__ | Class is the classification of the target + | | \n| *`type`* __string__ | Type is the language type + | | \n| *`vulnerabilities`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vulnerability[$$Vulnerability$$] array__ | Vulnerabilities found in this target + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-sbom\"]\n==== SBOM\n\n\n\nSBOM represents a Software Bill of Materials of an OCI artifact\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-sbomlist[$$SBOMList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`imageMetadata`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagemetadata[$$ImageMetadata$$]__ | | | \n| *`spdx`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#rawextension-runtime-pkg[$$RawExtension$$]__ | SPDX contains the SPDX document of the SBOM in JSON format + | | \n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-scanstatus\"]\n==== ScanStatus\n\n_Underlying type:_ _string_\n\nScanStatus represents the status of a container's vulnerability scan.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerstatus[$$ContainerStatus$$]\n****\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-summary\"]\n==== Summary\n\n\n\nSummary provides a high-level overview of the vulnerabilities found.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-report[$$Report$$]\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreport[$$WorkloadScanReport$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`critical`* __integer__ | Critical vulnerabilities count + | | \n| *`high`* __integer__ | High vulnerabilities count + | | \n| *`medium`* __integer__ | Medium vulnerabilities count + | | \n| *`low`* __integer__ | Low vulnerabilities count + | | \n| *`unknown`* __integer__ | Unknown vulnerabilities count + | | \n| *`suppressed`* __integer__ | Suppressed vulnerabilities count + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vexstatus\"]\n==== VEXStatus\n\n\n\nVEXStatus represents the status of a vulnerability as declared\nin a VEX document\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vulnerability[$$Vulnerability$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`repository`* __string__ | Repository providing the VEX document + | | \n| *`status`* __string__ | VEX status (e.g., \"not_affected\", \"fixed\", \"under_investigation\") + | | \n| *`statement`* __string__ | Statement optionally explain statement from the VEX document + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vulnerability\"]\n==== Vulnerability\n\n\n\nVulnerability contains detailed information about a single vulnerability\nfound in a package\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-result[$$Result$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`cve`* __string__ | CVE identifier + | | \n| *`title`* __string__ | Title is the title of the vulnerability + | | \n| *`packageName`* __string__ | PackageName is the name of the vulnerable package +\n(empty when Class is \"binary\") + | | \n| *`packagePath`* __string__ | PackagePath is the path where the package was found +\n(equal to Target when Class is \"binary\"). +\ntrivy removes the \"/\" at the beginning of the path +\nso we have to restore it. + | | \n| *`purl`* __string__ | PURL (Package URL) identify the package uniquely + | | \n| *`installedVersion`* __string__ | InstalledVersion of the package that was found + | | \n| *`fixedVersions`* __string array__ | FixedVersions is the list of versions where the vulnerability is fixed + | | \n| *`diffID`* __string__ | DiffID of the image layer where the vulnerability was introduced + | | \n| *`description`* __string__ | Description of the vulnerability + | | \n| *`severity`* __string__ | Severity rating (e.g., \"HIGH\", \"MEDIUM\") + | | \n| *`severitySource`* __string__ | SeveritySource identifies the vendor that produced the Severity +\n(e.g. \"nvd\", \"ghsa\", \"redhat\", \"alpine\"). +\nConsumers can use this key to look up the matching entry in the CVSS map to display alongside Severity. +\nMay be empty when the source vendor is not known. + | | \n| *`references`* __string array__ | References contains URLs for more information + | | \n| *`cvss`* __object (keys:string, values:xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-cvss[$$CVSS$$])__ | CVSS scoring details + | | \n| *`cwes`* __string array__ | CWEs with which the CVE is classified + | | \n| *`suppressed`* __boolean__ | Suppressed identify when vulnerability has +\nbeen suppressed by VEX documents + | | \n| *`vexStatus`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vexstatus[$$VEXStatus$$]__ | VEXStatus information + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vulnerabilityreport\"]\n==== VulnerabilityReport\n\n\n\nVulnerabilityReport is the Schema for the scanresults API\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-vulnerabilityreportlist[$$VulnerabilityReportList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`imageMetadata`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagemetadata[$$ImageMetadata$$]__ | ImageMetadata contains info about the scanned image + | | \n| *`report`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-report[$$Report$$]__ | Report is the actual vulnerability scan report + | | \n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreport\"]\n==== WorkloadScanReport\n\n\n\nWorkloadScanReport represents the vulnerability scan results for a workload's containers.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreportlist[$$WorkloadScanReportList$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`metadata`* __link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.36/#objectmeta-v1-meta[$$ObjectMeta$$]__ | Refer to Kubernetes API documentation for fields of `metadata`.\n | | \n| *`spec`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreportspec[$$WorkloadScanReportSpec$$]__ | Spec contains the workload container references, written by the reconciler. + | | \n| *`status`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreportstatus[$$WorkloadScanReportStatus$$]__ | Status contains the scan status for each container. +\nPopulated at read time. + | | Optional: \\{} +\n\n| *`summary`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-summary[$$Summary$$]__ | Summary provides aggregated vulnerability counts across all containers. +\nVulnerabilities are deduplicated per container (same CVE across platforms counts as 1), +\nthen summed across all containers. +\nPopulated at read time. + | | Optional: \\{} +\n\n| *`containers`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerresult[$$ContainerResult$$] array__ | Containers contains the vulnerability reports for each container. +\nPopulated at read time by joining with VulnerabilityReport data. + | | Optional: \\{} +\n\n|===\n\n\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreportspec\"]\n==== WorkloadScanReportSpec\n\n\n\nWorkloadScanReportSpec defines the containers to scan.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreport[$$WorkloadScanReport$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`containers`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerref[$$ContainerRef$$] array__ | Containers contains the list of containers in the workload with their image references. + | | \n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreportstatus\"]\n==== WorkloadScanReportStatus\n\n\n\nWorkloadScanReportStatus contains the observed scan state for the workload.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanreport[$$WorkloadScanReport$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`containerStatuses`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerstatus[$$ContainerStatus$$] array__ | ContainerStatuses contains the scan status for each container. + | | Optional: \\{} +\n\n|===\n\n\n[id=\"{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-workloadscanvulnerabilityreport\"]\n==== WorkloadScanVulnerabilityReport\n\n\n\nWorkloadScanVulnerabilityReport contains vulnerability report data for a specific platform.\n\n\n\n.Appears In:\n****\n- xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-containerresult[$$ContainerResult$$]\n****\n\n[cols=\"20a,50a,15a,15a\", options=\"header\"]\n|===\n| Field | Description | Default | Validation\n| *`name`* __string__ | Name is the name of the VulnerabilityReport. + | | \n| *`namespace`* __string__ | Namespace is the namespace where the VulnerabilityReport is stored. + | | \n| *`imageMetadata`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-imagemetadata[$$ImageMetadata$$]__ | ImageMetadata contains the VulnerabilityReport's image metadata. + | | \n| *`report`* __xref:{anchor_prefix}-github-com-kubewarden-sbomscanner-api-storage-v1alpha1-report[$$Report$$]__ | Report is the actual vulnerability scan report. + | | \n|===\n\n\n": * docs/sbom-scanner/version-0.13/modules/en/partials/crd-reference.adoc

GitHub Action workflow link

---

Created automatically by Updatecli Options: Most of Updatecli configuration is done via its manifest(s). If you close this pull request, Updatecli will automatically reopen it, the next time it runs. If you close this pull request and delete the base branch, Updatecli will automatically recreate it, erasing all previous commits made. Feel free to report any issues at github.com/updatecli/updatecli. If you find this tool useful, do not hesitate to star our GitHub repository as a sign of appreciation, and/or to tell us directly on our chat!

[netlify]

✅ Deploy Preview for docs-kubewarden-io ready!

Name	Link
🔨 Latest commit	0e9e813
🔍 Latest deploy log	https://app.netlify.com/projects/docs-kubewarden-io/deploys/6a7c7c575dd40b00088f9328
😎 Deploy Preview	https://deploy-preview-859--docs-kubewarden-io.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.