Github user DaveBirdsall commented on a diff in the pull request:
https://github.com/apache/incubator-trafodion/pull/326#discussion_r53224031
--- Diff: docs/provisioning_guide/src/asciidoc/_chapters/introduction.adoc
---
@@ -0,0 +1,466 @@
+////
+/**
+* @@@ 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]]
+= 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
+standard JDBC and ODBC APIs.
+
+You may choose whether to add Trafodion 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
+<<requirements-hadoop-software,Hadoop Software>> for information about
what Hadoop software is required
+Trafodion.
+
+[[introduction-security-considerations]]
+== Security Considerations
+
+The following users need be considered for Trafodion:
+
+* *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,
+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
+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
+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.
+
+* *Trafodion Database Users*: Trafodion users are managed by the Trafodion
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.
+ +
+ +
+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
+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
+<<enable-security,Enable Security>> for more information about this option.
+
+[[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,
+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.
+
+The Trafodion Installer automates many of the tasks required to
install/upgrade Trafodion, 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
+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
+*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:
+
+* *<<requirements,Requirements>>*: Activities and documentation required
to install the Trafodion 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
+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.
+
+<<<
+* *<<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,
+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.
+
+* *<<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,
+performing basic smoke tests, and so forth.
+
+* *<<remove,Remove>>*: Activities related to removing Trafodion 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
+"*Provisioning Master Node*" in this guide.
+
+The Trafodion 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
+
+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.
+Next, you unpack the tar file.
+
+*Example*
+
+```
+$ mkdir $HOME/trafodion-installer
+$ cd $HOME/trafodion-downloads
+$ tar -zxf apache-trafodion-installer-1.3.0-incubating-bin.tar.gz -C
$HOME/trafodion-installer
+$ ls $HOME/trafodion-installer/installer
+bashrc_default tools
traf_config_check trafodion_apache_hadoop_install traf_package_setup
+build-version-1.3.0.txt traf_add_user
traf_config_setup trafodion_config_default traf_setup
+dcs_installer traf_apache_hadoop_config_setup
traf_create_systemdefaults trafodion_install traf_sqconfig
+rest_installer traf_authentication_conf_default
traf_getHadoopNodes trafodion_license traf_start
+setup_known_hosts.exp traf_cloudera_mods98
traf_hortonworks_mods98 trafodion_uninstaller
+$
+```
+
+<<<
+The Trafodion 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.
++
+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.
++
+Automated Setup is recommended since it allows you to record the required
provisioning information information ahead of time.
+Refer to <<introduction-trafodion-automated-setup,Automated Setup>> for
information about how to
+populate this file.
+
+[[introduction-trafodion-installer-usage]]
+=== Usage
+
+The following shows help for the Trafodion Installer.
+
+```
+./trafodion_install --help
+
+This script will install Trafodion. 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.
+
+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
+ for automation by skipping the display and prompt of
+ the Trafodion license.
+ --config_file If provided, all install prompts will be
+ taken from this file and not prompted for.
+```
+
+<<<
+[[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.
+
+* If the user ID doesn't exists, then the Trafodion Installer runs in
install mode.
--- End diff --
Typo, should be "doesn't exist"
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
