From d3085be2cc5df90281c3139792e303bd3e807096 Mon Sep 17 00:00:00 2001 From: rafzei <13080132+rafzei@users.noreply.github.com> Date: Tue, 28 Jul 2020 14:25:41 +0200 Subject: [PATCH] Update after review --- CHANGELOG-0.7.md | 2 +- README.md | 13 ++++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/CHANGELOG-0.7.md b/CHANGELOG-0.7.md index 2c3836c8ec..0b1893f948 100644 --- a/CHANGELOG-0.7.md +++ b/CHANGELOG-0.7.md @@ -4,7 +4,7 @@ ### Added -- [#1424](https://github.com/epiphany-platform/epiphany/issues/1424) - Minor logging improvements added while fixing issue +- Minor logging improvements added while fixing issue [#1424](https://github.com/epiphany-platform/epiphany/issues/1424). - [#1438](https://github.com/epiphany-platform/epiphany/pull/1438) - Rename Terraform plugin vendor in VSCode recommendations ### Fixed diff --git a/README.md b/README.md index 9611cd78e6..0b0bc506b9 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,16 @@ Epiphany at its core is a full automation of Kubernetes and Docker plus addition - Prometheus and Alertmanager for monitoring with Graphana for visualization - Elasticsearch and Kibana for centralized logging (OpenDistro) - HAProxy for loadbalancing -- Postgress and Elasticsearch for date storage -- Vault (MVP) and KeyCloak for authentication +- Postgres and Elasticsearch for date storage +- KeyCloak for authentication +- Vault (MVP) for protecting secrets and other sensitive data - Helm as package manager for Kubernetes -Following target platforms are available: AWS, Azure and on-prem installation. +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. Nodes can be added or removed at will depending on data in the initial manifest. Everything is data driven so simply changing the manifest data and running the automation will modify the environment. +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 informations [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 Kubernets 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. @@ -53,7 +56,7 @@ 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 almost all its components. More information [here](https://github.com/epiphany-platform/epiphany/blob/develop/docs/home/howto/BACKUP.md) +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