From 15e6fcaa7e130b660b9d6d35b1270654df00d726 Mon Sep 17 00:00:00 2001 From: DmitriyLewen Date: Wed, 24 Apr 2024 14:23:59 +0600 Subject: [PATCH] refactor ConfigName's of k8s flags --- .../references/configuration/config-file.md | 47 +++++++++---------- pkg/flag/kubernetes_flags.go | 18 +++---- 2 files changed, 30 insertions(+), 35 deletions(-) diff --git a/docs/docs/references/configuration/config-file.md b/docs/docs/references/configuration/config-file.md index 467b0d163051..7996c34596c7 100644 --- a/docs/docs/references/configuration/config-file.md +++ b/docs/docs/references/configuration/config-file.md @@ -459,19 +459,28 @@ kubernetes: - workload - infra + # Same as '--k8s-version' + # Default is empty + k8s-version: 1.21.0 + # Same as '--tolerations' # Default is empty tolerations: - key1=value1:NoExecute - key2=value2:NoSchedule - # Same as '--qps' - # Default is 5.0 - qps: 5.0 + # Same as '--all-namespaces' + # Default is false + all-namespaces: false - # Same as '--burst' - # Default is 10 - burst: 10 + node-collector: + # Same as '--node-collector-namespace' + # Default is 'trivy-temp' + namespace: ~/.kube/config2 + + # Same as '--node-collector-imageref' + # Default is 'ghcr.io/aquasecurity/node-collector:0.0.9' + imageref: ghcr.io/aquasecurity/node-collector:0.0.9 exclude: # Same as '--exclude-owned' @@ -484,27 +493,13 @@ kubernetes: - kubernetes.io/arch:arm64 - team:dev - # Same as '--all-namespaces' - # Default is false - all: - namespaces: false + # Same as '--qps' + # Default is 5.0 + qps: 5.0 - # Same as '--k8s-version' - # Default is empty - k8s: - version: 1.21.0 - - # Same as '--node-collector-imageref' - # Default is 'ghcr.io/aquasecurity/node-collector:0.0.9' - node: - collector: - imageref: ghcr.io/aquasecurity/node-collector:0.0.9 - -# Same as '--node-collector-namespace' -# Default is 'trivy-temp' -node: - collector: - namespace: ~/.kube/config2 + # Same as '--burst' + # Default is 10 + burst: 10 ``` ## Repository Options diff --git a/pkg/flag/kubernetes_flags.go b/pkg/flag/kubernetes_flags.go index 7a87040ba698..a2f47ace08d9 100644 --- a/pkg/flag/kubernetes_flags.go +++ b/pkg/flag/kubernetes_flags.go @@ -44,7 +44,7 @@ var ( } K8sVersionFlag = Flag[string]{ Name: "k8s-version", - ConfigName: "kubernetes.k8s.version", + ConfigName: "kubernetes.k8s-version", Usage: "specify k8s version to validate outdated api by it (example: 1.21.0)", } TolerationsFlag = Flag[[]string]{ @@ -54,16 +54,22 @@ var ( } AllNamespaces = Flag[bool]{ Name: "all-namespaces", - ConfigName: "kubernetes.all.namespaces", + ConfigName: "kubernetes.all-namespaces", Shorthand: "A", Usage: "fetch resources from all cluster namespaces", } NodeCollectorNamespace = Flag[string]{ Name: "node-collector-namespace", - ConfigName: "node.collector.namespace", + ConfigName: "kubernetes.node-collector.namespace", Default: "trivy-temp", Usage: "specify the namespace in which the node-collector job should be deployed", } + NodeCollectorImageRef = Flag[string]{ + Name: "node-collector-imageref", + ConfigName: "kubernetes.node-collector.imageref", + Default: "ghcr.io/aquasecurity/node-collector:0.0.9", + Usage: "indicate the image reference for the node-collector scan job", + } ExcludeOwned = Flag[bool]{ Name: "exclude-owned", ConfigName: "kubernetes.exclude.owned", @@ -74,12 +80,6 @@ var ( ConfigName: "kubernetes.exclude.nodes", Usage: "indicate the node labels that the node-collector job should exclude from scanning (example: kubernetes.io/arch:arm64,team:dev)", } - NodeCollectorImageRef = Flag[string]{ - Name: "node-collector-imageref", - ConfigName: "kubernetes.node.collector.imageref", - Default: "ghcr.io/aquasecurity/node-collector:0.0.9", - Usage: "indicate the image reference for the node-collector scan job", - } QPS = Flag[float64]{ Name: "qps", ConfigName: "kubernetes.qps",