ray

Documentation

Index

• Constants
• func SetConfig(cfg *Config) error
• type Config
  • func GetConfig() *Config
  • func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet
• type DefaultConfig
• type NodeConfig

Constants

const (
	KindRayJob                         = "RayJob"
	IncludeDashboard                   = "include-dashboard"
	NodeIPAddress                      = "node-ip-address"
	DashboardHost                      = "dashboard-host"
	DisableUsageStatsStartParameter    = "disable-usage-stats"
	DisableUsageStatsStartParameterVal = "true"
)

Functions

func SetConfig

func SetConfig(cfg *Config) error

Types

type Config

type Config struct {
	// ShutdownAfterJobFinishes will determine whether to delete the ray cluster once rayJob succeed or failed
	ShutdownAfterJobFinishes bool `json:"shutdownAfterJobFinishes,omitempty"`

	// TTLSecondsAfterFinished is the TTL to clean up RayCluster.
	// It's only working when ShutdownAfterJobFinishes set to true.
	TTLSecondsAfterFinished int32 `json:"ttlSecondsAfterFinished,omitempty"`

	// Kubernetes Service Type, valid values are 'ClusterIP', 'NodePort' and 'LoadBalancer'
	ServiceType string `json:"serviceType,omitempty"`

	// IncludeDashboard is used to start a Ray Dashboard if set to true
	IncludeDashboard bool `json:"includeDashboard,omitempty"`

	// DashboardHost the host to bind the dashboard server to, either localhost (127.0.0.1)
	// or 0.0.0.0 (available from all interfaces). By default, this is localhost.
	DashboardHost string `json:"dashboardHost,omitempty"`

	// DeprecatedNodeIPAddress the IP address of the head node. By default, this is pod ip address.
	DeprecatedNodeIPAddress string `json:"nodeIPAddress,omitempty" pflag:"-,DEPRECATED. Please use DefaultConfig.[HeadNode|WorkerNode].IPAddress"`

	// Remote Ray Cluster Config
	RemoteClusterConfig  pluginmachinery.ClusterConfig `json:"remoteClusterConfig" pflag:"Configuration of remote K8s cluster for ray jobs"`
	Logs                 logs.LogConfig                `json:"logs" pflag:"-,Log configuration for ray jobs"`
	LogsSidecar          *v1.Container                 `json:"logsSidecar" pflag:"-,Sidecar to inject into head pods for capturing ray job logs"`
	DashboardURLTemplate *tasklog.TemplateLogPlugin    `json:"dashboardURLTemplate" pflag:"-,Template for URL of Ray dashboard running on a head node."`
	Defaults             DefaultConfig                 `json:"defaults" pflag:"-,Default configuration for ray jobs"`
	EnableUsageStats     bool                          `` /* 172-byte string literal not displayed */
	KubeRayCrdVersion    string                        `json:"kubeRayCrdVersion" pflag:",Version of the Ray CRD to use when creating RayClusters or RayJobs."`
}

Config is config for 'ray' plugin

func GetConfig

func GetConfig() *Config

func (Config) GetPFlagSet

func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet

GetPFlagSet will return strongly types pflags for all fields in Config and its nested types. The format of the flags is json-name.json-sub-name... etc.

type DefaultConfig

type DefaultConfig struct {
	HeadNode   NodeConfig `json:"headNode,omitempty" pflag:"-,Default configuration for head node of ray jobs"`
	WorkerNode NodeConfig `json:"workerNode,omitempty" pflag:"-,Default configuration for worker node of ray jobs"`
}

type NodeConfig

type NodeConfig struct {
	StartParameters map[string]string `json:"startParameters,omitempty" pflag:"-,Start parameters for the node"`
	IPAddress       string            `json:"ipAddress,omitempty" pflag:"-,IP address of the node"`
}