diff --git a/docs/README.adoc b/docs/README.adoc index 57aeddfd..e66421f9 100644 --- a/docs/README.adoc +++ b/docs/README.adoc @@ -23,12 +23,6 @@ toc::[levels=1] == JBoss Data Grid -* link:./datagrid/datagrid65-basic.adoc[datagrid65-basic] -* link:./datagrid/datagrid65-https.adoc[datagrid65-https] -* link:./datagrid/datagrid65-mysql-persistent.adoc[datagrid65-mysql-persistent] -* link:./datagrid/datagrid65-mysql.adoc[datagrid65-mysql] -* link:./datagrid/datagrid65-postgresql-persistent.adoc[datagrid65-postgresql-persistent] -* link:./datagrid/datagrid65-postgresql.adoc[datagrid65-postgresql] * link:./datagrid/datagrid71-basic.adoc[datagrid71-basic] * link:./datagrid/datagrid71-https.adoc[datagrid71-https] * link:./datagrid/datagrid71-mysql-persistent.adoc[datagrid71-mysql-persistent] @@ -144,6 +138,11 @@ toc::[levels=1] == Release Notes +=== Release 1.4.16 + * Changed image stream URLs from registry.access.redhat.com to registry.redhat.io + * Removed JBoss Data Grid 6.5 + * Added hidden tag Jboss Data Virtualization 6.3 resources + === Release 1.4.10 === Release 1.4.9 diff --git a/docs/datagrid/datagrid65-basic.adoc b/docs/datagrid/datagrid65-basic.adoc deleted file mode 100644 index 222b4867..00000000 --- a/docs/datagrid/datagrid65-basic.adoc +++ /dev/null @@ -1,213 +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 (./*.in) -//// - -= datagrid65-basic -:toc: -:toc-placement!: -:toclevels: 5 - -Application template for JDG 6.5 applications. - -For simple authentication, set - - USERNAME= - PASSWORD= - -This will enable user authentication with the datagrid. Provided username and password will be used to access the cache over both HTTPS and HotRod. With this case, the user will have all permissions configured. - -Restrictions for password: - - at least 8 characters - at least 1 digit - at least 1 non-alphanumeric symbol - must be different than username - must not be root, admin, or administrator - - -toc::[] - - -== Parameters - -Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. -References can be defined in any text field in the objects list field. Refer to the -https://docs.openshift.org/latest/architecture/core_concepts/templates.html#parameters[Openshift documentation] for more information. - -|======================================================================= -|Variable name |Image Environment Variable |Description |Example value |Required - -|`APPLICATION_NAME` | -- | The name for the application. | datagrid-app | True -|`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False -|`USERNAME` | `USERNAME` | User name for JDG user. | `${USERNAME}` | False -|`PASSWORD` | `PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` | False -|`IMAGE_STREAM_NAMESPACE` | -- | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you've installed the ImageStreams in a different namespace/project. | openshift | True -|`INFINISPAN_CONNECTORS` | `INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | hotrod,memcached,rest | False -|`CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` | False -|`DATAVIRT_CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure for use by Red Hat JBoss Data Virtualization for materialization of views. Three caches will be created for each named cache: , _staging and _alias. | `${CACHE_NAMES}` | False -|`CACHE_TYPE_DEFAULT` | `CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` | False -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | `ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` | False -|`MEMCACHED_CACHE` | `MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | default | False -|`REST_SECURITY_DOMAIN` | `REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` | False -|`JGROUPS_CLUSTER_PASSWORD` | `PASSWORD` | JGroups cluster password | `${PASSWORD}` | True -|`MEMORY_LIMIT` | -- | Container memory limit | 1Gi | False -|======================================================================= - - - -== Objects - -The CLI supports various object types. A list of these object types as well as their abbreviations -can be found in the https://docs.openshift.org/latest/cli_reference/basic_cli_operations.html#object-types[Openshift documentation]. - - -=== Services - -A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the -https://cloud.google.com/container-engine/docs/services/[container-engine documentation] for more information. - -|============= -|Service |Port |Name | Description - -.1+| `${APPLICATION_NAME}` -|8080 | -- -.1+| The web server's HTTP port. -.1+| `${APPLICATION_NAME}-memcached` -|11211 | -- -.1+| Memcached service for clustered applications. -.1+| `${APPLICATION_NAME}-hotrod` -|11333 | -- -.1+| Hot Rod service for clustered applications. -.1+| `${APPLICATION_NAME}-ping` -|8888 | ping -.1+| The JGroups ping port for clustering. -|============= - - - -=== Routes - -A route is a way to expose a service by giving it an externally-reachable hostname such as `www.example.com`. A defined route and the endpoints -identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists -of a route name, service selector, and (optionally) security configuration. Refer to the -https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html[Openshift documentation] for more information. - -|============= -| Service | Security | Hostname - -|`${APPLICATION_NAME}-http` | none | `${HOSTNAME_HTTP}` -|============= - - - - -=== Deployment Configurations - -A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. -Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/deployments.html#creating-a-deployment-configuration[Openshift documentation] for more information. - - -==== Triggers - -A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the -https://access.redhat.com/beta/documentation/en/openshift-enterprise-30-developer-guide#triggers[Openshift documentation] for more information. - -|============ -|Deployment | Triggers - -|`${APPLICATION_NAME}` | ImageChange -|============ - - - -==== Replicas - -A replication controller ensures that a specified number of pod "replicas" are running at any one time. -If there are too many, the replication controller kills some pods. If there are too few, it starts more. -Refer to the https://cloud.google.com/container-engine/docs/replicationcontrollers/[container-engine documentation] -for more information. - -|============ -|Deployment | Replicas - -|`${APPLICATION_NAME}` | 1 -|============ - - -==== Pod Template - - - - -===== Image - -|============ -|Deployment | Image - -|`${APPLICATION_NAME}` | jboss-datagrid65-openshift -|============ - - - -===== Readiness Probe - - -.${APPLICATION_NAME} ----- -/bin/bash -c /opt/datagrid/bin/readinessProbe.sh ----- - - - - -===== Exposed Ports - -|============= -|Deployments | Name | Port | Protocol - -.6+| `${APPLICATION_NAME}` -|jolokia | 8778 | `TCP` -|http | 8080 | `TCP` -|ping | 8888 | `TCP` -|memcached | 11211 | `TCP` -|hotrod-internal | 11222 | `TCP` -|hotrod | 11333 | `TCP` -|============= - - - -===== Image Environment Variables - -|======================================================================= -|Deployment |Variable name |Description |Example value - -.14+| `${APPLICATION_NAME}` -|`USERNAME` | User name for JDG user. | `${USERNAME}` -|`PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` -|`JGROUPS_PING_PROTOCOL` | -- | openshift.DNS_PING -|`OPENSHIFT_DNS_PING_SERVICE_NAME` | -- | `${APPLICATION_NAME}-ping` -|`OPENSHIFT_DNS_PING_SERVICE_PORT` | -- | 8888 -|`INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | `${INFINISPAN_CONNECTORS}` -|`CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` -|`DATAVIRT_CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${DATAVIRT_CACHE_NAMES}` -|`CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` -|`HOTROD_SERVICE_NAME` | -- | `${APPLICATION_NAME}-hotrod` -|`MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | `${MEMCACHED_CACHE}` -|`REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` -|`JGROUPS_CLUSTER_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_CLUSTER_PASSWORD}` -|======================================================================= - - - - -=== External Dependencies - - - - - - - diff --git a/docs/datagrid/datagrid65-https.adoc b/docs/datagrid/datagrid65-https.adoc deleted file mode 100644 index a60c44df..00000000 --- a/docs/datagrid/datagrid65-https.adoc +++ /dev/null @@ -1,245 +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 (./*.in) -//// - -= datagrid65-https -:toc: -:toc-placement!: -:toclevels: 5 - -Application template for JDG 6.5 applications. - -For simple authentication, set - - USERNAME= - PASSWORD= - -This will enable user authentication with the datagrid. Provided username and password will be used to access the cache over both HTTPS and HotRod. With this case, the user will have all permissions configured. - -Restrictions for password: - - at least 8 characters - at least 1 digit - at least 1 non-alphanumeric symbol - must be different than username - must not be root, admin, or administrator - - -toc::[] - - -== Parameters - -Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. -References can be defined in any text field in the objects list field. Refer to the -https://docs.openshift.org/latest/architecture/core_concepts/templates.html#parameters[Openshift documentation] for more information. - -|======================================================================= -|Variable name |Image Environment Variable |Description |Example value |Required - -|`APPLICATION_NAME` | -- | The name for the application. | datagrid-app | True -|`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False -|`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False -|`USERNAME` | `USERNAME` | User name for JDG user. | `${USERNAME}` | False -|`PASSWORD` | `PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` | False -|`HTTPS_SECRET` | -- | The name of the secret containing the keystore file | datagrid-app-secret | True -|`HTTPS_KEYSTORE` | `HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | keystore.jks | False -|`HTTPS_NAME` | `HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` | False -|`HTTPS_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`IMAGE_STREAM_NAMESPACE` | -- | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you've installed the ImageStreams in a different namespace/project. | openshift | True -|`INFINISPAN_CONNECTORS` | `INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | hotrod,memcached,rest | False -|`CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` | False -|`DATAVIRT_CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure for use by Red Hat JBoss Data Virtualization for materialization of views. Three caches will be created for each named cache: , _staging and _alias. | `${CACHE_NAMES}` | False -|`CACHE_TYPE_DEFAULT` | `CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` | False -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | `ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` | False -|`MEMCACHED_CACHE` | `MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | default | False -|`REST_SECURITY_DOMAIN` | `REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` | False -|`JGROUPS_ENCRYPT_SECRET` | `JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | datagrid-app-secret | False -|`JGROUPS_ENCRYPT_KEYSTORE` | `JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | jgroups.jceks | False -|`JGROUPS_ENCRYPT_NAME` | `JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` | False -|`JGROUPS_ENCRYPT_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`JGROUPS_CLUSTER_PASSWORD` | `PASSWORD` | JGroups cluster password | `${PASSWORD}` | True -|`MEMORY_LIMIT` | -- | Container memory limit | 1Gi | False -|======================================================================= - - - -== Objects - -The CLI supports various object types. A list of these object types as well as their abbreviations -can be found in the https://docs.openshift.org/latest/cli_reference/basic_cli_operations.html#object-types[Openshift documentation]. - - -=== Services - -A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the -https://cloud.google.com/container-engine/docs/services/[container-engine documentation] for more information. - -|============= -|Service |Port |Name | Description - -.1+| `${APPLICATION_NAME}` -|8080 | -- -.1+| The web server's HTTP port. -.1+| `secure-${APPLICATION_NAME}` -|8443 | -- -.1+| The web server's HTTPS port. -.1+| `${APPLICATION_NAME}-memcached` -|11211 | -- -.1+| Memcached service for clustered applications. -.1+| `${APPLICATION_NAME}-hotrod` -|11333 | -- -.1+| Hot Rod service for clustered applications. -.1+| `${APPLICATION_NAME}-ping` -|8888 | ping -.1+| The JGroups ping port for clustering. -|============= - - - -=== Routes - -A route is a way to expose a service by giving it an externally-reachable hostname such as `www.example.com`. A defined route and the endpoints -identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists -of a route name, service selector, and (optionally) security configuration. Refer to the -https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html[Openshift documentation] for more information. - -|============= -| Service | Security | Hostname - -|`${APPLICATION_NAME}-http` | none | `${HOSTNAME_HTTP}` -|`${APPLICATION_NAME}-https` | TLS passthrough | `${HOSTNAME_HTTPS}` -|============= - - - - -=== Deployment Configurations - -A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. -Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/deployments.html#creating-a-deployment-configuration[Openshift documentation] for more information. - - -==== Triggers - -A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the -https://access.redhat.com/beta/documentation/en/openshift-enterprise-30-developer-guide#triggers[Openshift documentation] for more information. - -|============ -|Deployment | Triggers - -|`${APPLICATION_NAME}` | ImageChange -|============ - - - -==== Replicas - -A replication controller ensures that a specified number of pod "replicas" are running at any one time. -If there are too many, the replication controller kills some pods. If there are too few, it starts more. -Refer to the https://cloud.google.com/container-engine/docs/replicationcontrollers/[container-engine documentation] -for more information. - -|============ -|Deployment | Replicas - -|`${APPLICATION_NAME}` | 1 -|============ - - -==== Pod Template - - - - -===== Image - -|============ -|Deployment | Image - -|`${APPLICATION_NAME}` | jboss-datagrid65-openshift -|============ - - - -===== Readiness Probe - - -.${APPLICATION_NAME} ----- -/bin/bash -c /opt/datagrid/bin/readinessProbe.sh ----- - - - - -===== Exposed Ports - -|============= -|Deployments | Name | Port | Protocol - -.7+| `${APPLICATION_NAME}` -|jolokia | 8778 | `TCP` -|http | 8080 | `TCP` -|https | 8443 | `TCP` -|ping | 8888 | `TCP` -|memcached | 11211 | `TCP` -|hotrod-internal | 11222 | `TCP` -|hotrod | 11333 | `TCP` -|============= - - - -===== Image Environment Variables - -|======================================================================= -|Deployment |Variable name |Description |Example value - -.24+| `${APPLICATION_NAME}` -|`USERNAME` | User name for JDG user. | `${USERNAME}` -|`PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` -|`HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/datagrid-secret-volume` -|`HTTPS_KEYSTORE` | The name of the keystore file within the secret | `${HTTPS_KEYSTORE}` -|`HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` -|`HTTPS_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${HTTPS_PASSWORD}` -|`JGROUPS_PING_PROTOCOL` | -- | openshift.DNS_PING -|`OPENSHIFT_DNS_PING_SERVICE_NAME` | -- | `${APPLICATION_NAME}-ping` -|`OPENSHIFT_DNS_PING_SERVICE_PORT` | -- | 8888 -|`INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | `${INFINISPAN_CONNECTORS}` -|`CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` -|`DATAVIRT_CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${DATAVIRT_CACHE_NAMES}` -|`CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` -|`HOTROD_SERVICE_NAME` | -- | `${APPLICATION_NAME}-hotrod` -|`MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | `${MEMCACHED_CACHE}` -|`REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` -|`HOTROD_ENCRYPTION` | -- | `${HTTPS_NAME}` -|`JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | `${JGROUPS_ENCRYPT_SECRET}` -|`JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | `${JGROUPS_ENCRYPT_KEYSTORE}` -|`JGROUPS_ENCRYPT_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/jgroups-encrypt-secret-volume` -|`JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` -|`JGROUPS_ENCRYPT_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_ENCRYPT_PASSWORD}` -|`JGROUPS_CLUSTER_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_CLUSTER_PASSWORD}` -|======================================================================= - - - -===== Volumes - -|============= -|Deployment |Name | mountPath | Purpose | readOnly - -|`${APPLICATION_NAME}` | datagrid-keystore-volume | `/etc/datagrid-secret-volume` | ssl certs | True -|============= - - -=== External Dependencies - - - - - - - diff --git a/docs/datagrid/datagrid65-mysql-persistent.adoc b/docs/datagrid/datagrid65-mysql-persistent.adoc deleted file mode 100644 index 00903723..00000000 --- a/docs/datagrid/datagrid65-mysql-persistent.adoc +++ /dev/null @@ -1,309 +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 (./*.in) -//// - -= datagrid65-mysql-persistent -:toc: -:toc-placement!: -:toclevels: 5 - -An example JBoss Data Grid application with a MySQL database. For more information about using this template, see https://github.com/jboss-openshift/application-templates. - -For simple authentication, set - - USERNAME= - PASSWORD= - -This will enable user authentication with the datagrid. Provided username and password will be used to access the cache over both HTTPS and HotRod. With this case, the user will have all permissions configured. - -Restrictions for password: - - at least 8 characters - at least 1 digit - at least 1 non-alphanumeric symbol - must be different than username - must not be root, admin, or administrator - - -toc::[] - - -== Parameters - -Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. -References can be defined in any text field in the objects list field. Refer to the -https://docs.openshift.org/latest/architecture/core_concepts/templates.html#parameters[Openshift documentation] for more information. - -|======================================================================= -|Variable name |Image Environment Variable |Description |Example value |Required - -|`APPLICATION_NAME` | -- | The name for the application. | datagrid-app | True -|`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False -|`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False -|`USERNAME` | `USERNAME` | User name for JDG user. | `${USERNAME}` | False -|`PASSWORD` | `PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` | False -|`HTTPS_SECRET` | -- | The name of the secret containing the keystore file | datagrid-app-secret | True -|`HTTPS_KEYSTORE` | `HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | keystore.jks | False -|`HTTPS_NAME` | `HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` | False -|`HTTPS_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/mysql | java:/jboss/datasources/mysql | False -|`DB_DATABASE` | `DB_DATABASE` | Database name | root | True -|`DB_USERNAME` | `USERNAME` | Database user name | `${USERNAME}` | True -|`DB_PASSWORD` | `PASSWORD` | Database user password | `${PASSWORD}` | True -|`DB_MIN_POOL_SIZE` | `DB_MIN_POOL_SIZE` | Sets xa-pool/min-pool-size for the configured datasource. | `${DB_MIN_POOL_SIZE}` | False -|`DB_MAX_POOL_SIZE` | `DB_MAX_POOL_SIZE` | Sets xa-pool/max-pool-size for the configured datasource. | `${DB_MAX_POOL_SIZE}` | False -|`DB_TX_ISOLATION` | `DB_TX_ISOLATION` | Sets transaction-isolation for the configured datasource. | `${DB_TX_ISOLATION}` | False -|`MYSQL_LOWER_CASE_TABLE_NAMES` | `MYSQL_LOWER_CASE_TABLE_NAMES` | Sets how the table names are stored and compared. | `${MYSQL_LOWER_CASE_TABLE_NAMES}` | False -|`MYSQL_MAX_CONNECTIONS` | `MYSQL_MAX_CONNECTIONS` | The maximum permitted number of simultaneous client connections. | `${MYSQL_MAX_CONNECTIONS}` | False -|`MYSQL_FT_MIN_WORD_LEN` | `MYSQL_FT_MIN_WORD_LEN` | The minimum length of the word to be included in a FULLTEXT index. | `${MYSQL_FT_MIN_WORD_LEN}` | False -|`MYSQL_FT_MAX_WORD_LEN` | `MYSQL_FT_MAX_WORD_LEN` | The maximum length of the word to be included in a FULLTEXT index. | `${MYSQL_FT_MAX_WORD_LEN}` | False -|`MYSQL_AIO` | `MYSQL_AIO` | Controls the innodb_use_native_aio setting value if the native AIO is broken. | `${MYSQL_AIO}` | False -|`VOLUME_CAPACITY` | -- | Size of persistent storage for database volume. | 1Gi | True -|`IMAGE_STREAM_NAMESPACE` | -- | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you've installed the ImageStreams in a different namespace/project. | openshift | True -|`INFINISPAN_CONNECTORS` | `INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | hotrod,memcached,rest | False -|`CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` | False -|`DATAVIRT_CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure for use by Red Hat JBoss Data Virtualization for materialization of views. Three caches will be created for each named cache: , _staging and _alias. | `${CACHE_NAMES}` | False -|`CACHE_TYPE_DEFAULT` | `CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` | False -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | `ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` | False -|`MEMCACHED_CACHE` | `MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | default | False -|`REST_SECURITY_DOMAIN` | `REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` | False -|`JGROUPS_ENCRYPT_SECRET` | `JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | datagrid-app-secret | False -|`JGROUPS_ENCRYPT_KEYSTORE` | `JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | jgroups.jceks | False -|`JGROUPS_ENCRYPT_NAME` | `JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` | False -|`JGROUPS_ENCRYPT_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`JGROUPS_CLUSTER_PASSWORD` | `PASSWORD` | JGroups cluster password | `${PASSWORD}` | True -|`MYSQL_IMAGE_STREAM_TAG` | -- | The tag to use for the "mysql" image stream. Typically, this aligns with the major.minor version of MySQL. | 5.7 | True -|`MEMORY_LIMIT` | -- | Container memory limit | 1Gi | False -|======================================================================= - - - -== Objects - -The CLI supports various object types. A list of these object types as well as their abbreviations -can be found in the https://docs.openshift.org/latest/cli_reference/basic_cli_operations.html#object-types[Openshift documentation]. - - -=== Services - -A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the -https://cloud.google.com/container-engine/docs/services/[container-engine documentation] for more information. - -|============= -|Service |Port |Name | Description - -.1+| `${APPLICATION_NAME}` -|8080 | -- -.1+| The web server's HTTP port. -.1+| `secure-${APPLICATION_NAME}` -|8443 | -- -.1+| The web server's HTTPS port. -.1+| `${APPLICATION_NAME}-memcached` -|11211 | -- -.1+| Memcached service for clustered applications. -.1+| `${APPLICATION_NAME}-hotrod` -|11333 | -- -.1+| Hot Rod service for clustered applications. -.1+| `${APPLICATION_NAME}-mysql` -|3306 | -- -.1+| The database server's port. -.1+| `${APPLICATION_NAME}-ping` -|8888 | ping -.1+| The JGroups ping port for clustering. -|============= - - - -=== Routes - -A route is a way to expose a service by giving it an externally-reachable hostname such as `www.example.com`. A defined route and the endpoints -identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists -of a route name, service selector, and (optionally) security configuration. Refer to the -https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html[Openshift documentation] for more information. - -|============= -| Service | Security | Hostname - -|`${APPLICATION_NAME}-http` | none | `${HOSTNAME_HTTP}` -|`${APPLICATION_NAME}-https` | TLS passthrough | `${HOSTNAME_HTTPS}` -|============= - - - - -=== Deployment Configurations - -A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. -Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/deployments.html#creating-a-deployment-configuration[Openshift documentation] for more information. - - -==== Triggers - -A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the -https://access.redhat.com/beta/documentation/en/openshift-enterprise-30-developer-guide#triggers[Openshift documentation] for more information. - -|============ -|Deployment | Triggers - -|`${APPLICATION_NAME}` | ImageChange -|`${APPLICATION_NAME}-mysql` | ImageChange -|============ - - - -==== Replicas - -A replication controller ensures that a specified number of pod "replicas" are running at any one time. -If there are too many, the replication controller kills some pods. If there are too few, it starts more. -Refer to the https://cloud.google.com/container-engine/docs/replicationcontrollers/[container-engine documentation] -for more information. - -|============ -|Deployment | Replicas - -|`${APPLICATION_NAME}` | 1 -|`${APPLICATION_NAME}-mysql` | 1 -|============ - - -==== Pod Template - - - - -===== Image - -|============ -|Deployment | Image - -|`${APPLICATION_NAME}` | jboss-datagrid65-openshift -|`${APPLICATION_NAME}-mysql` | mysql -|============ - - - -===== Readiness Probe - - -.${APPLICATION_NAME} ----- -/bin/bash -c /opt/datagrid/bin/readinessProbe.sh ----- - -.${APPLICATION_NAME}-mysql ----- -/bin/sh -i -c MYSQL_PWD="$MYSQL_PASSWORD" mysql -h 127.0.0.1 -u $MYSQL_USER -D $MYSQL_DATABASE -e 'SELECT 1' ----- - - - - -===== Exposed Ports - -|============= -|Deployments | Name | Port | Protocol - -.7+| `${APPLICATION_NAME}` -|jolokia | 8778 | `TCP` -|http | 8080 | `TCP` -|https | 8443 | `TCP` -|ping | 8888 | `TCP` -|memcached | 11211 | `TCP` -|hotrod-internal | 11222 | `TCP` -|hotrod | 11333 | `TCP` -.1+| `${APPLICATION_NAME}-mysql` -|-- | 3306 | `TCP` -|============= - - - -===== Image Environment Variables - -|======================================================================= -|Deployment |Variable name |Description |Example value - -.37+| `${APPLICATION_NAME}` -|`USERNAME` | User name for JDG user. | `${USERNAME}` -|`PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` -|`HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/datagrid-secret-volume` -|`HTTPS_KEYSTORE` | The name of the keystore file within the secret | `${HTTPS_KEYSTORE}` -|`HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` -|`HTTPS_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${HTTPS_PASSWORD}` -|`DB_SERVICE_PREFIX_MAPPING` | -- | `${APPLICATION_NAME}-mysql=DB` -|`DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/mysql | `${DB_JNDI}` -|`DB_USERNAME` | User name for JDG user. | `${DB_USERNAME}` -|`DB_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${DB_PASSWORD}` -|`DB_DATABASE` | Database name | `${DB_DATABASE}` -|`TX_DATABASE_PREFIX_MAPPING` | -- | `${APPLICATION_NAME}-mysql=DB` -|`DB_MIN_POOL_SIZE` | Sets xa-pool/min-pool-size for the configured datasource. | `${DB_MIN_POOL_SIZE}` -|`DB_MAX_POOL_SIZE` | Sets xa-pool/max-pool-size for the configured datasource. | `${DB_MAX_POOL_SIZE}` -|`DB_TX_ISOLATION` | Sets transaction-isolation for the configured datasource. | `${DB_TX_ISOLATION}` -|`DEFAULT_JDBC_STORE_TYPE` | -- | string -|`DEFAULT_JDBC_STORE_DATASOURCE` | -- | `${DB_JNDI}` -|`MEMCACHED_JDBC_STORE_TYPE` | -- | string -|`MEMCACHED_JDBC_STORE_DATASOURCE` | -- | `${DB_JNDI}` -|`JGROUPS_PING_PROTOCOL` | -- | openshift.DNS_PING -|`OPENSHIFT_DNS_PING_SERVICE_NAME` | -- | `${APPLICATION_NAME}-ping` -|`OPENSHIFT_DNS_PING_SERVICE_PORT` | -- | 8888 -|`INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | `${INFINISPAN_CONNECTORS}` -|`CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` -|`DATAVIRT_CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${DATAVIRT_CACHE_NAMES}` -|`CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` -|`HOTROD_SERVICE_NAME` | -- | `${APPLICATION_NAME}-hotrod` -|`HOTROD_ENCRYPTION` | -- | `${HTTPS_NAME}` -|`MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | `${MEMCACHED_CACHE}` -|`REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` -|`JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | `${JGROUPS_ENCRYPT_SECRET}` -|`JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | `${JGROUPS_ENCRYPT_KEYSTORE}` -|`JGROUPS_ENCRYPT_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/jgroups-encrypt-secret-volume` -|`JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` -|`JGROUPS_ENCRYPT_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_ENCRYPT_PASSWORD}` -|`JGROUPS_CLUSTER_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_CLUSTER_PASSWORD}` -.8+| `${APPLICATION_NAME}-mysql` -|`MYSQL_USER` | -- | `${DB_USERNAME}` -|`MYSQL_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${DB_PASSWORD}` -|`MYSQL_DATABASE` | -- | `${DB_DATABASE}` -|`MYSQL_LOWER_CASE_TABLE_NAMES` | Sets how the table names are stored and compared. | `${MYSQL_LOWER_CASE_TABLE_NAMES}` -|`MYSQL_MAX_CONNECTIONS` | The maximum permitted number of simultaneous client connections. | `${MYSQL_MAX_CONNECTIONS}` -|`MYSQL_FT_MIN_WORD_LEN` | The minimum length of the word to be included in a FULLTEXT index. | `${MYSQL_FT_MIN_WORD_LEN}` -|`MYSQL_FT_MAX_WORD_LEN` | The maximum length of the word to be included in a FULLTEXT index. | `${MYSQL_FT_MAX_WORD_LEN}` -|`MYSQL_AIO` | Controls the innodb_use_native_aio setting value if the native AIO is broken. | `${MYSQL_AIO}` -|======================================================================= - - - -===== Volumes - -|============= -|Deployment |Name | mountPath | Purpose | readOnly - -|`${APPLICATION_NAME}` | datagrid-keystore-volume | `/etc/datagrid-secret-volume` | ssl certs | True -|`${APPLICATION_NAME}-mysql` | `${APPLICATION_NAME}-mysql-pvol` | `/var/lib/mysql/data` | mysql | false -|============= - - -=== External Dependencies - - -==== Volume Claims - -A `PersistentVolume` object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator -by creating `PersistentVolume` objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. -Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/persistent_volumes.html#overview[Openshift documentation] for -more information. - -|============= -|Name | Access Mode - -|`${APPLICATION_NAME}-mysql-claim` | ReadWriteOnce -|============= - - - - - - - diff --git a/docs/datagrid/datagrid65-mysql.adoc b/docs/datagrid/datagrid65-mysql.adoc deleted file mode 100644 index d291ff06..00000000 --- a/docs/datagrid/datagrid65-mysql.adoc +++ /dev/null @@ -1,294 +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 (./*.in) -//// - -= datagrid65-mysql -:toc: -:toc-placement!: -:toclevels: 5 - -Application template for JDG 6.5 and MySQL applications. - -For simple authentication, set - - USERNAME= - PASSWORD= - -This will enable user authentication with the datagrid. Provided username and password will be used to access the cache over both HTTPS and HotRod. With this case, the user will have all permissions configured. - -Restrictions for password: - - at least 8 characters - at least 1 digit - at least 1 non-alphanumeric symbol - must be different than username - must not be root, admin, or administrator - - -toc::[] - - -== Parameters - -Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. -References can be defined in any text field in the objects list field. Refer to the -https://docs.openshift.org/latest/architecture/core_concepts/templates.html#parameters[Openshift documentation] for more information. - -|======================================================================= -|Variable name |Image Environment Variable |Description |Example value |Required - -|`APPLICATION_NAME` | -- | The name for the application. | datagrid-app | True -|`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False -|`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False -|`USERNAME` | `USERNAME` | User name for JDG user. | `${USERNAME}` | False -|`PASSWORD` | `PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` | False -|`HTTPS_SECRET` | -- | The name of the secret containing the keystore file | datagrid-app-secret | True -|`HTTPS_KEYSTORE` | `HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | keystore.jks | False -|`HTTPS_NAME` | `HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` | False -|`HTTPS_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/mysql | java:/jboss/datasources/mysql | False -|`DB_DATABASE` | `DB_DATABASE` | Database name | root | True -|`DB_USERNAME` | `USERNAME` | Database user name | `${USERNAME}` | True -|`DB_PASSWORD` | `PASSWORD` | Database user password | `${PASSWORD}` | True -|`DB_MIN_POOL_SIZE` | `DB_MIN_POOL_SIZE` | Sets xa-pool/min-pool-size for the configured datasource. | `${DB_MIN_POOL_SIZE}` | False -|`DB_MAX_POOL_SIZE` | `DB_MAX_POOL_SIZE` | Sets xa-pool/max-pool-size for the configured datasource. | `${DB_MAX_POOL_SIZE}` | False -|`DB_TX_ISOLATION` | `DB_TX_ISOLATION` | Sets transaction-isolation for the configured datasource. | `${DB_TX_ISOLATION}` | False -|`MYSQL_LOWER_CASE_TABLE_NAMES` | `MYSQL_LOWER_CASE_TABLE_NAMES` | Sets how the table names are stored and compared. | `${MYSQL_LOWER_CASE_TABLE_NAMES}` | False -|`MYSQL_MAX_CONNECTIONS` | `MYSQL_MAX_CONNECTIONS` | The maximum permitted number of simultaneous client connections. | `${MYSQL_MAX_CONNECTIONS}` | False -|`MYSQL_FT_MIN_WORD_LEN` | `MYSQL_FT_MIN_WORD_LEN` | The minimum length of the word to be included in a FULLTEXT index. | `${MYSQL_FT_MIN_WORD_LEN}` | False -|`MYSQL_FT_MAX_WORD_LEN` | `MYSQL_FT_MAX_WORD_LEN` | The maximum length of the word to be included in a FULLTEXT index. | `${MYSQL_FT_MAX_WORD_LEN}` | False -|`MYSQL_AIO` | `MYSQL_AIO` | Controls the innodb_use_native_aio setting value if the native AIO is broken. | `${MYSQL_AIO}` | False -|`IMAGE_STREAM_NAMESPACE` | -- | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you've installed the ImageStreams in a different namespace/project. | openshift | True -|`INFINISPAN_CONNECTORS` | `INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | hotrod,memcached,rest | False -|`CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` | False -|`DATAVIRT_CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure for use by Red Hat JBoss Data Virtualization for materialization of views. Three caches will be created for each named cache: , _staging and _alias. | `${CACHE_NAMES}` | False -|`CACHE_TYPE_DEFAULT` | `CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` | False -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | `ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` | False -|`MEMCACHED_CACHE` | `MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | default | False -|`REST_SECURITY_DOMAIN` | `REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` | False -|`JGROUPS_ENCRYPT_SECRET` | `JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | datagrid-app-secret | False -|`JGROUPS_ENCRYPT_KEYSTORE` | `JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | jgroups.jceks | False -|`JGROUPS_ENCRYPT_NAME` | `JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` | False -|`JGROUPS_ENCRYPT_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`JGROUPS_CLUSTER_PASSWORD` | `PASSWORD` | JGroups cluster password | `${PASSWORD}` | True -|`MYSQL_IMAGE_STREAM_TAG` | -- | The tag to use for the "mysql" image stream. Typically, this aligns with the major.minor version of MySQL. | 5.7 | True -|`MEMORY_LIMIT` | -- | Container memory limit | 1Gi | False -|======================================================================= - - - -== Objects - -The CLI supports various object types. A list of these object types as well as their abbreviations -can be found in the https://docs.openshift.org/latest/cli_reference/basic_cli_operations.html#object-types[Openshift documentation]. - - -=== Services - -A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the -https://cloud.google.com/container-engine/docs/services/[container-engine documentation] for more information. - -|============= -|Service |Port |Name | Description - -.1+| `${APPLICATION_NAME}` -|8080 | -- -.1+| The web server's HTTP port. -.1+| `secure-${APPLICATION_NAME}` -|8443 | -- -.1+| The web server's HTTPS port. -.1+| `${APPLICATION_NAME}-memcached` -|11211 | -- -.1+| Memcached service for clustered applications. -.1+| `${APPLICATION_NAME}-hotrod` -|11333 | -- -.1+| Hot Rod service for clustered applications. -.1+| `${APPLICATION_NAME}-mysql` -|3306 | -- -.1+| The database server's port. -.1+| `${APPLICATION_NAME}-ping` -|8888 | ping -.1+| The JGroups ping port for clustering. -|============= - - - -=== Routes - -A route is a way to expose a service by giving it an externally-reachable hostname such as `www.example.com`. A defined route and the endpoints -identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists -of a route name, service selector, and (optionally) security configuration. Refer to the -https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html[Openshift documentation] for more information. - -|============= -| Service | Security | Hostname - -|`${APPLICATION_NAME}-http` | none | `${HOSTNAME_HTTP}` -|`${APPLICATION_NAME}-https` | TLS passthrough | `${HOSTNAME_HTTPS}` -|============= - - - - -=== Deployment Configurations - -A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. -Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/deployments.html#creating-a-deployment-configuration[Openshift documentation] for more information. - - -==== Triggers - -A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the -https://access.redhat.com/beta/documentation/en/openshift-enterprise-30-developer-guide#triggers[Openshift documentation] for more information. - -|============ -|Deployment | Triggers - -|`${APPLICATION_NAME}` | ImageChange -|`${APPLICATION_NAME}-mysql` | ImageChange -|============ - - - -==== Replicas - -A replication controller ensures that a specified number of pod "replicas" are running at any one time. -If there are too many, the replication controller kills some pods. If there are too few, it starts more. -Refer to the https://cloud.google.com/container-engine/docs/replicationcontrollers/[container-engine documentation] -for more information. - -|============ -|Deployment | Replicas - -|`${APPLICATION_NAME}` | 1 -|`${APPLICATION_NAME}-mysql` | 1 -|============ - - -==== Pod Template - - - - -===== Image - -|============ -|Deployment | Image - -|`${APPLICATION_NAME}` | jboss-datagrid65-openshift -|`${APPLICATION_NAME}-mysql` | mysql -|============ - - - -===== Readiness Probe - - -.${APPLICATION_NAME} ----- -/bin/bash -c /opt/datagrid/bin/readinessProbe.sh ----- - -.${APPLICATION_NAME}-mysql ----- -/bin/sh -i -c MYSQL_PWD="$MYSQL_PASSWORD" mysql -h 127.0.0.1 -u $MYSQL_USER -D $MYSQL_DATABASE -e 'SELECT 1' ----- - - - - -===== Exposed Ports - -|============= -|Deployments | Name | Port | Protocol - -.7+| `${APPLICATION_NAME}` -|jolokia | 8778 | `TCP` -|http | 8080 | `TCP` -|https | 8443 | `TCP` -|ping | 8888 | `TCP` -|memcached | 11211 | `TCP` -|hotrod-internal | 11222 | `TCP` -|hotrod | 11333 | `TCP` -.1+| `${APPLICATION_NAME}-mysql` -|-- | 3306 | `TCP` -|============= - - - -===== Image Environment Variables - -|======================================================================= -|Deployment |Variable name |Description |Example value - -.37+| `${APPLICATION_NAME}` -|`USERNAME` | User name for JDG user. | `${USERNAME}` -|`PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` -|`HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/datagrid-secret-volume` -|`HTTPS_KEYSTORE` | The name of the keystore file within the secret | `${HTTPS_KEYSTORE}` -|`HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` -|`HTTPS_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${HTTPS_PASSWORD}` -|`DB_SERVICE_PREFIX_MAPPING` | -- | `${APPLICATION_NAME}-mysql=DB` -|`DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/mysql | `${DB_JNDI}` -|`DB_USERNAME` | User name for JDG user. | `${DB_USERNAME}` -|`DB_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${DB_PASSWORD}` -|`DB_DATABASE` | Database name | `${DB_DATABASE}` -|`TX_DATABASE_PREFIX_MAPPING` | -- | `${APPLICATION_NAME}-mysql=DB` -|`DB_MIN_POOL_SIZE` | Sets xa-pool/min-pool-size for the configured datasource. | `${DB_MIN_POOL_SIZE}` -|`DB_MAX_POOL_SIZE` | Sets xa-pool/max-pool-size for the configured datasource. | `${DB_MAX_POOL_SIZE}` -|`DB_TX_ISOLATION` | Sets transaction-isolation for the configured datasource. | `${DB_TX_ISOLATION}` -|`DEFAULT_JDBC_STORE_TYPE` | -- | string -|`DEFAULT_JDBC_STORE_DATASOURCE` | -- | `${DB_JNDI}` -|`MEMCACHED_JDBC_STORE_TYPE` | -- | string -|`MEMCACHED_JDBC_STORE_DATASOURCE` | -- | `${DB_JNDI}` -|`JGROUPS_PING_PROTOCOL` | -- | openshift.DNS_PING -|`OPENSHIFT_DNS_PING_SERVICE_NAME` | -- | `${APPLICATION_NAME}-ping` -|`OPENSHIFT_DNS_PING_SERVICE_PORT` | -- | 8888 -|`INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | `${INFINISPAN_CONNECTORS}` -|`CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` -|`DATAVIRT_CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${DATAVIRT_CACHE_NAMES}` -|`CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` -|`HOTROD_SERVICE_NAME` | -- | `${APPLICATION_NAME}-hotrod` -|`HOTROD_ENCRYPTION` | -- | `${HTTPS_NAME}` -|`MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | `${MEMCACHED_CACHE}` -|`REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` -|`JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | `${JGROUPS_ENCRYPT_SECRET}` -|`JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | `${JGROUPS_ENCRYPT_KEYSTORE}` -|`JGROUPS_ENCRYPT_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/jgroups-encrypt-secret-volume` -|`JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` -|`JGROUPS_ENCRYPT_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_ENCRYPT_PASSWORD}` -|`JGROUPS_CLUSTER_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_CLUSTER_PASSWORD}` -.8+| `${APPLICATION_NAME}-mysql` -|`MYSQL_USER` | -- | `${DB_USERNAME}` -|`MYSQL_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${DB_PASSWORD}` -|`MYSQL_DATABASE` | -- | `${DB_DATABASE}` -|`MYSQL_LOWER_CASE_TABLE_NAMES` | Sets how the table names are stored and compared. | `${MYSQL_LOWER_CASE_TABLE_NAMES}` -|`MYSQL_MAX_CONNECTIONS` | The maximum permitted number of simultaneous client connections. | `${MYSQL_MAX_CONNECTIONS}` -|`MYSQL_FT_MIN_WORD_LEN` | The minimum length of the word to be included in a FULLTEXT index. | `${MYSQL_FT_MIN_WORD_LEN}` -|`MYSQL_FT_MAX_WORD_LEN` | The maximum length of the word to be included in a FULLTEXT index. | `${MYSQL_FT_MAX_WORD_LEN}` -|`MYSQL_AIO` | Controls the innodb_use_native_aio setting value if the native AIO is broken. | `${MYSQL_AIO}` -|======================================================================= - - - -===== Volumes - -|============= -|Deployment |Name | mountPath | Purpose | readOnly - -|`${APPLICATION_NAME}` | datagrid-keystore-volume | `/etc/datagrid-secret-volume` | ssl certs | True -|`${APPLICATION_NAME}-mysql` | `${APPLICATION_NAME}-data` | `/var/lib/mysql/data` | -- | false -|============= - - -=== External Dependencies - - - - - - - diff --git a/docs/datagrid/datagrid65-postgresql-persistent.adoc b/docs/datagrid/datagrid65-postgresql-persistent.adoc deleted file mode 100644 index 377d1659..00000000 --- a/docs/datagrid/datagrid65-postgresql-persistent.adoc +++ /dev/null @@ -1,304 +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 (./*.in) -//// - -= datagrid65-postgresql-persistent -:toc: -:toc-placement!: -:toclevels: 5 - -An example JBoss Data Grid application with a PostgreSQL database. For more information about using this template, see https://github.com/jboss-openshift/application-templates. - -For simple authentication, set - - USERNAME= - PASSWORD= - -This will enable user authentication with the datagrid. Provided username and password will be used to access the cache over both HTTPS and HotRod. With this case, the user will have all permissions configured. - -Restrictions for password: - - at least 8 characters - at least 1 digit - at least 1 non-alphanumeric symbol - must be different than username - must not be root, admin, or administrator - - -toc::[] - - -== Parameters - -Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. -References can be defined in any text field in the objects list field. Refer to the -https://docs.openshift.org/latest/architecture/core_concepts/templates.html#parameters[Openshift documentation] for more information. - -|======================================================================= -|Variable name |Image Environment Variable |Description |Example value |Required - -|`APPLICATION_NAME` | -- | The name for the application. | datagrid-app | True -|`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False -|`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False -|`USERNAME` | `USERNAME` | User name for JDG user. | `${USERNAME}` | False -|`PASSWORD` | `PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` | False -|`HTTPS_SECRET` | -- | The name of the secret containing the keystore file | datagrid-app-secret | True -|`HTTPS_KEYSTORE` | `HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | keystore.jks | False -|`HTTPS_NAME` | `HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` | False -|`HTTPS_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/postgresql | java:jboss/datasources/postgresql | False -|`DB_DATABASE` | `DB_DATABASE` | Database name | root | True -|`DB_USERNAME` | `USERNAME` | Database user name | `${USERNAME}` | True -|`DB_PASSWORD` | `PASSWORD` | Database user password | `${PASSWORD}` | True -|`DB_MIN_POOL_SIZE` | `DB_MIN_POOL_SIZE` | Sets xa-pool/min-pool-size for the configured datasource. | `${DB_MIN_POOL_SIZE}` | False -|`DB_MAX_POOL_SIZE` | `DB_MAX_POOL_SIZE` | Sets xa-pool/max-pool-size for the configured datasource. | `${DB_MAX_POOL_SIZE}` | False -|`DB_TX_ISOLATION` | `DB_TX_ISOLATION` | Sets transaction-isolation for the configured datasource. | `${DB_TX_ISOLATION}` | False -|`POSTGRESQL_MAX_CONNECTIONS` | `POSTGRESQL_MAX_CONNECTIONS` | The maximum number of client connections allowed. This also sets the maximum number of prepared transactions. | `${POSTGRESQL_MAX_CONNECTIONS}` | False -|`POSTGRESQL_SHARED_BUFFERS` | `POSTGRESQL_SHARED_BUFFERS` | Configures how much memory is dedicated to PostgreSQL for caching data. | `${POSTGRESQL_SHARED_BUFFERS}` | False -|`VOLUME_CAPACITY` | -- | Size of persistent storage for database volume. | 1Gi | True -|`IMAGE_STREAM_NAMESPACE` | -- | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you've installed the ImageStreams in a different namespace/project. | openshift | True -|`INFINISPAN_CONNECTORS` | `INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | hotrod,memcached,rest | False -|`CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` | False -|`DATAVIRT_CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure for use by Red Hat JBoss Data Virtualization for materialization of views. Three caches will be created for each named cache: , _staging and _alias. | `${CACHE_NAMES}` | False -|`CACHE_TYPE_DEFAULT` | `CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` | False -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | `ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` | False -|`MEMCACHED_CACHE` | `MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | default | False -|`REST_SECURITY_DOMAIN` | `REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` | False -|`JGROUPS_ENCRYPT_SECRET` | `JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | datagrid-app-secret | False -|`JGROUPS_ENCRYPT_KEYSTORE` | `JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | jgroups.jceks | False -|`JGROUPS_ENCRYPT_NAME` | `JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` | False -|`JGROUPS_ENCRYPT_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`JGROUPS_CLUSTER_PASSWORD` | `PASSWORD` | JGroups cluster password | `${PASSWORD}` | True -|`POSTGRESQL_IMAGE_STREAM_TAG` | -- | The tag to use for the "postgresql" image stream. Typically, this aligns with the major.minor version of PostgreSQL. | 9.5 | True -|`MEMORY_LIMIT` | -- | Container memory limit | 1Gi | False -|======================================================================= - - - -== Objects - -The CLI supports various object types. A list of these object types as well as their abbreviations -can be found in the https://docs.openshift.org/latest/cli_reference/basic_cli_operations.html#object-types[Openshift documentation]. - - -=== Services - -A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the -https://cloud.google.com/container-engine/docs/services/[container-engine documentation] for more information. - -|============= -|Service |Port |Name | Description - -.1+| `${APPLICATION_NAME}` -|8080 | -- -.1+| The web server's HTTP port. -.1+| `secure-${APPLICATION_NAME}` -|8443 | -- -.1+| The web server's HTTPS port. -.1+| `${APPLICATION_NAME}-memcached` -|11211 | -- -.1+| Memcached service for clustered applications. -.1+| `${APPLICATION_NAME}-hotrod` -|11333 | -- -.1+| Hot Rod service for clustered applications. -.1+| `${APPLICATION_NAME}-postgresql` -|5432 | -- -.1+| The database server's port. -.1+| `${APPLICATION_NAME}-ping` -|8888 | ping -.1+| The JGroups ping port for clustering. -|============= - - - -=== Routes - -A route is a way to expose a service by giving it an externally-reachable hostname such as `www.example.com`. A defined route and the endpoints -identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists -of a route name, service selector, and (optionally) security configuration. Refer to the -https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html[Openshift documentation] for more information. - -|============= -| Service | Security | Hostname - -|`${APPLICATION_NAME}-http` | none | `${HOSTNAME_HTTP}` -|`${APPLICATION_NAME}-https` | TLS passthrough | `${HOSTNAME_HTTPS}` -|============= - - - - -=== Deployment Configurations - -A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. -Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/deployments.html#creating-a-deployment-configuration[Openshift documentation] for more information. - - -==== Triggers - -A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the -https://access.redhat.com/beta/documentation/en/openshift-enterprise-30-developer-guide#triggers[Openshift documentation] for more information. - -|============ -|Deployment | Triggers - -|`${APPLICATION_NAME}` | ImageChange -|`${APPLICATION_NAME}-postgresql` | ImageChange -|============ - - - -==== Replicas - -A replication controller ensures that a specified number of pod "replicas" are running at any one time. -If there are too many, the replication controller kills some pods. If there are too few, it starts more. -Refer to the https://cloud.google.com/container-engine/docs/replicationcontrollers/[container-engine documentation] -for more information. - -|============ -|Deployment | Replicas - -|`${APPLICATION_NAME}` | 1 -|`${APPLICATION_NAME}-postgresql` | 1 -|============ - - -==== Pod Template - - - - -===== Image - -|============ -|Deployment | Image - -|`${APPLICATION_NAME}` | jboss-datagrid65-openshift -|`${APPLICATION_NAME}-postgresql` | postgresql -|============ - - - -===== Readiness Probe - - -.${APPLICATION_NAME} ----- -/bin/bash -c /opt/datagrid/bin/readinessProbe.sh ----- - -.${APPLICATION_NAME}-postgresql ----- -/bin/sh -i -c psql -h 127.0.0.1 -U $POSTGRESQL_USER -q -d $POSTGRESQL_DATABASE -c 'SELECT 1' ----- - - - - -===== Exposed Ports - -|============= -|Deployments | Name | Port | Protocol - -.7+| `${APPLICATION_NAME}` -|jolokia | 8778 | `TCP` -|http | 8080 | `TCP` -|https | 8443 | `TCP` -|ping | 8888 | `TCP` -|memcached | 11211 | `TCP` -|hotrod-internal | 11222 | `TCP` -|hotrod | 11333 | `TCP` -.1+| `${APPLICATION_NAME}-postgresql` -|-- | 5432 | `TCP` -|============= - - - -===== Image Environment Variables - -|======================================================================= -|Deployment |Variable name |Description |Example value - -.37+| `${APPLICATION_NAME}` -|`USERNAME` | User name for JDG user. | `${USERNAME}` -|`PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` -|`HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/datagrid-secret-volume` -|`HTTPS_KEYSTORE` | The name of the keystore file within the secret | `${HTTPS_KEYSTORE}` -|`HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` -|`HTTPS_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${HTTPS_PASSWORD}` -|`DB_SERVICE_PREFIX_MAPPING` | -- | `${APPLICATION_NAME}-postgresql=DB` -|`DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/postgresql | `${DB_JNDI}` -|`DB_USERNAME` | User name for JDG user. | `${DB_USERNAME}` -|`DB_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${DB_PASSWORD}` -|`DB_DATABASE` | Database name | `${DB_DATABASE}` -|`TX_DATABASE_PREFIX_MAPPING` | -- | `${APPLICATION_NAME}-postgresql=DB` -|`DB_MIN_POOL_SIZE` | Sets xa-pool/min-pool-size for the configured datasource. | `${DB_MIN_POOL_SIZE}` -|`DB_MAX_POOL_SIZE` | Sets xa-pool/max-pool-size for the configured datasource. | `${DB_MAX_POOL_SIZE}` -|`DB_TX_ISOLATION` | Sets transaction-isolation for the configured datasource. | `${DB_TX_ISOLATION}` -|`DEFAULT_JDBC_STORE_TYPE` | -- | string -|`DEFAULT_JDBC_STORE_DATASOURCE` | -- | `${DB_JNDI}` -|`MEMCACHED_JDBC_STORE_TYPE` | -- | string -|`MEMCACHED_JDBC_STORE_DATASOURCE` | -- | `${DB_JNDI}` -|`JGROUPS_PING_PROTOCOL` | -- | openshift.DNS_PING -|`OPENSHIFT_DNS_PING_SERVICE_NAME` | -- | `${APPLICATION_NAME}-ping` -|`OPENSHIFT_DNS_PING_SERVICE_PORT` | -- | 8888 -|`INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | `${INFINISPAN_CONNECTORS}` -|`CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${CACHE_NAMES}` -|`DATAVIRT_CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configured for each entry. | `${DATAVIRT_CACHE_NAMES}` -|`CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` -|`HOTROD_SERVICE_NAME` | -- | `${APPLICATION_NAME}-hotrod` -|`HOTROD_ENCRYPTION` | -- | `${HTTPS_NAME}` -|`MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | `${MEMCACHED_CACHE}` -|`REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` -|`JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | `${JGROUPS_ENCRYPT_SECRET}` -|`JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | `${JGROUPS_ENCRYPT_KEYSTORE}` -|`JGROUPS_ENCRYPT_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/jgroups-encrypt-secret-volume` -|`JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` -|`JGROUPS_ENCRYPT_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_ENCRYPT_PASSWORD}` -|`JGROUPS_CLUSTER_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_CLUSTER_PASSWORD}` -.6+| `${APPLICATION_NAME}-postgresql` -|`POSTGRESQL_USER` | -- | `${DB_USERNAME}` -|`POSTGRESQL_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${DB_PASSWORD}` -|`POSTGRESQL_DATABASE` | -- | `${DB_DATABASE}` -|`POSTGRESQL_MAX_CONNECTIONS` | The maximum number of client connections allowed. This also sets the maximum number of prepared transactions. | `${POSTGRESQL_MAX_CONNECTIONS}` -|`POSTGRESQL_MAX_PREPARED_TRANSACTIONS` | -- | `${POSTGRESQL_MAX_CONNECTIONS}` -|`POSTGRESQL_SHARED_BUFFERS` | Configures how much memory is dedicated to PostgreSQL for caching data. | `${POSTGRESQL_SHARED_BUFFERS}` -|======================================================================= - - - -===== Volumes - -|============= -|Deployment |Name | mountPath | Purpose | readOnly - -|`${APPLICATION_NAME}` | datagrid-keystore-volume | `/etc/datagrid-secret-volume` | ssl certs | True -|`${APPLICATION_NAME}-postgresql` | `${APPLICATION_NAME}-postgresql-pvol` | `/var/lib/pgsql/data` | postgresql | false -|============= - - -=== External Dependencies - - -==== Volume Claims - -A `PersistentVolume` object is a storage resource in an OpenShift cluster. Storage is provisioned by an administrator -by creating `PersistentVolume` objects from sources such as GCE Persistent Disks, AWS Elastic Block Stores (EBS), and NFS mounts. -Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/persistent_volumes.html#overview[Openshift documentation] for -more information. - -|============= -|Name | Access Mode - -|`${APPLICATION_NAME}-postgresql-claim` | ReadWriteOnce -|============= - - - - - - - diff --git a/docs/datagrid/datagrid65-postgresql.adoc b/docs/datagrid/datagrid65-postgresql.adoc deleted file mode 100644 index 37c809d8..00000000 --- a/docs/datagrid/datagrid65-postgresql.adoc +++ /dev/null @@ -1,289 +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 (./*.in) -//// - -= datagrid65-postgresql -:toc: -:toc-placement!: -:toclevels: 5 - -Application template for JDG 6.5 and PostgreSQL applications built using. - -For simple authentication, set - - USERNAME= - PASSWORD= - -This will enable user authentication with the datagrid. Provided username and password will be used to access the cache over both HTTPS and HotRod. With this case, the user will have all permissions configured. - -Restrictions for password: - - at least 8 characters - at least 1 digit - at least 1 non-alphanumeric symbol - must be different than username - must not be root, admin, or administrator - - -toc::[] - - -== Parameters - -Templates allow you to define parameters which take on a value. That value is then substituted wherever the parameter is referenced. -References can be defined in any text field in the objects list field. Refer to the -https://docs.openshift.org/latest/architecture/core_concepts/templates.html#parameters[Openshift documentation] for more information. - -|======================================================================= -|Variable name |Image Environment Variable |Description |Example value |Required - -|`APPLICATION_NAME` | -- | The name for the application. | datagrid-app | True -|`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False -|`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False -|`USERNAME` | `USERNAME` | User name for JDG user. | `${USERNAME}` | False -|`PASSWORD` | `PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` | False -|`HTTPS_SECRET` | -- | The name of the secret containing the keystore file | datagrid-app-secret | True -|`HTTPS_KEYSTORE` | `HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | keystore.jks | False -|`HTTPS_NAME` | `HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` | False -|`HTTPS_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/postgresql | java:jboss/datasources/postgresql | False -|`DB_DATABASE` | `DB_DATABASE` | Database name | root | True -|`DB_USERNAME` | `USERNAME` | Database user name | `${USERNAME}` | True -|`DB_PASSWORD` | `PASSWORD` | Database user password | `${PASSWORD}` | True -|`DB_MIN_POOL_SIZE` | `DB_MIN_POOL_SIZE` | Sets xa-pool/min-pool-size for the configured datasource. | `${DB_MIN_POOL_SIZE}` | False -|`DB_MAX_POOL_SIZE` | `DB_MAX_POOL_SIZE` | Sets xa-pool/max-pool-size for the configured datasource. | `${DB_MAX_POOL_SIZE}` | False -|`DB_TX_ISOLATION` | `DB_TX_ISOLATION` | Sets transaction-isolation for the configured datasource. | `${DB_TX_ISOLATION}` | False -|`POSTGRESQL_MAX_CONNECTIONS` | `POSTGRESQL_MAX_CONNECTIONS` | The maximum number of client connections allowed. This also sets the maximum number of prepared transactions. | `${POSTGRESQL_MAX_CONNECTIONS}` | False -|`POSTGRESQL_SHARED_BUFFERS` | `POSTGRESQL_SHARED_BUFFERS` | Configures how much memory is dedicated to PostgreSQL for caching data. | `${POSTGRESQL_SHARED_BUFFERS}` | False -|`IMAGE_STREAM_NAMESPACE` | -- | Namespace in which the ImageStreams for Red Hat Middleware images are installed. These ImageStreams are normally installed in the openshift namespace. You should only need to modify this if you've installed the ImageStreams in a different namespace/project. | openshift | True -|`INFINISPAN_CONNECTORS` | `INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | hotrod,memcached,rest | False -|`CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configurd for each entry. | `${CACHE_NAMES}` | False -|`DATAVIRT_CACHE_NAMES` | `CACHE_NAMES` | Comma-separated list of caches to configure for use by Red Hat JBoss Data Virtualization for materialization of views. Three caches will be created for each named cache: , _staging and _alias. | `${CACHE_NAMES}` | False -|`CACHE_TYPE_DEFAULT` | `CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` | False -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | `ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` | False -|`MEMCACHED_CACHE` | `MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | default | False -|`REST_SECURITY_DOMAIN` | `REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` | False -|`JGROUPS_ENCRYPT_SECRET` | `JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | datagrid-app-secret | False -|`JGROUPS_ENCRYPT_KEYSTORE` | `JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | jgroups.jceks | False -|`JGROUPS_ENCRYPT_NAME` | `JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` | False -|`JGROUPS_ENCRYPT_PASSWORD` | `PASSWORD` | The password for the keystore and certificate | `${PASSWORD}` | False -|`JGROUPS_CLUSTER_PASSWORD` | `PASSWORD` | JGroups cluster password | `${PASSWORD}` | True -|`POSTGRESQL_IMAGE_STREAM_TAG` | -- | The tag to use for the "postgresql" image stream. Typically, this aligns with the major.minor version of PostgreSQL. | 9.5 | True -|`MEMORY_LIMIT` | -- | Container memory limit | 1Gi | False -|======================================================================= - - - -== Objects - -The CLI supports various object types. A list of these object types as well as their abbreviations -can be found in the https://docs.openshift.org/latest/cli_reference/basic_cli_operations.html#object-types[Openshift documentation]. - - -=== Services - -A service is an abstraction which defines a logical set of pods and a policy by which to access them. Refer to the -https://cloud.google.com/container-engine/docs/services/[container-engine documentation] for more information. - -|============= -|Service |Port |Name | Description - -.1+| `${APPLICATION_NAME}` -|8080 | -- -.1+| The web server's HTTP port. -.1+| `secure-${APPLICATION_NAME}` -|8443 | -- -.1+| The web server's HTTPS port. -.1+| `${APPLICATION_NAME}-memcached` -|11211 | -- -.1+| Memcached service for clustered applications. -.1+| `${APPLICATION_NAME}-hotrod` -|11333 | -- -.1+| Hot Rod service for clustered applications. -.1+| `${APPLICATION_NAME}-postgresql` -|5432 | -- -.1+| The database server's port. -.1+| `${APPLICATION_NAME}-ping` -|8888 | ping -.1+| The JGroups ping port for clustering. -|============= - - - -=== Routes - -A route is a way to expose a service by giving it an externally-reachable hostname such as `www.example.com`. A defined route and the endpoints -identified by its service can be consumed by a router to provide named connectivity from external clients to your applications. Each route consists -of a route name, service selector, and (optionally) security configuration. Refer to the -https://docs.openshift.com/enterprise/3.0/architecture/core_concepts/routes.html[Openshift documentation] for more information. - -|============= -| Service | Security | Hostname - -|`${APPLICATION_NAME}-http` | none | `${HOSTNAME_HTTP}` -|`${APPLICATION_NAME}-https` | TLS passthrough | `${HOSTNAME_HTTPS}` -|============= - - - - -=== Deployment Configurations - -A deployment in OpenShift is a replication controller based on a user defined template called a deployment configuration. Deployments are created manually or in response to triggered events. -Refer to the https://docs.openshift.com/enterprise/3.0/dev_guide/deployments.html#creating-a-deployment-configuration[Openshift documentation] for more information. - - -==== Triggers - -A trigger drives the creation of new deployments in response to events, both inside and outside OpenShift. Refer to the -https://access.redhat.com/beta/documentation/en/openshift-enterprise-30-developer-guide#triggers[Openshift documentation] for more information. - -|============ -|Deployment | Triggers - -|`${APPLICATION_NAME}` | ImageChange -|`${APPLICATION_NAME}-postgresql` | ImageChange -|============ - - - -==== Replicas - -A replication controller ensures that a specified number of pod "replicas" are running at any one time. -If there are too many, the replication controller kills some pods. If there are too few, it starts more. -Refer to the https://cloud.google.com/container-engine/docs/replicationcontrollers/[container-engine documentation] -for more information. - -|============ -|Deployment | Replicas - -|`${APPLICATION_NAME}` | 1 -|`${APPLICATION_NAME}-postgresql` | 1 -|============ - - -==== Pod Template - - - - -===== Image - -|============ -|Deployment | Image - -|`${APPLICATION_NAME}` | jboss-datagrid65-openshift -|`${APPLICATION_NAME}-postgresql` | postgresql -|============ - - - -===== Readiness Probe - - -.${APPLICATION_NAME} ----- -/bin/bash -c /opt/datagrid/bin/readinessProbe.sh ----- - -.${APPLICATION_NAME}-postgresql ----- -/bin/sh -i -c psql -h 127.0.0.1 -U $POSTGRESQL_USER -q -d $POSTGRESQL_DATABASE -c 'SELECT 1' ----- - - - - -===== Exposed Ports - -|============= -|Deployments | Name | Port | Protocol - -.7+| `${APPLICATION_NAME}` -|jolokia | 8778 | `TCP` -|http | 8080 | `TCP` -|https | 8443 | `TCP` -|ping | 8888 | `TCP` -|memcached | 11211 | `TCP` -|hotrod-internal | 11222 | `TCP` -|hotrod | 11333 | `TCP` -.1+| `${APPLICATION_NAME}-postgresql` -|-- | 5432 | `TCP` -|============= - - - -===== Image Environment Variables - -|======================================================================= -|Deployment |Variable name |Description |Example value - -.37+| `${APPLICATION_NAME}` -|`USERNAME` | User name for JDG user. | `${USERNAME}` -|`PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${PASSWORD}` -|`HTTPS_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/datagrid-secret-volume` -|`HTTPS_KEYSTORE` | The name of the keystore file within the secret | `${HTTPS_KEYSTORE}` -|`HTTPS_NAME` | The name associated with the server certificate | `${HTTPS_NAME}` -|`HTTPS_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${HTTPS_PASSWORD}` -|`DB_SERVICE_PREFIX_MAPPING` | -- | `${APPLICATION_NAME}-postgresql=DB` -|`DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/postgresql | `${DB_JNDI}` -|`DB_USERNAME` | User name for JDG user. | `${DB_USERNAME}` -|`DB_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${DB_PASSWORD}` -|`DB_DATABASE` | Database name | `${DB_DATABASE}` -|`TX_DATABASE_PREFIX_MAPPING` | -- | `${APPLICATION_NAME}-postgresql=DB` -|`DB_MIN_POOL_SIZE` | Sets xa-pool/min-pool-size for the configured datasource. | `${DB_MIN_POOL_SIZE}` -|`DB_MAX_POOL_SIZE` | Sets xa-pool/max-pool-size for the configured datasource. | `${DB_MAX_POOL_SIZE}` -|`DB_TX_ISOLATION` | Sets transaction-isolation for the configured datasource. | `${DB_TX_ISOLATION}` -|`DEFAULT_JDBC_STORE_TYPE` | -- | string -|`DEFAULT_JDBC_STORE_DATASOURCE` | -- | `${DB_JNDI}` -|`MEMCACHED_JDBC_STORE_TYPE` | -- | string -|`MEMCACHED_JDBC_STORE_DATASOURCE` | -- | `${DB_JNDI}` -|`JGROUPS_PING_PROTOCOL` | -- | openshift.DNS_PING -|`OPENSHIFT_DNS_PING_SERVICE_NAME` | -- | `${APPLICATION_NAME}-ping` -|`OPENSHIFT_DNS_PING_SERVICE_PORT` | -- | 8888 -|`INFINISPAN_CONNECTORS` | Comma-separated list of connector types that should be configured (defaults to 'memcached,hotrod,rest') | `${INFINISPAN_CONNECTORS}` -|`CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configurd for each entry. | `${CACHE_NAMES}` -|`DATAVIRT_CACHE_NAMES` | Comma-separated list of caches to configure. By default, a distributed-cache, with a mode of SYNC will be configurd for each entry. | `${DATAVIRT_CACHE_NAMES}` -|`CACHE_TYPE_DEFAULT` | Default cache type for all caches. If empty then distributed will be the default | `${CACHE_TYPE_DEFAULT}` -|`ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH` | | `${ENCRYPTION_REQUIRE_SSL_CLIENT_AUTH}` -|`HOTROD_SERVICE_NAME` | -- | `${APPLICATION_NAME}-hotrod` -|`HOTROD_ENCRYPTION` | -- | `${HTTPS_NAME}` -|`MEMCACHED_CACHE` | The name of the cache to expose through this memcached connector (defaults to 'default') | `${MEMCACHED_CACHE}` -|`REST_SECURITY_DOMAIN` | The domain, declared in the security subsystem, that should be used to authenticate access to the REST endpoint | `${REST_SECURITY_DOMAIN}` -|`JGROUPS_ENCRYPT_SECRET` | The name of the secret containing the keystore file | `${JGROUPS_ENCRYPT_SECRET}` -|`JGROUPS_ENCRYPT_KEYSTORE` | The name of the keystore file within the secret | `${JGROUPS_ENCRYPT_KEYSTORE}` -|`JGROUPS_ENCRYPT_KEYSTORE_DIR` | The name of the keystore file within the secret | `/etc/jgroups-encrypt-secret-volume` -|`JGROUPS_ENCRYPT_NAME` | The name associated with the server certificate | `${JGROUPS_ENCRYPT_NAME}` -|`JGROUPS_ENCRYPT_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_ENCRYPT_PASSWORD}` -|`JGROUPS_CLUSTER_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${JGROUPS_CLUSTER_PASSWORD}` -.6+| `${APPLICATION_NAME}-postgresql` -|`POSTGRESQL_USER` | -- | `${DB_USERNAME}` -|`POSTGRESQL_PASSWORD` | The password to access the JDG Caches. Must be different than username; must not be root, admin, or administrator; must contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), and 1 non-alphanumeric symbol(s). (optional) | `${DB_PASSWORD}` -|`POSTGRESQL_DATABASE` | -- | `${DB_DATABASE}` -|`POSTGRESQL_MAX_CONNECTIONS` | The maximum number of client connections allowed. This also sets the maximum number of prepared transactions. | `${POSTGRESQL_MAX_CONNECTIONS}` -|`POSTGRESQL_MAX_PREPARED_TRANSACTIONS` | -- | `${POSTGRESQL_MAX_CONNECTIONS}` -|`POSTGRESQL_SHARED_BUFFERS` | Configures how much memory is dedicated to PostgreSQL for caching data. | `${POSTGRESQL_SHARED_BUFFERS}` -|======================================================================= - - - -===== Volumes - -|============= -|Deployment |Name | mountPath | Purpose | readOnly - -|`${APPLICATION_NAME}` | datagrid-keystore-volume | `/etc/datagrid-secret-volume` | ssl certs | True -|`${APPLICATION_NAME}-postgresql` | `${APPLICATION_NAME}-data` | `/var/lib/pgsql/data` | -- | false -|============= - - -=== External Dependencies - - - - - - - diff --git a/docs/eap/eap71-amq-persistent-s2i.adoc b/docs/eap/eap71-amq-persistent-s2i.adoc index 30ad673a..bf89b3ea 100644 --- a/docs/eap/eap71-amq-persistent-s2i.adoc +++ b/docs/eap/eap71-amq-persistent-s2i.adoc @@ -27,7 +27,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts.git | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.3 | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | helloworld-mdb | False |`VOLUME_CAPACITY` | -- | Size of the volume used by A-MQ for persisting messages. | 1Gi | True |`MQ_JNDI` | `MQ_JNDI` | JNDI name for connection factory used by applications to connect to the broker, e.g. java:/ConnectionFactory | java:/ConnectionFactory | False diff --git a/docs/eap/eap71-amq-s2i.adoc b/docs/eap/eap71-amq-s2i.adoc index 7302da2f..df0f1bd3 100644 --- a/docs/eap/eap71-amq-s2i.adoc +++ b/docs/eap/eap71-amq-s2i.adoc @@ -27,7 +27,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts.git | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.3 | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | helloworld-mdb | False |`MQ_JNDI` | `MQ_JNDI` | JNDI name for connection factory used by applications to connect to the broker, e.g. java:/ConnectionFactory | java:/ConnectionFactory | False |`MQ_PROTOCOL` | `MQ_PROTOCOL` | Broker protocols to configure, separated by commas. Allowed values are: `openwire`, `amqp`, `stomp` and `mqtt`. Only `openwire` is supported by EAP. | openwire | False diff --git a/docs/eap/eap71-mongodb-persistent-s2i.adoc b/docs/eap/eap71-mongodb-persistent-s2i.adoc index 67eadef1..11d54e2f 100644 --- a/docs/eap/eap71-mongodb-persistent-s2i.adoc +++ b/docs/eap/eap71-mongodb-persistent-s2i.adoc @@ -27,7 +27,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.3 | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | todolist/todolist-mongodb | False |`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/mongodb | `${DB_JNDI}` | False |`DB_DATABASE` | `DB_DATABASE` | Database name | root | True diff --git a/docs/eap/eap71-mongodb-s2i.adoc b/docs/eap/eap71-mongodb-s2i.adoc index 79c83a5c..8a22df43 100644 --- a/docs/eap/eap71-mongodb-s2i.adoc +++ b/docs/eap/eap71-mongodb-s2i.adoc @@ -27,7 +27,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.3 | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | todolist/todolist-mongodb | False |`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/mongodb | `${DB_JNDI}` | False |`DB_DATABASE` | `DB_DATABASE` | Database name | root | True diff --git a/docs/eap/eap71-mysql-persistent-s2i.adoc b/docs/eap/eap71-mysql-persistent-s2i.adoc index 347702c1..c0457cb1 100644 --- a/docs/eap/eap71-mysql-persistent-s2i.adoc +++ b/docs/eap/eap71-mysql-persistent-s2i.adoc @@ -27,7 +27,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.3 | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | todolist/todolist-jdbc | False |`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/mysql | java:jboss/datasources/TodoListDS | False |`DB_DATABASE` | `DB_DATABASE` | Database name | root | True diff --git a/docs/eap/eap71-mysql-s2i.adoc b/docs/eap/eap71-mysql-s2i.adoc index 25e6b1a8..b6ea294a 100644 --- a/docs/eap/eap71-mysql-s2i.adoc +++ b/docs/eap/eap71-mysql-s2i.adoc @@ -27,7 +27,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.3 | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | todolist/todolist-jdbc | False |`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/mysql | java:jboss/datasources/TodoListDS | False |`DB_DATABASE` | `DB_DATABASE` | Database name | root | True diff --git a/docs/eap/eap71-postgresql-persistent-s2i.adoc b/docs/eap/eap71-postgresql-persistent-s2i.adoc index 8071ece5..d9ad7393 100644 --- a/docs/eap/eap71-postgresql-persistent-s2i.adoc +++ b/docs/eap/eap71-postgresql-persistent-s2i.adoc @@ -27,7 +27,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.3 | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | todolist/todolist-jdbc | False |`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/postgresql | java:jboss/datasources/TodoListDS | False |`DB_DATABASE` | `DB_DATABASE` | Database name | root | True diff --git a/docs/eap/eap71-postgresql-s2i.adoc b/docs/eap/eap71-postgresql-s2i.adoc index 4b481b7e..921da735 100644 --- a/docs/eap/eap71-postgresql-s2i.adoc +++ b/docs/eap/eap71-postgresql-s2i.adoc @@ -27,7 +27,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.3 | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | todolist/todolist-jdbc | False |`DB_JNDI` | `DB_JNDI` | Database JNDI name used by application to resolve the datasource, e.g. java:/jboss/datasources/postgresql | java:jboss/datasources/TodoListDS | False |`DB_DATABASE` | `DB_DATABASE` | Database name | root | True diff --git a/docs/eap/eap71-third-party-db-s2i.adoc b/docs/eap/eap71-third-party-db-s2i.adoc index 3aefa92c..d01f4239 100644 --- a/docs/eap/eap71-third-party-db-s2i.adoc +++ b/docs/eap/eap71-third-party-db-s2i.adoc @@ -28,7 +28,7 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False |`HOSTNAME_HTTPS` | -- | Custom hostname for https service route. Leave blank for default hostname, e.g.: secure--. | -- | False |`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | master | False +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False |`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | datavirt/hibernate-webapp | False |`EXTENSIONS_IMAGE` | -- | ImageStreamTag definition for the image containing the drivers and configuration, e.g. jboss-datavirt63-driver-openshift:1.1 | jboss-datavirt63-driver-openshift:1.1 | True |`EXTENSIONS_IMAGE_NAMESPACE` | -- | Namespace within which the ImageStream definition for the image containing the drivers and configuration is located. | openshift | True diff --git a/docs/eap/eap71-tx-recovery-s2i.adoc b/docs/eap/eap71-tx-recovery-s2i.adoc index 0ebfe699..be733fab 100644 --- a/docs/eap/eap71-tx-recovery-s2i.adoc +++ b/docs/eap/eap71-tx-recovery-s2i.adoc @@ -25,9 +25,10 @@ https://docs.openshift.org/latest/architecture/core_concepts/templates.html#para |`APPLICATION_NAME` | -- | The name for the application. | eap-app | True |`HOSTNAME_HTTP` | -- | Custom hostname for http service route. Leave blank for default hostname, e.g.: -. | -- | False -|`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-developer/jboss-eap-quickstarts | True -|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 7.1.0.GA | False -|`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | kitchensink | False +|`SOURCE_REPOSITORY_URL` | -- | Git source URI for application | https://github.com/jboss-openshift/openshift-quickstarts.git | True +|`SOURCE_REPOSITORY_REF` | -- | Git branch/tag reference | 1.4 | False +|`CONTEXT_DIR` | -- | Path within Git project to build; empty for root project directory. | jta-crash-rec-eap7 | False +|`CUSTOM_INSTALL_DIRECTORIES` | `CUSTOM_INSTALL_DIRECTORIES` | Additional directories from which to install. | extensions/* | False |`MQ_QUEUES` | `MQ_QUEUES` | Queue names | `${MQ_QUEUES}` | False |`MQ_TOPICS` | `MQ_TOPICS` | Topic names | `${MQ_TOPICS}` | False |`MQ_CLUSTER_PASSWORD` | `MQ_CLUSTER_PASSWORD` | A-MQ cluster admin password | `${MQ_CLUSTER_PASSWORD}` | True @@ -196,7 +197,7 @@ information. |======================================================================= |Deployment |Variable name |Description |Example value -.9+| `${APPLICATION_NAME}` +.10+| `${APPLICATION_NAME}` |`JGROUPS_PING_PROTOCOL` | -- | openshift.DNS_PING |`OPENSHIFT_DNS_PING_SERVICE_NAME` | -- | `${APPLICATION_NAME}-ping` |`OPENSHIFT_DNS_PING_SERVICE_PORT` | -- | 8888 @@ -206,7 +207,8 @@ information. |`JGROUPS_CLUSTER_PASSWORD` | JGroups cluster password | `${JGROUPS_CLUSTER_PASSWORD}` |`AUTO_DEPLOY_EXPLODED` | Controls whether exploded deployment content should be automatically deployed | `${AUTO_DEPLOY_EXPLODED}` |`SPLIT_DATA` | Split the data directory for each node in a cluster. | `${SPLIT_DATA}` -.9+| `${APPLICATION_NAME}-migration` +|`CUSTOM_INSTALL_DIRECTORIES` | Additional directories from which to install. | `${CUSTOM_INSTALL_DIRECTORIES}` +.10+| `${APPLICATION_NAME}-migration` |`JGROUPS_PING_PROTOCOL` | -- | openshift.DNS_PING |`OPENSHIFT_DNS_PING_SERVICE_NAME` | -- | `${APPLICATION_NAME}-ping` |`OPENSHIFT_DNS_PING_SERVICE_PORT` | -- | 8888 @@ -216,6 +218,7 @@ information. |`JGROUPS_CLUSTER_PASSWORD` | JGroups cluster password | `${JGROUPS_CLUSTER_PASSWORD}` |`AUTO_DEPLOY_EXPLODED` | Controls whether exploded deployment content should be automatically deployed | `${AUTO_DEPLOY_EXPLODED}` |`SPLIT_DATA` | Split the data directory for each node in a cluster. | `${SPLIT_DATA}` +|`CUSTOM_INSTALL_DIRECTORIES` | Additional directories from which to install. | `${CUSTOM_INSTALL_DIRECTORIES}` |======================================================================= diff --git a/release-notes.adoc.in b/release-notes.adoc.in index 2bd9e0d8..74803c19 100644 --- a/release-notes.adoc.in +++ b/release-notes.adoc.in @@ -6,6 +6,11 @@ == Release Notes +=== Release 1.4.16 + * Changed image stream URLs from registry.access.redhat.com to registry.redhat.io + * Removed JBoss Data Grid 6.5 + * Added hidden tag Jboss Data Virtualization 6.3 resources + === Release 1.4.10 === Release 1.4.9