Github user DaveBirdsall commented on a diff in the pull request:
https://github.com/apache/incubator-trafodion/pull/326#discussion_r53224776
--- Diff: docs/provisioning_guide/src/asciidoc/_chapters/prepare.adoc ---
@@ -0,0 +1,379 @@
+////
+/**
+* @@@ 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 @@@
+ */
+////
+
+[[prepare]]
+= Prepare
+You need to prepare your Hadoop environment before installing Trafodion.
+
+1. <<prepare-install-optional-workstation-software,Install Optional
Workstation Software>>
+2. <<configure-installation-user-id,Configure Installation User ID>>
+3. <<prepare-disable-requiretty,Disable requiretty>>
+4. <<prepare-verify-os-requirements-and-recommendations,Verify OS
Requirements and Recommendations>>
+5. <<prepare-configure-ldap-identity-store,Configure LDAP Identity Store>>
+6. <<prepare-gather-configuration-information,Gather Configuration
Information>>
+7. <<prepare-install-required-software-packages,Install Required Software
Packages>>
+8. <<prepare-perform-recipe-based-provisioning-tasks,Perform Recipe-Based
Provisioning Tasks>>
+
+[[prepare-install-optional-workstation-software]]
+== Install Optional Workstation Software
+
+If you are using a Windows workstation, then the following optional
software helps installation process.
+We recommended that you pre-install the software before continuing with
the Trafodion installation:
+
+* putty and puttygen (download from
http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html[PuTTY web site])
+* VNC client (download from http://www.realvnc.com[RealVNC web site])
+* Firefox or Chrome browser
+* SFTP client to transfer files from your workstation to the Linux server:
WinSCP or FileZilla
+
+[[configure-installation-user-id]]
+== Configure Installation User ID
+
+Trafodion installation requires a user ID with these attributes:
+
+* `sudo` access per the requirements documented in
<<requirements-linux-installation-user,Linux Installation User>>.
+* passwordless ssh to all nodes on the cluster where Trafodion will be
installed.
+
+NOTE: You may need to request permission from your cluster-management team
to obtain this type of access.
+
+The following example shows how to set up your user ID to have
"passwordless ssh" abilities.
+
+Do the following on the Provision Master Node:
+
+```
+echo -e 'y\n' | ssh-keygen -t rsa -N "" -f $HOME/.ssh/id_rsa
+cat $HOME/.ssh/id_rsa.pub >> $HOME/.ssh/authorized_keys
+echo localhost $(cat /etc/ssh/ssh_host_rsa_key.pub) >>
$HOME/.ssh/known_hosts
+echo "NoHostAuthenticationForLocalhost=yes" >> $HOME/.ssh/config
+chmod 600 $HOME/.ssh/config
+```
+
+After running these commands, do the following:
+
+* Copy the content of the `$HOME/.ssh/id_rsa.pub` file (public key) and
append it to the
+`$HOME/.ssh/authorized_keys` file on the other nodes in your cluster.
+* Copy the `$HOME/.ssh/id_rsa` file (private key) from the current node to
the `$HOME/.ssh` directory on the other nodes in the cluster.
+* Secure `$HOME/.ssh/id_rsa` on all nodes as private to yourself (`chmod
700`).
+* `ssh` to the other nodes in the cluster. Answer `y` to the prompt asking
you whether to continue the connection.
+This adds the node to the `$HOME/.ssh/known_hosts` file completing the
passwordless ssh setup.
+
+
+[[prepare-disable-requiretty]]
+== Disable requiretty
+You need to disable `requiretty` in `/etc/sudoers` on all nodes in the
cluster
+to ensure that `sudo` commands can be run from inside the installation
scripts.
+
+Comment out the `Defaults requiretty` setting in the `/etc/sudoers` file to
+ensure that the `requiretty` option is NOT being used.
+
+[[prepare-verify-os-requirements-and-recommendations]]
+== Verify OS Requirements and Recommendations
+
+Please ensure that the
<<requirements-os-requirements-and-recommendations,OS Requirements and
Recommendations>>
+are met for each node in the cluster where you intend to install Trafodion.
+
+<<<
+[[prepare-configure-ldap-identity-store]]
+== Configure LDAP Identity Store
+
+If you plan to enable security in Trafodion, then you need to have an LDAP
identity store available to perform authentication.
+The Trafodion Installer prompts you to set up an authentication
configuration file that points to an LDAP server (or servers),
+which enables security (that is, authentication and authorization) in the
Trafodion database.
+
+If you wish to manually set up the authentication configuration file and
enable security, then refer to the section on
+<<enable-security,Enable Security>>.
+
+[[prepare-gather-configuration-information]]
+== Gather Configuration Information
+
+You need to gather/decide information about your environment to aid
installation Trafodion, both for the Trafodion Installer
+and for recipe-based provisioning. (In alphabetical order to make it
easier to find information later on in the provisioning process.)
+
+[cols="25%l,25%,15%l,35%",options="header"]
+|===
+| ID^1^ | Information
| Default | Notes
+| ADMIN | Administrator user name for Apache Ambari or
Cloudera Manager. | admin | A user that can change
configuration and restart services via the
+distribution manager's REST API.
+| BACKUP_DCS_NODES | List of nodes where to start the backup DCS Master
components. | None | Blank separated FQDN list. Not
needed if $ENABLE_HA = N.
+| CLOUD_CONFIG | Whether you're installing Trafodion on a cloud
environment. | N | N = bare-metal or VM
installation.
+| CLOUD_TYPE | What type of cloud environment you're installing
Trafodion on. | None | { AWS \| OpenStack \| Other }. Not applicable for
bare-metal or VM installation.
+| CLUSTER_NAME | The name of the Hadoop Cluster.
| None | From Apache Ambari or Cloudera Manager.
+| DCS_BUILD | Tar file containing the DCS component.
| None | Not needed if using a Trafodion package installation tar
file.
+| DCS_PRIMARY_MASTER_NODE | The node where the primary DCS should run.
| None | The DCS Master handles JDBC and ODBC connection requests.
+| DCS_SERVER_PARM | Number of concurrent client sessions per node.
| 16 | This number specifies the concurrent sessions per node to be
supported. Each session could require up to 1GB of physical memory. The number
can be changed post-installation. For more information,
+refer to the
http://trafodion.apache.org/docs/client_install/index.html[Trafodion Client
Installation Guide].
+| ENABLE_HA | Whether to run DCS in high-availability (HA) mode.
| N | You need the floating IP address,
the interface, and the backup nodes for DCS Master if enabling this feature.
+| EPEL_RPM | Location of EPEL RPM.
| None | Specify if you don't have access
to the Internet.
+Downloaded automatically by the Trafodion Installer.
+| FLOATING_IP | IP address if running DCS in HA mode.
| None | Not needed if $ENABLE_HA = N. An
FQDN name or IP address.
+| HADOOP_TYPE | The type of Hadoop distribution you're installing
Trafodion on. | None | Lowercase. cloudera or hadoop.
+| HBASE_GROUP | Linux group name for the HBASE administrative user.
| hbase | Required in order to provide
access to select HDFS directories to this user ID.
+| HBASE_USER | Linux user name for the HBASE administrative user.
| hbase | Required in order to provide
access to select HDFS directories to this user ID.
+| HDFS_USER | Linux user name for the HDFS administrative user.
| hdfs | The Trafodion Installer uses
`sudo su` to make HDFS
+configuration changes under this user.
+| HOME_DIR | Root directory under which the `trafodion` home
directory should be created. | /home | *Example* +
+ +
+If the home directory of the `trafodion` user is
+`/opt/home/trafodion`, then specify the root directory as `/opt/home`.
+| INIT_TRAFODION | Whether to automatically initialize the Trafodion
database. | N | Does not apply to Recipe-Based
Provisioning. Applies if $START=Y only.
+| INTERFACE | Interface type used for $FLOATING_IP.
| None | Not needed if $ENABLE_HA = N.
+| JAVA_HOME | Location of Java 1.7.0_65 or higher (JDK).
| $JAVA_HOME setting | Fully qualified path of the JDK.
For example:
+`/usr/java/jdk1.7.0_67-cloudera`
+| LDAP_CERT^2^ | Full path to TLS certificate.
| None | Required of $LDAP_LEVEL = 1 or 2.
+| LDAP_HOSTS^2^ | List of nodes where LDAP Identity Store servers are
running. | None | Blank separated. FQDN format.
+| LDAP_ID^2^ | List of LDAP unique identifiers.
| None | Blank separated.
+| LDAP_LEVEL^2^ | LDAP Encryption Level.
| 0 | 0: Encryption not used, 1: SSL, 2:
TLS
+| LDAP_PASSWORD^2^ | Password for LDAP_USER.
| None | If LDAP_USER is required only.
+| LDAP_PORT^2^ | Port used to communicate with LDAP Identity Store.
| None | Examples: 389 for no encryption or
TLS, 636 for SSL.
+| LDAP_SECURITY^2^ | Whether to enable simple LDAP authentication.
| N | If Y, then you need to provide
LDAP_HOSTS.
+| LDAP_USER^2^ | LDAP Search user name.
| None | If required. If so, must provide
LDAP_PASSWORD, too.
+| LOCAL_WORKDIR | The directory where the Trafodion Installer is
located. | None | Full path, no environmental
variables.
+| MANAGEMENT_ENABLED | Whether your installation uses separate management
nodes. | N | Y if using separate management
nodes for Apache Ambari or Cloudera Manager.
+| MANAGEMENT_NODES | The FQDN names of management nodes, if any.
| None | Provide a blank-separated list of
node names.
+| NODE_LIST | The FQDN names of the nodes where Trafodion will be
installed. | None | Provide a blank-separated list of
node names. The Trafodion
+Provisioning ID must have passwordless and `sudo` access to these nodes.
+| PASSWORD | Administrator password for Apache Ambari or
Cloudera Manager. | admin | A user that can change
configuration and restart services via the
+distribution manager's REST API.
+| REST_BUILD | Tar file containing the REST component.
| None | Not needed if using a Trafodion package installation tar
file.
+| SQ_ROOT | Target directory for the Trafodion software.
| $HOME_DIR/trafodion | Trafodion is installed in this
directory on all nodes in `$NODE_LIST`.
+| START | Whether to start Trafodion after install/upgrade.
| N | Does not apply to Recipe-Based
Provisioning.
+| SUSE_LINUX | Whether your installing Trafodion on SUSE Linux.
| false | Auto-detected by the Trafodion
Installer.
+| TRAF_PACKAGE | The location of the Trafodion installation package
tar file or core installation tar file. | None | The package file contains the
Trafodion server,
+DCS, and REST software while the core installation file contains the
Trafodion server software only. If you're using a core installation file, then
you need to
+record the location of the DCS and REST installation tar files, too.
Normally, you perform Trafodion provisioning using a Trafodion package
installation tar file.
+| TRAF_USER | The Trafodion runtime user ID.
| trafodion | Must be `trafodion` in this
release.
+| TRAF_USER_PASSWORD | The password used for the `trafodion:trafodion`
user ID. | traf123 | Must be 6-8 characters long.
+| URL | FQDN and port for the Distribution Manager's REST
API. | None | Include `http://` or `https://`
as applicable. Specify in the form:
+`<IP-address>:<port>` or `<node name>:<port>` Example:
`https://susevm-1.yourcompany.local:8080`
+|===
+
+1. The ID matches the environmental variables used in the Trafodion
Installation configuration file. Refer to
<<install-trafodion-installer,Trafodion Installer>>
+for more information.
+2. Refer to <<enable-security,Enable Security>> for more information about
these security settings.
+
+
+<<<
+[[prepare-install-required-software-packages]]
+== Install Required Software Packages
+
+[[prepare-download-and-install-packages]]
+=== Download and Install Packages
+
+The step is required if you're:
--- End diff --
Do you mean, "This step..."?
---
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.
---
