Documentation
¶
Index ¶
Constants ¶
View Source
const ( // OperationTypeKubernetesOpenAPIV2Doc is the operation type for the required OpenAPI v2 discovery document. // // This is required by the Kubernetes API Server. OperationTypeKubernetesOpenAPIV2Doc = "KUBERNETESOPENAPIV2DOC" // OperationTypeKubernetesOpenAPIV3Doc is the operation type for the required OpenAPI v3 discovery document. // // This is required by the Kubernetes API Server. OperationTypeKubernetesOpenAPIV3Doc = "KUBERNETESOPENAPIV3DOC" // OperationTypeKubernetesDiscoveryDoc is the operation type for the required Kubernetes API discovery document. OperationTypeKubernetesDiscoveryDoc = "KUBERNETESDISCOVERYDOC" // OperationTypePlanes is the operation type for the planes (all types) collection. OperationTypePlanes = "PLANES" // OperationTypePlanes is the operation type for the planes (specific type) endpoints OperationTypePlanesByType = "PLANESBYTYPE" )
View Source
const (
DefaultPlanesConfig = "DEFAULT_PLANES_CONFIG"
)
Variables ¶
This section is empty.
Functions ¶
func DefaultModules ¶
func DefaultModules(options modules.Options) []modules.Initializer
DefaultModules returns a list of default modules that will be registered with the router.
Types ¶
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service implements the hosting.Service interface for the UCP frontend API.
func NewService ¶
func NewService(options ServiceOptions) *Service
NewService creates a server to serve UCP API requests.
func (*Service) Initialize ¶
Initialize sets up the router, storage provider, secret provider, status manager, AWS config, AWS clients, registers the routes, configures the default planes, and sets up the http server with the appropriate middleware. It returns an http server and an error if one occurs.
type ServiceOptions ¶
type ServiceOptions struct {
// Config is the bootstrap configuration loaded from config file.
Config *hostoptions.UCPConfig
ProviderName string
Address string
PathBase string
Configure func(chi.Router)
TLSCertDir string
DefaultPlanesConfigFile string
StorageProviderOptions dataprovider.StorageProviderOptions
SecretProviderOptions secretprovider.SecretProviderOptions
QueueProviderOptions queueprovider.QueueProviderOptions
InitialPlanes []rest.Plane
Identity hostoptions.Identity
UCPConnection sdk.Connection
Location string
// Modules is a list of modules that will be registered with the router.
Modules []modules.Initializer
}
Source Files
Click to show internal directories.
Click to hide internal directories.