Adding in api infrastructure using kubernetes deployments

Author: Josh Reynolds

README.md

@@ -1,17 +1,25 @@
-# Welcome to the Class
-
-## Prerequites to run this course (and commands to test for them and installation instructions)
-
-NOTE: Most applications can be installed using [homebrew](https://brew.sh/)
+# Prequisites
 
+NOTE: All applications can also be installed using [homebrew](https://brew.sh/)
 
 ### Required
-* Python 3.8+ -- `python3 --version` -- https://docs.python-guide.org/starting/install3/osx/
-* Docker Desktop -- `docker --version` -- https://docs.docker.com/docker-for-mac/install/
-
+* Python 3.8+ -- `python3 --version` -- https://docs.python-guide.org/starting/install3/osx/  -- `brew install python3`
+* node.js v12+ -- `node --version` -- https://nodejs.org/en/download/package-manager/#macos -- `brew install node`
+* Docker Desktop -- `docker --version` -- https://docs.docker.com/docker-for-mac/install/ -- `brew install --cask docker`
 
 ### Recommended
-* VSCode -- `code --version` -- https://code.visualstudio.com/docs/setup/mac
+* VSCode -- `code --version` -- https://code.visualstudio.com/docs/setup/mac -- `brew install --cask visual-studio-code`
+
+Note: Any code editor will do.  Support for python and javascript is ideal.
+
+### Configuration
 
+Please enable a kubernetes cluster on your local machine using the docker desktop dashboard. 
 
+1. From the docker desktop tray select `Dashboard`
+2. Select the gear icon in the upper right
+3. Select `Kubernetes` from the list on the left
+4. Check the `Enable Kubernetes` checkbox -- this will take a minute or two to determine if it is running.
+5. Verify installation by runing `kubectl get pods --all-namespaces` and seeing output of running system containers.
 
+If you run in to trouble no sweat.  We will have time to cover this.

api/Makefile

@@ -11,7 +11,10 @@ test: venv
 	. $(PYBIN)/activate; python -m unittest discover todo/unittests
 
 integration-test: venv
+	docker-compose up -d db
+	sleep 8
 	. $(PYBIN)/activate; python manage.py test todo/integrationtests
+	docker-compose down
 
 migrations: venv
 	. $(PYBIN)/activate; python manage.py makemigrations todo
@@ -25,8 +28,8 @@ makesuperuser:
 oneclickbuild: 
 	docker-compose up --build
 
-db-only:
-	docker-compose up db
+db-up:
+	docker-compose up db -d
 
 shutdown:
 	docker-compose down
@@ -39,4 +42,20 @@ run: venv
 
 clean:
 	rm -rf venv
-	find . -iname "*.pyc" -delete
+	find . -iname "*.pyc" -delete
+
+build-docker:
+	docker build . --tag class/api
+
+# CD
+deploy: test integration-test build-docker
+	kubectl delete pod -l app=api
+	kubectl apply -f infrastructure/api.yml
+
+# Localhost access
+bind-api-locally:
+	kubectl port-forward service/api 8000:8000
+
+# Installation and set-up
+install-kube-postgres:
+	kubectl apply -f infrastructure/postgres.yml

api/infrastructure/api.yml

@@ -0,0 +1,36 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: api
+spec:
+  replicas: 1
+  selector:
+      matchLabels:
+          app: api
+  template:
+    metadata:
+      labels:
+        app: api
+    spec:
+      containers:
+        - name: api
+          image: class/api:latest
+          imagePullPolicy: Never
+          ports:
+            - containerPort:  8000
+          env:
+            - name: DATABASE_URL
+              value: postgres://postgres:postgres@postgres:5432/postgres
+
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: api
+spec:
+  selector:
+    app: api
+  ports:
+  - port: 8000
+    targetPort: 8000
+  type: NodePort

api/infrastructure/postgres.yml

@@ -0,0 +1,39 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: postgres
+spec:
+  replicas: 1
+  selector:
+      matchLabels:
+          service: postgres
+  template:
+    metadata:
+      labels:
+        service: postgres
+    spec:
+      containers:
+        - name: postgres
+          image: postgres:latest
+          ports:
+            - containerPort: 5432
+          env:
+            - name: POSTGRES_DB
+              value: postgres
+            - name: POSTGRES_USER
+              value: postgres
+            - name: POSTGRES_PASSWORD
+              value: postgres
+
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: postgres
+spec:
+  selector:
+    service: postgres
+  ports:
+  - port: 5432
+    targetPort: 5432
+  type: NodePort

api/todo/serializers.py

@@ -17,5 +17,6 @@ class TodoSerializer(serializers.ModelSerializer):
     title = TitleField()
 
     class Meta:
+        
         model = Todo
         fields = ('id', 'title', 'description', 'priority', 'completed')