Skip To Content
ArcGIS Developers
Dashboard

Deployment

Description

This resource returns the properties of an individual microservice within your deployment. Some of these properties can be updated using the edit operation.

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, etc.). Only microservices related to an ArcGIS service type will return either 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 will have a provider type. A provider type of Undefined is returned for non-service related microservices (Admin API, Portal Sharing, ingress controller, etc.)

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

deploymentId

The microservice ID.

name

The microservice name.

type

The microservice type. For example, if the microservice is a shared feature server containing feature services, the type will be FeatureServer. For non-service related microservices, the type will be System.

Values: FeatureServer | GeometryServer | GPServer | GPSyncServer | MapServer | TileServer |System | InMemoryStore | ObjectStore | SpatiotemporalIndexStore | QueueServer | RelationalStore

spec

The JSON object representation of the template's properties, including replicas, container resources, managed kubernetes resources.

Example

"spec": {
  "servicesFilter": {
    "serviceType": "MapServer",
    "providerType": "DMaps"
  },
  "replicas": {
    "min": 1,
    "max": 1
  },
  "containers": [
    {
      "name": "main-container",
      "resources": {
        "memoryMin": "500Mi",
        "memoryMax": "4Gi",
        "cpuMin": "0.125",
        "cpuMax": "2"
      },
      "containerImageUrl": "container.esri.com/info:1082",
      "containerImageKey": "MAP_SERVER"
    },
    {
      "name": "filebeat",
      "resources": {
        "memoryMin": "32Mi",
        "memoryMax": "50Mi",
        "cpuMin": "0.05",
        "cpuMax": "0.25"
      },
      "containerImageUrl": "container.image.com/info:1082",
      "containerImageKey": "FILEBEAT"
    }
  ],
  "initServices": {
    "serviceNames": [
      {
        "serviceType": "MapServer",
        "folderName": "System",
        "serviceName": "SharedMapServiceHost",
        "serviceId": "sf8xiz33q3g7b4o18bcrf"
      }
    ]
  },
  "managedKubernetesResources": [
    {
      "purpose": "blue-deployment",
      "kind": "Deployment",
      "name": "arcgis-kvymoiqt0cl52ldoma1fh-mapserver-z9nlp",
      "selectorInstanceName": "blue"
    },
    {
      "purpose": "service",
      "kind": "Service",
      "name": "arcgis-kvymoiqt0cl52ldoma1fh-mapserver",
      "selectorInstanceName": "blue"
    }
  ]
},
replicas

The number of replicas for the microservice. Currently, both min and max values will need to be the same, as there is no auto-scaling. The default value for both min and max are 1.

Example

"replicas": {
  "min": 2,
  "max": 2
},
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.

Example

"resources": {
  "memoryMin": "500Mi",
  "cpuMin": "0.125",
  "memoryMax": "8Gi",
  "cpuMax": "4"
}
revision

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

Example

"revision": 1598217421474

Example usage

The following is a sample request URL used to access an individual deployment resource:

https://organization.domain.com/context/admin/system/deployments/v4b257669-f2ee-4b14-a058-30ade76e6127?f=pjson

JSON Response example

Below is the JSON response for the ingress controller microservice:

{
  "mode": "Undefined",
  "configuredState": "STARTED",
  "provider": "Undefined",
  "deploymentId": "ky6vk601p5ltq41sra837",
  "name": "ingress-controller",
  "type": "System",
  "spec": {
    "replicas": {
      "min": 2,
      "max": 2
    },
    "containers": [
      {
        "name": "main-container",
        "resources": {
          "memoryMin": "256Mi",
          "memoryMax": "4Gi",
          "cpuMin": "0.125",
          "cpuMax": "1"
        },
        "containerImageUrl": "contanier.image.com/info:1082",
        "containerImageKey": "INGRESS_CONTROLLER"
      }
    ],
    "managedKubernetesResources": [
      {
        "purpose": "blue-deployment",
        "kind": "Deployment",
        "name": "arcgis-ingress-controller",
        "selectorInstanceName": "blue"
      },
      {
        "purpose": "service",
        "kind": "Service",
        "name": "arcgis-ingress-nginx",
        "selectorInstanceName": "blue"
      }
    ]
  },
  "labels": {},
  "revision": 1618226994937
}

Below is the JSON response for a shared map server:

{
  "mode": "Shared",
  "configuredState": "STARTED",
  "provider": "DMaps",
  "deploymentId": "kvymoiqt0cl52ldoma1fh",
  "name": "shared-mapserver",
  "type": "MapServer",
  "spec": {
    "servicesFilter": {
      "serviceType": "MapServer",
      "providerType": "DMaps"
    },
    "replicas": {
      "min": 1,
      "max": 1
    },
    "containers": [
      {
        "name": "main-container",
        "resources": {
          "memoryMin": "500Mi",
          "memoryMax": "4Gi",
          "cpuMin": "0.125",
          "cpuMax": "2"
        },
        "containerImageUrl": "container.image.com/info:1082",
        "containerImageKey": "MAP_SERVER"
      },
      {
        "name": "filebeat",
        "resources": {
          "memoryMin": "32Mi",
          "memoryMax": "50Mi",
          "cpuMin": "0.05",
          "cpuMax": "0.25"
        },
        "containerImageUrl": "container.image.com/info:1082",
        "containerImageKey": "FILEBEAT"
      }
    ],
    "initServices": {
      "serviceNames": [
        {
          "serviceType": "MapServer",
          "folderName": "System",
          "serviceName": "SharedMapServiceHost",
          "serviceId": "sf8xiz33q3g7b4o18bcrf"
        }
      ]
    },
    "managedKubernetesResources": [
      {
        "purpose": "blue-deployment",
        "kind": "Deployment",
        "name": "arcgis-kvymoiqt0cl52ldoma1fh-mapserver-z9nlp",
        "selectorInstanceName": "blue"
      },
      {
        "purpose": "service",
        "kind": "Service",
        "name": "arcgis-kvymoiqt0cl52ldoma1fh-mapserver",
        "selectorInstanceName": "blue"
      }
    ]
  },
  "labels": {},
  "revision": 1618228766421
}