From 27bf07b7787191cd1bdedef8257c65eb3d3b51a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Etxaniz=20Errazkin=2C=20I=C3=B1aki?= <inaki.etxaniz@tecnalia.com> Date: Thu, 29 Jun 2023 13:44:22 +0200 Subject: [PATCH] Update file README.md --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bdbd452..6f1f889 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ PIACERE aims to increase the productivity of DevOps teams in the development and operation of IaC through the provisioning of an integrated DevSecOps framework. DevOps teams can program IaC as if they were programming any software application. -#### Table of Contents +**Table of Contents** - [Description](#Description) - [Repository structure](#Repository-structure) - [Components](#Components) @@ -15,17 +15,22 @@ PIACERE solution consists of an integrated DevSecOps framework to develop, verif The main characteristics of this solution are:  +PIACERE will support the different DevSecOps activities. Using a single **integrated environment to develop (IDE)** infrastructural code will unify the automation of the main DevSecOps activities and will shorten the learning curve for new DevSecOps teams. + +PIACERE will allow DevSecOps teams to model different infrastructure environments, by means of abstractions, through a novel **DevOps Modelling Language (DOML)**, thus hiding the specificities and technicalities of the current solutions and increasing the productivity of these teams. Moreover, PIACERE will also provide an extensible **Infrastructural Code Generator (ICG)**, translating DOML into source files for different existing IaC tools, to reduce the time needed for creating infrastructural code for complex applications. The provided **extensibility mechanisms (DOML-E)** shall ensure the sustainability and longevity of the PIACERE approach and tool-suite (new languages and protocols that can appear in the near future). The DevOps Modelling Language (DOML) is one of the key innovations of PIACERE, because it allows modelling the automation of the whole lifecycle of DevSecOps activities, from Creation to Configuration, and from Deployment to Orchestration and producing executable infrastructural code from the DOML model through the ICG code generator. + ## Repository structure The Public repository of PIACERE project is organized as follows: - /agents: contain the monitoring agents that need to be deployed along with the IaC to monitor the infrastructure - /demos: different demos that can serve as a basic examples of using PIACERE - /The Platform: is divided in many repositories where the several [components](#Components) of the PIACERE framework can be found -## Contact -**Juncal Alonso**, PIACERE project manager, TECNALIA -[Juncal.Alonso@Tecnalia.com] +The three branches **Y1**, **Y2**, **Y3** gather the code developed during the three main milestones of the project (at M12, M24 and M30). The **main** branch stores the final version of the components, as the code development and fixes could continue until the end of the 36-months long project. ## Components +Diagram of the PIACERE framework: + + | Component | Repository | | --------------------------------------|-----------------------------------------------| | CSE - Canary Sandbox Environment | [The Platform/cse] | @@ -41,6 +46,37 @@ The Public repository of PIACERE project is organized as follows: | Self-Healing | [The Platform/self-healing] | | Self-Learning | [The Platform/self-learning] | +## Contact +**Juncal Alonso**, PIACERE project manager, TECNALIA +[Juncal.Alonso@Tecnalia.com] + +## Acknowledgement +This project has received funding from the European Union’s Horizon 2020 research and innovation programme under Grant Agreement No. 101000162. + +### ===== Uniform approach for component repos ===== +- README file (see model in [iac-scan-runner/README.md](https://git.code.tecnalia.com/piacere/public/the-platform/iac-scan-runner/-/blob/main/README.md), Thx @XLAB! :-)) + - Description + - Installation + - License + - Contact + - Documentation (point to) + - Acknowledgement + +- Branches: + - **y1**, **y2**, **y3** (M30-jun code) + - **main** (default, from now on) + 1. Create **main** if not exist in your repo (_Code>Branches>New branch_) + 2. Make it the "default" branch (_Settings>Repository>Branch defaults_) + + + + + + + + + + [The Platform/cse]: https://git.code.tecnalia.com/piacere/public/the-platform/cse [The Platform/iop]: https://git.code.tecnalia.com/piacere/public/the-platform/iop -- GitLab