consoleserver

package
Version: v0.0.0-...-bc56e6a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 25, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddPage

type AddPage struct {
	// disabledActions is a list of actions that are not shown to users.
	// Each action in the list is represented by its ID.
	DisabledActions []string `yaml:"disabledActions,omitempty"`
}

AddPage allows customizing actions on the Add page in developer perspective.

type Auth

type Auth struct {
	ClientID                 string `yaml:"clientID,omitempty"`
	ClientSecretFile         string `yaml:"clientSecretFile,omitempty"`
	OAuthEndpointCAFile      string `yaml:"oauthEndpointCAFile,omitempty"`
	LogoutRedirect           string `yaml:"logoutRedirect,omitempty"`
	InactivityTimeoutSeconds int    `yaml:"inactivityTimeoutSeconds,omitempty"`
}

Auth holds configuration for authenticating with OpenShift. The auth method is assumed to be "openshift".

type ClusterInfo

type ClusterInfo struct {
	ConsoleBaseAddress string `yaml:"consoleBaseAddress,omitempty"`
	ConsoleBasePath    string `yaml:"consoleBasePath,omitempty"`
	MasterPublicURL    string `yaml:"masterPublicURL,omitempty"`
}

ClusterInfo holds information the about the cluster such as master public URL and console public URL.

type Config

type Config struct {
	APIVersion    string `yaml:"apiVersion"`
	Kind          string `yaml:"kind"`
	ServingInfo   `yaml:"servingInfo"`
	ClusterInfo   `yaml:"clusterInfo"`
	Auth          `yaml:"auth"`
	Customization `yaml:"customization"`
	Providers     `yaml:"providers"`
	Plugins       map[string]string `yaml:"plugins,omitempty"`
}

Config is the top-level console server cli configuration.

type ConsoleServerCLIConfigBuilder

type ConsoleServerCLIConfigBuilder struct {
	CAFile string
	// contains filtered or unexported fields
}

ConsoleServerCLIConfigBuilder Director will be DefaultConfigMap()

b := ConsoleYamlConfigBuilder{} return the default config value immediately:

b.Config()
b.ConfigYAML()

set all the values:

b.Host(host).LogoutURL("").Brand("").DocURL("").APIServerURL("").Config()

set only some values:

b.Host().Brand("").Config()

func (*ConsoleServerCLIConfigBuilder) APIServerURL

func (*ConsoleServerCLIConfigBuilder) AddPage

func (*ConsoleServerCLIConfigBuilder) Brand

func (*ConsoleServerCLIConfigBuilder) Config

func (*ConsoleServerCLIConfigBuilder) ConfigYAML

func (b *ConsoleServerCLIConfigBuilder) ConfigYAML() (consoleConfigYAML []byte, marshallError error)

func (*ConsoleServerCLIConfigBuilder) CustomDeveloperCatalog

func (*ConsoleServerCLIConfigBuilder) CustomHostnameRedirectPort

func (b *ConsoleServerCLIConfigBuilder) CustomHostnameRedirectPort(redirect bool) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) CustomLogoFile

func (b *ConsoleServerCLIConfigBuilder) CustomLogoFile(customLogoFile string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) CustomProductName

func (b *ConsoleServerCLIConfigBuilder) CustomProductName(customProductName string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) DocURL

func (*ConsoleServerCLIConfigBuilder) Host

func (*ConsoleServerCLIConfigBuilder) InactivityTimeout

func (b *ConsoleServerCLIConfigBuilder) InactivityTimeout(timeout int) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) LogoutURL

func (b *ConsoleServerCLIConfigBuilder) LogoutURL(logoutRedirectURL string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) OAuthServingCert

func (b *ConsoleServerCLIConfigBuilder) OAuthServingCert(useDefaultCAFile bool) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Plugins

func (*ConsoleServerCLIConfigBuilder) ProjectAccess

func (*ConsoleServerCLIConfigBuilder) QuickStarts

func (*ConsoleServerCLIConfigBuilder) StatusPageID

type ConsoleYAMLMerger

type ConsoleYAMLMerger struct{}

func (*ConsoleYAMLMerger) Merge

func (b *ConsoleYAMLMerger) Merge(configYAMLs ...[]byte) (converted []byte, conversionErr error)

type Customization

type Customization struct {
	Branding             string `yaml:"branding,omitempty"`
	DocumentationBaseURL string `yaml:"documentationBaseURL,omitempty"`
	CustomProductName    string `yaml:"customProductName,omitempty"`
	CustomLogoFile       string `yaml:"customLogoFile,omitempty"`
	// developerCatalog allows to configure the shown developer catalog categories.
	DeveloperCatalog *DeveloperConsoleCatalogCustomization `yaml:"developerCatalog,omitempty"`
	ProjectAccess    ProjectAccess                         `yaml:"projectAccess,omitempty"`
	QuickStarts      QuickStarts                           `yaml:"quickStarts,omitempty"`
	// addPage allows customizing actions on the Add page in developer perspective.
	AddPage AddPage `yaml:"addPage,omitempty"`
}

Customization holds configuration such as what logo to use.

type DeveloperConsoleCatalogCategory

type DeveloperConsoleCatalogCategory struct {
	// defines top level category ID, label and filter tags.
	DeveloperConsoleCatalogCategoryMeta `yaml:",inline"`
	// subcategories defines a list of child categories.
	Subcategories []DeveloperConsoleCatalogCategoryMeta `yaml:"subcategories,omitempty"`
}

DeveloperConsoleCatalogCategory for the developer console catalog.

type DeveloperConsoleCatalogCategoryMeta

type DeveloperConsoleCatalogCategoryMeta struct {
	// ID is an identifier used in the URL to enable deep linking in console.
	// ID is required and must have 1-32 URL safe (A-Z, a-z, 0-9, - and _) characters.
	ID string `yaml:"id"`
	// label defines a category display label. It is required and must have 1-64 characters.
	Label string `yaml:"label"`
	// tags is a list of strings that will match the category. A selected category
	// show all items which has at least one overlapping tag between category and item.
	Tags []string `yaml:"tags,omitempty"`
}

DeveloperConsoleCatalogCategoryMeta are the key identifiers of a developer catalog category.

type DeveloperConsoleCatalogCustomization

type DeveloperConsoleCatalogCustomization struct {
	// categories which are shown the in developer catalog.
	Categories *[]DeveloperConsoleCatalogCategory `yaml:"categories"`
}

DeveloperConsoleCatalogCustomization allow cluster admin to configure developer catalog.

type Helm

type Helm struct {
	ChartRepo HelmChartRepo `yaml:"chartRepository"`
}

type HelmChartRepo

type HelmChartRepo struct {
	URL    string `yaml:"url,omitempty"`
	CAFile string `yaml:"caFile,omitempty"`
}

type ProjectAccess

type ProjectAccess struct {
	AvailableClusterRoles []string `yaml:"availableClusterRoles,omitempty"`
}

ProjectAccess contains options for project access roles

type Providers

type Providers struct {
	StatuspageID string `yaml:"statuspageID,omitempty"`
}

type QuickStarts

type QuickStarts struct {
	Disabled []string `json:"disabled,omitempty"`
}

QuickStarts contains options for quick starts

type ServingInfo

type ServingInfo struct {
	BindAddress  string `yaml:"bindAddress,omitempty"`
	CertFile     string `yaml:"certFile,omitempty"`
	KeyFile      string `yaml:"keyFile,omitempty"`
	RedirectPort int    `yaml:"redirectPort,omitempty"`

	// These fields are defined in `HTTPServingInfo`, but are not supported for console. Fail if any are specified.
	// https://github.com/openshift/api/blob/0cb4131a7636e1ada6b2769edc9118f0fe6844c8/config/v1/types.go#L7-L38
	BindNetwork           string        `yaml:"bindNetwork,omitempty"`
	ClientCA              string        `yaml:"clientCA,omitempty"`
	NamedCertificates     []interface{} `yaml:"namedCertificates,omitempty"`
	MinTLSVersion         string        `yaml:"minTLSVersion,omitempty"`
	CipherSuites          []string      `yaml:"cipherSuites,omitempty"`
	MaxRequestsInFlight   int64         `yaml:"maxRequestsInFlight,omitempty"`
	RequestTimeoutSeconds int64         `yaml:"requestTimeoutSeconds,omitempty"`
}

ServingInfo holds configuration for serving HTTP.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL