mirror of
https://github.com/kubescape/kubescape.git
synced 2026-02-14 09:59:54 +00:00
120 lines
4.8 KiB
Go
120 lines
4.8 KiB
Go
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/kubescape/go-logger"
|
|
"github.com/kubescape/go-logger/helpers"
|
|
"github.com/kubescape/k8s-interface/k8sinterface"
|
|
"github.com/kubescape/kubescape/v3/cmd/completion"
|
|
"github.com/kubescape/kubescape/v3/cmd/config"
|
|
"github.com/kubescape/kubescape/v3/cmd/download"
|
|
"github.com/kubescape/kubescape/v3/cmd/fix"
|
|
"github.com/kubescape/kubescape/v3/cmd/list"
|
|
"github.com/kubescape/kubescape/v3/cmd/operator"
|
|
"github.com/kubescape/kubescape/v3/cmd/patch"
|
|
"github.com/kubescape/kubescape/v3/cmd/scan"
|
|
"github.com/kubescape/kubescape/v3/cmd/update"
|
|
"github.com/kubescape/kubescape/v3/cmd/vap"
|
|
"github.com/kubescape/kubescape/v3/cmd/version"
|
|
"github.com/kubescape/kubescape/v3/core/cautils"
|
|
"github.com/kubescape/kubescape/v3/core/cautils/getter"
|
|
"github.com/kubescape/kubescape/v3/core/core"
|
|
"github.com/kubescape/kubescape/v3/core/meta"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var rootInfo cautils.RootInfo
|
|
|
|
var ksExamples = fmt.Sprintf(`
|
|
# Scan a Kubernetes cluster or YAML files for image vulnerabilities and misconfigurations
|
|
%[1]s scan
|
|
|
|
# List supported controls
|
|
%[1]s list controls
|
|
|
|
# Download artifacts (air-gapped environment support)
|
|
%[1]s download artifacts
|
|
|
|
# View cached configurations
|
|
%[1]s config view
|
|
`, cautils.ExecName())
|
|
|
|
func NewDefaultKubescapeCommand() *cobra.Command {
|
|
ks := core.NewKubescape()
|
|
return getRootCmd(ks)
|
|
}
|
|
|
|
func getRootCmd(ks meta.IKubescape) *cobra.Command {
|
|
|
|
rootCmd := &cobra.Command{
|
|
Use: "kubescape",
|
|
Short: "Kubescape is a tool for testing Kubernetes security posture. Docs: https://hub.armosec.io/docs",
|
|
Example: ksExamples,
|
|
PersistentPreRun: func(cmd *cobra.Command, args []string) {
|
|
k8sinterface.SetClusterContextName(rootInfo.KubeContext)
|
|
initLogger()
|
|
initLoggerLevel()
|
|
initEnvironment()
|
|
initCacheDir()
|
|
},
|
|
}
|
|
|
|
if cautils.IsKrewPlugin() {
|
|
// Invoked as a kubectl plugin.
|
|
|
|
// Cobra doesn't have a way to specify a two word command (i.e. "kubectl kubescape"), so set a custom usage template
|
|
// with kubectl in it. Cobra will use this template for the root and all child commands.
|
|
oldUsageTemplate := rootCmd.UsageTemplate()
|
|
newUsageTemplate := strings.NewReplacer("{{.UseLine}}", "kubectl {{.UseLine}}", "{{.CommandPath}}", "kubectl {{.CommandPath}}").Replace(oldUsageTemplate)
|
|
rootCmd.SetUsageTemplate(newUsageTemplate)
|
|
}
|
|
|
|
rootCmd.PersistentFlags().StringVar(&rootInfo.DiscoveryServerURL, "server", "", "Backend discovery server URL")
|
|
|
|
rootCmd.PersistentFlags().MarkDeprecated("environment", "'environment' is no longer supported, Use 'server' instead. Feel free to contact the Kubescape maintainers for more information.")
|
|
rootCmd.PersistentFlags().MarkDeprecated("env", "'env' is no longer supported, Use 'server' instead. Feel free to contact the Kubescape maintainers for more information.")
|
|
rootCmd.PersistentFlags().MarkHidden("environment")
|
|
rootCmd.PersistentFlags().MarkHidden("env")
|
|
|
|
rootCmd.PersistentFlags().StringVar(&rootInfo.LoggerName, "logger-name", "", fmt.Sprintf("Logger name. Supported: %s [$KS_LOGGER_NAME]", strings.Join(logger.ListLoggersNames(), "/")))
|
|
rootCmd.PersistentFlags().MarkHidden("logger-name")
|
|
|
|
rootCmd.PersistentFlags().StringVarP(&rootInfo.Logger, "logger", "l", helpers.InfoLevel.String(), fmt.Sprintf("Logger level. Supported: %s [$KS_LOGGER]", strings.Join(helpers.SupportedLevels(), "/")))
|
|
rootCmd.PersistentFlags().StringVar(&rootInfo.CacheDir, "cache-dir", getter.DefaultLocalStore, "Cache directory [$KS_CACHE_DIR]")
|
|
rootCmd.PersistentFlags().BoolVarP(&rootInfo.DisableColor, "disable-color", "", false, "Disable color output for logging")
|
|
rootCmd.PersistentFlags().BoolVarP(&rootInfo.EnableColor, "enable-color", "", false, "Force enable color output for logging")
|
|
|
|
rootCmd.PersistentFlags().StringVarP(&rootInfo.KubeContext, "kube-context", "", "", "Kube context. Default will use the current-context")
|
|
// Supported commands
|
|
rootCmd.AddCommand(scan.GetScanCommand(ks))
|
|
rootCmd.AddCommand(download.GetDownloadCmd(ks))
|
|
rootCmd.AddCommand(list.GetListCmd(ks))
|
|
rootCmd.AddCommand(completion.GetCompletionCmd())
|
|
rootCmd.AddCommand(version.GetVersionCmd())
|
|
rootCmd.AddCommand(config.GetConfigCmd(ks))
|
|
rootCmd.AddCommand(update.GetUpdateCmd())
|
|
rootCmd.AddCommand(fix.GetFixCmd(ks))
|
|
rootCmd.AddCommand(patch.GetPatchCmd(ks))
|
|
rootCmd.AddCommand(vap.GetVapHelperCmd())
|
|
rootCmd.AddCommand(operator.GetOperatorCmd(ks))
|
|
|
|
// deprecated commands
|
|
rootCmd.AddCommand(&cobra.Command{
|
|
Use: "submit",
|
|
Deprecated: "This command is deprecated. Contact Kubescape maintainers for more information.",
|
|
})
|
|
rootCmd.AddCommand(&cobra.Command{
|
|
Use: "delete",
|
|
Deprecated: "This command is deprecated. Contact Kubescape maintainers for more information.",
|
|
})
|
|
|
|
return rootCmd
|
|
}
|
|
|
|
func Execute() error {
|
|
ks := NewDefaultKubescapeCommand()
|
|
return ks.Execute()
|
|
}
|