Skip to content

Commit

Permalink
Merge pull request #38 from anuket-project/petorre-rm-ch9-table
Browse files Browse the repository at this point in the history 
[RM Ch9] Fix CI/CD table rendering
  • Loading branch information
@walterkozlowski
walterkozlowski authored Oct 23, 2024
2 parents 4f7b6b0 + b0edd6a commit 4eaad6e
Showing 1 changed file with 76 additions and 76 deletions.
152 changes: 76 additions & 76 deletions doc/ref_model/chapters/chapter09.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -645,82 +645,82 @@ and so on, prior to deployment, are listed in Table 9-4 (below).
The tenant processes for application LCM, such as updates, are out of scope. For the purpose of these requirements,
CI includes Continuous Delivery, and CD refers to Continuous Deployment.

* - Ref #
- Description
- Comments/Notes

* - auto.cicd.001
- The CI/CD pipeline must support deployment on any cloud and cloud infrastructures, including different hardware
accelerators.
- CI/CD pipelines automate CI/CD best practices into repeatable workflows for integrating code and configurations
into builds, testing builds including validation against design and operator-specific criteria, and delivery of
the product onto a runtime environment. Example of an open-source cloud native CI/CD framework is the Tekton
project (:cite:p:`tekton-project`)

* - auto.cicd.002
- The CI/CD pipelines must use event-driven task automation
-

* - auto.cicd.003
- The CI/CD pipelines should avoid scheduling tasks
-

* - auto.cicd.004
- The CI/CD pipeline is triggered by a new or updated software release being loaded into a repository
- The software release can be source code files, configuration files, images, manifests. Operators may support a
single or multiple repositories and may specify which repository is to be used for these releases. An example of
an open source repository is the CNCF Harbor (:cite:p:`cncf-harbor`)

* - auto.cicd.005
- The CI pipeline must scan source code and manifests to validate compliance with design and coding best practices.
-

* - auto.cicd.006
- The CI pipeline must support the build and packaging of images and deployment manifests from source code and
configuration files.
-

* - auto.cicd.007
- The CI pipeline must scan images and manifests to validate for compliance with security requirements.
- See section 7.10 (:ref:`chapters/chapter07:consolidated security requirements`). Examples of such security
requirements include only ingesting images, source code, configuration files, etc., only from trusted sources.

* - auto.cicd.008
- The CI pipeline must validate images and manifests
- Example: different tests

* - auto.cicd.009
- The CI pipeline must validate with all hardware offload permutations and without hardware offload
-

* - auto.cicd.010
- The CI pipeline must promote validated images and manifests to be deployable.
- Example: promote from a development repository to a production repository

* - auto.cicd.011
- The CD pipeline must verify and validate the tenant request
- Example: RBAC, request is within quota limits, affinity/anti-affinity, etc.

* - auto.cicd.012
- The CD pipeline after all validations must turn over control to orchestration of the software
-

* - auto.cicd.013
- The CD pipeline must be able to deploy into Development, Test, and Production environments
-

* - auto.cicd.014
- The CD pipeline must be able to automatically promote software from Development to Test and Production
environments
-

* - auto.cicd.015
- The CI pipeline must run all relevant Reference Conformance test suites
-

* - auto.cicd.016
- The CD pipeline must run all relevant Reference Conformance test suites
-
+---------------+-----------------------------------+-----------------------------------------------------------------+
| Ref # | Description | Comments/Notes |
+===============+===================================+=================================================================+
| auto.cicd.001 | The CI/CD pipeline must support | CI/CD pipelines automate CI/CD best practices into repeatable |
| | deployment on any cloud and cloud | workflows for integrating code and configurations into builds, |
| | infrastructures, including | testing builds including validation against design and |
| | different hardware accelerators. | operator-specific criteria, and delivery of the product onto a |
| | | runtime environment. Example of an open-source cloud native |
| | | CI/CD framework is the Tekton project |
| | | (:cite:p:`tekton-project`) |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.002 | The CI/CD pipelines must use | |
| | event-driven task automation | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.003 | The CI/CD pipelines should avoid | |
| | scheduling tasks | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.004 | The CI/CD pipeline is triggered | The software release can be source code files, configuration |
| | by a new or updated software | files, images, manifests. Operators may support a single or |
| | release being loaded into a | multiple repositories and may specify which repository is to be |
| | repository | used for these releases. An example of an open source |
| | | repository is the CNCF Harbor (:cite:p:`cncf-harbor`) |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.005 | The CI pipeline must scan source | |
| | code and manifests to validate | |
| | compliance with design and coding | |
| | best practices. | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.006 | The CI pipeline must support the | |
| | build and packaging of images and | |
| | deployment manifests from source | |
| | code and configuration files. | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.007 | The CI pipeline must scan images | See section 7.10 |
| | and manifests to validate for | (:ref:`chapters/chapter07:consolidated security requirements`). |
| | compliance with security | Examples of such security requirements include only ingesting |
| | requirements. | images, source code, configuration files, etc., only from |
| | | trusted sources. |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.008 | The CI pipeline must validate | Example: different tests |
| | images and manifests | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.009 | The CI pipeline must validate | |
| | with all hardware offload | |
| | permutations and without hardware | |
| | offload | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.010 | The CI pipeline must promote | Example: promote from a development repository to a production |
| | validated images and manifests to | repository |
| | be deployable. | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.011 | The CD pipeline must verify and | Example: RBAC, request is within quota limits, |
| | validate the tenant request | affinity/anti-affinity, etc. |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.012 | The CD pipeline after all | |
| | validations must turn over | |
| | control to orchestration of the | |
| | software | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.013 | The CD pipeline must be able to | |
| | deploy into Development, Test, | |
| | and Production environments | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.014 | The CD pipeline must be able to | |
| | automatically promote software | |
| | from Development to Test and | |
| | Production environments | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.015 | The CI pipeline must run all | |
| | relevant Reference Conformance | |
| | test suites | |
+---------------+-----------------------------------+-----------------------------------------------------------------+
| auto.cicd.016 | The CD pipeline must run all | |
| | relevant Reference Conformance | |
| | test suites | |
+---------------+-----------------------------------+-----------------------------------------------------------------+

**Table 9-4:** Automation CI/CD

Expand Down

0 comments on commit 4eaad6e

Please sign in to comment.