Skip to content

Commit

Permalink
docs: add ESS upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
bmorelli25 committed Dec 7, 2021
1 parent f0bb5b0 commit 4bad167
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 15 deletions.
Binary file added docs/images/agent-settings-migration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/scale-apm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/schema-agent.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 0 additions & 7 deletions docs/upgrading-to-datastreams.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* <<why-upgrade-to-data-streams>>
* <<considerations-data-streams>>
* <<apm-data-streams-upgrade-steps>>
* <<apm-data-streams-upgrade-steps-ess>>

Classic indices are deprecated starting in version 7.16.0.
Users that are not ready to <<upgrade-to-apm-integration>> should
Expand Down Expand Up @@ -90,9 +89,3 @@ Need to customize anything?

* See <<ilm-how-to>> to learn about the new default Index lifecycle management (ILM) policies applied to data streams and how to customize them.
* See <<ingest-pipelines>> for more information on how to edit or view ingest pipelines.

[discrete]
[[apm-data-streams-upgrade-steps-ess]]
=== Upgrade an {ecloud} cluster

// Will add tomorrow
68 changes: 60 additions & 8 deletions docs/upgrading-to-integration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,63 @@ Congratulations -- you've now upgraded to the latest and greatest in Elastic APM
[[apm-integration-upgrade-steps-ess]]
=== Upgrade an {ecloud} cluster

// Will add tomorrow

// . Upgrade to Fleet + APM integration
// . Switch to data streams --> APM settings --> Schema --> Data streams
// . Scale APM & Fleet up and out. Capacity to process events increases with the memory size (instead of tweaking output settings, increase from 2gb to 4gb for example). As of right now, you cannot overwrite ES output settings or change the output.
// . Navigate to the APM integration and update settings (like enabling RUM)
// . ???
// . Profit
. <<apm-integration-upgrade-ess-1>>
. <<apm-integration-upgrade-ess-2>>
. <<apm-integration-upgrade-ess-3>>
. <<apm-integration-upgrade-ess-4>>

[discrete]
[[apm-integration-upgrade-ess-1]]
==== Upgrade the Elastic Stack

Use the {ecloud} console to upgrade the {stack} to version {version}.
See the {cloud}/ec-upgrade-deployment.html[{ess} upgrade guide] for details.

[discrete]
[[apm-integration-upgrade-ess-2]]
==== Switch to Elastic Agent

APM data collection will be interrupted while the migration is in progress.
The process of migrating should only take a few minutes.

With a Superuser account, complete the following steps:

. In {kib}, navigate to **Observability** > **APM** > **Settings** > **Schema**.
+
image::./images/schema-agent.png[switch to {agent}]

. Click **Switch to {agent}**.
Make a note of the `apm-server.yml` user settings that are incompatible with {agent}.
Check the confirmation box and click **Switch to {agent}**.
+
image::./images/agent-settings-migration.png[{agent} settings migration]

{ecloud} will now create a Fleet Server instance to contain the new APM integration,
and then will shut down the old APM server instance.
Within minutes your data should begin appearing in the APM app again.

[discrete]
[[apm-integration-upgrade-ess-3]]
==== Configure the APM integration

You can now update settings that were removed during the upgrade.
See <<input-apm>> for a reference of all available settings.

In {kib}, navigate to **Mangement** > **Fleet**.
Select the **Elastic Cloud Agent Policy**.
Next to the **Elastic APM** integration, select **Actions** > **Edit integration**.

[discrete]
[[apm-integration-upgrade-ess-4]]
==== Scale APM and Fleet

Certain {es} output configuration options are not available with the APM integration.
To ensure data is not lost, you can scale APM and Fleet up and out.
APM's capacity to process events increases with the instance memory size.

Go to the {ess-console}[{ecloud} console], select your deployment and click **Edit**.
Here you can edit the number and size of each availability zone.

image::./images/scale-apm.png[scale apm]

Congratulations -- you’ve now upgraded to the latest and greatest in Elastic APM!

0 comments on commit 4bad167

Please sign in to comment.