diff --git a/CHANGELOG-0.7.md b/CHANGELOG-0.7.md index f9d580b085..0b1893f948 100644 --- a/CHANGELOG-0.7.md +++ b/CHANGELOG-0.7.md @@ -15,6 +15,8 @@ - [#1412](https://github.com/epiphany-platform/epiphany/issues/1412) - Certificate in Vault is also generated or copied even if flag in configuration tls_disable is set to true - [#1408](https://github.com/epiphany-platform/epiphany/issues/1408) - Epiphany does not support upgrades for Kubernetes in HA mode - [#1482](https://github.com/epiphany-platform/epiphany/issues/1482) - Epicli upgrade: flannel CNI plugin is not upgraded to v0.12.0 +- [#1462](https://github.com/epiphany-platform/epiphany/issues/1461) - [BUG] Error upgrading AWS/RHEL/calico cluster from 0.6 to 0.7 +- [#802](https://github.com/epiphany-platform/epiphany/issues/802) - Docker version is hard-coded in installation tasks ### Added diff --git a/README.md b/README.md index 754eaece1e..a96d8ecbbb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# Documentation +# Epiphany Platform +[![GitHub release](https://img.shields.io/github/v/release/epiphany-platform/epiphany.svg)](https://github.com/epiphany-platform/epiphany/releases) +[![Github license](https://img.shields.io/github/license/epiphany-platform/epiphany)](https://github.com/epiphany-platform/epiphany/releases) ## Overview @@ -6,12 +8,19 @@ Epiphany at its core is a full automation of Kubernetes and Docker plus addition - Kafka or RabbitMQ for high speed messaging/events - Prometheus and Alertmanager for monitoring with Graphana for visualization -- Elasticsearch and Kibana for centralized logging +- Elasticsearch and Kibana for centralized logging (OpenDistro) - HAProxy for loadbalancing -- Postgress for storage +- Postgres and Elasticsearch for data storage - KeyCloak for authentication +- Vault (MVP) for protecting secrets and other sensitive data +- Helm as package manager for Kubernetes -Epiphany can run on as few as one node (laptop, desktop, server) but the real value comes from running 3 or more nodes for scale and HA. Nodes can be added or removed at will depending on data in the manifest. Everything is data driven so simply changing the manifest data and running the automation will modify the environment. +The following target platforms are available: AWS, Azure and on-prem installation. + +Epiphany can run on as few as one node (laptop, desktop, server) but the real value comes from running 3 or more nodes for scale and HA. Everything is data driven so simply changing the manifest data and running the automation will modify the environment. +Kubernetes hosts (masters, nodes) and component VMs can be added depending on data in the initial manifest. More information [here](https://github.com/epiphany-platform/epiphany/blob/develop/docs/home/howto/CLUSTER.md#how-to-scale-or-cluster-components). + +Please note that currently Epiphany supports only creating new masters and nodes and adding them to the Kubernetes cluster. It doesn't support downscale. To remove them from Kubernetes cluster you have to do it manually. We currently use Terraform and Ansible for our automation orchestration. All automation is idempotent so you can run it as many times as you wish and it will maintain the same state unless you change the data. If someone makes a "snow flake" change to the environment (you should never do this) then simply running the automation again will put the environment back to the desired state. @@ -48,6 +57,13 @@ epicli apply -f demo.yaml ``` You will be asked for a password that will be used for encryption of some of build artifacts. More information [here](docs/home/howto/SECURITY.md#how-to-run-epicli-with-password) +Since version 0.7 epicli has an option to backup/recovery some of its components. More information [here](https://github.com/epiphany-platform/epiphany/blob/develop/docs/home/howto/BACKUP.md) +```shell +epicli backup -f -b +epicli recovery -f -b +``` + + Find more information using table of contents below - especially the [How-to guides](docs/home/HOWTO.md). ## Documentation @@ -59,8 +75,8 @@ Find more information using table of contents below - especially the [How-to gui - [How-to guides](docs/home/HOWTO.md) - [Components](docs/home/COMPONENTS.md) - [Security](docs/home/SECURITY.md) - - [Troubleshooting](docs/home/TROUBLESHOOTING.md) - - [Changelog](CHANGELOG.md) + - [Troubleshooting](docs/home/TROUBLESHOOTING.md) + - [Changelog](CHANGELOG.md) - Architecture - [Logical View](docs/architecture/logical-view.md) - [Process View](docs/architecture/process-view.md) @@ -69,5 +85,5 @@ Find more information using table of contents below - especially the [How-to gui - [Governance model](docs/home/GOVERNANCE.md) - [Development environment](docs/home/DEVELOPMENT.md) - [GIT Workflow](docs/home/GITWORKFLOW.md) - +