From 7b9df1de6306a6a1266885393abef95a76444d9e Mon Sep 17 00:00:00 2001 From: rafzei <13080132+rafzei@users.noreply.github.com> Date: Tue, 28 Jul 2020 09:04:06 +0200 Subject: [PATCH 1/6] Readme and changelog update --- CHANGELOG-0.7.md | 4 +++- README.md | 28 ++++++++++++++++++++-------- 2 files changed, 23 insertions(+), 9 deletions(-) diff --git a/CHANGELOG-0.7.md b/CHANGELOG-0.7.md index f9d580b085..2c3836c8ec 100644 --- a/CHANGELOG-0.7.md +++ b/CHANGELOG-0.7.md @@ -4,7 +4,7 @@ ### Added -- Minor logging improvements added while fixing issue [#1424](https://github.com/epiphany-platform/epiphany/issues/1424). +- [#1424](https://github.com/epiphany-platform/epiphany/issues/1424) - Minor logging improvements added while fixing issue - [#1438](https://github.com/epiphany-platform/epiphany/pull/1438) - Rename Terraform plugin vendor in VSCode recommendations ### Fixed @@ -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..9611cd78e6 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,15 @@ 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 -- KeyCloak for authentication +- Postgress and Elasticsearch for date storage +- Vault (MVP) and KeyCloak for authentication +- 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. +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. 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 +53,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 almost all 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 +71,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 +81,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) - + 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 2/6] 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 From 91c21c26f104f71a5cf6e990429e68743a8e021d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Zeidler?= <13080132+rafzei@users.noreply.github.com> Date: Tue, 28 Jul 2020 14:31:12 +0200 Subject: [PATCH 3/6] Add new line --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0b0bc506b9..4fdc145bbc 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ The following target platforms are available: AWS, Azure and on-prem installatio 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. From 417dbcf50de358981b8e53c89d19b88e4436d47c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Zeidler?= <13080132+rafzei@users.noreply.github.com> Date: Tue, 28 Jul 2020 16:16:36 +0200 Subject: [PATCH 4/6] Update README.md Co-authored-by: to-bar <46519524+to-bar@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4fdc145bbc..7358b8df1f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ 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 -- Postgres and Elasticsearch for date 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 From 3a18113be61d83948cad1857df5930893083799f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Zeidler?= <13080132+rafzei@users.noreply.github.com> Date: Wed, 29 Jul 2020 08:07:12 +0200 Subject: [PATCH 5/6] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7358b8df1f..2f81dac6d9 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,9 @@ Epiphany at its core is a full automation of Kubernetes and Docker plus addition 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 informations [here](https://github.com/epiphany-platform/epiphany/blob/develop/docs/home/howto/CLUSTER.md#how-to-scale-or-cluster-components). +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 Kubernets cluster. It doesn't support downscale. To remove them from Kubernetes cluster you have to do it manually. +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. From db358ad89727b7ea8c8be7578649d9e9905e7da5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Zeidler?= <13080132+rafzei@users.noreply.github.com> Date: Wed, 29 Jul 2020 09:47:28 +0200 Subject: [PATCH 6/6] Update README.md Co-authored-by: to-bar <46519524+to-bar@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f81dac6d9..a96d8ecbbb 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The following target platforms are available: AWS, Azure and on-prem installatio 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. +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.