diff --git a/README.md b/README.md index 36aa346..dba10e3 100644 --- a/README.md +++ b/README.md @@ -1 +1,260 @@ -# corise-zignite-devops-cc \ No newline at end of file +# Intro to DevOps - Week 2 Project Starter Code + +# Goal +## Containerize two Flask web services and use Docker Compose to orchestrate them +### For our week 2 project, we will be containerizing two Flask apps, one generates a Random Quote, and the other service consumes this and displays it on a neat front end. +### Then we shall be using Docker Swarm to orchestrate the services to achieve our end goal. This exercise will help us understand a real-world use case of Docker and Docker Swarm better. + +## Prerequisites +
Basic knowledge of programming and APIs is needed.
+
The tutorial on how to start a Docker Container is here - https://docs.docker.com/language/python/build-images/
+ +## Environment Setup - Things needed to run Project 2 + +Install Docker Desktop from here - https://docs.docker.com/desktop/. +Choose the distribution of your choice but we will be using Windows. +Docker compose, the CLI tools come along with Docker Desktop. + +Download the starter file from here - (https://github.com/sb2nov/corise-zignite-devops-cc) + +Test if Docker is installed by running the following command in the terminal +``` +docker run hello-world +``` +If everything is installed right you get a response 'Hello from Docker! We are all good to go, let's start off our Week 2 project then! + +# Steps +Download or Clone the repo https://github.com/sb2nov/corise-zignite-devops-cc/tree/starter_code + +Create a Docker File within the cloned Repository +``` +vim Dockerfile +``` + +The Python application directory structure should now look like the following: +``` +quote_gen +|____ static +|____ templates +|____ app.py +|____ requirements.txt +|____ Dockerfile +``` +``` +quote_disp +|____ static +|____ templates +|____ app.py +|____ requirements.txt +|____ Dockerfile +``` + +Let's create a basic container in each of the directories +``` +FROM python:3.8-slim-buster +COPY . /app +WORKDIR /app +RUN pip install -r requirements.txt +ENTRYPOINT [ "python" ] +CMD [ "app.py" ] +``` + +Let's see what each of these commands means - + +
FROM python - gets a Python distribution from Docker Images
+
WORKDIR Changes the working directory
+
COPY Copies the content of Workdir into a new directory
+ +Build the Docker Images - +``` +cd quote_gen +``` +``` +docker build --tag quote-gen-service . +``` +``` +cd quote_disp +``` +``` +docker build --tag quote-disp-service . +``` + +Run Docker Container + +With the Docker images created, let’s get the containers up and running +``` +cd quote_gen +docker run --name quote-gen-container -p 84:84 quote-gen-service +``` +``` +cd quote_disp +docker run --name quote-disp-container -p 85:85 quote-disp-service +``` + +Let’s run docker container ls to get a list of containers created + +Create Docker Network + +``` +docker network create quote-network +``` +and running the followng command +``` +docker network inspect quote-network +``` + +Let's add our containers to the quote-network + +``` +docker network connect quote-network quote-gen-container +docker network connect quote-network quote-disp-container +docker network inspect quote-network +``` +You see the following output - + +``` +[ + { + "Name": "quote-network", + "Id": "999c81eb87c4b687921ea474abd1e59875447a96d2477ae190dcccc40f882d8a", + "Created": "2023-04-24T04:45:15.9081804Z", + "Scope": "local", + "Driver": "bridge", + "EnableIPv6": false, + "IPAM": { + "Driver": "default", + "Options": {}, + "Config": [ + { + "Subnet": "172.19.0.0/16", + "Gateway": "172.19.0.1" + } + ] + }, + "Internal": false, + "Attachable": false, + "Ingress": false, + "ConfigFrom": { + "Network": "" + }, + "ConfigOnly": false, + "Containers": { + "2636f9d91e5468029981d499fc7e0b46a204d8fc3b16e5e7e6e912651ce8dd4a": { + "Name": "quote-disp-container", + "EndpointID": "a4eb7320b1585b43a10499a73059e8f50fb8d5e33f9aee433b1b7e5e0b1dee85", + "MacAddress": "02:42:ac:13:00:03", + "IPv4Address": "172.19.0.3/16", + "IPv6Address": "" + }, + "557e1ff9f220704ad9f76d94ebe5d3c433dc20ed44798831af6f2bfe68176583": { + "Name": "quote-gen-container", + "EndpointID": "191f2b22ec8a92256d47b152a06eeaeead9f05a13799f48d43d9c5410daceebb", + "MacAddress": "02:42:ac:13:00:02", + "IPv4Address": "172.19.0.2/16", + "IPv6Address": "" + } + }, + "Options": {}, + "Labels": {} + } +] +``` + +Let's see if the dockers are communicating +``` +StatusCode : 200 +StatusDescription : OK +Content : + Docker App Quote +
+
+
+
; outerText=; tagName=A; class=link; href=https://youtube.com/@Hyperplexed; + target=_blank}} +ParsedHtml : mshtml.HTMLDocumentClass +RawContentLength : 503 +``` +They seem to be working! + +Let's create a Docker Compose Manifest to orchestrate our services + +``` +version: "3.7" +services: + web1: + build: ./quote_gen + container_name: gen + ports: + - "5000:5000" + web2: + build: ./quote_disp + container_name: disp + expose: + - "5000" + ports: + - "5001:5000" + depends_on: + - web1 +``` + +Let's understand the commands in our Compose YAML file - + +version: - Compose file versions that run our Docker Compose + +services: the components or services that run within the docker-compose manifest + +Eg - Our website is a service, we can have a database service or a unit testing service, an application server, etc + +Under service, we have our website - service name, build - looks for a docker image, context - specifies where to look + +ports: -80:80 + +Run Docker Compose +``` +docker-compose up +``` + +``` +[+] Running 3/3 + - Network corise-zignite-devops-cc_default Created 0.8s + - Container gen Created 0.6s + - Container disp Created 0.1s +Attaching to disp, gen +gen | * Serving Flask app 'app' +gen | * Debug mode: on +gen | WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. +gen | * Running on all addresses (0.0.0.0) +gen | * Running on http://127.0.0.1:5000 +gen | * Running on http://172.26.0.2:5000 +gen | Press CTRL+C to quit +gen | * Restarting with stat +gen | * Debugger is active! +gen | * Debugger PIN: 930-011-562 +disp | * Serving Flask app 'app' +disp | * Debug mode: on +disp | WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead. +disp | * Running on all addresses (0.0.0.0) +disp | * Running on http://127.0.0.1:5000 +disp | * Running on http://172.26.0.3:5000 +disp | Press CTRL+C to quit +disp | * Restarting with stat +disp | * Debugger is active! +disp | * Debugger PIN: 112-266-209 +``` + +## You can find a link to the Docker Compose tutorial https://docs.docker.com/compose/gettingstarted/ diff --git a/quote_disp/Dockerfile b/quote_disp/Dockerfile index 0a9eb01..88a739d 100644 --- a/quote_disp/Dockerfile +++ b/quote_disp/Dockerfile @@ -1,6 +1,6 @@ -FROM python:3.8-slim-buster -COPY . /app -WORKDIR /app -RUN pip install -r requirements.txt -ENTRYPOINT [ "python" ] -CMD [ "app.py" ] \ No newline at end of file +FROM python:3.8-slim-buster +COPY . /app +WORKDIR /app +RUN pip install -r requirements.txt +ENTRYPOINT [ "python" ] +CMD [ "app.py" ] diff --git a/quote_disp/__pycache__/app.cpython-38.pyc b/quote_disp/__pycache__/app.cpython-38.pyc deleted file mode 100644 index b15b672..0000000 Binary files a/quote_disp/__pycache__/app.cpython-38.pyc and /dev/null differ diff --git a/quote_disp/app.py b/quote_disp/app.py index 6e32c62..18b3844 100644 --- a/quote_disp/app.py +++ b/quote_disp/app.py @@ -1,24 +1,28 @@ -from flask import Flask, render_template import random + import requests +from flask import Flask, render_template app = Flask(__name__) + @app.route("/health") def health(): - return int(200) + return "healthy" + @app.route("/") def home(): - return render_template('index.html') + return render_template("index.html") + @app.route("/get_quote") -def get_quote(): +def quote(): + quote = requests.get("http://gen:5000/quote").text + print("quote - ", quote) - quote = requests.get('http://gen:5000/quote') - print('quote - ', quote) + return render_template("quote.html", quote=quote) - return render_template('quote.html', quote = quote) if __name__ == "__main__": - app.run(host="0.0.0.0", debug = True) \ No newline at end of file + app.run(host="0.0.0.0", debug=True, port=5001) diff --git a/quote_gen/Dockerfile b/quote_gen/Dockerfile index 39226e9..88a739d 100644 --- a/quote_gen/Dockerfile +++ b/quote_gen/Dockerfile @@ -1,6 +1,6 @@ -FROM python:3.8-slim-buster -COPY . /app -WORKDIR /app -RUN pip install -r requirements.txt -ENTRYPOINT [ "python" ] -CMD [ "app2.py" ] \ No newline at end of file +FROM python:3.8-slim-buster +COPY . /app +WORKDIR /app +RUN pip install -r requirements.txt +ENTRYPOINT [ "python" ] +CMD [ "app.py" ] diff --git a/quote_gen/app.py b/quote_gen/app.py new file mode 100644 index 0000000..7499579 --- /dev/null +++ b/quote_gen/app.py @@ -0,0 +1,43 @@ +import random + +from flask import Flask, render_template + +app = Flask(__name__) + +quotes = [ + "The greatest glory in living lies not in never falling, but in rising every time we fall. -Nelson Mandela", + "The way to get started is to quit talking and begin doing. -Walt Disney", + "Your time is limited, so don't waste it living someone else's life. Don't be trapped by dogma – which is living with the results of other people's thinking. -Steve Jobs", + "If life were predictable it would cease to be life, and be without flavor. -Eleanor Roosevelt", + "If you look at what you have in life, you'll always have more. If you look at what you don't have in life, you'll never have enough. -Oprah Winfrey", + "If you set your goals ridiculously high and it's a failure, you will fail above everyone else's success. -James Cameron", +] + + +@app.route("/health") +def health(): + return "healthy" + + +@app.route("/") +def home(): + return render_template("index.html") + + +@app.route("/quote") +def quote(): + quotes = [ + "The greatest glory in living lies not in never falling, but in rising every time we fall. -Nelson Mandela", + "The way to get started is to quit talking and begin doing. -Walt Disney", + "Your time is limited, so don't waste it living someone else's life. Don't be trapped by dogma – which is living with the results of other people's thinking. -Steve Jobs", + "If life were predictable it would cease to be life, and be without flavor. -Eleanor Roosevelt", + "If you look at what you have in life, you'll always have more. If you look at what you don't have in life, you'll never have enough. -Oprah Winfrey", + "If you set your goals ridiculously high and it's a failure, you will fail above everyone else's success. -James Cameron", + ] + + index = random.randrange(len(quotes)) + return str(quotes[index]) + + +if __name__ == "__main__": + app.run(host="0.0.0.0", port=5000, debug=True) diff --git a/quote_gen/app2.py b/quote_gen/app2.py deleted file mode 100644 index f152f46..0000000 --- a/quote_gen/app2.py +++ /dev/null @@ -1,28 +0,0 @@ -from flask import Flask -import random - -app = Flask(__name__) - -quotes = ['The greatest glory in living lies not in never falling, but in rising every time we fall. -Nelson Mandela', 'The way to get started is to quit talking and begin doing. -Walt Disney', "Your time is limited, so don't waste it living someone else's life. Don't be trapped by dogma – which is living with the results of other people's thinking. -Steve Jobs", 'If life were predictable it would cease to be life, and be without flavor. -Eleanor Roosevelt', "If you look at what you have in life, you'll always have more. If you look at what you don't have in life, you'll never have enough. -Oprah Winfrey", "If you set your goals ridiculously high and it's a failure, you will fail above everyone else's success. -James Cameron"] - -@app.route("/health") -def health(): - return 'healthy' - -@app.route("/quote") -def quote(): - - quotes = [ - 'The greatest glory in living lies not in never falling, but in rising every time we fall. -Nelson Mandela', - 'The way to get started is to quit talking and begin doing. -Walt Disney', - "Your time is limited, so don't waste it living someone else's life. Don't be trapped by dogma – which is living with the results of other people's thinking. -Steve Jobs", - 'If life were predictable it would cease to be life, and be without flavor. -Eleanor Roosevelt', - "If you look at what you have in life, you'll always have more. If you look at what you don't have in life, you'll never have enough. -Oprah Winfrey", - "If you set your goals ridiculously high and it's a failure, you will fail above everyone else's success. -James Cameron" - ] - - index = random.randrange(len(quotes)) - return str(quotes[index]) - -if __name__ == "__main__": - app.run(host="0.0.0.0", debug = True) \ No newline at end of file diff --git a/quote_gen/templates/index.html b/quote_gen/templates/index.html index b00e5e4..ffcde14 100644 --- a/quote_gen/templates/index.html +++ b/quote_gen/templates/index.html @@ -1,16 +1,15 @@ - - - - + + + Quote Gen Service + - - - - -

Quote Generation Service

- - - \ No newline at end of file + +

Quote Generation Service

+ +