Red Hat Training

A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform

24.10. User Script Configuration

24.10.1. Permanent Configuration Parameters

Summary

The following parameters can be used to influence the configuration and operation of JBoss EAP 6. Their contents are written to /etc/sysconfig/jbossas and /etc/sysconfig/jon-agent-ec2.

Table 24.2. Configurable Parameters

Name Description Default
JBOSS_JGROUPS_S3_PING_ACCESS_KEY Amazon AWS user account access key for S3_PING discovery if clustering is used. N/A
JBOSS_JGROUPS_S3_PING_SECRET_ACCESS_KEY Amazon AWS user account secret access key. N/A
JBOSS_JGROUPS_S3_PING_BUCKET Amazon S3 bucket to be used for S3_PING discovery. N/A
JBOSS_CLUSTER_ID
ID of cluster member nodes. Only used for clustering. Accepted values are (in order):
  • A valid cluster ID number in the range 0 - 1023.
  • A network interface name, where the last octet of the IP is used as the value.
  • "S3" as a value would coordinate ID usage through the S3 bucket used by jgroups' S3_PING.
    It is recommended to use the last octet of the IP (the default) when all cluster nodes are located in the same 24 or more bit subnet (for example, in a VPC subnet).
Last octet of eth0's IP address
MOD_CLUSTER_PROXY_LIST Comma-delimited list of IPs/hostnames of mod_cluster proxies if mod_cluster is to be used. N/A
PORTS_ALLOWED List of incoming ports to be allowed by firewall in addition to the default ones. N/A
JBOSSAS_ADMIN_PASSWORD Password for the admin user. N/A
JON_SERVER_ADDR JON server hostname or IP with which to register. This is only used for registration, after that the agent may communicate with other servers in the JON cluster. N/A
JON_SERVER_PORT Port used by the agent to communicate with the server. 7080
JON_AGENT_NAME Name of JON agent, must be unique. Instance's ID
JON_AGENT_PORT Port that the agent listens on. 16163
JON_AGENT_ADDR IP address that the JON agent is to be bound to. This is used when the server has more than one public address, (e.g. VPN). JON agent chooses the IP of local hostname by default.
JON_AGENT_OPTS Additional JON agent system properties which can be used for configuring SSL, NAT and other advanced settings. N/A
JBOSS_SERVER_CONFIG
Name of JBoss EAP 6 server configuration file to use. If JBOSS_DOMAIN_CONTROLLER=true, then domain-ec2.xml is used. Otherwise:
  • If S3 config is present, then standalone-ec2-ha.xml is used.
  • If MOD_CLUSTER_PROXY_LIST is specified, then standalone-mod_cluster-ec2-ha.xml is selected.
  • If neither of the first two options are used, then the standalone.xml file is used.
  • Can also be set to standalone-full.xml.
standalone.xml, standalone-full.xml, standalone-ec2-ha.xml, standalone-mod_cluser-ec2-ha.xml, domain-ec2.xml depending on the other parameters.
JAVA_OPTS Custom values to be added to the variable before JBoss EAP 6 starts. JAVA_OPTS is built from the values of other parameters.
JBOSS_IP IP address that the server is to be bound to. 127.0.0.1
JBOSSCONF The name of the JBoss EAP 6 profile to start. To prevent JBoss EAP 6 from starting, JBOSSCONF can be set to disabled standalone
JBOSS_DOMAIN_CONTROLLER
Sets whether or not this instance will run as a domain controller.
false
JBOSS_DOMAIN_MASTER_ADDRESS
IP address of remote domain controller.
N/A
JBOSS_HOST_NAME
The logical host name (within the domain). This needs to be distinct.
The value of the HOSTNAME environment variable.
JBOSS_HOST_USERNAME
The username the host controller should use when registering with the domain controller. If not provided, the JBOSS_HOST_NAME is used instead.
JBOSS_HOST_NAME
JBOSS_HOST_PASSWORD
The password the host controller should use when registering with the domain controller.
N/A
JBOSS_HOST_CONFIG
If JBOSS_DOMAIN_CONTROLLER=true, then host-master.xml is used. If JBOSS_DOMAIN_MASTER_ADDRESS is present, then host-slave.xml is used.
host-master.xml or host-slave.xml, depending on the other parameters.
JBOSS_DOMAIN_S3_ACCESS_KEY Amazon AWS user account access key for S3 domain controller discovery. N/A
JBOSS_DOMAIN_S3_SECRET_ACCESS_KEY Amazon AWS user account secret access key for S3 domain controller discovery. N/A
JBOSS_DOMAIN_S3_BUCKET Amazon S3 bucket to be used for S3 domain controller discovery. N/A

24.10.2. Custom Script Parameters

Summary

The following parameters can be used in the user customization section of the User Data: field.

Table 24.3. Configurable Parameters

Name Description
JBOSS_DEPLOY_DIR
Deploy directory of the active profile (for example, /var/lib/jbossas/standalone/deployments/). Deployable archives placed in this directory will be deployed. Red Hat recommends using the Management Console or CLI tool to manage deployments instead of using the deploy directory.
JBOSS_CONFIG_DIR
Config directory of the active profile (for example, /var/lib/jbossas/standalone/configuration).
JBOSS_HOST_CONFIG
Name of the active host configuration file (for example, host-master.xml). Red Hat recommends using the Management Console or CLI tools to configure the server instead of editing the configuration file.
JBOSS_SERVER_CONFIG
Name of the active server configuration file (for example, standalone-ec2-ha.xml). Red Hat recommends using the Management Console or CLI tools to configure the server instead of editing the configuration file.
USER_SCRIPT
Path to the custom configuration script, which is available prior to sourcing user-data configuration.
USER_CLI_COMMANDS
Path to a custom file of CLI commands, which is available prior to sourcing user-data configuration.