From 1776a12b68941e0d53254d2e0b4dc0be2d2f2b3d Mon Sep 17 00:00:00 2001 From: Eduardo Martins Date: Thu, 9 Jan 2025 10:37:31 +0000 Subject: [PATCH] Cleanup README includes --- batch-processing/README-source.adoc | 2 - bmt/README-source.adoc | 22 ----- cmt/README-source.adoc | 2 - ee-security/README-source.adoc | 2 - ejb-remote/README-source.adoc | 4 +- .../README-source.adoc | 2 - .../README-source.adoc | 11 +-- ejb-throws-exception/README-source.adoc | 2 - ejb-timer/README-source.adoc | 2 - ha-singleton-deployment/README-source.adoc | 3 - ha-singleton-service/README-source.adoc | 5 - helloworld-jms/README-source.adoc | 2 - helloworld-mdb/README-source.adoc | 2 - .../README-source.adoc | 2 - helloworld-mutual-ssl/README-source.adoc | 8 +- helloworld-rs/README-source.adoc | 2 - helloworld-singleton/README-source.adoc | 2 - helloworld-ws/README-source.adoc | 2 - helloworld/README-source.adoc | 2 - hibernate/README-source.adoc | 2 - http-custom-mechanism/README-source.adoc | 2 - jaxrs-client/README-source.adoc | 2 - jaxrs-jwt/README-source.adoc | 3 - jaxws-ejb/README-source.adoc | 2 - jaxws-retail/README-source.adoc | 2 - jsonp/README-source.adoc | 2 - jta-crash-rec/README-source.adoc | 17 +--- jts/README-source.adoc | 12 +-- kitchensink/README-source.adoc | 2 - logging/README-source.adoc | 3 - mail/README-source.adoc | 23 +---- micrometer/README-source.adoc | 2 - numberguess/README-source.adoc | 2 - opentelemetry-tracing/README-source.adoc | 2 - remote-helloworld-mdb/README-source.adoc | 4 - security-domain-to-domain/README-source.adoc | 2 - servlet-async/README-source.adoc | 2 - servlet-filterlistener/README-source.adoc | 2 - servlet-security/README-source.adoc | 2 - shared-doc/debug-the-application.adoc | 23 ----- shared-doc/deploy-to-openshift-online.adoc | 68 ------------- shared-doc/openshift-create-project.adoc | 46 --------- shared-doc/openshift-deploy-project.adoc | 97 ------------------- .../openshift-getting-started-overview.adoc | 8 -- shared-doc/openshift-getting-started.adoc | 8 -- ...enshift-import-imagestreams-templates.adoc | 71 -------------- .../openshift-post-deployment-tasks.adoc | 61 ------------ ...-quickstart-in-jboss-developer-studio.adoc | 17 ---- spring-resteasy/README-source.adoc | 2 - tasks-jsf/README-source.adoc | 2 - temperature-converter/README-source.adoc | 2 - thread-racing/README-source.adoc | 2 - websocket-endpoint/README-source.adoc | 2 - websocket-hello/README-source.adoc | 2 - 54 files changed, 6 insertions(+), 574 deletions(-) delete mode 100644 shared-doc/debug-the-application.adoc delete mode 100644 shared-doc/deploy-to-openshift-online.adoc delete mode 100644 shared-doc/openshift-create-project.adoc delete mode 100644 shared-doc/openshift-deploy-project.adoc delete mode 100644 shared-doc/openshift-getting-started-overview.adoc delete mode 100644 shared-doc/openshift-getting-started.adoc delete mode 100644 shared-doc/openshift-import-imagestreams-templates.adoc delete mode 100644 shared-doc/openshift-post-deployment-tasks.adoc delete mode 100644 shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc diff --git a/batch-processing/README-source.adoc b/batch-processing/README-source.adoc index 1f4573932c..64a8e3e112 100644 --- a/batch-processing/README-source.adoc +++ b/batch-processing/README-source.adoc @@ -138,9 +138,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/bmt/README-source.adoc b/bmt/README-source.adoc index a884f8da42..3a96bde570 100644 --- a/bmt/README-source.adoc +++ b/bmt/README-source.adoc @@ -28,8 +28,6 @@ When you run this example, you are presented with a *Use bean managed Entity Man This example shows how to transactionally insert key value pairs into the database and demonstrates the requirements on the developer with respect to the JPA Entity Manager. -ifndef::EAPCDRelease[] - // Link to the quickstart source include::../shared-doc/view-the-source.adoc[leveloffset=+1] // Considerations for Use in a Production Environment @@ -70,29 +68,9 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1] // Build and run sections for other environments/builds -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] -endif::[] ifndef::ProductRelease,EAPXPRelease[] // Kubernetes include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1] -endif::[] -//************************************************* -// Product Release content only -//************************************************* -ifdef::ProductRelease[] - -// Getting Started with OpenShift -include::../shared-doc/openshift-getting-started.adoc[leveloffset=+1] -//Prepare OpenShift for Quickstart Deployment -include::../shared-doc/openshift-create-project.adoc[leveloffset=+1] -// Import the Latest {xpaasproduct-shortname} Image Streams and Templates -include::../shared-doc/openshift-import-imagestreams-templates.adoc[leveloffset=+1] -// Deploy the {ProductShortName} Source-to-Image (S2I) Quickstart to OpenShift -include::../shared-doc/openshift-deploy-project.adoc[leveloffset=+1] -// Openshift post deployment tasks -include::../shared-doc/openshift-post-deployment-tasks.adoc[leveloffset=+1] - endif::[] \ No newline at end of file diff --git a/cmt/README-source.adoc b/cmt/README-source.adoc index f362e0b929..cffcc52c95 100644 --- a/cmt/README-source.adoc +++ b/cmt/README-source.adoc @@ -84,9 +84,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/ee-security/README-source.adoc b/ee-security/README-source.adoc index a7c252be6f..ccb35b619f 100644 --- a/ee-security/README-source.adoc +++ b/ee-security/README-source.adoc @@ -126,9 +126,7 @@ include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset= include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+3] // Build and run sections for other environments/builds -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 diff --git a/ejb-remote/README-source.adoc b/ejb-remote/README-source.adoc index c9b5dcd46c..e00c33e322 100644 --- a/ejb-remote/README-source.adoc +++ b/ejb-remote/README-source.adoc @@ -100,9 +100,7 @@ Logging statements have been removed from this output here to make it clearer. include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // This quickstart is not openshift compatible -include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] +include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/ejb-security-context-propagation/README-source.adoc b/ejb-security-context-propagation/README-source.adoc index 385587f3dd..deefd7526d 100644 --- a/ejb-security-context-propagation/README-source.adoc +++ b/ejb-security-context-propagation/README-source.adoc @@ -301,9 +301,7 @@ The batch executed successfully // Restore the {productName} Standalone Server Configuration Manually include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // Quickstart not compatible with OpenShift include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/ejb-security-programmatic-auth/README-source.adoc b/ejb-security-programmatic-auth/README-source.adoc index 821aeac1d3..b08af9a8a5 100644 --- a/ejb-security-programmatic-auth/README-source.adoc +++ b/ejb-security-programmatic-auth/README-source.adoc @@ -168,16 +168,7 @@ Principal has admin permission: true * Make sure you xref:restore_the_server_configuration[restore the {productName} standalone server configuration] when you have completed testing this quickstart. // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] - -//************************************************* -// Product Release content only -//************************************************* -ifdef::ProductRelease[] // Quickstart not compatible with OpenShift -include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] - -endif::[] \ No newline at end of file +include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/ejb-throws-exception/README-source.adoc b/ejb-throws-exception/README-source.adoc index fca363f3dd..85f82dcc32 100644 --- a/ejb-throws-exception/README-source.adoc +++ b/ejb-throws-exception/README-source.adoc @@ -86,9 +86,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level // Undeploy the Quickstart include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1] -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // Quickstart not compatible with OpenShift include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/ejb-timer/README-source.adoc b/ejb-timer/README-source.adoc index 15d820aa8c..c7c731e04e 100644 --- a/ejb-timer/README-source.adoc +++ b/ejb-timer/README-source.adoc @@ -89,9 +89,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1] // Build and run sections for other environments/builds -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 diff --git a/ha-singleton-deployment/README-source.adoc b/ha-singleton-deployment/README-source.adoc index 0f77b822e6..782f341f00 100644 --- a/ha-singleton-deployment/README-source.adoc +++ b/ha-singleton-deployment/README-source.adoc @@ -254,8 +254,5 @@ mvn wildfly:undeploy mvn wildfly:undeploy -Dwildfly.port=10090 ---- -// Debug the Application -include::../shared-doc/debug-the-application.adoc[leveloffset=+1] - // Quickstart not compatible with OpenShift include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] diff --git a/ha-singleton-service/README-source.adoc b/ha-singleton-service/README-source.adoc index adf2ede397..9de0cbe52c 100644 --- a/ha-singleton-service/README-source.adoc +++ b/ha-singleton-service/README-source.adoc @@ -474,10 +474,5 @@ $ __{jbossHomeName}_2__/bin/jboss-cli.sh --connect --controller=localhost:10090 + NOTE: For Windows, use the `__{jbossHomeName}_1__\bin\jboss-cli.bat` and `__{jbossHomeName}_2__\bin\jboss-cli.bat` scripts. -// Run the Quickstart in Red Hat CodeReady Studio or Eclipse -include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1] -// Debug the Application -include::../shared-doc/debug-the-application.adoc[leveloffset=+1] - // Quickstart not compatible with OpenShift include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] diff --git a/helloworld-jms/README-source.adoc b/helloworld-jms/README-source.adoc index 09a74c120e..ce2d681eed 100644 --- a/helloworld-jms/README-source.adoc +++ b/helloworld-jms/README-source.adoc @@ -156,7 +156,5 @@ The batch executed successfully ---- // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/helloworld-mdb/README-source.adoc b/helloworld-mdb/README-source.adoc index fd437b3a63..d9496d945b 100644 --- a/helloworld-mdb/README-source.adoc +++ b/helloworld-mdb/README-source.adoc @@ -85,9 +85,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/helloworld-mutual-ssl-secured/README-source.adoc b/helloworld-mutual-ssl-secured/README-source.adoc index 2d2c342230..70fc563868 100644 --- a/helloworld-mutual-ssl-secured/README-source.adoc +++ b/helloworld-mutual-ssl-secured/README-source.adoc @@ -293,9 +293,7 @@ After you are done with this quickstart, remember to remove the certificate that . The certificate has now been removed from the Mozilla Firefox browser. // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // Quickstart not compatible with OpenShift include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] diff --git a/helloworld-mutual-ssl/README-source.adoc b/helloworld-mutual-ssl/README-source.adoc index 50044d59d7..1a864c5ad1 100644 --- a/helloworld-mutual-ssl/README-source.adoc +++ b/helloworld-mutual-ssl/README-source.adoc @@ -232,13 +232,7 @@ After you are done with this quickstart, remember to remove the certificate that // Product Release content only //************************************************* // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] - -ifdef::ProductRelease[] // Quickstart not compatible with OpenShift -include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] - -endif::[] \ No newline at end of file +include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/helloworld-rs/README-source.adoc b/helloworld-rs/README-source.adoc index 6f3ea5de51..d55e2a9974 100644 --- a/helloworld-rs/README-source.adoc +++ b/helloworld-rs/README-source.adoc @@ -41,9 +41,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/helloworld-singleton/README-source.adoc b/helloworld-singleton/README-source.adoc index e794954c51..06da23c6be 100644 --- a/helloworld-singleton/README-source.adoc +++ b/helloworld-singleton/README-source.adoc @@ -48,9 +48,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/helloworld-ws/README-source.adoc b/helloworld-ws/README-source.adoc index 5462ba33a7..f99c03b413 100644 --- a/helloworld-ws/README-source.adoc +++ b/helloworld-ws/README-source.adoc @@ -56,9 +56,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/helloworld/README-source.adoc b/helloworld/README-source.adoc index 4c5e6bf039..278170ff13 100644 --- a/helloworld/README-source.adoc +++ b/helloworld/README-source.adoc @@ -41,9 +41,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // Bootable JAR include::../shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc[leveloffset=+1] // OpenShift diff --git a/hibernate/README-source.adoc b/hibernate/README-source.adoc index bbc713fa3d..f58cc44dfa 100644 --- a/hibernate/README-source.adoc +++ b/hibernate/README-source.adoc @@ -138,9 +138,7 @@ process-state: reload-required include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+3] // Build and run sections for other environments/builds -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 diff --git a/http-custom-mechanism/README-source.adoc b/http-custom-mechanism/README-source.adoc index 40acf5a1e7..406232141a 100644 --- a/http-custom-mechanism/README-source.adoc +++ b/http-custom-mechanism/README-source.adoc @@ -239,9 +239,7 @@ process-state: reload-required include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // Quickstart not compatible with OpenShift include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/jaxrs-client/README-source.adoc b/jaxrs-client/README-source.adoc index a890645c94..f32f38f004 100644 --- a/jaxrs-client/README-source.adoc +++ b/jaxrs-client/README-source.adoc @@ -64,9 +64,7 @@ When you run the integration tests, Maven prints summary of the performed tests include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/jaxrs-jwt/README-source.adoc b/jaxrs-jwt/README-source.adoc index 0cc30e7b62..ac8da209d4 100644 --- a/jaxrs-jwt/README-source.adoc +++ b/jaxrs-jwt/README-source.adoc @@ -146,10 +146,7 @@ process-state: reload-required // Restore the {productName} Standalone Server Configuration Manually include::../shared-doc/restore-standalone-server-configuration-manual.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] ifndef::ProductRelease,EAPXPRelease[] //Kubernetes diff --git a/jaxws-ejb/README-source.adoc b/jaxws-ejb/README-source.adoc index 30e558ac37..11a02094f8 100644 --- a/jaxws-ejb/README-source.adoc +++ b/jaxws-ejb/README-source.adoc @@ -46,9 +46,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/jaxws-retail/README-source.adoc b/jaxws-retail/README-source.adoc index e8375c7c1f..42396aa50b 100644 --- a/jaxws-retail/README-source.adoc +++ b/jaxws-retail/README-source.adoc @@ -40,9 +40,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1] // Build and run sections for other environments/builds -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 diff --git a/jsonp/README-source.adoc b/jsonp/README-source.adoc index 3c3a5110a6..be6fc47d56 100644 --- a/jsonp/README-source.adoc +++ b/jsonp/README-source.adoc @@ -48,9 +48,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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[] include::../shared-doc/build-and-run-the-quickstart-with-kubernetes.adoc[leveloffset=+1] diff --git a/jta-crash-rec/README-source.adoc b/jta-crash-rec/README-source.adoc index 7173e6d800..c60a72608d 100644 --- a/jta-crash-rec/README-source.adoc +++ b/jta-crash-rec/README-source.adoc @@ -187,21 +187,6 @@ HHH000431: Unable to determine H2 database version, certain features may not wor include::../shared-doc/run-integration-tests-with-server-distribution.adoc[leveloffset=+1] // Undeploy the Quickstart include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1] -// Run the Quickstart in Red Hat CodeReady Studio or Eclipse -include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1] - - -NOTE: Within {JBDSProductName}, make sure you define a server runtime environment that uses the `standalone-full.xml` configuration file. - -// Debug the Application -include::../shared-doc/debug-the-application.adoc[leveloffset=+1] - -//************************************************* -// Product Release content only -//************************************************* -ifdef::ProductRelease[] // Quickstart not compatible with OpenShift -include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] - -endif::[] \ No newline at end of file +include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/jts/README-source.adoc b/jts/README-source.adoc index c199634b61..d096dd7ce3 100644 --- a/jts/README-source.adoc +++ b/jts/README-source.adoc @@ -392,15 +392,5 @@ NOTE: For Windows, use the `__{jbossHomeName}_1__\bin\jboss-cli.bat` script. ---- -// Run the Quickstart in Red Hat CodeReady Studio or Eclipse -include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1] - -//************************************************* -// Product Release content only -//************************************************* -ifdef::ProductRelease[] - // Quickstart not compatible with OpenShift -include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] - -endif::[] +include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/kitchensink/README-source.adoc b/kitchensink/README-source.adoc index 76e5de341a..312b128133 100644 --- a/kitchensink/README-source.adoc +++ b/kitchensink/README-source.adoc @@ -145,9 +145,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level // Undeploy the Quickstart include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/logging/README-source.adoc b/logging/README-source.adoc index aaf19a4627..ffd9cf02d3 100644 --- a/logging/README-source.adoc +++ b/logging/README-source.adoc @@ -157,10 +157,7 @@ This script removes the log and file handlers from the `logging` subsystem in th include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/mail/README-source.adoc b/mail/README-source.adoc index 45cddc992b..deaf4598c1 100644 --- a/mail/README-source.adoc +++ b/mail/README-source.adoc @@ -174,30 +174,9 @@ process-state: reload-required // Restore the {productName} Standalone Server Configuration Manually include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] -// Run the Quickstart in Red Hat CodeReady Studio or Eclipse -include::../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc[leveloffset=+1] - -// Additional Red Hat CodeReady Studio instructions -* Make sure you xref:configure_an_smtp_server_on_your_local_machine[Configure an SMTP Server on Your Local Machine]. -* Make sure you configure the {productName} custom mail configuration as described above under xref:configure_the_server[Configure the {productName} Server]. Stop the server at the end of that step. -* To deploy the server project, right-click on the *{artifactId}* project and choose *Run As* –> *Run on Server*. A browser window appears that accesses the running application. -* To undeploy the project, right-click on the *{artifactId}* project and choose *Run As* –> *Maven build*. Enter `wildfly:undeploy` for the *Goals* and click *Run*. -* Make sure you xref:restore_the_server_configuration[restore the {productName} server configuration] when you have completed testing this quickstart. - -// Debug the Application -include::../shared-doc/debug-the-application.adoc[leveloffset=+1] // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] - -//************************************************* -// Product Release content only -//************************************************* -ifdef::ProductRelease[] // Quickstart not compatible with OpenShift -include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] - -endif::[] +include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/micrometer/README-source.adoc b/micrometer/README-source.adoc index a62e018e99..946c9447ee 100644 --- a/micrometer/README-source.adoc +++ b/micrometer/README-source.adoc @@ -266,9 +266,7 @@ include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset= // Restore the {productName} Standalone Server Configuration Manually include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+3] // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // Bootable JAR include::../shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc[leveloffset=+1] // OpenShift diff --git a/numberguess/README-source.adoc b/numberguess/README-source.adoc index 3284eba714..dcf74fb588 100644 --- a/numberguess/README-source.adoc +++ b/numberguess/README-source.adoc @@ -42,9 +42,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/opentelemetry-tracing/README-source.adoc b/opentelemetry-tracing/README-source.adoc index 6db8f100a7..a347b88b5e 100644 --- a/opentelemetry-tracing/README-source.adoc +++ b/opentelemetry-tracing/README-source.adoc @@ -224,9 +224,7 @@ include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset= // Restore the {productName} Standalone Server Configuration Manually include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+3] // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // Bootable JAR include::../shared-doc/build-and-run-the-quickstart-with-bootable-jar.adoc[leveloffset=+1] // OpenShift diff --git a/remote-helloworld-mdb/README-source.adoc b/remote-helloworld-mdb/README-source.adoc index b528ea22d5..88da9ceb46 100644 --- a/remote-helloworld-mdb/README-source.adoc +++ b/remote-helloworld-mdb/README-source.adoc @@ -147,11 +147,7 @@ include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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[] diff --git a/security-domain-to-domain/README-source.adoc b/security-domain-to-domain/README-source.adoc index 046b07f61b..d73e635c14 100644 --- a/security-domain-to-domain/README-source.adoc +++ b/security-domain-to-domain/README-source.adoc @@ -255,9 +255,7 @@ include::../shared-doc/restore-standalone-server-configuration.adoc[leveloffset= include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+2] // Build and run sections for other environments/builds -ifndef::ProductRelease,EAPXPRelease[] include::../shared-doc/build-and-run-the-quickstart-with-provisioned-server.adoc[leveloffset=+1] -endif::[] // Quickstart not compatible with OpenShift include::../shared-doc/openshift-incompatibility.adoc[leveloffset=+1] \ No newline at end of file diff --git a/servlet-async/README-source.adoc b/servlet-async/README-source.adoc index 9ffa3e2fb9..c5540f7418 100644 --- a/servlet-async/README-source.adoc +++ b/servlet-async/README-source.adoc @@ -46,9 +46,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/servlet-filterlistener/README-source.adoc b/servlet-filterlistener/README-source.adoc index e80ee1183a..597aa37604 100644 --- a/servlet-filterlistener/README-source.adoc +++ b/servlet-filterlistener/README-source.adoc @@ -93,9 +93,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/servlet-security/README-source.adoc b/servlet-security/README-source.adoc index 651b6604d6..30d9c27060 100644 --- a/servlet-security/README-source.adoc +++ b/servlet-security/README-source.adoc @@ -218,9 +218,7 @@ process-state: reload-required include::../shared-doc/restore-standalone-server-configuration-manual.adoc[leveloffset=+3] // Build and run sections for other environments/builds -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 diff --git a/shared-doc/debug-the-application.adoc b/shared-doc/debug-the-application.adoc deleted file mode 100644 index a08812b78d..0000000000 --- a/shared-doc/debug-the-application.adoc +++ /dev/null @@ -1,23 +0,0 @@ -[[debug_the_application]] -= Debug the Application -//****************************************************************************** -// Include this template to provide debugging information. -//****************************************************************************** - -If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it. - ----- -$ mvn dependency:sources ----- - -//// -TODO: I need to investigate whether the following version can be used across all quickstarts. - -If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them. - -[source,options="nowrap"] ----- -$ mvn dependency:sources -$ mvn dependency:resolve -Dclassifier=javadoc ----- -//// diff --git a/shared-doc/deploy-to-openshift-online.adoc b/shared-doc/deploy-to-openshift-online.adoc deleted file mode 100644 index bdda27167c..0000000000 --- a/shared-doc/deploy-to-openshift-online.adoc +++ /dev/null @@ -1,68 +0,0 @@ -[[deploy_the_quickstart_to_openshift_online]] -= Deploy the Quickstart to OpenShift Online - -Use these instructions to deploy the quickstart to {OpenShiftOnlineName}. If you do not yet have an OpenShift Online account and are interested in signing up for one, see link:{LinkOpenShiftSignup}[Choose a Plan] in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running {ProductShortName} on {OpenShiftOnlineName}, see link:{LinkOpenShiftOnlineGuide}[_{EapForOpenshiftOnlineBookName}_], also located on the Red Hat Customer Portal. - -[[create_and_deploy_the_quickstart_project]] -== Create and Deploy the Quickstart Project - -Follow these instructions to deploy this quickstart to OpenShift Online. - -. Browse to OpenShift Online console and login with your credentials. -. On the *View All Projects* or *Welcome to Project* page, click *Create Project*. -. On the *Create Project* page, enter the following information: -+ -[source,subs="+quotes,attributes+"] ----- -*Name:* {artifactId} -*Display Name* {artifactId} -*Description:* {artifactId} ----- - -. Click *Create* to create the project. -. On the *My Projects* page, choose your new *{artifactId}* and click *Browse Catalog*. -. Choose *{OpenShiftTemplateName}* and then click *Next* to view the *Information* page. -. Click *Next* to navigate to the *Configuration* page. . . Enter the following information. You can leave the remaining fields as they are. -+ -[source,subs="+quotes,attributes+"] ----- -*Add to Project:* {artifactId} -*Application Name:* {artifactId} -*Custom http Route Hostname:* (leave blank) -*Git Repository URL:* {githubRepoUrl} -*Git Reference:* {githubRepoBranch} -*Context directory:* {artifactId} ----- - -. Click the *Create* button. -. Click on the *Continue to the project overview* link. - -* You should see "Build #1 is running ..." with the console log below. -+ -[source,subs="+quotes,attributes+"] ----- -Cloning ... -Downloading ... -Building ... -Copying ... -Pushing ... ----- - -* At the end of the build, you should see "Push successful". -* Click *View Full Log* to see the entire log. - -. Click the *Overview* tab to see the `{artifactId}` deployment. -. Click on the application URL on the right side of the page to view the running application. It should be in the following pattern: -+ -[source,subs="+quotes,attributes+"] ----- -http://__APPLICATION_NAME__-__PROJECT_NAME__.__PORT__.__HOST__.openshiftapps.com ----- - -[[delete_the_quickstart_project]] -== Delete the Quickstart Project - -Follow these instructions to delete the project from OpenShift Online. - -. Go to the *View All Projects* page and select *Delete Project* from the drop down list to the right of the *{artifactId}* project. -. Type the name of the project to confirm, and then click *Delete* diff --git a/shared-doc/openshift-create-project.adoc b/shared-doc/openshift-create-project.adoc deleted file mode 100644 index aaeeb01ef6..0000000000 --- a/shared-doc/openshift-create-project.adoc +++ /dev/null @@ -1,46 +0,0 @@ - -[[prepare_openshift_for_quickstart_deployment]] -= Prepare OpenShift for Quickstart Deployment - -. Log in to your OpenShift instance using the `oc login` command. -. Create a new project for the quickstart in OpenShift. You can create a project in OpenShift using the following command. -+ -[options="nowrap",subs="attributes"] ----- -$ oc new-project {artifactId}-project ----- -+ - -Before you can import and use the OpenShift image for {xpaasproduct-shortname} , you must configure authentication to the Red Hat Container Registry. - -Create an authentication token using a registry service account to configure access to the Red Hat Container Registry. You need not use or store your Red Hat account's username and password in your OpenShift configuration when you use an authentication token. - -.Procedure - -. Follow the instructions on Red Hat Customer Portal to create an authentication token using a registry service account. -. Download the YAML file containing the OpenShift secret for the token. -+ -You can download the YAML file from the *OpenShift Secret* tab on your token's *Token Information* page. - -. Create the authentication token secret for your OpenShift project using the YAML file that you downloaded: -+ -[options="nowrap",subs="+quotes"] ----- -oc create -f __1234567_myserviceaccount-secret.yaml__ ----- -+ -. Configure the secret for your OpenShift project using the following commands, replacing the secret name below with the name of your secret created in the previous step. -+ -[options="nowrap",subs="+quotes"] ----- -oc secrets link default __1234567-myserviceaccount-pull-secret__ --for=pull -oc secrets link builder __1234567-myserviceaccount-pull-secret__ --for=pull ----- -.Additional resources - -* link:https://access.redhat.com/RegistryAuthentication#registry-service-accounts-for-shared-environments-4[Create an authentication token using a registry service account] - -* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/3.11/html/developer_guide/dev-guide-managing-images#allowing-pods-to-reference-images-from-other-secured-registries[Configuring access to secured registries] - -* link:https://access.redhat.com/RegistryAuthentication[Configuring authentication to the Red Hat Container Registry] - diff --git a/shared-doc/openshift-deploy-project.adoc b/shared-doc/openshift-deploy-project.adoc deleted file mode 100644 index 2b08601c9d..0000000000 --- a/shared-doc/openshift-deploy-project.adoc +++ /dev/null @@ -1,97 +0,0 @@ -[[deploy_eap_s2i]] -= Deploy the {ProductShortName} Source-to-Image (S2I) Quickstart to OpenShift - -.Procedure - -. Create a new OpenShift application using the {xpaasproduct-shortname} image and the quickstart's source code. Use the following command to use the `{ImagePrefixVersion}-basic-s2i` template with the JDK 8 images and the `{artifactId}` source code on GitHub. -+ -[options="nowrap",subs="+attributes"] ----- -$ oc new-app --template={ImagePrefixVersion}-basic-s2i {backslash} - -p EAP_IMAGE_NAME=jboss-{ImagePrefixVersion}-openjdk8-openshift:latest {backslash} - -p EAP_RUNTIME_IMAGE_NAME=jboss-{ImagePrefixVersion}-openjdk8-runtime-openshift:latest {backslash} - -p IMAGE_STREAM_NAMESPACE="{artifactId}-project" {backslash} - -p SOURCE_REPOSITORY_URL="{EAPQuickStartRepo}" {backslash} - -p SOURCE_REPOSITORY_REF="{EAPQuickStartRepoRef}" {backslash} -ifdef::uses-h2[] - -p ENABLE_GENERATE_DEFAULT_DATASOURCE="true" {backslash} -endif::[] - -p CONTEXT_DIR="{artifactId}" ----- -+ --- -* `--template` The template to use. -* `-p IMAGE_STREAM_NAMESPACE` The latest images streams and templates xref:import_imagestreams_templates[were imported into the project's namespace], so you must specify the namespace of where to find the image stream. This is usually the OpenShift project's name. -* `-p SOURCE_REPOSITORY_URL` The URL to the repository containing the application source code. -* `-p SOURCE_REPOSITORY_REF` The Git repository reference to use for the source code. This can be a Git branch or tag reference. -ifdef::uses-h2[] -* `-p ENABLE_GENERATE_DEFAULT_DATASOURCE` Enables the default datasource, which is required by this quickstart. -endif::[] -* `-p CONTEXT_DIR` The directory within the source repository to build. --- -+ -Alternatively, to create the quickstart application using the JDK 11 images enter the following command. -+ -[options="nowrap",subs="+attributes"] ----- -$ oc new-app --template={ImagePrefixVersion}-basic-s2i {backslash} - -p EAP_IMAGE_NAME=jboss-{ImagePrefixVersion}-openjdk11-openshift:latest \ - -p EAP_RUNTIME_IMAGE_NAME=jboss-{ImagePrefixVersion}-openjdk11-runtime-openshift:latest \ - -p IMAGE_STREAM_NAMESPACE="{artifactId}-project" {backslash} - -p SOURCE_REPOSITORY_URL="{EAPQuickStartRepo}" {backslash} - -p SOURCE_REPOSITORY_REF="{EAPQuickStartRepoRef}" {backslash} -ifdef::uses-h2[] - -p ENABLE_GENERATE_DEFAULT_DATASOURCE="true" {backslash} -endif::[] - -p CONTEXT_DIR="{artifactId}" ----- -+ --- -* `--template` The template to use. -* `-p IMAGE_STREAM_NAMESPACE` The latest images streams and templates xref:import_imagestreams_templates[were imported into the project's namespace], so you must specify the namespace of where to find the image stream. This is usually the OpenShift project's name. -* `-p SOURCE_REPOSITORY_URL` The URL to the repository containing the application source code. -* `-p SOURCE_REPOSITORY_REF` The Git repository reference to use for the source code. This can be a Git branch or tag reference. -ifdef::uses-h2[] -* `-p ENABLE_GENERATE_DEFAULT_DATASOURCE` Enables the default datasource, which is required by this quickstart. -endif::[] -* `-p CONTEXT_DIR` The directory within the source repository to build. --- - -+ -NOTE: A template can specify default values for many template parameters, and you might have to override some, or all, of the defaults. To see template information, including a list of parameters and any default values, use the command `oc describe template __TEMPLATE_NAME__`. - -+ -TIP: It is possible to trim down the {xpaasproduct-shortname} image that will be used to run this quickstart. To do so, please add the `-p GALLEON_PROVISION_LAYERS=` argument when creating the new application. Please refer to the JBoss EAP documentation for the list of supported galleon layers. - -. Retrieve the name of the build configuration. -+ -[options="nowrap"] ----- -$ oc get bc -o name ----- -+ -. Use the name of the build configurations from the previous step to view the Maven progress of the builds. -+ -[options="nowrap",subs="+quotes"] ----- -$ oc logs -f bc/${APPLICATION_NAME}-build-artifacts - -… -Push successful -$ oc logs -f bc/${APPLICATION_NAME} -… -Push successful ----- -+ -For example, for the previously created application, the following command shows the progress of the Maven builds. -+ -[options="nowrap",subs="+attributes"] ----- -$ oc logs -f bc/{ImagePrefixVersion}-basic-app-build-artifacts - -… -Push successful -$ oc logs -f bc/{ImagePrefixVersion}-basic-app -… -Push successful ----- \ No newline at end of file diff --git a/shared-doc/openshift-getting-started-overview.adoc b/shared-doc/openshift-getting-started-overview.adoc deleted file mode 100644 index 03e2186b96..0000000000 --- a/shared-doc/openshift-getting-started-overview.adoc +++ /dev/null @@ -1,8 +0,0 @@ -[[getting_started_with_openshift_overview]] -= Getting Started with {xpaasproduct-shortname} - -Each quickstart `README{outfilesuffix}` file contains the basic instructions to build and deploy the quickstart to {xpaasproduct-shortname} or {xpaasproductOpenShiftOnline-shortname}. - -See link:{LinkOpenShiftGuide}[_{EapForOpenshiftBookName}_] for more detailed information about building and running applications on {xpaasproduct-shortname}. - -See link:{LinkOpenShiftOnlineGuide}[_{EapForOpenshiftOnlineBookName}_] for more detailed information about building and running applications on {xpaasproductOpenShiftOnline-shortname}. diff --git a/shared-doc/openshift-getting-started.adoc b/shared-doc/openshift-getting-started.adoc deleted file mode 100644 index 64c92ee848..0000000000 --- a/shared-doc/openshift-getting-started.adoc +++ /dev/null @@ -1,8 +0,0 @@ -[[getting_started_with_openshift]] -= Getting Started with {xpaasproduct-shortname} - -This document contains the basic instructions to build and deploy this quickstart to {xpaasproduct-shortname} or {xpaasproductOpenShiftOnline-shortname}. - -See link:{LinkOpenShiftGuide}[_{EapForOpenshiftBookName}_] for more detailed information about building and running applications on {xpaasproduct-shortname}. - -See link:{LinkOpenShiftOnlineGuide}[_{EapForOpenshiftOnlineBookName}_] for more detailed information about building and running applications on {xpaasproductOpenShiftOnline-shortname}. diff --git a/shared-doc/openshift-import-imagestreams-templates.adoc b/shared-doc/openshift-import-imagestreams-templates.adoc deleted file mode 100644 index eaeae62aab..0000000000 --- a/shared-doc/openshift-import-imagestreams-templates.adoc +++ /dev/null @@ -1,71 +0,0 @@ - -[[import_imagestreams_templates]] -= Import the Latest {xpaasproduct-shortname} Imagestreams and Templates - -[IMPORTANT] -==== -If you are building and deploying this quickstart on {xpaasproduct-shortname}, you must configure authentication to the {ContainerRegistryName} before you import the image streams and templates into your namespace. link:{LinkOpenShiftGuide}#container_registry_authentication[_{EapForOpenshiftBookName}_] provides an example of one way to configure authentication to the registry. For additional information, see link:https://access.redhat.com/RegistryAuthentication[Red Hat Container Registry Authentication] on the Red Hat Customer Portal. - -Configuration of authentication to the registry is not necessary if you are building and deploying this quickstart on {xpaasproductOpenShiftOnline-shortname}. -==== - -.Procedure - -. Use the following commands to import the latest JDK 8 and JDK 11 image streams and templates for the OpenShift image for {xpaasproduct-shortname}, into your OpenShift project's namespace. - -.. Import JDK 8 image streams: -+ -[options="nowrap",subs="+attributes"] ----- -oc replace --force -f {ImageandTemplateImportURL}{ImagePrefixVersion}-openjdk8-image-stream.json ----- -+ -This command imports the following imagestreams: - -* The JDK 8 builder imagestream: jboss-{ImagePrefixVersion}-openjdk8-openshift -* The JDK 8 runtime imagestream: jboss-{ImagePrefixVersion}-openjdk8-runtime-openshift -+ -.. Import JDK 11 image stream: -+ -[options="nowrap",subs="+attributes"] ----- -oc replace --force -f {ImageandTemplateImportURL}{ImagePrefixVersion}-openjdk11-image-stream.json ----- -+ -This command imports the following imagestreams: - -* The JDK 11 builder imagestream: jboss-{ImagePrefixVersion}-openjdk11-openshift -* The JDK 11 runtime imagestream: jboss-{ImagePrefixVersion}-openjdk11-runtime-openshift -+ -.. Import the JDK 8 and JDK 11 templates: -+ -[options="nowrap",subs="+attributes"] ----- -for resource in \ - {ImagePrefixVersion}-amq-persistent-s2i.json \ - {ImagePrefixVersion}-amq-s2i.json \ - {ImagePrefixVersion}-basic-s2i.json \ - {ImagePrefixVersion}-https-s2i.json \ - {ImagePrefixVersion}-sso-s2i.json \ - {ImagePrefixVersion}-starter-s2i.json \ - {ImagePrefixVersion}-third-party-db-s2i.json \ - {ImagePrefixVersion}-tx-recovery-s2i.json -do - oc replace --force -f \ -{ImageandTemplateImportURL}templates/${resource} -done ----- - -[NOTE] -==== -The {ProductShortName} image streams and templates imported using the above command are only available within that OpenShift project. - -If you have administrative access to the general `openshift` namespace and want the image streams and templates to be accessible by all projects, add `-n openshift` to the `oc replace` line of the command. For example: - -[options="nowrap"] ----- -... -oc replace -n openshift --force -f \ -... ----- -==== \ No newline at end of file diff --git a/shared-doc/openshift-post-deployment-tasks.adoc b/shared-doc/openshift-post-deployment-tasks.adoc deleted file mode 100644 index 8d9bf22745..0000000000 --- a/shared-doc/openshift-post-deployment-tasks.adoc +++ /dev/null @@ -1,61 +0,0 @@ -[[post_deployment]] -= OpenShift Post Deployment Tasks - -Depending on your application, you might need to complete some tasks after your OpenShift application has been built and deployed. - -Examples of post-deployment tasks include the following: - -* Exposing a service so that the application is viewable from outside of OpenShift. -* Scaling your application to a specific number of replicas. - -.Procedure - -. Get the service name of your application using the following command. -+ -[options="nowrap",subs="+quotes"] ----- -$ oc get service ----- - -. *Optional*: Expose the main service as a route so you can access your application from outside of OpenShift. For example, for the previously created application, use the following command to expose the required service and port. -+ -[NOTE] -==== -If you used a template to create the application, the route might already exist. If it does, continue on to the next step. -==== - -+ -[options="nowrap",subs="+attributes"] ----- -$ oc expose service/{ImagePrefixVersion}-basic-app --port=8080 ----- -+ - -. Get the URL of the route. -+ -[options="nowrap"] ----- -$ oc get route ----- -. Access the application in your web browser using the URL. The URL is the value of the `HOST/PORT` field from previous command's output. -+ -[NOTE] -==== - -For example, to interact with this quickstart , the root of its application URLs should be `https://_HOST_PORT_Value_/`. -==== -+ - -. Optionally, you can scale up the application instance by running the following command. This command increases the number of replicas to 3. -+ -[options="nowrap",subs="+quotes"] ----- -$ oc scale deploymentconfig __DEPLOYMENTCONFIG_NAME__ --replicas=3 ----- -+ -For example, for this` quickstart, use the following command to scale up the application. -+ -[options="nowrap",subs="+attributes"] ----- -$ oc scale deploymentconfig/{ImagePrefixVersion}-basic-app --replicas=3 ----- diff --git a/shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc b/shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc deleted file mode 100644 index b99e67ab08..0000000000 --- a/shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[[run_the_quickstart_in_redhat_codeready_studio_or_eclipse]] -= Run the Quickstart in {JBDSProductName} or Eclipse -//****************************************************************************** -// Include this template to provide instructions to run the quickstart -// in Red Hat CodeReady Studio. -// -// If the quickstart is not supported, create the `jbds-not-supported` attribute. -//****************************************************************************** -ifdef::jbds-not-supported[] -This quickstart is not supported in {JBDSProductName}. -endif::jbds-not-supported[] - -ifndef::jbds-not-supported[] -You can also start the server and deploy the quickstarts, or run any tests in {JBDSProductName} or from Eclipse using JBoss tools. For general information about how to import a quickstart, add a {productName} server, and build and deploy a quickstart, see link:{useEclipseUrl}[Use {JBDSProductName} or Eclipse to Run the Quickstarts]. -endif::jbds-not-supported[] - -// Add additional instructions specific to running this quickstart in an IDE here. diff --git a/spring-resteasy/README-source.adoc b/spring-resteasy/README-source.adoc index c55266b76c..78617653ca 100644 --- a/spring-resteasy/README-source.adoc +++ b/spring-resteasy/README-source.adoc @@ -72,9 +72,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+1] // Build and run sections for other environments/builds -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 diff --git a/tasks-jsf/README-source.adoc b/tasks-jsf/README-source.adoc index 979493c391..f30a05d71b 100644 --- a/tasks-jsf/README-source.adoc +++ b/tasks-jsf/README-source.adoc @@ -66,9 +66,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/temperature-converter/README-source.adoc b/temperature-converter/README-source.adoc index 058dc16c68..b4b7d843c7 100644 --- a/temperature-converter/README-source.adoc +++ b/temperature-converter/README-source.adoc @@ -56,9 +56,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/thread-racing/README-source.adoc b/thread-racing/README-source.adoc index 4e78af879e..aa79158a89 100644 --- a/thread-racing/README-source.adoc +++ b/thread-racing/README-source.adoc @@ -69,9 +69,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/websocket-endpoint/README-source.adoc b/websocket-endpoint/README-source.adoc index 298d2dbd50..5da0432edb 100644 --- a/websocket-endpoint/README-source.adoc +++ b/websocket-endpoint/README-source.adoc @@ -54,9 +54,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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 diff --git a/websocket-hello/README-source.adoc b/websocket-hello/README-source.adoc index 692e1a4e4e..2ca5d5566d 100644 --- a/websocket-hello/README-source.adoc +++ b/websocket-hello/README-source.adoc @@ -60,9 +60,7 @@ include::../shared-doc/run-integration-tests-with-server-distribution.adoc[level include::../shared-doc/undeploy-the-quickstart.adoc[leveloffset=+2] // Build and run sections for other environments/builds -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