Switch from APM to Integrations Server payloadedit
This example shows how to use the Elastic Cloud Enterprise RESTful API to switch from using APM & Fleet Server to Integrations Server.
Requirementsedit
Given a deployment that is using an APM & Fleet Server with Elastic Stack version 8.0 it is possible to start using Integrations Server instead by updating the deployment with an IntegrationsServerPayload.
Switching from APM & Fleet Server to Integrations Server in this way ensures that the endpoints and credentials currently used by APM Server and Fleet Server remain the same after the switch.
In order to start using the IntegrationsServerPayload, you first need to enable the APM integration for Elastic Agent by following the steps in Switch to the Elastic APM integration.
API request exampleedit
The example shows how to use the API to create a deployment with APM with version 8.0 and update the deployment to switch to Integrations Server.
Create a deployment with APMedit
When creating a deployment with version 8.0 using the ApmPayload, the APM integration for Elastic Agent is enabled by default.
The following creates a deployment that uses the default deployment template in the ece-region
curl -k -X POST -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments -H 'content-type: application/json' -d '
{
"resources": {
"elasticsearch": [
{
"ref_id": "main-elasticsearch",
"region": "ece-region",
"plan": {
"cluster_topology": [
{
"id": "hot_content",
"node_roles": [
"master",
"ingest",
"transform",
"data_hot",
"remote_cluster_client",
"data_content"
],
"zone_count": 1,
"elasticsearch": {
"node_attributes": {
"data": "hot"
},
"enabled_built_in_plugins": []
},
"instance_configuration_id": "data.default",
"size": {
"value": 4096,
"resource": "memory"
}
},
{
"id": "warm",
"node_roles": [
"data_warm",
"remote_cluster_client"
],
"zone_count": 1,
"elasticsearch": {
"node_attributes": {
"data": "warm"
},
"enabled_built_in_plugins": []
},
"instance_configuration_id": "data.highstorage",
"size": {
"value": 0,
"resource": "memory"
}
},
{
"id": "cold",
"node_roles": [
"data_cold",
"remote_cluster_client"
],
"zone_count": 1,
"elasticsearch": {
"node_attributes": {
"data": "cold"
},
"enabled_built_in_plugins": []
},
"instance_configuration_id": "data.highstorage",
"size": {
"value": 0,
"resource": "memory"
}
},
{
"id": "frozen",
"node_roles": [
"data_frozen"
],
"zone_count": 1,
"elasticsearch": {
"node_attributes": {
"data": "frozen"
},
"enabled_built_in_plugins": []
},
"instance_configuration_id": "data.frozen",
"size": {
"value": 0,
"resource": "memory"
}
},
{
"id": "coordinating",
"node_roles": [
"ingest",
"remote_cluster_client"
],
"zone_count": 1,
"instance_configuration_id": "coordinating",
"size": {
"value": 0,
"resource": "memory"
},
"elasticsearch": {
"enabled_built_in_plugins": []
}
},
{
"id": "master",
"node_roles": [
"master",
"remote_cluster_client"
],
"zone_count": 1,
"instance_configuration_id": "master",
"size": {
"value": 0,
"resource": "memory"
},
"elasticsearch": {
"enabled_built_in_plugins": []
}
},
{
"id": "ml",
"node_roles": [
"ml",
"remote_cluster_client"
],
"zone_count": 1,
"instance_configuration_id": "ml",
"size": {
"value": 1024,
"resource": "memory"
},
"elasticsearch": {
"enabled_built_in_plugins": []
}
}
],
"elasticsearch": {
"version": "8.0.0"
},
"autoscaling_enabled": false,
"deployment_template": {
"id": "default"
}
},
"settings": {
"dedicated_masters_threshold": 6,
"snapshot": {
"enabled": false
}
}
}
],
"kibana": [
{
"ref_id": "main-kibana",
"elasticsearch_cluster_ref_id": "main-elasticsearch",
"region": "ece-region",
"plan": {
"zone_count": 1,
"cluster_topology": [
{
"instance_configuration_id": "kibana",
"size": {
"value": 1024,
"resource": "memory"
},
"zone_count": 1
}
],
"kibana": {
"version": "8.0.0"
}
}
}
],
"enterprise_search": [],
"apm": [
{
"ref_id": "main-apm",
"elasticsearch_cluster_ref_id": "main-elasticsearch",
"region": "ece-region",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "apm",
"size": {
"value": 512,
"resource": "memory"
},
"zone_count": 1
}
],
"apm": {
"version": "8.0.0"
}
}
}
]
},
"name": "switch-to-integrations-server",
"metadata": {
"system_owned": false
}
}
'
Identify the instance configuration to use for Integrations Serveredit
Once the deployment is created, find the instance_configuration_id for IntegrationsServerPayload supported by the deployment template used by the deployment created in the previous step.
In the example above, the deployment was created using the default deployment template in the ece-region region.
To find the instance_configuration_id, fetch the deployment template using the template ID, the region, and the version used by the deployment (Integrations Server is supported on version 8.0 and higher).
curl -XGET \ -H 'Content-Type: application/json' \ -H "Authorization: ApiKey $EC_API_KEY" \ "https://$COORDINATOR_HOST:12443/api/v1/deployments/templates/default?region=ece-region&show_instance_configurations=false&stack_version=8.0.0"
This return a template like
{
"id": "default",
"name": "Default",
"description": "Default deployment template for clusters",
"deployment_template": {
"resources": {
"elasticsearch": [
...
],
"kibana": [
...
],
"apm": [
...
],
"enterprise_search": [
...
],
"integrations_server": [
{
"ref_id": "integrations_server-ref-id",
"elasticsearch_cluster_ref_id": "es-ref-id",
"region": "ece-region",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "integrations.server",
"size": {
"value": 512,
"resource": "memory"
},
"zone_count": 1
}
],
"integrations_server": {}
}
}
]
}
},
"system_owned": true,
"metadata": [
{
"key": "parent_solution",
"value": "stack"
}
],
"order": 0,
"template_category_id": "default"
}
|
The instance configuration ID to use in |
Update deployment using IntegrationsServerPayloadedit
Finally, to switch to Integrations Server, update the deployment using the IntegrationsServerPayload, setting
instance_configuration_id to the value identified in the previous step.
curl -XPUT \
-H 'Content-Type: application/json' \
-H "Authorization: ApiKey $EC_API_KEY" \
"https://$COORDINATOR_HOST:12443/api/v1/deployments/<deployment-id>" \
-d '
{
"prune_orphans": false,
"resources": {
"integrations_server": [
{
"region": "ece-region",
"ref_id": "main-integrations_server",
"elasticsearch_cluster_ref_id": "main-elasticsearch",
"plan": {
"cluster_topology": [
{
"instance_configuration_id": "integrations.server",
"size": {
"value": 512,
"resource": "memory"
},
"zone_count": 1
}
],
"integrations_server": {
"version": "8.0.0"
},
"transient": {
"strategy": {
"autodetect": {}
}
}
}
}
]
}
}
'
|
Make sure to use the |
|
|
Make sure |