Skip to content

Commit 71e32c1

Browse files
committed
implement corrections from the PR #52
1 parent b704b1a commit 71e32c1

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

content/09.annex.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# A1. Annex {.page_break_before}
22

3-
The Quality Criteria described in this document follows a technology-agnostic approach, as such the
3+
The Quality Criteria described in this document follows a technology-agnostic approach. As such the
44
choice of tools and services to implement the workflow for service quality assessment process, is up
55
to the team or community developing or operating a given service.
66

@@ -10,25 +10,25 @@ Quality Criteria detailed in this document.
1010
## A1.1. Code workflow
1111

1212
The workflow for service quality assessment, is shown in Figure @fig:workflow. It depicts a real
13-
case example, Github is used in particular to host the Dockerfiles to build the service docker
14-
image, it also hosts the ansible role for the service deployment and configuration, thus the
13+
case example, GitHub is used in particular to host the Dockerfiles to build the service Docker
14+
image, it also hosts the Ansible role for the service deployment and configuration, thus the
1515
IaC (Infrastructure as Code).
1616

1717
The SQA as a Service (SQAaaS), is used to create the Jenkinsfile (pipeline) to be executed in the
1818
Jenkins service.
1919

2020
Before the Jenkins pipeline execution phase, the figure depicts the build and upload/publish of the
21-
service docker image in the Dockerhub.
21+
service Docker image in the Docker Hub.
2222

2323
The Jenkins service is the main service used to execute he pipeline. The figure show a simple
2424
pipeline with automated deployment of the service, execution of functional tests and dynamic
2525
security tests, but in general the pipeline can be more complex and execute other tools to assess
2626
the other service quality criteria.
2727

2828
The bottom part of the figure shows the services, tools and infrastructures that are actuated by the
29-
Jenkins pipeline execution: The IM (Infrastructure Manager) is the service that is used to deploy
30-
the service in cloud resources, fetching the corresponding ansible role from Ansible Galaxy to
31-
instantiate and configure it.
29+
Jenkins pipeline execution: The [IM (Infrastructure Manager)](https://www.grycap.upv.es/im) is the
30+
service that is used to deploy the service in cloud resources, fetching the corresponding Ansible
31+
role from Ansible Galaxy to instantiate and configure it.
3232

3333
![Workflow for service quality assessment](images/service-qa-workflow.png){height="700px"}{#fig:workflow}
3434

@@ -38,7 +38,7 @@ As it can be seen in Figure @fig:workflow, multiple services take part in the ex
3838
pipelines. Table 1 shows the list of services used for the service for the Quality Criteria
3939
assessment detailed in this document.
4040

41-
One of the most popular services for Software source code management is Github. It is uses Git
41+
One of the most popular services for Software source code management is GitHub. It is uses Git
4242
as the Version Control System, branching and tag management.
4343

4444
Ansible and Ansible-Galaxy are used in many software frameworks as deployment and configuration
@@ -55,20 +55,20 @@ Regarding the CI/CD automation, Jenkins pipelines can be easily composed through
5555
and put into the git repositories to be used by the Jenkins CI service to perform the tests. The
5656
tools used in the CI automation are shown in section A1.2.
5757

58-
Kubernetes is a container management service where services or platforms can be deployed while the
58+
Kubernetes is a container management platform where services or platforms can be deployed while the
5959
IM (Infrastructure Manager) can also be used to automatically deploy services both in cloud
6060
resources or kubernetes clusters.
6161

6262
| Service | Usage | Criteria | Repo URL or documentation | Comment |
6363
|-----------------------------|-------------------------------|---------------|------------------------------------------|------------------------------------------|
64-
| Github | VCS | **SvcQC.Dep** | <https://docs.github.com/> | Source code repository - git |
64+
| GitHub | VCS | **SvcQC.Dep** | <https://docs.github.com/> | Source code repository - git |
6565
| Ansible, Galaxy | Install, Config | **SvcQC.Dep** | <https://docs.ansible.com/> | Automated deployment and configuration |
6666
| SQAaaS platform | Pipeline composition | **All** | <https://sqaaas.eosc-synergy.eu> | Pipeline composition for automatic tests |
6767
| SQAaaS platform | Assessment & awarding | **All** | <https://sqaaas.eosc-synergy.eu> | Badge awarding |
6868
| Jenkins CI service | Automated tests | **All** | <https://www.jenkins.io/> | Execution of automatic tests |
6969
| Docker Hub | Docker images | N.A. | <https://hub.docker.com/> | Public repository of Docker images |
7070
| Kubernetes | Service deployment/management |**SvcQC.Dep** | <https://kubernetes.io/> | Docker container management |
71-
| Infrastructure Manager (IM) | Service deployment |**SvcQC.Dep** | <https://www.grycap.upv.es/im/index.php> | Service deployment |
71+
| Infrastructure Manager (IM) | Service deployment |**SvcQC.Dep** | <https://www.grycap.upv.es/im> | Service deployment |
7272

7373
Table 1: Tools and services used to implement the Service QA criteria, also shown the criteria where
7474
applicable.

0 commit comments

Comments
 (0)