Skip to content

Latest commit

 

History

History
98 lines (62 loc) · 3.53 KB

add-service-and-config-github.md

File metadata and controls

98 lines (62 loc) · 3.53 KB

Adding a new service/chart and general Git flow

This guide assumes you want to host your code on GitHub and build using Team Services. You can also follow that guide to host your code and build it on Team Services (work in progress).

Install Helm starter chart

To make deploying the boilerplate template code easier, I've created a Git repository with a Helm starter chart corresponding to my preferred boiler plate.

Install the starter chart by following the instructions here: https://github.com/sabbour/aks-gitops-startercharts

This is done once per development environment.

Creating a new service

For each new service/application you want to build and configure to run on your Kubernetes cluster, you need to do the workflow below.

Assuming you want to create a new microservice called color-service

  • You will need to create a Git repository to host its code under code-repos\color-service\code.
  • For the Helm charts, you'll need to create that under code-repos\color-service\charts.

Finally, you'll setup some git branches to do some proper governance of code loosely based on what is documented here.

Create service repository to host code and chart

  1. Create a new Github repository for the service. Make sure to check the "Initialize with README" option to be able to clone this repo locally immediately

  2. Add the new repository as a submodule using the Git clone URL into the code-repos folder

    Add the submodule to the code-repos/color-service folder

    git submodule add https://github.com/sabbour/aks-gitops-color-service.git code-repos/color-service

  3. Add the code subfolder

    mkdir code-repos/color-service/code

  4. Add the charts subfolder

    mkdir code-repos/color-service/charts

Create the Helm chart

Using the Helm starter template you installed in the earlier step, create a new chart using the public-ingress-app starter, in the charts subfolder.

cd code-repos/color-service/charts

helm create color-service --starter=gitops-startercharts/public-ingress-app

You'll find a file under code-repos/color-service/charts/color-service/values.yaml with many placeholders starting with XX_. These will be replaced in the build process by the appropriate values.

Create the development branch and push it

git checkout -b development
git commit --allow-empty -m "Initial commit"
git push -u origin development

Work on a new feature

The flow below is loosely based on Simplified Git Flow.

Branch off the development branch to add a new feature.

git checkout development
git pull
git checkout -b feature/coolnewfeature
git push -u origin feature/coolnewfeature

Add some code and commits

git commit -a -m "The best feature ever"
git push origin feature/coolnewfeature

When the feature is ready for review, create a Pull Request to merge feature/coolnewfeature into development.

Once the Pull Request is reviewed and is ready for merging, merge and close the Pull Request.

Finally, delete the feature branch locally and remotely.

git branch -d feature/coolnewfeature                # locally
git push origin --delete feature/coolnewfeature     # remotely

Next: Follow the next part of the guide to setup the pull request pipeline.