Commit 2e0ab7a7 authored by Aurelien's avatar Aurelien
Browse files

Merge branch '39-identify-go2scale-vocabulary' into 'latest' 

Resolve "Identify Go2Scale vocabulary"

Closes #39

See merge request r2devops/hub!107
parents f769f241 ac4b1b30

docs/concept.md

+6 −4
Original line number Diff line number Diff line 
# Concept



The **R2Devops hub** is a collaborative hub of CI & CD

**ready to use** jobs which helps you to easily build powerful pipelines for your

projects.

The **R2Devops hub** is a collaborative [Hub](/r2bulary/#hub) of CI & CD

**ready to use** jobs which helps you to easily build powerful Pipelines for your projects.



!!! info

    Currently, the hub is focused to provide only **Gitlab 🦊** jobs. We plan

    to support more CI/CD platforms in the future.



Each jobs of the hub can be used independently to create fully **customized pipelines.**

Each Job of the hub can be used independently to create fully **customized pipelines.**

You can use them for any kind of software and deployment type. Each job can be

customized through configuration.
@@ -18,6 +17,9 @@ customized through configuration. 
    </button>

</a>





## Overview



![hub overview](images/g2shub_mvp.jpg)



--8<-- "includes/abbreviations.md"

docs/css/extra.css

+4 −0
Original line number Diff line number Diff line
@@ -26,6 +26,10 @@ 
  width:20%

}



.small_r2bulary{

  width:15%

}



/* Landing Page */



.md-typeset .tx-insiders {

docs/images/r2bulary.png

0 → 100644
+12.9 KiB
Loading image diff...

docs/r2bulary.md

0 → 100644
+63 −0
Original line number Diff line number Diff line 
# R2bulary



![r2bulary](images/r2bulary.png){: .center .small_r2bulary }





## R2Devops platform



___

### Hub





___

### Job configuration



This is the configuration settings of the job.



___

### Job ready to use



Job is ready to use when you just have to include it into your project in order to Contributing.

Even job is ready to use, it's always customizable for your specific usage.



___

### Mono repo

Alls job are manage in the same repository.

In comparison to multi repo where each job has his own repository and his own git project url.



---



## DevOps



___

### Pipeline



Set of jobs launched in the same sequence. Pipeline can be run manually, after a commit or a merge into a branch.

We consider the pipeline as succeeded if all jobs in the pipeline success.



___

### Job



**A job is a script hosted in R2Devops Hub that can be included in CI/CD pipeline to do a unitary work.**



- 🆕 The job must be considered like a "disposable treatment" and not like something persistent.

- 🖇️The job is included in a stage in a pipeline. 1 job belongs to 1 stage (and 1 stage may contain several jobs 1:N)

- 🔫 Job is triggered by an action (either a merge on branch, or a manual triggering, or a previous job success).

- 🎁 Job may produce an artifact.

- 📄 Job always produces logs.

- ✋If a job failed, it can stop the pipeline (block the run of next stages or in case of [DAG](https://docs.gitlab.com/ee/ci/directed_acyclic_graph/) the next jobs of the graph).

- ⚠️ If a job failed, it can just throw a non-blocking warning.

- 📝 Once the pipeline is finished, jobs inside the pipeline are considered as finished too. The results (logs, artifacts, output) as for them are persistent.

- ⚙️ The Job can be customized by setting up the variables.

- 🧬A job instance in a pipeline is unique but a "job definition" can be implemented multiple time in a pipeline as multiple jobs instances.



___

### CI



___

### CD



___

### Stage



--8<-- "includes/abbreviations.md"

docs/use-the-hub.md

+6 −4
Original line number Diff line number Diff line
@@ -4,8 +4,8 @@ 


- 🦊  Manage your project in Gitlab

- ✏️   Have the write access to the `.gitlab-ci.yml` file in your project

- 🔫  Be aware each file modification in your project will trigger the pipeline

- 🗝  Have access to the Pipelines page in your Gitlab project to see the pipeline execution

- 🔫  Be aware each file modification in your project will trigger the [Pipeline](/r2bulary/#pipeline)

- 🗝  Have access to the pipelines page in your Gitlab project to see the pipeline execution



## ⏳ Quick setup
@@ -27,7 +27,7 @@ Follows these steps to setup your CI/CD pipeline in less than 5 minutes ! 
        Check [stages](#stages) section to get more information about this list

        or if you already have a configuration with different stages.



2. Select jobs you want in [Jobs section](/jobs/) and add their URL at the end

2. Select Jobs you want in [jobs section](/jobs/) and add their URL at the end

   of your `.gitlab-ci.yml` file:



    ```yaml
@@ -41,7 +41,7 @@ Follows these steps to setup your CI/CD pipeline in less than 5 minutes ! 


        By default, the `latest` version of a job is used. You can choose to

        use a specific version using a `tag`. Available tags are described for

        each job in [Jobs section](/jobs/). Description of `tag` format is

        each job in [jobs section](/jobs/). Description of `tag` format is

        available in [Versioning page](/versioning/).



        Once your pipeline is functional, we recommend to use a specific version
@@ -168,3 +168,5 @@ nmap: 
    - name: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA

      alias: app

```



--8<-- "includes/abbreviations.md"