Merge pull request #919 from kabir/kubernetes-readme

Instructions to run on Kubernetes in the READMEs
wildfly · Jul 4, 2024 · 33f3f42 · 33f3f42
2 parents 741125f + 65a06c2
commit 33f3f42
Show file tree

Hide file tree

Showing 75 changed files with 847 additions and 340 deletions.
diff --git a/...ts/kubernetes/qs-overrides/microprofile-reactive-messaging-kafka/overridable-functions.sh b/...ts/kubernetes/qs-overrides/microprofile-reactive-messaging-kafka/overridable-functions.sh
@@ -42,59 +42,23 @@ function installPrerequisites()
   application="${1}"
 
   echo "Installing Strimzi operator"
-  kubectl apply -f charts/strimzi-on-kubernetes.yaml
+  kubectl apply -f charts/strimzi-on-kubernetes.yaml --wait --timeout=10m0s
 
-  seconds=120
+  seconds=300
   now=$(date +%s)
   end=$(($seconds + $now))
 
-  echo "Looping for 2 minutes until the 'kafka' CRD is available "
+  echo "Looping for 5 minutes until the 'kafka' CRD is available "
   while [ $now -lt $end ]; do
-    # It takes a while for the kafka CRD to be ready
     sleep 5
-    echo "Trying to create my-cluster"
-    kubectl apply -f - <<EOF
-    apiVersion: kafka.strimzi.io/v1beta2
-    kind: Kafka
-    metadata:
-      name: my-cluster
-    spec:
-      kafka:
-        replicas: 3
-        listeners:
-          - name: plain
-            port: 9092
-            type: internal
-            tls: false
-        storage:
-          type: ephemeral
-      zookeeper:
-        replicas: 3
-        storage:
-          type: ephemeral
-      entityOperator:
-        topicOperator: {}
-EOF
+    echo "Create a Strimzi instance and testing topic"
+    kubectl apply -f ./charts/kafka-on-kubernetes.yaml --wait --timeout=10m0s
+    break
     if [ "$?" = "0" ]; then
       break
     fi
-    now=$(date +%s)
   done
 
-  echo "Creating testing topic"
-  kubectl apply -f - <<EOF
-  apiVersion: kafka.strimzi.io/v1beta2
-  kind: KafkaTopic
-  metadata:
-    name: testing
-  labels:
-    strimzi.io/cluster: my-cluster
-  spec:
-    partitions: 3
-    replicas: 3
-EOF
-
-  # Wait for the pods to come up
   seconds=900
   now=$(date +%s)
   end=$(($seconds + $now))
@@ -124,11 +88,6 @@ EOF
 # 1 - application name
 function cleanPrerequisites()
 {
-  # TODO There are a few topics created that need cleaning up
-
-  kubectl delete kafka my-cluster
-  kubectl delete subscription amq-streams-subscription
-  kubectl delete operatorgroup amq-streams-operator-group
-  kubectl delete deployment amq-streams-cluster-operator-v2.5.0-1
-  kubectl delete kafkatopic testing
+  kubectl delete -f ./charts/kafka-on-kubernetes.yaml --wait --timeout=10m0s
+  kubectl delete -f charts/strimzi-on-kubernetes.yaml --wait --timeout=10m0s
 }
diff --git a/batch-processing/README-source.adoc b/batch-processing/README-source.adoc
@@ -141,4 +141,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+// Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/bmt/README-source.adoc b/bmt/README-source.adoc
@@ -75,7 +75,10 @@ include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc
 endif::[]
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
 endif::[]
-
+ifndef::ProductRelease,EAPXPRelease[]
+// Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
 //*************************************************
 // Product Release content only
 //*************************************************

diff --git a/cmt/README-source.adoc b/cmt/README-source.adoc
@@ -87,4 +87,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+// Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/ee-security/README-source.adoc b/ee-security/README-source.adoc
@@ -130,4 +130,7 @@ ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
-
+ifndef::ProductRelease,EAPXPRelease[]
+// Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/ejb-remote/README-source.adoc b/ejb-remote/README-source.adoc
@@ -103,4 +103,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+// Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/ejb-timer/README-source.adoc b/ejb-timer/README-source.adoc
@@ -94,6 +94,10 @@ ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+// Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
 
 === Using Timer Service within a cluster
 

diff --git a/helloworld-mdb/README-source.adoc b/helloworld-mdb/README-source.adoc
@@ -90,7 +90,10 @@ ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
-
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
 
 
 == Clustering

diff --git a/helloworld-singleton/README-source.adoc b/helloworld-singleton/README-source.adoc
@@ -51,4 +51,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/helloworld-ws/README-source.adoc b/helloworld-ws/README-source.adoc
@@ -57,4 +57,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/helloworld/README-source.adoc b/helloworld/README-source.adoc
@@ -44,4 +44,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/hibernate/README-source.adoc b/hibernate/README-source.adoc
@@ -141,3 +141,7 @@ ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/jaxrs-client/README-source.adoc b/jaxrs-client/README-source.adoc
@@ -67,3 +67,7 @@ ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/jaxrs-jwt/README-source.adoc b/jaxrs-jwt/README-source.adoc
@@ -152,4 +152,8 @@ ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
 
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/jaxws-ejb/README-source.adoc b/jaxws-ejb/README-source.adoc
@@ -49,4 +49,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/jaxws-retail/README-source.adoc b/jaxws-retail/README-source.adoc
@@ -46,4 +46,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/jsonp/README-source.adoc b/jsonp/README-source.adoc
@@ -51,4 +51,7 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/kitchensink/README-source.adoc b/kitchensink/README-source.adoc
@@ -148,4 +148,8 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2]
 ifndef::ProductRelease,EAPXPRelease[]
 include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1]
 endif::[]
-include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/logging/README-source.adoc b/logging/README-source.adoc
@@ -163,3 +163,7 @@ include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc
 endif::[]
 
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
diff --git a/micrometer/README-source.adoc b/micrometer/README-source.adoc
@@ -14,7 +14,8 @@ The `micrometer` quickstart demonstrates the use of the Micrometer library in {p
 :archiveType: war
 :archiveName: {artifactId}
 :restoreScriptName: restore-configuration.cli
-:helm-install-prerequisites: ../micrometer/helm-install-prerequisites.adoc
+:helm-install-prerequisites-openshift: ../micrometer/helm-install-prerequisites-openshift.adoc
+:helm-install-prerequisites-kubernetes: ../micrometer/helm-install-prerequisites-kubernetes.adoc
 
 == What is it?
 
@@ -272,7 +273,10 @@ endif::[]
 include::../shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc[leveloffset=+1]
 // OpenShift
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
-
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
 == Conclusion
 
 Micrometer provides a de facto standard way of capturing and publishing metrics to the monitoring solution of your choice. {productName} provides a convenient, out-of-the-box integration of Micrometer to make it easier to capture those metrics and monitor your application's health and performance. For more information on Micrometer, please refer to the project's https://micrometer.io[website].
diff --git a/micrometer/helm-install-prerequisites-common.adoc b/micrometer/helm-install-prerequisites-common.adoc
@@ -0,0 +1,35 @@
+ifdef::prereq-openshift[]
+:prereq-cloud-platform: OpenShift
+:prereq-cloud-cli: oc
+:prereq-suffix: openshift
+endif::[]
+ifdef::prereq-kubernetes[]
+:prereq-cloud-platform: Kubernetes
+:prereq-cloud-cli: kubectl
+:prereq-suffix: kubernetes
+endif::[]
+
+
+
+=== Install OpenTelemetry Collector on OpenShift
+
+The functionality of this quickstart depends on a running instance of the https://opentelemetry.io/docs/collector/[OpenTelemetry Collector].
+
+To deploy and configure the OpenTelemetry Collector, you will need to apply a set of configurations to your {prereq-cloud-platform} cluster:
+
+[source,options="nowrap",subs="+attributes"]
+----
+include::charts/opentelemetry-collector-openshift.yaml[]
+----
+
+To make things simpler, you can find these commands in `charts/opentelemetry-collector-openshift.yaml`, and to apply them run the following command in your terminal:
+
+[source,options="nowrap",subs="+attributes"]
+----
+$ {prereq-cloud-cli} apply -f charts/opentelemetry-collector-{prereq-suffix}.yaml
+----
+
+[NOTE]
+====
+When done with the quickstart, the `{prereq-cloud-cli} delete -f charts/opentelemetry-collector-{prereq-suffix}.yaml` command may be used to revert the applied changes.
+====
diff --git a/micrometer/helm-install-prerequisites-kubernetes.adoc b/micrometer/helm-install-prerequisites-kubernetes.adoc
@@ -0,0 +1,2 @@
+:prereq-kubernetes: true
+include::./helm-install-prerequisites-common.adoc[]
diff --git a/micrometer/helm-install-prerequisites-openshift.adoc b/micrometer/helm-install-prerequisites-openshift.adoc
@@ -0,0 +1,2 @@
+:prereq-openshift: true
+include::./helm-install-prerequisites-common.adoc[]
diff --git a/micrometer/helm-install-prerequisites.adoc b/micrometer/helm-install-prerequisites.adoc
diff --git a/microprofile-config/README-source.adoc b/microprofile-config/README-source.adoc
@@ -802,6 +802,10 @@ include::../shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc[level
 
 // Openshift
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+//Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
 
 == Conclusion
 

diff --git a/microprofile-fault-tolerance/README-source.adoc b/microprofile-fault-tolerance/README-source.adoc
@@ -633,6 +633,10 @@ include::../shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc[level
 
 // OpenShift
 include::../shared-doc/build-and-run-the-quickstart-with-openshift.adoc[leveloffset=+1]
+ifndef::ProductRelease,EAPXPRelease[]
+// Kubernetes
+include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1]
+endif::[]
 
 == Conclusion