From 4b1b402432451d36ba80ae0e107e59ac18d5ce42 Mon Sep 17 00:00:00 2001 From: Jonathan Dowland Date: Wed, 18 Mar 2020 10:40:52 +0000 Subject: [PATCH] Remove autogenerated README.adoc files As mentioned in #370, we need a different approach for docs. These files get stale as the modules are updated but they are not regenerated, and they make refactoring work very difficult. We can either come up with a new scheme or re-introduce these later on. Signed-off-by: Jonathan Dowland --- jboss/container/hawkular/api/README.adoc | 66 --------------- jboss/container/hawkular/bash/README.adoc | 69 ---------------- jboss/container/java/jvm/api/README.adoc | 70 ---------------- jboss/container/java/jvm/bash/README.adoc | 58 -------------- jboss/container/java/proxy/bash/README.adoc | 56 ------------- jboss/container/java/run/bash/README.adoc | 65 --------------- jboss/container/jws/s2i/bash/README.adoc | 59 -------------- jboss/container/maven/35/35scl/README.adoc | 59 -------------- jboss/container/maven/35/default/README.adoc | 59 -------------- jboss/container/maven/36/36scl/README.adoc | 59 -------------- jboss/container/maven/36/default/README.adoc | 59 -------------- jboss/container/maven/api/README.adoc | 80 ------------------- .../maven/default/bash/36/README.adoc | 62 -------------- .../maven/default/bash/default/README.adoc | 62 -------------- jboss/container/maven/s2i/api/README.adoc | 60 -------------- jboss/container/maven/s2i/bash/README.adoc | 62 -------------- jboss/container/openjdk/base/README.adoc | 55 ------------- jboss/container/openjdk/jdk/10/README.adoc | 67 ---------------- jboss/container/openjdk/jdk/11/README.adoc | 67 ---------------- jboss/container/openjdk/jdk/8/README.adoc | 68 ---------------- jboss/container/proxy/api/README.adoc | 58 -------------- jboss/container/s2i/core/api/README.adoc | 77 ------------------ jboss/container/s2i/core/bash/README.adoc | 56 ------------- jboss/container/user/README.adoc | 59 -------------- jboss/container/util/logging/bash/README.adoc | 54 ------------- 25 files changed, 1566 deletions(-) delete mode 100644 jboss/container/hawkular/api/README.adoc delete mode 100644 jboss/container/hawkular/bash/README.adoc delete mode 100644 jboss/container/java/jvm/api/README.adoc delete mode 100644 jboss/container/java/jvm/bash/README.adoc delete mode 100644 jboss/container/java/proxy/bash/README.adoc delete mode 100644 jboss/container/java/run/bash/README.adoc delete mode 100644 jboss/container/jws/s2i/bash/README.adoc delete mode 100644 jboss/container/maven/35/35scl/README.adoc delete mode 100644 jboss/container/maven/35/default/README.adoc delete mode 100644 jboss/container/maven/36/36scl/README.adoc delete mode 100644 jboss/container/maven/36/default/README.adoc delete mode 100644 jboss/container/maven/api/README.adoc delete mode 100644 jboss/container/maven/default/bash/36/README.adoc delete mode 100644 jboss/container/maven/default/bash/default/README.adoc delete mode 100644 jboss/container/maven/s2i/api/README.adoc delete mode 100644 jboss/container/maven/s2i/bash/README.adoc delete mode 100644 jboss/container/openjdk/base/README.adoc delete mode 100644 jboss/container/openjdk/jdk/10/README.adoc delete mode 100644 jboss/container/openjdk/jdk/11/README.adoc delete mode 100644 jboss/container/openjdk/jdk/8/README.adoc delete mode 100644 jboss/container/proxy/api/README.adoc delete mode 100644 jboss/container/s2i/core/api/README.adoc delete mode 100644 jboss/container/s2i/core/bash/README.adoc delete mode 100644 jboss/container/user/README.adoc delete mode 100644 jboss/container/util/logging/bash/README.adoc diff --git a/jboss/container/hawkular/api/README.adoc b/jboss/container/hawkular/api/README.adoc deleted file mode 100644 index 524ea5d1..00000000 --- a/jboss/container/hawkular/api/README.adoc +++ /dev/null @@ -1,66 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.hawkular.api] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Defines environment variables used for configuring Hawkular. Modules providing support for configuring Hawkular should use the variables listed within this module to configure Hawkular appropriately. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|AB_HAWKULAR_AGENT_CONFIG |The location of the Hawkular agent configuration file, in yaml. Defaults to /opt/jboss/container/hawkular/etc/hawkular-javaagent-config.yaml. |/opt/eap/standalone/configuration/hawkular-javaagent-config.yaml -|AB_HAWKULAR_AGENT_OPTS |Additional options to add to the -javaagent parameter, e.g. delay=10. | -|AB_HAWKULAR_REST_FEED_ID |The feed-id for this agent. Must be globally unique to the Hawkular REST service. |autogenerate -|AB_HAWKULAR_REST_KEY_MANAGER_ALGORITHM |The key manager algorithm to use when verifying the identity of the Hawkular REST service. Defaults to the JVM default. |X509 -|AB_HAWKULAR_REST_KEYSTORE |The name of the keystore JKS file used to verify the identity of the Hawkular REST service when using https. |keystore.jks -|AB_HAWKULAR_REST_KEYSTORE_DIR |The location of the keystore JKS file used to verify the identity of the Hawkular REST service when using https. |/etc/hawkular-agent-volume -|AB_HAWKULAR_REST_KEYSTORE_PASSWORD |The password for the keystore JKS file used to verify the identity of the Hawkular REST service when using https. |tru5tM3 -|AB_HAWKULAR_REST_KEYSTORE_TYPE |The type of the keystore file used to verify the identity of the Hawkular REST service when using https. Defaults to the JVM default, jks. |jks -|AB_HAWKULAR_REST_PASSWORD |The password used for basic authentication with the Hawkular REST service. |QSandC -|AB_HAWKULAR_REST_SSL_PROTOCOL |The SSL protocol to use when verifying the identity of the Hawkular REST service. Defaults to TLSv1. |TLSv1 -|AB_HAWKULAR_REST_TENANT_ID |The tenant-id for this agent. |hawkular -|AB_HAWKULAR_REST_TRUST_MANAGER_ALGORITHM |The trust manager algorithm to use when verifying the identity of the Hawkular REST service. Defaults to the JVM default. |X509 -|AB_HAWKULAR_REST_URL |The url of the Hawkular REST service to which the Hawkular agent will emit metrics. This must be set to configure the Hawkular agent. |http://myhawkularservice.example.com/hawkular -|AB_HAWKULAR_REST_USER |The username used for basic authentication with the Hawkular REST service. |hawkW1nd -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/hawkular/bash/README.adoc b/jboss/container/hawkular/bash/README.adoc deleted file mode 100644 index a79647d6..00000000 --- a/jboss/container/hawkular/bash/README.adoc +++ /dev/null @@ -1,69 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.hawkular.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Provides support for configuring Hawkular. Basic usage is opts=$(source $JBOSS_CONTAINER_HAWKULAR_MODULE/hawkular-opts; get_hawkular_opts) - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_HAWKULAR_MODULE |/opt/jboss/container/hawkular -|======================================================================= - -== Resources - -The following resources will be included through this module: -|======================================================================= -|Name |Location |Checksum -|hawkular-javaagent-1.0.1.Final-redhat-2-shaded.jar -|./hawkular-javaagent-1.0.1.Final-redhat-2-shaded.jar -a| -md5:: f97f623e5b614a7b6d1eb5ff7158027b - -sha1:: - -sha256:: - -|======================================================================= - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../jboss/container/hawkular/api/README.adoc[jboss.container.hawkular.api] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/java/jvm/api/README.adoc b/jboss/container/java/jvm/api/README.adoc deleted file mode 100644 index 9a62e7ea..00000000 --- a/jboss/container/java/jvm/api/README.adoc +++ /dev/null @@ -1,70 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.java.jvm.api] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Defines environment variables used for configuring Java JVM, e.g. GC settings, etc. Modules providing support for configuring JVM settings should use the variables listed within this module to configure the JVM appropriately. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|CONTAINER_CORE_LIMIT |A calculated core limit as described in https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. |2 -|CONTAINER_MAX_MEMORY |Memory limit given to the container. |1024 -|GC_ADAPTIVE_SIZE_POLICY_WEIGHT |The weighting given to the current GC time versus previous GC times. |90 -|GC_CONTAINER_OPTIONS |specify Java GC to use. The value of this variable should contain the necessary JRE command-line options to specify the required GC, which will override the default of `-XX:+UseParallelOldGC`. |-XX:+UseG1GC -|GC_MAX_HEAP_FREE_RATIO |Maximum percentage of heap free after GC to avoid shrinking. |40 -|GC_METASPACE_SIZE |The initial metaspace size. |20 -|GC_MAX_METASPACE_SIZE |The maximum metaspace size. |100 -|GC_MIN_HEAP_FREE_RATIO |Minimum percentage of heap free after GC to avoid expansion. |20 -|GC_TIME_RATIO |Specifies the ratio of the time spent outside the garbage collection (for example, the time spent for application execution) to the time spent in the garbage collection. |4 -|JAVA_DEBUG |If set remote debugging will be switched on. **Disabled by default.** |true -|JAVA_DEBUG_PORT |Port used for remote debugging. Defaults to *5005*. |8787 -|JAVA_DIAGNOSTICS |Set this to get some diagnostics information to standard output when things are happening. **Disabled by default.** |true -|JAVA_MAX_MEM_RATIO |Is used when no `-Xmx` option is given in **JAVA_OPTS**. This is used to calculate a default maximal heap memory based on a containers restriction. If used in a container without any memory constraints for the container then this option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio of the container available memory as set here. The default is `50` which means 50% of the available memory is used as an upper boundary. You can skip this mechanism by setting this value to `0` in which case no `-Xmx` option is added. |40 -|JAVA_INITIAL_MEM_RATIO |Is used when no `-Xms` option is given in **JAVA_OPTS**. This is used to calculate a default initial heap memory based on the maximum heap memory. If used in a container without any memory constraints for the container then this option has no effect. If there is a memory constraint then `-Xms` is set to a ratio of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` is used as the initial heap size. You can skip this mechanism by setting this value to `0` in which case no `-Xms` option is added. |25 -|JAVA_MAX_INITIAL_MEM |Is used when no `-Xms` option is given in **JAVA_OPTS**. This is used to calculate the maximum value of the initial heap memory. If used in a container without any memory constraints for the container then this option has no effect. If there is a memory constraint then `-Xms` is limited to the value set here. The default is 4096Mb which means the calculated value of `-Xms` never will be greater than 4096Mb. The value of this variable is expressed in MB. |4096 -|JAVA_OPTIONS |JVM options passed to the `java` command. Use **JAVA_OPTS**. |-verbose:class -|JAVA_OPTS |JVM options passed to the `java` command. |-verbose:class -|JAVA_OPTS_APPEND |User specified Java options to be appended to generated options in JAVA_OPTS. |-Dsome.property=foo -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/java/jvm/bash/README.adoc b/jboss/container/java/jvm/bash/README.adoc deleted file mode 100644 index 788e9d2c..00000000 --- a/jboss/container/java/jvm/bash/README.adoc +++ /dev/null @@ -1,58 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.java.jvm.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Provides support for configuring Java JVM, e.g. GC settings, etc. Basic usage is opts=$($JBOSS_CONTAINER_JAVA_JVM_MODULE/java-default-options) - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_JAVA_JVM_MODULE |/opt/jboss/container/java/jvm -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/java/jvm/api/README.adoc[jboss.container.java.jvm.api] - -link:../../../../../jboss/container/java/proxy/bash/README.adoc[jboss.container.java.proxy.bash] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/java/proxy/bash/README.adoc b/jboss/container/java/proxy/bash/README.adoc deleted file mode 100644 index d2137949..00000000 --- a/jboss/container/java/proxy/bash/README.adoc +++ /dev/null @@ -1,56 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.java.proxy.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Provides support configuring proxy settings in Java. Basic usage is opts=$(source $JBOSS_CONTAINER_JAVA_PROXY_MODULE; proxy_options) - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_JAVA_PROXY_MODULE |/opt/jboss/container/java/proxy -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/proxy/api/README.adoc[jboss.container.proxy.api] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/java/run/bash/README.adoc b/jboss/container/java/run/bash/README.adoc deleted file mode 100644 index 78bc1e2e..00000000 --- a/jboss/container/java/run/bash/README.adoc +++ /dev/null @@ -1,65 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.java.run.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Provides support for running Java applications. Basic usage is $JBOSS_CONTAINER_JAVA_RUN_MODULE/run-java.sh. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|JAVA_APP_DIR |^ The directory where the application resides. All paths in your application are relative to this directory. |myapplication/ -|JAVA_ARGS |Arguments passed to the `java` application. | -|JAVA_CLASSPATH |^ The classpath to use. If not given, the startup script checks for a file `**JAVA_APP_DIR/classpath**` and use its content literally as classpath. If this file doesn't exists all jars in the app dir are added (`classes:**JAVA_APP_DIR/***`). | -|JAVA_DATA_DIR |^ The location of the directory which should be used by the application for reading/writing application data. Users should override the default if their application should use a different directory, e.g. if a persistent volume is used to persist data across restarts. |/var/cache/application -|JAVA_LIB_DIR |^ Directory holding the Java jar files as well an optional `classpath` file which holds the classpath. Either as a single line classpath (colon separated) or with jar files listed line-by-line. If not set **JAVA_LIB_DIR** is the same as **JAVA_APP_DIR**. | -|JAVA_MAIN_CLASS |^ A main class to use as argument for `java`. When this environment variable is given, all jar files in **JAVA_APP_DIR** are added to the classpath as well as **JAVA_LIB_DIR**. |com.example.MainClass -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JAVA_DATA_DIR |/deployments/data -|JBOSS_CONTAINER_JAVA_RUN_MODULE |/opt/jboss/container/java/run -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/java/jvm/bash/README.adoc[jboss.container.java.jvm.bash] - -link:../../../../../jboss/container/util/logging/bash/README.adoc[jboss.container.util.logging.bash] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/jws/s2i/bash/README.adoc b/jboss/container/jws/s2i/bash/README.adoc deleted file mode 100644 index 5e18d30c..00000000 --- a/jboss/container/jws/s2i/bash/README.adoc +++ /dev/null @@ -1,59 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.jws.s2i.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -Customization of common Maven S2I for JWS S2I images. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_JWS_S2I_MODULE |/opt/jboss/container/jws/s2i -|S2I_SOURCE_DEPLOYMENTS_FILTER |*.war -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/maven/s2i/bash/README.adoc[jboss.container.maven.s2i.bash] - -link:../../../../../jboss/container/util/logging/bash/README.adoc[jboss.container.util.logging.bash] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/35/35scl/README.adoc b/jboss/container/maven/35/35scl/README.adoc deleted file mode 100644 index ae83aa74..00000000 --- a/jboss/container/maven/35/35scl/README.adoc +++ /dev/null @@ -1,59 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.35.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -Provides Maven v3.5 capabilities to an image. - -toc::[] - -== Labels - -The following labels will be defined on the image: - -io.fabric8.s2i.version.maven:: 3.5 - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_MAVEN_35_MODULE |/opt/jboss/container/maven/35/ -|MAVEN_VERSION |3.5 -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages - -The following RPMs will be installed by this module: - -* rh-maven35 - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/35/default/README.adoc b/jboss/container/maven/35/default/README.adoc deleted file mode 100644 index ae83aa74..00000000 --- a/jboss/container/maven/35/default/README.adoc +++ /dev/null @@ -1,59 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.35.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -Provides Maven v3.5 capabilities to an image. - -toc::[] - -== Labels - -The following labels will be defined on the image: - -io.fabric8.s2i.version.maven:: 3.5 - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_MAVEN_35_MODULE |/opt/jboss/container/maven/35/ -|MAVEN_VERSION |3.5 -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages - -The following RPMs will be installed by this module: - -* rh-maven35 - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/36/36scl/README.adoc b/jboss/container/maven/36/36scl/README.adoc deleted file mode 100644 index 278d4f25..00000000 --- a/jboss/container/maven/36/36scl/README.adoc +++ /dev/null @@ -1,59 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.36.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -Provides Maven v3.6 capabilities to an image via SCL. - -toc::[] - -== Labels - -The following labels will be defined on the image: - -io.fabric8.s2i.version.maven:: 3.6 - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_MAVEN_36_MODULE |/opt/jboss/container/maven/36/ -|MAVEN_VERSION |3.6 -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages - -The following RPMs will be installed by this module: - -* rh-maven36 - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/36/default/README.adoc b/jboss/container/maven/36/default/README.adoc deleted file mode 100644 index b14a981a..00000000 --- a/jboss/container/maven/36/default/README.adoc +++ /dev/null @@ -1,59 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.36.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -Provides Maven v3.6 capabilities to an image. - -toc::[] - -== Labels - -The following labels will be defined on the image: - -io.fabric8.s2i.version.maven:: 3.6 - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_MAVEN_36_MODULE |/opt/jboss/container/maven/36/ -|MAVEN_VERSION |3.6 -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages - -The following RPMs will be installed by this module: - -* maven - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/api/README.adoc b/jboss/container/maven/api/README.adoc deleted file mode 100644 index bd6271dd..00000000 --- a/jboss/container/maven/api/README.adoc +++ /dev/null @@ -1,80 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.api] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Defines environment variables used for configuring Maven. Modules providing support for configuring Maven should use the variables listed within this module to configure Maven appropriately. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|MAVEN_ARGS |Arguments to use when calling Maven, replacing the default `package hawt-app:build -DskipTests -e`. Please be sure to run the `hawt-app:build` goal (when not already bound to the `package` execution phase), otherwise the startup scripts won't work. |-e -Popenshift -DskipTests -Dcom.redhat.xpaas.repo.redhatga package -|MAVEN_ARGS_APPEND |Additional Maven arguments. |-X -am -pl -|MAVEN_CLEAR_REPO |If set then the Maven repository is removed after the artifact is built. This is useful for keeping the created application image small, but prevents *incremental* builds. Will be overridden by **S2I_ENABLE_INCREMENTAL_BUILDS**. Defaults to *false*. | -|MAVEN_LOCAL_REPO |Directory to use as the local Maven repository. |/home/jboss/.m2/repository -|MAVEN_MIRROR_URL |The base URL of a mirror used for retrieving artifacts. |http://10.0.0.1:8080/repository/internal/ -|MAVEN_MIRRORS |If set, multi-mirror support is enabled, and other MAVEN_MIRROR_* variables will be prefixed. For example: DEV_ONE_MAVEN_MIRROR_URL and QE_TWO_MAVEN_MIRROR_URL |dev-one,qe-two -|MAVEN_REPO_LOCAL |^ **DEPRECATED, use MAVEN_LOCAL_REPO** Directory to use as the local Maven repository. |/home/jboss/.m2 -|MAVEN_REPOS |If set, multi-repo support is enabled, and other MAVEN_REPO_* variables will be prefixed. For example: DEV_ONE_MAVEN_REPO_URL and QE_TWO_MAVEN_REPO_URL |dev-one,qe-two -|MAVEN_SETTINGS_XML |Location of custom Maven settings.xml file to use. |/home/jboss/.m2/settings.xml -|prefix_MAVEN_MIRROR_ID |ID to be used for the specified mirror. If ommitted, a unique ID will be generated. |internal-mirror -|prefix_MAVEN_MIRROR_OF |Repository IDs mirrored by this entry. Defaults to external:* | -|prefix_MAVEN_MIRROR_URL |The URL of the mirror. |http://10.0.0.1:8080/repository/internal -|prefix_MAVEN_REPO_HOST |Maven repository host (if not using fully defined url; will fallback to service) |repo.example.com -|prefix_MAVEN_REPO_ID |Maven repository id |my-repo -|prefix_MAVEN_REPO_LAYOUT |Maven repository layout |default -|prefix_MAVEN_REPO_PASSPHRASE |Maven repository passphrase |maven1! -|prefix_MAVEN_REPO_PASSWORD |Maven repository password |maven1! -|prefix_MAVEN_REPO_PATH |Maven repository path (if not using fully defined url; will fallback to service) |/maven2/ -|prefix_MAVEN_REPO_PORT |Maven repository port (if not using fully defined url; will fallback to service) |8080 -|prefix_MAVEN_REPO_PRIVATE_KEY |Maven repository private key |${user.home}/.ssh/id_dsa -|prefix_MAVEN_REPO_PROTOCOL |Maven repository protocol (if not using fully defined url; will fallback to service) |http -|prefix_MAVEN_REPO_RELEASES_ENABLED |Maven repository releases enabled |true -|prefix_MAVEN_REPO_RELEASES_UPDATE_POLICY |Maven repository releases update policy |always -|prefix_MAVEN_REPO_SERVICE |Maven repository service to lookup if prefix_MAVEN_REPO_URL not specified |buscentr-myapp -|prefix_MAVEN_REPO_SNAPSHOTS_ENABLED |Maven repository snapshots enabled |true -|prefix_MAVEN_REPO_SNAPSHOTS_UPDATE_POLICY |Maven repository snapshots update policy |always -|prefix_MAVEN_REPO_URL |Maven repository url (fully defined) |http://repo.example.com:8080/maven2/ -|prefix_MAVEN_REPO_USERNAME |Maven repository username |mavenUser -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/default/bash/36/README.adoc b/jboss/container/maven/default/bash/36/README.adoc deleted file mode 100644 index 69ff6712..00000000 --- a/jboss/container/maven/default/bash/36/README.adoc +++ /dev/null @@ -1,62 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.default.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Provides basic Maven capabilities to an image, with support for configuring settings.xml using the environment variables described in jboss.container.maven.api. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_MAVEN_DEFAULT_MODULE |/opt/jboss/container/maven/default/ -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/java/jvm/bash/README.adoc[jboss.container.java.jvm.bash] - -link:../../../../../jboss/container/maven/36/bash/README.adoc[jboss.container.maven.36.bash] - -link:../../../../../jboss/container/maven/api/README.adoc[jboss.container.maven.api] - -link:../../../../../jboss/container/util/logging/bash/README.adoc[jboss.container.util.logging.bash] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/default/bash/default/README.adoc b/jboss/container/maven/default/bash/default/README.adoc deleted file mode 100644 index 88cb9837..00000000 --- a/jboss/container/maven/default/bash/default/README.adoc +++ /dev/null @@ -1,62 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.default.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Provides basic Maven capabilities to an image, with support for configuring settings.xml using the environment variables described in jboss.container.maven.api. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_MAVEN_DEFAULT_MODULE |/opt/jboss/container/maven/default/ -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/java/jvm/bash/README.adoc[jboss.container.java.jvm.bash] - -link:../../../../../jboss/container/maven/35/bash/README.adoc[jboss.container.maven.35.bash] - -link:../../../../../jboss/container/maven/api/README.adoc[jboss.container.maven.api] - -link:../../../../../jboss/container/util/logging/bash/README.adoc[jboss.container.util.logging.bash] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/s2i/api/README.adoc b/jboss/container/maven/s2i/api/README.adoc deleted file mode 100644 index a91ceb57..00000000 --- a/jboss/container/maven/s2i/api/README.adoc +++ /dev/null @@ -1,60 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.s2i.api] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Defines environment variables and labels used by Maven s2i. Modules implementing Maven S2I should use these variables accordingly. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|ARTIFACT_DIR |Deprecated by **MAVEN_S2I_ARTIFACT_DIRS**. | -|MAVEN_S2I_ARTIFACT_DIRS |Relative paths of source directories to scan for build output, which will be copied to $DEPLOY_DIR. Defaults to **target** - |target -|MAVEN_S2I_GOALS |Space separated list of goals to be executed with maven build, e.g. mvn $MAVEN_S2I_GOALS. Defaults to **package** - |package install -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/s2i/core/api/README.adoc[jboss.container.s2i.core.api] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/maven/s2i/bash/README.adoc b/jboss/container/maven/s2i/bash/README.adoc deleted file mode 100644 index 4ffdaa31..00000000 --- a/jboss/container/maven/s2i/bash/README.adoc +++ /dev/null @@ -1,62 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.maven.s2i.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -Provides s2i capabilities built around Maven. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_MAVEN_S2I_MODULE |/opt/jboss/container/maven/s2i -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/maven/default/bash/README.adoc[jboss.container.maven.default.bash] - -link:../../../../../jboss/container/maven/s2i/api/README.adoc[jboss.container.maven.s2i.api] - -link:../../../../../jboss/container/s2i/core/bash/README.adoc[jboss.container.s2i.core.bash] - -link:../../../../../jboss/container/util/logging/bash/README.adoc[jboss.container.util.logging.bash] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/openjdk/base/README.adoc b/jboss/container/openjdk/base/README.adoc deleted file mode 100644 index 5f872eb5..00000000 --- a/jboss/container/openjdk/base/README.adoc +++ /dev/null @@ -1,55 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.openjdk.base] -:toc: -:toc-placement!: -:toclevels: 5 - -Provides image configuration common to all JBoss Java based images. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../jboss/container/user/README.adoc[jboss.container.user] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/openjdk/jdk/10/README.adoc b/jboss/container/openjdk/jdk/10/README.adoc deleted file mode 100644 index 9da555fb..00000000 --- a/jboss/container/openjdk/jdk/10/README.adoc +++ /dev/null @@ -1,67 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.openjdk.jdk] -:toc: -:toc-placement!: -:toclevels: 5 - -Installs the JDK for OpenJDK 10. - -toc::[] - -== Labels - -The following labels will be defined on the image: - -org.jboss.container.product:: openjdk - -org.jboss.container.product.openjdk.version:: 10 - -org.jboss.container.product.version:: 10 - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JAVA_HOME |/usr/lib/jvm/java-10 -|JAVA_VENDOR |openjdk -|JAVA_VERSION |10 -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages - -The following RPMs will be installed by this module: - -* java-openjdk-devel-10.0.* - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../jboss/container/openjdk/base/README.adoc[jboss.container.openjdk.base] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/openjdk/jdk/11/README.adoc b/jboss/container/openjdk/jdk/11/README.adoc deleted file mode 100644 index f04c7c8d..00000000 --- a/jboss/container/openjdk/jdk/11/README.adoc +++ /dev/null @@ -1,67 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.openjdk.jdk] -:toc: -:toc-placement!: -:toclevels: 5 - -Installs the JDK for OpenJDK 11. - -toc::[] - -== Labels - -The following labels will be defined on the image: - -org.jboss.product:: openjdk - -org.jboss.product.openjdk.version:: 11.0 - -org.jboss.product.version:: 11.0 - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JAVA_HOME |/usr/lib/jvm/java-11 -|JAVA_VENDOR |openjdk -|JAVA_VERSION |11.0 -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages - -The following RPMs will be installed by this module: - -* java-11-openjdk-devel - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../jboss/container/user/README.adoc[jboss.container.user] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/openjdk/jdk/8/README.adoc b/jboss/container/openjdk/jdk/8/README.adoc deleted file mode 100644 index 024d2544..00000000 --- a/jboss/container/openjdk/jdk/8/README.adoc +++ /dev/null @@ -1,68 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.openjdk.jdk] -:toc: -:toc-placement!: -:toclevels: 5 - -Installs the JDK for OpenJDK 8. - -toc::[] - -== Labels - -The following labels will be defined on the image: - -org.jboss.product:: openjdk - -org.jboss.product.openjdk.version:: 1.8.0 - -org.jboss.product.version:: 1.8.0 - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JAVA_HOME |/usr/lib/jvm/java-1.8.0 -|JAVA_VENDOR |openjdk -|JAVA_VERSION |1.8.0 -|JBOSS_CONTAINER_OPENJDK_JDK_MODULE |/opt/jboss/container/openjdk/jdk -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages - -The following RPMs will be installed by this module: - -* java-1.8.0-openjdk-devel - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../jboss/container/user/README.adoc[jboss.container.user] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/proxy/api/README.adoc b/jboss/container/proxy/api/README.adoc deleted file mode 100644 index d9559152..00000000 --- a/jboss/container/proxy/api/README.adoc +++ /dev/null @@ -1,58 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.proxy.api] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Defines environment variables used for proxy configuration. Modules providing support for configuring proxy settings should use the variables described here accordingly. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|http_proxy |The location of the http proxy. This takes precedence over **HTTP_PROXY** and will be used for both Maven builds and Java runtime. |http://127.0.0.1:8080 -|HTTP_PROXY |The location of the http proxy. This will be used for both Maven builds and Java runtime. |127.0.0.1:8080 -|https_proxy |The location of the https proxy. This takes precedence over **HTTPS_PROXY**, **http_proxy**, and **HTTP_PROXY**, and will be used for both Maven builds and Java runtime. |myuser:mypass@127.0.0.1:8080 -|HTTPS_PROXY |The location of the https proxy. This takes precedence over **http_proxy** and **HTTP_PROXY**, and will be used for both Maven builds and Java runtime. |myuser@127.0.0.1:8080 -|no_proxy |A comman separated lists of hosts, IP addresses or domains that can be accessed directly. This takes precedence over **NO_PROXY** and will be used for both Maven builds and Java runtime. |*.example.com -|NO_PROXY |A comman separated lists of hosts, IP addresses or domains that can be accessed directly. This will be used for both Maven builds and Java runtime. |foo.example.com,bar.example.com -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/s2i/core/api/README.adoc b/jboss/container/s2i/core/api/README.adoc deleted file mode 100644 index 42a50c0b..00000000 --- a/jboss/container/s2i/core/api/README.adoc +++ /dev/null @@ -1,77 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.s2i.core.api] -:toc: -:toc-placement!: -:toclevels: 5 - -^ Defines environment variables and labels used by S2I. Modules implementing S2I capabilities should use these variables accordingly. - -toc::[] - -== Labels - -The following labels will be defined on the image: - -io.openshift.s2i.destination:: /tmp - -io.openshift.s2i.scripts-url:: image:///usr/local/s2i - -org.jboss.container.deployments-dir:: /deployments - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|APP_DATADIR |Deprecated by **S2I_SOURCE_DATA_DIR**. | -|CUSTOM_INSTALL_DIRECTORIES |Deprecated by **S2I_IMAGE_SOURCE_MOUNTS**. | -|DATA_DIR |Deprecated by **S2I_TARGET_DATA_DIR**. | -|DEPLOYMENTS_DIR |Deprecated by **S2I_TARGET_DEPLOYMENTS_DIR**. | -|JAVA_DATA_DIR |Deprecated by **S2I_TARGET_DATA_DIR**. | -|S2I_ARTIFACTS_DIR |^ Location mount for artifacts persisted with **save-artifacts** script, which are used with incremental builds. This should not be overridden by end users. |${S2I_DESTINATION_DIR}/artifacts} -|S2I_DESTINATION_DIR |^ Root directory for S2I mount, as specified by the **io.openshift.s2i.destination** label. This should not be overridden by end users. |/tmp -|S2I_ENABLE_INCREMENTAL_BUILDS |^ Do not remove source and intermediate build files so they can be saved for use with future builds. Defaults to true. |true -|S2I_IMAGE_SOURCE_MOUNTS |^ Comma separated list of relative paths in source directory which should be included in the image. List may include wildcards, which are expanded using find. By default, the contents of mounted directories are processed similarly to source folders, where the contents of $S2I_SOURCE_CONFIGURATION_DIR, $S2I_SOURCE_DATA_DIR, and $S2I_SOURCE_DEPLOYMENTS_DIR are copied to their respective target directories. Alternatively, if an **install.sh** file is located in the root of the mount point, it is executed instead. Deprecates CUSTOM_INSTALL_DIRECTORIES. |extras/* -|S2I_SOURCE_CONFIGURATION_DIR |^ Relative path to directory containing application configuration files to be copied over to the product configuration directory, see **S2I_TARGET_CONFIGURATION_DIR**. Defaults to **configuration**. |configuration -|S2I_SOURCE_DATA_DIR |^ Relative path to directory containing application data files to be copied over to the product data directory, see **S2I_TARGET_DATA_DIR**. Defaults to **data**. |data -|S2I_SOURCE_DEPLOYMENTS_DIR |^ Relative path to directory containing binary files to be copied over to the product deployment directory, see **S2I_TARGET_DEPLOYMENTS_DIR**. Defaults to **deployments**. |deployments -|S2I_SOURCE_DEPLOYMENTS_FILTER |Space separated list of filters to be applied when copying deployments. Defaults to ** * ** - |*.jar *.war *.ear -|S2I_SOURCE_DIR |^ Location of mount for source code to be built. This should not be overridden by end users. |${S2I_DESTINATION_DIR}/src} -|S2I_TARGET_CONFIGURATION_DIR |^ Absolute path to which files located in $S2I_SOURCE_DIR/$S2I_SOURCE_CONFIGURATION_DIR are copied. |/opt/eap/standalone/configuration -|S2I_TARGET_DATA_DIR |^ Absolute path to which files located in $S2I_SOURCE_DIR/$S2I_SOURCE_DATA_DIR are copied. |/opt/eap/standalone/data -|S2I_TARGET_DEPLOYMENTS_DIR |^ Absolute path to which files located in $S2I_SOURCE_DIR/$S2I_SOURCE_DEPLOYMENTS_DIR are copied. Additionally, this is the directory to which build output is copied |/deployments -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|S2I_SOURCE_DEPLOYMENTS_FILTER |* -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/s2i/core/bash/README.adoc b/jboss/container/s2i/core/bash/README.adoc deleted file mode 100644 index 099d4bd8..00000000 --- a/jboss/container/s2i/core/bash/README.adoc +++ /dev/null @@ -1,56 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.s2i.core.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -Provides support for core s2i capabilities. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_S2I_CORE_MODULE |/opt/jboss/container/s2i/core/ -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules - -The following modules will be installed with this module: - -link:../../../../../jboss/container/s2i/core/api/README.adoc[jboss.container.s2i.core.api] - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/user/README.adoc b/jboss/container/user/README.adoc deleted file mode 100644 index a4d4e69b..00000000 --- a/jboss/container/user/README.adoc +++ /dev/null @@ -1,59 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.user] -:toc: -:toc-placement!: -:toclevels: 5 - -Configures the jboss user and permissions. This module should be included by all images. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|HOME |/home/jboss -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages - -The following RPMs will be installed by this module: - -* rsync -* tar -* unzip -* yum-utils - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined. diff --git a/jboss/container/util/logging/bash/README.adoc b/jboss/container/util/logging/bash/README.adoc deleted file mode 100644 index 1b4df421..00000000 --- a/jboss/container/util/logging/bash/README.adoc +++ /dev/null @@ -1,54 +0,0 @@ -//// - AUTOGENERATED FILE - this file was generated via ./gen_template_docs.py. - Changes to .adoc or HTML files may be overwritten! Please change the - generator or the input template (./*.jinja) -//// - - - -= link:./module.yaml[jboss.container.util.logging.bash] -:toc: -:toc-placement!: -:toclevels: 5 - -Provides support for script logging, e.g. colorization of levels, redirection to stderr, etc. - -toc::[] - -== Labels -No labels defined. - - -== Environment Variables - -The following environment variables are used to configure the functionality provided by this module: - -|======================================================================= -|Name |Description |Example -|LOGGING_SCRIPT_DEBUG |Set to true to enable script debugging. Deprecates SCRIPT_DEBUG. |True -|======================================================================= - -The following environment variables will be configured on the image: -|======================================================================= -|Name |Value -|JBOSS_CONTAINER_UTIL_LOGGING_MODULE |/opt/jboss/container/util/logging/ -|======================================================================= - -== Resources -No additional resources will be installed through this module. - -== RPM Packages - -=== Installed RPM Packages -No RPMs will be installed by this module. - -=== RPM Package Repositories -No additional RPM package repositories are required to install listed RPMs. - -== Modules - -=== Included Modules -No additional modules will be installed through this module. - -=== Module Repositories -No module repositories defined.