simpleflaskservice

This repo provides a simple Python-Flask Server with several RESTful APIs for learning and testing. I created it to learn about running containers within Pods in Kubernetes, but could be used to test across many orchestrated environments. Deployed on a virtual machine, or baremetal, it could be a useful tool demonstrating HTTP connectivity.

The current release of this code can be deployed from the GitHub Container Repository (GHCR): https://github.com/rzfeeser/simpleflaskservice/pkgs/container/simpleflaskservice

Alternatively, this code can easily be transformed into a docker image following the steps included in this repo. Steps on deploying code found in this repository can be found at the bottom of the README file.

simpleflaskserver 0.1 API endpoints

/env [0.1]

    Methods Accepted: GET

    HTTP/1.1 200 OK
    $HTTP_HEADERZ
     {
         "env": # dump of available environmental variables,
         "version": $VERSION
     }

/health [0.1]

    HTTP/1.1 200 OK
    $HEADER_FIELDS
     {
         "delay in seconds": $HEALTH_DELAY,
         "version": $VERSION,
         "healthy": true
     }

/info [0.1]

    HTTP/1.1 200 OK
    $HTTP_HEADERZ
     {
         "from": "$REMOTE_IP",
         "host": ""$HOST:$PORT"",
         "version": "$VERSION"
     }

/alta3 [0.1]

    HTTP/1.1 200 OK
    $HTTP_HEADERZ
     {
         "thanks": "Thank You for training with Alta3 Research!",
         "alta3":
             {
                 "homepage": "https://alta3.com",
                 "posters": "https://alta3.com/posters",
                 "youtube": "https://www.youtube.com/user/Alta3Research/videos"
             },
         "version": "$VERSION"
     }

/talkingparrot?say=[ANYTHING] [0.1]

Returns a 200 containing a "SQUAKK!!" + the [ANYTHING] string sent to the API endpoint.

    HTTP/1.1 200 OK
    $HTTP_HEADERZ
     {
         "you": "Polly want a cracker?",
         "parrot": "SQUAWK!! Polly want a cracker?",
         "version": "I am talking parrot version $VERSION"
     }

By setting the following environment variables, you can change the runtime behaviour of simpleservice:

- PORT0 - the port simpleservice is serving on
- VERSION - the value of version returned in the JSON response of the /endpoint0 endpoint
- HEALTH_DELAY - delay in milliseconds that the /health endpoint responds

How to Run this Code

1. First, git clone the repository to your local machine.

   git clone https://github.com/rzfeeser/simpleflaskservice

2. Ensure Python 3.6+ has been installed on Debian / Ubuntu Machines

   sudo apt install python3-pip

3. Ensure Python 3.6+ has been installed, then use pip to install Flask.

   python3 -m pip install flask

4. Run the code with Python 3.6+

   python3 simpleflaskservice.py

5. Set the environmental variable VERSION to "24601" and PORT0 to "8887", then launch the server.

   VERSION=24601 PORT0=8887 python3 simpleflaskservice.py

How to Deploy on Docker

1. First build an image.

   sudo docker build -t simpleservice -f Dockerfile .

2. Launch the image in docker with the port 9010 pointing to 9876, and without hogging up the screen (-d).

   docker run -d -p 9010:9876 simpleflaskservice

3. OR Launch the image in docker with a random port pointing to the exposed ports.

   docker run -P simpleflaskservice

Deploy from GitHub Container Repository (GHCR)

1. Launch the image in docker with the port 9010 pointing to 9876, and without hogging up the screen (-d)

   docker run -d -p 9010:9876 ghcr.io/rzfeeser/simpleflaskservice:main

Tests

You can run the following tests to confirm the server is running:

curl localhost:9010/env
curl localhost:9010/info
curl localhost:9010/alta3
curl localhost:9010/health
curl localhost:9010/talkingparrot?say=rzfeeser%20authored%20talking%20parrot

Troubleshooting

1. If you're new to Docker, the following command will stop and delete all running containers on your system. This can be especially useful if you are "stuck" trying to get the service to redeploy. Try starting the deployment instructions over after running this command.

   docker ps -aq | xargs docker stop | xargs docker rm