utils

package

v0.1.39 Latest Latest Go to latest Published: Aug 14, 2023 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubescape/operator

Links

Open Source Insights

Documentation ¶

Overview ¶

Package utils contains utilities common to all units of the Operator

The package includes:

- Common utilities

- Common test utilities, like constructors for test doubles etc

Index ¶

Constants
Variables
func AddCommandToChannel(ctx context.Context, cmd *apis.Command, workerPool *ants.PoolWithFunc)
func ExtractContainersToImageIDsFromPod(pod *core1.Pod) map[string]string
func ExtractImageID(imageID string) string
func InitKubescapeHttpClient() httputils.IHttpClient
func InitReporterHttpClient() httputils.IHttpClient
func InitVulnScanHttpClient() httputils.IHttpClient
func LoadEnvironmentVariables(ctx context.Context) (err error)
func MapToString(m map[string]interface{}) []string
func NewJobTracking(reporter reporterlib.IReporter) *apis.JobTracking
func NewK8sInterfaceFake(k8sClient k8s.Interface) *k8sinterface.KubernetesApi
type ClientMock
- func (c *ClientMock) Do(req *http.Request) (*http.Response, error)
type CredStruct
type Job
- func (j *Job) Context() context.Context
- func (j *Job) Obj() SessionObj
- func (j *Job) SetContext(ctx context.Context)
- func (j *Job) SetObj(sessionObj SessionObj)
type SessionObj
- func NewSessionObj(ctx context.Context, command *apis.Command, message, parentID, jobID string, ...) *SessionObj
- func (sessionObj *SessionObj) WatchErrors(ctx context.Context)

Constants ¶

View Source

const (
	ReleaseBuildTagEnvironmentVariable          = "RELEASE"
	NamespaceEnvironmentVariable                = "NAMESPACE"
	ConfigEnvironmentVariable                   = "CONFIG"
	PortEnvironmentVariable                     = "PORT"
	CleanUpDelayEnvironmentVariable             = "CLEANUP_DELAY"
	TriggerSecurityFrameworkEnvironmentVariable = "TRIGGER_SECURITY_FRAMEWORK"
	ConcurrencyEnvironmentVariable              = "WORKER_CONCURRENCY"
)

View Source

const ContainerToImageIdsArg = "containerToImageIDs"

View Source

const KubescapeRequestPathV1 = "v1/scan"

View Source

const KubescapeRequestStatusV1 = "v1/status"

View Source

const KubescapeScanV1 = "scanV1"

Variables ¶

View Source

var (
	Namespace                string        = "default" // default namespace
	RestAPIPort              string        = "4002"    // default port
	CleanUpRoutineInterval   time.Duration = 10 * time.Minute
	ConcurrencyWorkers       int           = 3
	TriggerSecurityFramework bool          = false
)

View Source

var ClusterConfig = &utilsmetadata.ClusterConfig{}

View Source

var ReporterHttpClient httputils.IHttpClient

Functions ¶

func AddCommandToChannel ¶ added in v0.1.21

func AddCommandToChannel(ctx context.Context, cmd *apis.Command, workerPool *ants.PoolWithFunc)

func ExtractContainersToImageIDsFromPod ¶ added in v0.1.21

func ExtractContainersToImageIDsFromPod(pod *core1.Pod) map[string]string

func ExtractImageID ¶ added in v0.1.21

func ExtractImageID(imageID string) string

func InitKubescapeHttpClient ¶

func InitKubescapeHttpClient() httputils.IHttpClient

func InitReporterHttpClient ¶

func InitReporterHttpClient() httputils.IHttpClient

func InitVulnScanHttpClient ¶

func InitVulnScanHttpClient() httputils.IHttpClient

func LoadEnvironmentVariables ¶

func LoadEnvironmentVariables(ctx context.Context) (err error)

func MapToString ¶

func MapToString(m map[string]interface{}) []string

func NewJobTracking ¶

func NewJobTracking(reporter reporterlib.IReporter) *apis.JobTracking

func NewK8sInterfaceFake ¶ added in v0.1.21

func NewK8sInterfaceFake(k8sClient k8s.Interface) *k8sinterface.KubernetesApi

NewK8sInterfaceFake returns a new K8sInterface with a fake Kubernetes Client attached

This function is a Dependency Injection-friendly version for the `KubernetesApi` constructor that allows to inject any Kubernetes Clients. For example, the official fake Kubernetes client, so unit tests would have a suitable test double instead of trying to talk to a real cluster

Types ¶

type ClientMock ¶

type ClientMock struct {
}

func (*ClientMock) Do ¶

func (c *ClientMock) Do(req *http.Request) (*http.Response, error)

type CredStruct ¶

type CredStruct struct {
	User     string `json:"user"`
	Password string `json:"password"`
	Customer string `json:"customer"`
}

CredStruct holds the various credentials needed to do login into CA BE

type Job ¶ added in v0.1.39

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

func (*Job) Context ¶ added in v0.1.39

func (j *Job) Context() context.Context

func (*Job) Obj ¶ added in v0.1.39

func (j *Job) Obj() SessionObj

func (*Job) SetContext ¶ added in v0.1.39

func (j *Job) SetContext(ctx context.Context)

func (*Job) SetObj ¶ added in v0.1.39

func (j *Job) SetObj(sessionObj SessionObj)

type SessionObj ¶

type SessionObj struct {
	Command  apis.Command          `json:"command"`
	Reporter reporterlib.IReporter `json:"reporter"`
	ErrChan  chan error            `json:"-"`
}

Commands list of commands received from websocket

func NewSessionObj ¶

func NewSessionObj(ctx context.Context, command *apis.Command, message, parentID, jobID string, actionNumber int) *SessionObj

func (*SessionObj) WatchErrors ¶

func (sessionObj *SessionObj) WatchErrors(ctx context.Context)

Source Files ¶

View all Source files

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