Edit (Scaling)

Description

The edit operation updates the scaling (replicas, min, and max) and resource allocation (cpuMin, cpuMax, memoryMin, and memoryMax) for an individual service. Changes made using this operation will be reflected in the deployment resource for the GIS service microservice.

Scaling in ArcGIS Enterprise on Kubernetes

Either manual scaling or autoscaling can be set for a GIS service microservice using the serviceScalingSpec parameter. Introduced at ArcGIS Enterprise on Kubernetes 10.9.1, autoscaling allows administrators to configure and deploy systems that respond to unexpected performance demands with minimal intervention and overhead. The ArcGIS Enterprise on Kubernetes autoscaling feature uses horizontal pod autoscaling, which, in response to an increase in resource usage, deploys more pods according to the values set by the administrator.

When a specific CPU utilization threshold (averageUtilization ) is crossed, ArcGIS Enterprise on Kubernetes scales the number of pods up to the maximum (max ) values set in the replicas JSON object. When utilization drops, and the additional resources are no longer needed, the system scales itself back down to no lower than the minimum (min ) value set in the replicas JSON object. For more information on how to enable autoscaling, see the Editable properties section below.

Though scaling properties can be updated using the Edit default properties and Edit deployment operation, to reduce risk of errors it is recommended that changes to scaling information is performed using this operation.

Request parameters

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
serviceScalingSpec={
  "scalingSpec": [
    {
      "deploymentType": "MapServer",
      "replicas": {
        "min": 3,
        "max": 3,
        "scalingMode": "manual"
      },
      "deploymentId": "kui6zmtqzkjrsihh6tegq",
      "resources": {
        "memoryMin": "500Mi",
        "memoryMax": "2Gi",
        "cpuMin": "0.125",
        "cpuMax": "2"
      }
    }
  ]
}

Scaling properties

The following example demonstrates the scalingSpec JSON object of a GIS service microservice:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "scalingSpec": [
    {
      "deploymentType": "MapServer",
      "replicas": {
        "min": 3,
        "max": 3,
        "scalingMode": "manual"
      },
      "deploymentId": "knftr3em9ezf1rb7tvpym",
      "resources": {
        "memoryMin": "500Mi",
        "memoryMax": "2Gi",
        "cpuMin": "0.125",
        "cpuMax": "2"
      }
    }
  ]
}

The following sections outline the individual properties included in the scalingSpec JSON object that can, and cannot, be updated using this operation.

Editable properties

The following properties can be updated using the edit operation:

1
2
3
4
5
"replicas": {
  "min": 3,
  "max": 3,
  "scalingMode": "manual"
},

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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
"replicas": {
  "min": 1,
  "max": 10,
  "scalingMode": "auto",
  "autoscaling": {
    "hpaSpec": {
      "metrics": [
        {
          "resource": {
            "name": "cpu",
            "target": {
              "averageUtilization": "65",
              "type": "Utilization"
            }
          },
          "type": "Resource"
        }
      ],
      "behavior": {
        "scaleDown": {
          "stabilizationWindowSeconds": 600, //Waits 10 minutes to observe recommendations and goes with an appropriate value for replicas to either scale up or down.
          "policies": [ //Two policies for scale down behaviors. Allows for staggering or setting limits on the rate of scaling down.
            {
              "periodSeconds": 180,
              "type": "Pods",
              "value": 5
            },
            {
              "periodSeconds": 80,
              "type": "Percent",
              "value": 25
            }
          ]
        },
        "scaleUp": {
          "policies": [ //Two policies for scale up behaviors. Allows for staggering or setting limits on the rate of scaling up.
            {
              "periodSeconds": 180,
              "type": "Pods",
              "value": 5
            },
            {
              "periodSeconds": 80,
              "type": "Percent",
              "value": 25
            }
          ]
        }
      },
      "hpaVersion": "autoscaling/v2"
    }
  }
},

1
2
3
4
5
6
7
8
9
10
11
"replicas": {
  "min": 1,
  "max": 5,
  "scalingMode": "auto",
  "autoscaling": {
    "hpaSpec": {
      "targetCPUUtilizationPercentage": 50
    },
    "hpaVersion": "autoscaling/v1"
  }
}

1
2
3
4
5
6
"resources": {
  "memoryMin": "500Mi",
  "memoryMax": "2Gi",
  "cpuMin": "0.125",
  "cpuMax": "2"
},

Uneditable properties

The following properties cannot be edited but are required to be passed through in the serviceScalingSpec object:

Example usage

The following is a sample POST request for the edit operation that demonstrates autoscaling, formatted for readability:

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
29
30
31
32
33
34
35
36
37
38
39
40
41
POST /context/admin/services/MyService.MapServer/scaling/edit HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

serviceScalingSpec={
  "scalingSpec": [
    {
      "deploymentType": "MapServer",
      "replicas": {
        "min": 1,
        "max": 4,
        "scalingMode": "auto",
        "autoscaling": {
          "hpaSpec": {
            "metrics": [
              {
                "resource": {
                  "name": "cpu",
                  "target": {
                    "averageUtilization": "50",
                    "type": "Utilization"
                  }
                },
                "type": "Resource"
              }
            ],
            "hpaVersion": "autoscaling/v2"
          }
        }
      },
      "deploymentId": "kui6zmtqzkjrsihh6tegq",
      "resources": {
        "memoryMin": "500Mi",
        "memoryMax": "2Gi",
        "cpuMin": "0.125",
        "cpuMax": "2"
      }
    }
  ]
}&async=false&f=pjson&token=_2AKqbDf5yQyOBrCXyfoMx3vHLY3z7Hp-ZQ27GJXN9Vqz5og2NnjAZjbHiB6YUnLg3gslmfCkDWgqEtsPmLIXB3gnhkmYD3VzM698NLJnoN4gOlXdn3EXX3UUJGXO4s19-fh8_stvig0ldDffzz6AuAbOWLPlTf0hOmyhxNJi8WckhJMV_VZ1SHNAGrcwdF6hPKoUQHTqcoAqNdsBUglm1VqH2nG8oq1a9JjESkTtDR12Yc-4dlttQPyiDsRVwZu

JSON Response example

If async is false, the following response is returned once a service's scaling is edited successfully:

1
{"status": "success"}

If async is true, the following response is returned. The value returned for jobsUrl can be used to access the job resource to track a job's status after it has been submitted. For more information, see the Job resource topic.

1
2
3
4
5
{
  "jobsUrl": "https://organization.domain.com/context/admin/jobs/ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobID": "ja2ca1a35-881c-400c-a49a-b26883002d6c",
  "jobStatus": "SUBMITTED"
}