Configuring maximum size of client requests to the Management subsystem on VMware

You can configure the maximum allowed size of the client request body for requests made to the Management subsystem.

About this task

The default maximum size is 8 megabytes. You can increase this value.

Increasing the setting can be useful if you get errors when using the CLI to import a large API. Example error:

HTTP/1.1 413 Request Entity Too Large
Note:
  • These instructions apply only to VMware installations. For Kubernetes installations, see Configuring maximum size of client requests to the Management subsystem.
  • These instructions use an extra-values file. This file can be used to define CR overrides. Note that extra-values files for a CR can contain more than one override. If you already use an extra-values file, you can add the new override to it.
  • All of the commands must be run in the apicup management project directory.

Procedure

  1. Create, or edit if one already exists, a management subsystem extra-values file in the apicup management project directory, and enter the following configuration details:
    spec:
      template:
      - name: juhu
        containers:
        - name: juhu
          env:
          - name: CLIENT_MAX_BODY_SIZE
            value: "12m"
    
  2. Save the extra-values file with a filename of your choice, but it must have a .yaml or .yml extension.
  3. Use apicup to update the VMware extra-values-file attribute to point to the new or updated management subsystem extra-values file:
    apicup subsys set <mgmt_subsystem_name> extra-values-file <extra_values_file_path_and_name>
    Where:
    • <mgmt_subsystem_name> is the name of the management subsystem that you are configuring.
    • <extra_values_file_path_and_name> is the fully qualified path and name of your extra-values file.
    For example:
    apicup subsys set ds10-management extra-values-file /workspace/v10011/my_extra_values.yaml
  4. Verify that the configuration settings are valid in the apiconect-up.yaml by running the following command:
    apicup subsys get <mgmt_subsystem_name> --validate
    The output lists each setting and adds a check mark after the value once the value is validated. If the setting lacks a check mark and indicates an invalid value, reconfigure the setting.
  5. Update the management VMware with the updated setting.
    apicup subsys install <mgmt_subsystem_name>
  6. Monitor the health-check output until the management subsystem is healthy by running the following command:
    apicup subsys health-check <mgmt_subsystem_name>
    If one or more of the health criteria are not met, the command stops processing and displays a message with the failure, and exits with a status of 1. The following output is an example of unhealthy output while the install is running:
    Error: Cluster not in good health:
     ManagementCluster (current ha mode: active) is not ready | State: 15/17 Phase: Pending
     ManagementCluster (current ha mode: active) is not ready | State: 15/17 Phase: Pending
    When all of the health criteria are successfully met, the command displays no output, and exits with a status of 0.