Skip to content

Commit

Permalink
Deprecation documentation (#2839)
Browse files Browse the repository at this point in the history
* Initial deprecation docs commit

* Move deprecation info to top of readme, stylistic changes in deprecation note doc

* Changes after review

* Add information to changelog

* Fixes after review

* Further fixes after review
  • Loading branch information
erzetpe authored Jan 12, 2022
1 parent 8e5f202 commit ebbaeed
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/changelogs/CHANGELOG-1.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
34 changes: 34 additions & 0 deletions docs/home/DEPRECATION-NOTE.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit ebbaeed

Please sign in to comment.