Placement Policy

URL:
https://<root>/services/<serviceName.serviceType>/placementPolicy
Methods:
GET
Operations:
Edit Placement
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
11.2

Description

The placementPolicy resource returns the current node affinity and tolerations that are applied to a GIS service’s pods. By utilizing node affinity and tolerations, administrators can have the pods for a specific service be scheduled to, or repelled from, specific nodes. For example, an administrator could use node affinity and tolerations to ensure that a GIS service’s pods are scheduled to nodes that have higher capacity, nodes that have a specific type of GPU, or prevent pods of other components from being scheduled on specific nodes. The placementPolicy resource also provides access to the Edit (Placement Policy) operation, which is used to define or modify the node affinity and toleration values for a specific service.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the placementPolicy resource:

1
https://organization.domain.com/context/admin/services/CommercialDamageAssessment.FeatureServer/placementPolicy?f=pjson

JSON Response example

The following response example shows a sample configuration for nodeAffinity:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "placementPolicy": [
    {
      "deploymentType": "FeatureServer",
      "deploymentId": "krh1vura4livmjy61ibe4",
      "podPlacementPolicy": {
        "tolerations": [],
        "nodeAffinity": {
          "requiredDuringSchedulingIgnoredDuringExecution": {
            "nodeSelectorTerms": [
              {
                "matchExpressions": [
                  {
                    "key": "sampleLabel",
                    "operator": "In",
                    "values": [
                      "sampleValue"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  ]
}

The following response example shows a sample configuration for tolerations:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "placementPolicy": [
    {
      "deploymentId": "kfnxectieft8iaxn3qka9",
      "deploymentType": "FeatureServer",
      "podPlacementPolicy":{
        "nodeAffinity":{},
        "tolerations": [
          {
            "effect": "NoSchedule",
            "key": "label1",
            "operator": "Equal",
            "value": "test1"
          }
        ]
      }
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close