diff --git a/README.md b/README.md index 0506803574..b04b6fe43c 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,11 @@ We currently use Terraform and Ansible for our automation orchestration. All aut - The documentation is a moving target. Always check the latest documentation on the develop branch. There is a big chance that whatever you are looking for is already added/updated or improved there. +## Deprecation Note + +At the link presented below you can find the information about deprecated components with plan of removal from Epiphany. +[Deprecation Note](docs/home/DEPRECATION-NOTE.md) + ## Quickstart ### Epicli diff --git a/docs/changelogs/CHANGELOG-1.3.md b/docs/changelogs/CHANGELOG-1.3.md index 805d48c8d7..c726e53248 100644 --- a/docs/changelogs/CHANGELOG-1.3.md +++ b/docs/changelogs/CHANGELOG-1.3.md @@ -23,6 +23,7 @@ - [#2665](https://github.com/epiphany-platform/epiphany/issues/2665) - Add Kubernetes prereqs to epicli preflight checks - [#633](https://github.com/epiphany-platform/epiphany/issues/633) - DOC: How to use TLS/SSL certificate with HA Proxy - [#2702](https://github.com/epiphany-platform/epiphany/issues/2702) - Use state flag file in K8s upgrades +- [#2840](https://github.com/epiphany-platform/epiphany/issues/2840) - Create deprecation notes documentation ### Fixed diff --git a/docs/home/DEPRECATION-NOTE.md b/docs/home/DEPRECATION-NOTE.md new file mode 100644 index 0000000000..bc8f8f3173 --- /dev/null +++ b/docs/home/DEPRECATION-NOTE.md @@ -0,0 +1,34 @@ +# 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. + +The list of components to be deprecated: + +- 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. + +Planed removal: Epiphany 2.0 +Issue: [2833](https://github.com/epiphany-platform/epiphany/issues/2833) + +- 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. + +Planed removal: 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. + +Planed removal: Epiphany 2.0 +Issue: [2836](https://github.com/epiphany-platform/epiphany/issues/2836) + +- Apache Ignite + +Apache Ignite is prone to 1.x log4j issue. + +Planed removal: Epiphany 2.0 +Issue: [2837](https://github.com/epiphany-platform/epiphany/issues/2837)