jws31-tomcat8-https-s2i.adoc

jws31-tomcat8-https-s2i

An example JBoss Web Server application. For more information about using this template, see https://github.com/jboss-openshift/application-templates.

Table of Contents

• Parameters
• Objects
  • Services
  • Routes
  • Build Configurations
  • Deployment Configurations
    • Triggers
    • Replicas
    • Pod Template
      • Image
      • Readiness Probe
      • Exposed Ports
      • Image Environment Variables
      • Volumes
  • External Dependencies

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 OKD documentation for more information.

Variable name	Image Environment Variable	Description	Example value	Required
APPLICATION_NAME	—	The name for the application.	jws-app	True
HOSTNAME_HTTP	—	Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-<project>.<default-domain-suffix>	—	False
HOSTNAME_HTTPS	—	Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-<project>.<default-domain-suffix>	—	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.2	False
CONTEXT_DIR	—	Path within Git project to build; empty for root project directory.	tomcat-websocket-chat	False
JWS_HTTPS_SECRET	—	The name of the secret containing the certificate files	jws-app-secret	True
JWS_HTTPS_CERTIFICATE	JWS_HTTPS_CERTIFICATE_DIR	The name of the certificate file within the secret	server.crt	False
JWS_HTTPS_CERTIFICATE_KEY	JWS_HTTPS_CERTIFICATE	The name of the certificate key file within the secret	server.key	False
JWS_HTTPS_CERTIFICATE_PASSWORD	JWS_HTTPS_CERTIFICATE	The certificate password	${JWS_HTTPS_CERTIFICATE}	False
JWS_ADMIN_USERNAME	JWS_ADMIN_USERNAME	JWS Admin User	${JWS_ADMIN_USERNAME}	True
JWS_ADMIN_PASSWORD	JWS_ADMIN_PASSWORD	JWS Admin Password	${JWS_ADMIN_PASSWORD}	True
GITHUB_WEBHOOK_SECRET	—	GitHub trigger secret	secret101	True
GENERIC_WEBHOOK_SECRET	—	Generic build trigger secret	secret101	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
MAVEN_MIRROR_URL	—	Maven mirror to use for S2I builds	—	False
ARTIFACT_DIR	—	List of directories from which archives will be copied into the deployment folder. If unspecified, all archives in /target will be copied.	—	False

Objects

The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the OKD 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 OKD documentation for more information.

Service	Port	Name	Description
${APPLICATION_NAME}	8080	—	The web server’s http port.
secure-${APPLICATION_NAME}	8443	—	The web server’s https port.

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 OKD documentation for more information.

Service	Security	Hostname
${APPLICATION_NAME}-http	none	${HOSTNAME_HTTP}
${APPLICATION_NAME}-https	TLS passthrough	${HOSTNAME_HTTPS}

Build Configurations

A buildConfig describes a single build definition and a set of triggers for when a new build should be created. A buildConfig is a REST object, which can be used in a POST to the API server to create a new instance. Refer to the OKD documentation for more information.

S2I image	link	Build output	BuildTriggers and Settings
jboss-webserver31-tomcat8-openshift:1.3	jboss-webserver-3/webserver31-tomcat8-openshift	${APPLICATION_NAME}:latest	GitHub, Generic, ImageChange, ConfigChange

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 OKD 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 OKD 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 OKD documentation for more information.

Deployment	Replicas
${APPLICATION_NAME}	1

Pod Template

Image

Deployment	Image
${APPLICATION_NAME}	${APPLICATION_NAME}

Readiness Probe

${APPLICATION_NAME}

/bin/bash -c curl --noproxy '*' -s -u ${JWS_ADMIN_USERNAME}:${JWS_ADMIN_PASSWORD} 'http://localhost:8080/manager/jmxproxy/?get=Catalina%3Atype%3DServer&att=stateName' |grep -iq 'stateName *= *STARTED'

Exposed Ports

Deployments	Name	Port	Protocol
${APPLICATION_NAME}	jolokia	8778	TCP
	http	8080	TCP
	https	8443	TCP

Image Environment Variables

Deployment	Variable name	Description	Example value
${APPLICATION_NAME}	JWS_HTTPS_CERTIFICATE_DIR	The name of the certificate file within the secret	/etc/jws-secret-volume
	JWS_HTTPS_CERTIFICATE	The name of the certificate file within the secret	${JWS_HTTPS_CERTIFICATE}
	JWS_HTTPS_CERTIFICATE_KEY	The name of the certificate file within the secret	${JWS_HTTPS_CERTIFICATE_KEY}
	JWS_HTTPS_CERTIFICATE_PASSWORD	The name of the certificate file within the secret	${JWS_HTTPS_CERTIFICATE_PASSWORD}
	JWS_ADMIN_USERNAME	JWS Admin User	${JWS_ADMIN_USERNAME}
	JWS_ADMIN_PASSWORD	JWS Admin Password	${JWS_ADMIN_PASSWORD}

Volumes

Deployment	Name	mountPath	Purpose	readOnly
${APPLICATION_NAME}	jws-certificate-volume	/etc/jws-secret-volume	ssl certs	True

External Dependencies