From bd91d392b75d504d5d670f710bec828a07804773 Mon Sep 17 00:00:00 2001 From: David Yozie Date: Wed, 18 Mar 2020 17:34:10 -0700 Subject: [PATCH] Docs - further reorg of pl/container files --- gpdb-doc/dita/analytics/analytics.ditamap | 1 + gpdb-doc/dita/analytics/pl_container.xml | 22 +++++++++---------- .../dita/analytics/pl_container_using.xml | 10 ++++----- .../ref/plcontainer-configuration.xml} | 10 ++++----- .../ref/plcontainer.xml} | 2 +- .../dita/utility_guide/utility_guide.ditamap | 2 ++ 6 files changed, 25 insertions(+), 22 deletions(-) rename gpdb-doc/dita/{analytics/plcontainer-configuration-xml.xml => utility_guide/ref/plcontainer-configuration.xml} (98%) rename gpdb-doc/dita/{analytics/plcontainer_ref.xml => utility_guide/ref/plcontainer.xml} (99%) diff --git a/gpdb-doc/dita/analytics/analytics.ditamap b/gpdb-doc/dita/analytics/analytics.ditamap index a48f78574a..d8ad687ca1 100644 --- a/gpdb-doc/dita/analytics/analytics.ditamap +++ b/gpdb-doc/dita/analytics/analytics.ditamap @@ -18,6 +18,7 @@ + diff --git a/gpdb-doc/dita/analytics/pl_container.xml b/gpdb-doc/dita/analytics/pl_container.xml index 4e21c04ea3..6eaedb0ea9 100644 --- a/gpdb-doc/dita/analytics/pl_container.xml +++ b/gpdb-doc/dita/analytics/pl_container.xml @@ -155,7 +155,7 @@
  • Make sure Greenplum Database is up and running:gpstate -sIf it's not, start it:gpstart -a
  • Run the package installation - command:gppkg -i plcontainer-2.1.0-rhel7-x86_64.gppkg
    • + command:gppkg -i plcontainer-2.1.1-rhel7-x86_64.gppkg
  • Source the file $GPHOME/greenplum_path.sh:source $GPHOME/greenplum_path.sh
  • Restart Greenplum Database:gpstop -ra
    • @@ -182,8 +182,8 @@
    • Download the tar.gz files that contain the Docker images from from VMware Tanzu - Network. For example, for Greenplum 6.3, download PL/Container Docker Image - for Python with file name plcontainer-python-image-2.1.0-gp6.tar.gz + Network. For example, for Greenplum 6.5, download PL/Container Docker Image + for Python with file name plcontainer-python-image-2.1.1-gp6.tar.gz which includes Python 2.7.12 and the Python Data Science Module Package.

      If you require different images from the ones provided by Pivotal, you can create custom Docker images, install the image and add the image to the PL/ Container configuration. @@ -193,20 +193,20 @@ install the images on all Greenplum Database hosts where -f indicates the location of the downloaded files:

      # Install a Python 2 based Docker image -plcontainer image-add -f /home/gpadmin/plcontainer-python-image-2.1.0-gp6.tar.gz +plcontainer image-add -f /home/gpadmin/plcontainer-python-image-2.1.1-gp6.tar.gz # Install a Python 3 based Docker image -plcontainer image-add -f /home/gpadmin/plcontainer-python3-image-2.1.0-gp6.tar.gz +plcontainer image-add -f /home/gpadmin/plcontainer-python3-image-2.1.1-gp6.tar.gz # Install an R based Docker image -plcontainer image-add -f /home/gpadmin/plcontainer-r-image-2.1.0-gp6.tar.gz +plcontainer image-add -f /home/gpadmin/plcontainer-r-image-2.1.1-gp6.tar.gz

      The utility displays progress information, similar to:

      20200127:21:54:43:004607 plcontainer:mdw:gpadmin-[INFO]:-Checking whether docker is installed on all hosts... 20200127:21:54:43:004607 plcontainer:mdw:gpadmin-[INFO]:-Distributing image file /home/gpadmin/plcontainer-python-images-1.5.0.tar to all hosts... 20200127:21:54:55:004607 plcontainer:mdw:gpadmin-[INFO]:-Loading image on all hosts... 20200127:21:55:37:004607 plcontainer:mdw:gpadmin-[INFO]:-Removing temporary image files on all hosts...

      For more information on image-add options, visit the plcontainer reference page.

      + href="../utility_guide/ref/plcontainer.xml#topic_rw3_52s_dw">plcontainer reference page.

    • To display the installed Docker images on the local host use: $ plcontainer image-listFor details on other runtime-add options, see the plcontainer reference page. + href="../utility_guide/ref/plcontainer.xml#topic_rw3_52s_dw">plcontainer reference page.

    • Optional: Use Greenplum Database resource groups to manage and limit the total CPU and memory resources of containers in PL/Container runtimes. In this example, the Python @@ -330,8 +330,8 @@ $$ LANGUAGE plcontainer;
    • Use the Greenplum Database gppkg utility with the -u option to update the PL/Container language extension. For example, the following command updates the PL/Container language extension to version - 2.1.0 on a Linux - system:$ gppkg -u plcontainer-2.1.0-gp6-rhel7_x86_64.gppkg
      • + 2.1.1 on a Linux + system:$ gppkg -u plcontainer-2.1.1-gp6-rhel7_x86_64.gppkg
    • Source the Greenplum Database environment file $GPHOME/greenplum_path.sh.$ source $GPHOME/greenplum_path.sh
    • Restore the PL/Container configuration that you saved in a previous step: @@ -397,7 +397,7 @@ $$ LANGUAGE plcontainer;
    • Use the Greenplum Database gppkg utility with the -r option to uninstall the PL/Container language extension. This example uninstalls the PL/Container language extension on a Linux - system:$ gppkg -r plcontainer-2.1.0

      You can run the + system:$ gppkg -r plcontainer-2.1.1

      You can run the gppkg utility with the options -q --all to list the installed extensions and their versions.

    • Reload diff --git a/gpdb-doc/dita/analytics/pl_container_using.xml b/gpdb-doc/dita/analytics/pl_container_using.xml index 9998ed63e7..865aec22d1 100644 --- a/gpdb-doc/dita/analytics/pl_container_using.xml +++ b/gpdb-doc/dita/analytics/pl_container_using.xml @@ -28,7 +28,7 @@ memory resources available to each container instance. The cpu_share setting identifies the relative weighting of a container's CPU usage compared to other containers. See for further + href="../utility_guide/ref/plcontainer-configuration.xml" format="dita"/> for further details.

      You cannot, by default, restrict the number of executing PL/Container container instances, nor can you restrict the total amount of memory or CPU resources that @@ -87,7 +87,7 @@ plcontainer runtime-add -r python_run1 -i pivotaldata/plcontainer_python_shared:devel -l python -s resource_group_id=16391

      You can also assign a resource group to a PL/Container runtime using the plcontainer runtime-edit command. For information about the - plcontainer command, see plcontainer command, see reference page.

      After you assign a resource group to a PL/Container runtime, all container instances that share the same runtime configuration are subject to the memory @@ -154,7 +154,7 @@ plcontainer runtime-add -r python_run1 -i pivotaldata/plcontainer_python_shared:devel -l python -s resource_group_id=16391 plcontainer runtime-replace -r r_run1 -i pivotaldata/plcontainer_r_shared:devel -l r -s resource_group_id=16393

      For information about the plcontainer command, see reference page.

      • + href="../utility_guide/ref/plcontainer.xml" format="dita"/> reference page.

      @@ -236,7 +236,7 @@ configuration file plcontainer_configuration.xml, there is a runtime XML element that contains a corresponding id XML element that specifies the Docker container startup - information. See for information about how PL/Container maps the ID to a Docker image. See for example UDF definitions.

      @@ -323,7 +323,7 @@ Docker image to be started. If you configured PL/Container with a different ID, change the value of the # container line. For information about configuring PL/Container and viewing the configuration settings, see .

      + href="../utility_guide/ref/plcontainer-configuration.xml" format="dita"/>.

      This is an example of PL/Python function that runs using the plc_python_shared container that contains Python 2:CREATE OR REPLACE FUNCTION pylog100() RETURNS double precision AS $$ diff --git a/gpdb-doc/dita/analytics/plcontainer-configuration-xml.xml b/gpdb-doc/dita/utility_guide/ref/plcontainer-configuration.xml similarity index 98% rename from gpdb-doc/dita/analytics/plcontainer-configuration-xml.xml rename to gpdb-doc/dita/utility_guide/ref/plcontainer-configuration.xml index 196218b9f3..3faf5e3544 100644 --- a/gpdb-doc/dita/analytics/plcontainer-configuration-xml.xml +++ b/gpdb-doc/dita/utility_guide/ref/plcontainer-configuration.xml @@ -1,7 +1,7 @@ - PL/Container Configuration File + plcontainer Configuration File

      The Greenplum Database utility plcontainer manages the PL/Container configuration files in a Greenplum Database system. The utility @@ -213,7 +213,7 @@ runtime configuration, its container instances are limited only by system resources. For information about managing PL/Container resources, see About PL/Container Resource Management. @@ -243,12 +243,12 @@ logging (the default). The Greenplum Database server configuration parameter log_min_messages + href="../../ref_guide/config_params/guc-list.xml#log_min_messages" + scope="local">log_min_messages controls the PL/Container log level. The default log level is warning. For information about PL/Container log information, see Notes.

      By default, the PL/Container log information is diff --git a/gpdb-doc/dita/analytics/plcontainer_ref.xml b/gpdb-doc/dita/utility_guide/ref/plcontainer.xml similarity index 99% rename from gpdb-doc/dita/analytics/plcontainer_ref.xml rename to gpdb-doc/dita/utility_guide/ref/plcontainer.xml index 1dd82aa42c..1d3d6cfaf5 100644 --- a/gpdb-doc/dita/analytics/plcontainer_ref.xml +++ b/gpdb-doc/dita/utility_guide/ref/plcontainer.xml @@ -146,7 +146,7 @@ for the container. The value is either yes (enable logging) or no (disable logging, the default).

      The Greenplum Database server configuration parameter log_min_messages controls the log level. The default log level is warning. For information about PL/Container log information, see + + -- GitLab