risk_scanner

Documentation

Index

• type AnalyzeOption
• type Client
  • func NewClient(conf *Config) *Client
  • func (c *Client) IsAnalyzeRunning() (bool, error)
  • func (c *Client) PostAnalyze(a AnalyzeOption) error
  • func (c *Client) PostResource(a interface{}) error
  • func (c *Client) SendExitInstruction() error
• type Config
  • func DefaultConfig() *Config
  • func ReadEnvConfig() *Config
• type Controller
• type RiskController
  • func NewController() *RiskController
  • func (c *RiskController) CTRL() Controller
  • func (c *RiskController) Run(ctx context.Context, policy *v1alpha1.InspectionPolicy) error
  • func (c *RiskController) WithK8sClient(cli client.Client) *RiskController
  • func (c *RiskController) WithScheme(scheme *runtime.Scheme) *RiskController
• type Server
  • func NewServer() *Server
  • func (s *Server) Analyze(option AnalyzeOption)
  • func (s *Server) Clear()
  • func (s *Server) Run(address string)
  • func (s *Server) WithAdapter(Adapter providers.Adapter) *Server
  • func (s *Server) WithContext(ctx context.Context) *Server
  • func (s *Server) WithPolicy(policy *v1alpha1.InspectionPolicy) *Server
• type Status

Types

type AnalyzeOption

type AnalyzeOption struct {
	//DumpAssessReport bool
	SkipImages []string
}

AnalyzeOption analyze option

type Client

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

Client to post requests

func NewClient

func NewClient(conf *Config) *Client

NewClient new client

func (*Client) IsAnalyzeRunning

func (c *Client) IsAnalyzeRunning() (bool, error)

IsAnalyzeRunning get analyze status

func (*Client) PostAnalyze

func (c *Client) PostAnalyze(a AnalyzeOption) error

PostAnalyze ask server to analyze resources

func (*Client) PostResource

func (c *Client) PostResource(a interface{}) error

func (*Client) SendExitInstruction

func (c *Client) SendExitInstruction() error

SendExitInstruction send exit instruction

type Config

type Config struct {
	Server     string `json:"server"`
	StandAlone bool   `json:"standalone"`
}

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig read configuration from env

func ReadEnvConfig

func ReadEnvConfig() *Config

ReadEnvConfig read configuration from env

type Controller

type Controller interface {
	// Run inspection.
	Run(ctx context.Context, policy *v1alpha1.InspectionPolicy) error
}

Controller controls the inspection flow.

type RiskController

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

func NewController

func NewController() *RiskController

NewController news a RiskController.

func (*RiskController) CTRL

func (c *RiskController) CTRL() Controller

CTRL returns RiskController interface.

func (*RiskController) Run

func (c *RiskController) Run(ctx context.Context, policy *v1alpha1.InspectionPolicy) error

func (*RiskController) WithK8sClient

func (c *RiskController) WithK8sClient(cli client.Client) *RiskController

WithK8sClient sets k8s client.

func (*RiskController) WithScheme

func (c *RiskController) WithScheme(scheme *runtime.Scheme) *RiskController

WithScheme sets runtime scheme.

type Server

type Server struct {
	Workloads riskdata.Workloads
	Evaluator riskdata.Evaluator
	IsRunning bool
	Images    map[string]*riskdata.ImageItem
	Last      int64
	// contains filtered or unexported fields
}

Server the server

func NewServer

func NewServer() *Server

NewServer new server instance

func (*Server) Analyze

func (s *Server) Analyze(option AnalyzeOption)

func (*Server) Clear

func (s *Server) Clear()

func (*Server) Run

func (s *Server) Run(address string)

Run turn the server

func (*Server) WithAdapter

func (s *Server) WithAdapter(Adapter providers.Adapter) *Server

WithAdapter sets adapter.

func (*Server) WithContext

func (s *Server) WithContext(ctx context.Context) *Server

func (*Server) WithPolicy

func (s *Server) WithPolicy(policy *v1alpha1.InspectionPolicy) *Server

WithPolicy sets the policy

type Status

type Status struct {
	IsRunning bool  `json:"is_running"`
	Last      int64 `json:"last"`
}

Status risk evaluation status