[teiid-commits] teiid SVN: r2234 - in trunk/documentation/admin-guide: src/main/docbook/en-US and 2 other directories.
teiid-commits at lists.jboss.org
teiid-commits at lists.jboss.org
Tue Jun 15 15:52:01 EDT 2010
Author: rareddy
Date: 2010-06-15 15:52:00 -0400 (Tue, 15 Jun 2010)
New Revision: 2234
Added:
trunk/documentation/admin-guide/src/main/docbook/en-US/admin_guide.xml
trunk/documentation/admin-guide/src/main/docbook/en-US/content/admin-console.xml
trunk/documentation/admin-guide/src/main/docbook/en-US/content/adminshell-introduction.xml
trunk/documentation/admin-guide/src/main/docbook/en-US/content/installation.xml
trunk/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml
trunk/documentation/admin-guide/src/main/docbook/en-US/images/
trunk/documentation/admin-guide/src/main/docbook/en-US/images/admin_console.png
Removed:
trunk/documentation/admin-guide/src/main/docbook/en-US/adminshell_guide.xml
trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml
Modified:
trunk/documentation/admin-guide/pom.xml
Log:
misc: Adding chapters on installation, admin-console and VDB deployment to the "admin-guide".
Modified: trunk/documentation/admin-guide/pom.xml
===================================================================
--- trunk/documentation/admin-guide/pom.xml 2010-06-15 16:49:28 UTC (rev 2233)
+++ trunk/documentation/admin-guide/pom.xml 2010-06-15 19:52:00 UTC (rev 2234)
@@ -36,7 +36,7 @@
</dependency>
</dependencies>
<configuration>
- <sourceDocumentName>adminshell_guide.xml</sourceDocumentName>
+ <sourceDocumentName>admin_guide.xml</sourceDocumentName>
<imageResource>
<directory>${basedir}/src/main/docbook/en-US</directory>
<excludes>
Copied: trunk/documentation/admin-guide/src/main/docbook/en-US/admin_guide.xml (from rev 2230, trunk/documentation/admin-guide/src/main/docbook/en-US/adminshell_guide.xml)
===================================================================
--- trunk/documentation/admin-guide/src/main/docbook/en-US/admin_guide.xml (rev 0)
+++ trunk/documentation/admin-guide/src/main/docbook/en-US/admin_guide.xml 2010-06-15 19:52:00 UTC (rev 2234)
@@ -0,0 +1,59 @@
+<?xml version='1.0' encoding="UTF-8"?>
+<!--
+
+ JBoss, Home of Professional Open Source.
+ Copyright (C) 2008 Red Hat, Inc.
+ Licensed to Red Hat, Inc. under one or more contributor
+ license agreements. See the copyright.txt file in the
+ distribution for a full listing of individual contributors.
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ 02110-1301 USA.
+
+-->
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % CustomDTD SYSTEM "../../../../../docbook/custom.dtd">
+%CustomDTD;
+]>
+
+<book>
+
+ <bookinfo>
+ <title>Teiid - Scalable Information Integration</title>
+ <subtitle>Teiid Administrator's Guide</subtitle>
+ <releaseinfo>&versionNumber;</releaseinfo>
+ <productnumber>&versionNumber;</productnumber>
+ <issuenum>1</issuenum>
+ <copyright>
+ <year>©rightYear;</year>
+ <holder>©rightHolder;</holder>
+ </copyright>
+ <xi:include href="../../../../../docbook/en-US/legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </bookinfo>
+
+ <toc/>
+
+ <xi:include href="content/installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/vdb-deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/admin-console.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/adminshell-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/working-with-scripts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/connection-management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/appendix-a.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="content/appendix-b.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+
+</book>
+
Deleted: trunk/documentation/admin-guide/src/main/docbook/en-US/adminshell_guide.xml
===================================================================
--- trunk/documentation/admin-guide/src/main/docbook/en-US/adminshell_guide.xml 2010-06-15 16:49:28 UTC (rev 2233)
+++ trunk/documentation/admin-guide/src/main/docbook/en-US/adminshell_guide.xml 2010-06-15 19:52:00 UTC (rev 2234)
@@ -1,56 +0,0 @@
-<?xml version='1.0' encoding="UTF-8"?>
-<!--
-
- JBoss, Home of Professional Open Source.
- Copyright (C) 2008 Red Hat, Inc.
- Licensed to Red Hat, Inc. under one or more contributor
- license agreements. See the copyright.txt file in the
- distribution for a full listing of individual contributors.
-
- This library is free software; you can redistribute it and/or
- modify it under the terms of the GNU Lesser General Public
- License as published by the Free Software Foundation; either
- version 2.1 of the License, or (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public
- License along with this library; if not, write to the Free Software
- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- 02110-1301 USA.
-
--->
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
-<!ENTITY % CustomDTD SYSTEM "../../../../../docbook/custom.dtd">
-%CustomDTD;
-]>
-
-<book>
-
- <bookinfo>
- <title>Teiid - Scalable Information Integration</title>
- <subtitle>Teiid Admin Shell User Guide</subtitle>
- <releaseinfo>&versionNumber;</releaseinfo>
- <productnumber>&versionNumber;</productnumber>
- <issuenum>1</issuenum>
- <copyright>
- <year>©rightYear;</year>
- <holder>©rightHolder;</holder>
- </copyright>
- <xi:include href="../../../../../docbook/en-US/legal_notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- </bookinfo>
-
- <toc/>
-
- <xi:include href="content/introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="content/getting-started.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="content/working-with-scripts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="content/connection-management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="content/appendix-a.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="content/appendix-b.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-
-</book>
-
Added: trunk/documentation/admin-guide/src/main/docbook/en-US/content/admin-console.xml
===================================================================
--- trunk/documentation/admin-guide/src/main/docbook/en-US/content/admin-console.xml (rev 0)
+++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/admin-console.xml 2010-06-15 19:52:00 UTC (rev 2234)
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<chapter id="admin-console">
+ <title>Teiid Admin Console</title>
+ <para>Teiid admin console is a web based administrative and monitoring tool for Teiid.
+ This is built using the <ulink url="http://www.jboss.org/embjopr">Embedded JOPR</ulink> library that is built to manage the
+ JBoss AS instances. Teiid adds a additional plugin into the Embeeded JOPR program already available in the
+ <ulink url="http://www.jboss.org/jbossas">JBoss AS</ulink>, to provide the Teiid specific functionality.</para>
+
+ <sect1>
+ <title>What can be monitored and/or configured?</title>
+ <para>Here are the steps to follow to install Teiid</para>
+
+ <orderedlist>
+ <listitem> <para><emphasis>The Teiid Runtime Engine</emphasis> (Data Services node in the tree)</para> </listitem>
+ <listitem> <para><emphasis>VDBs</emphasis> - Virtual databases</para>
+ <orderedlist>
+ <listitem> <para><emphasis>Models</emphasis></para>
+ <orderedlist>
+ <listitem> <para><emphasis>Source</emphasis>- these are physical sources</para></listitem>
+ <listitem> <para><emphasis>Multi-source</emphasis> - these are multiple sourced models</para></listitem>
+ <listitem> <para><emphasis>Logical</emphasis> - these are virtual sources</para></listitem>
+ </orderedlist>
+ </listitem>
+ <listitem> <para><emphasis>Translator instances</emphasis>- any Translator instances defined for use by this VDB</para> </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem> <para>Translators - These are the extensions to supported datasources that come with Teiid out-of-the-box.</para> </listitem>
+ </orderedlist>
+
+ <note>
+ <para>The creation/modification of the datasource is managed by the JBossAS plugin.</para>
+ </note>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="../images/admin_console.png"/>
+ </imageobject>
+ </mediaobject>
+
+ <sect2>
+ <title>Configuration</title>
+ <orderedlist>
+ <listitem> <para>Runtime Engine properties</para> </listitem>
+ <listitem> <para>Buffer Service</para> </listitem>
+ <listitem> <para>Jdbc Socket configuration</para> </listitem>
+ <listitem> <para>Session Service</para> </listitem>
+ </orderedlist>
+ </sect2>
+
+ <sect2>
+ <title>Metrics</title>
+ <orderedlist>
+ <listitem> <para>Long Running Query count</para> </listitem>
+ <listitem> <para>Active Query count</para> </listitem>
+ <listitem> <para>Active Session count</para> </listitem>
+ </orderedlist>
+ </sect2>
+
+ <sect2>
+ <title>Control (Operations)</title>
+ <orderedlist>
+ <listitem> <para>View Long Running Queries</para> </listitem>
+ <listitem> <para>View Current Sessions</para> </listitem>
+ <listitem> <para>Terminate Session</para> </listitem>
+ <listitem> <para>View Current Requests</para> </listitem>
+ <listitem> <para>Terminate requests</para> </listitem>
+ <listitem> <para>View Current Transactions</para> </listitem>
+ <listitem> <para>Terminate Transaction</para> </listitem>
+ </orderedlist>
+ </sect2>
+
+ <sect2 id="vdb_deploy">
+ <title>Deploying the VDB</title>
+ <para>VDB archive files created it the Designer Tool or Dynamic VDBs can be deployed into Teiid server using
+ this "admin-console" tool.</para>
+
+ <orderedlist>
+ <listitem> <para>Select the Virtual Database node in the Admin Console tree and click the Add New Resource button.</para> </listitem>
+ <listitem> <para>Select the VDB archive file from the file system and click continue.</para> </listitem>
+ <listitem> <para>The VDB will deploy if no fatal errors are found in the archive. The status of
+ the VDB will be UP if no errors are found with the models in the VDB.</para> </listitem>
+ <listitem> <para>If there are model errors, the VDB will be deployed with a status of DOWN and the errors will be
+ listed on the configuration tab of the VDB. VDBs that are not UP will be marked with a red X in the tree.</para> </listitem>
+ </orderedlist>
+
+ <para>Only Model's "connection-jndi-name" can be modified using this tool by clicking on the "configuration"
+ tab, all other proeprties are read-only.</para>
+ </sect2>
+
+ </sect1>
+
+</chapter>
\ No newline at end of file
Property changes on: trunk/documentation/admin-guide/src/main/docbook/en-US/content/admin-console.xml
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Copied: trunk/documentation/admin-guide/src/main/docbook/en-US/content/adminshell-introduction.xml (from rev 2230, trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml)
===================================================================
--- trunk/documentation/admin-guide/src/main/docbook/en-US/content/adminshell-introduction.xml (rev 0)
+++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/adminshell-introduction.xml 2010-06-15 19:52:00 UTC (rev 2234)
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<chapter id="adminshell_introduction">
+ <title>Introduction to Admin Tools</title>
+ <para>
+ AdminShell provides scripting based programming environments that enable user to access, monitor and control a Teiid
+ Server. The Shell and Console tools are built on ones provide by the Groovy (
+ <ulink url="http://groovy.codehaus.org/">http://groovy.codehaus.org/</ulink>
+ ) project. The AdminShell tools be used in ad-hoc scripting or to run pre-defined scripts.
+ </para>
+ <orderedlist>
+ <title>AdminShell features:</title>
+ <listitem>
+ <para>fully functional programming environment with resource flow control and exception
+ management. See <ulink url="http://groovy.codehaus.org/">Groovy</ulink> docs for the full power of the language.</para>
+ </listitem>
+ <listitem>
+ <para>quick administrative tool. The user can connect to a running Teiid Server and invoke any of
+ the Admin API methods, such as "deployVDB" or "stopConnectionFactory", to control Teiid System.
+ Since this can be script driven, these tasks can be automated and re-run at a later time.</para>
+ </listitem>
+ <listitem>
+ <para>simplified data access tool. The user can connect to a VDB, issue any SQL commands, and view the
+ results of the query via <ulink url="http://groovy.codehaus.org/Database+features">Groovy Sql</ulink> extensions.</para>
+ </listitem>
+ <listitem>
+ <para>migration tool. This can be used to develop scripts like moving the Virtual Databases
+ (VDB), Connection Factories, and Configuration from one development environment to another. This will
+ enable users to test and automate their migration scripts before production deployments.</para>
+ </listitem>
+ <listitem>
+ <para>testing tool. The JUnit (
+ <ulink url="http://junit.org/">http://junit.org</ulink>
+ ) test framework is built in, see <ulink url="http://groovy.codehaus.org/Unit+Testing">Groovy Unit Tests</ulink>. User can write regression tests for checking system health, or data
+ integrity that can be used to validate a system functionality automatically instead of manual
+ verification by QA personnel.
+ </para>
+ </listitem>
+ </orderedlist>
+ <sect1>
+ <title>Where can you find AdminShell?</title>
+ <para>AdminShell is distributed along with other Teiid downloads under "teiid-{version}-adminshell-dist.zip" name. Download and unzip this
+ file to any directory. Once you have unzipped the file, in root directory
+ you will find "adminshell" and "adminconsole" executable scripts.</para>
+ <para>Windows: Double click or execute "adminshell.cmd"</para>
+ <para>*nix: Execute the "adminshell.sh" script</para>
+ </sect1>
+</chapter>
\ No newline at end of file
Added: trunk/documentation/admin-guide/src/main/docbook/en-US/content/installation.xml
===================================================================
--- trunk/documentation/admin-guide/src/main/docbook/en-US/content/installation.xml (rev 0)
+++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/installation.xml 2010-06-15 19:52:00 UTC (rev 2234)
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<chapter id="installation">
+ <title>Installation Guide</title>
+ <para>Teiid 7.0 installation is entirely different from previous versions. Previously Teiid could be installed
+ as a standalone or embedded server. Starting with this release Teiid needs to be installed into an
+ existing JBoss AS installation. Teiid does not support the "embedded" mode in 7.0 version. ("embedded" version
+ will be coming in a future release soon).
+ </para>
+
+ <sect1>
+ <title>Installation:</title>
+ <para>Here are the steps to follow to install Teiid</para>
+ <orderedlist numeration="arabic">
+ <listitem>
+ <para>Download the <ulink url="http://www.jboss.org/jbossas/downloads.html">JBoss AS 5.1.0</ulink> application server.
+ Install the server by unzipping into a known location. Ex: /apps/jboss-5.1.0</para>
+ </listitem>
+ <listitem>
+ <para>Download <ulink url="http://www.jboss.org/teiid/downloads.html">Teiid 7.0</ulink>. Unzip the downloaded artifact inside any "profiles"
+ inside the JBoss AS installation. We suggest using either "default" or "all".
+ Teiid 7.0 for the administrative purposes uses a service called "profile service" that
+ is only installed in "default" and "all" profiles, so installing into one of these
+ profiles is required. Ex: /apps/jboss-5.10/server/default</para>
+ </listitem>
+
+ <listitem>
+ <para>Start the JBoss AS server by executing "/apps/jboss-5.1.0/bin/run.sh" if you installed in the
+ "default" profile. Other wise use "/apps/jboss-5.1.0/bin/run.sh -c <profilename>"
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>That it!. JBoss AS and Teiid are now installed and running. See below instructions to customize various settings.</para>
+ </listitem>
+
+ <listitem>
+ <para>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".
+ </para>
+ </listitem>
+ </orderedlist>
+ </sect1>
+ <sect1>
+ <title>Directory Structure Explained</title>
+ <para>The below file structure shows the contents of the Teiid 7.0 deployment. This directory
+ structure is "exactly" same as what is under any JBoss profile directory structure like "default"</para>
+
+ <programlisting><![CDATA[
+ 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
+ ]]></programlisting>
+
+ <sect2>
+ <title>/deploy/teiid/teiid-jboss-beans.xml</title>
+ <para>Master configuration file for Teiid system. This file contains its own documentation,
+ so refer to the file for all the available properties to configure.</para>
+ </sect2>
+
+ <sect2>
+ <title>/deploy/teiid/connectors</title>
+ <para>This directory contains all the connector RAR files that are supplied as part of the Teiid installation.</para>
+ </sect2>
+
+ <sect2>
+ <title>/conf/props</title>
+ <para> /teiid-security-users.properties</para>
+ <para> /teiid-security-roles.properties</para>
+ <para>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.</para>
+ </sect2>
+
+ <sect2>
+ <title>/conf/jboss-teiid-log4j.xml</title>
+ <para>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 Server Extension Guide for more on logging.</para>
+ </sect2>
+
+ <sect2>
+ <title>admin-console.war</title>
+ <para>This file has the required files for Teiid JOPR plugin. To see the
+ Teiid's "admin-console", go to http://<host>:<port>/admin-console</para>
+ </sect2>
+
+ <sect2>
+ <title>/deployers/teiid.deployer</title>
+ <para>This directory contains all the connector RAR files that are supplied as part of the Teiid installation.</para>
+ </sect2>
+
+ <sect2>
+ <title>/deploy/teiid/connectors</title>
+ <para>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.</para>
+ </sect2>
+
+ <sect2>
+ <title>lib</title>
+ <para>This directory contains Teiid client libraries. It has the Teiid JDBC driver jar, "teiid-{version}-client.jar",
+ and also contains "teiid-hibernate-dialect-{version}.jar" that contains Teiid's Hibernate dialect.</para>
+ </sect2>
+
+ <sect2>
+ <title>teiid-examples</title>
+ <para>This directory contains some examples of how Teiid can be used. Contains artifacts
+ need by the Getting Started Guide. Also contains some sample XML files to define the connectors.</para>
+ </sect2>
+
+ <sect2>
+ <title>teiid-docs</title>
+ <para>This directory contains the PDF documents related Teiid and Teiid development. </para>
+ </sect2>
+
+ </sect1>
+
+</chapter>
\ No newline at end of file
Property changes on: trunk/documentation/admin-guide/src/main/docbook/en-US/content/installation.xml
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Deleted: trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml
===================================================================
--- trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml 2010-06-15 16:49:28 UTC (rev 2233)
+++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/introduction.xml 2010-06-15 19:52:00 UTC (rev 2234)
@@ -1,48 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="introduction">
- <title>Introduction to Admin Tools</title>
- <para>
- AdminShell provides scripting based programming environments that enable user to access, monitor and control a Teiid
- Server. The Shell and Console tools are built on ones provide by the Groovy (
- <ulink url="http://groovy.codehaus.org/">http://groovy.codehaus.org/</ulink>
- ) project. The AdminShell tools be used in ad-hoc scripting or to run pre-defined scripts.
- </para>
- <orderedlist>
- <title>AdminShell features:</title>
- <listitem>
- <para>fully functional programming environment with resource flow control and exception
- management. See <ulink url="http://groovy.codehaus.org/">Groovy</ulink> docs for the full power of the language.</para>
- </listitem>
- <listitem>
- <para>quick administrative tool. The user can connect to a running Teiid Server and invoke any of
- the Admin API methods, such as "deployVDB" or "stopConnectionFactory", to control Teiid System.
- Since this can be script driven, these tasks can be automated and re-run at a later time.</para>
- </listitem>
- <listitem>
- <para>simplified data access tool. The user can connect to a VDB, issue any SQL commands, and view the
- results of the query via <ulink url="http://groovy.codehaus.org/Database+features">Groovy Sql</ulink> extensions.</para>
- </listitem>
- <listitem>
- <para>migration tool. This can be used to develop scripts like moving the Virtual Databases
- (VDB), Connection Factories, and Configuration from one development environment to another. This will
- enable users to test and automate their migration scripts before production deployments.</para>
- </listitem>
- <listitem>
- <para>testing tool. The JUnit (
- <ulink url="http://junit.org/">http://junit.org</ulink>
- ) test framework is built in, see <ulink url="http://groovy.codehaus.org/Unit+Testing">Groovy Unit Tests</ulink>. User can write regression tests for checking system health, or data
- integrity that can be used to validate a system functionality automatically instead of manual
- verification by QA personnel.
- </para>
- </listitem>
- </orderedlist>
- <sect1>
- <title>Where can you find AdminShell?</title>
- <para>AdminShell is distributed along with other Teiid downloads under "teiid-{version}-adminshell-dist.zip" name. Download and unzip this
- file to any directory. Once you have unzipped the file, in root directory
- you will find "adminshell" and "adminconsole" executable scripts.</para>
- <para>Windows: Double click or execute "adminshell.cmd"</para>
- <para>*nix: Execute the "adminshell.sh" script</para>
- </sect1>
-</chapter>
\ No newline at end of file
Added: trunk/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml
===================================================================
--- trunk/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml (rev 0)
+++ trunk/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml 2010-06-15 19:52:00 UTC (rev 2234)
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<chapter id="vdb-deployment">
+ <title>Deploying VDBs in Teiid 7</title>
+ <para>
+ A <ulink url="http://www.jboss.org/teiid/basics/virtualdatabases.html">VDB</ulink>is the primary means to define a
+ Virtual Database in Teiid. A user can create a VDB using
+ <ulink url="http://www.jboss.org/teiiddesigner.html">Teiid Designer</ulink> or follow the instructions in the "reference" guide
+ create a "Dynamic VDB" without Designer for data integration purposes. If you do not know what a VDB is,
+ then please start with these <ulink url="http://www.jboss.org/teiid/basics/virtualdatabases.html">documents</ulink>
+ </para>
+
+ <sect1>
+ <title>Deploying a VDB</title>
+ <para>Once you have a "VDB" built it can be deployed in Teiid runtime in different ways.</para>
+
+ <sect2>
+ <title>By Copying the File</title>
+ <para>Copy the VDB file into the "<jboss-install>/server/<profile>/deploy" directory.
+ Make sure that there are no other VDB files with the same name. If a VDB already exists with
+ the same name, then this VDB will be replaced with the new VDB. T
+ his is the simplest way to deploy a VDB.</para>
+ </sect2>
+
+ <sect2>
+ <title>By Using Admin API</title>
+ <para>The Admin API (look in org.teiid.adminpi.*) provides Java API methods that
+ let's a user connect to a Teiid runtime and deploy a VDB. If you need to programmatically deploy a VDB use this method.</para>
+ </sect2>
+
+ <sect2>
+ <title>By Using Admin Shell</title>
+ <para>Teiid provides "groovy" based Admin Shell scripting tool, which can be used to deploy
+ a VDB. Check out the "deployVDB" method. Check out more information about <emphasis>Admin Shell</emphasis>
+ <link linkend="adminshell_introduction">here</link>. </para>
+ </sect2>
+
+ <sect2>
+ <title>By Using Admin-Console (JOPR Based Web tool )</title>
+ <para>Use the JOPR-based web console configuration system, which will enable users to connect
+ to a running Teiid and provide a way to deploy a VDB. Check out the JOPR plugin at:</para>
+
+ <programlisting><![CDATA[
+ http://<host>:<port>/admin-console
+ ]]></programlisting>
+ </sect2>
+ </sect1>
+
+ <para>Option 1 can be used for local development VDB deployment or deployment in a
+ manually controlled environment. Options 2, 3 and 4 can be used when your Teiid runtime
+ instance is a remote instance or if you need a programmatic way to control your deployment.</para>
+
+ <sect1>
+ <title>Deploying VDB Dependencies</title>
+ <para>Apart from deploying the VDB, the user is also responsible for providing all the necessary
+ dependent libraries, configuration for creating the data sources that are needed by the Schemas (models)
+ defined in "META-INF/vdb.xml" file inside your VDB. This section shows you a sample VDB configuration needed.</para>
+
+ <para>For example, if you are trying to integrate Oracle and File sources in your VDB, then you are responsible for
+ providing the JDBC driver for the Oracle source, and any necessary documents and configuration that are needed by the File Translator.</para>
+
+ <sect2>
+ <title>Creating Oracle Data source</title>
+ <orderedlist>
+ <listitem> <para>Copy the Oracle JDBC JAR file into "<jboss-install>/server/<profile>/lib" directory </para> </listitem>
+ <listitem> <para>Create a "data source" to the Oracle instance in the JBoss container. This typically
+ done by creating "xxx-ds.xml" file and copying this file to the "<jboss-install>/server/%lt;profile>/deploy"
+ directory. The following shows a "-ds.xml" file template for Oracle. You can also use admin-console to create this data source. </para>
+ <programlisting><![CDATA[
+ <?xml version="1.0" encoding="UTF-8"?>
+ <datasources>
+ <xa-datasource>
+ <jndi-name>OracleDS</jndi-name>
+ <!-- uncomment to enable interleaving <interleaving/> -->
+ <isSameRM-override-value>false</isSameRM-override-value>
+ <xa-datasource-class>oracle.jdbc.xa.client.OracleXADataSource</xa-datasource-class>
+ <xa-datasource-property name="URL">jdbc:oracle:oci8:@tc</xa-datasource-property>
+ <xa-datasource-property name="User">scott</xa-datasource-property>
+ <xa-datasource-property name="Password">tiger</xa-datasource-property>
+ <!-- Uses the pingDatabase method to check a connection is still valid before handing it out from the pool -->
+ <!--valid-connection-checker-class-name>org.jboss.resource.adapter.jdbc.vendor.OracleValidConnectionChecker</valid-connection-checker-class-name-->
+ <!-- Checks the Oracle error codes and messages for fatal errors -->
+ <exception-sorter-class-name>org.jboss.resource.adapter.jdbc.vendor.OracleExceptionSorter</exception-sorter-class-name>
+ <!-- Oracles XA datasource cannot reuse a connection outside a transaction once enlisted in a global transaction and vice-versa -->
+ <no-tx-separate-pools/>
+ <!-- corresponding type-mapping in the standardjbosscmp-jdbc.xml (optional) -->
+ <metadata>
+ <type-mapping>Oracle9i</type-mapping>
+ </metadata>
+ </xa-datasource>
+ </datasources>
+ ]]></programlisting>
+ </listitem>
+ </orderedlist>
+ <para>There are templates for all the data sources in the "<jboss-install>/docs/examples/jca" directory.</para>
+
+ </sect2>
+ <sect2>
+ <title>Creating File Data source</title>
+ <para>File data source uses Teiid specific JCA connector. You need to create "-ds.xml" file and copy it to the
+ "<jboss-install>/server/%lt;profile>/deploy" directory. The below is template for creating a File based data source</para>
+
+ <programlisting><![CDATA[
+ <?xml version="1.0" encoding="UTF-8"?>
+ <connection-factories>
+ <no-tx-connection-factory>
+ <jndi-name>text-source</jndi-name>
+ <rar-name>connector-file-{version}.rar</rar-name>
+ <connection-definition>javax.resource.cci.ConnectionFactory</connection-definition>
+ <config-property name="ParentDirectory" type="java.lang.String">path-to-the-directory-of-data-file</config-property>
+ <max-pool-size>1</max-pool-size>
+ </no-tx-connection-factory>
+ </connection-factories>
+ ]]></programlisting>
+ </sect2>
+ </sect1>
+
+ <para>Once the VDB and its dependencies are deployed, then your client application can connect to the
+ deployed VDB using the JDBC API. If there are any errors in the deployment, the connection will not be successful. You can use the
+ <link linkend="admin-console">admin-console</link> tool or check the log files for errors and correct them before proceeding.</para>
+
+ <sect1>
+ <title>Migrating VDBs from 6.x</title>
+ <para>VDBs from prior release contain an older configuration file version that is no longer supported.
+ You can use the migration utility (bin/migrate.sh or bin/migrate.bat) supplied with the
+ <link linkend="adminshell_introduction">Admin Shell</link> download
+ to update these VDBs for use with Teiid 7. Note - XML and File based sources from previous releases are changed, so do not work
+ as is. The VDB models need to be updated for this as these are breaking changes.</para>
+ </sect1>
+
+</chapter>
\ No newline at end of file
Property changes on: trunk/documentation/admin-guide/src/main/docbook/en-US/content/vdb-deployment.xml
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Added: trunk/documentation/admin-guide/src/main/docbook/en-US/images/admin_console.png
===================================================================
(Binary files differ)
Property changes on: trunk/documentation/admin-guide/src/main/docbook/en-US/images/admin_console.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
More information about the teiid-commits
mailing list