JBoss.orgCommunity Documentation
Starting with the 7.0 release Teiid needs to be installed into an existing JBoss AS installation, which is entirely different from previous versions.
Teiid does not support the "embedded" mode in 7.5 version. ("embedded" will be coming in a future release).
Steps to install Teiid
Download the JBoss AS 5.1.0 application server. Install the server by unzipping into a known location. Ex: /apps/jboss-5.1.0
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.
Download Teiid 7.5. Unzip the downloaded artifact inside any "profile" in the JBoss AS installation. Teiid 7.5 uses a JBoss AS service called the "profile service" that is only installed in "default" and "all" profiles, so installing into one of these profiles is required. The default profile is the typical installation location, for example "<jboss-install>/server/default". The Teiid runtime directory structure matches JBoss profiles directly - it is just an overlay.
The all profile is recommended in a clustered environment to take advantage of clustered caching and cluster safe distribution of events.
Start the JBoss AS server by executing "<jboss-install>/bin/run.sh" if you installed in the "default" profile. Otherwise use "<jboss-install>/bin/run.sh -c <profilename>"
That it!. JBoss AS and Teiid are now installed and running. See below instructions to customize various settings.
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".
The usage of CXF is expected for utilizing Salesforce and Web Services connectivity through Teiid. If you do not plan on integrating either of these features, then you may leave JBoss AS with the default "native" web services stack.
Download JBossWS-CXF 3.1.2 and unzip to a temporary location.
From the jbossws-cxf-bin-dist directory, save the ant.properties.example file as ant.properties and change the values for jboss510.home, jbossws.integration.target, jboss.server.instance, jboss.bind.address accordingly:
... jboss510.home=<jboss-install> # The JBoss server under test. This can be [jboss500|jboss501|jboss510|jboss600] jbossws.integration.target=jboss510 # The JBoss settings jboss.server.instance=<profile> jboss.bind.address=<bind address>
The jboss-install location should be the root directory of your AS installation, profile (typically default) should indicate the profile selected for your Teiid installation, and the bind address should be the bind address used when launching JBoss AS (use the value localhost if you do not set the bind address when launching JBoss AS).
From the jbossws-cxf-bin-dist directory, install JBossWS-CXF by running the ANT build script:
$ant deploy-jboss510
Optionally run tests to verify that there are no errors with the installation:
$ant tests
Example 1.1. Directory Structure
This shows the contents of the Teiid 7.5 deployment. The directory structure is exactly the same under any JBoss profile.
teiid /conf /props teiid-security-roles.properties teiid-security-users.properties jboss-teiid-log4j.xml /deploy /teiid /connectors teiid-jboss-beans.xml teiid-connector-templates-jboss-beans.xml admin-console.war /deployers /teiid.deployer /lib /teiid-examples
Master configuration file for Teiid system. This file contains its own documentation, so refer to the file for all the available properties to configure.
This directory contains all the translator JAR and connector RAR files that are supplied as part of the Teiid installation.
Relevant Files
/teiid-security-users.properties
/teiid-security-roles.properties
These files define the allowed users and their defined roles in Teiid using the default security domain. Edit these files to add uses. If you want to use a different security domain look for details in main configuration file.
This file contains the Teiid specific logging contexts to be included in the "jboss-log4j.xml" file. If you need to turn ON or OFF specific logging in Teiid, then copy the contents of this file into "jboss-log4j.xml" in the installation directory. See the Developers Guide for more on customizing logging.
This file has the required files for Teiid JOPR plugin. To see the Teiid's "admin-console", go to http://<host>:<port>/admin-console
This directory contains Teiid runtime specific configuration files and its libraries. These configuration files define VDB deployers, connector binding deployers etc. Typically user never need to edit any files in this directory.
This directory contains Teiid client libraries. It has the Teiid JDBC driver jar, "teiid-7.5-client.jar", and also contains "teiid-hibernate-dialect-7.5.jar" that contains Teiid's Hibernate dialect.
This directory contains some examples of how Teiid can be used. Contains artifacts need by the Quick Start Example. Also contains some sample XML files to define the connectors.