Skip to content

Commit

Permalink
[chore][docs] enable Markdownlint rule MD004 (#2973)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidxia authored Feb 7, 2025
1 parent 391099a commit 4b27b44
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
1 change: 0 additions & 1 deletion ci/markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
# Default state for all rules
default: true

MD004: false
MD005: false
MD007: false
MD012: false
Expand Down
4 changes: 2 additions & 2 deletions docs/guidance/rayStartParams.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The latter setting exposes the Ray dashboard outside the Ray cluster, which is r
The default value for both Ray and KubeRay 0.5.0 is `localhost`. Please note that this will change for versions of KubeRay later than 0.5.0, where the default setting will be `0.0.0.0`.

- `--no-monitor` (Modification is not recommended):
* Ray autoscaler supports various node providers such as AWS, GCP, Azure, and Kubernetes. However, the default autoscaler is not compatible with Kubernetes. Therefore, when [KubeRay autoscaling](https://github.com/ray-project/kuberay/blob/master/docs/guidance/autoscaler.md) is enabled (i.e. `EnableInTreeAutoscaling` is true), KubeRay disables the monitor process via setting `--no-monitor` to true and injects a sidecar container for KubeRay autoscaler. See [PR #13505](https://github.com/ray-project/ray/pull/13505) for more details.
* Please note that the monitor process serves not only for autoscaling but also for observability, such as Prometheus metrics. Considering this, it is reasonable to disable the Kubernetes-incompatible autoscaler regardless of the value of `EnableInTreeAutoscaling`. To achieve this, we can launch the monitor process without autoscaling functionality by setting the autoscaler to READONLY mode. If `autoscaling-option` is not set, the autoscaler will default to READONLY mode.
- Ray autoscaler supports various node providers such as AWS, GCP, Azure, and Kubernetes. However, the default autoscaler is not compatible with Kubernetes. Therefore, when [KubeRay autoscaling](https://github.com/ray-project/kuberay/blob/master/docs/guidance/autoscaler.md) is enabled (i.e. `EnableInTreeAutoscaling` is true), KubeRay disables the monitor process via setting `--no-monitor` to true and injects a sidecar container for KubeRay autoscaler. See [PR #13505](https://github.com/ray-project/ray/pull/13505) for more details.
- Please note that the monitor process serves not only for autoscaling but also for observability, such as Prometheus metrics. Considering this, it is reasonable to disable the Kubernetes-incompatible autoscaler regardless of the value of `EnableInTreeAutoscaling`. To achieve this, we can launch the monitor process without autoscaling functionality by setting the autoscaler to READONLY mode. If `autoscaling-option` is not set, the autoscaler will default to READONLY mode.

- `--port`: Port for the GCS server. The port is set to `6379` by default. Please ensure that this value matches the `gcs-server` container port in Ray head container.

Expand Down

0 comments on commit 4b27b44

Please sign in to comment.