blackduck

Documentation

Index

• Variables
• func CRUDServiceOrRoute(restConfig *rest.Config, kubeClient *kubernetes.Clientset, namespace string, ...) error
• func CorePodSecurityContextToHelm(psc corev1.PodSecurityContext) map[string]interface{}
• func CreateSelfSignedCert() (string, string)
• func FlagWasSet(flagset *pflag.FlagSet, flagName string) bool
• func GetAuthCertificateSecret(secretName string, namespace string, cert []byte) (*corev1.Secret, error)
• func GetCertificateSecret(secretName string, namespace string, cert []byte, key []byte) (*corev1.Secret, error)
• func GetCertificateSecretFromFile(secretName, namespace, certPath, keyPath string) (*corev1.Secret, error)
• func GetCertsFromFlagsAndSetHelmValue(name string, namespace string, flagset *pflag.FlagSet, ...) ([]corev1.Secret, error)
• func GetProxyCertificateSecret(secretName string, namespace string, cert []byte) (*corev1.Secret, error)
• func ImageRegistryIsSet(imageRegistries []string, imageName string) bool
• func OperatorAPISecurityContextToHelm(opSecurityContext api.SecurityContext) map[string]interface{}
• func OperatorAffinityToHelm(opAffinity []v1.NodeAffinity) map[string]interface{}
• func SetBlackDuckImageRegistriesInHelmValuesMap(helmValues map[string]interface{}, imageRegistries []string)
• type FlagTree
  • func GetDefaultFlagTree() *FlagTree
• type HelmValuesFromCobraFlags
  • func NewHelmValuesFromCobraFlags() *HelmValuesFromCobraFlags
  • func (ctl *HelmValuesFromCobraFlags) AddCobraFlagsToCommand(cmd *cobra.Command, isCreateCmd 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) MarkRequiredFlags(flagset *pflag.FlagSet, version string, updating bool) error
  • func (ctl *HelmValuesFromCobraFlags) SetArgs(args map[string]interface{})
  • func (ctl *HelmValuesFromCobraFlags) VerifyChartVersionSupportsChangedFlags(flagset *pflag.FlagSet, version string) error

Variables

var DefaultFlagTree = FlagTree{

	Version: globals.BlackDuckVersion,

	Registry: "docker.io/blackducksoftware",

	PersistentStorage: "true",
	Size:              "small",

	ExposeService: util.NONE,

	ExternalPostgresPort: 5432,
	ExternalPostgresUser: "blackduck_user",
	ExternalPostgresSsl:  "true",
	PostgresClaimSize:    "150Gi",

	EnableBinaryAnalysis:   false,
	EnableSourceCodeUpload: false,
}

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

Functions

func CRUDServiceOrRoute

func CRUDServiceOrRoute(restConfig *rest.Config, kubeClient *kubernetes.Clientset, namespace string, name string, isExposedUI interface{}, exposedServiceType interface{}, isChanged bool) error

CRUDServiceOrRoute will create or update Black Duck exposed service or route in case of OpenShift

func CorePodSecurityContextToHelm

func CorePodSecurityContextToHelm(psc corev1.PodSecurityContext) map[string]interface{}

CorePodSecurityContextToHelm converts pod security context format for Helm Values NOTE: SecurityContext doens't have fsGroup (PodSecurityContext has fsGroup)

func CreateSelfSignedCert

func CreateSelfSignedCert() (string, string)

CreateSelfSignedCert will create a random self signed certificate

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

func GetAuthCertificateSecret

func GetAuthCertificateSecret(secretName string, namespace string, cert []byte) (*corev1.Secret, error)

GetAuthCertificateSecret get the authentication CA certificate secret from file bytes

func GetCertificateSecret

func GetCertificateSecret(secretName string, namespace string, cert []byte, key []byte) (*corev1.Secret, error)

GetCertificateSecret get the webserver or nginx certificate secret from file bytes

func GetCertificateSecretFromFile

func GetCertificateSecretFromFile(secretName, namespace, certPath, keyPath string) (*corev1.Secret, error)

GetCertificateSecretFromFile generates secret from file

func GetCertsFromFlagsAndSetHelmValue

func GetCertsFromFlagsAndSetHelmValue(name string, namespace string, flagset *pflag.FlagSet, helmVal map[string]interface{}) ([]corev1.Secret, error)

GetCertsFromFlagsAndSetHelmValue converts synopsysctl certificate files to kube secrets

func GetProxyCertificateSecret

func GetProxyCertificateSecret(secretName string, namespace string, cert []byte) (*corev1.Secret, error)

GetProxyCertificateSecret get the proxy certificate secret from file bytes

func ImageRegistryIsSet

func ImageRegistryIsSet(imageRegistries []string, imageName string) bool

ImageRegistryIsSet checks if imageRegistries contains and image with the name imageName

func OperatorAPISecurityContextToHelm

func OperatorAPISecurityContextToHelm(opSecurityContext api.SecurityContext) map[string]interface{}

OperatorAPISecurityContextToHelm converts security context format for Helm Values NOTE: SecurityContext doens't have fsGroup (PodSecurityContext has fsGroup)

func OperatorAffinityToHelm

func OperatorAffinityToHelm(opAffinity []v1.NodeAffinity) map[string]interface{}

OperatorAffinityToHelm ...

func SetBlackDuckImageRegistriesInHelmValuesMap

func SetBlackDuckImageRegistriesInHelmValuesMap(helmValues map[string]interface{}, imageRegistries []string)

SetBlackDuckImageRegistriesInHelmValuesMap uses the image name to set the registry and tag in the Helm Chart for each image in imageRegistries

Types

type FlagTree

type FlagTree struct {
	Version string

	Registry        string
	PullSecrets     []string
	ImageRegistries []string

	PvcStorageClass             string
	PersistentStorage           string
	PVCFilePath                 string
	Size                        string
	DeploymentResourcesFilePath string

	ExposeService   string
	ExposedNodePort string

	ExternalPostgresHost          string
	ExternalPostgresPort          int
	ExternalPostgresAdmin         string
	ExternalPostgresUser          string
	ExternalPostgresSsl           string
	ExternalPostgresAdminPassword string
	ExternalPostgresUserPassword  string
	PostgresClaimSize             string
	AdminPassword                 string
	UserPassword                  string

	CertificateName          string
	CertificateFilePath      string
	CertificateKeyFilePath   string
	ProxyCertificateFilePath string
	AuthCustomCAFilePath     string

	SealKey string

	Environs []string

	LivenessProbes         string
	EnableBinaryAnalysis   bool
	EnableSourceCodeUpload bool

	NodeAffinityFilePath    string
	SecurityContextFilePath string
}

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

func GetDefaultFlagTree

func GetDefaultFlagTree() *FlagTree

GetDefaultFlagTree ...

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 creates a new HelmValuesFromCobraFlags type

func (*HelmValuesFromCobraFlags) AddCobraFlagsToCommand

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

AddCobraFlagsToCommand adds flags to a Cobra Command that are need for BlackDuck's Spec. The flags map to fields in the CRSpecBuilderFromCobraFlags struct.

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

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) MarkRequiredFlags

func (ctl *HelmValuesFromCobraFlags) MarkRequiredFlags(flagset *pflag.FlagSet, version string, updating bool) error

MarkRequiredFlags ...

func (*HelmValuesFromCobraFlags) SetArgs

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

SetArgs set the map to values

func (*HelmValuesFromCobraFlags) VerifyChartVersionSupportsChangedFlags

func (ctl *HelmValuesFromCobraFlags) VerifyChartVersionSupportsChangedFlags(flagset *pflag.FlagSet, version string) error

VerifyChartVersionSupportsChangedFlags ...