cmd

package
v0.15.20 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 1, 2024 License: Apache-2.0 Imports: 41 Imported by: 0

Documentation

Overview

Package cmd provides primitives for implementing Starboard CLI.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ComplianceNameFromArgs added in v0.15.0

func ComplianceNameFromArgs(args []string, suffix ...string) (types.NamespacedName, error)

func GetComplianceReport added in v0.15.0

func GetComplianceReport(ctx context.Context, client client.Client, namespaceName types.NamespacedName, out io.Writer, report client.Object) error

func GetNodes added in v0.11.0

func GetNodes(ctx context.Context, clientset kubernetes.Interface, names ...string) ([]corev1.Node, error)

GetNodes returns nodes by names. If the list of names is empty it returns all nodes.

func NewCleanupCmd

func NewCleanupCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command

func NewConfigCmd added in v0.6.0

func NewConfigCmd(cf *genericclioptions.ConfigFlags, outWriter io.Writer) *cobra.Command

func NewGetClusterComplianceReportsCmd added in v0.15.0

func NewGetClusterComplianceReportsCmd(executable string, cf *genericclioptions.ConfigFlags, out io.Writer) *cobra.Command

func NewGetCmd

func NewGetCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags, outWriter io.Writer) *cobra.Command

func NewGetConfigAuditReportsCmd added in v0.13.0

func NewGetConfigAuditReportsCmd(executable string, cf *genericclioptions.ConfigFlags, out io.Writer) *cobra.Command

func NewGetVulnerabilityReportsCmd added in v0.13.0

func NewGetVulnerabilityReportsCmd(executable string, cf *genericclioptions.ConfigFlags, out io.Writer) *cobra.Command

func NewInitCmd

func NewInitCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command

func NewReportCmd added in v0.13.0

func NewReportCmd(info starboard.BuildInfo, cf *genericclioptions.ConfigFlags, out io.Writer) *cobra.Command

func NewRootCmd

func NewRootCmd(buildInfo starboard.BuildInfo, args []string, outWriter io.Writer, errWriter io.Writer) *cobra.Command

func NewScanCmd added in v0.7.0

func NewScanCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command

func NewScanConfigAuditReportsCmd added in v0.7.0

func NewScanConfigAuditReportsCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command

func NewScanKubeBenchReportsCmd added in v0.7.0

func NewScanKubeBenchReportsCmd(cf *genericclioptions.ConfigFlags) *cobra.Command

func NewScanKubeHunterReportsCmd added in v0.7.0

func NewScanKubeHunterReportsCmd(cf *genericclioptions.ConfigFlags) *cobra.Command

func NewScanVulnerabilityReportsCmd added in v0.7.0

func NewScanVulnerabilityReportsCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command

func NewVersionCmd

func NewVersionCmd(buildInfo starboard.BuildInfo, outWriter io.Writer) *cobra.Command

func Run added in v0.3.0

func Run(version starboard.BuildInfo, args []string, outWriter io.Writer, errWriter io.Writer) error

Run is the entry point of the Starboard CLI. It runs the specified command based on the specified args.

func ScanConfigAuditReports added in v0.7.0

func ScanConfigAuditReports(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) func(cmd *cobra.Command, args []string) error

func ScanKubeBenchReports added in v0.7.0

func ScanKubeBenchReports(cf *genericclioptions.ConfigFlags) func(cmd *cobra.Command, args []string) error

func ScanKubeHunterReports added in v0.7.0

func ScanKubeHunterReports(cf *genericclioptions.ConfigFlags) func(cmd *cobra.Command, args []string) (err error)

func ScanVulnerabilityReports added in v0.7.0

func ScanVulnerabilityReports(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) func(cmd *cobra.Command, args []string) error

func SetGlobalFlags added in v0.2.1

func SetGlobalFlags(cf *genericclioptions.ConfigFlags, cmd *cobra.Command)

func WorkloadFromArgs

func WorkloadFromArgs(mapper meta.RESTMapper, namespace string, args []string) (workload kube.ObjectRef, gvk schema.GroupVersionKind, err error)

Types

type Installer added in v0.11.0

type Installer struct {
	// contains filtered or unexported fields
}

func NewInstaller added in v0.11.0

func NewInstaller(
	buildInfo starboard.BuildInfo,

	clientset kubernetes.Interface,
	clientsetext extapi.ApiextensionsV1Interface,
	client client.Client,
	configManager starboard.ConfigManager,
) *Installer

NewInstaller constructs an Installer with the given starboard.ConfigManager and kubernetes.Interface.

func (*Installer) Install added in v0.11.0

func (m *Installer) Install(ctx context.Context) error

Install creates Kubernetes API objects required by Starboard CLI.

func (*Installer) Uninstall added in v0.11.0

func (m *Installer) Uninstall(ctx context.Context) error

type LocalFlags added in v0.6.0

type LocalFlags struct {
	// contains filtered or unexported fields
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL