JBoss.orgCommunity Documentation

Chapter 1. Installation Guide

1.1. Installation
1.2. Directory Structure Explained
1.2.1. bin/scripts
1.2.2. docs/teiid
1.2.3. /standalone/configuration/standalone-teiid.xml
1.2.4. /standalone/deployments
1.2.5. modules
1.2.6. /modules/org/jboss/teiid/main/conf
1.2.7. /domain/configuration/domain-teiid.xml
1.2.8. modules/org/jboss/teiid/client
1.2.9. {standlaone or domain}tmp/teiid
1.2.10. {standlaone or domain}data/teiid-data

Starting with the 7.0 release Teiid needs to be installed into an existing JBoss AS installation, which is entirely different from previous versions.

Note

Teiid does not support the "embedded" mode in 7.6 version. ("embedded" will be coming in a future release).

Steps to install Teiid

  1. Download the JBoss AS 7.1.0 application server. Install the server by unzipping into a known location. Ex: /apps/jboss-7.1.0

    Note

    You may also choose to use an existing AS installation. However if a previous version of Teiid was already installed, you must remove the old teiid distribution artifacts before installing the new version.

  2. Download Teiid 7.6. Unzip the downloaded artifact inside the JBoss AS installation. Teiid 7.6 directory structure matches JBoss profiles directly - it is just an overlay. This will add necessary modules and configuration files to install Teiid in JBoss AS 7.x. Teiid works in both Standalone and Domain modes. Teiid provides separate configuration files (standalone-teiid.xml and domain-teiid.xml) for both modes apart from the default configuration files come with JBoss AS 7.x

    The "Domain" mode recommended in a clustered environment to take advantage of clustered caching and cluster safe distribution of events.

  3. Start the JBoss AS server by executing

       <jboss-install>/bin/standalone.sh --server-config=standalone-teiid.xml
             

    if you want to start the "standalone" profile.

    To start the server in "Domain" mode, install the JBoss AS 7.x and Teiid on all the servers in are going to be part of the cluster. Select one of the server as the "master" domain controller, the rest of the servers will be slaves that connect to the "master" domain controller for all the administrative operations. Edit "host-teiid.xml" on all the slave servers in "jbossas/domain/configuration" directory, and make sure the "domain-controller" element is configured with ip address of the "master" server. For example

         <domain-controller>
           <remote host="192.168.100.1" port="9999"/>
        </domain-controller>  
             

    the port number is for the management interface, make sure they match to that of what you have in the configuration. If you want to change the "server-group" name or add unique server names to each server then modify the "servers" element. Once all the configuration edits are done, then you can start JBoss AS in domain mode by executing the command

       <jboss-install>/bin/domain.sh --domain-config=domain-teiid.xml --host-config=host-teiid.xml
             

    on all the servers. Once all the servers are up, to complete the installion for the domain mode, run the following command on any one server. Note that this only needs to be run for once per whole domain install. Since in domain mode you can not statically deploy resources, this script deploys default resources required (file, ldap, salesforce and ws connectors) for Teiid once the server starts using the CLI interface.

       <jboss-install>/bin/jboss-admin.sh --file=scripts/teiid-domain-mode-install.cli
             

  4. That it!. JBoss AS and Teiid are now installed and running. See below instructions to customize various settings.

  5. Once VDBs have been deployed, users can now connect their JDBC applications to Teiid. If you need help on connecting your application to the Teiid using JDBC check out the "Client Developer's Guide".