Domain.xml: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Internal=
=Internal=


* [[WildFly Domain#Configuration_Files|WildFly Domain]]
* [[WildFly Configuration#Configuration_Files|WildFly Configuration]]
* [[WildFly Domain Mode Configuration]]


=Overview=
=Overview=


<tt>domain.xml</tt> is the main configuration file for a managed domain, containing various profiles to be pushed to different servers belonging to the server groups managed by the domain. Only the domain master reads this file. RedHat documentation mentions that on other domain members, <tt>domain.xml</tt> can be removed. However, it should not be removed from the backup domain controller, if the domain is configured to support HA. For more details see [[Subordinate_WildFly_Host_Controller_Post-Install_Configuration#Optionally_Remove_domain.xm|subordinate host controller post-install configuration - optionally remove <tt>domain.xml</tt>l]].
<tt>domain.xml</tt> is the main configuration file for a managed domain, containing various profiles to be pushed to different servers belonging to the server groups managed by the domain. Only the domain master reads this file. RedHat documentation mentions that <tt>domain.xml</tt> can be removed on other domain members. However, it should not be removed from the backup domain controller, if the domain is configured to support HA. For more details see [[Subordinate_WildFly_Host_Controller_Post-Install_Configuration#Optionally_Remove_domain.xml|subordinate host controller post-install configuration - optionally remove <tt>domain.xml</tt>]]. The file's location is <tt>$JBOSS_HOME/domain/configuration/domain.xml</tt>.
 
=Schema=
 
The domain.xml configuration syntax is described in $JBOSS_HOME/docs/schema/jboss-as-config_*.xsd
 
=Sections=
 
==<server-group>==
 
The <tt><server-group></tt> section defines the [[WildFly Domain Mode Concepts#Server_Group|server groups]] for this management domain.
 
The server group configuration specifies the following mandatory attributes:
* the '''name''' of the server group
* the server group '''profile'''
* the '''socket binding group''' for the servers in the group. This value can be overridden in [[host.xml]].
 
It also can specify optional elements:
 
===<jvm>===
 
<jvm> is an optional element. It can be used to specify the following configuration for the JVMs running server nodes belonging to this server group:
 
====<heap>====
 
====<permgen>====
 
====<ivm-options>====
 
Example of how to configure GC logging: [[WildFly_and_Garbage_Collection_Logging#Server_Node|Enabling GC Logging in Domain Mode - Server Node]].
 
===<system-properties>===
 
<system-properties> is an optional element.
 
===<deployments>===
 
<deployments> is an optional element.
 
For more on deployments, see [[WildFly_Deployment_Concepts#Domain_Mode_Deployments|domain mode deployments]].
 
===<server-group> Example===
 
<pre>
<domain>
    ...
    <server-groups>
        <server-group name="agents" profile="ha">
            <jvm name="default">
                <heap size="1000m" max-size="1000m"/>
                <permgen max-size="256m"/>
            </jvm>
            <socket-binding-group ref="ha-sockets"/>
            <deployments>
                <deployment name="something.ear" runtime-name="something.ear"/>
            </deployments>
        </server-group>
        <server-group name="claims" profile="full-ha">
            <jvm name="default">
                <heap size="1000m" max-size="1000m"/>
                <permgen max-size="256m"/>
            </jvm>
            <socket-binding-group ref="full-ha-sockets"/>
        </server-group>
    </server-groups>
</domain>
</pre>

Latest revision as of 21:09, 5 September 2017

Internal

Overview

domain.xml is the main configuration file for a managed domain, containing various profiles to be pushed to different servers belonging to the server groups managed by the domain. Only the domain master reads this file. RedHat documentation mentions that domain.xml can be removed on other domain members. However, it should not be removed from the backup domain controller, if the domain is configured to support HA. For more details see subordinate host controller post-install configuration - optionally remove domain.xml. The file's location is $JBOSS_HOME/domain/configuration/domain.xml.

Schema

The domain.xml configuration syntax is described in $JBOSS_HOME/docs/schema/jboss-as-config_*.xsd

Sections

<server-group>

The <server-group> section defines the server groups for this management domain.

The server group configuration specifies the following mandatory attributes:

  • the name of the server group
  • the server group profile
  • the socket binding group for the servers in the group. This value can be overridden in host.xml.

It also can specify optional elements:

<jvm>

<jvm> is an optional element. It can be used to specify the following configuration for the JVMs running server nodes belonging to this server group:

<heap>

<permgen>

<ivm-options>

Example of how to configure GC logging: Enabling GC Logging in Domain Mode - Server Node.

<system-properties>

<system-properties> is an optional element.

<deployments>

<deployments> is an optional element.

For more on deployments, see domain mode deployments.

<server-group> Example

<domain>
    ...
    <server-groups>
        <server-group name="agents" profile="ha">
            <jvm name="default">
                <heap size="1000m" max-size="1000m"/>
                <permgen max-size="256m"/>
            </jvm>
            <socket-binding-group ref="ha-sockets"/>
            <deployments>
                <deployment name="something.ear" runtime-name="something.ear"/>
            </deployments>
        </server-group>
        <server-group name="claims" profile="full-ha">
            <jvm name="default">
                <heap size="1000m" max-size="1000m"/>
                <permgen max-size="256m"/>
            </jvm>
            <socket-binding-group ref="full-ha-sockets"/>
        </server-group>
    </server-groups>
</domain>