You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/index.adoc
+14-3Lines changed: 14 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -33,9 +33,16 @@ Please refer to the https://github.com/quarkiverse/quarkus-operator-sdk/blob/mai
33
33
34
34
== Installation
35
35
36
-
If you want to use this extension, you need to add the `quarkus-operator-sdk` extension first.
36
+
=== Using the Quarkus platform
37
37
38
-
You need to add minimally, the following to your `pom.xml` file:
38
+
The best way to use this extension is to generate a skeleton project from https://code.quarkus.io[code.quarkus.io], search for `qosdk` (or similar) and select the Operator SDK extension.
39
+
Doing so will automatically import the Java Operator SDK dependencies in a managed way, using the BOM from the Quarkus platform.
40
+
41
+
Some of these topics along with upgrading strategies are discussed in https://developers.redhat.com/articles/2023/09/19/write-operators-java-josdk-part-4-upgrading-strategies.
42
+
43
+
=== Managing the QOSDK extension yourself
44
+
45
+
Alternatively, you can add the following to your `pom.xml` file, if you want to be managing the QOSDK extension yourself.
39
46
40
47
[source,xml,subs=attributes+]
41
48
----
@@ -75,7 +82,11 @@ Exception in thread "main" java.lang.RuntimeException: java.lang.RuntimeExceptio
75
82
at io.quarkus.deployment.dev.DevModeMain.main(DevModeMain.java:62)
76
83
----
77
84
78
-
If you want to use the Bundle generator, you will first need to use Quarkus 2.3.0.Final or above and add the `quarkus-operator-sdk-bundle-generator` extension first:
85
+
=== OLM bundle generator extension
86
+
87
+
You can add the OLM bundle generator using the Quarkus platform via code.quarkus.io, searching for `olm` (for example).
88
+
89
+
You can also add the `quarkus-operator-sdk-bundle-generator` extension manually to your dependencies in a project that's already set up to use QOSDK.
0 commit comments