GCI1024 [Team OSER][2025] - Amar salhi code add iac rules 1 #398
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <assembly xmlns="http://maven.apache.org/ASSEMBLY/2.1.1" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.1.1 https://maven.apache.org/xsd/assembly-2.1.1.xsd"> | ||
| <id>kubernetes</id> | ||
| <formats> | ||
| <format>jar</format> | ||
| </formats> | ||
| <includeBaseDirectory>false</includeBaseDirectory> | ||
| <fileSets> | ||
| <fileSet> | ||
| <directory>${project.build.outputDirectory}</directory> | ||
| <includes> | ||
| <include>org/green-code-initiative/rules/kubernetes/*.*</include> | ||
| </includes> | ||
| <outputDirectory/> | ||
| </fileSet> | ||
| </fileSets> | ||
| </assembly> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "title": "Liveness and liveness detection should be avoided", | ||
| "type": "CODE_SMELL", | ||
| "status": "ready", | ||
| "remediation": { | ||
| "func": "Constant\/Issue", | ||
| "constantCost": "5 min" | ||
| }, | ||
| "tags": [ | ||
| "performance", | ||
| "iac", | ||
| "eco-design", | ||
| "creedengo" | ||
| ], | ||
| "defaultSeverity": "Minor" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| == Why this rule is important ? | ||
|
|
||
| The absence of liveness or readiness probes in a Kubernetes deployment can cause undesirable effects: | ||
|
|
||
| - Unstable containers that unnecessarily consume CPU/memory resources. | ||
| - Unready applications receiving traffic, increasing errors and client-side retries. | ||
| - More frequent redeployments or crash-loops. | ||
| - Increased carbon footprint due to inefficient use of resources. | ||
|
|
||
| Defining these probes ensures that the pod is properly supervised by Kubernetes, limiting wasted resources and promoting a leaner, more stable cluster. | ||
|
|
||
| Additional information available on: | ||
|
|
||
| * Research articles: | ||
|
Contributor
There was a problem hiding this comment. Theses articles do not seems to talk about probe (did not read it entirely) |
||
| ** https://arxiv.org/html/2504.10702v1[Container-level Energy Observability in Kubernetes Clusters] | ||
| ** https://arxiv.org/pdf/2503.08641[A Comprehensive Experimentation Framework for Energy-Efficient Design of Cloud-Native Applications] | ||
| * Official Kubernetes documentation: https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/[Liveness, Readiness, and Startup Probes] | ||
|
|
||
| == Non Compliant Code Example | ||
|
|
||
|
|
||
|
|
||
| [source,yml] | ||
| ---- | ||
| # Liveness et readiness probes absentes | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| metadata: | ||
| name: my-app | ||
| spec: | ||
| replicas: 2 | ||
| template: | ||
| spec: | ||
| containers: | ||
| - name: my-app | ||
| image: my-image:latest | ||
|
|
||
| ---- | ||
|
|
||
| == Compliant Code Example | ||
|
|
||
| [source,yml] | ||
| ---- | ||
|
|
||
| livenessProbe: | ||
| httpGet: | ||
| path: /health | ||
| port: 8080 | ||
| initialDelaySeconds: 10 | ||
| periodSeconds: 5 | ||
|
|
||
| readinessProbe: | ||
| httpGet: | ||
| path: /ready | ||
| port: 8080 | ||
| initialDelaySeconds: 5 | ||
| periodSeconds: 10 | ||
|
|
||
|
|
||
| ---- | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't change the Unreleased, it will be update by CI