This is a demo project for nocalhost. Bookinfo is from Istio samples(https://github.com/istio/istio/tree/master/samples/bookinfo).
Bookinfo is a typical microservice architecture application, which consists of 4 services:
- productpage(Request Entrance): https://github.com/nocalhost/bookinfo-productpage
- reviews: https://github.com/nocalhost/bookinfo-reviews
- details: https://github.com/nocalhost/bookinfo-details
- ratings: https://github.com/nocalhost/bookinfo-ratings
Every service has its different program language and runtime environment. All of them had been configured to use docker as container runtime, you can find Dockerfile in their corresponding repository.
A helm chart in this repository is prepared for one command installing. 4 Deployments witch 2 replica pods for 4 microservices are main skeleton of this chart.
You can install the chart by this command: helm install ./charts/bookinfo, but if you want to try nocalhost, we recommend you do this with nocalhost. We will give step-by-step QuickStart later.
We commit some changes to demonstrate nocalhost better. Here are some main changes:
- Simplified different version of reviews service to one version. Nocalhost does not target on how to manage service traffic or canary deployment.
- Splitted source codes from mono-repo to four independent repositories. In reality, diffrent microservices are developed by diffrent teams with different access rules.
- Changed the framework of reviews service to spring-boot. Nothing but everyone loves spring-boot.
- Configured GitHub Action for every microservice to auto build Docker images.
- Added a .nocalhost directory to support development with nocalhost.
.nocalhost is a directory in the root of repository which stores the configurations of nocalhost. In this case, the file config.yaml :
# preInstalls indict the jobs must be done before application installation.
preInstalls:
- path: manifest/pre-install/print-num-job-01.yaml
- path: manifest/pre-install/print-num-job-02.yaml
# job priority, the smaller the earlier.
weight: "10"
- path: manifest/pre-install/print-num-job-03.yaml
weight: "-5"
# appConfig indicts application infomation
appConfig:
name: bookinfo
# helm or manifests(helm for Helm chart or manifests for raw kubernetes manifests)
type: helm
# path in this repository
resourcePath: charts/bookinfo
# Configurations of microservices in application
svcConfigs:
# the microservice name(same as the name of Kubernete Object)
- name: productpage
# the resouces type in Kubernetes(deployment is the only surppoted type by now)
type: deployment
# the git clone url of this microservice(used by IDE plugin)
gitUrl: https://github.com/nocalhost/bookinfo-productpage
devEnv: python # java|go|node|php
# The container image for development of this microservice(Commonly, the image contains all of the sdks and debug tools of this microservice)
devImage: codingcorp-docker.pkg.coding.net/nocalhost/public/share-container-ruby:v2
# Specify which directories to sync from IDE workspace to remote container
sync:
# current dir sync to /home in the develop container.
- .:/home
# - ./build:/home
# Specify which directories to ignore sync
ignore:
- tests
- .github
# Specify which ports to forward to local(localPort:remotePort)
devPort:
- 12345:22
- 5005:5005
# Specify which command to execute when enabled hotreload mode
command: ["kill `ps -ef|grep -i gradlew| grep -v grep| awk '{print $2}'`", "gradlew", "bootrun"]
# Specify which jobs to wait before this microservice starts
jobs:
- "dep-job"
# Specify which pods to wait for ready before this microservice starts
pods:
- "productpage"