Skip to content

Latest commit

 

History

History
213 lines (133 loc) · 9.02 KB

datagrid65-basic.adoc

File metadata and controls

213 lines (133 loc) · 9.02 KB

datagrid65-basic

Application template for JDG 6.5 applications.

For simple authentication, set

USERNAME=<username>
PASSWORD=<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

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 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.: <application-name>-<project>.<default-domain-suffix>

 — 

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: <name>, <name>_staging and <name>_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 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 container-engine documentation for more information.

Service Port Name Description

${APPLICATION_NAME}

8080

 — 

The web server’s HTTP port.

${APPLICATION_NAME}-memcached

11211

 — 

Memcached service for clustered applications.

${APPLICATION_NAME}-hotrod

11333

 — 

Hot Rod service for clustered applications.

${APPLICATION_NAME}-ping

8888

ping

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 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 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 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 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

${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

${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