This guide
will assist you in installing Teiid and Teiid Designer projects. If you
have any feedback on how to improve this guide, if you encounter problems, or
if you want to help out, do not hesitate to contact the Teiid / Teiid Designer community
as described in the "What to do if I encounter problems or have
questions?" section.
This script
assumes you have Java JDK 1.6+ (set as JAVA_HOME), and Ant 1.7+ installed.
If you don't,
use the following links to download and install them:
Java: http://java.sun.com/javase/downloads/index.jsp
Ant: http://ant.apache.org/bindownload.cgi
First of all,
you need to download the installer:
teiid-{version}-installer.zip
You can for
example find the latest snapshot release here.
Before running
the setup, if you have any jdbc drivers or other 3rd party jar’s
that need to be deployed for accessing datasources, copy them to the “drivers”
directory. See the readme.txt in
the drivers directory for further explanation.
The easiest
way to get started is to simply run the installation script to install and
setup. Simply go into the install folder and run:
ant install.demo
This will:
NOTE:
if you already have some of the components locally, see section: Manually
installing different components
This
could take a while (REALLY, not kidding, we are downloading an application
server and Eclipse installation). The script however always shows which file it
is downloading (you could for example check whether it is still downloading by
checking the whether the size of the file in question in the teiid-installer/lib
folder is still increasing). If you want to avoid downloading specific
components (because you will not be using them or you already have them
installed somewhere else), check below for running only specific parts of the
demo or directing the installer to an already installed component.
Once
the demo setup has finished, you can start playing with the various components
by starting the demo setup:
ant start.demo
This
will:
Once
everything is started, you can start playing with the Eclipse tooling.
To
install Teiid Designer into your eclipse environment, do the following:
Open
up the process management console:
http://localhost:8080/admin-console
Log
in, using "admin" / "admin" as username / password.
When you are done
Once
you're done playing: ant stop.demo
This
will stop the following:
and
simply close the rest.
You
can always contact the Teiid / Teiid Designer community for assistance.
Email:
teiid-designer-dev@lists.jboss.org or teiid-dev@lists.jboss.org
IRC:
#teiiddesigner or #reiid at irc.freenode.net
Teiid Designer User Forum or Teiid User Forum
Some
common issues are explained below.
Q:
What if the installer complains it cannot download component X?
A:
Are you connected to the internet? Do you have a firewall turned on? Do you
require a proxy? It might be possible that one of the locations we're
downloading the components from is temporarly offline. Try downloading the
components manually (possibly from alternate locations) and put them in the
teiid-installer/lib folder.
Q:
What if the installer complains it cannot extract / unzip a certain
jar/war/zip?
A:
If your download failed while downloading a component, it is possible that the
installer is trying to use an incomplete file. Try deleting the component in
question from the teiid-installer/lib folder and reinstall, so it will be
downloaded again.
Q:
What if I have been changing my installation (and it no longer works) and I
want to start over again with a clean installation?
A:
You can use ant clean.demo to remove all the installed components, so you end
up with a fresh installation again.
Q:
I sometimes see exceptions when trying to stop or restart certain services,
what should I do?
A:
If you see errors during shutdown, are you sure the services were still
running? If you see exceptions during restart, are you sure the service you
started earlier was successfully shutdown? Maybe try killing the services
manually if necessary.
Q:
Something seems to be going wrong when running Eclipse but I have no idea what.
What can I do?
A:
Always check the consoles for output like error messages or stack traces. You
can also check the Eclipse Error Log for exceptions. Try adding an audit logger
to your session to figure out what's happening at runtime, or try debugging
your application.
Q:
Something seems to be going wrong when running the a web-based application
admin-console. What can I do?
A:
You can check the server log for possible exceptions in the
teiid-installer/jboss-${version}/server/default/log directory.
For
all other questions, try contacting the Teiid / Teiid Designer community as
described above.
If
you don't want to use the demo setup, you can also use the individual ant
targets, as described below.
You
need to download and install JBoss AS. If you don't have it installed yet, go
into the install folder and run the installation script:
ant install.jboss
This
will download and install the server in install/jboss-${version} folder. If you
don't want it to download the zip file, you can put the jboss-${version}.zip in
the install/lib folder.
If
you already have it installed somewhere else, in install/build.properties,
change the jboss.home property to the location of your JBoss AS installation.
You
need to download and install Eclipse 3.6.1 If you don't have it installed yet,
run installation script:
ant install.eclipse
This
will download and install eclipse in teiid-installer/eclipse folder. If you
don't want it to download the eclipse file, you can put the file in the
install/lib folder:
eclipse-SDK-3.6.1-linux-gtk.tar.gz
(linux),
eclipse-SDK-3.6.1-win32.zip
(windows), or
eclipse-SDK-3.6.1-macosx-carbon.tar.gz
(mac).
If
you don't want it to download the eclipse GEF file, you can put the
GEF-runtime-3.6.1.zip file in the install/lib folder.
If
you already have it installed somewhere else, in
teiid-installer/build.properties, change the eclipse.home property to the
location of your Eclipse installation.
Startup
JBoss AS:
ant start.jboss
Startup
eclipse:
ant start.eclipse
Once
you're done playing
stop
JBoss AS:
ant stop.jboss
and
simply close all the rest. You can also clean up your installation using:
ant clean.jboss ant clean.eclipse