miscellaneous doc updates (closes #115)
Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/4759d34c Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/4759d34c Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/4759d34c Branch: refs/heads/master Commit: 4759d34c62c0e2364ceaa5b36d94d31552ca8103 Parents: 12c58b1 Author: Lisa Owen <lo...@pivotal.io> Authored: Tue Apr 4 16:21:56 2017 -0700 Committer: David Yozie <yo...@apache.org> Committed: Tue Apr 4 16:21:56 2017 -0700 ---------------------------------------------------------------------- .../source/subnavs/apache-hawq-nav.erb | 1 - ...ckingUpandRestoringHAWQDatabases.html.md.erb | 4 +- markdown/admin/MasterMirroring.html.md.erb | 2 +- markdown/admin/ambari-admin.html.md.erb | 19 + markdown/admin/ambari-rest-api.html.md.erb | 19 + markdown/ddl/ddl-partition.html.md.erb | 2 +- markdown/images/gpfdist_instances.png | Bin 0 -> 26236 bytes markdown/images/gpfdist_instances_backup.png | Bin 0 -> 48414 bytes .../images/hawq_architecture_components.png | Bin 0 -> 99650 bytes .../images/hawq_high_level_architecture.png | Bin 0 -> 491840 bytes markdown/images/partitions.jpg | Bin 0 -> 43514 bytes markdown/images/source/gporca.graffle | Bin 0 -> 2814 bytes markdown/images/source/hawq_hcatalog.graffle | Bin 0 -> 2967 bytes markdown/images/standby_master.jpg | Bin 0 -> 18180 bytes .../images/svg/hawq_architecture_components.svg | 1083 ++++++++++++++++++ markdown/images/svg/hawq_hcatalog.svg | 3 + .../images/svg/hawq_resource_management.svg | 621 ++++++++++ markdown/images/svg/hawq_resource_queues.svg | 340 ++++++ markdown/images/unused/03-gpload-files.jpg | Bin 0 -> 38954 bytes markdown/images/unused/1-assign-masters.tiff | Bin 0 -> 248134 bytes markdown/images/unused/1-choose-services.tiff | Bin 0 -> 258298 bytes .../unused/3-assign-slaves-and-clients.tiff | Bin 0 -> 199176 bytes .../unused/4-customize-services-hawq.tiff | Bin 0 -> 241800 bytes .../images/unused/5-customize-services-pxf.tiff | Bin 0 -> 192364 bytes markdown/images/unused/6-review.tiff | Bin 0 -> 230890 bytes .../images/unused/7-install-start-test.tiff | Bin 0 -> 204112 bytes markdown/images/unused/gp_orca_fallback.png | Bin 0 -> 14683 bytes markdown/images/unused/piv-opt.png | Bin 0 -> 4823 bytes markdown/images/unused/resource_queues.jpg | Bin 0 -> 18793 bytes markdown/mdimages/02-pipeline.png | Bin 40864 -> 0 bytes markdown/mdimages/03-gpload-files.jpg | Bin 38954 -> 0 bytes markdown/mdimages/1-assign-masters.tiff | Bin 248134 -> 0 bytes markdown/mdimages/1-choose-services.tiff | Bin 258298 -> 0 bytes .../mdimages/3-assign-slaves-and-clients.tiff | Bin 199176 -> 0 bytes .../mdimages/4-customize-services-hawq.tiff | Bin 241800 -> 0 bytes markdown/mdimages/5-customize-services-pxf.tiff | Bin 192364 -> 0 bytes markdown/mdimages/6-review.tiff | Bin 230890 -> 0 bytes markdown/mdimages/7-install-start-test.tiff | Bin 204112 -> 0 bytes markdown/mdimages/ext-tables-xml.png | Bin 92048 -> 0 bytes markdown/mdimages/ext_tables.jpg | Bin 65371 -> 0 bytes markdown/mdimages/ext_tables_multinic.jpg | Bin 24394 -> 0 bytes markdown/mdimages/gangs.jpg | Bin 30405 -> 0 bytes markdown/mdimages/gp_orca_fallback.png | Bin 14683 -> 0 bytes markdown/mdimages/gpfdist_instances.png | Bin 26236 -> 0 bytes markdown/mdimages/gpfdist_instances_backup.png | Bin 48414 -> 0 bytes markdown/mdimages/gporca.png | Bin 53323 -> 0 bytes .../mdimages/hawq_architecture_components.png | Bin 99650 -> 0 bytes markdown/mdimages/hawq_hcatalog.png | Bin 120047 -> 0 bytes .../mdimages/hawq_high_level_architecture.png | Bin 491840 -> 0 bytes markdown/mdimages/partitions.jpg | Bin 43514 -> 0 bytes markdown/mdimages/piv-opt.png | Bin 4823 -> 0 bytes markdown/mdimages/resource_queues.jpg | Bin 18793 -> 0 bytes markdown/mdimages/slice_plan.jpg | Bin 53086 -> 0 bytes markdown/mdimages/source/gporca.graffle | Bin 2814 -> 0 bytes markdown/mdimages/source/hawq_hcatalog.graffle | Bin 2967 -> 0 bytes markdown/mdimages/standby_master.jpg | Bin 18180 -> 0 bytes .../svg/hawq_architecture_components.svg | 1083 ------------------ markdown/mdimages/svg/hawq_hcatalog.svg | 3 - .../mdimages/svg/hawq_resource_management.svg | 621 ---------- markdown/mdimages/svg/hawq_resource_queues.svg | 340 ------ markdown/overview/HAWQArchitecture.html.md.erb | 4 +- .../guc/parameter_definitions.html.md.erb | 9 - .../HAWQResourceManagement.html.md.erb | 4 +- .../resourcemgmt/ResourceQueues.html.md.erb | 2 +- 64 files changed, 2094 insertions(+), 2066 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/book/master_middleman/source/subnavs/apache-hawq-nav.erb ---------------------------------------------------------------------- diff --git a/book/master_middleman/source/subnavs/apache-hawq-nav.erb b/book/master_middleman/source/subnavs/apache-hawq-nav.erb index 054cc01..c511d0e 100644 --- a/book/master_middleman/source/subnavs/apache-hawq-nav.erb +++ b/book/master_middleman/source/subnavs/apache-hawq-nav.erb @@ -561,7 +561,6 @@ <li><a href="/docs/userguide/2.2.0.0-incubating/reference/guc/parameter_definitions.html#default_tablespace">default_tablespace</a></li> <li><a href="/docs/userguide/2.2.0.0-incubating/reference/guc/parameter_definitions.html#default_transaction_isolation">default_transaction_isolation</a></li> <li><a href="/docs/userguide/2.2.0.0-incubating/reference/guc/parameter_definitions.html#default_transaction_read_only">default_transaction_read_only</a></li> - <li><a href="/docs/userguide/2.2.0.0-incubating/reference/guc/parameter_definitions.html#dfs_url">dfs_url</a></li> <li><a href="/docs/userguide/2.2.0.0-incubating/reference/guc/parameter_definitions.html#dynamic_library_path">dynamic_library_path</a></li> <li><a href="/docs/userguide/2.2.0.0-incubating/reference/guc/parameter_definitions.html#effective_cache_size">effective_cache_size</a></li> <li><a href="/docs/userguide/2.2.0.0-incubating/reference/guc/parameter_definitions.html#enable_bitmapscan">enable_bitmapscan</a></li> http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/admin/BackingUpandRestoringHAWQDatabases.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/admin/BackingUpandRestoringHAWQDatabases.html.md.erb b/markdown/admin/BackingUpandRestoringHAWQDatabases.html.md.erb index f1e651a..20cebd3 100644 --- a/markdown/admin/BackingUpandRestoringHAWQDatabases.html.md.erb +++ b/markdown/admin/BackingUpandRestoringHAWQDatabases.html.md.erb @@ -173,11 +173,11 @@ This section discusses `gpfdist` and shows an example of how to backup and resto To use `gpfdist`, start the `gpfdist` server program on the host where you want to store backup files. You can start multiple `gpfdist` instances on the same host or on different hosts. For each `gpfdist` instance, you specify a directory from which `gpfdist` will serve files for readable external tables or create output files for writable external tables. For example, if you have a dedicated machine for backup with two disks, you can start two `gpfdist` instances, each using one disk: - + You can also run `gpfdist` instances on each segment host. During backup, table data will be evenly distributed to all `gpfdist` instances specified in the `LOCATION` clause in the `CREATE EXTERNAL TABLE` definition. - + ### <a id="example"></a>Example http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/admin/MasterMirroring.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/admin/MasterMirroring.html.md.erb b/markdown/admin/MasterMirroring.html.md.erb index 090f882..fb8e0d2 100644 --- a/markdown/admin/MasterMirroring.html.md.erb +++ b/markdown/admin/MasterMirroring.html.md.erb @@ -33,7 +33,7 @@ Since the master does not house user data, only system catalog tables are synchr *Figure 1: Master Mirroring in HAWQ* - + If the primary master fails, the replication process stops, and an administrator can activate the standby master. Upon activation of the standby master, the replicated logs reconstruct the state of the primary master at the time of the last successfully committed transaction. The activated standby then functions as the HAWQ master, accepting connections on the port specified when the standby master was initialized. http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/admin/ambari-admin.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/admin/ambari-admin.html.md.erb b/markdown/admin/ambari-admin.html.md.erb index ba69a7d..73c7c39 100644 --- a/markdown/admin/ambari-admin.html.md.erb +++ b/markdown/admin/ambari-admin.html.md.erb @@ -1,6 +1,25 @@ --- title: Managing HAWQ Using Ambari --- + +<!-- +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. +--> Ambari provides an easy interface to perform some of the most common HAWQ and PXF Administration Tasks. http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/admin/ambari-rest-api.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/admin/ambari-rest-api.html.md.erb b/markdown/admin/ambari-rest-api.html.md.erb index f029acb..34d640f 100644 --- a/markdown/admin/ambari-rest-api.html.md.erb +++ b/markdown/admin/ambari-rest-api.html.md.erb @@ -2,6 +2,25 @@ title: Using the Ambari REST API --- +<!-- +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. +--> + You can monitor and manage the resources in your HAWQ cluster using the Ambari REST API. In addition to providing access to the metrics information in your cluster, the API supports viewing, creating, deleting, and updating cluster resources. This section will provide an introduction to using the Ambari REST APIs for HAWQ-related cluster management activities. http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/ddl/ddl-partition.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/ddl/ddl-partition.html.md.erb b/markdown/ddl/ddl-partition.html.md.erb index b0dc3f4..4e1c3f4 100644 --- a/markdown/ddl/ddl-partition.html.md.erb +++ b/markdown/ddl/ddl-partition.html.md.erb @@ -32,7 +32,7 @@ HAWQ supports: - A combination of both types. <a id="im207241"></a> - + ## <a id="topic64"></a>Table Partitioning in HAWQ http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/images/gpfdist_instances.png ---------------------------------------------------------------------- diff --git a/markdown/images/gpfdist_instances.png b/markdown/images/gpfdist_instances.png new file mode 100644 index 0000000..6fae2d4 Binary files /dev/null and b/markdown/images/gpfdist_instances.png differ http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/images/gpfdist_instances_backup.png ---------------------------------------------------------------------- diff --git a/markdown/images/gpfdist_instances_backup.png b/markdown/images/gpfdist_instances_backup.png new file mode 100644 index 0000000..7cd3e1a Binary files /dev/null and b/markdown/images/gpfdist_instances_backup.png differ http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/images/hawq_architecture_components.png ---------------------------------------------------------------------- diff --git a/markdown/images/hawq_architecture_components.png b/markdown/images/hawq_architecture_components.png new file mode 100644 index 0000000..cea50b0 Binary files /dev/null and b/markdown/images/hawq_architecture_components.png differ http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/images/hawq_high_level_architecture.png ---------------------------------------------------------------------- diff --git a/markdown/images/hawq_high_level_architecture.png b/markdown/images/hawq_high_level_architecture.png new file mode 100644 index 0000000..d88bf7a Binary files /dev/null and b/markdown/images/hawq_high_level_architecture.png differ http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/images/partitions.jpg ---------------------------------------------------------------------- diff --git a/markdown/images/partitions.jpg b/markdown/images/partitions.jpg new file mode 100644 index 0000000..d366e21 Binary files /dev/null and b/markdown/images/partitions.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/images/source/gporca.graffle ---------------------------------------------------------------------- diff --git a/markdown/images/source/gporca.graffle b/markdown/images/source/gporca.graffle new file mode 100644 index 0000000..fb835d5 Binary files /dev/null and b/markdown/images/source/gporca.graffle differ http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/images/source/hawq_hcatalog.graffle ---------------------------------------------------------------------- diff --git a/markdown/images/source/hawq_hcatalog.graffle b/markdown/images/source/hawq_hcatalog.graffle new file mode 100644 index 0000000..f46bfb2 Binary files /dev/null and b/markdown/images/source/hawq_hcatalog.graffle differ http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/4759d34c/markdown/images/standby_master.jpg ---------------------------------------------------------------------- diff --git a/markdown/images/standby_master.jpg b/markdown/images/standby_master.jpg new file mode 100644 index 0000000..ef195ab Binary files /dev/null and b/markdown/images/standby_master.jpg differ
