Changing PXF settings

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change the PXF settings:

1. View a description of the update cluster configuration CLI command:

   yc managed-greenplum cluster update --help
   

2. Specify PXF settings:

   yc managed-greenplum cluster update <cluster_name_or_ID> \
      --pxf-connection-timeout=<read_request_timeout> \
      --pxf-upload-timeout=<write_request_timeout> \
      --pxf-max-threads=<maximum_number_of_Apache_Tomcat®_threads> \
      --pxf-pool-allow-core-thread-timeout=<whether_timeout_for_streaming_threads_is_permitted> \
      --pxf-poll-core-size=<number_of_streaming_threads> \
      --pxf-pool-queue-capacity=<capacity_of_pool_queue_for_streaming_threads> \
      --pxf-pool-max-size=<maximum_number_of_streaming_threads> \
      --pxf-xmx=<initial_size_of_JVM_heap> \
      --pxf-xms=<maximum_size_of_JVM_heap>
   

   Where:

   • pxf-connection-timeout: Timeout for connection to the Apache Tomcat® server when making read requests, in seconds. The values may range from 5 to 600.

   • pxf-upload-timeout: Timeout for connection to the Apache Tomcat® server when making write requests, in seconds. The values may range from 5 to 600.

   • pxf-max-threads: Maximum number of the Apache Tomcat® threads. The values may range from 1 to 1024.

     To prevent situations when requests get stuck or fail due to running out of memory or malfunctioning of the Java garbage collector, specify the number of the Apache Tomcat® threads. Learn more about adjusting the number of threads in the VMware Greenplum® Platform Extension Framework documentation.

   • pxf-pool-allow-core-thread-timeout: Determines whether a timeout for core streaming threads is allowed. The default value is false.

   • pxf-poll-core-size: Number of core streaming threads per pool. The values may range from 1 to 1024.

   • pxf-pool-queue-capacity: Maximum number of requests you can add to a pool queue for core streaming threads. The values may range from zero upward. If 0, no pool queue is generated.

   • pxf-pool-max-size: Maximum allowed number of core streaming threads. The values may range from 1 to 1024.

   • pxf-xmx: Initial size of the JVM heap for the PXF daemon, in megabytes. The values may range from 64 to 16384.

   • pxf-xms: Maximum size of the JVM heap for the PXF daemon, in megabytes. The values may range from 64 to 16384.

   You can retrieve the cluster name with a list of clusters in the folder.

To change the PXF settings:

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating a Greenplum® cluster.

   For a complete list of available Managed Service for Greenplum® cluster configuration fields, see the Terraform provider documentation.

2. In the cluster description, under pxf_config, configure the PXF settings:

   resource "yandex_mdb_greenplum_cluster" "<cluster_name>" {
     ...
     pxf_config {
       connection_timeout             = <read_request_timeout>
       upload_timeout                 = <write_request_timeout>
       max_threads                    = <maximum_number_of_Apache_Tomcat®_threads>
       pool_allow_core_thread_timeout = <whether_timeout_for_streaming_threads_is_permitted>
       pool_core_size                 = <number_of_streaming_threads>
       pool_queue_capacity            = <capacity_of_pool_queue_for_streaming_threads>
       pool_max_size                  = <maximum_number_of_streaming_threads>
       xmx                            = <initial_size_of_JVM_heap>
       xms                            = <maximum_size_of_JVM_heap>
     }
   }
   

   Where:

   • connection_timeout: Timeout for connection to the Apache Tomcat® server when making read requests, in seconds. The values may range from 5 to 600.

   • upload_timeout: Timeout for connection to the Apache Tomcat® server when making write requests, in seconds. The values may range from 5 to 600.

   • max_threads: Maximum number of the Apache Tomcat® threads. The values may range from 1 to 1024.

     To prevent situations when requests get stuck or fail due to running out of memory or malfunctioning of the Java garbage collector, specify the number of the Apache Tomcat® threads. Learn more about adjusting the number of threads in the VMware Greenplum® Platform Extension Framework documentation.

   • pool_allow_core_thread_timeout: Determines whether a timeout for core streaming threads is allowed. The default value is false.

   • pool_core_size: Number of core streaming threads per pool. The values may range from 1 to 1024.

   • pool_queue_capacity: Maximum number of requests you can add to a pool queue for core streaming threads. The values may range from zero upward. If 0, no pool queue is generated.

   • pool_max_size: Maximum allowed number of core streaming threads. The values may range from 1 to 1024.

   • xmx: Initial size of the JVM heap for the PXF daemon, in megabytes. The values may range from 64 to 16384.

   • xms: Maximum size of the JVM heap for the PXF daemon, in megabytes. The values may range from 64 to 16384.

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

To change PXF settings, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.

• List of PXF settings to change in the configSpec.pxfConfig parameter:

  • connectionTimeout: Timeout for connection to the Apache Tomcat® server when making read requests, in seconds. The values may range from 5 to 600.

  • uploadTimeout: Timeout for connection to the Apache Tomcat® server when making write requests, in seconds. The values may range from 5 to 600.

  • maxThreads: Maximum number of the Apache Tomcat® threads. The values may range from 1 to 1024.

    To prevent situations when requests get stuck or fail due to running out of memory or malfunctioning of the Java garbage collector, specify the number of the Apache Tomcat® threads. Learn more about adjusting the number of threads in the VMware Greenplum® Platform Extension Framework documentation.

  • poolAllowCoreThreadTimeout: Determines whether a timeout for core streaming threads is allowed. The default value is false.

  • poolCoreSize: Number of core streaming threads per pool. The values may range from 1 to 1024.

  • poolQueueCapacity: Maximum number of requests you can add to a pool queue for core streaming threads. The values may range from zero upward. If 0, no pool queue is generated.

  • poolMaxSize: Maximum allowed number of core streaming threads. The values may range from 1 to 1024.

  • xmx: Initial size of the JVM heap for the PXF daemon, in megabytes. The values may range from 64 to 16384.

  • xms: Maximum size of the JVM heap for the PXF daemon, in megabytes. The values may range from 64 to 16384.

• List of cluster configuration fields to update in the UpdateMask parameter.