Docs - updates for PL/Container 3 beta (#9773)

* Docs - updates for PL/Container 3 beta * Update to account for beta being available for Ubuntu * Update install, uninstall tasks for 3 Beta * Qualify r image as beta

Docs - updates for PL/Container 3 beta (#9773)
* Docs - updates for PL/Container 3 beta * Update to account for beta being available for Ubuntu * Update install, uninstall tasks for 3 Beta * Qualify r image as beta
e470a38b · David Yozie · GitHub · 04fdd0a6 · e470a38b
隐藏空白更改
内联并排

Showing with 63 addition and 12 deletion

gpdb-doc/dita/analytics/pl_container.xml gpdb-doc/dita/analytics/pl_container.xml +63 -12

未找到文件。
--- a/gpdb-doc/dita/analytics/pl_container.xml
+++ b/gpdb-doc/dita/analytics/pl_container.xml
@@ -75,6 +75,20 @@
          the container, and the container shuts down.</p>
        
      </section>
+      <section>
+        <title>About PL/Container 3 Beta</title>
+        <p>Greenplum Database 6.5 introduces PL/Container version 3 Beta, which:<ul
+            id="ul_jj3_lyq_blb">
+            <li>Provides support for the new GreenplumR interface.</li>
+            <li>Reduces the number of processes created by PL/Container, in order to save system
+              resources.</li>
+            <li>Supports more containers running concurrently.</li>
+            <li>Includes improved log messages to help diagnose problems.</li>
+          </ul></p>
+        <p>PL/Container 3 is currently a Beta feature, and provides only an Beta R Docker image for
+          executing functions; Python images are not yet available. Save and uninstall any existing
+          PL/Container software before you install PL/Container 3 Beta.</p>
+      </section>
    </body>
  </topic>
  
@@ -82,7 +96,7 @@
    <title id="pz214493">Install PL/Container </title>
    
    <body>
-    <section>This topic includes how to: <p/><ul>
+    <section>This topic includes how to: <ul>
          <li><xref href="#install_docker" format="dita" scope="local">install Docker</xref></li>
          <li><xref href="#topic3/install_pl_utility" format="dita">install PL/Container</xref></li>
          <li><xref href="#topic3/install_docker_images" format="dita">install the PL/Container
@@ -94,15 +108,17 @@
      
    <section id="requirements">
          <title>Prerequisites</title>
-        <ol>
-          <li>For PL/Container 2.1.0 and later use Greenplum Database 6 on CentOS 7.x (or later),
-            RHEL 7.x (or later), or Ubuntu 18.04. <note>PL/Container 2.1.0 and later supports Docker
-              images with Python 3 installed.</note></li>
+        <ul>
+          <li>For PL/Container 2.1.x use Greenplum Database 6 on CentOS 7.x (or later), RHEL 7.x (or
+            later), or Ubuntu 18.04. <note>PL/Container 2.1.x supports Docker images with Python 3
+              installed.</note></li>
+          <li>For PL/Container 3 Beta use Greenplum Database 6.1 or later on CentOS 7.x (or later),
+            RHEL 7.x (or later), or Ubuntu 18.04.</li>
          <li>The minimum Linux OS kernel version supported is 3.10. To verfiy your kernel release
            use: <codeblock>$ uname -r</codeblock>
          </li>
          <li>The minimum Docker versions on all hosts needs to be Docker 19.03.</li>
-        </ol>
+        </ul>
      
    </section>
    
@@ -158,6 +174,9 @@
            command:<codeblock>gppkg -i plcontainer-2.1.1-rhel7-x86_64.gppkg</codeblock></li>
          <li>Source the file
            <codeph>$GPHOME/greenplum_path.sh</codeph>:<codeblock>source $GPHOME/greenplum_path.sh</codeblock></li>
+          <li>For PL/Container version 3 Beta only, enable the <codeph>plc_coordinator</codeph>
+            shared library using the
+            command:<codeblock>gpconfig -c shared_preload_libraries -v 'plc_coordinator'</codeblock></li>
          <li>Restart Greenplum Database:<codeblock>gpstop -ra</codeblock></li>
          <li>Login into one of the available databases, for example:
            <codeblock>psql postgres</codeblock></li>
@@ -188,6 +207,9 @@
              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.
            </p></li>
+          <li>If you are using PL/Container 3 Beta, note that this Beta version is compatible only
+            with the associated <filepath>plcontainer-r-image-3.0.0-beta-gp6.tar.gz</filepath>
+            image.</li>
          <li>
            <p>Use the <codeph>plcontainer </codeph> utility command <codeph>image-add</codeph> to
              install the images on all Greenplum Database hosts where  <codeph>-f
@@ -199,7 +221,10 @@ plcontainer image-add -f /home/gpadmin/plcontainer-python-image-2.1.1-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.1-gp6.tar.gz</codeblock>
+plcontainer image-add -f /home/gpadmin/plcontainer-r-image-2.1.1-gp6.tar.gz
+
+# Install the Beta R image for use with PL/Container 3.0.0 Beta
+plcontainer image-add -f /home/gpadmin/plcontainer-r-image-3.0.0-beta-gp6.tar.gz</codeblock>
            <p>The utility displays progress information, similar to:</p>
            <codeblock>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...
@@ -241,12 +266,12 @@ plcontainer image-add -f /home/gpadmin/plcontainer-r-image-2.1.1-gp6.tar.gz</cod
              containers with specified Docker images.</p><p>Use the <codeph>-r</codeph> option to
              specify your own user defined runtime ID name, use the <codeph>-i</codeph> option to
              specify the Docker image, and the <codeph>-l</codeph> option to specify the Docker
-              image language.  When there are multiple versions of the same docker image, for
-              example 1.0.0 or 1.2.0, specify the TAG version using ":" after the image name.
+              image language. When there are multiple versions of the same docker image, for example
+              1.0.0 or 1.2.0, specify the TAG version using ":" after the image name.
            </p><codeblock># Add a Python 2 based runtime
 plcontainer runtime-add -r plc_python_shared -i pivotaldata/plcontainer_python_shared:devel -l python
            
-# Add a Python 3 based runtime that is supported with PL/Container 2.1.0 and later
+# Add a Python 3 based runtime that is supported with PL/Container 2.1.x
 plcontainer runtime-add -r plc_python3_shared -i pivotaldata/plcontainer_python3_shared:devel -l python3
            
 # Add an R based runtime
@@ -254,8 +279,8 @@ plcontainer runtime-add -r plc_r_shared -i pivotaldata/plcontainer_r_shared:deve
            utility displays progress information as it updates the PL/Container configuration file
            on the Greenplum Database instances. <p>For details on other
                <codeph>runtime-add</codeph> options, see the <xref
-                href="../utility_guide/ref/plcontainer.xml#topic_rw3_52s_dw">plcontainer</xref> reference page.
-            </p></li>
+                href="../utility_guide/ref/plcontainer.xml#topic_rw3_52s_dw">plcontainer</xref>
+              reference page. </p></li>
          <li>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
            runtime will be used with a preconfigured resource group
@@ -305,6 +330,17 @@ $$ LANGUAGE plcontainer;</codeblock>
 hello from Python
 (1 row)
 </codeblock>
+        <p>Similarly, to test the R
+          runtime:<codeblock>postgres=# CREATE FUNCTION dummyR() RETURNS text AS $$
+# container: plc_r_shared
+return ('hello from R')
+$$ LANGUAGE plcontainer;
+CREATE FUNCTION
+postgres=# select dummyR();
+    dummyr    
+--------------
+ hello from R
+(1 row)</codeblock></p>
        <p>For further details and examples about using PL/Container functions, see <xref
            href="pl_container_using.xml#topic_kwg_qfg_mjb">PL/Container Functions </xref>.</p>
      </section>
@@ -322,6 +358,9 @@ $$ LANGUAGE plcontainer;</codeblock>
          Greenplum Database installation. Refer to the <xref
            href="../utility_guide/ref/gppkg.xml#topic1" format="dita" scope="peer">gppkg</xref>
          command for package installation and migration information.</note>
+      <note>You cannot upgrade to PL/Container 3 Beta. To install PL/Container 3 Beta, first save
+        and then uninstall your existing PL/Container software. Then follow the instructions in
+          <xref href="#topic3/install_pl_utility" format="dita"/>.</note>
        <p>To upgrade, perform the following procedure:  
          <ol id="ol_l1j_bml_vkb">
            <li>Save the PL/Container configuration. For example, to save the configuration to a
@@ -387,6 +426,18 @@ $$ LANGUAGE plcontainer;</codeblock>
        <p>The <codeph>CASCADE</codeph> keyword drops PL/Container-specific functions and views.</p>
      </body>
    </topic>
+    <topic id="topic_llg_d4w_blb">
+      <title>Remove PL/Container 3 Beta Shared Library</title>
+      <body>
+        <p>This step is required only if you have installed PL/Container 3 Beta. Before you remove
+          the extension from your system with <codeph>gppkg</codeph>, remove the shared library
+          configuration for the <codeph>plc_coordinator</codeph> process. For example, the following
+          command comments-out the <codeph>shared_preload_libraries</codeph> setting in
+            <filepath>postgresql.conf
+          </filepath>:<codeblock>$ gpconfig -r shared_preload_libraries
+$ gpstop -ra</codeblock></p>
+      </body>
+    </topic>
    <topic xml:lang="en" id="topic_dty_fcj_kw" otherprops="pivotal">
      <title>Uninstall PL/Container Language Extension</title>
      <body>