My GSOC journey with xwiki

Version 1.3 by Ashish Sharma on 2019/08/26

Mentors:

I want to thank my mentors Shubham Jain, Neha Gupta and Xwiki organisation for giving me such an opportunity and helping me out throughout my journey of GSOC. I also want to also thank Vincent Massol for helping me out in one of my dependent project.

A little bit about me

My name is Ashish Sharma, I am 23 and I am a final year student from Bharati Vidyapeeth's College of Engineering, India. I have participated in GSoC'19 program as a student in XWiki and worked on "Helm chart for Xwiki".

What did I expect from GSoC 2019

This was my first Google Summer of Code and the concept to contribute for 3 months in an open-source organisation was exciting for me. I got an opportunity to work remotely on a project. I was curious to explore how an open-source organisation work. Anyway, I have expected new experience in remote internship, open source project contributing, Google Summer of Code participating and international only remote communication.

In this post I want to describe what I have finished and what is not completed yet and why.

Description

This project focoused on creating a helm chart that would deploy xwiki on Kubernetes by using helm templating. The deployment should be configurable to be scalacble, highly available and roboust.

You can find the project code at

https://github.com/xwiki-contrib/xwiki-helm and

The issue tracker can be found

https://jira.xwiki.org/projects/HELM/issues

How to use the result of my work

git clone https://github.com/xwiki-contrib/xwiki-helm
cd xwiki-helm-chart
helm dependency update
helm debug upgrade -i force xwiki -f ./values.yaml .

Read about prerequite

Milestones

Milestones 1:

Creating a basic helm chart

  • Understanding xwiki-docker structure.
  • Understanding and taking the decision for using the correct resource to host xwiki.
  • So I started up using the StatefulSet, clusterIP service and ingress.
  • Added values files which help in making the chart dynamically configurable.
  • Then we had a neded to support multiple databases and was in a need of a solution that don't require to deploy database externally, so a good standard for adding dependency to other services like database were needed.
  • So we deccided to add database as a helm dependency, that helped us to deploy database automatically with our application and the database was also configured with the xwiki chart configuration, that made maintaining the database easy, and we don't need to deploy it seprately.
  • So we added support for database mysql and postgress through dependency and also given option for user to deploy it's own external database.

Milestestone 2:

Adding support for ISTIO and other features

Milestone 3:

Adding support for clustering,HA and Unit testing

  • Migrated from Statefulset to Deployment
  • Added Clustering feature to docker project
  • Added Clustering feature to helm project
  • Can add JGroup config file through configMaps
  • Unit Testing
  • Added Liveliness and Readiness Probes
Tags:
    

Get Connected