From 924e001a6a9f5cfbd54c51241a852064486ed802 Mon Sep 17 00:00:00 2001 From: Anatoli Tsikhamirau Date: Fri, 4 Feb 2022 15:16:33 +0100 Subject: [PATCH] Extend deprecation note with Ignite removal steps (#2949) --- docs/home/DEPRECATION-NOTE.md | 68 +++++++++++++++++++++++++++-------- 1 file changed, 54 insertions(+), 14 deletions(-) diff --git a/docs/home/DEPRECATION-NOTE.md b/docs/home/DEPRECATION-NOTE.md index 163b848d69..aef142aefe 100644 --- a/docs/home/DEPRECATION-NOTE.md +++ b/docs/home/DEPRECATION-NOTE.md @@ -1,40 +1,80 @@ # Deprecation Note -This page is related to our components deprecation plan. Components listed below are marked as deprecated with plan of removal -in Epiphany version 2.0. +This page is related to our components deprecation plan. Components listed below are marked as deprecated with plan of +removal in Epiphany version 2.0. The list of components removed: - Hashicorp Vault -The role related to Hashicorp Vault has never been developed beyond MVP/PoC stage and cannot be used for production usage. It also causes troubles with upgrade to new Kubernetes versions. +The role related to Hashicorp Vault has never been developed beyond MVP/PoC stage and cannot be used for production +usage. It also causes troubles with upgrade to new Kubernetes versions. -Removed: Epiphany 2.0 -Issue: [2834](https://github.com/epiphany-platform/epiphany/issues/2834) +Removed: Epiphany 2.0 Issue: [2834](https://github.com/epiphany-platform/epiphany/issues/2834) - Istio -We are considering replacement of Istio component with different solution. Additionally, Istio causes problems during upgrade of Kubernetes. +We are considering replacement of Istio component with different solution. Additionally, Istio causes problems during +upgrade of Kubernetes. -Removed: Epiphany 2.0 -Issue: [2836](https://github.com/epiphany-platform/epiphany/issues/2836) +Removed: Epiphany 2.0 Issue: [2836](https://github.com/epiphany-platform/epiphany/issues/2836) - Apache Ignite Apache Ignite is prone to 1.x log4j issue. -Removed: Epiphany 2.0 -Issue: [2837](https://github.com/epiphany-platform/epiphany/issues/2837) +Removed: Epiphany 2.0 Issue: [2837](https://github.com/epiphany-platform/epiphany/issues/2837) - Logstash -The functionality that the Logstash is serving in Epiphany - exporting csv can right now be achieved using the Open Distro for Elasticsearch plugin. The Logstash in this version is prone to log4j issue and this is also the reason why should be removed. +The functionality that the Logstash is serving in Epiphany - exporting csv can right now be achieved using the Open +Distro for Elasticsearch plugin. The Logstash in this version is prone to log4j issue and this is also the reason it +should be removed. -Removed: Epiphany 2.0 -Issue: [2833](https://github.com/epiphany-platform/epiphany/issues/2833) +Removed: Epiphany 2.0 Issue: [2833](https://github.com/epiphany-platform/epiphany/issues/2833) ## Next steps -If you plan Epiphany upgrade from v1.x to v2.x and Logstash is installed in your cluster but you don't use it, it is recommended to: +### Logstash + +If you plan Epiphany upgrade from v1.x to v2.x and Logstash is installed in your cluster, but you don't use it, it is +recommended to: + - remove `logstash` group, if present, from `inventory` file - remove Logstash from machines (recommended way is to use `apt`/`yum` according to your OS) + +### Ignite + +There are a few installation approaches that influence the removal of Ignite. + +#### Standalone installation on VMs + +To remove Ignite application in this case, it's necessary to destroy related infrastructure part with following +configuration. The `epicli apply` command with `--skip-config` flag may be used to run only Terraform part and skip +Ansible role provisioning. To be sure about compatibility of applied changes, use the same epicli version. + +```yaml +--- +kind: epiphany-cluster +... +specification: + components: + ignite: + count: 0 +... +``` + +#### Installation on VMs by usage of custom feature mapping + +When custom feature-mapping was used, following actions are required for removal: + +- remove `/opt/ignite` symlink +- remove folders in format `/opt/ignite_` +- if there are no applications dependent on `openjdk` packages, such as Kafka/Zookeeper, remove them: + - `openjdk-8-jre-headless` for Ubuntu + - `java-1.8.0-openjdk-headless` for RHEL/CentOS + +#### Installation as a K8s application + +It was possible to install Ignite only in a separate namespace, `ignite` by default. If the application is not used +anymore, remove its namespace with all content.