Skip to content

Commit d723f50

Browse files
kevin85421kevin85421
authored
[CRD] Delete CRD v1alpha1 (#1771)
1 parent a6cf6e0 commit d723f50

17 files changed

+0
-52061
lines changed

‎docs/reference/api.md

Lines changed: 0 additions & 281 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
## Packages
44
- [ray.io/v1](#rayiov1)
5-
- [ray.io/v1alpha1](#rayiov1alpha1)
65

76

87
## ray.io/v1
@@ -242,286 +241,6 @@ _Appears in:_
242241

243242

244243

245-
_Appears in:_
246-
- [RayServiceSpec](#rayservicespec)
247-
248-
| Field | Description |
249-
| --- | --- |
250-
| `importPath` _string_ | |
251-
| `runtimeEnv` _string_ | |
252-
| `deployments` _[ServeConfigSpec](#serveconfigspec) array_ | |
253-
| `port` _integer_ | |
254-
255-
256-
#### UpscalingMode
257-
258-
_Underlying type:_ _string_
259-
260-
261-
262-
_Appears in:_
263-
- [AutoscalerOptions](#autoscaleroptions)
264-
265-
266-
267-
#### WorkerGroupSpec
268-
269-
270-
271-
WorkerGroupSpec are the specs for the worker pods
272-
273-
_Appears in:_
274-
- [RayClusterSpec](#rayclusterspec)
275-
276-
| Field | Description |
277-
| --- | --- |
278-
| `groupName` _string_ | we can have multiple worker groups, we distinguish them by name |
279-
| `replicas` _integer_ | Replicas is the number of desired Pods for this worker group. See https://github.com/ray-project/kuberay/pull/1443 for more details about the reason for making this field optional. |
280-
| `minReplicas` _integer_ | MinReplicas denotes the minimum number of desired Pods for this worker group. |
281-
| `maxReplicas` _integer_ | MaxReplicas denotes the maximum number of desired Pods for this worker group, and the default value is maxInt32. |
282-
| `rayStartParams` _object (keys:string, values:string)_ | RayStartParams are the params of the start command: address, object-store-memory, ... |
283-
| `template` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core)_ | Template is a pod template for the worker |
284-
| `scaleStrategy` _[ScaleStrategy](#scalestrategy)_ | ScaleStrategy defines which pods to remove |
285-
286-
287-
288-
## ray.io/v1alpha1
289-
290-
291-
Package v1alpha1 contains API Schema definitions for the ray v1alpha1 API group
292-
293-
### Resource Types
294-
- [RayCluster](#raycluster)
295-
- [RayJob](#rayjob)
296-
- [RayService](#rayservice)
297-
298-
299-
300-
#### AutoscalerOptions
301-
302-
303-
304-
AutoscalerOptions specifies optional configuration for the Ray autoscaler.
305-
306-
_Appears in:_
307-
- [RayClusterSpec](#rayclusterspec)
308-
309-
| Field | Description |
310-
| --- | --- |
311-
| `resources` _[ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core)_ | Resources specifies optional resource request and limit overrides for the autoscaler container. Default values: 500m CPU request and limit. 512Mi memory request and limit. |
312-
| `image` _string_ | Image optionally overrides the autoscaler's container image. This override is for provided for autoscaler testing and development. |
313-
| `imagePullPolicy` _[PullPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#pullpolicy-v1-core)_ | ImagePullPolicy optionally overrides the autoscaler container's image pull policy. This override is for provided for autoscaler testing and development. |
314-
| `env` _[EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core) array_ | Optional list of environment variables to set in the autoscaler container. |
315-
| `envFrom` _[EnvFromSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envfromsource-v1-core) array_ | Optional list of sources to populate environment variables in the autoscaler container. |
316-
| `volumeMounts` _[VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#volumemount-v1-core) array_ | Optional list of volumeMounts. This is needed for enabling TLS for the autoscaler container. |
317-
| `securityContext` _[SecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#securitycontext-v1-core)_ | SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
318-
| `idleTimeoutSeconds` _integer_ | IdleTimeoutSeconds is the number of seconds to wait before scaling down a worker pod which is not using Ray resources. Defaults to 60 (one minute). It is not read by the KubeRay operator but by the Ray autoscaler. |
319-
| `upscalingMode` _[UpscalingMode](#upscalingmode)_ | UpscalingMode is "Conservative", "Default", or "Aggressive." Conservative: Upscaling is rate-limited; the number of pending worker pods is at most the size of the Ray cluster. Default: Upscaling is not rate-limited. Aggressive: An alias for Default; upscaling is not rate-limited. It is not read by the KubeRay operator but by the Ray autoscaler. |
320-
321-
322-
323-
324-
#### HeadGroupSpec
325-
326-
327-
328-
HeadGroupSpec are the spec for the head pod
329-
330-
_Appears in:_
331-
- [RayClusterSpec](#rayclusterspec)
332-
333-
| Field | Description |
334-
| --- | --- |
335-
| `serviceType` _[ServiceType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#servicetype-v1-core)_ | ServiceType is Kubernetes service type of the head service. it will be used by the workers to connect to the head pod |
336-
| `headService` _[Service](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#service-v1-core)_ | HeadService is the Kubernetes service of the head pod. |
337-
| `enableIngress` _boolean_ | EnableIngress indicates whether operator should create ingress object for head service or not. |
338-
| `rayStartParams` _object (keys:string, values:string)_ | RayStartParams are the params of the start command: node-manager-port, object-store-memory, ... |
339-
| `template` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core)_ | Template is the exact pod template used in K8s depoyments, statefulsets, etc. |
340-
341-
342-
#### RayActorOptionSpec
343-
344-
345-
346-
RayActorOptionSpec defines the desired state of RayActor
347-
348-
_Appears in:_
349-
- [ServeConfigSpec](#serveconfigspec)
350-
351-
| Field | Description |
352-
| --- | --- |
353-
| `runtimeEnv` _string_ | |
354-
| `numCpus` _float_ | |
355-
| `numGpus` _float_ | |
356-
| `memory` _integer_ | |
357-
| `objectStoreMemory` _integer_ | |
358-
| `resources` _string_ | |
359-
| `acceleratorType` _string_ | |
360-
361-
362-
#### RayCluster
363-
364-
365-
366-
RayCluster is the Schema for the RayClusters API
367-
368-
369-
370-
| Field | Description |
371-
| --- | --- |
372-
| `apiVersion` _string_ | `ray.io/v1alpha1`
373-
| `kind` _string_ | `RayCluster`
374-
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
375-
| `spec` _[RayClusterSpec](#rayclusterspec)_ | Specification of the desired behavior of the RayCluster. |
376-
377-
378-
#### RayClusterSpec
379-
380-
381-
382-
EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN! NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized. var app appsv1.Deployment{} RayClusterSpec defines the desired state of RayCluster
383-
384-
_Appears in:_
385-
- [RayCluster](#raycluster)
386-
- [RayJobSpec](#rayjobspec)
387-
- [RayServiceSpec](#rayservicespec)
388-
389-
| Field | Description |
390-
| --- | --- |
391-
| `headGroupSpec` _[HeadGroupSpec](#headgroupspec)_ | INSERT ADDITIONAL SPEC FIELDS - desired state of cluster Important: Run "make" to regenerate code after modifying this file HeadGroupSpecs are the spec for the head pod |
392-
| `workerGroupSpecs` _[WorkerGroupSpec](#workergroupspec) array_ | WorkerGroupSpecs are the specs for the worker pods |
393-
| `rayVersion` _string_ | RayVersion is used to determine the command for the Kubernetes Job managed by RayJob |
394-
| `enableInTreeAutoscaling` _boolean_ | EnableInTreeAutoscaling indicates whether operator should create in tree autoscaling configs |
395-
| `autoscalerOptions` _[AutoscalerOptions](#autoscaleroptions)_ | AutoscalerOptions specifies optional configuration for the Ray autoscaler. |
396-
| `headServiceAnnotations` _object (keys:string, values:string)_ | |
397-
398-
399-
#### RayJob
400-
401-
402-
403-
RayJob is the Schema for the rayjobs API
404-
405-
406-
407-
| Field | Description |
408-
| --- | --- |
409-
| `apiVersion` _string_ | `ray.io/v1alpha1`
410-
| `kind` _string_ | `RayJob`
411-
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
412-
| `spec` _[RayJobSpec](#rayjobspec)_ | |
413-
414-
415-
#### RayJobSpec
416-
417-
418-
419-
RayJobSpec defines the desired state of RayJob
420-
421-
_Appears in:_
422-
- [RayJob](#rayjob)
423-
424-
| Field | Description |
425-
| --- | --- |
426-
| `entrypoint` _string_ | INSERT ADDITIONAL SPEC FIELDS - desired state of cluster Important: Run "make" to regenerate code after modifying this file |
427-
| `metadata` _object (keys:string, values:string)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
428-
| `runtimeEnv` _string_ | RuntimeEnv is base64 encoded. This field is deprecated, please use RuntimeEnvYAML instead. |
429-
| `runtimeEnvYAML` _string_ | RuntimeEnvYAML represents the runtime environment configuration provided as a multi-line YAML string. |
430-
| `jobId` _string_ | If jobId is not set, a new jobId will be auto-generated. |
431-
| `shutdownAfterJobFinishes` _boolean_ | ShutdownAfterJobFinishes will determine whether to delete the ray cluster once rayJob succeed or failed. |
432-
| `ttlSecondsAfterFinished` _integer_ | TTLSecondsAfterFinished is the TTL to clean up RayCluster. It's only working when ShutdownAfterJobFinishes set to true. |
433-
| `rayClusterSpec` _[RayClusterSpec](#rayclusterspec)_ | RayClusterSpec is the cluster template to run the job |
434-
| `clusterSelector` _object (keys:string, values:string)_ | clusterSelector is used to select running rayclusters by labels |
435-
| `suspend` _boolean_ | suspend specifies whether the RayJob controller should create a RayCluster instance If a job is applied with the suspend field set to true, the RayCluster will not be created and will wait for the transition to false. If the RayCluster is already created, it will be deleted. In case of transition to false a new RayCluster will be created. |
436-
| `submitterPodTemplate` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podtemplatespec-v1-core)_ | SubmitterPodTemplate is the template for the pod that will run `ray job submit`. |
437-
| `entrypointNumCpus` _float_ | EntrypointNumCpus specifies the number of cpus to reserve for the entrypoint command. |
438-
| `entrypointNumGpus` _float_ | EntrypointNumGpus specifies the number of gpus to reserve for the entrypoint command. |
439-
| `entrypointResources` _string_ | EntrypointResources specifies the custom resources and quantities to reserve for the entrypoint command. |
440-
441-
442-
443-
444-
#### RayService
445-
446-
447-
448-
RayService is the Schema for the rayservices API
449-
450-
451-
452-
| Field | Description |
453-
| --- | --- |
454-
| `apiVersion` _string_ | `ray.io/v1alpha1`
455-
| `kind` _string_ | `RayService`
456-
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
457-
| `spec` _[RayServiceSpec](#rayservicespec)_ | |
458-
459-
460-
#### RayServiceSpec
461-
462-
463-
464-
RayServiceSpec defines the desired state of RayService
465-
466-
_Appears in:_
467-
- [RayService](#rayservice)
468-
469-
| Field | Description |
470-
| --- | --- |
471-
| `serveConfig` _[ServeDeploymentGraphSpec](#servedeploymentgraphspec)_ | Important: Run "make" to regenerate code after modifying this file |
472-
| `serveConfigV2` _string_ | Defines the applications and deployments to deploy, should be a YAML multi-line scalar string. |
473-
| `rayClusterConfig` _[RayClusterSpec](#rayclusterspec)_ | |
474-
| `serviceUnhealthySecondThreshold` _integer_ | Deprecated: This field is not used anymore. ref: https://github.com/ray-project/kuberay/issues/1685 |
475-
| `deploymentUnhealthySecondThreshold` _integer_ | Deprecated: This field is not used anymore. ref: https://github.com/ray-project/kuberay/issues/1685 |
476-
| `serveService` _[Service](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#service-v1-core)_ | ServeService is the Kubernetes service for head node and worker nodes who have healthy http proxy to serve traffics. |
477-
478-
479-
480-
481-
#### ScaleStrategy
482-
483-
484-
485-
ScaleStrategy to remove workers
486-
487-
_Appears in:_
488-
- [WorkerGroupSpec](#workergroupspec)
489-
490-
| Field | Description |
491-
| --- | --- |
492-
| `workersToDelete` _string array_ | WorkersToDelete workers to be deleted |
493-
494-
495-
#### ServeConfigSpec
496-
497-
498-
499-
ServeConfigSpec defines the desired state of RayService Reference to http://rayserve.org
500-
501-
_Appears in:_
502-
- [ServeDeploymentGraphSpec](#servedeploymentgraphspec)
503-
504-
| Field | Description |
505-
| --- | --- |
506-
| `name` _string_ | |
507-
| `numReplicas` _integer_ | |
508-
| `routePrefix` _string_ | |
509-
| `maxConcurrentQueries` _integer_ | |
510-
| `userConfig` _string_ | |
511-
| `autoscalingConfig` _string_ | |
512-
| `gracefulShutdownWaitLoopS` _integer_ | |
513-
| `gracefulShutdownTimeoutS` _integer_ | |
514-
| `healthCheckPeriodS` _integer_ | |
515-
| `healthCheckTimeoutS` _integer_ | |
516-
| `rayActorOptions` _[RayActorOptionSpec](#rayactoroptionspec)_ | |
517-
518-
519-
#### ServeDeploymentGraphSpec
520-
521-
522-
523-
524-
525244
_Appears in:_
526245
- [RayServiceSpec](#rayservicespec)
527246

0 commit comments

Comments
 (0)