Skip to content
This repository has been archived by the owner on Jun 1, 2024. It is now read-only.

Commit

Permalink
translated docs in en/src (#15)
Browse files Browse the repository at this point in the history
Co-authored-by: gustavo.tapia <[email protected]>
  • Loading branch information
TapiaGus and gustavo.tapia committed Oct 4, 2021
1 parent 91dd015 commit 14037db
Show file tree
Hide file tree
Showing 7 changed files with 45 additions and 45 deletions.
37 changes: 18 additions & 19 deletions en/src/C1-Context/c1.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,38 @@
No primeiro nível podemos ver, de forma geral, como é a ligação entre os diferentes componentes do Horusec e suas respectivas responsabilidades.
At the first level we can see, in general, how the different components from Horusec and their respective responsibilities are linked.

É neste nível em que há um contexto macro de como o Horusec entrega o resultado de suas análises e permite que você possa gerenciar as vulnerabildades na plataforma web.
It is at this level that there is a macro context of how Horusec delivers the results of its analisys and allows you to manage the vulnerabilities on the web platform.

Veja a seguir os componentes do nível 1:
See below the components of level 1:


### **Usuário**
### **User**

- Qualquer pessoa que deseje utilizar o Horusec para realizar análises de código e/ou gestão de vulnerabilidades.
- Any person who wants to use Horusec to perform code analisys and/or vulnerability management.

- Pode ser alguém que atue com DevSecOps, Desenvolvimento de Software, Product Management, Qualidade ou em cargo de gestão, etc.
- It may be someone from DevSecOps, Software Development, Product Management, Quality or a management position, etc.


### **Horusec-CLI System**

### **Sistema Horusec-CLI**
- It is the command line interface (CLI) that orchestrates other static code analisys tools.

- É a interface de linha de comando (CLI) que orquestra outras ferramentas de análise estática de código.
- Its main function is to automatically identify the project's programming language and start the proper tools to, shortly after, export the unified information in a common data.

- Sua principal função é a de identificar automaticamente as linguagens de programação do projeto e iniciar as devidas ferramentas para, logo em seguida, exportar as informações unificadas em um dado em comum.
- It is also possible to send the performed analisys to the Horusec-Platform system, where you can perform the vulnerability management in a web application.

- Também é possível enviar a análise realizada para o sistema Horusec-Platform, onde você pode retirar métricas e realizar a gestão de vulnerabilidades em uma aplicação web.
### **Horusec-Platform System**

### **Sistema Horusec-Platform**
- It is a set of web services for managing and viewing vulnerabilities found by the Horusec-CLI system.

- É conjunto de serviços web para gestão e visualização de vulnerabilidades encontradas pelo sistema Horusec-CLI.
### **Horusec-Operator System**

### **Sistema Horusec-Operator**
- It is the kubernetes operators system that speeds up and enhances the installation of the Horusec-Platform system in a unified way.

- É o sistema de kubernetes operators que agiliza e potencializa a instação do sistema Horusec-Platform de forma unificada.
### **Horusec-VsCode Sysetem**

### **Sistema Horusec-VsCode**
- It is the extension of Horusec-CLI to an integrated development environment (IDE) [Visual Studio Code](https://code.visualstudio.com/), where it is possible to perform analisys without having to install a binary in your local machine.

- É a extensão da Horusec-CLI para um Ambiente de Desenvolvimento Integrado (IDE) [Visual Studio Code](https://code.visualstudio.com/), onde é possível realizar as análises sem precisar instalar um binário em sua máquina local.
- **Kubernetes:** Tool that orchestrates application containers.

- **Kubernetes:** Ferramenta que orquestra os containers das aplicações.

- **Resultado:** Resultado das análises realizadas pelos sistemas Horusec-CLI ou Horusec-VsCode.
- **Result:** Results of the analisys performed by the Horusec-CLI and Horusec-VsCode systems.

37 changes: 19 additions & 18 deletions en/src/C2-Container/c2.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,48 @@
No segundo nível podemos verificar, de forma mais detalhada, como a arquitetura do Horusec está interligada aos seus componentes, além das tecnologias que fazem parte deste ecossistema.
At the second level we can verify, in more detail, how the Horusec architecture is interconnected to its components, in addition technologies that are part of this ecosystem.

O Horusec foi construído utilizando usando as seguintes abordagens:
Horusec was built using the following approaches:

### **Horusec-CLI**

É um compilador que executa localmente, ou seja na máquina do usuário, seja atráves de uma máquina de desenvolvimento ou de uma esteira de CI/CD em busca de vulnerabilidades. Os seus containers são:
It is a compiler that runs locally, that is, either on the user's machine, either through a development machine or a CI/CD track searching for vulnerabilities. Its containers are:

- **Horusec-CLI:** Interface de linha de comando (CLI) que realiza orquestração de ferramentas de análise estática de código.
- **Horusec-CLI:** Command line interface (CLI) that orchestrates static code analisys tools.

- O **Horusec-VsCode:** É uma extensão da ferramenta Visual Studio Code que utiliza a Horusec-CLI para análisar projetos em busca de vulnerabilidades. Seus containers são:
- **Horusec-VsCode** é responsável por iniciar o Horusec-CLI em imagem docker e trazer o resultado da análise para dentro do Ambiente de Desenvolvimento Integrado (IDE) em um formato amigável a fim de garantir que o desenvolvedor faça suas devidas modificações.
- **Horusec-VsCode:** An extension of the Visual Studio Code tool that uses Horusec-CLI to analize projects searching for vulnerabilities. Its containers are:

- **Horusec-VsCode** is responsible for starting Horusec-CLI in a docker image and bringing the analisys results into the Integrated Development Environment (IDE) in a friendly format in order to ensure the developer makes the necessary modifications.


### **Horusec-Platform**

É uma plataforma web construída em microsserviços para visualização e gestão das vulnerabilidades. Seus containers são:
It is a web platform built in microservices for viewing and managing vulnerabilities. Its containers are:

#### **API**
Responsável por salvar as análises realizadas via Horusec-CLI no banco de dados principal e publicar para os serviços analytic e webhook via message broker.
Responsible for saving the analisys performed via Horusec-CLI into the main database and publish to analytic and webhook services via message broker .


#### **Analytic**
Responsável por receber as análises realizadas via message broker e salvar no banco de dados analytic para visualização no dashboard do container Horusec-Manager.
Responsible for receiving the analisys performed via message broker and saving in the analytic database for viewing in the dashboard of the Horusec-Manager container.

#### **Auth**
Responsável por gerenciar sessão e acessos a plataforma web através do container Horusec-Manager.
Responsible for managing the session and accesses to the web platform through Horusec-Manager container.

#### **Core**
Responsável pelo gerenciamento de repositórios, workspaces e tokens da plataforma web através do container Horusec-Manager.
Responsible for managing repositories, workspaces and tokens of the web platform through Horusec-Manager container.

#### **Manager**
Responsável por disponibilizar a página estática para integração com os containers do Horusec-Platform.
Responsible for providing the static page for integration with other Horusec-Platform containers.

#### **Messages**
Responsável por diparos de e-mails em determinadas ações realizadas pelo usuário da plataforma web por meio do container Horusec-Manager.
Responsible for e-mail triggers in certain actions performed by the user of the web platform through Horusec-Manager container.

#### **Vulnerability**
Responsável por realizar a gestão das vulnerabilidades criadas pelo container Horusec-API.
Responsible for managing the vulnerabilities created by Horusec-API container.

#### **Webhook**
Responsável pelo disparo de análises para serviços de terceiros via HTTP na plataforma web através do container Horusec-Manager.
Responsible for triggering analisys for third-party services via HTTP in the web platform through the Horusec-Manager container.

#### O **Horusec-Operator**
É uma aplicação usando a base de kubernetes operator para agilizar e garantir que os serviços sejam entregues nos formatos desejados. Seu container é:
#### The **Horusec-Operator**
Is an application using the kubernetes operator base to speed up and ensure that the services are delivered in the desired format. Its container is:

- **Horusec-Operator:** Responsável por realizar a integração com o Kubernetes e, após ser instalado na sua CRD no cluster, ajuda a identificar pedidos de modificações do usuário e aplicá-los no cluster de acordo com as configurações enviadas pelo usuário.
- **Horusec-Operator:** Responsible for performing the integration with Kubernetes and, after being installed on your CRD in the cluster, helps identify the user's modification requests and applying them in the cluster according to the settings sent by the user.
4 changes: 2 additions & 2 deletions en/src/C3-Component/CLI/description.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
A CLI (sigla para interface de linha de comando) é o programa responsável por processar comandos de um software ou qualquer programa computacional por meio de texto.
CLI (acrony for command line interface) is the program responsible for processing a software's commands or any computer program through text. A

No contexto da ferramenta, o Horusec-CLI é a parte de código que permite você rodar os comandos de análise de segurança e de identificação e/ou classificação de vulnerabilidades.
In the context of the tool, Horusec-CLI is the piece of code that allows you to run commands for security analisys and for identifying and/or classifying vulnerabilities.
2 changes: 1 addition & 1 deletion en/src/C3-Component/Operator/description.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
O Horusec-Operator é um facilitador para gerenciamento e orquestração do ambiente de produção do [Horusec-Platform](C3-Component/Platform/HOME).
Horusec-Operator is a facilitator for managing and orchestrating the production environment of the [Horusec-Platform](C3-Component/Platform/HOME).
2 changes: 1 addition & 1 deletion en/src/C3-Component/Platform/description.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
A aplicação web do Horusec (horusec-platform) é uma extensão das funcionalidades da CLI. Nela, é possível realizar a organização em repositórios e em workspaces para facilitar a visualização das vulnerabilidades no formato de gráficos e também classificá-las da forma que convém à equipe.
Horusec's web application (horusec-platform) is an extension of the CLI functionalities. In it, it is possible to carry out the organization in repositories and workspaces to facilitate the visualization of vulnerabilities in chart format, and also classify them in a way that suits the team.
2 changes: 1 addition & 1 deletion en/src/C3-Component/VSCode/description.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
O Horusec disponibiliza a extensão do Visual Studio Code para realizar análises completas do código de seu projeto com apenas um clique.
Horusec provides the Visual Studio Code extension to perform complete analisys of your project's code with only one click.
6 changes: 3 additions & 3 deletions en/src/C3-Component/description.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Neste nível, mais informações são detalhadas na comparação com o C2 (Container), pois é aqui que as partes dos componentes são descritas.
In this level, more information is detailed in comparison with C2 (Container), as this is where the component parts are described.

A ênfase está nas interações, responsabilidades e tecnologias utilizadas de maneira mais detalhada que nos níveis anteriores.
The emphasys is in the interactions, responsibilities and technologies used in more detail than at previous levels.

O Horusec, hoje, é dividido em 4 frentes, sendo cada um delas um container dentro do C4Model.
Currently, Horusec is divided in 4 fronts, each of them a container inside C4Model.

- [CLI](C3-Component/CLI/HOME)
- [Operator](C3-Component/Operator/HOME)
Expand Down

0 comments on commit 14037db

Please sign in to comment.