systeminfo

Documentation

Index

• Variables
• func OIDCProviderName(cfg map[string]interface{}) string
• type Controller
  • func NewController() Controller
• type Data
• type Options

Variables

var Ctl = NewController()

Ctl is the default instance of the package

Functions

func OIDCProviderName

func OIDCProviderName(cfg map[string]interface{}) string

Types

type Controller

type Controller interface {

	// GetInfo consolidates the info of the system by checking settings in DB and env vars
	GetInfo(ctx context.Context, opt Options) (*Data, error)

	// GetCapacity returns total and free space of the storage in byte
	GetCapacity(ctx context.Context) (*imagestorage.Capacity, error)

	// GetCA returns a ReadCloser of Harbor's CA if it's configured and accessible from Harbor core
	GetCA(ctx context.Context) (io.ReadCloser, error)
}

Controller defines the methods needed for systeminfo API

func NewController

func NewController() Controller

NewController return an instance of controller

type Data

type Data struct {
	AuthMode          string
	PrimaryAuthMode   bool
	SelfRegistration  bool
	HarborVersion     string
	BannerMessage     string
	AuthProxySettings *models.HTTPAuthProxy
	Protected         *protectedData
	OIDCProviderName  string
}

Data wraps common systeminfo data

type Options

type Options struct {
	// WithProtectedInfo controls if the protected info, which are considered to be sensitive, should be returned
	WithProtectedInfo bool
}

Options provide a set of attributes to control what info should be returned