Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 3 additions & 29 deletions docs/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ AuthMode describes the authentication mode for the Ray cluster.
_Appears in:_
- [AuthOptions](#authoptions)

| Field | Description |
| --- | --- |
| `disabled` | AuthModeDisabled disables authentication.<br /> |
| `token` | AuthModeToken enables token-based authentication.<br /> |


#### AuthOptions
Expand Down Expand Up @@ -87,10 +83,6 @@ _Validation:_
_Appears in:_
- [AutoscalerOptions](#autoscaleroptions)

| Field | Description |
| --- | --- |
| `v1` | |
| `v2` | |


#### ClusterUpgradeOptions
Expand Down Expand Up @@ -160,12 +152,6 @@ _Appears in:_
- [DeletionPolicy](#deletionpolicy)
- [DeletionRule](#deletionrule)

| Field | Description |
| --- | --- |
| `DeleteCluster` | |
| `DeleteWorkers` | |
| `DeleteSelf` | |
| `DeleteNone` | |


#### DeletionRule
Expand Down Expand Up @@ -193,15 +179,18 @@ _Appears in:_
DeletionStrategy configures automated cleanup after the RayJob reaches a terminal state.
Two mutually exclusive styles are supported:


Legacy: provide both onSuccess and onFailure (deprecated; removal planned for 1.6.0). May be combined with shutdownAfterJobFinishes and (optionally) global TTLSecondsAfterFinished.
Rules: provide deletionRules (non-empty list). Rules mode is incompatible with shutdownAfterJobFinishes, legacy fields, and the global TTLSecondsAfterFinished (use per‑rule condition.ttlSeconds instead).


Semantics:
- A non-empty deletionRules selects rules mode; empty lists are treated as unset.
- Legacy requires both onSuccess and onFailure; specifying only one is invalid.
- Global TTLSecondsAfterFinished > 0 requires shutdownAfterJobFinishes=true; therefore it cannot be used with rules mode or with legacy alone (no shutdown).
- Feature gate RayJobDeletionPolicy must be enabled when this block is present.


Validation:
- CRD XValidations prevent mixing legacy fields with deletionRules and enforce legacy completeness.
- Controller logic enforces rules vs shutdown exclusivity and TTL constraints.
Expand Down Expand Up @@ -275,12 +264,6 @@ _Underlying type:_ _string_
_Appears in:_
- [RayJobSpec](#rayjobspec)

| Field | Description |
| --- | --- |
| `K8sJobMode` | |
| `HTTPMode` | |
| `InteractiveMode` | |
| `SidecarMode` | |


#### RayCluster
Expand Down Expand Up @@ -359,10 +342,6 @@ _Validation:_
_Appears in:_
- [RayClusterUpgradeStrategy](#rayclusterupgradestrategy)

| Field | Description |
| --- | --- |
| `Recreate` | During upgrade, Recreate strategy will delete all existing pods before creating new ones<br /> |
| `None` | No new pod will be created while the strategy is set to None<br /> |


#### RayCronJob
Expand Down Expand Up @@ -533,11 +512,6 @@ _Underlying type:_ _string_
_Appears in:_
- [RayServiceUpgradeStrategy](#rayserviceupgradestrategy)

| Field | Description |
| --- | --- |
| `NewClusterWithIncrementalUpgrade` | During upgrade, NewClusterWithIncrementalUpgrade strategy will create an upgraded cluster to gradually scale<br />and migrate traffic to using Gateway API.<br /> |
| `NewCluster` | During upgrade, NewCluster strategy will create new upgraded cluster and switch to it when it becomes ready<br /> |
| `None` | No new cluster will be created while the strategy is set to None<br /> |


#### RedisCredential
Expand Down
12 changes: 6 additions & 6 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ require (
github.com/ray-project/kuberay/ray-operator v0.0.0
github.com/rs/cors v1.11.1
github.com/rs/zerolog v1.34.0
github.com/spf13/cobra v1.9.1
github.com/spf13/cobra v1.10.0
github.com/spf13/pflag v1.0.10
github.com/stretchr/testify v1.11.1
google.golang.org/genproto/googleapis/api v0.0.0-20250707201910-8d1bb00bc6a7
google.golang.org/genproto/googleapis/rpc v0.0.0-20250826171959-ef028d996bc1
google.golang.org/grpc v1.75.1
google.golang.org/protobuf v1.36.11
gopkg.in/yaml.v2 v2.4.0
k8s.io/api v0.34.3
k8s.io/apimachinery v0.34.3
k8s.io/api v0.35.0
k8s.io/apimachinery v0.35.0
k8s.io/cli-runtime v0.34.1
k8s.io/client-go v0.34.3
k8s.io/client-go v0.35.0
k8s.io/klog/v2 v2.130.1
k8s.io/kubectl v0.34.1
k8s.io/utils v0.0.0-20251002143259-bc988d571ff4
Expand Down Expand Up @@ -121,8 +121,8 @@ require (
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
k8s.io/apiextensions-apiserver v0.34.3 // indirect
k8s.io/apiserver v0.34.3 // indirect
k8s.io/component-base v0.34.3 // indirect
k8s.io/apiserver v0.35.0 // indirect
k8s.io/component-base v0.35.0 // indirect
k8s.io/component-helpers v0.34.1 // indirect
k8s.io/kube-openapi v0.0.0-20251125145642-4e65d59e963e // indirect
sigs.k8s.io/gateway-api v1.4.1 // indirect
Expand Down
26 changes: 13 additions & 13 deletions go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

64 changes: 64 additions & 0 deletions helm-chart/kuberay-operator/crds/ray.io_rayclusters.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

48 changes: 48 additions & 0 deletions helm-chart/kuberay-operator/crds/ray.io_raycronjobs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4400,6 +4400,10 @@ spec:
type: integer
signerName:
type: string
userAnnotations:
additionalProperties:
type: string
type: object
required:
- keyType
- signerName
Expand Down Expand Up @@ -4594,6 +4598,18 @@ spec:
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
workloadRef:
properties:
name:
type: string
podGroup:
type: string
podGroupReplicaKey:
type: string
required:
- name
- podGroup
type: object
required:
- containers
type: object
Expand Down Expand Up @@ -8281,6 +8297,10 @@ spec:
type: integer
signerName:
type: string
userAnnotations:
additionalProperties:
type: string
type: object
required:
- keyType
- signerName
Expand Down Expand Up @@ -8475,6 +8495,18 @@ spec:
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
workloadRef:
properties:
name:
type: string
podGroup:
type: string
podGroupReplicaKey:
type: string
required:
- name
- podGroup
type: object
required:
- containers
type: object
Expand Down Expand Up @@ -12113,6 +12145,10 @@ spec:
type: integer
signerName:
type: string
userAnnotations:
additionalProperties:
type: string
type: object
required:
- keyType
- signerName
Expand Down Expand Up @@ -12307,6 +12343,18 @@ spec:
x-kubernetes-list-map-keys:
- name
x-kubernetes-list-type: map
workloadRef:
properties:
name:
type: string
podGroup:
type: string
podGroupReplicaKey:
type: string
required:
- name
- podGroup
type: object
required:
- containers
type: object
Expand Down
Loading
Loading