- URL:
- https://<root>/system/upgrades/config
- Methods:
GET- Operations:
- Update Configuration
- Version Introduced:
- 11.2
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
Starting at ArcGIS Enterprise on Kubernetes 12.0, the config resource returns the upgrade job configuration. The upgrade job configuration defines the pod placement policy, which consists of the node affinity and tolerations, and container resource allocations that are applied to the pods used by the upgrade job whenever an upgrade or update is performed. This resource also provides access to the Update Configuration operation, which is used to define or modify the upgrade job configuration.
Prior to 12.0, the config resource returned only the pod placement policy.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the config resource:
https://organization.example.com/<context>/admin/system/upgrades/config?f=pjsonJSON Response example
The following are sample JSON responses for the config resource, showing the responses before and after support for container resource allocations was added at 12.0:
{
"upgraderJobSpec": {
"podPlacementPolicy": {
"nodeAffinity": {
"requiredDuringSchedulingIgnoredDuringExecution": {
"nodeSelectorTerms": [
{
"matchExpressions": [
{
"key": "upgrader",
"operator": "In",
"values": ["true"]
}
]
}
]
}
},
"tolerations": [
{
"effect": "NoSchedule",
"key": "upgrader",
"operator": "Equal",
"value": "true"
}
]
},
"containers": [
{
"name": "main-container",
"resources": {
"memoryMin": "128Mi",
"memoryMax": "8Gi",
"cpuMin": "0.25",
"cpuMax": "4",
"customResources": {}
}
},
{
"name": "fluent-bit"
}
]
}
}