Files

1095 lines
32 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://ray-project.github.io/kuberay/deploy/helm-cluster/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.17">
<title>RayCluster - KubeRay Docs</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#raycluster" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="KubeRay Docs" class="md-header__button md-logo" aria-label="KubeRay Docs" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
KubeRay Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
RayCluster
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/ray-project/kuberay" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
ray-project/kuberay
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="KubeRay Docs" class="md-nav__button md-logo" aria-label="KubeRay Docs" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
KubeRay Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/ray-project/kuberay" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
</div>
<div class="md-source__repository">
ray-project/kuberay
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
Home
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Home
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Welcome
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#introduction" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#end-to-end-example" class="md-nav__link">
<span class="md-ellipsis">
End-to-end example
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#values" class="md-nav__link">
<span class="md-ellipsis">
Values
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="raycluster">RayCluster<a class="headerlink" href="#raycluster" title="Permanent link">&para;</a></h1>
<p><img alt="Version: 1.1.0" src="https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square" /></p>
<p>A Helm chart for deploying the RayCluster with the kuberay operator.</p>
<p><strong>Homepage:</strong> <a href="https://github.com/ray-project/kuberay">https://github.com/ray-project/kuberay</a></p>
<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">&para;</a></h2>
<p>RayCluster is a custom resource definition (CRD).
KubeRay operator will listen to the resource events about RayCluster and create related Kubernetes resources
(e.g. Pod &amp; Service).
Hence, KubeRay operator installation and CRD registration are required for this guide.</p>
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
<p>See <a href="https://github.com/ray-project/kuberay/blob/master/helm-chart/kuberay-operator/README.md">kuberay-operator/README.md</a> for more details.</p>
<ul>
<li>Helm</li>
<li>Install custom resource definition and KubeRay operator (covered by the following end-to-end
example.)</li>
</ul>
<h2 id="end-to-end-example">End-to-end example<a class="headerlink" href="#end-to-end-example" title="Permanent link">&para;</a></h2>
<div class="highlight"><pre><span></span><code><span class="c1"># Step 1: Create a KinD cluster</span>
kind<span class="w"> </span>create<span class="w"> </span>cluster
<span class="c1"># Step 2: Register a Helm chart repo</span>
helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>kuberay<span class="w"> </span>https://ray-project.github.io/kuberay-helm/
<span class="c1"># Step 3: Install both CRDs and KubeRay operator v1.1.0.</span>
helm<span class="w"> </span>install<span class="w"> </span>kuberay-operator<span class="w"> </span>kuberay/kuberay-operator<span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.1.0
<span class="c1"># Step 4: Install a RayCluster custom resource</span>
<span class="c1"># (For x86_64 users)</span>
helm<span class="w"> </span>install<span class="w"> </span>raycluster<span class="w"> </span>kuberay/ray-cluster<span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.1.0
<span class="c1"># (For arm64 users, e.g. Mac M1)</span>
<span class="c1"># See here for all available arm64 images: https://hub.docker.com/r/rayproject/ray/tags?page=1&amp;name=aarch64</span>
helm<span class="w"> </span>install<span class="w"> </span>raycluster<span class="w"> </span>kuberay/ray-cluster<span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.1.0<span class="w"> </span>--set<span class="w"> </span>image.tag<span class="o">=</span>nightly-aarch64
<span class="c1"># Step 5: Verify the installation of KubeRay operator and RayCluster</span>
kubectl<span class="w"> </span>get<span class="w"> </span>pods
<span class="c1"># NAME READY STATUS RESTARTS AGE</span>
<span class="c1"># kuberay-operator-6fcbb94f64-gkpc9 1/1 Running 0 89s</span>
<span class="c1"># raycluster-kuberay-head-qp9f4 1/1 Running 0 66s</span>
<span class="c1"># raycluster-kuberay-worker-workergroup-2jckt 1/1 Running 0 66s</span>
<span class="c1"># Step 6: Forward the port of Dashboard</span>
kubectl<span class="w"> </span>port-forward<span class="w"> </span>svc/raycluster-kuberay-head-svc<span class="w"> </span><span class="m">8265</span>:8265
<span class="c1"># Step 7: Check 127.0.0.1:8265 for the Dashboard</span>
<span class="c1"># Step 8: Log in to Ray head Pod and execute a job.</span>
kubectl<span class="w"> </span><span class="nb">exec</span><span class="w"> </span>-it<span class="w"> </span><span class="si">${</span><span class="nv">RAYCLUSTER_HEAD_POD</span><span class="si">}</span><span class="w"> </span>--<span class="w"> </span>bash
python<span class="w"> </span>-c<span class="w"> </span><span class="s2">&quot;import ray; ray.init(); print(ray.cluster_resources())&quot;</span><span class="w"> </span><span class="c1"># (in Ray head Pod)</span>
<span class="c1"># Step 9: Check 127.0.0.1:8265/#/job. The status of the job should be &quot;SUCCEEDED&quot;.</span>
<span class="c1"># Step 10: Uninstall RayCluster</span>
helm<span class="w"> </span>uninstall<span class="w"> </span>raycluster
<span class="c1"># Step 11: Verify that RayCluster has been removed successfully</span>
<span class="c1"># NAME READY STATUS RESTARTS AGE</span>
<span class="c1"># kuberay-operator-6fcbb94f64-gkpc9 1/1 Running 0 9m57s</span>
</code></pre></div>
<h2 id="values">Values<a class="headerlink" href="#values" title="Permanent link">&para;</a></h2>
<table>
<thead>
<tr>
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>image.repository</td>
<td>string</td>
<td><code>"rayproject/ray"</code></td>
<td>Image repository.</td>
</tr>
<tr>
<td>image.tag</td>
<td>string</td>
<td><code>"2.52.0"</code></td>
<td>Image tag.</td>
</tr>
<tr>
<td>image.pullPolicy</td>
<td>string</td>
<td><code>"IfNotPresent"</code></td>
<td>Image pull policy.</td>
</tr>
<tr>
<td>nameOverride</td>
<td>string</td>
<td><code>"kuberay"</code></td>
<td>String to partially override release name.</td>
</tr>
<tr>
<td>fullnameOverride</td>
<td>string</td>
<td><code>""</code></td>
<td>String to fully override release name.</td>
</tr>
<tr>
<td>imagePullSecrets</td>
<td>list</td>
<td><code>[]</code></td>
<td>Secrets with credentials to pull images from a private registry</td>
</tr>
<tr>
<td>gcsFaultTolerance.enabled</td>
<td>bool</td>
<td><code>false</code></td>
<td></td>
</tr>
<tr>
<td>common.containerEnv</td>
<td>list</td>
<td><code>[]</code></td>
<td>containerEnv specifies environment variables for the Ray head and worker containers. Follows standard K8s container env schema.</td>
</tr>
<tr>
<td>head.initContainers</td>
<td>list</td>
<td><code>[]</code></td>
<td>Init containers to add to the head pod</td>
</tr>
<tr>
<td>head.labels</td>
<td>object</td>
<td><code>{}</code></td>
<td>Labels for the head pod</td>
</tr>
<tr>
<td>head.serviceAccountName</td>
<td>string</td>
<td><code>""</code></td>
<td></td>
</tr>
<tr>
<td>head.restartPolicy</td>
<td>string</td>
<td><code>""</code></td>
<td></td>
</tr>
<tr>
<td>head.runtimeClassName</td>
<td>string</td>
<td><code>""</code></td>
<td>runtimeClassName is the name of the RuntimeClass to use to run the head Pod.</td>
</tr>
<tr>
<td>head.containerEnv</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>head.envFrom</td>
<td>list</td>
<td><code>[]</code></td>
<td>envFrom to pass to head pod</td>
</tr>
<tr>
<td>head.resources.limits.cpu</td>
<td>string</td>
<td><code>"1"</code></td>
<td></td>
</tr>
<tr>
<td>head.resources.limits.memory</td>
<td>string</td>
<td><code>"2G"</code></td>
<td></td>
</tr>
<tr>
<td>head.resources.requests.cpu</td>
<td>string</td>
<td><code>"1"</code></td>
<td></td>
</tr>
<tr>
<td>head.resources.requests.memory</td>
<td>string</td>
<td><code>"2G"</code></td>
<td></td>
</tr>
<tr>
<td>head.resourceClaims</td>
<td>list</td>
<td><code>[]</code></td>
<td>ResourceClaims to allocate with the head pod</td>
</tr>
<tr>
<td>head.annotations</td>
<td>object</td>
<td><code>{}</code></td>
<td>Extra annotations for head pod</td>
</tr>
<tr>
<td>head.nodeSelector</td>
<td>object</td>
<td><code>{}</code></td>
<td>Node labels for head pod assignment</td>
</tr>
<tr>
<td>head.tolerations</td>
<td>list</td>
<td><code>[]</code></td>
<td>Node tolerations for head pod scheduling to nodes with taints</td>
</tr>
<tr>
<td>head.affinity</td>
<td>object</td>
<td><code>{}</code></td>
<td>Head pod affinity</td>
</tr>
<tr>
<td>head.podSecurityContext</td>
<td>object</td>
<td><code>{}</code></td>
<td>Head pod security context.</td>
</tr>
<tr>
<td>head.securityContext</td>
<td>object</td>
<td><code>{}</code></td>
<td>Ray container security context.</td>
</tr>
<tr>
<td>head.volumes[0].name</td>
<td>string</td>
<td><code>"log-volume"</code></td>
<td></td>
</tr>
<tr>
<td>head.volumes[0].emptyDir</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td>head.volumeMounts[0].mountPath</td>
<td>string</td>
<td><code>"/tmp/ray"</code></td>
<td></td>
</tr>
<tr>
<td>head.volumeMounts[0].name</td>
<td>string</td>
<td><code>"log-volume"</code></td>
<td></td>
</tr>
<tr>
<td>head.sidecarContainers</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>head.command</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>head.args</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>head.headService</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td>head.topologySpreadConstraints</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>head.rayStartParams</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td>worker.groupName</td>
<td>string</td>
<td><code>"workergroup"</code></td>
<td>The name of the workergroup</td>
</tr>
<tr>
<td>worker.replicas</td>
<td>int</td>
<td><code>1</code></td>
<td>The number of replicas for the worker pod</td>
</tr>
<tr>
<td>worker.minReplicas</td>
<td>int</td>
<td><code>1</code></td>
<td>The minimum number of replicas for the worker pod</td>
</tr>
<tr>
<td>worker.maxReplicas</td>
<td>int</td>
<td><code>3</code></td>
<td>The maximum number of replicas for the worker pod</td>
</tr>
<tr>
<td>worker.labels</td>
<td>object</td>
<td><code>{}</code></td>
<td>Labels for the worker pod</td>
</tr>
<tr>
<td>worker.serviceAccountName</td>
<td>string</td>
<td><code>""</code></td>
<td></td>
</tr>
<tr>
<td>worker.restartPolicy</td>
<td>string</td>
<td><code>""</code></td>
<td></td>
</tr>
<tr>
<td>worker.runtimeClassName</td>
<td>string</td>
<td><code>""</code></td>
<td>runtimeClassName is the name of the RuntimeClass to use to run the worker Pods.</td>
</tr>
<tr>
<td>worker.initContainers</td>
<td>list</td>
<td><code>[]</code></td>
<td>Init containers to add to the worker pod</td>
</tr>
<tr>
<td>worker.containerEnv</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>worker.envFrom</td>
<td>list</td>
<td><code>[]</code></td>
<td>envFrom to pass to worker pod</td>
</tr>
<tr>
<td>worker.resources.limits.cpu</td>
<td>string</td>
<td><code>"1"</code></td>
<td></td>
</tr>
<tr>
<td>worker.resources.limits.memory</td>
<td>string</td>
<td><code>"1G"</code></td>
<td></td>
</tr>
<tr>
<td>worker.resources.requests.cpu</td>
<td>string</td>
<td><code>"1"</code></td>
<td></td>
</tr>
<tr>
<td>worker.resources.requests.memory</td>
<td>string</td>
<td><code>"1G"</code></td>
<td></td>
</tr>
<tr>
<td>worker.resourceClaims</td>
<td>list</td>
<td><code>[]</code></td>
<td>ResourceClaims to allocate with the worker pod</td>
</tr>
<tr>
<td>worker.annotations</td>
<td>object</td>
<td><code>{}</code></td>
<td>Extra annotations for worker pod</td>
</tr>
<tr>
<td>worker.nodeSelector</td>
<td>object</td>
<td><code>{}</code></td>
<td>Node labels for worker pod assignment</td>
</tr>
<tr>
<td>worker.tolerations</td>
<td>list</td>
<td><code>[]</code></td>
<td>Node tolerations for worker pod scheduling to nodes with taints</td>
</tr>
<tr>
<td>worker.affinity</td>
<td>object</td>
<td><code>{}</code></td>
<td>Worker pod affinity</td>
</tr>
<tr>
<td>worker.podSecurityContext</td>
<td>object</td>
<td><code>{}</code></td>
<td>Worker pod security context.</td>
</tr>
<tr>
<td>worker.securityContext</td>
<td>object</td>
<td><code>{}</code></td>
<td>Ray container security context.</td>
</tr>
<tr>
<td>worker.volumes[0].name</td>
<td>string</td>
<td><code>"log-volume"</code></td>
<td></td>
</tr>
<tr>
<td>worker.volumes[0].emptyDir</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td>worker.volumeMounts[0].mountPath</td>
<td>string</td>
<td><code>"/tmp/ray"</code></td>
<td></td>
</tr>
<tr>
<td>worker.volumeMounts[0].name</td>
<td>string</td>
<td><code>"log-volume"</code></td>
<td></td>
</tr>
<tr>
<td>worker.sidecarContainers</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>worker.command</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>worker.args</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>worker.topologySpreadConstraints</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>worker.rayStartParams</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.disabled</td>
<td>bool</td>
<td><code>true</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.replicas</td>
<td>int</td>
<td><code>0</code></td>
<td>The number of replicas for the additional worker pod</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.minReplicas</td>
<td>int</td>
<td><code>0</code></td>
<td>The minimum number of replicas for the additional worker pod</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.maxReplicas</td>
<td>int</td>
<td><code>3</code></td>
<td>The maximum number of replicas for the additional worker pod</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.labels</td>
<td>object</td>
<td><code>{}</code></td>
<td>Labels for the additional worker pod</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.serviceAccountName</td>
<td>string</td>
<td><code>""</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.restartPolicy</td>
<td>string</td>
<td><code>""</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.runtimeClassName</td>
<td>string</td>
<td><code>""</code></td>
<td>runtimeClassName for this additional worker group. Empty string means default runtime.</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.containerEnv</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.envFrom</td>
<td>list</td>
<td><code>[]</code></td>
<td>envFrom to pass to additional worker pod</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.resources.limits.cpu</td>
<td>int</td>
<td><code>1</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.resources.limits.memory</td>
<td>string</td>
<td><code>"1G"</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.resources.requests.cpu</td>
<td>int</td>
<td><code>1</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.resources.requests.memory</td>
<td>string</td>
<td><code>"1G"</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.resourceClaims</td>
<td>list</td>
<td><code>[]</code></td>
<td>ResourceClaims to allocate with the additional worker pod</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.annotations</td>
<td>object</td>
<td><code>{}</code></td>
<td>Extra annotations for additional worker pod</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.nodeSelector</td>
<td>object</td>
<td><code>{}</code></td>
<td>Node labels for additional worker pod assignment</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.tolerations</td>
<td>list</td>
<td><code>[]</code></td>
<td>Node tolerations for additional worker pod scheduling to nodes with taints</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.affinity</td>
<td>object</td>
<td><code>{}</code></td>
<td>Additional worker pod affinity</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.podSecurityContext</td>
<td>object</td>
<td><code>{}</code></td>
<td>Additional worker pod security context.</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.securityContext</td>
<td>object</td>
<td><code>{}</code></td>
<td>Ray container security context.</td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.volumes[0].name</td>
<td>string</td>
<td><code>"log-volume"</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.volumes[0].emptyDir</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.volumeMounts[0].mountPath</td>
<td>string</td>
<td><code>"/tmp/ray"</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.volumeMounts[0].name</td>
<td>string</td>
<td><code>"log-volume"</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.sidecarContainers</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.command</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.args</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.topologySpreadConstraints</td>
<td>list</td>
<td><code>[]</code></td>
<td></td>
</tr>
<tr>
<td>additionalWorkerGroups.smallGroup.rayStartParams</td>
<td>object</td>
<td><code>{}</code></td>
<td></td>
</tr>
<tr>
<td>service.type</td>
<td>string</td>
<td><code>"ClusterIP"</code></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../../assets/javascripts/bundle.1e8ae164.min.js"></script>
</body>
</html>