Klagarge/MSE-CyberSec-DevSecOps
1
0
Fork 0
Code Issues Pull Requests Releases Activity

update the overall README.md file

Browse Source
This commit is contained in:
Michael Mäder
2025-03-11 15:39:36 +01:00
parent 34c4a80c61
commit f447ce21c8
1 changed files with 14 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -21,11 +21,11 @@ The lab will be performed in groups of two students.
The groups (pair) will be evaluated. The groups (pair) will be evaluated.
Any work is stored by the groups in their own Git repo, in the **`main` branch**. This contains: Any work is stored by the groups in their own Git repo. The professor controls only the **`main` branch**. Finally the main branche should contain:
* Code * Code
* CI/CD pipeline * CI/CD pipeline
* Documentation * Documentation / answers to the questions
The documentation contains the answers to all the questions asked. It is a rolling lab, which means, that additional questions will come each week. Use the question files (e.g. `docs/question-part1.md`) for your answers! (--> Overall duration of the lab approximately 5 weeks) The documentation contains the answers to all the questions asked. It is a rolling lab, which means, that additional questions will come each week. Use the question files (e.g. `docs/question-part1.md`) for your answers! (--> Overall duration of the lab approximately 5 weeks)
@@ -33,35 +33,33 @@ The documentation contains the answers to all the questions asked. It is a rolli
How is the lab graded? How is the lab graded?
- If you answer the questions correctly, you have the grade 5.0 * If you answer the questions correctly, you have the grade 5.0
- To get more than 5.0, you must for example : * To get more than 5.0, you must for example :
- propose an original solution * propose an original solution
- deepen one or more themes * deepen one or more themes
- answer the optional questions of the labs (if there are any) * answer the optional questions of the labs (if there are any)
### Submission ### Submission
All your work must be terminated and commit to your *group repo* at latest **16.04.2024** All your work must be terminated and commit to your *group repo* at latest **16.04.2025**
## Preparation ## Preparation
You must (in the pair) fork the Git Repo that contains an example Web-API application with a minimalistic CI/CD pipeline. This repo will build the starting point for all your upcoming lab tasks. These preparation steps will be done together in class You must (in the pair) fork the Git Repo that contains an example Web-API application with a minimalistic CI/CD pipeline. This repo will build the starting point for all your upcoming lab tasks. These preparation steps will be done together in class
### Tasks ### Tasks
1. Fork this git repo here https://gitlab.forge.hefr.ch/devsecops/mse-dev-sec-ops-2324 1. Fork this git repo here https://gitlab.forge.hefr.ch/devsecops/mse-dev-sec-ops-2425
- Get some inspiration [here](https://concurp.pages.forge.hefr.ch/2022-2023/website/lab00/) how to fork a repo - Get some inspiration [here](https://concurp.pages.forge.hefr.ch/2022-2023/website/lab00/) how to fork a repo
2. Give **Maintainer** access to your colleague in your group 2. Give **Maintainer** access to your colleague in your group
3. Give **Developer** access to the professor (@michael.maeder) 3. Give **Developer** access to the professor (@michael.maeder)
4. Clone your newly created repo to your local machine and `cd` into the directory 4. Clone your newly created repo to your local machine and `cd` into the directory
5. Set the `upstream` to the main repo to get any updates 5. Set the `upstream` to the main repo to get any updates
* `git remote add upstream git@gitlab.forge.hefr.ch:devsecops/mse-dev-sec-ops-2324.git` * `git remote add upstream git@gitlab.forge.hefr.ch:devsecops/mse-dev-sec-ops-2425.git`
6. `git pull upstream main` will update your fork repo with the latest changes from the main repo 6. `git pull upstream main` will update your fork repo with the latest changes from the main repo
# Lab environment setup
# Lab envrionment setup
In the first part, the lab will be mainly a setup of the environment for everybody to ensure that you can work correctly. The basics will be shown directly in the course. In the first part, the lab will be mainly a setup of the environment for everybody to ensure that you can work correctly. The basics will be shown directly in the course.
@@ -86,19 +84,16 @@ You must understand the application, how it works, the basics of Flask (as web p
The provided basic pipeline description `.gitlab-ci.yml` is **not optimized at all**. It works in a *shaky* way and does the following tasks: The provided basic pipeline description `.gitlab-ci.yml` is **not optimized at all**. It works in a *shaky* way and does the following tasks:
- run the unit tests (described in `src/tests`) * run the unit tests (described in `src/tests`)
- checks the test coverage * checks the test coverage
- create a test and coverage report in HTML format, which is then accessible through **your** gitlab pages (e.g. `https://devsecops.pages.forge.hefr.ch/mse-dev-sec-ops-2223/`) * create a test and coverage report in HTML format, which is then accessible through **your** gitlab pages (e.g. `https://devsecops.pages.forge.hefr.ch/mse-dev-sec-ops-2425/`)
## The questions ## The questions
The questions for all the parts can be found in the [questions-partX.md files](./docs/) file in the docs directory. You can write your answers directly into these files if you wish. The questions for all the parts can be found in the [questions-partX.md files](./docs/) file in the docs directory. You can write your answers directly into these files if you wish.
# Resources # Resources
* [TSM Cybersecurity Moodle](https://moodle.msengineering.ch/course/view.php?id=2376) * [TSM Cybersecurity Moodle](https://moodle.msengineering.ch/course/view.php?id=2376)
* [Lecture notes](https://heia-fr-maeder.github.io/mse_cybersec) * [Lecture notes](https://heia-fr-maeder.github.io/mse_cybersec)
* [Coverage report](hhttps://mse-dev-sec-ops-2324-devsecops-mse-fd7bb329cbf2fd39e71840cb4686.pages.forge.hefr.ch/)
* [Short Intro to CI/CD](https://www.youtube.com/watch?v=l5705U8s_nQ&t=358s) * [Short Intro to CI/CD](https://www.youtube.com/watch?v=l5705U8s_nQ&t=358s)
* [How to make your code shine with Gitlab CI pipelines](https://medium.com/semantixbr/how-to-make-your-code-shine-with-gitlab-ci-pipelines-48ade99192d1) * [How to make your code shine with Gitlab CI pipelines](https://medium.com/semantixbr/how-to-make-your-code-shine-with-gitlab-ci-pipelines-48ade99192d1)