Skip to content

Commit cd0862a

Browse files
committed
docs: project planning small fixes and formatting
1 parent 7d7cdb6 commit cd0862a

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

docs/project/overview/planning.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ tags:
77

88
# Planning
99

10-
<!-- [TOC] -->
1110

1211
## Stage 0: Project framing
1312

@@ -23,7 +22,6 @@ tags:
2322

2423
## [Stage 1: Requirements specifications and Project setup](https://github.com/DevOps-Boot/fastapi-k8s/milestone/1)
2524

26-
2725
### Activities
2826

2927
* Define project context and scope/perimeter
@@ -37,8 +35,12 @@ tags:
3735
* Organize and document code repository organization
3836
* Organizing project management: Choice of methods
3937

38+
4039
### Deliverables
4140

41+
* Requirements and specification document
42+
* Implementation architecture and workflow schemas
43+
4244

4345
### Deadline
4446

@@ -56,15 +58,18 @@ tags:
5658
* High-Availability
5759
* Backup and Disaster Recovery
5860

61+
5962
### Deliverables
6063

6164
* Infrastructure and application deployment scripts
6265

66+
6367
### Extras
6468

6569
* Implement IaC tools and techniques
6670
* Use Cloud services to host and deploy the application
6771

72+
6873
### Deadline
6974

7075
2023.11.10
@@ -87,6 +92,7 @@ tags:
8792
* Consumption by users
8893
* Log management
8994

95+
9096
### Deliverable
9197

9298
* Any document describing and explaining the chosen architecture (UML diagram)
@@ -98,11 +104,12 @@ tags:
98104
2023.11.20
99105

100106

101-
102107
## [Stage 4: CI/CD pipelines](https://github.com/DevOps-Boot/fastapi-k8s/milestone/4)
103108

104109
!!! note
105110
This is the most important step in the project, as it is the heart of the DevOps training.
111+
!!!
112+
106113

107114
### Activities
108115

@@ -122,14 +129,14 @@ The environments simply have to be separated.
122129

123130
Source code should go through automated tests before being deployed to production to ensure correct behavior.
124131

132+
125133
### Deadline
126134

127135
2023.11.25
128136

129137

130138
## [Stage 5: Monitoring and Observability](https://github.com/DevOps-Boot/fastapi-k8s/milestone/5)
131139

132-
133140
### Activities
134141

135142
**Define metrics and monitor the system** in production to detect errors and potential issues.
@@ -142,17 +149,20 @@ Using a monitoring system, which includes a server, collection agents and a moni
142149
* When the console shows a fault on an indicator, determine the cause of the problem
143150
* Regularly report to developers on performance statistics of their applications in production
144151

152+
145153
### Bonus step
146154

147155
* Define metrics, "health points" relevant to the application.
148156
* Create dashboard to make sense of metric collection.
149157
* Define thresholds from which it is considered that there is a malfunction of the architecture and/or the application, this must trigger an alarm.
150158
* Define automatic actions in response to these alarms.
151159

160+
152161
### Deadline
153162

154163
2023.12.01
155164

165+
156166
## Stage 6: Automation
157167

158168
**Automate deployment of infrastructure, environments, and application.**
@@ -162,6 +172,7 @@ Using a monitoring system, which includes a server, collection agents and a moni
162172
* Use environment variables to secure sensitive data and avoid template redundancy.
163173
These templates will be reusable, repeatable regardless of the deployed environment
164174

175+
165176
### Deadline
166177

167178
2023.12.05
@@ -194,9 +205,9 @@ If the renderings are not up to par and delivered on time, your project cannot b
194205
Semaine du 12 Décembre
195206

196207

197-
## Entretien final
208+
## Final interview
198209

199-
To validate the RNCP36061 “DevOps System Administrator” professional title:
210+
To validate the {{RNCP36061}}:
200211

201212
The evaluation session to obtain the professional title brings together a jury of professionals in the field, is organized face-to-face in Paris and is based on several elements:
202213

0 commit comments

Comments
 (0)