Documentation
¶
Index ¶
- Constants
- func MustRegisterSubsection(key config.SectionKey, configSection config.Config) config.Section
- func SetConfig(s *ServerConfig)
- type DataProxyConfig
- type DataProxyDownloadConfig
- type DataProxyUploadConfig
- type GrpcConfig
- type KubeClientConfig
- type ServerConfig
- type ServerSecurityOptions
- type SslOptions
Constants ¶
View Source
const SectionKey = "server"
Variables ¶
This section is empty.
Functions ¶
func MustRegisterSubsection ¶ added in v0.5.0
func SetConfig ¶
func SetConfig(s *ServerConfig)
Types ¶
type DataProxyConfig ¶ added in v0.6.120
type DataProxyConfig struct {
Upload DataProxyUploadConfig `json:"upload" pflag:",Defines data proxy upload configuration."`
Download DataProxyDownloadConfig `json:"download" pflag:",Defines data proxy download configuration."`
}
type DataProxyDownloadConfig ¶ added in v1.1.17
type DataProxyUploadConfig ¶ added in v0.6.120
type DataProxyUploadConfig struct {
MaxSize resource.Quantity `json:"maxSize" pflag:",Maximum allowed upload size."`
MaxExpiresIn config.Duration `json:"maxExpiresIn" pflag:",Maximum allowed expiration duration."`
DefaultFileNameLength int `json:"defaultFileNameLength" pflag:",Default length for the generated file name if not provided in the request."`
StoragePrefix string `json:"storagePrefix" pflag:",Storage prefix to use for all upload requests."`
}
type GrpcConfig ¶ added in v0.6.101
type KubeClientConfig ¶ added in v1.1.64
type KubeClientConfig struct {
// QPS indicates the maximum QPS to the master from this client.
// If it's zero, the created RESTClient will use DefaultQPS: 5
QPS int32 `json:"qps" pflag:",Max QPS to the master for requests to KubeAPI. 0 defaults to 5."`
// Maximum burst for throttle.
// If it's zero, the created RESTClient will use DefaultBurst: 10.
Burst int `json:"burst" pflag:",Max burst rate for throttle. 0 defaults to 10"`
// The maximum length of time to wait before giving up on a server request. A value of zero means no timeout.
Timeout config.Duration `json:"timeout" pflag:",Max duration allowed for every request to KubeAPI before giving up. 0 implies no timeout."`
}
KubeClientConfig contains the configuration used by flyteadmin to configure its internal Kubernetes Client.
type ServerConfig ¶ added in v0.1.5
type ServerConfig struct {
HTTPPort int `json:"httpPort" pflag:",On which http port to serve admin"`
GrpcPort int `json:"grpcPort" pflag:",deprecated"`
GrpcServerReflection bool `json:"grpcServerReflection" pflag:",deprecated"`
KubeConfig string `json:"kube-config" pflag:",Path to kubernetes client config file, default is empty, useful for incluster config."`
Master string `json:"master" pflag:",The address of the Kubernetes API server."`
Security ServerSecurityOptions `json:"security"`
GrpcConfig GrpcConfig `json:"grpc"`
// Deprecated: please use auth.AppAuth.ThirdPartyConfig instead.
DeprecatedThirdPartyConfig authConfig.ThirdPartyConfigOptions `json:"thirdPartyConfig" pflag:",Deprecated please use auth.appAuth.thirdPartyConfig instead."`
DataProxy DataProxyConfig `json:"dataProxy" pflag:",Defines data proxy configuration."`
ReadHeaderTimeoutSeconds int `json:"readHeaderTimeoutSeconds" pflag:",The amount of time allowed to read request headers."`
KubeClientConfig KubeClientConfig `json:"kubeClientConfig" pflag:",Configuration to control the Kubernetes client"`
}
func GetConfig ¶
func GetConfig() *ServerConfig
func (ServerConfig) GetGrpcHostAddress ¶ added in v0.1.5
func (s ServerConfig) GetGrpcHostAddress() string
func (ServerConfig) GetHostAddress ¶ added in v0.1.5
func (s ServerConfig) GetHostAddress() string
func (ServerConfig) GetPFlagSet ¶ added in v0.1.5
func (cfg ServerConfig) GetPFlagSet(prefix string) *pflag.FlagSet
GetPFlagSet will return strongly types pflags for all fields in ServerConfig and its nested types. The format of the flags is json-name.json-sub-name... etc.
type ServerSecurityOptions ¶ added in v0.1.5
type ServerSecurityOptions struct {
Secure bool `json:"secure"`
Ssl SslOptions `json:"ssl"`
UseAuth bool `json:"useAuth"`
AuditAccess bool `json:"auditAccess"`
// These options are here to allow deployments where the Flyte UI (Console) is served from a different domain/port.
// Note that CORS only applies to Admin's API endpoints. The health check endpoint for instance is unaffected.
// Please obviously evaluate security concerns before turning this on.
AllowCors bool `json:"allowCors"`
// Defines origins which are allowed to make CORS requests. This list should _not_ contain "*", as that
// will make CORS header responses incompatible with the `withCredentials=true` setting.
AllowedOrigins []string `json:"allowedOrigins"`
// These are the Access-Control-Request-Headers that the server will respond to.
// By default, the server will allow Accept, Accept-Language, Content-Language, and Content-Type.
// DeprecatedUser this setting to add any additional headers which are needed
AllowedHeaders []string `json:"allowedHeaders"`
}
type SslOptions ¶ added in v0.1.5
Click to show internal directories.
Click to hide internal directories.