CON-2204 de vops audits reworks (#2333)

* chore(Readme): adding guidance for AFPA time management of deep in system project

* chore(README): formate the space

* chore(Audit Readme): rewording

* chore(README audits): added focus on technical questions commands

---------

Co-authored-by: Christopher Fremond <christopher@01talent.com>
This commit is contained in:
Christopher Fremond 2023-12-04 18:50:36 +00:00 committed by GitHub
parent fa36ca4dad
commit a24842592e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 222 additions and 224 deletions

View File

@ -31,7 +31,7 @@ Suggested roleplay questions include:
- What challenges did you face during the project and how did you address them?
- How did you ensure your documentation's clarity and completeness, and what measures did you take to make it easily understandable and maintainable?
###### Was the students able to answer all the questions correctly?
###### Were the students able to answer all the questions correctly?
###### Did the students demonstrate a thorough understanding of the concepts and technologies used in the project?
@ -44,14 +44,14 @@ Suggested roleplay questions include:
Review the student's architecture design, ensuring that it meets the project requirements:
1. `Scalability`: Does the architecture utilize AWS services to manage varying workloads and scale as required?
2. `Availability`: Design the architecture to be fault-tolerant and maintain high availability, even during component failures.
2. `Availability`: Is the architecture designed to be fault-tolerant and maintain high availability, even during component failures?
3. `Security`: Does the architecture integrate AWS security best practices, such as data encryption, use of AWS VPC, and secure API endpoints with managed authentication?
4. `Cost-effectiveness`: Is the architecture designed to be cost-effective on AWS without compromising performance, security, or scalability?
5. `Simplicity`: Is the AWS architecture straightforward and free of unnecessary complexity while still fulfilling project requirements?
###### Did the architecture design and choice of services align with the project requirements?
###### Did the architecture design and choice of services align with all the project requirements above?
###### Did the students have the ability to design a cost-effective architecture that meets the project requirements?
###### Were the students able to design a cost-effective architecture that meets the project requirements?
##### Check the student documentation in the `README.md` file.
@ -59,7 +59,7 @@ Review the student's architecture design, ensuring that it meets the project req
###### Is the documentation provided by the student clear and complete, including well-structured diagrams and thorough descriptions?
##### Verify the deployment.
##### Verify the deployment. Ask the auditee **to show you**, the auditor, the use of the commands `aws cli`, `docker ps`, and/or `kubectl` or any other necessary with the right options to answer the following questions.
###### Are all the microservices running as expected in the cloud environment, with no errors or connectivity issues?
@ -67,13 +67,13 @@ Review the student's architecture design, ensuring that it meets the project req
###### Are the microservices communicating with each other securely, using proper authentication and encryption methods?
##### Evaluate the infrastructure setup.
##### Evaluate the infrastructure setup. Ask the auditee **to show you**, the auditor, the use of the commands `terraform plan` and/or `terraform apply` to answer the following questions.
###### Are `Terraform` used effectively to provision and manage resources in the cloud environment?
###### Is `Terraform` used effectively to provision and manage resources in the cloud environment?
###### Does the infrastructure setup follow the architecture design and the project requirements?
##### Assess containerization and orchestration.
##### Assess containerization and orchestration. Ask the auditee **to show you**, the auditor, the use of the commands `aws cli`, `docker ps`, and/or `kubectl` or any other necessary with the right options to answer the following questions.
###### Are the Dockerfiles optimized for efficient container builds?
@ -81,7 +81,7 @@ Review the student's architecture design, ensuring that it meets the project req
##### Evaluate monitoring and logging.
###### Do monitoring and logging dashboards provide useful insights into the application performance and health?
###### Are monitoring and logging dashboards providing useful insights into the application performance and health?
##### Assess optimization efforts.
@ -95,8 +95,6 @@ Review the student's architecture design, ensuring that it meets the project req
#### Bonus
###### +Did the student used his/her own `orchestrator` solution instead of the provided one?
###### +Did the student add any optional bonus?
###### +Is this project an outstanding project?

View File

@ -54,7 +54,7 @@ During the roleplay, ask them the following questions:
###### Are all of the students capable of thinking critically about their solution and considering alternative approaches?
##### Review the GitLab and Runners Deployment:
##### Review the GitLab and Runners Deployment. Ask the auditee **to show you**, the auditor, the use of the commands `ansible-playbook --list-tasks`, and/or `systemctl status` or any other necessary with the right options to answer the following questions.
###### Was the GitLab instance deployed and configured successfully using Ansible?
@ -62,7 +62,7 @@ During the roleplay, ask them the following questions:
##### Review the Infrastructure Pipeline:
###### Does the student deploy the infrastructure of the `cloud-design` project and the source code of `crud-master` project for two environments (staging, prod) on a cloud platform (e.g., AWS, Azure, or Google Cloud) using `Terraform`?
###### Did the student deploy the infrastructure of the `cloud-design` project and the source code of `crud-master` project for two environments (staging, prod) on a cloud platform (e.g., AWS, Azure, or Google Cloud) using `Terraform`?
###### Are the two environments similar in design, resources and services used?
@ -87,7 +87,7 @@ During the roleplay, ask them the following questions:
###### Are the "Deploy to Staging", "Approval", and "Deploy to Production" stages implemented correctly in the CD pipeline for each repository?
##### Review the functionality of pipelines:
##### Review the functionality of pipelines. Ask the auditee **to show you**, the auditor, that the pipelines are functional by running one or several tests of their choosing.
###### Are the pipelines working properly and updating the application and infrastructure after each modification in each repository?