Skip to content

Commit

Permalink
feat: Better CRD docs (#319)
Browse files Browse the repository at this point in the history
* updated operator rs

* update Changelog

* docs

* removed version and stopped fields and others mandatory

* added comments

* history server docs. Removed test step that does not work following the deletecollection fix

* regenerate charts

* updated docs

* updated changelog

* review suggestions

* expanded changelog comment

* changed mode to enum, make JobDependencies non-optional

* regenerate charts

* removed all mentions of removed version field

* added strum directive

---------

Co-authored-by: Andrew Kenworthy <[email protected]>
  • Loading branch information
fhennig and adwk67 authored Dec 14, 2023
1 parent 297bea0 commit 97301f5
Show file tree
Hide file tree
Showing 41 changed files with 455 additions and 333 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,19 @@ All notable changes to this project will be documented in this file.

## [Unreleased]

### Changed

- Various documentation of the CRD ([#319]).
- [BREAKING] Removed version field. Several attributes have been changed to mandatory. While this change is
technically breaking, existing Spark jobs would not have worked before as these attributes were necessary ([#319]).

### Fixed

- Add missing `deletecollection` RBAC permission for Spark drivers. Previously this caused confusing error
messages in the spark driver log (`User "system:serviceaccount:default:my-spark-app" cannot deletecollection resource "configmaps" in API group "" in the namespace "default".`) ([#313]).

[#313]: https://github.com/stackabletech/spark-k8s-operator/pull/313
[#319]: https://github.com/stackabletech/spark-k8s-operator/pull/319

## [23.11.0] - 2023-11-24

Expand Down
121 changes: 61 additions & 60 deletions Cargo.lock

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

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
serde_yaml = "0.9"
snafu = "0.7"
stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "0.56.1" }
stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "0.58.1" }
strum = { version = "0.25", features = ["derive"] }
tokio = { version = "1.29", features = ["full"] }
tracing = "0.1"
Expand Down
Loading

0 comments on commit 97301f5

Please sign in to comment.