From c18cd0cddb1d1b19b826726405e57d14b96a02b6 Mon Sep 17 00:00:00 2001 From: Brent Daniel Date: Thu, 14 Nov 2019 13:40:00 -0800 Subject: [PATCH] Update README --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6f8fa65095e..83504ce2431 100644 --- a/README.md +++ b/README.md @@ -50,34 +50,41 @@ Environment variables to be used at s2i build time -------------------------------------------------- The following environment variables can be passed to the S2I build process to customize Open Liberty. More information on these variables and the functions they enable can be found at https://github.com/OpenLiberty/ci.docker +* `DEPLOY_TO_APPS` + * Description: When true, applicaton binaries will be copied to `apps` instead of `dropins` * `HTTP_ENDPOINT` - * Decription: Add configuration properties for an HTTP endpoint. + * Description: Add configuration properties for an HTTP endpoint. * XML Snippet Location: [http-ssl-endpoint.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/http-ssl-endpoint.xml) when SSL is enabled. Otherwise [http-endpoint.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/http-endpoint.xml) * `MP_HEALTH_CHECK` - * Decription: Check the health of the environment using Liberty feature `mpHealth-1.0` (implements [MicroProfile Health](https://microprofile.io/project/eclipse/microprofile-health)). + * Description: Check the health of the environment using Liberty feature `mpHealth-1.0` (implements [MicroProfile Health](https://microprofile.io/project/eclipse/microprofile-health)). * XML Snippet Location: [mp-health-check.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/mp-health-check.xml) * `MP_MONITORING` - * Decription: Monitor the server runtime environment and application metrics by using Liberty features `mpMetrics-1.1` (implements [Microprofile Metrics](https://microprofile.io/project/eclipse/microprofile-metrics)) and `monitor-1.0`. + * Description: Monitor the server runtime environment and application metrics by using Liberty features `mpMetrics-1.1` (implements [Microprofile Metrics](https://microprofile.io/project/eclipse/microprofile-metrics)) and `monitor-1.0`. * XML Snippet Location: [mp-monitoring.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/mp-monitoring.xml) * Note: With this option, `/metrics` endpoint is configured without authentication to support the environments that do not yet support scraping secured endpoints. * `TLS` or `SSL` (SSL is being deprecated) - * Decription: Enable Transport Security in Liberty by adding the `transportSecurity-1.0` feature (includes support for SSL). + * Description: Enable Transport Security in Liberty by adding the `transportSecurity-1.0` feature (includes support for SSL). * XML Snippet Location: [keystore.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/keystore.xml). * `IIOP_ENDPOINT` - * Decription: Add configuration properties for an IIOP endpoint. + * Description: Add configuration properties for an IIOP endpoint. * XML Snippet Location: [iiop-ssl-endpoint.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/iiop-ssl-endpoint.xml) when SSL is enabled. Otherwise, [iiop-endpoint.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/iiop-endpoint.xml). * Note: If using this option, `env.IIOP_ENDPOINT_HOST` environment variable should be set to the server's host. See [IIOP endpoint configuration](https://www.ibm.com/support/knowledgecenter/en/SSEQTP_liberty/com.ibm.websphere.liberty.autogen.base.doc/ae/rwlp_config_orb.html#iiopEndpoint) for more details. * `JMS_ENDPOINT` - * Decription: Add configuration properties for an JMS endpoint. + * Description: Add configuration properties for an JMS endpoint. * XML Snippet Location: [jms-ssl-endpoint.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/jms-ssl-endpoint.xml) when SSL is enabled. Otherwise, [jms-endpoint.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/jms-endpoint.xml) * `OIDC` - * Decription: Enable OpenIdConnect Client function by adding the `openidConnectClient-1.0` feature. + * Description: Enable OpenIdConnect Client function by adding the `openidConnectClient-1.0` feature. * XML Snippet Location: [oidc.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/oidc.xml) * `OIDC_CONFIG` - * Decription: Enable OpenIdConnect Client configuration to be read from environment variables. + * Description: Enable OpenIdConnect Client configuration to be read from environment variables. * XML Snippet Location: [oidc-config.xml](https://github.com/OpenLiberty/ci.docker/tree/master/common/helpers/build/configuration_snippets/oidc-config.xml) * Note: The following variables will be read: OIDC_CLIENT_ID, OIDC_CLIENT_SECRET, OIDC_DISCOVERY_URL. +Server Configuration +-------------------------------------------------- + +If you want to use your own server.xml file rather than the default, it should be present in the `src/main/liberty/config` directory. + OpenShift `oc` usage --------------------