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: clarify that CRDs are never applied in prod mode #1010

Merged
merged 1 commit into from
Nov 25, 2024
Merged

doc: clarify that CRDs are never applied in prod mode #1010

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
15 changes: 9 additions & 6 deletions core/runtime/src/main/java/io/quarkiverse/operatorsdk/runtime/CRDConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ public interface CRDConfiguration {

/**
* Whether the extension should automatically apply updated CRDs when they change.
* When running on DEV mode, the CRD changes will always be applied automatically.
* <p>
* <strong>NOTE that this option only when *not* in Dev mode as applying the CRD to a production cluster could be
Copy link
Member

Choose a reason for hiding this comment

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

missing verb?

Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure what this is saying. It applies only in dev and test, correct?

Copy link
Member Author

Choose a reason for hiding this comment

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

D'oh! 😓 Opened a new PR to fix this. Thank you!

* dangerous.</strong>
* </p>
*/
Optional<Boolean> apply();

Expand All @@ -49,21 +52,21 @@ public interface CRDConfiguration {
Optional<String> outputDirectory();

/**
* Whether the extension should generate all CRDs even if some are not tied to a Reconciler.
* Whether the extension should generate all CRDs for Custom Resource implementations known to the application even if some
* are not tied to a Reconciler.
*/
@WithDefault("false")
Boolean generateAll();

/**
* Whether the CRDs should be generated in parallel. Please note that this feature is experimental
* and it may lead to unexpected results.
* Whether the CRDs should be generated in parallel.
*/
@WithDefault("false")
Boolean generateInParallel();

/**
* A comma-separated list of fully-qualified class names implementing custom resources to exclude from the CRD generation
* process.
* A comma-separated list of fully-qualified class names implementing {@link CustomResource} to exclude from the CRD
* generation process.
*/
Optional<List<String>> excludeResources();

Expand Down
10 changes: 6 additions & 4 deletions docs/modules/ROOT/pages/includes/quarkus-operator-sdk.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus-operator-s

[.description]
--
Whether the extension should automatically apply updated CRDs when they change. When running on DEV mode, the CRD changes will always be applied automatically.
Whether the extension should automatically apply updated CRDs when they change.

*NOTE that this option only when ++*++not++*++ in Dev mode as applying the CRD to a production cluster could be dangerous.*


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -96,7 +98,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus-operator-s

[.description]
--
Whether the extension should generate all CRDs even if some are not tied to a Reconciler.
Whether the extension should generate all CRDs for Custom Resource implementations known to the application even if some are not tied to a Reconciler.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -113,7 +115,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus-operator-s

[.description]
--
Whether the CRDs should be generated in parallel. Please note that this feature is experimental and it may lead to unexpected results.
Whether the CRDs should be generated in parallel.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -130,7 +132,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus-operator-s

[.description]
--
A comma-separated list of fully-qualified class names implementing custom resources to exclude from the CRD generation process.
A comma-separated list of fully-qualified class names implementing `CustomResource` to exclude from the CRD generation process.


ifdef::add-copy-button-to-env-var[]
Expand Down
10 changes: 6 additions & 4 deletions docs/modules/ROOT/pages/includes/quarkus-operator-sdk_quarkus.operator-sdk.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus-operator-s

[.description]
--
Whether the extension should automatically apply updated CRDs when they change. When running on DEV mode, the CRD changes will always be applied automatically.
Whether the extension should automatically apply updated CRDs when they change.

*NOTE that this option only when ++*++not++*++ in Dev mode as applying the CRD to a production cluster could be dangerous.*


ifdef::add-copy-button-to-env-var[]
Expand Down Expand Up @@ -96,7 +98,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus-operator-s

[.description]
--
Whether the extension should generate all CRDs even if some are not tied to a Reconciler.
Whether the extension should generate all CRDs for Custom Resource implementations known to the application even if some are not tied to a Reconciler.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -113,7 +115,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus-operator-s

[.description]
--
Whether the CRDs should be generated in parallel. Please note that this feature is experimental and it may lead to unexpected results.
Whether the CRDs should be generated in parallel.


ifdef::add-copy-button-to-env-var[]
Expand All @@ -130,7 +132,7 @@ a|icon:lock[title=Fixed at build time] [[quarkus-operator-sdk_quarkus-operator-s

[.description]
--
A comma-separated list of fully-qualified class names implementing custom resources to exclude from the CRD generation process.
A comma-separated list of fully-qualified class names implementing `CustomResource` to exclude from the CRD generation process.


ifdef::add-copy-button-to-env-var[]
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Please refer to the https://github.com/quarkiverse/quarkus-operator-sdk/blob/mai
* Watches your code for changes and reload automatically your operator if needed without having to hit an endpoint
* Only re-generates the CRDs if a change impacting its generation is detected
* Only re-processes a reconciler's configuration if needed
* Automatically apply the CRD to the cluster when it has changed
* Automatically apply the CRD to the cluster when it has changed (only in dev mode and during tests, never in production)
- Supports micrometer registry extensions (adding a Quarkus-supported micrometer registry extension will automatically inject said registry into the operator)
- Automatically adds a SmallRye health check
- Sets up reflection for native binary generation
Expand Down