discovery

Documentation

Index

• Constants
• type Configuration
• type DiscoveryEvent
• type DiscoveryEventType
• type Service
  • func NewService(opts ...ServiceOption) *Service
  • func (svc *Service) Authorizer() api.Authorizer
  • func (svc *Service) Query(_ context.Context, req *discovery.QueryRequest) (res *discovery.QueryResponse, err error)
  • func (svc *Service) SetAuthorizer(auth api.Authorizer)
  • func (svc *Service) Shutdown()
  • func (svc *Service) Start(_ context.Context, _ *discovery.StartDiscoveryRequest) (resp *discovery.StartDiscoveryResponse, err error)
  • func (svc *Service) StartDiscovery(discoverer discovery.Discoverer)
• type ServiceOption
  • func WithAssessmentAddress(address string, opts ...grpc.DialOption) ServiceOption
  • func WithCloudServiceID(ID string) ServiceOption
  • func WithOAuth2Authorizer(config *clientcredentials.Config) ServiceOption
  • func WithProviders(providersList []string) ServiceOption

Constants

const (
	ProviderAWS   = "aws"
	ProviderK8S   = "k8s"
	ProviderAzure = "azure"
)

const (
	// DefaultAssessmentAddress specifies the default gRPC address of the assessment service.
	DefaultAssessmentAddress = "localhost:9090"
)

Types

type Configuration

type Configuration struct {
	Interval time.Duration
}

type DiscoveryEvent

type DiscoveryEvent struct {
	Type            DiscoveryEventType
	DiscovererName  string
	DiscoveredItems int
	Time            time.Time
}

DiscoveryEvent represents an event that is ommited if certain situations happen in the discoverer (defined by DiscoveryEventType). Examples would be the start or the end of the discovery. We will potentially expand this in the future.

type DiscoveryEventType

type DiscoveryEventType int

DiscoveryEventType defines the event types for DiscoveryEvent.

const (
	// DiscovererStart is emmited at the start of a discovery run.
	DiscovererStart DiscoveryEventType = iota
	// DiscovererFinished is emmited at the end of a discovery run.
	DiscovererFinished
)

type Service

type Service struct {
	discovery.UnimplementedDiscoveryServer

	Events chan *DiscoveryEvent
	// contains filtered or unexported fields
}

Service is an implementation of the Clouditor Discovery service. It should not be used directly, but rather the NewService constructor should be used.

func NewService

func NewService(opts ...ServiceOption) *Service

func (*Service) Authorizer

func (svc *Service) Authorizer() api.Authorizer

Authorizer implements UsesAuthorizer.

func (*Service) Query

func (svc *Service) Query(_ context.Context, req *discovery.QueryRequest) (res *discovery.QueryResponse, err error)

func (*Service) SetAuthorizer

func (svc *Service) SetAuthorizer(auth api.Authorizer)

SetAuthorizer implements UsesAuthorizer.

func (*Service) Shutdown

func (svc *Service) Shutdown()

func (*Service) Start

func (svc *Service) Start(_ context.Context, _ *discovery.StartDiscoveryRequest) (resp *discovery.StartDiscoveryResponse, err error)

Start starts discovery

func (*Service) StartDiscovery

func (svc *Service) StartDiscovery(discoverer discovery.Discoverer)

type ServiceOption

type ServiceOption func(*Service)

ServiceOption is a functional option type to configure the discovery service.

func WithAssessmentAddress

func WithAssessmentAddress(address string, opts ...grpc.DialOption) ServiceOption

WithAssessmentAddress is an option to configure the assessment service gRPC address.

func WithCloudServiceID

func WithCloudServiceID(ID string) ServiceOption

WithCloudServiceID is an option to configure the cloud service ID for which resources will be discovered.

func WithOAuth2Authorizer

func WithOAuth2Authorizer(config *clientcredentials.Config) ServiceOption

WithOAuth2Authorizer is an option to use an OAuth 2.0 authorizer

func WithProviders

func WithProviders(providersList []string) ServiceOption

WithProviders is an option to set providers for discovering