An example JBoss Web Server application configured for use with https. For more information about using this template, see https://github.com/jboss-openshift/application-templates.
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 |
---|---|---|---|---|
|
— |
The name for the application. |
jws-app |
True |
|
— |
Custom hostname for http service route. Leave blank for default hostname, e.g.: <application-name>-<project>.<default-domain-suffix> |
— |
False |
|
— |
Custom hostname for https service route. Leave blank for default hostname, e.g.: secure-<application-name>-<project>.<default-domain-suffix> |
— |
False |
|
— |
Git source URI for application |
https://github.com/jboss-openshift/openshift-quickstarts.git |
True |
|
— |
Git branch/tag reference |
1.2 |
False |
|
— |
Path within Git project to build; empty for root project directory. |
tomcat-websocket-chat |
False |
|
— |
The name of the secret containing the certificate files |
jws-app-secret |
True |
|
|
The name of the certificate file within the secret |
server.crt |
False |
|
|
The name of the certificate key file within the secret |
server.key |
False |
|
|
The certificate password |
|
False |
|
|
JWS Admin User |
|
True |
|
|
JWS Admin Password |
|
True |
|
— |
GitHub trigger secret |
secret101 |
True |
|
— |
Generic build trigger secret |
secret101 |
True |
|
— |
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 to use for S2I builds |
— |
False |
|
— |
List of directories from which archives will be copied into the deployment folder. If unspecified, all archives in /target will be copied. |
— |
False |
The CLI supports various object types. A list of these object types as well as their abbreviations can be found in the OKD documentation.
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 |
---|---|---|---|
|
8080 |
— |
The web server’s http port. |
|
8443 |
— |
The web server’s https port. |
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 |
---|---|---|
|
none |
|
|
TLS passthrough |
|
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-tomcat7-openshift:1.3 |
|
GitHub, Generic, ImageChange, ConfigChange |
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.
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 |
---|---|
|
ImageChange |
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 |
---|---|
|
1 |
/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'
Deployments | Name | Port | Protocol |
---|---|---|---|
|
jolokia |
8778 |
|
http |
8080 |
|
|
https |
8443 |
|
Deployment | Variable name | Description | Example value |
---|---|---|---|
|
|
The name of the certificate file within the secret |
|
|
The name of the certificate file within the secret |
|
|
|
The name of the certificate file within the secret |
|
|
|
The name of the certificate file within the secret |
|
|
|
JWS Admin User |
|
|
|
JWS Admin Password |
|