You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hawq.apache.org by lisakowen <gi...@git.apache.org> on 2016/12/30 16:27:43 UTC
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
GitHub user lisakowen opened a pull request:
https://github.com/apache/incubator-hawq-docs/pull/80
HAWQ-1209 - hawq overview page
replace "Running a HAWQ Cluster" "Overview" section content (previously just a set of bullets with links) with several new sections providing an intro to hawq users/systems/databases/data/environment including links to relevant doc sections.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/lisakowen/incubator-hawq-docs feature/hawq-openv-intro
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-hawq-docs/pull/80.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #80
----
commit 26429566aba9a438a9372f707e3a0fa0cf27e556
Author: Lisa Owen <lo...@pivotal.io>
Date: 2016-12-29T23:20:42Z
new page for intro to hawq op env - includes procedure
commit 51af87c81fca8f6821f5d8008d0a511ade371049
Author: Lisa Owen <lo...@pivotal.io>
Date: 2016-12-30T16:01:32Z
running hawq to include intro info
----
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94877959
--- Diff: admin/RunningHAWQ.html.md.erb ---
@@ -2,21 +2,36 @@
title: Running a HAWQ Cluster
---
-This section provides information for system administrators and database superusers responsible for administering a HAWQ system.
-
-This guide provides information and instructions for configuring, maintaining and using a HAWQ system. This guide is intended for system and database administrators responsible for managing a HAWQ system.
-
-This guide assumes knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\). Because HAWQ is based on PostgreSQL 8.2.15, this guide assumes some familiarity with PostgreSQL. This guide calls out similarities between HAWQ and PostgreSQL features throughout. It contains the topics:
-
-* <a class="subnav" href="./ambari-admin.html">Managing HAWQ Using Ambari</a>
-* <a class="subnav" href="./startstop.html">Starting and Stopping HAWQ</a>
-* <a class="subnav" href="./ClusterExpansion.html">Expanding a Cluster</a>
-* <a class="subnav" href="./ClusterShrink.html">Removing a Node</a>
-* <a class="subnav" href="./BackingUpandRestoringHAWQDatabases.html">Backing Up and Restoring HAWQ</a>
-* <a class="subnav" href="./HighAvailability.html">High Availability in HAWQ</a>
-* <a class="subnav" href="./MasterMirroring.html">Master Mirroring</a>
-* <a class="subnav" href="./HAWQFilespacesandHighAvailabilityEnabledHDFS.html">HAWQ Filespaces and High Availability Enabled HDFS</a>
-* <a class="subnav" href="./FaultTolerance.html">Understanding the Fault Tolerance Service</a>
-* <a class="subnav" href="./RecommendedMonitoringTasks.html">Recommended Monitoring and Maintenance Tasks</a>
-* <a class="subnav" href="./maintain.html">Routine System Maintenance Tasks</a>
-* <a class="subnav" href="./monitor.html">Monitoring a HAWQ System</a>
+Your HAWQ deployment environment is a collection of systems, processes, and data, and the users that operate on these systems, processes, and data. This section provides information for system administrators and database superusers responsible for administering a HAWQ deployment.
+
+You should have some knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\) to administer a HAWQ cluster. Because HAWQ is based on PostgreSQL 8.2.15, you should also have some familiarity with PostgreSQL. The HAWQ documentation calls out similarities between HAWQ and PostgreSQL features throughout.
+
+## <a id="hawq_users"></a>HAWQ Users
+
+HAWQ supports users with both administrative and operating privileges. The HAWQ administrator may choose to manage the HAWQ cluster using either Ambari or the command line. [Managing HAWQ Using Ambari](../admin/ambari-admin.html) provides Ambari-specific HAWQ cluster administration procedures. [Starting and Stopping HAWQ](startstop.html), [Expanding a Cluster](ClusterExpansion.html), and [Removing a Node](ClusterShrink.html) describe specific command-line-managed HAWQ cluster administration procedures. Other topics in this guide are applicable to both Ambari- and command-line-managed HAWQ clusters.
+
+The default HAWQ admininstrator user is named `gpadmin`. The HAWQ admin may choose to assign administrative and/or operating HAWQ privileges to additional users. Refer to [Configuring Client Authentication](../clientaccess/client_auth.html) and [Managing Roles and Privileges](../clientaccess/roles_privs.html) for additional information on HAWQ user configuration.
+
+## <a id="hawq_systems"></a>HAWQ Deployment Systems
+
+A typical HAWQ deployment will include single HDFS and HAWQ master and standby nodes and multiple HAWQ segment and HDFS data nodes. The HAWQ cluster may also include systems running PXF and other Hadoop services. Refer to [HAWQ Architecture](../overview/HAWQArchitecture.html) and [Select HAWQ Host Machines](../install/select-hosts.html) for information about the different systems in a HAWQ deployment and how they are configured.
+
+
+## <a id="hawq_env_databases"></a>HAWQ Databases
+
+[Creating and Managing Databases](../ddl/ddl-database.html) and [Creating and Managing Tables](../ddl/ddl-table.html) identify specific HAWQ database and table creation and access information.
+
--- End diff --
Change "identify specific HAWQ database and ..." to "describe HAWQ extensions database and table creation commands." or something similar.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94879877
--- Diff: admin/setuphawqopenv.html.md.erb ---
@@ -0,0 +1,81 @@
+---
+title: Introducing the HAWQ Operating Environment
+---
+
+Before invoking operations on a HAWQ cluster, you must set up your HAWQ environment. This set up is required for both administrative and non-administrative HAWQ users.
+
+## <a id="hawq_setupenv"></a>Procedure: Setting Up Your HAWQ Operating Environment
+
+HAWQ installs a script that you can use to set up your HAWQ cluster environment. The `greenplum_path.sh` script, located in your HAWQ root install directory, sets `$PATH` and other environment variables to find HAWQ files. Most importantly, `greenplum_path.sh` sets the `$GPHOME` environment variable to point to the root directory of the HAWQ installation. If you installed HAWQ from a product distribution, the HAWQ root is typically `/usr/local/hawq`. If you built HAWQ from source or downloaded the tarball, you will have selected an install root directory on your own.
+
+Perform the following steps to set up your HAWQ operating environment:
+
+1. Log in to the HAWQ \<node\-type\> system as the desired user. For example:
+
--- End diff --
Has this <node-type> convention been used elsewhere? It reads a bit awkwardly. Maybe just say "Login to a HAWQ node as the desired user."?
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94878929
--- Diff: admin/RunningHAWQ.html.md.erb ---
@@ -2,21 +2,36 @@
title: Running a HAWQ Cluster
---
-This section provides information for system administrators and database superusers responsible for administering a HAWQ system.
-
-This guide provides information and instructions for configuring, maintaining and using a HAWQ system. This guide is intended for system and database administrators responsible for managing a HAWQ system.
-
-This guide assumes knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\). Because HAWQ is based on PostgreSQL 8.2.15, this guide assumes some familiarity with PostgreSQL. This guide calls out similarities between HAWQ and PostgreSQL features throughout. It contains the topics:
-
-* <a class="subnav" href="./ambari-admin.html">Managing HAWQ Using Ambari</a>
-* <a class="subnav" href="./startstop.html">Starting and Stopping HAWQ</a>
-* <a class="subnav" href="./ClusterExpansion.html">Expanding a Cluster</a>
-* <a class="subnav" href="./ClusterShrink.html">Removing a Node</a>
-* <a class="subnav" href="./BackingUpandRestoringHAWQDatabases.html">Backing Up and Restoring HAWQ</a>
-* <a class="subnav" href="./HighAvailability.html">High Availability in HAWQ</a>
-* <a class="subnav" href="./MasterMirroring.html">Master Mirroring</a>
-* <a class="subnav" href="./HAWQFilespacesandHighAvailabilityEnabledHDFS.html">HAWQ Filespaces and High Availability Enabled HDFS</a>
-* <a class="subnav" href="./FaultTolerance.html">Understanding the Fault Tolerance Service</a>
-* <a class="subnav" href="./RecommendedMonitoringTasks.html">Recommended Monitoring and Maintenance Tasks</a>
-* <a class="subnav" href="./maintain.html">Routine System Maintenance Tasks</a>
-* <a class="subnav" href="./monitor.html">Monitoring a HAWQ System</a>
+Your HAWQ deployment environment is a collection of systems, processes, and data, and the users that operate on these systems, processes, and data. This section provides information for system administrators and database superusers responsible for administering a HAWQ deployment.
+
+You should have some knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\) to administer a HAWQ cluster. Because HAWQ is based on PostgreSQL 8.2.15, you should also have some familiarity with PostgreSQL. The HAWQ documentation calls out similarities between HAWQ and PostgreSQL features throughout.
+
+## <a id="hawq_users"></a>HAWQ Users
+
+HAWQ supports users with both administrative and operating privileges. The HAWQ administrator may choose to manage the HAWQ cluster using either Ambari or the command line. [Managing HAWQ Using Ambari](../admin/ambari-admin.html) provides Ambari-specific HAWQ cluster administration procedures. [Starting and Stopping HAWQ](startstop.html), [Expanding a Cluster](ClusterExpansion.html), and [Removing a Node](ClusterShrink.html) describe specific command-line-managed HAWQ cluster administration procedures. Other topics in this guide are applicable to both Ambari- and command-line-managed HAWQ clusters.
+
+The default HAWQ admininstrator user is named `gpadmin`. The HAWQ admin may choose to assign administrative and/or operating HAWQ privileges to additional users. Refer to [Configuring Client Authentication](../clientaccess/client_auth.html) and [Managing Roles and Privileges](../clientaccess/roles_privs.html) for additional information on HAWQ user configuration.
+
+## <a id="hawq_systems"></a>HAWQ Deployment Systems
+
+A typical HAWQ deployment will include single HDFS and HAWQ master and standby nodes and multiple HAWQ segment and HDFS data nodes. The HAWQ cluster may also include systems running PXF and other Hadoop services. Refer to [HAWQ Architecture](../overview/HAWQArchitecture.html) and [Select HAWQ Host Machines](../install/select-hosts.html) for information about the different systems in a HAWQ deployment and how they are configured.
+
+
+## <a id="hawq_env_databases"></a>HAWQ Databases
+
+[Creating and Managing Databases](../ddl/ddl-database.html) and [Creating and Managing Tables](../ddl/ddl-table.html) identify specific HAWQ database and table creation and access information.
+
+You manage HAWQ databases at the command line using the [psql](../reference/cli/client_utilities/psql.html) utility, an interactive front-end to the HAWQ PostgreSQL database. Configuring client access to HAWQ databases and tables may require information related to [Establishing a Database Session](../clientaccess/g-establishing-a-database-session.html).
+
--- End diff --
I'd remove the postgresql reference here - it makes it sound like we just use a standard (unmodified) postgresql db.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94877686
--- Diff: admin/RunningHAWQ.html.md.erb ---
@@ -2,21 +2,36 @@
title: Running a HAWQ Cluster
---
-This section provides information for system administrators and database superusers responsible for administering a HAWQ system.
-
-This guide provides information and instructions for configuring, maintaining and using a HAWQ system. This guide is intended for system and database administrators responsible for managing a HAWQ system.
-
-This guide assumes knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\). Because HAWQ is based on PostgreSQL 8.2.15, this guide assumes some familiarity with PostgreSQL. This guide calls out similarities between HAWQ and PostgreSQL features throughout. It contains the topics:
-
-* <a class="subnav" href="./ambari-admin.html">Managing HAWQ Using Ambari</a>
-* <a class="subnav" href="./startstop.html">Starting and Stopping HAWQ</a>
-* <a class="subnav" href="./ClusterExpansion.html">Expanding a Cluster</a>
-* <a class="subnav" href="./ClusterShrink.html">Removing a Node</a>
-* <a class="subnav" href="./BackingUpandRestoringHAWQDatabases.html">Backing Up and Restoring HAWQ</a>
-* <a class="subnav" href="./HighAvailability.html">High Availability in HAWQ</a>
-* <a class="subnav" href="./MasterMirroring.html">Master Mirroring</a>
-* <a class="subnav" href="./HAWQFilespacesandHighAvailabilityEnabledHDFS.html">HAWQ Filespaces and High Availability Enabled HDFS</a>
-* <a class="subnav" href="./FaultTolerance.html">Understanding the Fault Tolerance Service</a>
-* <a class="subnav" href="./RecommendedMonitoringTasks.html">Recommended Monitoring and Maintenance Tasks</a>
-* <a class="subnav" href="./maintain.html">Routine System Maintenance Tasks</a>
-* <a class="subnav" href="./monitor.html">Monitoring a HAWQ System</a>
+Your HAWQ deployment environment is a collection of systems, processes, and data, and the users that operate on these systems, processes, and data. This section provides information for system administrators and database superusers responsible for administering a HAWQ deployment.
+
+You should have some knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\) to administer a HAWQ cluster. Because HAWQ is based on PostgreSQL 8.2.15, you should also have some familiarity with PostgreSQL. The HAWQ documentation calls out similarities between HAWQ and PostgreSQL features throughout.
+
+## <a id="hawq_users"></a>HAWQ Users
+
+HAWQ supports users with both administrative and operating privileges. The HAWQ administrator may choose to manage the HAWQ cluster using either Ambari or the command line. [Managing HAWQ Using Ambari](../admin/ambari-admin.html) provides Ambari-specific HAWQ cluster administration procedures. [Starting and Stopping HAWQ](startstop.html), [Expanding a Cluster](ClusterExpansion.html), and [Removing a Node](ClusterShrink.html) describe specific command-line-managed HAWQ cluster administration procedures. Other topics in this guide are applicable to both Ambari- and command-line-managed HAWQ clusters.
+
+The default HAWQ admininstrator user is named `gpadmin`. The HAWQ admin may choose to assign administrative and/or operating HAWQ privileges to additional users. Refer to [Configuring Client Authentication](../clientaccess/client_auth.html) and [Managing Roles and Privileges](../clientaccess/roles_privs.html) for additional information on HAWQ user configuration.
+
+## <a id="hawq_systems"></a>HAWQ Deployment Systems
+
+A typical HAWQ deployment will include single HDFS and HAWQ master and standby nodes and multiple HAWQ segment and HDFS data nodes. The HAWQ cluster may also include systems running PXF and other Hadoop services. Refer to [HAWQ Architecture](../overview/HAWQArchitecture.html) and [Select HAWQ Host Machines](../install/select-hosts.html) for information about the different systems in a HAWQ deployment and how they are configured.
+
--- End diff --
Change "will include" to "includes" . (In general try to avoid using 'will' and keep things in the present.)
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94880323
--- Diff: admin/setuphawqopenv.html.md.erb ---
@@ -0,0 +1,81 @@
+---
+title: Introducing the HAWQ Operating Environment
+---
+
+Before invoking operations on a HAWQ cluster, you must set up your HAWQ environment. This set up is required for both administrative and non-administrative HAWQ users.
+
+## <a id="hawq_setupenv"></a>Procedure: Setting Up Your HAWQ Operating Environment
+
+HAWQ installs a script that you can use to set up your HAWQ cluster environment. The `greenplum_path.sh` script, located in your HAWQ root install directory, sets `$PATH` and other environment variables to find HAWQ files. Most importantly, `greenplum_path.sh` sets the `$GPHOME` environment variable to point to the root directory of the HAWQ installation. If you installed HAWQ from a product distribution, the HAWQ root is typically `/usr/local/hawq`. If you built HAWQ from source or downloaded the tarball, you will have selected an install root directory on your own.
+
+Perform the following steps to set up your HAWQ operating environment:
+
+1. Log in to the HAWQ \<node\-type\> system as the desired user. For example:
+
+ ``` shell
+ $ ssh gpadmin@<master>
+ gpadmin@master$
+ ```
+
+ Or, if you are already logged in to \<node\-type\> as a different user, switch to the desired user. For example:
+
+ ``` shell
+ gpadmin@master$ su - <hawq-user>
+ Password:
+ hawq-user@master$
+ ```
+
+2. Set up your HAWQ operating environment by sourcing the `greenplum_path.sh` file. For HAWQ deployments installed from a product distribution:
+
+ ``` shell
+ hawq-node$ source /usr/local/hawq/greenplum_path.sh
+ ```
+
+ If you built HAWQ from source or downloaded the tarball, substitute the path to the installed or extracted `greenplum_path.sh` file \(for example `/opt/hawq-2.1.0.0/greenplum_path.sh`\).
+
+
+3. Edit your `.bash_profile` or other shell initialization file to source `greenplum_path.sh` on login. For example, add:
+
+ ``` shell
+ source /usr/local/hawq/greenplum_path.sh
--- End diff --
This and a few of the following command blocks are omitting the shell prompt.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by lisakowen <gi...@git.apache.org>.
Github user lisakowen closed the pull request at:
https://github.com/apache/incubator-hawq-docs/pull/80
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94879281
--- Diff: admin/RunningHAWQ.html.md.erb ---
@@ -2,21 +2,36 @@
title: Running a HAWQ Cluster
---
-This section provides information for system administrators and database superusers responsible for administering a HAWQ system.
-
-This guide provides information and instructions for configuring, maintaining and using a HAWQ system. This guide is intended for system and database administrators responsible for managing a HAWQ system.
-
-This guide assumes knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\). Because HAWQ is based on PostgreSQL 8.2.15, this guide assumes some familiarity with PostgreSQL. This guide calls out similarities between HAWQ and PostgreSQL features throughout. It contains the topics:
-
-* <a class="subnav" href="./ambari-admin.html">Managing HAWQ Using Ambari</a>
-* <a class="subnav" href="./startstop.html">Starting and Stopping HAWQ</a>
-* <a class="subnav" href="./ClusterExpansion.html">Expanding a Cluster</a>
-* <a class="subnav" href="./ClusterShrink.html">Removing a Node</a>
-* <a class="subnav" href="./BackingUpandRestoringHAWQDatabases.html">Backing Up and Restoring HAWQ</a>
-* <a class="subnav" href="./HighAvailability.html">High Availability in HAWQ</a>
-* <a class="subnav" href="./MasterMirroring.html">Master Mirroring</a>
-* <a class="subnav" href="./HAWQFilespacesandHighAvailabilityEnabledHDFS.html">HAWQ Filespaces and High Availability Enabled HDFS</a>
-* <a class="subnav" href="./FaultTolerance.html">Understanding the Fault Tolerance Service</a>
-* <a class="subnav" href="./RecommendedMonitoringTasks.html">Recommended Monitoring and Maintenance Tasks</a>
-* <a class="subnav" href="./maintain.html">Routine System Maintenance Tasks</a>
-* <a class="subnav" href="./monitor.html">Monitoring a HAWQ System</a>
+Your HAWQ deployment environment is a collection of systems, processes, and data, and the users that operate on these systems, processes, and data. This section provides information for system administrators and database superusers responsible for administering a HAWQ deployment.
+
+You should have some knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\) to administer a HAWQ cluster. Because HAWQ is based on PostgreSQL 8.2.15, you should also have some familiarity with PostgreSQL. The HAWQ documentation calls out similarities between HAWQ and PostgreSQL features throughout.
+
+## <a id="hawq_users"></a>HAWQ Users
+
+HAWQ supports users with both administrative and operating privileges. The HAWQ administrator may choose to manage the HAWQ cluster using either Ambari or the command line. [Managing HAWQ Using Ambari](../admin/ambari-admin.html) provides Ambari-specific HAWQ cluster administration procedures. [Starting and Stopping HAWQ](startstop.html), [Expanding a Cluster](ClusterExpansion.html), and [Removing a Node](ClusterShrink.html) describe specific command-line-managed HAWQ cluster administration procedures. Other topics in this guide are applicable to both Ambari- and command-line-managed HAWQ clusters.
+
+The default HAWQ admininstrator user is named `gpadmin`. The HAWQ admin may choose to assign administrative and/or operating HAWQ privileges to additional users. Refer to [Configuring Client Authentication](../clientaccess/client_auth.html) and [Managing Roles and Privileges](../clientaccess/roles_privs.html) for additional information on HAWQ user configuration.
+
+## <a id="hawq_systems"></a>HAWQ Deployment Systems
+
+A typical HAWQ deployment will include single HDFS and HAWQ master and standby nodes and multiple HAWQ segment and HDFS data nodes. The HAWQ cluster may also include systems running PXF and other Hadoop services. Refer to [HAWQ Architecture](../overview/HAWQArchitecture.html) and [Select HAWQ Host Machines](../install/select-hosts.html) for information about the different systems in a HAWQ deployment and how they are configured.
+
+
+## <a id="hawq_env_databases"></a>HAWQ Databases
+
+[Creating and Managing Databases](../ddl/ddl-database.html) and [Creating and Managing Tables](../ddl/ddl-table.html) identify specific HAWQ database and table creation and access information.
+
+You manage HAWQ databases at the command line using the [psql](../reference/cli/client_utilities/psql.html) utility, an interactive front-end to the HAWQ PostgreSQL database. Configuring client access to HAWQ databases and tables may require information related to [Establishing a Database Session](../clientaccess/g-establishing-a-database-session.html).
+
+[HAWQ Database Drivers and APIs](../clientaccess/g-database-application-interfaces.html) identifies supported HAWQ database drivers and APIs for additional client access methods.
+
+## <a id="hawq_env_data"></a>HAWQ Data
+
+HAWQ internal data resides in HDFS. You may require access to data in different formats and locations in your data lake. You can use HAWQ to query both internal and this external data:
+
--- End diff --
The lead-in sentence to this bullet list doesn't really seem to match (the bullets aren't talking about specific types of data).
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94879489
--- Diff: admin/RunningHAWQ.html.md.erb ---
@@ -2,21 +2,36 @@
title: Running a HAWQ Cluster
---
-This section provides information for system administrators and database superusers responsible for administering a HAWQ system.
-
-This guide provides information and instructions for configuring, maintaining and using a HAWQ system. This guide is intended for system and database administrators responsible for managing a HAWQ system.
-
-This guide assumes knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\). Because HAWQ is based on PostgreSQL 8.2.15, this guide assumes some familiarity with PostgreSQL. This guide calls out similarities between HAWQ and PostgreSQL features throughout. It contains the topics:
-
-* <a class="subnav" href="./ambari-admin.html">Managing HAWQ Using Ambari</a>
-* <a class="subnav" href="./startstop.html">Starting and Stopping HAWQ</a>
-* <a class="subnav" href="./ClusterExpansion.html">Expanding a Cluster</a>
-* <a class="subnav" href="./ClusterShrink.html">Removing a Node</a>
-* <a class="subnav" href="./BackingUpandRestoringHAWQDatabases.html">Backing Up and Restoring HAWQ</a>
-* <a class="subnav" href="./HighAvailability.html">High Availability in HAWQ</a>
-* <a class="subnav" href="./MasterMirroring.html">Master Mirroring</a>
-* <a class="subnav" href="./HAWQFilespacesandHighAvailabilityEnabledHDFS.html">HAWQ Filespaces and High Availability Enabled HDFS</a>
-* <a class="subnav" href="./FaultTolerance.html">Understanding the Fault Tolerance Service</a>
-* <a class="subnav" href="./RecommendedMonitoringTasks.html">Recommended Monitoring and Maintenance Tasks</a>
-* <a class="subnav" href="./maintain.html">Routine System Maintenance Tasks</a>
-* <a class="subnav" href="./monitor.html">Monitoring a HAWQ System</a>
+Your HAWQ deployment environment is a collection of systems, processes, and data, and the users that operate on these systems, processes, and data. This section provides information for system administrators and database superusers responsible for administering a HAWQ deployment.
+
+You should have some knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\) to administer a HAWQ cluster. Because HAWQ is based on PostgreSQL 8.2.15, you should also have some familiarity with PostgreSQL. The HAWQ documentation calls out similarities between HAWQ and PostgreSQL features throughout.
+
+## <a id="hawq_users"></a>HAWQ Users
+
+HAWQ supports users with both administrative and operating privileges. The HAWQ administrator may choose to manage the HAWQ cluster using either Ambari or the command line. [Managing HAWQ Using Ambari](../admin/ambari-admin.html) provides Ambari-specific HAWQ cluster administration procedures. [Starting and Stopping HAWQ](startstop.html), [Expanding a Cluster](ClusterExpansion.html), and [Removing a Node](ClusterShrink.html) describe specific command-line-managed HAWQ cluster administration procedures. Other topics in this guide are applicable to both Ambari- and command-line-managed HAWQ clusters.
+
+The default HAWQ admininstrator user is named `gpadmin`. The HAWQ admin may choose to assign administrative and/or operating HAWQ privileges to additional users. Refer to [Configuring Client Authentication](../clientaccess/client_auth.html) and [Managing Roles and Privileges](../clientaccess/roles_privs.html) for additional information on HAWQ user configuration.
+
+## <a id="hawq_systems"></a>HAWQ Deployment Systems
+
+A typical HAWQ deployment will include single HDFS and HAWQ master and standby nodes and multiple HAWQ segment and HDFS data nodes. The HAWQ cluster may also include systems running PXF and other Hadoop services. Refer to [HAWQ Architecture](../overview/HAWQArchitecture.html) and [Select HAWQ Host Machines](../install/select-hosts.html) for information about the different systems in a HAWQ deployment and how they are configured.
+
+
+## <a id="hawq_env_databases"></a>HAWQ Databases
+
+[Creating and Managing Databases](../ddl/ddl-database.html) and [Creating and Managing Tables](../ddl/ddl-table.html) identify specific HAWQ database and table creation and access information.
+
+You manage HAWQ databases at the command line using the [psql](../reference/cli/client_utilities/psql.html) utility, an interactive front-end to the HAWQ PostgreSQL database. Configuring client access to HAWQ databases and tables may require information related to [Establishing a Database Session](../clientaccess/g-establishing-a-database-session.html).
+
+[HAWQ Database Drivers and APIs](../clientaccess/g-database-application-interfaces.html) identifies supported HAWQ database drivers and APIs for additional client access methods.
+
+## <a id="hawq_env_data"></a>HAWQ Data
+
+HAWQ internal data resides in HDFS. You may require access to data in different formats and locations in your data lake. You can use HAWQ to query both internal and this external data:
+
+- [Managing Data with HAWQ](../datamgmt/dml.html) discusses the basic data operations and details regarding the loading and unloading semantics for HAWQ internal tables.
+- [Using PXF with Unmanaged Data](../pxf/HawqExtensionFrameworkPXF.html) describes PXF, an extensible framework you may use to query data external to HAWQ.
+
+## <a id="hawq_env_setup"></a>HAWQ Operating Environment
+
+Refer to [Introducing the HAWQ Operating Environment](setuphawqopenv.html) for a discussion of the HAWQ operating environment, including a procedure to set up the HAWQ environment. This section also provides and introduction to the important files and directories in a HAWQ installation.
--- End diff --
and -> an
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94880036
--- Diff: admin/setuphawqopenv.html.md.erb ---
@@ -0,0 +1,81 @@
+---
+title: Introducing the HAWQ Operating Environment
+---
+
+Before invoking operations on a HAWQ cluster, you must set up your HAWQ environment. This set up is required for both administrative and non-administrative HAWQ users.
+
+## <a id="hawq_setupenv"></a>Procedure: Setting Up Your HAWQ Operating Environment
+
+HAWQ installs a script that you can use to set up your HAWQ cluster environment. The `greenplum_path.sh` script, located in your HAWQ root install directory, sets `$PATH` and other environment variables to find HAWQ files. Most importantly, `greenplum_path.sh` sets the `$GPHOME` environment variable to point to the root directory of the HAWQ installation. If you installed HAWQ from a product distribution, the HAWQ root is typically `/usr/local/hawq`. If you built HAWQ from source or downloaded the tarball, you will have selected an install root directory on your own.
+
+Perform the following steps to set up your HAWQ operating environment:
+
+1. Log in to the HAWQ \<node\-type\> system as the desired user. For example:
+
+ ``` shell
+ $ ssh gpadmin@<master>
+ gpadmin@master$
+ ```
+
+ Or, if you are already logged in to \<node\-type\> as a different user, switch to the desired user. For example:
+
+ ``` shell
+ gpadmin@master$ su - <hawq-user>
+ Password:
+ hawq-user@master$
+ ```
+
+2. Set up your HAWQ operating environment by sourcing the `greenplum_path.sh` file. For HAWQ deployments installed from a product distribution:
--- End diff --
I think it's fine to remove "For HAWQ deployments installed from a product distribution:" here.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94877232
--- Diff: admin/RunningHAWQ.html.md.erb ---
@@ -2,21 +2,36 @@
title: Running a HAWQ Cluster
---
-This section provides information for system administrators and database superusers responsible for administering a HAWQ system.
-
-This guide provides information and instructions for configuring, maintaining and using a HAWQ system. This guide is intended for system and database administrators responsible for managing a HAWQ system.
-
-This guide assumes knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\). Because HAWQ is based on PostgreSQL 8.2.15, this guide assumes some familiarity with PostgreSQL. This guide calls out similarities between HAWQ and PostgreSQL features throughout. It contains the topics:
-
-* <a class="subnav" href="./ambari-admin.html">Managing HAWQ Using Ambari</a>
-* <a class="subnav" href="./startstop.html">Starting and Stopping HAWQ</a>
-* <a class="subnav" href="./ClusterExpansion.html">Expanding a Cluster</a>
-* <a class="subnav" href="./ClusterShrink.html">Removing a Node</a>
-* <a class="subnav" href="./BackingUpandRestoringHAWQDatabases.html">Backing Up and Restoring HAWQ</a>
-* <a class="subnav" href="./HighAvailability.html">High Availability in HAWQ</a>
-* <a class="subnav" href="./MasterMirroring.html">Master Mirroring</a>
-* <a class="subnav" href="./HAWQFilespacesandHighAvailabilityEnabledHDFS.html">HAWQ Filespaces and High Availability Enabled HDFS</a>
-* <a class="subnav" href="./FaultTolerance.html">Understanding the Fault Tolerance Service</a>
-* <a class="subnav" href="./RecommendedMonitoringTasks.html">Recommended Monitoring and Maintenance Tasks</a>
-* <a class="subnav" href="./maintain.html">Routine System Maintenance Tasks</a>
-* <a class="subnav" href="./monitor.html">Monitoring a HAWQ System</a>
+Your HAWQ deployment environment is a collection of systems, processes, and data, and the users that operate on these systems, processes, and data. This section provides information for system administrators and database superusers responsible for administering a HAWQ deployment.
+
+You should have some knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\) to administer a HAWQ cluster. Because HAWQ is based on PostgreSQL 8.2.15, you should also have some familiarity with PostgreSQL. The HAWQ documentation calls out similarities between HAWQ and PostgreSQL features throughout.
+
+## <a id="hawq_users"></a>HAWQ Users
+
+HAWQ supports users with both administrative and operating privileges. The HAWQ administrator may choose to manage the HAWQ cluster using either Ambari or the command line. [Managing HAWQ Using Ambari](../admin/ambari-admin.html) provides Ambari-specific HAWQ cluster administration procedures. [Starting and Stopping HAWQ](startstop.html), [Expanding a Cluster](ClusterExpansion.html), and [Removing a Node](ClusterShrink.html) describe specific command-line-managed HAWQ cluster administration procedures. Other topics in this guide are applicable to both Ambari- and command-line-managed HAWQ clusters.
+
+The default HAWQ admininstrator user is named `gpadmin`. The HAWQ admin may choose to assign administrative and/or operating HAWQ privileges to additional users. Refer to [Configuring Client Authentication](../clientaccess/client_auth.html) and [Managing Roles and Privileges](../clientaccess/roles_privs.html) for additional information on HAWQ user configuration.
+
--- End diff --
Change "on" to "about" or just lose "on HAWQ user configuration" entirely.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94876821
--- Diff: admin/RunningHAWQ.html.md.erb ---
@@ -2,21 +2,36 @@
title: Running a HAWQ Cluster
---
-This section provides information for system administrators and database superusers responsible for administering a HAWQ system.
-
-This guide provides information and instructions for configuring, maintaining and using a HAWQ system. This guide is intended for system and database administrators responsible for managing a HAWQ system.
-
-This guide assumes knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\). Because HAWQ is based on PostgreSQL 8.2.15, this guide assumes some familiarity with PostgreSQL. This guide calls out similarities between HAWQ and PostgreSQL features throughout. It contains the topics:
-
-* <a class="subnav" href="./ambari-admin.html">Managing HAWQ Using Ambari</a>
-* <a class="subnav" href="./startstop.html">Starting and Stopping HAWQ</a>
-* <a class="subnav" href="./ClusterExpansion.html">Expanding a Cluster</a>
-* <a class="subnav" href="./ClusterShrink.html">Removing a Node</a>
-* <a class="subnav" href="./BackingUpandRestoringHAWQDatabases.html">Backing Up and Restoring HAWQ</a>
-* <a class="subnav" href="./HighAvailability.html">High Availability in HAWQ</a>
-* <a class="subnav" href="./MasterMirroring.html">Master Mirroring</a>
-* <a class="subnav" href="./HAWQFilespacesandHighAvailabilityEnabledHDFS.html">HAWQ Filespaces and High Availability Enabled HDFS</a>
-* <a class="subnav" href="./FaultTolerance.html">Understanding the Fault Tolerance Service</a>
-* <a class="subnav" href="./RecommendedMonitoringTasks.html">Recommended Monitoring and Maintenance Tasks</a>
-* <a class="subnav" href="./maintain.html">Routine System Maintenance Tasks</a>
-* <a class="subnav" href="./monitor.html">Monitoring a HAWQ System</a>
+Your HAWQ deployment environment is a collection of systems, processes, and data, and the users that operate on these systems, processes, and data. This section provides information for system administrators and database superusers responsible for administering a HAWQ deployment.
+
--- End diff --
I think the lead sentence could use some cleanup - Your HAWQ deployment environment is a collection of systems, processes, data, and the users that operate on those systems, processes, and data.
Also, I know the original text mentioned database superusers but that seems a bit weird to call them out. I think we could just stick with "system administrators" here.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-hawq-docs pull request #80: HAWQ-1209 - hawq overview page
Posted by dyozie <gi...@git.apache.org>.
Github user dyozie commented on a diff in the pull request:
https://github.com/apache/incubator-hawq-docs/pull/80#discussion_r94878461
--- Diff: admin/RunningHAWQ.html.md.erb ---
@@ -2,21 +2,36 @@
title: Running a HAWQ Cluster
---
-This section provides information for system administrators and database superusers responsible for administering a HAWQ system.
-
-This guide provides information and instructions for configuring, maintaining and using a HAWQ system. This guide is intended for system and database administrators responsible for managing a HAWQ system.
-
-This guide assumes knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\). Because HAWQ is based on PostgreSQL 8.2.15, this guide assumes some familiarity with PostgreSQL. This guide calls out similarities between HAWQ and PostgreSQL features throughout. It contains the topics:
-
-* <a class="subnav" href="./ambari-admin.html">Managing HAWQ Using Ambari</a>
-* <a class="subnav" href="./startstop.html">Starting and Stopping HAWQ</a>
-* <a class="subnav" href="./ClusterExpansion.html">Expanding a Cluster</a>
-* <a class="subnav" href="./ClusterShrink.html">Removing a Node</a>
-* <a class="subnav" href="./BackingUpandRestoringHAWQDatabases.html">Backing Up and Restoring HAWQ</a>
-* <a class="subnav" href="./HighAvailability.html">High Availability in HAWQ</a>
-* <a class="subnav" href="./MasterMirroring.html">Master Mirroring</a>
-* <a class="subnav" href="./HAWQFilespacesandHighAvailabilityEnabledHDFS.html">HAWQ Filespaces and High Availability Enabled HDFS</a>
-* <a class="subnav" href="./FaultTolerance.html">Understanding the Fault Tolerance Service</a>
-* <a class="subnav" href="./RecommendedMonitoringTasks.html">Recommended Monitoring and Maintenance Tasks</a>
-* <a class="subnav" href="./maintain.html">Routine System Maintenance Tasks</a>
-* <a class="subnav" href="./monitor.html">Monitoring a HAWQ System</a>
+Your HAWQ deployment environment is a collection of systems, processes, and data, and the users that operate on these systems, processes, and data. This section provides information for system administrators and database superusers responsible for administering a HAWQ deployment.
+
+You should have some knowledge of Linux/UNIX system administration, database management systems, database administration, and structured query language \(SQL\) to administer a HAWQ cluster. Because HAWQ is based on PostgreSQL 8.2.15, you should also have some familiarity with PostgreSQL. The HAWQ documentation calls out similarities between HAWQ and PostgreSQL features throughout.
+
--- End diff --
I don't think it's necessarily useful to call out that postgresql version, given that we've ported features from later versions as well. It's probably enough to just say it's based on postgresql to give them a frame of reference.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---