You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafodion.apache.org by db...@apache.org on 2016/05/05 23:39:44 UTC
[13/22] incubator-trafodion git commit: Prepared documents for TLP
and centralized shared information.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc b/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc
index 21f7156..fe68028 100644
--- a/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc
+++ b/docs/messages_guide/src/asciidoc/_chapters/udr_language_mgr_msgs.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[udr-server-and-language-manager-messages]]
@@ -35,11 +35,11 @@ MXUDR: Unable to allocate memory for object <object-name>.
Where <object-name> is the name of the object.
-*Cause:* The Trafodion UDR server was not able to obtain enough memory to allocate the named object.
+*Cause:* The {project-name} UDR server was not able to obtain enough memory to allocate the named object.
-*Effect:* The request message is rejected, and the Trafodion statement fails.
+*Effect:* The request message is rejected, and the {project-name} statement fails.
-*Recovery:* Stop and start the client process to restart a new Trafodion UDR server,
+*Recovery:* Stop and start the client process to restart a new {project-name} UDR server,
and retry the stored procedure call.
[[SQL-11201]]
@@ -57,10 +57,10 @@ method was not found.
*Effect:* The operation fails.
-*Recovery:* Check the installation of the Trafodion platform for Java
-product and the Trafodion language manager. Verify the
+*Recovery:* Check the installation of the {project-name} platform for Java
+product and the {project-name} language manager. Verify the
existence of the specified class. Stop and restart the session, and
-retry the Trafodion statement.
+retry the {project-name} statement.
<<<
[[SQL-11202]]
@@ -74,8 +74,8 @@ Language Manager initialization failed. Details: Unable to initialize the Java v
*Effect:* The operation fails.
-*Recovery:* Check the installation of the Trafodion platform for Java
-product. Stop and restart the session, and retry the Trafodion statement.
+*Recovery:* Check the installation of the {project-name} platform for Java
+product. Stop and restart the session, and retry the {project-name} statement.
[[SQL-11221]]
== SQL 11221
@@ -85,11 +85,11 @@ Language Manager is out of memory <string>.
```
*Cause:* The language manager could not acquire enough memory to
-complete its work on the Trafodion statement.
+complete its work on the {project-name} statement.
*Effect:* The operation fails.
-*Recovery:* Stop and restart the session and retry the Trafodion
+*Recovery:* Stop and restart the session and retry the {project-name}
statement.
<<<
@@ -100,13 +100,13 @@ statement.
The operation failed because the Java Virtual Machine ran out of memory.
```
-*Cause:* The Java Virtual Machine, hosted by a Trafodion UDR
+*Cause:* The Java Virtual Machine, hosted by a {project-name} UDR
server, did not have enough memory to execute a Java method. This error
condition will be accompanied by another condition that shows when the
Java Virtual Machine encountered the error.
*Effect:* The operation fails.
-*Recovery:* Stop and restart the session and retry the Trafodion statement.
+*Recovery:* Stop and restart the session and retry the {project-name} statement.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/messages_guide/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/messages_guide/src/asciidoc/index.adoc b/docs/messages_guide/src/asciidoc/index.adoc
index 7bd23e8..1cedf3b 100644
--- a/docs/messages_guide/src/asciidoc/index.adoc
+++ b/docs/messages_guide/src/asciidoc/index.adoc
@@ -32,7 +32,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
:images: ../images
:sourcedir: ../../resources/source
@@ -43,22 +44,10 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-*License Statement*
+include::../../shared/license.txt[]
-Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
-specific language governing permissions and limitations under the License.
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/pom.xml
----------------------------------------------------------------------
diff --git a/docs/odb_user/pom.xml b/docs/odb_user/pom.xml
index c154229..0ad3324 100644
--- a/docs/odb_user/pom.xml
+++ b/docs/odb_user/pom.xml
@@ -183,6 +183,10 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -201,6 +205,10 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc b/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc
index 0bc5184..113718b 100644
--- a/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/a_warnings.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
== A. Troubleshooting
@@ -89,7 +89,7 @@ then you should use an *empty string* as catalog name.
+
NOTE: Some flawed ODBC Drivers unfortunately want NULL here — instead of *empty strings* as it should be.
-5. You can have errors loading `TIME(N)` fields with` N>0` under Trafodion because the
+5. You can have errors loading `TIME(N)` fields with` N>0` under {project-name} because the
ODBC Driver does not manage the field display size when `N>0`.
6. If you have problems starting odb on Unix/Linux check:
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/about.adoc b/docs/odb_user/src/asciidoc/_chapters/about.adoc
index 5e418ff..9b00e47 100644
--- a/docs/odb_user/src/asciidoc/_chapters/about.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/about.adoc
@@ -20,20 +20,20 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
-This guide describes how to use odb, a multi-threaded, ODBC-based command-line tool, to perform various operations on a Trafodion
+This guide describes how to use odb, a multi-threaded, ODBC-based command-line tool, to perform various operations on a {project-name}
database.
-NOTE: In Trafodion Release 1.3, only loading, extracting, and copying data operations are production ready, meaning that that have
+NOTE: In {project-name} Release 1.3, only loading, extracting, and copying data operations are production ready, meaning that that have
been fully tested and are ready to be used in a production environment. +
+
Other features are designated as _Technology Preview_ meaning that they have not been fully tested and are not ready for production use.
== Intended Audience
-This guide is intended for database administrators and other users who want to run scripts that operate on a Trafodion database, primarily for
+This guide is intended for database administrators and other users who want to run scripts that operate on a {project-name} database, primarily for
parallel data loading.
== New and Changed Information
@@ -167,20 +167,8 @@ match-value [NOT] LIKE _pattern
[ESCAPE esc-char-expression]
```
-== Publishing History
-[cols="2*",options="header"]
-|===
-| Product Version | Publication Date
-| Trafodion Release 1.3.0 | To be announced.
-|===
-
-<<<
== Comments Encouraged
-The Trafodion community encourages your comments concerning this document. We are committed to providing documentation that meets your
-needs. Send any errors found, suggestions for improvement, or compliments to:
-
-issues@trafodion.incubator.apache.org
+We encourage your comments concerning this document. We are committed to providing documentation that meets your
+needs. Send any errors found, suggestions for improvement, or compliments to {project-support}.
Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
-Or, even better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc b/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc
index c427652..21b8e11 100644
--- a/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/b_develop.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
<<<
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc b/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc
index 5d2e1b3..32a1a6d 100644
--- a/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/compare_tables.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Comparing Tables (Technology Preview)
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/concepts.adoc b/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
index 8faff01..5a79855 100644
--- a/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/concepts.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Basic Concepts
@@ -107,7 +107,7 @@ Data loading options [connection required]:
* pc: no default. Also <ASCII_dec> 0<ASCII_OCT> X<ASCII_HEX>
* direct: only for Vertica databases
* bpc: default 1,bpwc: default 4
- * loadcmd: default IN. only for Trafodion databases
+ * loadcmd: default IN. only for {project-name} databases
Data extraction options [connection required]:
-e {src={table|-file}|sql=<custom sql>}:tgt=[+]file[:pwhere=where_cond]
[:fs=fieldsep][:rs=recsep][:sq=stringqualifier][:ec=escape_char][:soe]
@@ -139,7 +139,7 @@ Data copy options [connection required]:
* ucs2toutf8: default is 'skip'
* roe: default 3 if no arguments
* bpc: default 1,bpwc: default 4
- * loadcmd: default IN. only for Trafodion databases
+ * loadcmd: default IN. only for {project-name} databases
Data pipe options [connection required]:
-pipe sql={[sqlcmd]|@sqlscript|-file}:tgtsql={@sqlfile|[sqlcmd]}[:soe]
[:rows=#rowset][:nomark][:max=#max_rec][:bpc=#][:bpwc=#][:errdmp=file]
@@ -314,7 +314,7 @@ Describing: TRAFODION.MAURIZIO.T11
The `INDEX` column (when using type `T`) contains the following information:
-* `name` of the `INDEX` (in Trafodion indexes having the same name as the table are Primary Keys).
+* `name` of the `INDEX` (in {project-name} indexes having the same name as the table are Primary Keys).
* `ordinal number` to identify the order of that field in the index.
* `(U)nique o (M)ultiple` values allowed.
* `(+)` means that more than one index includes that field.
@@ -806,7 +806,7 @@ If you have 16 threads and `\u2013d MYDSN`:
| `15` | `MYDSN8` | `MYDSN8`
|===
-This technique has been used to maximize extraction throughput from a multi-segment Trafodion system.
+This technique has been used to maximize extraction throughput from a multi-segment {project-name} system.
Each (local) Data Source was *linked* to a corresponding remote Data Source extracting its own data through its
own network interface card.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/install.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/install.adoc b/docs/odb_user/src/asciidoc/_chapters/install.adoc
index b6df5b9..d505a49 100644
Binary files a/docs/odb_user/src/asciidoc/_chapters/install.adoc and b/docs/odb_user/src/asciidoc/_chapters/install.adoc differ
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/introduction.adoc b/docs/odb_user/src/asciidoc/_chapters/introduction.adoc
index 3357f21..d34b48d 100644
--- a/docs/odb_user/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/introduction.adoc
@@ -1,23 +1,23 @@
////
/**
- *@@@ START COPYRIGHT @@@
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * @@@ END COPYRIGHT @@@
- */
+*@@@ START COPYRIGHT @@@
+* Licensed to the Apache Software Foundation (ASF) under one
+* or more contributor license agreements. See the NOTICE file
+* distributed with this work for additional information
+* regarding copyright ownership. The ASF licenses this file
+* to you under the Apache License, Version 2.0 (the
+* "License"); you may not use this file except in compliance
+* with the License. You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+* @@@ END COPYRIGHT @@@
+*/
////
= Introduction
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/load.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/load.adoc b/docs/odb_user/src/asciidoc/_chapters/load.adoc
index b735b7a..9d2f669 100644
--- a/docs/odb_user/src/asciidoc/_chapters/load.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/load.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= Load, Extract, Copy
@@ -41,7 +41,7 @@ This command:
* using `|` (vertical bar) as a field separator (`fs=\|`)
* using `1000 rows` as row-set buffer (`rows=1000`)
* using `UPSERT USING LOAD` syntax to achieve better throughput as described in
-http://trafodion.incubator.apache.org/docs/load_transform/index.html[Trafodion Load and Transform Guide]
+{docs-url}/load_transform/index.html[{project-name} Load and Transform Guide]
* truncating the target table before loading (`truncate`)
* using `4 parallel threads` to load the target table (`parallel=4`)
@@ -162,7 +162,7 @@ specified, then odb loads node-attributes values.
odb loads the first node/attribute to the first column, the second node/attribute to the second column and so on without checking node/attribute names.
| `xmldump` | odb does not load the XML file content. Instead, XML attribute/tage names are printed to standard output so you can check
what is going to be loaded.
-| `loadcmd` | SQL operation to be used for load. (Default: `INSERT`). `UPSERT` and `UPSERT USING LOAD` are also available for Trafodion.
+| `loadcmd` | SQL operation to be used for load. (Default: `INSERT`). `UPSERT` and `UPSERT USING LOAD` are also available for {project-name}.
|===
You can load multiple files using different `-l` options. By default odb creates as many threads (and ODBC connections) as the sum of
@@ -558,7 +558,7 @@ has generated and loaded 1M rows of _realistic_ data in about ten seconds:
== Load Default Values
The simpler way to load database generated defaults is to ignore the associated columns in the map file. For example, suppose you have a
-table like this under Trafodion:
+table like this under {project-name}:
```
create table TRAFODION.maurizio.dtest
@@ -928,7 +928,7 @@ features *for each extraction thread*. +
+
*Examples* +
+
-1. You want *Trafodion* to ignore missing stats warning. Then you can run via `mpre` a SQL script containing: +
+1. You want *{project-name}* to ignore missing stats warning. Then you can run via `mpre` a SQL script containing: +
+
`control query default HIST_MISSING_STATS_WARNING_LEVEL '0';` +
+
@@ -975,7 +975,7 @@ Please note the `src=-tlist.txt`.
<<<
== Copy Tables From One Database to Another
-odb can directly copy tables from one data-source to another. For example, from Trafodion to Teradata or vice-versa).
+odb can directly copy tables from one data-source to another. For example, from {project-name} to Teradata or vice-versa).
Data *_never lands to disk_* when using this option.
The target table has to be be created in advance and should have a compatible structure.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc b/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc
index c331107..ce49729 100644
--- a/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/query_driver.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= odb as a Query Driver (Technology Preview)
@@ -112,7 +112,7 @@ SET QLABEL <label>
```
~/Devel/odb $ cat script.sql
--- Trafodion TPC-H Query 1 SET QLABEL Q01
+-- {project-name} TPC-H Query 1 SET QLABEL Q01
SELECT
L_RETURNFLAG
, L_LINESTATUS
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc b/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc
index 491afd7..0be4a07 100644
--- a/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc
+++ b/docs/odb_user/src/asciidoc/_chapters/sql_interpreter.adoc
@@ -20,7 +20,7 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= odb as a SQL Interpreter (Technology Preview)
@@ -101,7 +101,7 @@ will be just prepared, not executed.
<<<
10. Different databases use different commands to set default schema(s):
-* Trafodion: `set schema <name>;`
+* {project-name}: `set schema <name>;`
* MySQL: `use <name>;`
* PostgreSQL/Vertica: `set search_path to <name1,name2,\u2026>;`
* Teradata: `set database <name>;`
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/odb_user/src/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/docs/odb_user/src/asciidoc/index.adoc b/docs/odb_user/src/asciidoc/index.adoc
index 84ae2f9..e07063c 100644
--- a/docs/odb_user/src/asciidoc/index.adoc
+++ b/docs/odb_user/src/asciidoc/index.adoc
@@ -33,7 +33,8 @@
:experimental:
:source-language: text
:revnumber: {project-version}
-:title-logo-image: ../../../shared/trafodion-logo.jpg
+:title-logo-image: {project-logo}
+:project-name: {project-name}
// Define variables used in the document.
:images: ../images
@@ -43,22 +44,10 @@
// processing of files found in directories starting with an _. This
// prevents each chapter being built as its own book.
-**License Statement**
+include::../../shared/license.txt[]
-Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
-specific language governing permissions and limitations under the License.
-
-[cols="2",options="header"]
-|===
-| Version | Date
-| 1.3.0 | January, 2016
-|===
+<<<
+include::../../shared/revisions.txt[]
include::asciidoc/_chapters/about.adoc[]
include::asciidoc/_chapters/introduction.adoc[]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/pom.xml
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/pom.xml b/docs/provisioning_guide/pom.xml
index eb7b4c3..70f80b0 100644
--- a/docs/provisioning_guide/pom.xml
+++ b/docs/provisioning_guide/pom.xml
@@ -184,6 +184,11 @@
<!-- Location of centralized stylesheet -->
<stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
+ <download-url>http://trafodion.incubator.apache.org/download.html</download-url>
<build-date>${maven.build.timestamp}</build-date>
<google-analytics-account>UA-72491210-1</google-analytics-account>
</attributes>
@@ -202,6 +207,11 @@
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
<project-version>${env.TRAFODION_VER}</project-version>
+ <project-name>Trafodion</project-name>
+ <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo>
+ <project-support>user@trafodion.incubator.apache.org</project-support>
+ <docs-url>http://trafodion.incubator.apache.org/docs</docs-url>
+ <download-url>http://trafodion.incubator.apache.org/download.html</download-url>
<build-date>${maven.build.timestamp}</build-date>
<pdf-stylesdir>${basedir}/../shared</pdf-stylesdir>
<pdf-style>trafodion</pdf-style>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc
index b5a67e9..c751ed3 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/about.adoc
@@ -20,35 +20,35 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
= About This Document
-This guide describes how to provision the end-user Trafodion binaries on top of an existing Hadoop environment. This install allows you to store and query data using Trafodion, either via Trafodion clients
-(see http://trafodion.incubator.apache.org/client_install/index.html[Trafodion Client Installation Guide] or via application code you write.
+This guide describes how to provision the end-user {project-name} binaries on top of an existing Hadoop environment. This install allows you to store and query data using {project-name}, either via {project-name} clients
+(see {docs-url}/client_install/index.html[{project-name} Client Installation Guide] or via application code you write.
If you want to install a Trafodion developer-build environment, then please refer to the
http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for instructions.
== Intended Audience
This guide assumes that you are well-versed in Linux and Hadoop administration. If you don't have such experience, then
-you should consider going through the steps required to install a Hadoop environment before attempting to install Trafodion.
+you should consider going through the steps required to install a Hadoop environment before attempting to install {project-name}.
The instructions contained herein apply to the following environments.
-* *Single-Node Environments*: Typically used when you want to evaluate Trafodion.
-* *Cluster (Multi-Node) Environments*: Typically used when you deploy Trafodion for application usage.
+* *Single-Node Environments*: Typically used when you want to evaluate {project-name}.
+* *Cluster (Multi-Node) Environments*: Typically used when you deploy {project-name} for application usage.
-NOTE: Trafodion can be provisioned on a single-node or multi-node environment. Unless specifically noted, the term *cluster* is used
+NOTE: {project-name} can be provisioned on a single-node or multi-node environment. Unless specifically noted, the term *cluster* is used
to mean both single- and multi-node environments.
The provisioning instructions applies to a diverse set of platforms:
-* *Virtual Machines*: Often used for evaluations and Trafodion development.
+* *Virtual Machines*: Often used for evaluations and {project-name} development.
* *Cloud*: Used for Product Environments as well as for Developer Environments.
* *Bare Metal*: Used for Product Environments as well as for Developer Environments.
-NOTE: The term *node* is used to represent a computing platform on which operating system, Hadoop, and Trafodion software is running.
+NOTE: The term *node* is used to represent a computing platform on which operating system, Hadoop, and {project-name} software is running.
Unless specifically qualified (bare-metal node, virtual-machine node, or cloud-node), *node* represents a computing platform in your cluster
regardless of platform type.
@@ -181,19 +181,8 @@ match-value [NOT] LIKE _pattern
[ESCAPE esc-char-expression]
```
-== Publishing History
-[cols="2*",options="header"]
-|===
-| Product Version | Publication Date
-| Trafodion Release 1.3.0 | January 2016.
-|===
-
== Comments Encouraged
-The Trafodion community encourages your comments concerning this document. We are committed to providing documentation that meets your
-needs. Send any errors found, suggestions for improvement, or compliments to:
-
-issues@trafodion.incubator.apache.org
+We encourage your comments concerning this document. We are committed to providing documentation that meets your
+needs. Send any errors found, suggestions for improvement, or compliments to {project-support}.
-Include the document title and any comment, error found, or suggestion for improvement you have concerning this document. Or, even
-better, join our community and help us improve our documentation. Please refer to
-http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details.
+Include the document title and any comment, error found, or suggestion for improvement you have concerning this document.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc
index 56cecdd..1e5017a 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/activate.adoc
@@ -20,30 +20,30 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[activate]]
= Activate
[[activate-manage-trafodion]]
-== Manage Trafodion
+== Manage {project-name}
-You use the Trafodion runtime user ID to perform Trafodion management operations.
+You use the {project-name} runtime user ID to perform {project-name} management operations.
-The following table provides an overview of the different Trafodion management scripts.
+The following table provides an overview of the different {project-name} management scripts.
[cols="40%,20%l,20%l,20%l",options="header"]
|===
| Component | Start | Stop | Status
-| *All of Trafodion* | sqstart | sqstop | sqcheck
+| *All of {project-name}* | sqstart | sqstop | sqcheck
| *RMS Server* | rmsstart | rmsstop | rmscheck
| *REST Server* | reststart | reststop | -
| *LOB Server* | lobstart | lobstop | -
| *DCS (Database Connectivity Services)* | dcsstart | dcsstop | dcscheck
|===
-*Example: Start Trafodion*
+*Example: Start {project-name}*
```
cd $MY_SQROOT/sql/scripts
@@ -52,13 +52,13 @@ sqcheck
```
[[activate-validate-trafodion-installation]]
-== Validate Trafodion Installation
+== Validate {project-name} Installation
You can use sqlci (part of the base product) or trafci (requires separate install; see the
-http://trafodion.apache.org/docs/client_install/index.html[Trafodion Client Installation Guide]) to validate your installation.
+{docs-url}/client_install/index.html[{project-name} Client Installation Guide]) to validate your installation.
=== Smoke Test
-A simple smoke test to validate that Trafodion is functioning.
+A simple smoke test to validate that {project-name} is functioning.
```
get schemas;
@@ -126,9 +126,9 @@ $
<<<
Assuming no errors, your installation has been successful. Next, do the following:
-* Install the Trafodion client software. Refer to the http://trafodion.apache.org/docs/client_install/index.html[Trafodion Client Installation Guide].
-* Use Trafodion. Refer to the http://trafodion.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual.]
-* Review other Trafodion documentation. Refer to the http://trafodion.apache.org/documentation.html[Trafodion documentation].
+* Install the {project-name} client software. Refer to the {docs-url}/client_install/index.html[{project-name} Client Installation Guide].
+* Use {project-name}. Refer to the {docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual.]
+* Review other {project-name} documentation. Refer to the http://trafodion.apache.org/documentation.html[{project-name} documentation].
[[activate-troubleshooting-tips]]
== Troubleshooting Tips
@@ -139,9 +139,9 @@ If you are not able to start up the environment or if there are problems running
If processes are not running as expected, then:
-* `sqstop` to shut down Trafodion. If some Trafodion processes do not terminate cleanly, then run `ckillall`.
-* `sqstart` to restart Trafodion.
+* `sqstop` to shut down {project-name}. If some {project-name} processes do not terminate cleanly, then run `ckillall`.
+* `sqstart` to restart {project-name}.
If problems persist please review logs:
-* `$MY_SQROOT/logs`: Trafodion logs.
+* `$MY_SQROOT/logs`: {project-name} logs.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc
index 752e025..f46d825 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/enable_security.adoc
@@ -20,27 +20,27 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[enable-security]]
= Enable Security
-If you do not enable security in Trafodion, then a client interface to Trafodion may request a user name and password,
-but Trafodion ignores the user name and password entered in the client interface, and the session runs as the database *root* user,
+If you do not enable security in {project-name}, then a client interface to {project-name} may request a user name and password,
+but {project-name} ignores the user name and password entered in the client interface, and the session runs as the database *root* user,
`DB__ROOT`, without restrictions. If you want to restrict users, restrict access to certain users only, or restrict access to an
object or operation, then you must enable security, which enforces authentication and authorization. You can enable security
-during installation by answering the Trafodion Installer's prompts or after installation by running the `traf_authentication_setup`
+during installation by answering the {project-name} Installer's prompts or after installation by running the `traf_authentication_setup`
script, which enables both authentication and authorization. For more information, see
<<enable-security-authentication-setup-script,Authentication Setup Script>> below.
-Trafodion does not manage user names and passwords internally but does support authentication via directory servers that support
-the OpenLDAP protocol, also known as LDAP servers. You can configure the LDAP servers during installation by answering the Trafodion
+{project-name} does not manage user names and passwords internally but does support authentication via directory servers that support
+the OpenLDAP protocol, also known as LDAP servers. You can configure the LDAP servers during installation by answering the {project-name}
Installer's prompts, or you can configure the LDAP servers manually after installation. For more information, please refer to
<<enable-security-configuring-ldap-servers,Configuring LDAP Servers>> below.
-Once authentication and authorization are enabled, Trafodion allows users to be registered in the database and allows privileges
-on objects to be granted to users and roles (which are granted to users). Trafodion also supports component-level (or system-level)
+Once authentication and authorization are enabled, {project-name} allows users to be registered in the database and allows privileges
+on objects to be granted to users and roles (which are granted to users). {project-name} also supports component-level (or system-level)
privileges, such as MANAGE_USERS, which can be granted to users and roles. Refer to <<enable-security-manage-users,Manage Users>> below.
[[enable-security-configuring-ldap-servers]]
@@ -68,14 +68,14 @@ If `Attribute1` has only one instance, `valueC` is used, otherwise, `valueA` and
Attributes are grouped into sections; this is for future enhancements. Attributes are declared in the `LOCAL` section, unless otherwise specified.
NOTE: Section names, attribute names, and the general layout of the authentication configuration file are subject to change in future versions
-of Trafodion and backward compatibility is not guaranteed.
+of {project-name} and backward compatibility is not guaranteed.
Specification of your directory server(s) requires at a minimum:
[cols="15%h,55%,30%a",options="header"]
|===
| Setting | Description | Example
-| LDAP Host Name(s) | One or more names of hosts that support the OpenLDAP protocol must be specified. Trafodion attempts to connect to all
+| LDAP Host Name(s) | One or more names of hosts that support the OpenLDAP protocol must be specified. {project-name} attempts to connect to all
provided host names during the authentication process. The set of user names and passwords should be identical on all hosts to avoid unpredictable
results. The attribute name is `LDAPHostName`. | `LDAPHostName: ldap.company.com`
| LDAP Port Number | Port number of the LDAP server. Typically this is 389 for servers using no encryption or TLS, and 636 for servers using SSL.
@@ -88,7 +88,7 @@ identifier specifiers. | `UniqueIdentifier: uid=,ou=users,dc=com`
• 1: SSL +
• 2: TLS | `LDAPSSL: 2` +
+
-If your LDAP server uses TLS you must specify a file containing the certificate used to encrypt the password. By default the Trafodion software
+If your LDAP server uses TLS you must specify a file containing the certificate used to encrypt the password. By default the {project-name} software
looks for this file in `$MY_SQROOT/cacerts`, but you may specify a fully qualified filename, or set the environment variable `CACERTS_DIR` to another
directory. To specify the file containing the certificate, you set the value of the attribute `TLS_CACERTFilename`, located in the Defaults section. +
+
@@ -102,10 +102,10 @@ has that requirement, provide these "search" values. | `LDAPSearchDN: lookup@com
`LDAPSearchPwd: Lookup123`
|===
-There are additional optional attributes that can be used to customize Trafodion authentication. As mentioned earlier, they are described in
+There are additional optional attributes that can be used to customize {project-name} authentication. As mentioned earlier, they are described in
<<enable-security-traf-authentication-config,.traf_authentication_config>> below.
-You can test the authentication configuration file for syntactic errors using the `ldapconfigcheck` tool. If you have loaded the Trafodion
+You can test the authentication configuration file for syntactic errors using the `ldapconfigcheck` tool. If you have loaded the {project-name}
environment (`sqenv.sh`), then the tool automatically checks the file at `$MY_SQROOT/sql/scripts/.traf_authentication_config`.
If not, you can specify the file to be checked.
@@ -122,8 +122,8 @@ Please refer to <<enable-security-ldapconfigcheck,ldapconfigcheck>> below for mo
NOTE: The authentication configuration file needs to be propagated to all nodes, but there is a script that does that for you described later.
For now, you can test your changes on the local node.
-You can test the LDAP connection using the utility `ldapcheck`. To use this utility the Trafodion environment must be loaded (`sqenv.sh`),
-but the Trafodion instance does not need to be running. To test the connection only, you can specify any user name, and a name lookup is performed
+You can test the LDAP connection using the utility `ldapcheck`. To use this utility the {project-name} environment must be loaded (`sqenv.sh`),
+but the {project-name} instance does not need to be running. To test the connection only, you can specify any user name, and a name lookup is performed
using the attributes in `.traf_authentication_config`.
```
@@ -146,10 +146,10 @@ Authentication successful
<<<
[[enable-security-generate-trafodion-certificate]]
-== Generate Trafodion Certificate
-Trafodion clients such as `trafci` encrypt the password before sending it to Trafodion. A self-signed certificate is used to encrypt the password.
+== Generate {project-name} Certificate
+{project-name} clients such as `trafci` encrypt the password before sending it to {project-name}. A self-signed certificate is used to encrypt the password.
The certificate and key should be generated when the `sqgen` script is invoked. By default, the files `server.key` and `server.crt` are located
-in `$HOME/sqcert`. If those files are not present and since Trafodion clients does not send unencrypted passwords, then you need to manually generate
+in `$HOME/sqcert`. If those files are not present and since {project-name} clients does not send unencrypted passwords, then you need to manually generate
those files. To do so, run the script `sqcertgen` located in `$MY_SQROOT/sql/scripts`. The script runs `openssl` to generate the certificate and key.
To run openssl manually, follow the example:
@@ -174,18 +174,18 @@ If you encrypt the private key, then you must enter the password every time the
|===
Both the public (`server.crt`) and private (`server.key`) files should be placed in the directory `$HOME/sqcert`. If you do not want to use
-the `HOME` directory or if you want to use different names for the private and/or public key files, then Trafodion supports environment variables
+the `HOME` directory or if you want to use different names for the private and/or public key files, then {project-name} supports environment variables
to specific the alternate locations or names.
-* Trafodion first checks the environment variables `SQCERT_PRIVKEY` and `SQCERT_PUBKEY`. If they are set, Trafodion uses the fully qualified filename
+* {project-name} first checks the environment variables `SQCERT_PRIVKEY` and `SQCERT_PUBKEY`. If they are set, {project-name} uses the fully qualified filename
value of the environment variable.
+
You can specify either one filename environment variable or both.
-* If at least one filename environment variable is not set, Trafodion checks the value of the environment variable `SQCERT_DIR`. If set,
+* If at least one filename environment variable is not set, {project-name} checks the value of the environment variable `SQCERT_DIR`. If set,
then the default filename `server.key` or `server.crt` is appended to the value of the environment variable `SQCERT_DIR`.
* If the filename environment variable is not set and the directory environment variable is not set,
-then Trafodion uses the default location (`$HOME/sqcert`) and the default filename.
+then {project-name} uses the default location (`$HOME/sqcert`) and the default filename.
[[enable-security-authentication-setup-script]]
== Authentication Setup Script
@@ -220,14 +220,14 @@ and propagates `sqenvcom.sh` and `.traf_authentication_config` to all nodes in t
The last step is to enable authorization by creating privilege-related metadata tables and set up default permissions with a call to the database.
The list of privilege-related metadata tables, users, roles, and component privileges are logged in `$MY_SQROOT/logs/authEnable.log`. +
+
-Specifying `--on` requires that a valid `.traf_authentication_config` file exists and the Trafodion metadata initialized.
+Specifying `--on` requires that a valid `.traf_authentication_config` file exists and the {project-name} metadata initialized.
| --off | If specified, then `traf_authentication_setup` sets the environment variable `TRAFODION_ENABLE_AUTHENTICATION` to `NO` in
`$MY_SQROOT/sqenvcom.sh` and propagates the file to all the nodes in the cluster. +
+
The last step is to disable authorization by removing any privilege-related metadata and permissions with a call to the database.
The results of this operation is logged in `$MY_SQROOT/logs/authEnable.log`.
-| --setup | Use this option if the Trafodion metadata has not been initialized. This option enables authentication but does not call the database
-to create privilege-related metadata tables. Later, when Trafodion metadata is initialized, privilege-related metadata tables and default permissions
+| --setup | Use this option if the {project-name} metadata has not been initialized. This option enables authentication but does not call the database
+to create privilege-related metadata tables. Later, when {project-name} metadata is initialized, privilege-related metadata tables and default permissions
are automatically created.
| --status | Reports the value of the environment variable `TRAFODION_ENABLE_AUTHENTICATION` in `$MY_SQROOT/sqenvcom.sh` on the current node and
reports the status of security features in the database.
@@ -266,7 +266,7 @@ ALTER USER DB__ROOT SET EXTERNAL NAME trafodion_rootuser_in_ldap;
```
To learn more about how to register users, grant object and component privileges, and manage users and roles, please see the
-http://trafodion.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual].
+{docs-url}/sql_reference/index.html[Trafodion SQL Reference Manual].
[[enable-security-traf-authentication-config]]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc b/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
index 89e99e6..6df64fd 100644
--- a/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
@@ -20,52 +20,52 @@
* under the License.
*
* @@@ END COPYRIGHT @@@
- */
+*/
////
[[introduction]]
= Introduction
-Trafodion is a Hadoop add-on service that provides transactional SQL on top of HBase. Typically, you
-use Trafodion as the database for applications that require Online Transaction Processing (OLTP),
-Operational Data Store (ODS), and/or strong reporting capabilities. You access Trafodion using
+{project-name} is a Hadoop add-on service that provides transactional SQL on top of HBase. Typically, you
+use {project-name} as the database for applications that require Online Transaction Processing (OLTP),
+Operational Data Store (ODS), and/or strong reporting capabilities. You access {project-name} using
standard JDBC and ODBC APIs.
-You may choose whether to add Trafodion to an existing Hadoop environment or to create a standalone
+You may choose whether to add {project-name} to an existing Hadoop environment or to create a standalone
Hadoop environment specifically for Hadoop.
-This guide assumes that a Hadoop environment exists upon which your provisioning Trafodion. Refer to
+This guide assumes that a Hadoop environment exists upon which your provisioning {project-name}. Refer to
<<requirements-hadoop-software,Hadoop Software>> for information about what Hadoop software is required
-Trafodion.
+{project-name}.
[[introduction-security-considerations]]
== Security Considerations
-The following users need be considered for Trafodion:
+The following users need be considered for {project-name}:
-* *Provisioning User*: A Linux-level user that performs the Trafodion provisioning tasks. This user ID
-requires `sudo` access and passwordless ssh among the nodes where Trafodion is installed. In addition,
+* *Provisioning User*: A Linux-level user that performs the {project-name} provisioning tasks. This user ID
+requires `sudo` access and passwordless ssh among the nodes where {project-name} is installed. In addition,
this user ID requires access to Hadoop distribution, HDFS, and HBase administrative users to change
-respective environment's configuration settings per Trafodion requirements. Refer to
-<<requirements-trafodion-provisioning-user,Trafodion Provisioning User>> for more information
+respective environment's configuration settings per {project-name} requirements. Refer to
+<<requirements-trafodion-provisioning-user,{project-name} Provisioning User>> for more information
about the requirements and usage associated with this user ID.
-* *Runtime User*: A Linux-level user under which the Trafodion software runs. This user ID must be registered
+* *Runtime User*: A Linux-level user under which the {project-name} software runs. This user ID must be registered
as a user in the Hadoop Distributed File System (HDFS) to store and access objects in HDFS, HBase, and Hive.
-In addition, this user ID requires passwordless access among the nodes where Trafodion is installed.
-Refer to <<requirements-trafodion-runtime-user,Trafodion Runtime User>> for more information about this user ID.
+In addition, this user ID requires passwordless access among the nodes where {project-name} is installed.
+Refer to <<requirements-trafodion-runtime-user,{project-name} Runtime User>> for more information about this user ID.
-* *Trafodion Database Users*: Trafodion users are managed by the Trafodion security features (grant, revoke, etc.),
+* *{project-name} Database Users*: {project-name} users are managed by the {project-name} security features (grant, revoke, etc.),
which can be integrated with LDAP if so desired. These users are referred to as *database users* and
do not have direct access to the operating system. Refer to
-http://trafodion.apache.org/docs/sql_reference/index.html#register_user_statement[Register User],
-http://trafodion.apache.org/docs/sql_reference/index.html#grant_statement[Grant], and other SQL statements
-in the http://trafodion.apache.org/docs/sql_reference/index.html[Trafodion SQL Reference Manual] for
-more information about managing Trafodion Database Users.
+{docs-url}/sql_reference/index.html#register_user_statement[Register User],
+{docs-url}/sql_reference/index.html#grant_statement[Grant], and other SQL statements
+in the {docs-url}/sql_reference/index.html[{project-name} SQL Reference Manual] for
+more information about managing {project-name} Database Users.
+
+
-Optionally, you can enable Trafodion Security. If you do not enable security in Trafodion, then a client interface
-to Trafodion may request a user name and password, but Trafodion ignores the user name and password entered in the
+Optionally, you can enable {project-name} Security. If you do not enable security in {project-name}, then a client interface
+to {project-name} may request a user name and password, but {project-name} ignores the user name and password entered in the
client interface, and the session runs as the database *root* user, `DB__ROOT`, without restrictions. If you want
to restrict users, restrict access to certain users only, or restrict access to an object or operation, then you must
enable security, which enforces authentication and authorization. Refer to
@@ -74,71 +74,71 @@ enable security, which enforces authentication and authorization. Refer to
[[introduction-provisioning-options]]
== Provisioning Options
-Trafodion ships with a set of scripts (the Trafodion Installer) that takes care of many of the installation and upgrade
-tasks associated with the Trafodion software and its requirements. There is a separate set of scripts to remove Trafodion,
+{project-name} ships with a set of scripts (the {project-name} Installer) that takes care of many of the installation and upgrade
+tasks associated with the {project-name} software and its requirements. There is a separate set of scripts to remove {project-name},
if needed.
-Currently, the Trafodion Installer is able to install Trafodion on select Cloudera and Hortonworks Hadoop distributions only.
-The Trafodion Installer limitations are noted as they apply in the different chapters below. For example, the Trafodion Installer
-is less capable on SUSE than it is on RedHat/CentOS; you have to install the prerequisite software packages outside the Trafodion Installer.
+Currently, the {project-name} Installer is able to install {project-name} on select Cloudera and Hortonworks Hadoop distributions only.
+The {project-name} Installer limitations are noted as they apply in the different chapters below. For example, the {project-name} Installer
+is less capable on SUSE than it is on RedHat/CentOS; you have to install the prerequisite software packages outside the {project-name} Installer.
-The Trafodion Installer automates many of the tasks required to install/upgrade Trafodion, spanning from downloading and
+The {project-name} Installer automates many of the tasks required to install/upgrade {project-name}, spanning from downloading and
installing required software packages and making required changes to your Hadoop environment via creating
-the Trafodion runtime user ID to installing and starting Trafodion. It is, therefore, highly recommend that
-you use the Trafodion Installer for initial installation and upgrades of Trafodion. These steps are referred to as
-"Script-Based Provisioning" in this guide. Refer to <<introduction-trafodion-installer, Trafodion Installer>> provides
+the {project-name} runtime user ID to installing and starting {project-name}. It is, therefore, highly recommend that
+you use the {project-name} Installer for initial installation and upgrades of {project-name}. These steps are referred to as
+"Script-Based Provisioning" in this guide. Refer to <<introduction-trafodion-installer, {project-name} Installer>> provides
usage information.
-If, for any reason, you choose not to use the Trafodion Installer, then separate chapters provide
-step-by-step recipes for the tasks required to install/upgrade Trafodion. These steps are referred to as
+If, for any reason, you choose not to use the {project-name} Installer, then separate chapters provide
+step-by-step recipes for the tasks required to install/upgrade {project-name}. These steps are referred to as
*Recipe-Based Provisioning* in this guide. It is assumed that you are well-versed in Linux and Hadoop
administrative tasks if using Recipe-Based Provisioning.
[[introduction-provisioning-activities]]
== Provisioning Activities
-Trafodion provisioning is divided into the following main activities:
+{project-name} provisioning is divided into the following main activities:
-* *<<requirements,Requirements>>*: Activities and documentation required to install the Trafodion software.
+* *<<requirements,Requirements>>*: Activities and documentation required to install the {project-name} software.
These activities include tasks such as understanding hardware and operating system requirements,
Hadoop requirements, what software packages that need to be downloaded, configuration settings that need to be changed,
user IDs requirements, and so on.
* *<<prepare,Prepare>>*: Activities to prepare the operating system and the Hadoop ecosystem to run
-Trafodion. These activities include tasks such as installing required software packages, configure
-the Trafodion Installation User, gather information about the Hadoop environment, modify configuration
+{project-name}. These activities include tasks such as installing required software packages, configure
+the {project-name} Installation User, gather information about the Hadoop environment, modify configuration
for different Hadoop services, and so forth.
-* *<<install,Install>>*: Activities related to installing the Trafodion software. These activities
-include tasks such as unpacking the Trafodion tar files, creating the Trafodion Runtime User,
-creating Trafodion HDFS directories, installing the Trafodion software, and so forth.
+* *<<install,Install>>*: Activities related to installing the {project-name} software. These activities
+include tasks such as unpacking the {project-name} tar files, creating the {project-name} Runtime User,
+creating {project-name} HDFS directories, installing the {project-name} software, and so forth.
<<<
-* *<<upgrade,Upgrade>>*: Activities related to the upgrading the Trafodion software. These activities
-include tasks such as shutting down Trafodion, installing a new version of the Trafodion software,
+* *<<upgrade,Upgrade>>*: Activities related to the upgrading the {project-name} software. These activities
+include tasks such as shutting down {project-name}, installing a new version of the {project-name} software,
and so on. The upgrade tasks vary depending on the differences between the current and new release of
-Trafodion. For example, an upgrade may or may not include an upgrade of the Trafodion metadata.
+{project-name}. For example, an upgrade may or may not include an upgrade of the {project-name} metadata.
-* *<<activate,Activate>>*: Activities related to starting the Trafodion software. These actives
-include basic management tasks such as starting and checking the status of the Trafodion components,
+* *<<activate,Activate>>*: Activities related to starting the {project-name} software. These actives
+include basic management tasks such as starting and checking the status of the {project-name} components,
performing basic smoke tests, and so forth.
-* *<<remove,Remove>>*: Activities related to removing Trafodion from your Hadoop cluster.
+* *<<remove,Remove>>*: Activities related to removing {project-name} from your Hadoop cluster.
[[introduction-provisioning-master-node]]
== Provisioning Master Node
All provisioning tasks are performed from a single node in the cluster, which must be part
-of the Hadoop environment you're adding Trafodion to. This node is referred to as the
+of the Hadoop environment you're adding {project-name} to. This node is referred to as the
"*Provisioning Master Node*" in this guide.
-The Trafodion Provisioning User must have access to all other nodes from the Provisioning
+The {project-name} Provisioning User must have access to all other nodes from the Provisioning
Master Node in order to perform provisioning tasks on the cluster.
[[introduction-trafodion-installer]]
-== Trafodion Installer
+== {project-name} Installer
-The Trafodion Installer is a set of scripts automates most of the tasks requires to install/upgrade Trafodion.
-You download the Trafodion Installer tar file from the Trafodion http://trafodion.apache.org/download.html[download] page.
+The {project-name} Installer is a set of scripts automates most of the tasks requires to install/upgrade {project-name}.
+You download the {project-name} Installer tar file from the {project-name} {download-url}[download] page.
Next, you unpack the tar file.
*Example*
@@ -157,11 +157,11 @@ $
```
<<<
-The Trafodion Installer supports two different modes:
+The {project-name} Installer supports two different modes:
1. *Guided Setup*: Prompts for information as it works through the installation/upgrade process. This mode is recommended for new users.
2. *Automated Setup*: Required information is provided in a pre-formatted bash-script configuration file, which is provided
-via a command argument when running the Trafodion Installer thereby suppressing all prompts.
+via a command argument when running the {project-name} Installer thereby suppressing all prompts.
+
A template of the configuration file is available here within the installer directory: `trafodion_config_default`.
Make a copy of the file in your directory and populate the needed information.
@@ -173,22 +173,22 @@ populate this file.
[[introduction-trafodion-installer-usage]]
=== Usage
-The following shows help for the Trafodion Installer.
+The following shows help for the {project-name} Installer.
```
./trafodion_install --help
-This script will install Trafodion. It will create a configuration
+This script will install {project-name}. It will create a configuration
file (if one has not been created), setup of the environment needed
-for Trafodion, configure HBase with Hbase-trx and co-processors needed,
-and install a specified Trafodion build.
+for {project-name}, configure HBase with Hbase-trx and co-processors needed,
+and install a specified {project-name} build.
Options:
--help Print this message and exit
--accept_license If provided, the user agrees to accept all the
- provisions in the Trafodion license. This allows
+ provisions in the {project-name} license. This allows
for automation by skipping the display and prompt of
- the Trafodion license.
+ the {project-name} license.
--config_file If provided, all install prompts will be
taken from this file and not prompted for.
```
@@ -197,17 +197,17 @@ Options:
[[introduction-trafodion-installer-install-vs-upgrade]]
=== Install vs. Upgrade
-The Trafodion Installer automatically detects whether you're performing an install
-or an upgrade by looking for the Trafodion Runtime User in the `/etc/passwd` file.
+The {project-name} Installer automatically detects whether you're performing an install
+or an upgrade by looking for the {project-name} Runtime User in the `/etc/passwd` file.
-* If the user ID doesn't exist, then the Trafodion Installer runs in install mode.
-* If the user ID exists, then the Trafodion Installer runs in upgrade mode.
+* If the user ID doesn't exist, then the {project-name} Installer runs in install mode.
+* If the user ID exists, then the {project-name} Installer runs in upgrade mode.
[[introduction-trafodion-installer-guided-setup]]
=== Guided Setup
-By default, the Trafodion Installer runs in Guided Setup mode, which means
+By default, the {project-name} Installer runs in Guided Setup mode, which means
that it prompts you for information during the install/upgrade process.
Refer to the following sections for examples:
@@ -218,9 +218,9 @@ Refer to the following sections for examples:
[[introduction-trafodion-installer-automated-setup]]
=== Automated Setup
-The `--config_file` option runs the Trafodion in Automated Setup mode.
+The `--config_file` option runs the {project-name} in Automated Setup mode.
-Before running the Trafodion Installer with this option, you do the following:
+Before running the {project-name} Installer with this option, you do the following:
1. Copy the `trafodion_config_default` file.
+
@@ -234,7 +234,7 @@ cp trafodion_config_default my_config
<<prepare-gather-configuration-information,Gather Configuration Information>>
section in the <<prepare,Prepare>> chapter.
-3. Run the Trafodion Installer in Automated Setup Mode
+3. Run the {project-name} Installer in Automated Setup Mode
+
*Example*
+
@@ -242,11 +242,11 @@ section in the <<prepare,Prepare>> chapter.
./trafodion_installer --config_file my_config
```
-NOTE: Your Trafodion Configuration File contains the password for the Trafodion Runtime User
+NOTE: Your {project-name} Configuration File contains the password for the {project-name} Runtime User
and for the Distribution Manager. Therefore, we recommend that you secure the file in a manner
that matches the security policies of your organization.
-==== Example: Creating a Trafodion Configuration File
+==== Example: Creating a {project-name} Configuration File
Using the instructions in <<prepare-gather-configuration-information,Gather Configuration Information>>
in the <<prepare,Prepare>> chapter, you record the following information.
@@ -256,8 +256,8 @@ in the <<prepare,Prepare>> chapter, you record the following information.
| ID | Information | Setting
| ADMIN | Administrator user name for Apache Ambari or Cloudera Manager. | admin
| BACKUP_DCS_NODES | List of nodes where to start the backup DCS Master components. |
-| CLOUD_CONFIG | Whether you're installing Trafodion on a cloud environment. | N
-| CLOUD_TYPE | What type of cloud environment you're installing Trafodion on. |
+| CLOUD_CONFIG | Whether you're installing {project-name} on a cloud environment. | N
+| CLOUD_TYPE | What type of cloud environment you're installing {project-name} on. |
| CLUSTER_NAME | The name of the Hadoop Cluster. | Cluster 1
| DCS_BUILD | Tar file containing the DCS component. |
| DCS_PRIMARY_MASTER_NODE | The node where the primary DCS should run. |
@@ -265,12 +265,12 @@ in the <<prepare,Prepare>> chapter, you record the following information.
| ENABLE_HA | Whether to run DCS in high-availability (HA) mode. | N
| EPEL_RPM | Location of EPEL RPM. Specify if you don't have access to the Internet. |
| FLOATING_IP | IP address if running DCS in HA mode. |
-| HADOOP_TYPE | The type of Hadoop distribution you're installing Trafodion on. | cloudera
+| HADOOP_TYPE | The type of Hadoop distribution you're installing {project-name} on. | cloudera
| HBASE_GROUP | Linux group name for the HBASE administrative user. | hbase
| HBASE_USER | Linux user name for the HBASE administrative user. | hbase
| HDFS_USER | Linux user name for the HDFS administrative user. | hdfs
| HOME_DIR | Root directory under which the `trafodion` home directory should be created. | /home
-| INIT_TRAFODION | Whether to automatically initialize the Trafodion database. | Y
+| INIT_TRAFODION | Whether to automatically initialize the {project-name} database. | Y
| INTERFACE | Interface type used for $FLOATING_IP. |
| JAVA_HOME | Location of Java 1.7.0_65 or higher (JDK). | /usr/java/jdk1.7.0_67-cloudera
| LDAP_CERT | Full path to TLS certificate. |
@@ -281,17 +281,17 @@ in the <<prepare,Prepare>> chapter, you record the following information.
| LDAP_PORT | Port used to communicate with LDAP Identity Store. |
| LDAP_SECURITY | Whether to enable simple LDAP authentication. | N
| LDAP_USER | LDAP Search user name. |
-| LOCAL_WORKDIR | The directory where the Trafodion Installer is located. | /home/centos/trafodion-installer/installer
+| LOCAL_WORKDIR | The directory where the {project-name} Installer is located. | /home/centos/trafodion-installer/installer
| MANAGEMENT_ENABLED | Whether your installation uses separate management nodes. | N
| MANAGEMENT_NODES | The FQDN names of management nodes, if any. |
-| NODE_LIST | The FQDN names of the nodes where Trafodion will be installed. | trafodion-1 trafodion-2
+| NODE_LIST | The FQDN names of the nodes where {project-name} will be installed. | trafodion-1 trafodion-2
| PASSWORD | Administrator password for Apache Ambari or Cloudera Manager. | admin
| REST_BUILD | Tar file containing the REST component. |
-| SQ_ROOT | Target directory for the Trafodion software. | /home/trafodion/apache-trafodion-1.3.0-incubating-bin
-| START | Whether to start Trafodion after install/upgrade. | Y
-| SUSE_LINUX | Whether your installing Trafodion on SUSE Linux. | false
-| TRAF_PACKAGE | The location of the Trafodion installation package tar file or core installation tar file. | /home/centos/trafodion-download/apache-trafodion-1.3.0-incubating-bin.tar.gz
-| TRAF_USER | The Trafodion runtime user ID. Must be `trafodion` in this release. | trafodion
+| SQ_ROOT | Target directory for the {project-name} software. | /home/trafodion/apache-trafodion-1.3.0-incubating-bin
+| START | Whether to start {project-name} after install/upgrade. | Y
+| SUSE_LINUX | Whether your installing {project-name} on SUSE Linux. | false
+| TRAF_PACKAGE | The location of the {project-name} installation package tar file or core installation tar file. | /home/centos/trafodion-download/apache-trafodion-1.3.0-incubating-bin.tar.gz
+| TRAF_USER | The {project-name} runtime user ID. Must be `trafodion` in this release. | trafodion
| TRAF_USER_PASSWORD | The password used for the `trafodion:trafodion` user ID. | traf123
| URL | FQDN and port for the Distribution Manager's REST API. | trafodion-1.apache.org:7180
|===
@@ -322,13 +322,13 @@ Next, you edit `my_config` to contain the following:
# @@@ END COPYRIGHT @@@
#====================================================
-# Trafodion Configuration File
+# {project-name} Configuration File
# This file contains default values for the installer.
# Users can also edit this file and provide values for all parameters
# and then specify this file on the run line of trafodion_install.
# Example:
-# ./trafodion_install --config_file <Trafodion-config-file>
+# ./trafodion_install --config_file <{project-name}-config-file>
# WARNING: This mode is for advanced users!
#
#=====================================================
@@ -340,7 +340,7 @@ Next, you edit `my_config` to contain the following:
export SUSE_LINUX="false"
-# The working directory where Trafodion installer untars files, etc.
+# The working directory where {project-name} installer untars files, etc.
# do not change this unless you really know what you are doing
export TRAF_WORKDIR="/usr/lib/trafodion"
@@ -353,10 +353,10 @@ export DCS_SERVERS_PARM="8"
# "true" if this is an upgrade
export UPGRADE_TRAF="false"
-# Trafodion userid, This is the userid the Trafodion instance will run under
+# {project-name} userid, This is the userid the {project-name} instance will run under
export TRAF_USER="trafodion"
-# Trafodion userid's password
+# {project-name} userid's password
export TRAF_USER_PASSWORD="traf123"
# a blank separated list of nodes in your cluster
@@ -384,7 +384,7 @@ export JAVA_HOME="/usr/java/jdk1.7.0_67-cloudera"
# will be installed from the internet
export EPEL_RPM=""
-# full path of the Trafodion package tar file
+# full path of the {project-name} package tar file
export TRAF_PACKAGE="/home/centos/trafodion-download/apache-trafodion-1.3.0-incubating-bin.tar.gz"
# if TRAF_PACKAGE wasn't specified then these two values must be specified
@@ -397,7 +397,7 @@ export REST_BUILD=""
# Either "cloudera" or "hortonworks" (all lowercase)
export HADOOP_TYPE="cloudera"
-# The URL for Cloudera/Hortonworks REST API (i.e. node1.hp.com:8080)
+# The URL for Cloudera/Hortonworks REST API (i.e. node1.host.com:8080)
export URL="trafodion-1.apache.org:7180"
# Cloudera/Hortonworks UI admin's userid and password
@@ -417,7 +417,7 @@ export HBASE_GROUP="hbase"
# The hadoop HBase service name
export HBASE="hbase"
-# full path of where to install Trafodion to
+# full path of where to install {project-name} to
# Example is used below. If $HOME_DIR or $TRAF_USER have been changed
# then this will need to be changed.
# On an upgrade, it is recommend to choose a different directory.
@@ -426,7 +426,7 @@ export HBASE="hbase"
# By doing this the previous version will remain and allow for an easier rollback.
export SQ_ROOT="/home/trafodion/apache-trafodion-1.3.0-incubating-bin"
-# Start Trafodion after install completes
+# Start {project-name} after install completes
export START="Y"
# initialize trafodion after starting
@@ -445,7 +445,7 @@ export LDAP_SECURITY="N"
export LDAP_AUTH_FILE="traf_authentication_config_${HOSTNAME}"
```
-Once completed, run the Trafodion Installer with the `--config_file` option.
+Once completed, run the {project-name} Installer with the `--config_file` option.
Refer to the following sections for examples:
@@ -453,9 +453,9 @@ Refer to the following sections for examples:
* <<upgrade-automated-upgrade, Automated Upgrade>>
[[introduction-trafodion-provisioning-directories]]
-== Trafodion Provisioning Directories
+== {project-name} Provisioning Directories
-Trafodion stores its provisioning information in the following directories on each node in the cluster:
+{project-name} stores its provisioning information in the following directories on each node in the cluster:
* `/etc/trafodion`: Configurtion information.
* `/usr/lib/trafodion`: Copies of the installer files.