Edit (Deployment)

deploymentJson

A JSON object that represents the properties of a microservice.

Example

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
deploymentJson={
  "mode": "Primary",
  "configuredState": "STARTED",
  "provider": "Postgres",
  "deploymentId": "ke84ls9uva6t7fvck8q5p",
  "name": "relational-store-primary",
  "type": "RelationalStore",
  "spec": {
    "replicas": {
      "min": 3,
      "max": 3,
      "scalingMode": "manual" //Added at 11.0
    },
    "containers": [
      {
        "name": "filebeat",
        "resources": {
          "memoryMin": "32Mi",
          "memoryMax": "50Mi",
          "cpuMin": "0.05",
          "cpuMax": "0.25"
        },
        "containerImageUrl": "container.image.com/info:1082",
        "containerImageKey": "FILEBEAT"
      },
      {
        "name": "main-container",
        "resources": {
          "memoryMin": "2Gi",
          "memoryMax": "8Gi",
          "cpuMin": "0.5",
          "cpuMax": "4"
        },
        "containerImageUrl": "container.image.com/info:1082",
        "containerImageKey": "STORE_POSTGRES"
      }
    ]
  },
  "labels": {},
  "revision": 1618223097333
}

async

(Optional)

Introduced at 10.9.1. This parameter specifies whether the operation will run synchronously or asynchronously. If false, the operation is run synchronously. If true, the operation is run asynchronously and the response returns a JSON object containing job information that can be used to track the job's status. The default value is false.

Values: true | false

f

The response format. The default format is html.

Values: html | json | pjson

replicas

The number of replicas for the microservice. The default value for manual scaling for min and max is 1. For manual scaling, both the min and max values must be the same.

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

For organizations using ArcGIS Enterprise 11.2 on Kubernetes or later versions, version 2 (v2) of the autoscaling feature can be enabled by passing in the JSON object below and modifying the min, max, scalingMode, and averageUtilization values.

Autoscaling can be enabled by adjusting the scalingMode value to auto. The averageUtilization value will act as the CPU utilization threshold for autoscaling. If the threshold is crossed, ArcGIS Enterprise on Kubernetes scales up to the number of pods specified by the max value, and will return to no lower than the default pod level (the value set for min) once utilization decreases.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
"replicas": {
  "min": 1,
  "max": 10,
  "scalingMode": "auto",
  "autoscaling": {
    "hpaSpec": {
      "metrics": [
        {
          "resource": {
            "name": "cpu",
            "target": {
              "averageUtilization": "65",
              "type": "Utilization"
            }
          },
          "type": "Resource"
        }
      ],
      "hpaVersion": "autoscaling/v2"
    }
  }
},

Organizations using ArcGIS Enterprise on Kubernetes 10.9.1 can enable version 1 of the autoscaling feature by passing in the JSON object below and modifying the min, max, scalingMode, and targetCPUUtilizationPercentage values:

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"
  }
}

podPlacementPolicy

Introduced at 11.2. Sets the node affinity or tolerations applied that will be applied the pods of a GIS service deployment. For more information on configuring node affinity or tolerations, see the Edit placement policy operation.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
"nodeAffinity": {
  "requiredDuringSchedulingIgnoredDuringExecution": {
    "nodeSelectorTerms": [
      {
        "matchExpressions": [
          {
            "key": "affinity",
            "operator": "In",
            "values": [
              "true"
            ]
          }
        ]
      }
    ]
  }
}

1
2
3
4
5
6
7
8
"tolerations": [
  {
    "effect": "NoExecute",
    "key": "tolerates",
    "operator": "Equal",
    "value": "true"
  }
]

volumes

Introduced at 11.2. An array that sets additional volumes for the deployment's pods to pull from. Administrators have the option to configure PVC volumes, which create a singular PVC volume that the pods of a deployment can directly request resources from, or configure PVC volume templates with the deployment, which will create separate volumes for each pod to use.

For singular PVC volumes, administrators will only need to provide the volume's ID:

1
2
3
4
5
6
7
...
"volumes": [
  {
    "volumeId": "uadwuaj4pwkjhcst6spxx"
  }
],
...

For PVC volume templates, administrators need to provide the volume template's ID as well as the volume's purpose. The purpose specifies the types of volumes being created. Currently, the only supported purpose is GIS_SERVICE_TEMP, which designates the volumes created from the template as ephemeral volumes:

1
2
3
4
5
6
7
8
...
"volumes": [
  {
    "purpose": "GIS_SERVICE_TEMP"
    "volumeConfig": "oi72y1m4q2exgzfr9uppg"
  }
],
...

resources

The minimum and maximum resource allocations for the microservice, including the minimum memory (memoryMin) and minimum CPU (cpuMin) resources required for the microservice to start. The default values for memoryMin, cpuMin, memoryMax, and cpuMax are shown in the example below.

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

Starting at ArcGIS Enterprise 11.3 on Kubernetes, organizations can implement device plugins to enable GPU nodes in their cluster to optimize workflows for raster analytics and deep learning. Requests and limits for GPU are set using the customResources object.

The following deployments will need to have request and limits values set for GPU:

• system-rasteranalysistools-gpsyncserver (used for training models)
• system-rasterprocessinggpu-dpserver (used for processing)

Values for requests and limits only need to be set on main-container.

The example below shows the accepted values for both requests and limits:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
"resources": {
  "memoryMin": "32Mi",
  "memoryMax": "50Mi",
  "cpuMin": "0.05",
  "cpuMax": "0.25",
  "customResources": {
    "limits": {
      "nvidia.com/gpu": 1
    },
    "requests": {
      "nvidia.com/gpu": 1
    }
  }
}

mode

The microservice mode. A mode type of Undefined is used when the microservice is system related (Admin API, portal sharing, ingress controller, and so on). Only microservices related to an ArcGIS service type return Dedicated or Shared for this property.

Values: Shared | Dedicated | Undefined | Primary | Standby | Coordinator

provider

The microservice provider. Only microservices related to an ArcGIS service type have a provider type. A provider type of Undefined is used for microservices that are not service related (Admin API, portal sharing, ingress controller, and so on).

Values: SDS | ArcObjects11 | DMaps | Undefined | Postgres | Tiles | Ignite | MinIO | Elasticsearch | RabbitMQ | ArcObjectsRasterRendering

id

The template ID.

1
"id": "9375dd81-30d1-41c0-a802-cabb425159a9",

type

The microservice type. For example, if the microservice is a shared feature server containing feature services, FeatureServer is returned. For microservices that are not service related, System is returned.

Values: FeatureServer | GeometryServer | GPServer | GPSyncServer | MapServer | TileServer | System | InMemoryStore | ObjectStore | SpatiotemporalIndexStore | QueueServer | RelationalStore | WebhookProcessor (Added at 11.0)

spec

The JSON object representation of the template's specifications, including replicas and container resources.

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
"spec": {
  "replicas": {
    "min": 3,
    "max": 3,
    "scalingMode": "manual" //Added at 11.0
  },
  "containers": [
    {
      "name": "main-container",
      "resources": {
        "memoryMin": "1.5Gi",
        "memoryMax": "4Gi",
        "cpuMin": "0.125",
        "cpuMax": "2"
      },
      "containerImageKey": "GP_SERVER"
    },
    {
      "name": "filebeat",
      "resources": {
        "memoryMin": "32Mi",
        "memoryMax": "50Mi",
        "cpuMin": "0.05",
        "cpuMax": "0.25"
      },
      "containerImageKey": "FILEBEAT"
    }
  ]
},

revision

The date, in milliseconds from epoch format, of the latest revision to the template.

1
"revision": 1598217421474