ray

Introduction ​

This documentation is automatically generated by raydoc. If you see any errors, open an issue. The base struct for this page is ProjectConfig.

The field types in this documentation are declared just like go types, here's a quick rundown on how those work:

Types ​

There are two different kinds of types, basic types and structs. Structs have a specific structure and all the structs used by the base struct (ProjectConfig) is documented on this page. Basic types are:

Note that when setting a byte array ([]byte) in JSON, you will need to use a base64-encoded string as there is no byte array data type in JSON.

Arrays ​

Arrays are denoted as an open and closing bracket followed by a type. For example, []string would be an array of strings. In JSON form:

json
["a string", "another string", "yet another string"]

Maps (Dictionaries) ​

Maps are denoted as the keyword "map" followed by a type enclosed in brackets. This first type is the type of the key. This is followed by another type, which is the type of the value For example, map[string]bool would be a map/dictionary where the keys are strings and the values are booleans. In JSON form:

json
{
    "first key" : true,
    "second key:" : false,
    "3rd key" : true
}

Reference ​

The base struct for this page is ProjectConfig.

PipelineOptions ​

Special options for a pipeline step.

View JSON documentation
json
// Note that this is not a proper example, but just shows docs in JSON form
{
  "Dir": "", //Directory to run tool in
  "IfAvailable": false, //Whether or the step is optional based on if its available on the current system.
  "EnvVar": {
    "": ""
  }, //Enviroment variables to pass the tool
  "RayserveRedirects": , //Redirects if Tool is "rayserve"
  "RayserveDisableDirListing": false //Whether or not to disable rayserve directory listings if Tool is "rayserve"
}

IfAvailable bool ​

Whether or the step is optional based on if its available on the current system.

EnvVar map[string]string ​

Enviroment variables to pass the tool

RayserveRedirects []RayserveRedirect ​

Redirects if Tool is "rayserve"

RayserveDisableDirListing bool ​

Whether or not to disable rayserve directory listings if Tool is "rayserve"

Dir string ​

Directory to run tool in

PipelineStep ​

Step in pipeline. See this page

View JSON documentation
json
// Note that this is not a proper example, but just shows docs in JSON form
{
  "Tool": "", //Built in tool or binary in %PATH%
  "Command": [
    ""
  ], //Arguments to pass to tool
  "Type": "", //Type of step, possible vals are "build" and "deploy".
  "Options":  //Special options
}

Options PipelineOptions ​

Special options

Tool string ​

Built in tool or binary in %PATH%

Command []string ​

Arguments to pass to tool

Type string ​

Type of step, possible vals are "build" and "deploy".

ProjectConfig ​

View JSON documentation
json
// Note that this is not a proper example, but just shows docs in JSON form
{
  "NonNetworked": false, //Disables ray router for this project and does not expect the process to listen on RAY_PORT or RAY_SOCK_PATH
  "PluginImplementation": "", //The plugin this project implements, if any. Note that due to historical reasons each deployment in a project needs to have the same PluginImplementation.
  "Pipeline": , //Deployment pipeline. See [this page](https://ray.pyrret.com/guides/deploying-a-project/project-config.html)
  "Version": "", //Config version, latest is "v1-networked". Other versions are "v1"
  "LenientPorts": false //Whether to not care if another process uses RAY_PORT than the one started by ray. Needed if the deploy step are starting child processes.
}

Pipeline []PipelineStep ​

Deployment pipeline. See this page

Version string ​

Config version, latest is "v1-networked". Other versions are "v1"

LenientPorts bool ​

Whether to not care if another process uses RAY_PORT than the one started by ray. Needed if the deploy step are starting child processes.

NonNetworked bool ​

Disables ray router for this project and does not expect the process to listen on RAY_PORT or RAY_SOCK_PATH

PluginImplementation string ​

The plugin this project implements, if any. Note that due to historical reasons each deployment in a project needs to have the same PluginImplementation.

RayserveRedirect ​

Redirect for rayserve

View JSON documentation
json
// Note that this is not a proper example, but just shows docs in JSON form
{
  "Temporary": false, //If this is true HTTP status code 302 is used, otherwise 301.
  "Path": "", //Where to redirect from
  "Destination": "" //Where to redirect to
}

Path string ​

Where to redirect from

Destination string ​

Where to redirect to

Temporary bool ​

If this is true HTTP status code 302 is used, otherwise 301.