diff --git a/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md b/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md index b686453105..bc5d0bf066 100644 --- a/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md +++ b/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md @@ -2,4 +2,43 @@ navigation_title: "Upgrade on {{ece}}" --- -# Upgrade on {{ece}} (ECE) +# Upgrade your deployment on {{ece}} (ECE) + +Similar to {{ech}}, a single click in the {{ecloud}} console can upgrade a deployment running on ECE to a newer version, add more processing capacity, change plugins, and enable or disable high availability, all at the same time. During the upgrade process, {{es}}, {{kib}}, and all of your deployment components are upgraded simultaneously. + +Once you're prepared to upgrade, do the following: + +% Note: Add a link once confirmed where prepare to upgrade will reside in TOC. + +1. Ensure your current ECE and Docker or Podman versions are [compatible](https://www.elastic.co/support/matrix/#elastic-cloud-enterprise) with the {{stack}} version you're upgrading to. For example, if you're upgrading to 9.0.0, the minimum required version is ECE 3.0. If you don’t have a compatible version installed, [upgrade your orchestrator](/deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md). +2. Download the most recent [stack pack](/deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md#ece_most_recent_elastic_stack_packs) for the version you’re upgrading to, then [add the stack pack](/deploy-manage/deploy/cloud-enterprise/manage-elastic-stack-versions.md#ece-manage-elastic-stack-add) to your installation using the Cloud UI. +3. If not configured already, [assign a snapshots repository](/deploy-manage/tools/snapshot-and-restore/cloud-enterprise.md) to your deployment to enable snapshots and back up your data. Although this is optional, we recommend this step. + +## Perform the upgrade + +1. [Log in to the Cloud UI](/deploy-manage/deploy/cloud-enterprise/log-into-cloud-ui.md). +2. On the **Deployments** page, select your deployment. + + Narrow the list by name, ID, or choose from several other filters. To further define the list, use a combination of filters. + +1. In the **Deployment version** section, click **Upgrade**. +2. Select the version you're upgrading to. For example, `9.0.0`. +3. Click **Upgrade**, then **Confirm upgrade**. The new configuration takes a few minutes to create. + + ::::{note} + If any incompatibilities are detected when you attempt to upgrade, the UI provides a link to the Upgrade Assistant, which checks for deprecated settings in your cluster and indices and helps you resolve them. If there are any issues that would prevent a successful upgrade, the upgrade is blocked. After resolving the issues, return to the **Deployments** page and restart the upgrade. + :::: + +**Security realm settings** + +During the upgrade process, you are prompted to update the security realm settings if your user settings include a `xpack.security.authc.realms` value. + +If the security realms are configured in `user_settings`, you’ll be prompted to modify the settings: + +1. On the **Update security realm settings** window, edit the settings. +2. Click **Update settings**. If the security realm settings are located in `user_settings_override`, contact support to help you upgrade. + +## Next steps + +Once you've successfully upgraded your deployment, [upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md), such as {{ls}}, {{agents}}, or {{beats}}. + diff --git a/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md b/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md index c0ae27b768..dc8dcdc73b 100644 --- a/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md +++ b/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md @@ -18,8 +18,8 @@ Log in to your {{ecloud}} environment: 1. Log in to the [{{ech}} console](https://cloud.elastic.co/login). 2. Select your deployment on the home page in the {{ech}} card or go to the **Deployments** page. - - Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. + + Narrow your deployments by name, ID, or choose from several other filters. To customize your view, use a combination of filters, or change the format from a grid to a list. To upgrade a deployment: @@ -45,9 +45,6 @@ Security realm settings 1. On the **Update security realm settings** window, edit the settings. 2. Click **Update settings**. If the security realm settings are located in `user_settings_override`, contact support to help you upgrade. -### Next steps [next-steps-ech] +### Next steps -Once you've successfully upgraded on {{ech}}, do the following: - -* [Upgrade Elastic APM](../../../solutions/observability/apps/upgrade.md) -* [Upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md) +Once you've successfully upgraded on {{ech}}, [upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md), such as {{ls}}, {{agents}}, or {{beats}}. diff --git a/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md b/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md index e335b1020f..6a90343f28 100644 --- a/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md +++ b/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md @@ -2,4 +2,142 @@ navigation_title: "Upgrade on {{eck}}" --- -# Upgrade on {{eck}} (ECK) +# Upgrade your deployment on {{eck}} (ECK) + +The ECK orchestrator can safely perform upgrades to newer versions of the {{stack}}. + +Once you are prepared to upgrade, ensure the ECK version is [compatible](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-supported.html) with the {{stack}} version you’re upgrading to. If it's incompatible, [upgrade your orchestrator](/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md). + +% Note: Add a link once confirmed where prepare to upgrade will reside in TOC. + +## Perform the upgrade + +1. In the resource spec file, modify the `version` field for the desired {{stack}} version. +2. Save your changes. The orchestrator will start the upgrade process automatically. + +In this example, we’re modifying the version to `9.0.0`. + +```yaml +apiVersion: elasticsearch.k8s.elastic.co/v1 +kind: Elasticsearch +metadata: + name: elasticsearch-sample + namespace: production +spec: + version: 9.0.0 + monitoring: + metrics: + elasticsearchRefs: + - name: monitoring-cluster + namespace: observability + logs: + elasticsearchRefs: + - name: monitoring-cluster + namespace: observability + http: + service: + spec: + type: LoadBalancer + nodeSets: + - name: master + count: 3 + config: + node.roles: ["master"] + xpack.ml.enabled: true + node.store.allow_mmap: false + volumeClaimTemplates: + - metadata: + name: elasticsearch-data + spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 20Gi + storageClassName: standard + podTemplate: + metadata: + labels: + key: sample + spec: + initContainers: + - name: sysctl + securityContext: + privileged: true + command: ['sh', '-c', 'sysctl -w vm.max_map_count=262144'] + containers: + - name: elasticsearch + resources: + requests: + memory: 2Gi + cpu: 0.5 + limits: + memory: 2Gi + cpu: 1 + - name: data + count: 3 + config: + node.roles: ["data", "ingest", "ml", "transform"] + node.store.allow_mmap: false + volumeClaimTemplates: + - metadata: + name: elasticsearch-data + spec: + accessModes: + - ReadWriteOnce + resources: + requests: + storage: 20Gi + storageClassName: standard + podTemplate: + metadata: + labels: + key: sample + spec: + initContainers: + - name: sysctl + securityContext: + privileged: true + command: ['sh', '-c', 'sysctl -w vm.max_map_count=262144'] + containers: + - name: elasticsearch + resources: + requests: + memory: 2Gi + cpu: 0.5 + limits: + memory: 2Gi + cpu: 1 +--- +apiVersion: kibana.k8s.elastic.co/v1 +kind: Kibana +metadata: + name: kibana-sample + namespace: production +spec: + version: 9.0.0 + monitoring: + metrics: + elasticsearchRefs: + - name: monitoring-cluster + namespace: observability + logs: + elasticsearchRefs: + - name: monitoring-cluster + namespace: observability + http: + service: + spec: + type: LoadBalancer + count: 1 + elasticsearchRef: + name: elasticsearch-sample +``` + +ECK will ensure that {{stack}} components are upgraded in the correct order. Upgrades to dependent resources are delayed until that dependency is upgraded. For example, the {{kib}} upgrade will start only when the associated {{es}} cluster has been upgraded. + +Check out [Nodes orchestration](/deploy-manage/deploy/cloud-on-k8s/nodes-orchestration.md) for more information on how ECK manages upgrades and how to tune its behavior. + +## Next steps + +Once you've successfully upgraded your deployment, [upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md), such as {{ls}}, {{agents}}, or {{beats}}.