cmd

Documentation

Overview

Package cmd provides primitives for implementing Starboard CLI.

Index

• func ComplianceNameFromArgs(args []string, suffix ...string) (types.NamespacedName, error)
• func GetComplianceReport(ctx context.Context, client client.Client, namespaceName types.NamespacedName, ...) error
• func GetNodes(ctx context.Context, clientset kubernetes.Interface, names ...string) ([]corev1.Node, error)
• func NewCleanupCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command
• func NewConfigCmd(cf *genericclioptions.ConfigFlags, outWriter io.Writer) *cobra.Command
• func NewGetClusterComplianceReportsCmd(executable string, cf *genericclioptions.ConfigFlags, out io.Writer) *cobra.Command
• func NewGetCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags, ...) *cobra.Command
• func NewGetConfigAuditReportsCmd(executable string, cf *genericclioptions.ConfigFlags, out io.Writer) *cobra.Command
• func NewGetVulnerabilityReportsCmd(executable string, cf *genericclioptions.ConfigFlags, out io.Writer) *cobra.Command
• func NewInitCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command
• func NewReportCmd(info starboard.BuildInfo, cf *genericclioptions.ConfigFlags, out io.Writer) *cobra.Command
• func NewRootCmd(buildInfo starboard.BuildInfo, args []string, outWriter io.Writer, ...) *cobra.Command
• func NewScanCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command
• func NewScanConfigAuditReportsCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command
• func NewScanKubeBenchReportsCmd(cf *genericclioptions.ConfigFlags) *cobra.Command
• func NewScanKubeHunterReportsCmd(cf *genericclioptions.ConfigFlags) *cobra.Command
• func NewScanVulnerabilityReportsCmd(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) *cobra.Command
• func NewVersionCmd(buildInfo starboard.BuildInfo, outWriter io.Writer) *cobra.Command
• func Run(version starboard.BuildInfo, args []string, outWriter io.Writer, ...) error
• func ScanConfigAuditReports(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) func(cmd *cobra.Command, args []string) error
• func ScanKubeBenchReports(cf *genericclioptions.ConfigFlags) func(cmd *cobra.Command, args []string) error
• func ScanKubeHunterReports(cf *genericclioptions.ConfigFlags) func(cmd *cobra.Command, args []string) (err error)
• func ScanVulnerabilityReports(buildInfo starboard.BuildInfo, cf *genericclioptions.ConfigFlags) func(cmd *cobra.Command, args []string) error
• func SetGlobalFlags(cf *genericclioptions.ConfigFlags, cmd *cobra.Command)
• func WorkloadFromArgs(mapper meta.RESTMapper, namespace string, args []string) (workload kube.ObjectRef, gvk schema.GroupVersionKind, err error)
• type Installer
  • func NewInstaller(buildInfo starboard.BuildInfo, clientset kubernetes.Interface, ...) *Installer
  • func (m *Installer) Install(ctx context.Context) error
  • func (m *Installer) Uninstall(ctx context.Context) error
• type LocalFlags

Functions

func ComplianceNameFromArgs

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

func GetComplianceReport

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

func GetNodes

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

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

func NewGetClusterComplianceReportsCmd

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

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

func NewGetVulnerabilityReportsCmd

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

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

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

func NewScanConfigAuditReportsCmd

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

func NewScanKubeBenchReportsCmd

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

func NewScanKubeHunterReportsCmd

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

func NewScanVulnerabilityReportsCmd

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

func NewVersionCmd

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

func Run

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

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

func ScanKubeBenchReports

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

func ScanKubeHunterReports

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

func ScanVulnerabilityReports

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

func SetGlobalFlags

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

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

func NewInstaller

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

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

Install creates Kubernetes API objects required by Starboard CLI.

func (*Installer) Uninstall

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

type LocalFlags

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