Deployment Properties

URL:
https://<root>/system/deployments/properties
Methods:
GET
Required Capability:
Access allowed only with the default administrator role
Version Introduced:
10.9

Description

The properties resource returns the default template for GIS service microservices, as well as microservices that are not service related. The properties section for each template can be updated using the Edit (Default Properties) operation.

Starting at ArcGIS Enterprise 11.2 on Kubernetes, the default property template supports having node affinity and tolerations that are applied to the pods of newly created GIS service deployments.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

PropertyDetails

mode

The microservice mode. A mode type of Undefined is returned 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 returned 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.

Example
Use dark colors for code blocksCopy
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.

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 the container resources.

Example
Use dark colors for code blocksCopy
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
"spec": {
  "replicas": {
    "min": 3,
    "max": 3,
    "scalingMode": "manual" //Added at 11.0
  },
  "podPlacementPolicy": {
    "tolerations": [
      {
        "effect": "NoSchedule",
        "key": "label1",
        "operator": "Equal",
        "value": "test1"
      }
    ]
    "nodeAffinity": {}
  },
  "containers": [
    {
      "name": "main-container",
      "resources": {
        "memoryMin": "500Mi",
        "memoryMax": "4Gi",
        "cpuMin": "0.125",
        "cpuMax": "2"
      },
      "containerImageKey": "SDS_FEATURE_SERVER"
    },
    {
      "name": "filebeat",
      "resources": {
        "memoryMin": "32Mi",
        "memoryMax": "50Mi",
        "cpuMin": "0.05",
        "cpuMax": "0.25"
      },
      "containerImageKey": "FILEBEAT"
    }
  ]
}

replicas

The number of replicas for the microservice. For manual scaling, the value for both min and max must be the same. Organizations using a version of ArcGIS Enterprise on Kubernetes at 10.9.1 or higher have the option to enable autoscaling. For more information on manual scaling and autoscaling, see the Edit.

Example
Use dark colors for code blocksCopy
1
2
3
4
5
"replicas": {
  "min": 3,
  "max": 3,
  "scalingMode": "manual" //Added at 11.0
},

podPlacementPolicy

Introduced at 11.2. The node affinity or tolerations applied to the pods of a GIS service deployment. For more information on node affinity and tolerations, see the Edit operation.

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
...
"podPlacementPolicy": {
  "tolerations": [
    {
      "effect": "NoSchedule",
      "key": "label1",
      "operator": "Equal",
      "value": "test1"
    }
  ]
  "nodeAffinity": {}
},
...

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 outlined in the example below. Starting at ArcGIS Enterprise 11.3 on Kubernetes, resources also includes the customResources object, which includes the values for GPU requests and limits for GPU nodes that are part of raster analytic and deep learning workflows.

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
"resources": {
  "memoryMin": "500Mi",
  "memoryMax": "2Gi",
  "cpuMin": "0.125",
  "cpuMax": "2",
  "customResources": {
    "limits": {
      "nvidia.com/gpu": 1
    },
    "requests": {
      "nvidia.com/gpu": 1
    }
  }
}

revision

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

Use dark colors for code blocksCopy
1
"revision": 1598217421474

Example usage

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

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/system/deployments/properties?f=pjson

JSON Response example

Use dark colors for code blocksCopy
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
{
  "properties": [
    {
      "mode": "Shared",
      "provider": "SDS",
      "id": "prava5pumwtr4a9tu4u6x",
      "type": "FeatureServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 10,
          "scalingMode": "auto",
          "autoscaling": {
            "hpaSpec": {
              "metrics": [
                {
                  "resource": {
                    "name": "cpu",
                    "target": {
                      "averageUtilization": "65",
                      "type": "Utilization"
                    }
                  },
                  "type": "Resource"
                }
              ],
              "hpaVersion": "autoscaling/v2"
            }
          }
        },
        "podPlacementPolicy": {
          "tolerations": [{"effect": "NoSchedule","key": "label1","operator": "Equal","value": "test1"}]
          "nodeAffinity": {}
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "SDS_FEATURE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610863
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pub3eotrxkkfwjq5mej0z",
      "type": "GPServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "1.5Gi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "cpuMax": "1"
            },
            "containerImageKey": "GPPROXY_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610897
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pykfh7b6tclxybgr4btz6",
      "type": "GPSyncServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "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": 1655462610920
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pc6zcbz5dooa6a4rkw8vd",
      "type": "DistributedServer",
      "spec": {
        "replicas": {
          "min": 2,
          "max": 2,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "1.5Gi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "DISTRIBUTED_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610937
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pice0u4obpd61q1468awv",
      "type": "MapServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "MAP_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462610954
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pkdgkvtk715depace6u12",
      "type": "GeometryServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "cpuMax": "1"
            },
            "containerImageKey": "GEOMETRY_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611029
    },
    {
      "mode": "Shared",
      "provider": "DMaps",
      "id": "pdidly9jaqnemz24fiand",
      "type": "MapServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "MAP_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611048
    },
    {
      "mode": "Shared",
      "provider": "Tiles",
      "id": "psnbuq4yo1mqbqa7iwm4s",
      "type": "TileServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "2Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "TILE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611066
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pb1uozskr2pt5xohg8aqj",
      "type": "GeocodeServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "GEOCODE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611084
    },
    {
      "mode": "Dedicated",
      "provider": "ArcObjects11",
      "id": "pjzgnwaihdcsk8ot939kk",
      "type": "ImageServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "IMAGE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611103
    },
    {
      "mode": "Shared",
      "provider": "ArcObjectsRasterRendering",
      "id": "ps6lhh4esym49vqx13yni",
      "type": "ImageServer",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "500Mi",
              "memoryMax": "4Gi",
              "cpuMin": "0.125",
              "cpuMax": "2"
            },
            "containerImageKey": "IMAGE_SERVER"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611121
    },
    {
      "mode": "Undefined",
      "provider": "Undefined",
      "id": "pc87bjte6yjihiajr111s",
      "type": "WebhookProcessor",
      "spec": {
        "replicas": {
          "min": 1,
          "max": 1,
          "scalingMode": "manual"
        },
        "containers": [
          {
            "name": "main-container",
            "resources": {
              "memoryMin": "0.5Gi",
              "memoryMax": "1Gi",
              "cpuMin": "0.25",
              "cpuMax": "0.5"
            },
            "containerImageKey": "WEBHOOK_PROCESSOR"
          },
          {
            "name": "filebeat",
            "resources": {
              "memoryMin": "32Mi",
              "memoryMax": "50Mi",
              "cpuMin": "0.05",
              "cpuMax": "0.25"
            },
            "containerImageKey": "FILEBEAT"
          }
        ]
      },
      "revision": 1655462611138
    }
  ]
}

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