Changes to the Grid Management API

StorageGRID 11.4 uses version 3 of the Grid Management API. Version 3 deprecates version 2; however, version 1 and version 2 are still supported.

Attention: You can continue to use version 1 and version 2 of the management API with StorageGRID 11.4; however, support for these versions of the API will be removed in a future release of StorageGRID. After upgrading to StorageGRID 11.4, the deprecated v1 and v2 APIs can be deactivated using the PUT /grid/config/management API.

New sections for alert operations

You can now use the Grid Management API to manage alerts. The following sections are available:

Alerts now listed in /grid/health endpoint

The GET/grid/health endpoint in the Alarms section was updated. In addition to providing information about alarms and node connection states, this endpoint now provides information about the number of critical, major, and minor alerts.

New traffic-classes section

You can now use the Grid Management API to configure traffic classification policies. The new operations for traffic classifier configuration are as follows:
  • /grid/traffic-classes: Get all traffic class policy names and IDs, and which bandwidth limits are in use.
  • /grid/traffic-classes/policies: Get all traffic class policy names.
  • /grid/traffic-classes/policies: Create a new traffic class policy.
  • /grid/traffic-classes/policies/{id}: Get a traffic class policy by ID.
  • /grid/traffic-classes/policies/{id}: Replace an existing traffic class policy.
  • /grid/traffic-classes/policies/{id}: Delete a traffic class policy.

Upgrading an SNMP agent to StorageGRID 11.4

If you used the SNMP endpoints in the Grid Management API to configure an SNMP agent in StorageGRID 11.3, you can continue to use the same agent configuration after you upgrade to StorageGRID 11.4. Alternatively, you can use the new SNMP Agent page to redefine agent settings. If you want to use SNMPv3 traps and informs, you must use the SNMP Agent page to configure USM users and trap/inform destinations.

If you want to use your existing SNMP agent configuration, you must make modifications, as follows:

Prometheus metrics renamed

A number of Prometheus metrics in the Metrics section of the Grid Management API have been renamed for StorageGRID 11.4. During the upgrade to StorageGRID, the following items are automatically updated to use the new metric names:

After the upgrade is complete, all metrics data is stored using the new metric names. If you edited any of the default alert rules or you created custom alert rules in StorageGRID 11.3, you must review alert rule settings to ensure these rules do not use old metric names.

After the upgrade, you can temporarily access historical data for the renamed metrics.
Note: Because Prometheus metrics data is only preserved for 31 days, the Renamed Metrics page and the Prometheus interface only show historical data for 31 days after the upgrade is complete. After that time, all available data for these metrics is shown on the charts and dashboards that use the new names of the metrics.

Change to erasure-coding API

The /grid/ec-profiles API now includes an active property to indicate whether the Erasure Coding profile is active or deactivated.

manageAlerts permission added to Groups API

The /grid/groups API now includes the manageAlerts permission.

New option for object metadata retrieval

You can now specify the consistency level required for responses to requests for object metadata made using the POST /grid-object-metadata endpoint in the Objects section. You can specify that the request be made with any of the following consistency levels:
  • all
  • strong-global
  • strong-site
  • read-after-new-write
  • available
  • weak
See the instructions for implementing client applications for information about these consistency levels.

Support for external Layer 7 load balancers and IP-based S3 policies

A new, private Grid Management API allows the configuration of a list of trusted external Layer 7 load balancers. This list is used in combination with an S3 bucket or group policy that is IP based for the original client, allowing StorageGRID to accept forwarded requests.

How to configure StorageGRID to work with third-party Layer 7 load balancers