opssight

Documentation

Index

• Variables
• func FlagWasSet(flagset *pflag.FlagSet, flagName string) bool
• type FlagTree
• type HelmValuesFromCobraFlags
  • func NewHelmValuesFromCobraFlags() *HelmValuesFromCobraFlags
  • func (ctl *HelmValuesFromCobraFlags) AddCobraFlagsToCommand(cmd *cobra.Command, master bool)
  • func (ctl *HelmValuesFromCobraFlags) CheckValuesFromFlags(flagset *pflag.FlagSet) error
  • func (ctl *HelmValuesFromCobraFlags) GenerateHelmFlagsFromCobraFlags(flagset *pflag.FlagSet) (map[string]interface{}, error)
  • func (ctl *HelmValuesFromCobraFlags) GetArgs() map[string]interface{}
  • func (ctl *HelmValuesFromCobraFlags) SetArgs(args map[string]interface{})

Variables

var DefaultFlagTree = FlagTree{

	Version: globals.OpsSightVersion,

	LogLevel: "debug",

	BlackduckTLSVerification: "false",

	EnableMetrics:    "true",
	PrometheusExpose: util.NONE,

	PerceptorExpose:                         util.NONE,
	PerceptorCheckForStalledScansPauseHours: 999999,
	PerceptorStalledScanClientTimeoutHours:  999999,
	PerceptorModelMetricsPauseSeconds:       15,
	PerceptorUnknownImagePauseMilliseconds:  15000,
	PerceptorClientTimeoutMilliseconds:      100000,

	PerceiverAnnotationIntervalSeconds: 30,
	PerceiverDumpIntervalMinutes:       30,

	PerceiverEnablePodPerceiver: "true",

	ScannerPodScannerClientTimeoutSeconds: 600,
	ScannerPodReplicaCount:                1,
	ScannerPodImageDirectory:              "/var/images",

	ScannerPodImageFacadeImagePullerType: "skopeo",

	PerceiverEnableImagePerceiver: "false",

	PerceiverEnableQuayPerceiver: "false",
	PerceiverQuayExpose:          util.NONE,

	PerceiverEnableArtifactoryPerceiver:       "false",
	PerceiverEnableArtifactoryPerceiverDumper: "false",
	PerceiverArtifactoryExpose:                util.NONE,
}

DefaultFlagTree ... [Dev Note]: These should match the Helm Chart's Values.yaml

Functions

func FlagWasSet

func FlagWasSet(flagset *pflag.FlagSet, flagName string) bool

FlagWasSet returns true if a flag was changed and it exists, otherwise it returns false

Types

type FlagTree

type FlagTree struct {
	Version                     string
	DeploymentResourcesFilePath string
	// IsUpstream                                      string
	Registry          string
	RegistryNamespace string
	PullSecrets       []string
	// ImageRegistries                                 []string
	LogLevel                           string
	BlackduckExternalHostsFilePath     string
	BlackduckSecuredRegistriesFilePath string
	// BlackduckConnectionsEnvironmentVaraiableName    string
	BlackduckTLSVerification string
	// BlackduckPassword                               string
	// BlackduckInitialCount                           int
	// BlackduckMaxCount                               int
	// BlackduckType                                   string
	PrometheusExpose                        string
	EnableMetrics                           string
	PerceptorExpose                         string
	PerceptorCheckForStalledScansPauseHours int
	PerceptorStalledScanClientTimeoutHours  int
	PerceptorModelMetricsPauseSeconds       int
	PerceptorUnknownImagePauseMilliseconds  int
	PerceptorClientTimeoutMilliseconds      int
	PerceiverTLSCertificatePath             string
	PerceiverTLSKeyPath                     string
	PerceiverAnnotationIntervalSeconds      int
	PerceiverDumpIntervalMinutes            int
	PerceiverEnablePodPerceiver             string
	PerceiverPodPerceiverNamespaceFilter    string
	ScannerPodScannerClientTimeoutSeconds   int
	ScannerPodReplicaCount                  int
	ScannerPodImageDirectory                string
	// ScannerPodImageFacadeInternalRegistriesFilePath string
	ScannerPodImageFacadeImagePullerType      string
	PerceiverEnableImagePerceiver             string
	PerceiverEnableQuayPerceiver              string
	PerceiverQuayExpose                       string
	PerceiverEnableArtifactoryPerceiver       string
	PerceiverEnableArtifactoryPerceiverDumper string
	PerceiverArtifactoryExpose                string
}

FlagTree is a set of fields needed to configure the Opssight Helm Chart

type HelmValuesFromCobraFlags

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

HelmValuesFromCobraFlags is a type for converting synopsysctl flags to Helm Chart fields and values args: map of helm chart field to value

func NewHelmValuesFromCobraFlags

func NewHelmValuesFromCobraFlags() *HelmValuesFromCobraFlags

NewHelmValuesFromCobraFlags returns an initialized HelmValuesFromCobraFlags

func (*HelmValuesFromCobraFlags) AddCobraFlagsToCommand

func (ctl *HelmValuesFromCobraFlags) AddCobraFlagsToCommand(cmd *cobra.Command, master bool)

AddCobraFlagsToCommand adds flags for the Opssight helm chart to the cmd master=true is used to add all flags for creating an instance master=false is used to add a subset of flags for updating an instance

func (*HelmValuesFromCobraFlags) CheckValuesFromFlags

func (ctl *HelmValuesFromCobraFlags) CheckValuesFromFlags(flagset *pflag.FlagSet) error

CheckValuesFromFlags returns an error if a value stored in the struct will not be able to be used in the opssightSpec

func (*HelmValuesFromCobraFlags) GenerateHelmFlagsFromCobraFlags

func (ctl *HelmValuesFromCobraFlags) GenerateHelmFlagsFromCobraFlags(flagset *pflag.FlagSet) (map[string]interface{}, error)

GenerateHelmFlagsFromCobraFlags checks each flag in synopsysctl and updates the map to contain the corresponding helm chart field and value

func (*HelmValuesFromCobraFlags) GetArgs

func (ctl *HelmValuesFromCobraFlags) GetArgs() map[string]interface{}

GetArgs returns the map of helm chart fields to values

func (*HelmValuesFromCobraFlags) SetArgs

func (ctl *HelmValuesFromCobraFlags) SetArgs(args map[string]interface{})

SetArgs set the map to values