Update README.md

Author: Timoo20

README.md

@@ -26,97 +26,112 @@ The main goal of this exercise was to set up a simple web server inside a Docker
 1. **Creating the Dockerfile**: I started by creating a `Dockerfile` to configure the web server. The Dockerfile uses the official **Nginx** image, and it exposes the application on port `8002`.
 
     ```Dockerfile
-    # Use the official Nginx image
+    # Nginx image in the Docker Hub
     FROM nginx:latest
-    
-    # Copy custom index.html to the container's web directory
-    COPY index.html /usr/share/nginx/html/index.html
-    
-    # Expose port 8002 for the web server
+        # Nginx configuration
+    COPY nginx/nginx.conf /etc/nginx/nginx.conf
+        # Exposing the port 8002
     EXPOSE 8002
-    ```
-
+        # Health Check
+    HEALTHCHECK --interval=30s --timeout=5s --retries=3 \
+      CMD curl -f http://localhost:8002/ || exit 1
+        # default command to run Nginx
+    CMD ["nginx", "-g", "daemon off;"]
+        ```
 2. **Building and Running the Container**:
    After writing the Dockerfile, I built the Docker image using the following command:
    ```bash
-   docker build -t my-nginx-app .
+   docker build -t terra-simple-nginx-server .
    ```
    And ran the container:
    ```bash
-   docker run -d -p 8002:80 my-nginx-app
+   docker run -d -p 8002:80 terra-simple-nginx-server
    ```
-
-Once this was set up, the web server was live and accessible at `http://localhost:8002`.
+The web server was live and accessible at `http://localhost:8002`. As shown in the Screenshort [https://github.com/Timoo20/info-sec-devops-devsecops-terra/blob/main/images-screenshots/Validating%20in%20localhost.png]
 
 ---
+### Health Check
 
-### Health Check Configuration
-
-A health check is essential to ensure that the container is up and running correctly. To add this, I configured a health check in the Dockerfile, which pings the root path of the web server every 30 seconds to ensure it is alive.
+A health check is important as it ensures that the container is up and running perfectly; as expected. To achieve this, I configured a health check in the Dockerfile that pings the root path of the web server every 30 seconds to ensure it is alive.
 
 ```Dockerfile
 HEALTHCHECK --interval=30s --timeout=10s --retries=3 \
     CMD curl --silent --fail http://localhost:8002/ || exit 1
 ```
-
-If the web server does not respond successfully within the set parameters, Docker will consider the container "unhealthy."
+[As shown in the screenshort](https://github.com/Timoo20/info-sec-devops-devsecops-terra/blob/main/images-screenshots/Health-Container-Status.png) 
+Incase the web server does not respond successfully within the configured param, then Docker will consider the container "UNHEALTHY."
 
 ---
 
 ### Troubleshooting Docker Health Checks
 
-During my setup, I encountered an issue where the health check was consistently failing. Here’s how I tackled the issue:
+If I encounter issues with Docker health checks, I would take to troubleshoot the problem by:
 
-1. **Check the Logs**: First, I looked at the container logs using `docker logs <container_id>` to see if there were any clues about errors or misconfigurations.
-   
-2. **Examine the Health Check Status**: Using the command `docker inspect --format='{{json .State.Health}}' <container_id>`, I was able to inspect the health check status and pinpoint the issue.
+1. **Checking the Logs**:  
+   First, I would check the container logs to gather any clues about errors or misconfigurations that might be affecting the health check. For example, I ran the following command for my container:
+   ```bash
+   docker logs 350df94ecfdc
+---
+The logs showed the server returning the expected **"Hey! This is hello from Terra Software Company. Welcome to your Nginx server" **message, which confirmed the web server was functioning correctly.
 
-3. **Test the Web Server Directly**: To rule out potential networking issues, I accessed the container directly using `docker exec` and tested the server internally with `curl`.
+2. **Examine the Health Check Status:**
 
-4. **Increase Timeout & Retry Settings**: Finally, I tweaked the health check settings, such as increasing the timeout and retry count, which helped the container pass the health check successfully.
+   ```bash
+   docker inspect --format='{{json .State.Health}}' 350df94ecfdc
+    ---
+
+When I executed the command, it showed that it is in healthy [As shown in the screenshort](https://github.com/Timoo20/info-sec-devops-devsecops-terra/blob/main/images-screenshots/Health-Container-Status.png) ; hence confirming the container was in good health. 
 
----
 
-## Scenario-Based Troubleshooting
+3. **Teting in web server directly:**
+
+   I access the container directly and test the web server inside using curl. This helps in fixing network issues.
+  
+
+4. **Increasing the Timeout & Retry Configuration::**
+
+   I would change the health params to fix the issue. For example; instead of 5 seconds in the timeout onfiguration, I would consider extending it to about 10 Seconds. 
+  
+
+
+## PART 2
 
 ### Scenario 1: Failing Health Checks in Docker
 
-Sometimes, health checks can fail due to various reasons, like misconfigurations or network issues. In my case, the Docker health check was failing.
+Health checks can fail because of misconfigurations or maybe because of network issues. In my case, the Docker health check was successful. Incase Docker fails, i would have considered:
 
-#### Here's how I solved it:
-1. **Inspect the Health Check Output**: I started by using `docker inspect` to get more details about the health check status, which pointed out that the issue was a time-out from the health check ping.
+1. **Inspecting the Health Checks**: I would utilize `docker inspect` to get finer details about the health status. 
    
-2. **Check the Web Server Logs**: The logs revealed that Nginx was not fully loading the content due to a missing file.
+2. **Checking the Web Server Logs**: I would keenly check the server logs.
 
-3. **Adjust the Health Check Parameters**: After resolving the file issue, I adjusted the health check’s timeout and retries to give the container a little more time to respond.
-
-4. **Rebuild the Container**: Once the changes were made, I rebuilt the Docker container and ran it again. This time, the health check passed, confirming the issue was resolved.
+3. **Fine tuning the the Health Check Params**: I would fine tune the health params to fix the issue. For example; instead of 5 seconds in the timeout onfiguration, I would consider extending it to about 10 Seconds. 
+  
+4. **Rebuilding the Container**: I will rebuilt the  container and ran it again.
 
 ---
 
 ### Scenario 2: Nginx Ingress Not Accessible
 
-In this scenario, I exposed a service via **Nginx Ingress**, but it wasn’t accessible over the internet. Here’s how I approached the troubleshooting:
+In this scenario, this is how I would approach the troubleshooting:
 
-1. **Check the Ingress Controller**: I first made sure that the **Nginx Ingress Controller** was properly set up and running in my Kubernetes cluster by using `kubectl get pods -n ingress-nginx`.
+1. **Checking the Ingress Controller**: I would first assess the Ingress Controller to ensure that it is up and running.
 
-2. **Inspect the Ingress Resource**: I verified that the **Ingress Resource** was configured correctly with the correct **host** and **service** details.
+2. **Inspecting the Ingress Resource**: I would keenly verify the ingress Resource; to ensure that it is properly correctly with the correct **service** and **host** details.
 
-3. **DNS and Routing**: Next, I checked if the DNS settings were correctly pointing to the IP address of the Ingress controller.
+3. **DNS checking**: I would check the DNS settings to ensure that they are correctly pointing to the exact Ingress controller - IP address.
 
-4. **Firewall Rules**: I made sure that the relevant ports (80/443) were open in the cloud provider’s security group or firewall.
+4. **Firewall Rules**: I would check if the ports Port 80/443 were open in the cloud provider’s security group or firewall.
 
-5. **Nginx Logs**: Finally, I looked at the logs of the **Nginx Ingress Controller** to check for any issues in routing or configuration.
+5. **Nginx Logs**: Finally, I would look at the logs to check for any issues in routing or configuration.
 
 ---
 
 ## Tech Stack Used
 
-- **Docker**: To build and run the containerized web application.
-- **Nginx**: Used as the web server to serve the content.
-- **Kubernetes & Ingress**: To manage and expose services in a Kubernetes environment.
-- **Curl & Wget**: For testing service health and availability.
-- **YAML & Dockerfiles**: For configuration management and defining services.
+- **Docker**: To build and run the terra-simple-nginx-server application.
+- **Nginx**: Utilized as the web server to serve the content.
+- **Curl**: For testing service health and availability.
+- **Yaml & Dockerfiles**: For configuration management.
 
 ---
 
@@ -125,19 +140,21 @@ In this scenario, I exposed a service via **Nginx Ingress**, but it wasn’t acc
 To get started with this project, you'll need:
 
 - **Docker** installed on your local machine or VM.
-- **Kubernetes** (optional, for the Nginx Ingress exercise).
 - Access to a terminal to run the commands and build the containers.
 
 ---
 ## About Me & Contact
 
-I'm a **Cybersecurity/DevSecOps/DevOps professional** passionate about building secure, scalable, and efficient applications. I focus on bridging the gap between development and security to create seamless solutions that are both effective and safe.
+I'm a **Developer/Cybersecurity/DevSecOps/DevOps professional** passionate about building secure, scalable, and efficient applications. I focus on bridging the gap between development and security to create seamless solutions that are both effective and safe.
 
 If you want to connect or have any questions about this repository or the exercises, feel free to reach out!
 
 - **Email**: [[email protected]](mailto:[email protected])
-- **LinkedIn**: [Tim Murkomen](https://www.linkedin.com/in/timoo20//)
+- **LinkedIn**: [Tim Murkomen](https://www.linkedin.com/in/timoo20/)
 ---
 ## LICENCE
 **License**: This project is Licensed under a Tim Murkomen Custom License by Tim Murkomen - Here is the Link  [Custom Licence](https://github.com/Timoo20/info-sec-devops-devsecops-terra/blob/main/LICENSE)
-```
+
+---
+Contributor: [Tim Murkomen](https://github.com/Timoo20) 
+---