Skip to content

Commit f717893

Browse files
committed
address comments in PR #20
1 parent f822470 commit f717893

File tree

3 files changed

+58
-46
lines changed

3 files changed

+58
-46
lines changed

content/03.intro.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ services, such as their stability or functional suitability.
1010

1111
The meaning of **Service** can be regarded from different perspectives.
1212
From an IT Service Management (ITSM) standpoint, such as the EOSC Service Management
13-
System (SMS) process model, a service is devised as a means to "provide value
13+
System (SMS) process model, a **Service** is devised as a means to "provide value
1414
to the customer". The same goal is shared by the DevOps paradigm, but in this
1515
case there is a more pragmatic vision that the customer satisfaction is achieved
16-
through the continuous delivery of quality-assured services, with a shorter
16+
through the continuous delivery of quality-assured **Services**, with a shorter
1717
life cycle, as the final outcome of a comprehensive software development process.
1818

19-
The ITSM model has a broader focus. A service is an "intangible asset" that
19+
The ITSM model has a broader focus. A **Service** is an "intangible asset" that
2020
also includes additional activities such as customer engagement and support.
2121
Consequently, it is a much heavier process that might not be appropriate to
22-
be applicable for all types of services. The DevOps model, on the other hand,
22+
be applicable for all types of **Services**. The DevOps model, on the other hand,
2323
narrows down the scope to meet the user expectations by acting exclusively on
24-
the quality features of the service, which is seen as an aggregate of software
24+
the quality features of the **Service**, which is seen as an aggregate of software
2525
components in operation.
2626

2727
## Purpose
2828

29-
This document provides an initial approach to Service Quality Assurance,
30-
meant to be applied in the integration process of the services existing
29+
This document provides an initial approach to **Service Quality Assurance**,
30+
meant to be applied in the integration process of the **Services** existing
3131
under the EOSC-Synergy project, which eventually will be accessible as part
3232
of the EOSC offerings.
3333

@@ -37,29 +37,30 @@ conventions. To this end, the criteria herein compiled builds on the DevOps
3737
culture already established in the preceding Software Quality Assurance baseline
3838
document [@url:https://digital.csic.es/handle/10261/160086] to outline the set
3939
of good practices that seek the usability and
40-
reliability of services, and meet the user expectations in terms of functional
40+
reliability of **Services**, and meet the user expectations in terms of functional
4141
requirements.
4242

4343
## Contextualization of a Service
4444

4545
As a result, a **Service**, as conceived in this document, represents the following:
4646

47-
* **Web service** [WS] [@url:https://techterms.com/definition/web_service]:
48-
* A web service is an application or data source that is accessible via
47+
* **Web Service** [@url:https://techterms.com/definition/web_service]:
48+
* A **Web Service** is an application or data source that is accessible via
4949
a standard web protocol (HTTP or HTTPS).
50-
* Web services are designed to communicate with other programs,
50+
* **Web Services** are designed to communicate with other programs,
5151
rather than directly with users.
52-
* Most web services provide an API, or a set of functions and commands,
52+
* Most **Web Services** provide an API, or a set of functions and commands,
5353
that can be used to access the data.
5454

55-
* **Web application** [WApp] [@url:https://techterms.com/definition/web_application]:
56-
* A web application or "web app" is a software program that is delivered over
55+
* **Web Application** [@url:https://techterms.com/definition/web_application]:
56+
* A **Web Application** or "Web App" is a software program that is delivered over
5757
the Internet and is accessed through a web browser.
5858

59-
* **Platform** or **Service Composition** [Plat]
59+
* **Platform** or **Service Composition**
6060
[@url:https://csrc.nist.gov/glossary/term/Service_Composition]:
61-
* Aggregation of multiple small services into larger services.
62-
* An integrated set of Web services, Web applications and software components.
61+
* Aggregation of multiple small services into larger services,
62+
according to a service-oriented (SOA) and/or microservices architecture.
63+
* An integrated set of **Web Services**, **Web Applications** and software components.
6364

6465
Examples are: Web portals, Scientific portals and gateways, data repositories.
6566

content/06.quality_criteria.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ good practices.
229229
for this task.
230230

231231
* **[SvcQC.Sec07]** IaC testing, from [SvcQC.Aud02] criterion, MUST cover the
232-
security auditing of the IaC templates (aka _Security as Code_ or _SaC_) in
232+
security auditing of the IaC templates (_SaC_) in
233233
order to assure the deployment of secured **Services**. For all the third-party
234234
dependencies used in the IaC templates (including all kind of software artefacts,
235235
such as Linux packages or container-based images):
@@ -246,14 +246,14 @@ such as Linux packages or container-based images):
246246

247247
### Policies [SvcQC.Pol]
248248

249-
Policy documents describe what are the users expected behaviour when using the
249+
Policy documents describe what are the user's expected behaviour when using the
250250
**Service**, how they can access it and what they can expect regarding privacy
251251
of their data.
252252

253253
* **[SvcQC.Pol01]** The **Service** MUST include the following policy documents:
254254
* **[SvcQC.Pol01.1]** Acceptable Usage Policy (AUP): Is a set of rules applied
255-
by the owner, creator or administrator of a network, website, or service, that
256-
restrict the ways in which the network, website or system may be used and sets
255+
by the owner, creator or administrator of a network, **Service** or system, that
256+
restrict the ways in which the network, **Service** or system may be used and sets
257257
guidelines as to how it should be used. The AUP can also be referred to as: Acceptable
258258
Use Policy or Fair Use Policy.
259259
* **[SvcQC.Pol01.2]** Access Policy or Terms of Use: represent a binding legal
@@ -285,11 +285,36 @@ Level Agreement (OLA) with the infrastructure where it is integrated.
285285
* **[SvcQC.Sup04]** The **Service** MAY include Service Level
286286
Agreement (SLA) with user communities.
287287

288+
### Automated Deployment [SvcQC.Aud]
289+
290+
The automated deployment of **Services** implies the use of code to install and
291+
configure them in the target infrastructures. Infrastructure as Code (IaC)
292+
templates allow operations teams to treat service provisioning and deployment in
293+
a similar fashion as developers manage the software code.
294+
295+
Consequently, IaC enables the paradigm of immutable infrastructure deployment
296+
and maintenance, where **Services** are never updated, but deprovisioned and
297+
redeployed. An immutable infrastructure simplifies maintenance and enhances
298+
repeatability and reliability.
299+
300+
* **[SvcQC.Aud01]** A production-ready **Service** SHOULD be deployed as a
301+
workable system with the minimal user or system administrator interaction
302+
leveraging IaC templates.
303+
304+
* **[SvcQC.Aud02]** Any future change to a deployed **Service** SHOULD be
305+
done in the form of a new deployment, in order to preserve immutable
306+
infrastructures.
307+
308+
* **[SvcQC.Aud03]** IaC SHOULD be validated by specific (unit) testing
309+
frameworks for every change being done.
310+
* **[SvcQC.Aud03.1]** IaC (unit) tests MUST be idempotent.
311+
288312
### Monitoring [SvcQC.Mon]
289313

290314
Monitoring is a periodic testing of the **Service**. It requires a monitoring
291315
service from where tests are executed or sent and results of those tests are shown.
292-
The tests can be the same, in part or in total of the Functional tests.
316+
The tests can be the same, in part or in total of the Functional, Security and
317+
Infrastructure tests.
293318
The technology used for the monitoring is left to the developers of the underlying
294319
software to decide eventually with input from the infrastructure(s),
295320
where the **Service** is foreseen to be integrated.
@@ -315,30 +340,6 @@ where the **Service** is foreseen to be integrated.
315340
* **[SvcQC.Mon03.1]** IaC (unit) tests [SvcQC.Aud02] SHOULD be reused as
316341
monitoring tests, thus avoiding duplication.
317342

318-
### Automated Deployment [SvcQC.Aud]
319-
320-
The automated deployment of **Services** implies the use of code to install and
321-
configure them in the target infrastructures. Infrastructure as Code (IaC)
322-
templates allow operations teams to treat service provisioning and deployment in
323-
a similar fashion as developers manage the software code.
324-
325-
Consequently, IaC enables the paradigm of immutable infrastructure deployment
326-
and maintenance, where **Services** are never updated, but deprovisioned and
327-
redeployed. An immutable infrastructure simplifies maintenance and enhances
328-
repeatability and reliability.
329-
330-
* **[SvcQC.Aud01]** A production-ready **Service** SHOULD be deployed as a
331-
workable system with the minimal user or system administrator interaction
332-
leveraging IaC templates.
333-
334-
* **[SvcQC.Aud02]** Any future change to a deployed **Service** SHOULD be
335-
done in the form of a new deployment, in order to preserve immutable
336-
infrastructures.
337-
338-
* **[SvcQC.Aud03]** IaC SHOULD be validated by specific (unit) testing
339-
frameworks for every change being done.
340-
* **[SvcQC.Aud03.1]** IaC (unit) tests MUST be idempotent.
341-
342343
### Metrics [SvcQC.Met]
343344

344345
A metric is a quantifiable measure that is used to track and assess

content/07.glossary.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ __GDPR__
2121
__IaC__
2222
: Infrastructure as Code
2323

24+
__ITSM__
25+
26+
: IT Service Management
27+
2428
__NIST__
2529
: National Institute of Standards and Technology
2630

@@ -48,5 +52,11 @@ __SDLC__
4852
__SLA__
4953
: Service Level Agreement
5054

55+
__SMS__
56+
: Service Management System
57+
58+
__SOA__
59+
: Service Oriented Architecture
60+
5161
__VCS__
5262
: Version Control System

0 commit comments

Comments
 (0)