Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Update version from 0.4.0 to 0.5.0 on remaining kuberay docs files #1018

Merged
merged 8 commits into from
Apr 6, 2023
Merged

[Doc] Update version from 0.4.0 to 0.5.0 on remaining kuberay docs files #1018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
154fc0f
Update version from 0.4.0 to 0.5.0 on kuberay docs
architkulkarni Apr 6, 2023
ec5bf45
Update for apiserver
architkulkarni Apr 6, 2023
614d084
Update for python_client
architkulkarni Apr 6, 2023
09d59a9
Update proto generate version
architkulkarni Apr 6, 2023
383c633
Update proto swagger json
architkulkarni Apr 6, 2023
13f94b1
Update python client setup cfg
architkulkarni Apr 6, 2023
37dbd56
Update RayJob doc
architkulkarni Apr 6, 2023
acf9683
Update APIServer Chart.yaml and readme
architkulkarni Apr 6, 2023
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
2 changes: 1 addition & 1 deletion .github/workflows/image-release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
description: 'Commit reference (branch or SHA) from which to build the images.'
required: true
tag:
description: 'Desired release version tag (e.g. v0.4.0-rc.0).'
description: 'Desired release version tag (e.g. v0.5.0-rc.0).'
required: true

jobs:
Expand Down
6 changes: 3 additions & 3 deletions apiserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ helm version
```sh
helm repo add kuberay https://ray-project.github.io/kuberay-helm/

# Install KubeRay APIServer v0.4.0.
helm install kuberay-apiserver kuberay/kuberay-apiserver --version 0.4.0
# Install KubeRay APIServer v0.5.0.
helm install kuberay-apiserver kuberay/kuberay-apiserver --version 0.5.0

# Check the KubeRay APIServer Pod in `default` namespace
kubectl get pods
Expand All @@ -60,7 +60,7 @@ To list the `my-release` deployment:
```sh
helm ls
# NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
# kuberay-apiserver default 1 2023-02-07 09:28:15.510869781 -0500 EST deployedkuberay-apiserver-0.4.0
# kuberay-apiserver default 1 2023-02-07 09:28:15.510869781 -0500 EST deployedkuberay-apiserver-0.5.0
```

### Uninstall the Chart
Expand Down
2 changes: 1 addition & 1 deletion clients/python-client/python_client/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.4.0"
__version__ = "0.5.0"
2 changes: 1 addition & 1 deletion clients/python-client/setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = python_client
version = 0.4.0
version = 0.5.0
author = Ali Kanso
description = A Kuberay python client library to create/delete/update clusters
long_description = file: README.md
Expand Down
4 changes: 2 additions & 2 deletions docs/guidance/rayjob.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
### Prerequisites

* Ray 1.10 or higher
* KubeRay v0.3.0+. (v0.4.0 is recommended)
* KubeRay v0.3.0+. (v0.5.0+ is recommended)

### What is a RayJob?

Expand All @@ -21,7 +21,7 @@ A RayJob manages 2 things:
### Deploy KubeRay

Make sure your KubeRay operator version is at least v0.3.0.
The latest released KubeRay version (v0.4.0) is recommended.
The latest released KubeRay version is recommended.
For installation instructions, please follow [the documentation](../deploy/installation.md).

### Run an example Job
Expand Down
2 changes: 1 addition & 1 deletion docs/guidance/rayservice.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A RayService manages 2 things:
### Deploy the Operator

```
$ kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.4.0&timeout=90s"
$ kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.5.0&timeout=90s"
```

Check that the controller is running.
Expand Down
2 changes: 1 addition & 1 deletion docs/notebook/kuberay-on-kind.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@
}
],
"source": [
"!kubectl create -k \"github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.4.0&timeout=90s\""
"!kubectl create -k \"github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.5.0&timeout=90s\""
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion helm-chart/kuberay-apiserver/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.4.0
architkulkarni marked this conversation as resolved.
Show resolved Hide resolved
version: 0.5.0
6 changes: 3 additions & 3 deletions helm-chart/kuberay-apiserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ helm version
```sh
helm repo add kuberay https://ray-project.github.io/kuberay-helm/

# Install the KubeRay API Server at Version v0.4.0.
helm install kuberay-apiserver kuberay/kuberay-apiserver --version 0.4.0
# Install the KubeRay API Server at Version v0.5.0.
helm install kuberay-apiserver kuberay/kuberay-apiserver --version 0.5.0

# Check that the KubeRay API Server is running in the "default" namespaces.
kubectl get pods
Expand All @@ -42,7 +42,7 @@ To list the `kuberay-apiserver` release:
```sh
helm ls
# NAME NAMESPACE REVISION UPDATED STATUS CHART
# kuberay-apiserver default 1 2022-12-02 02:13:37.514445313 +0000 UTC deployed kuberay-apiserver-0.4.0
# kuberay-apiserver default 1 2022-12-02 02:13:37.514445313 +0000 UTC deployed kuberay-apiserver-0.5.0
```

## Uninstall the Chart
Expand Down
2 changes: 1 addition & 1 deletion proto/hack/generate.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ cp ${TMP_OUTPUT}/github.com/ray-project/kuberay/proto/go_client/* ./go_client
# Generate a single swagger json file from the swagger json files of all models.
# Note: use proto/swagger/{cluster,config,error}.swagger.json
# Note: swagger files are generate to source folder directly. No files in ${TMP_OUTPUT}
jq -s 'reduce .[] as $item ({}; . * $item) | .info.title = "KubeRay API" | .info.description = "This file contains REST API specification for KubeRay. The file is autogenerated from the swagger definition." | .info.version = "'0.4.0'" | .info.license = { "name": "Apache 2.0", "url": "https://raw.githubusercontent.com/ray-project/kuberay/master/LICENSE" }' \
jq -s 'reduce .[] as $item ({}; . * $item) | .info.title = "KubeRay API" | .info.description = "This file contains REST API specification for KubeRay. The file is autogenerated from the swagger definition." | .info.version = "'0.5.0'" | .info.license = { "name": "Apache 2.0", "url": "https://raw.githubusercontent.com/ray-project/kuberay/master/LICENSE" }' \
/go/src/github.com/ray-project/kuberay/proto/swagger/cluster.swagger.json \
/go/src/github.com/ray-project/kuberay/proto/swagger/config.swagger.json \
/go/src/github.com/ray-project/kuberay/proto/swagger/error.swagger.json \
Expand Down
2 changes: 1 addition & 1 deletion proto/kuberay_api.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"title": "KubeRay API",
"version": "0.4.0",
"version": "0.5.0",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's generated correctly.

"description": "This file contains REST API specification for KubeRay. The file is autogenerated from the swagger definition.",
"license": {
"name": "Apache 2.0",
Expand Down
2 changes: 1 addition & 1 deletion ray-operator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can update the number of replicas in a worker group, and specify which exact
### Deploy the operator

```shell
kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.4.0&timeout=90s"
kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v0.5.0&timeout=90s"
```

Check that the controller is running.
Expand Down