Yann Rouillard presented principles for a developer-friendly CI/CD pipeline for Kubernetes applications. The principles include having a simple interface like a deployment file template, validating configuration early to fail fast, making the pipeline self-service through automation and templates, providing clear error messages with context, and ensuring the pipeline is troubleshoot-able by developers. Examples were given of implementing these principles using tools like Python scripts, Helm, schemas, and error tracking software. The talk concluded with a Q&A section and thanks to the audience.

1. PAGE1
DEVOPS INDONESIA
PAGE
1
DEVOPS INDONESIA
Yann Rouillard
DevOps Community in Indonesia
Jakarta, 8 Juli 2020
Developer-Friendly
CI / CD For Kubernetes

2. For KubernetesDev-Friendly CI / CD

3. OnlinePajak
Founded in
2014
Located in
3 countries
Develop tax-
related
products
OnlinePajak @lifeatonlinepajak

4. PRINCIPLES of a Dev-Friendly CI/ CD
SIMPLE INTERFACE
FAIL FAST
SELF-SERVICE
ERROR MESSAGE
TROUBLESHOOT-ABLE
DOCUMENTED

5. SIMPLE
INTERFACE

6. IS KUBERNETES INTERFACE SIMPLE ENOUGH?

7. S c a r y YAML files
A unique simple file
For Only
SOLUTION: CREATE A SIMPLE DEPLOYMENT FILE
met adat a:
busi nessI mpact Level : medi um
ser vi ces:
webser ver :
wor kl oadType: web
endpoi nt :
i nt er nal Por t : 8080
publ i cHost name: mywebapp
access: publ i c- aut h
depl oyment :
r epl i caCount : 4
Tailored to your uses cases

8. A PRACTICAL IMPLEMENTATION
Python + Shell
scripts
HELM Package
Manager
Helm Chart
(Template)
Deployment file
Kubernetes
K8S YAML filesHelm Value File

9. ❝ Yann's presentation is insanely awesome !!!!!!!!!! ❞
WE ARE JUST BUILDING A PAAS!
❝ Kubernetes is a platform for building platforms ❞
❝ Kubernetes is an infrastructure framework [...] but far from the
developer productivity you find in a PaaS or FaaS platform ❞
Kelsey
Hightower
Famous Kubernetes
Expert @Google

10. FAIL
FAST

11. MOST HORRIBLE CI/CD EXPERIENCE EVER!
FAIL
New service
my_service
Linting Tests Build DeployLinting Tests Build Deploy

12. SOLUTION: VALIDATE YOUR INPUT EARLY!
Tests Build DeployLinting
Deployment file validation
● check validity of values
● check existence of Docker image
● check for clash of names
● ...

13. A PRACTICAL IMPLEMENTATION
Python script
Cerberus Schema File
Python
Library

14. VALIDATE FILES IN DEVELOPER'S IDE ITSELF!
Define your validation rules as a JSON schema
Document how to configure it for your dev's favorite IDE
Supported by
○ Jetbrain IDEs out of the box
○ Visual Code with plugin
○ pretty much all other IDE with plugin

15. Exampl e wi t h Vi sual Code
VALIDATE FILES IN DEVELOPER'S IDE ITSELF!

16. SELF
SERVICE

17. MAKE PIPELINE CONFIGURATION EASY
Use Templating feature of your CI/CD
Exampl e 1 wi t h Gi t l ab CI
Exampl e 2 wi t h Gi t l ab CI

18. AUTOMATE SERVICES PROVISIONING
Everything needed to deploy an application
must be automated
DNS

19. THE RETURN OF THE DEPLOYMENT FILE
Describe all your required services in it!
ser vi ces:
webser ver :
wor kl oadType: web
endpoi nt :
i nt er nal Por t : 8080
publ i cHost name: mywebapp
access: publ i c- aut h
ser vi ces:
webser ver :
wor kl oadType: web
endpoi nt :
i nt er nal Por t : 8080
publ i cHost name: mywebapp
access: publ i c- aut h
managedSer vi ces:
mysql :
my- mysql - dat abase:
ver si on: 8. 0
mongodb:
my- mongo- dat abase:
Ver si on: 4. 2

20. A PRACTICAL IMPLEMENTATION
ser vi ces:
webser ver :
wor kl oadType: web
endpoi nt :
i nt er nal Por t : 8080
publ i cHost name: mywebapp
access: publ i c- aut h
managedSer vi ces:
mysql :
my- mysql - dat abase:
ver si on: 8. 0
mongodb:
my- mongo- dat abase:
Ver si on: 4. 2
Services Subscriptions
Manager
Create secrets
Provision DB
Provision DB

21. ALTERNATIVE SOLUTIONS
Kubernetes
Operators
Kubernetes extensions for supporting
application components through
K8S Custom Resources
Allow to provision and manage
cloud infrastructure services using
K8S Custom Resources
See https://operatorhub.io/

22. ERROR
MESSAGES

23. SOME COULD-BE-BETTER ERROR MESSAGES
Let's dump the full stacktrace in
case we find something useful

24. DISPLAY CLEAR LINTING ERROR MESSAGES
Anatomy of a clear error message
Exact error localisation
Clear explanation about the cause
Optional hint about how to fix the error

25. SHOW CONTEXTUAL INFORMATION OR LINKS
Developers are a bunch of lazy guys!
So are we !
Don't ask them to find info
you could directly show to them!!!
So

26. EXAMPLE FOR A K8S DEPLOYMENT FAILURE
In case of failure, you can show
Last N lines of application logs
Kubernetes deployment logs

27. TROUBLESHOOT
-ABLE

28. SELF-TROUBLESHOOT-ABLE?
2thingsIknow
Pipeline will (sometimes) because of your mistakesFAIL YOUR
Developers are POWER USERS
YOUR CODEthat can understand
Empower your developers
To troubleshoot your mistakes!So

29. PRACTICAL SELF-TROUBLESHOOT-ABLENESS
Make your DevOps source code readable to developers
Always save and expose tracing/debug information
Allow developers to execute shell in their containers
Make your intermediate Kubernetes YAML files available

30. HOW TO EXPORT TRACING/DEBUG INFO?
Export tracing information in a file Exit handler installation
Example of error message for unexpected failure
With

31. HOW TO EXPORT TRACING/DEBUG INFO?
With
And other
languages
Use an error tracking
software like
Example of error message
Example of Sentry issue

32. PRINCIPLES of a Dev-Friendly CI/ CD
SIMPLE INTERFACE
FAIL FAST
SELF-SERVICE
ERROR MESSAGE
TROUBLESHOOT-ABLE
DOCUMENTED

33. Questions ?
and maybe answers...

34. Terima Kasih
www.online-pajak.com

35. PAGE35
DEVOPS INDONESIA
Stay Connected
@devopsindonesia
http://www.devopsindonesia.com
@IDDevOps
@DevOpsIndonesia
@IDDevOps DevOps Indonesia

36. PAGE36
DEVOPS INDONESIA
Alone We are smart, together We are brilliant
THANK YOU !
Quote by Steve Anderson