consoleserver

package
v0.0.0-...-e918992 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2024 License: Apache-2.0 Imports: 14 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 {
	AuthType                 string   `yaml:"authType,omitempty"`
	OIDCIssuer               string   `yaml:"oidcIssuer,omitempty"`
	OIDCExtraScopes          []string `yaml:"oidcExtraScopes,omitempty"`
	OIDCOCLoginCommand       string   `yaml:"oidcOCLoginCommand,omitempty"`
	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 CatalogTypesState 

type CatalogTypesState string

CatalogTypesState defines the state of the catalog types based on which the types will be enabled or disabled. 

const (
	CatalogTypeEnabled  CatalogTypesState = "Enabled"
	CatalogTypeDisabled CatalogTypesState = "Disabled"
)

type ClusterInfo 

type ClusterInfo struct {
	ConsoleBaseAddress   string                `yaml:"consoleBaseAddress,omitempty"`
	ConsoleBasePath      string                `yaml:"consoleBasePath,omitempty"`
	MasterPublicURL      string                `yaml:"masterPublicURL,omitempty"`
	ControlPlaneToplogy  configv1.TopologyMode `yaml:"controlPlaneTopology,omitempty"`
	ReleaseVersion       string                `yaml:"releaseVersion,omitempty"`
	NodeArchitectures    []string              `yaml:"nodeArchitectures,omitempty"`
	NodeOperatingSystems []string              `yaml:"nodeOperatingSystems,omitempty"`
	CopiedCSVsDisabled   bool                  `yaml:"copiedCSVsDisabled,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"`
	Session        `yaml:"session"`
	Customization  `yaml:"customization"`
	Providers      `yaml:"providers"`
	MonitoringInfo `yaml:"monitoringInfo,omitempty"`
	Plugins        map[string]string `yaml:"plugins,omitempty"`
	I18nNamespaces []string          `yaml:"i18nNamespaces,omitempty"`
	Proxy          Proxy             `yaml:"proxy,omitempty"`
	Telemetry      map[string]string `yaml:"telemetry,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 (b *ConsoleServerCLIConfigBuilder) APIServerURL(apiServerURL string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) AddPage 

func (b *ConsoleServerCLIConfigBuilder) AddPage(addPage operatorv1.AddPage) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) AuthConfig 

func (b *ConsoleServerCLIConfigBuilder) AuthConfig(authnConfig *configv1.Authentication, apiServerURL string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Brand 

func (b *ConsoleServerCLIConfigBuilder) Brand(brand operatorv1.Brand) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Capabilities 

func (b *ConsoleServerCLIConfigBuilder) Capabilities(capabilities []operatorv1.Capability) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Config 

func (b *ConsoleServerCLIConfigBuilder) Config() Config

func (*ConsoleServerCLIConfigBuilder) ConfigYAML 

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

func (*ConsoleServerCLIConfigBuilder) CopiedCSVsDisabled 

func (b *ConsoleServerCLIConfigBuilder) CopiedCSVsDisabled(copiedCSVsDisabled bool) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) CustomDeveloperCatalog 

func (b *ConsoleServerCLIConfigBuilder) CustomDeveloperCatalog(devCatalogCustomization operatorv1.DeveloperConsoleCatalogCustomization) *ConsoleServerCLIConfigBuilder

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 (b *ConsoleServerCLIConfigBuilder) DocURL(docURL string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Host 

func (b *ConsoleServerCLIConfigBuilder) Host(host string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) I18nNamespaces 

func (b *ConsoleServerCLIConfigBuilder) I18nNamespaces(i18nNamespaces []string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) InactivityTimeout 

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

func (*ConsoleServerCLIConfigBuilder) LogoutURL 

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

func (*ConsoleServerCLIConfigBuilder) Monitoring 

func (b *ConsoleServerCLIConfigBuilder) Monitoring(monitoringConfig *corev1.ConfigMap) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) NodeArchitectures 

func (b *ConsoleServerCLIConfigBuilder) NodeArchitectures(architectures []string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) NodeOperatingSystems 

func (b *ConsoleServerCLIConfigBuilder) NodeOperatingSystems(operatingSystems []string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Perspectives 

func (b *ConsoleServerCLIConfigBuilder) Perspectives(perspectives []operatorv1.Perspective) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Plugins 

func (b *ConsoleServerCLIConfigBuilder) Plugins(plugins map[string]string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) ProjectAccess 

func (b *ConsoleServerCLIConfigBuilder) ProjectAccess(projectAccess operatorv1.ProjectAccess) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Proxy 

func (b *ConsoleServerCLIConfigBuilder) Proxy(proxyServices []ProxyService) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) QuickStarts 

func (b *ConsoleServerCLIConfigBuilder) QuickStarts(quickStarts operatorv1.QuickStarts) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) ReleaseVersion 

func (b *ConsoleServerCLIConfigBuilder) ReleaseVersion() *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) StatusPageID 

func (b *ConsoleServerCLIConfigBuilder) StatusPageID(id string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) Telemetry 

func (b *ConsoleServerCLIConfigBuilder) Telemetry() map[string]string

func (*ConsoleServerCLIConfigBuilder) TelemetryConfiguration 

func (b *ConsoleServerCLIConfigBuilder) TelemetryConfiguration(telemetry map[string]string) *ConsoleServerCLIConfigBuilder

func (*ConsoleServerCLIConfigBuilder) TopologyMode 

func (b *ConsoleServerCLIConfigBuilder) TopologyMode(topologyMode configv1.TopologyMode) *ConsoleServerCLIConfigBuilder

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"`
	// perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.
	Perspectives []Perspective           `yaml:"perspectives,omitempty"`
	Capabilities []operatorv1.Capability `yaml:"capabilities,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 in the developer catalog.
	Categories *[]DeveloperConsoleCatalogCategory `yaml:"categories"`
	// types allows enabling or disabling of sub-catalog types that user can see in the Developer catalog.
	// When omitted, all the sub-catalog types will be shown.
	Types DeveloperConsoleCatalogTypes `yaml:"types"`
}

DeveloperConsoleCatalogCustomization allow cluster admin to configure developer catalog.

type DeveloperConsoleCatalogTypes 

type DeveloperConsoleCatalogTypes struct {
	// state defines if a list of catalog types should be enabled or disabled.
	State CatalogTypesState `yaml:"state,omitempty"`
	// enabled is a list of developer catalog types (sub-catalogs IDs) that will be shown to users.
	// Types (sub-catalogs) are added via console plugins, the available types (sub-catalog IDs) are available
	// in the console on the cluster configuration page, or when editing the YAML in the console.
	// Example: "Devfile", "HelmChart", "BuilderImage"
	// If the list is non-empty, a new type will not be shown to the user until it is added to list.
	// If the list is empty the complete developer catalog will be shown.
	Enabled *[]string `yaml:"enabled,omitempty"`
	// disabled is a list of developer catalog types (sub-catalogs IDs) that are not shown to users.
	// Types (sub-catalogs) are added via console plugins, the available types (sub-catalog IDs) are available
	// in the console on the cluster configuration page, or when editing the YAML in the console.
	// Example: "Devfile", "HelmChart", "BuilderImage"
	// If the list is empty or all the available sub-catalog types are added, then the complete developer catalog should be hidden.
	Disabled *[]string `yaml:"disabled,omitempty"`
}

DeveloperConsoleCatalogTypes defines the state of the sub-catalog types.

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 MonitoringInfo 

type MonitoringInfo struct {
	AlertmanagerUserWorkloadHost string `yaml:"alertmanagerUserWorkloadHost,omitempty"`
	AlertmanagerTenancyHost      string `yaml:"alertmanagerTenancyHost,omitempty"`
}

MonitoringInfo holds configuration for monitoring related services

type Perspective 

type Perspective struct {
	// id defines the id of the perspective.
	// Example: "dev", "admin".
	// The available perspective ids can be found in the code snippet section next to the yaml editor.
	// Incorrect or unknown ids will be ignored.
	ID string `yaml:"id"`
	// visibility defines the state of perspective along with access review checks if needed for that perspective.
	// visibility is required
	Visibility PerspectiveVisibility `yaml:"visibility"`
	// pinnedResources defines the list of default pinned resources that users will see on the perspective navigation if they have not customized these pinned resources themselves.
	// The list of available Kubernetes resources could be read via `kubectl api-resources`.
	// The console will also provide a configuration UI and a YAML snippet that will list the available resources that can be pinned to the navigation.
	// Incorrect or unknown resources will be ignored.
	PinnedResources *[]operatorv1.PinnedResourceReference `yaml:"pinnedResources,omitempty"`
}

Perspective defines a perspective that cluster admins want to show/hide in the perspective switcher dropdown

type PerspectiveState 

type PerspectiveState string

PerspectiveState defines the visibility state of the perspective. "Enabled" means the perspective is shown. "Disabled" means the Perspective is hidden. "AccessReview" means access review check is required to show or hide a Perspective. 

const (
	PerspectiveEnabled      PerspectiveState = "Enabled"
	PerspectiveDisabled     PerspectiveState = "Disabled"
	PerspectiveAccessReview PerspectiveState = "AccessReview"
)

type PerspectiveVisibility 

type PerspectiveVisibility struct {
	// state defines the perspective is enabled or disabled or access review check is required.
	// state is required
	State PerspectiveState `yaml:"state"`
	// accessReview defines required and missing access review checks.
	AccessReview *ResourceAttributesAccessReview `yaml:"accessReview,omitempty"`
}

PerspectiveVisibility defines the criteria to show/hide a perspective.

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 Proxy 

type Proxy struct {
	Services []ProxyService `yaml:"services,omitempty"`
}

type ProxyService 

type ProxyService struct {
	Endpoint       string `yaml:"endpoint"`
	ConsoleAPIPath string `yaml:"consoleAPIPath"`
	CACertificate  string `yaml:"caCertificate"`
	Authorize      bool   `yaml:"authorize"`
}

type QuickStarts 

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

QuickStarts contains options for quick starts

type ResourceAttributesAccessReview 

type ResourceAttributesAccessReview struct {
	// required defines a list of permission checks. The perspective will only be shown when all checks are successful. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the missing access review list.
	Required []authorizationv1.ResourceAttributes `yaml:"required,omitempty"`
	// missing defines a list of permission checks. The perspective will only be shown when at least one check fails. When omitted, the access review is skipped and the perspective will not be shown unless it is required to do so based on the configuration of the required access review list.
	Missing []authorizationv1.ResourceAttributes `yaml:"missing,omitempty"`
}

ResourceAttributesAccessReview defines the visibility of the perspective depending on the access review checks. `required` and `missing` can work together esp. in the case where the cluster admin wants to show another perspective to users without specific permissions. Out of `required` and `missing` atleast one property should be non-empty.

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.

type Session 

type Session struct {
	CookieEncryptionKeyFile     string `yaml:"cookieEncryptionKeyFile,omitempty"`
	CookieAuthenticationKeyFile string `yaml:"cookieAuthenticationKeyFile,omitempty"`
}

Session holds configuration for web-session related configuration

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.