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

Jump to bottom

[Feature][Doc] Explain that RBAC should be synchronized manually #641

Merged
merged 1 commit into from
Oct 17, 2022
Merged

[Feature][Doc] Explain that RBAC should be synchronized manually #641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 ray-operator/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ We have several [consistency checks](https://github.com/ray-project/kuberay/blob
2. `ray-operator/apis/ray/v1alpha1/*_types.go` should be synchronized with generated API (`ray-operator/pkg/client`)
3. CRD YAML files in `ray-operator/config/crd/bases/` and `helm-chart/kuberay-operator/crds/` should be the same.
4. Kubebuilder markers in `ray-operator/controllers/ray/*_controller.go` should be synchronized with RBAC YAML files in `ray-operator/config/rbac`.
5. RBAC YAML files in `helm-chart/kuberay-operator/templates` and `ray-operator/config/rbac` should be synchronized.
5. RBAC YAML files in `helm-chart/kuberay-operator/templates` and `ray-operator/config/rbac` should be synchronized. **Currently, we need to synchronize this manually.** See [#631](https://github.com/ray-project/kuberay/pull/631) as an example.

```bash
# Synchronize consistency 1 and 4:
Expand Down
4 changes: 3 additions & 1 deletion scripts/rbac-check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,6 @@ def compare_two_yaml(yaml1, yaml2):
diff_files.append(f)

if diff_files:
sys.exit(f"{diff_files} are out of synchronization!")
sys.exit(f"{diff_files} are out of synchronization! RBAC YAML files in" +
"\'helm-chart/kuberay-operator/templates\' and \'ray-operator/config/rbac\'" +
"should be synchronized manually. See DEVELOPMENT.md for more details.")