package
0.6.0
Repository: https://github.com/ray-project/kuberay.git
Documentation: pkg.go.dev

# Functions

Before Get substring before a string.
CalculateAvailableReplicas calculates available worker replicas at the cluster level A worker is available if its Pod is running.
CalculateDesiredReplicas calculate desired worker replicas at the cluster level.
No description provided by the author
CalculateMaxReplicas calculates max worker replicas at the cluster level.
CalculateMinReplicas calculates min worker replicas at the cluster level.
No description provided by the author
CheckAllPodsRunning check if all pod in a list is running.
CheckLabel makes sure the label value does not start with a punctuation and the total length is < 63 char.
CheckName makes sure the name does not start with a numeric value and the total length is < 63 char.
CompareJsonStruct This is a way to better compare if two objects are the same when they are json/yaml structs.
No description provided by the author
No description provided by the author
No description provided by the author
ExtractRayIPFromFQDN extracts the head service name (i.e., RAY_IP, deprecated) from a fully qualified domain name (FQDN).
FetchHeadServiceURL fetches the URL that consists of the FQDN for the RayCluster's head service and the port with the given port name (defaultPortName).
No description provided by the author
FindContainerPort searches for a specific port $portName in the container.
TODO: find target container through name instead of using index 0.
FormatInt returns the string representation of i in the given base, for 2 <= base <= 36.
GenerateDashboardServiceName generates a ray head service name from cluster name.
GenerateFQDNServiceName generates a Fully Qualified Domain Name.
GenerateIdentifier generates identifier of same group pods.
GenerateIngressName generates an ingress name from cluster name.
Json-serializes obj and returns its hash string.
GenerateRayClusterName generates a ray cluster name from ray service name.
GenerateRayJobId generates a ray job id for submission.
GenerateServeServiceLabel generates label value for serve service selector.
GenerateServeServiceName generates name for serve service.
GenerateServiceName generates a Ray head service name from cluster name.
GetClusterDomainName returns cluster's domain name.
No description provided by the author
GetHeadGroupServiceAccountName returns the head group service account if it exists.
GetNamespace return namespace.
No description provided by the author
No description provided by the author
IsCreated returns true if pod has been created and is maintained by the API server.
IsRunningAndReady returns true if pod is in the PodRunning Phase, if it has a condition of PodReady.
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Single-application URL paths.
No description provided by the author
GetRayDashboardClientFunc Used for unit tests.
GetRayHttpProxyClientFunc Used for unit tests.
Job URL paths.
Multi-application URL paths.
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
RayActorOptionSpec defines the desired state of RayActor, used by Ray Dashboard.
No description provided by the author
No description provided by the author
RayJobInfo is the response of "ray job status" api.
RayJobRequest is the request body to submit.
No description provided by the author
No description provided by the author
No description provided by the author
Describes the status of an application.
V1 Serve API Response format.
ServeConfigSpec defines the (single-application) desired state of RayService, used by Ray Dashboard.
V2 Serve API Response format.
ServeDeploymentStatus and ServeApplicationStatus describe the format of status(es) that will be returned by GetSingleApplicationStatus and GetMultiApplicationStatus methods of the dashboard client Describes the status of a deployment.
No description provided by the author
No description provided by the author
ServingClusterDeployments defines the request sent to the dashboard api server.

# Interfaces

No description provided by the author
No description provided by the author

# Type aliases

Defines which Ray Serve config schema is used for `serveConfigV2`; can be SINGLE_APP or MULTI_APP.