Skip to content

Commit c736f80

Browse files
authored
docs: Add a description for the OpaCluster CRD (#843)
I more or less copied this from our other operators.
1 parent adf3863 commit c736f80

3 files changed

Lines changed: 13 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
99
- Added support for OPA `1.16.2`. `1.12.3` is now deprecated ([#838]).
1010
- BREAKING: Add required CLI argument and env var to set the image repository used to construct final product image names: `IMAGE_REPOSITORY` (`--image-repository`), eg. `oci.example.org/my/namespace` ([#830]).
1111
- Support `configOverrides` for `config.json` ([#818], [#831]).
12+
- Add a description for the `OpaCluster` CRD, which shows up in the generated CRD ([#843]).
1213

1314
### Changed
1415

@@ -31,6 +32,7 @@ All notable changes to this project will be documented in this file.
3132
[#836]: https://github.com/stackabletech/opa-operator/pull/836
3233
[#838]: https://github.com/stackabletech/opa-operator/pull/838
3334
[#840]: https://github.com/stackabletech/opa-operator/pull/840
35+
[#843]: https://github.com/stackabletech/opa-operator/pull/843
3436

3537
## [26.3.0] - 2026-03-16
3638

extra/crds.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ spec:
2121
description: Auto-generated derived type for OpaClusterSpec via `CustomResource`
2222
properties:
2323
spec:
24+
description: |-
25+
An OPA (Open Policy Agent) cluster stacklet. This resource is managed by the Stackable operator for OPA.
26+
Find more information on how to use it and the resources that the operator generates in the
27+
[operator documentation](https://docs.stackable.tech/home/nightly/opa/).
2428
properties:
2529
clusterConfig:
2630
default:
@@ -1914,6 +1918,10 @@ spec:
19141918
description: Auto-generated derived type for OpaClusterSpec via `CustomResource`
19151919
properties:
19161920
spec:
1921+
description: |-
1922+
An OPA (Open Policy Agent) cluster stacklet. This resource is managed by the Stackable operator for OPA.
1923+
Find more information on how to use it and the resources that the operator generates in the
1924+
[operator documentation](https://docs.stackable.tech/home/nightly/opa/).
19171925
properties:
19181926
clusterConfig:
19191927
default:

rust/operator-binary/src/crd/mod.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@ pub enum Error {
7575
)
7676
)]
7777
pub mod versioned {
78+
/// An OPA (Open Policy Agent) cluster stacklet. This resource is managed by the Stackable operator for OPA.
79+
/// Find more information on how to use it and the resources that the operator generates in the
80+
/// [operator documentation](DOCS_BASE_URL_PLACEHOLDER/opa/).
7881
#[versioned(crd(
7982
group = "opa.stackable.tech",
8083
status = "OpaClusterStatus",

0 commit comments

Comments
 (0)