This repository has been archived by the owner on Aug 20, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 105
Initial commit adding the TODO sample #30
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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,113 @@ | ||
# TODO Application Sample | ||
|
||
This sample illustrates how Bridge to Kubernetes can be used to develop a microservice version of the celebrated TODO application on any Kubernetes cluster. This sample has been adapted from code provided by [TodoMVC](http://todomvc.com). | ||
|
||
Most sample TODO applications are composed of a frontend and some kind of backend persistent storage. This extended sample adds a statistics component and breaks the application into a number of microservices, specifically: | ||
|
||
- The frontend uses a Mongo database to persist TODO items; | ||
- The frontend writes add, complete and delete events to a RabbitMQ queue; | ||
- A statistics worker receives events from the RabbitMQ queue and updates a Redis cache; | ||
- A statistics API exposes the cached statistics for the frontend to show. | ||
|
||
In all, this extended TODO application is composed of six inter-related components. | ||
|
||
## Prerequisites | ||
|
||
- Kubectl CLI (connected to a cluster) | ||
- [Bridge to Kubernetes VS Code extension](https://aka.ms/bridge-to-k8s-vsc-extension) | ||
|
||
## Deploy the application | ||
|
||
In this example, we will use a local cluster, MiniKube. | ||
|
||
First, create a namespace for the sample. | ||
|
||
``` | ||
kubectl create namespace todo-app | ||
``` | ||
|
||
Then, apply the deployment manifest: | ||
|
||
``` | ||
kubectl apply -n todo-app -f deployment.yaml | ||
``` | ||
|
||
This is a simple deployment that exposes the frontend using a service of type `LoadBalancer`. Wait for all the pods to be running and for the external IP of the `frontend` service to become available. | ||
|
||
If you are testing with MiniKube, you will need to use `minikube tunnel` to resolve an external IP. | ||
|
||
``` | ||
kubectl get services -n todo-app | ||
|
||
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE | ||
frontend LoadBalancer 10.0.49.177 127.0.0.1 80:30145/TCP 18h | ||
``` | ||
|
||
Browse to the application using the external IP and give it a spin. As you add, complete and delete todos, notice that the stats page updates with the expected metrics | ||
|
||
## Debug the stats-api service | ||
|
||
We will now use the Bridge to Kubernetes extension to demonstrate how traffic from the Kubernetes cluster can be redirected to a locally running version of the stats-api. | ||
|
||
``` | ||
cd stats-api/ | ||
``` | ||
|
||
Open the source code for the stats-api in VS Code. | ||
|
||
``` | ||
code . | ||
``` | ||
|
||
Place a breakpoint on line 17 of server.js. | ||
|
||
Open the `Command Pallette (Ctrl + SHIFT + P) or (CMD + SHIFT + P)` and type Bridge to Kubernetes. Select the `"Bridge to Kubernetes: Configure"` option. | ||
|
||
 | ||
|
||
You are prompted to configure the service you want to replace, the port to forward from your development computer, and the launch task to use. | ||
|
||
Choose the `stats-api` service. | ||
 | ||
|
||
After you select your service, you are prompted to enter the TCP port for your local application. For this example, enter `3001`. | ||
 | ||
|
||
Choose `Run Script: dev` as the launch task. | ||
 | ||
|
||
You have the option of running isolated or not isolated. If you run isolated, only your requests are routed to your local process; other developers can use the cluster without being affected. If you don't run isolated, all traffic is redirected to your local process. For more information on this option, see [Using routing capabilities for developing in isolation](https://docs.microsoft.com/en-us/visualstudio/containers/overview-bridge-to-kubernetes?view=vs-2019#using-routing-capabilities-for-developing-in-isolation). For this example, we will proceed with non-isolated. | ||
 | ||
|
||
> Note: You will be prompted to allow the EndpointManager to run elevated and modify your hosts file. | ||
|
||
The Bridge to Kubernetes debugging profile has been successfully configured. | ||
|
||
Select the Debug icon on the left and select `Run Script: dev with Bridge to Kubernetes`. Click the start button next to `Run Script: dev with Kubernetes`. | ||
|
||
 | ||
|
||
Your development computer is connected when the VS Code status bar turns orange and the Kubernetes extension shows you are connected. Once your development computer is connected, traffic starts redirecting to your development computer for the stats-api you are replacing. | ||
|
||
 | ||
|
||
|
||
Navigate to the frontend entry point of your todo-app. For minikube, we'll be using `127.0.0.1`. | ||
|
||
Make a request to the stats-api by clicking on the `stats` link. | ||
|
||
 | ||
|
||
Notice the traffic that initally started in your cluster was redirected to your locally running version (outside of the cluster) where the breakpoint was triggered. | ||
|
||
Press play and let the request contine complete transparently. | ||
|
||
This is just one example on how to use Bridge to Kubernetes on non-AKS clusters. Try it on your own project next! | ||
|
||
## Clean up | ||
|
||
To clean up the assets produced by this sample, simply run: | ||
|
||
``` | ||
kubectl delete namespace todo-app | ||
``` |
This file contains 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,176 @@ | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: stats-cache | ||
spec: | ||
selector: | ||
matchLabels: | ||
name: stats-cache | ||
template: | ||
metadata: | ||
labels: | ||
name: stats-cache | ||
spec: | ||
containers: | ||
- name: cache | ||
image: redis:5-alpine | ||
--- | ||
apiVersion: v1 | ||
kind: Service | ||
metadata: | ||
name: stats-cache | ||
spec: | ||
selector: | ||
name: stats-cache | ||
ports: | ||
- port: 6379 | ||
targetPort: 6379 | ||
--- | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: stats-queue | ||
spec: | ||
selector: | ||
matchLabels: | ||
name: stats-queue | ||
template: | ||
metadata: | ||
labels: | ||
name: stats-queue | ||
spec: | ||
containers: | ||
- name: queue | ||
image: rabbitmq:3-alpine | ||
--- | ||
apiVersion: v1 | ||
kind: Service | ||
metadata: | ||
name: stats-queue | ||
spec: | ||
selector: | ||
name: stats-queue | ||
ports: | ||
- port: 5672 | ||
targetPort: 5672 | ||
--- | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: stats-worker | ||
spec: | ||
selector: | ||
matchLabels: | ||
name: stats-worker | ||
template: | ||
metadata: | ||
labels: | ||
name: stats-worker | ||
spec: | ||
containers: | ||
- name: stats-worker | ||
image: azdspublic/todo-app-stats-worker | ||
env: | ||
- name: STATS_QUEUE_URI | ||
value: amqp://stats-queue | ||
- name: REDIS_HOST | ||
value: stats-cache | ||
- name: REDIS_PORT | ||
value: "6379" | ||
--- | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: stats-api | ||
spec: | ||
selector: | ||
matchLabels: | ||
name: stats-api | ||
template: | ||
metadata: | ||
labels: | ||
name: stats-api | ||
spec: | ||
containers: | ||
- name: stats-api | ||
image: azdspublic/todo-app-stats-api | ||
env: | ||
- name: REDIS_HOST | ||
value: stats-cache | ||
- name: REDIS_PORT | ||
value: "6379" | ||
--- | ||
apiVersion: v1 | ||
kind: Service | ||
metadata: | ||
name: stats-api | ||
spec: | ||
selector: | ||
name: stats-api | ||
ports: | ||
- port: 80 | ||
targetPort: 80 | ||
--- | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: todos-db | ||
spec: | ||
selector: | ||
matchLabels: | ||
name: todos-db | ||
template: | ||
metadata: | ||
labels: | ||
name: todos-db | ||
spec: | ||
containers: | ||
- name: todos-db | ||
image: mongo:4 | ||
--- | ||
apiVersion: v1 | ||
kind: Service | ||
metadata: | ||
name: todos-db | ||
spec: | ||
selector: | ||
name: todos-db | ||
ports: | ||
- port: 27017 | ||
targetPort: 27017 | ||
--- | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: frontend | ||
spec: | ||
selector: | ||
matchLabels: | ||
name: frontend | ||
template: | ||
metadata: | ||
labels: | ||
name: frontend | ||
spec: | ||
containers: | ||
- name: frontend | ||
image: azdspublic/todo-app-frontend | ||
env: | ||
- name: MONGO_CONNECTION_STRING | ||
value: mongodb://todos-db | ||
- name: STATS_QUEUE_URI | ||
value: amqp://stats-queue | ||
- name: STATS_API_HOST | ||
value: stats-api | ||
--- | ||
apiVersion: v1 | ||
kind: Service | ||
metadata: | ||
name: frontend | ||
spec: | ||
type: LoadBalancer | ||
selector: | ||
name: frontend | ||
ports: | ||
- port: 80 | ||
targetPort: 80 |
This file contains 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,7 @@ | ||
.dockerignore | ||
.gitignore | ||
.next | ||
.vscode | ||
Dockerfile | ||
node_modules | ||
README.md |
This file contains 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,2 @@ | ||
.next | ||
node_modules |
This file contains 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,11 @@ | ||
FROM node:lts-alpine | ||
ENV PORT 80 | ||
EXPOSE 80 | ||
|
||
WORKDIR /app | ||
COPY package*.json ./ | ||
RUN npm install | ||
COPY . . | ||
RUN npm run build | ||
|
||
CMD ["npm", "start"] |
Oops, something went wrong.
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.
It might be a good idea to have this doc show the isolated mode. That way we can talk about the nip.io URL and it doesn't come as a surprise to users who see it for the first time.
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.
or if we want, we can talk to both scenarios if that makes sense.