Lessons learned from the charts repo

0 likes447 views

The document presents a comprehensive overview of Helm, an open-source tool for managing Kubernetes applications, outlining its structure, functionality, and the significance of the Kubernetes Charts repository. It discusses chart basics, templating, and various operations such as rollbacks and deployments, offering actionable insights and best practices. Additionally, it highlights future work for enhancing the management of Helm charts within the Kubernetes ecosystem.

Technology

Vic Iglesias
Cloud Solutions Architect
@vicnastea
Lessons Learned from
the Charts Repo

Confidential & ProprietaryGoogle Cloud Platform 2
Vic Iglesias
● Cloud Solutions Architect
● Santa Barbara, CA
● viglesias@google.com
● @vicnastea

Agenda Slide
01
02
03
04
05
Helm 101
The kubernetes/charts Repo
Chart Structure
Chart Tricks
What’s Next?

Confidential & ProprietaryGoogle Cloud Platform 5
Helm Basics
● Helm is an OSS tool that streamlines installing and
managing Kubernetes applications.
● Helm has two parts
○ Client (helm) on your laptop or CI/CD system
○ Server (tiller) in your Kubernetes cluster
● Helm is the equivalent of Apt or Yum in the OS
packaging world

Confidential & ProprietaryGoogle Cloud Platform 6
Chart Basics
● Charts are Helm packages that contain:
○ A description of the package (Chart.yaml)
○ One or more templates, which contain Kubernetes
manifest files
● Charts can be stored locally on disk or fetched from
remote repositories
● Charts are the equivalent of Debs or RPMs in the OS
packaging world

Confidential & ProprietaryGoogle Cloud Platform 7
What is a Kubernetes “Application”?
Pods Config Volumes SecretsServices

Confidential & ProprietaryGoogle Cloud Platform 8
What is a Kubernetes “Application”?
Pods Config Volumes SecretsServices

Confidential & ProprietaryGoogle Cloud Platform 9
What is a Kubernetes “Application”?
Pods Config Volumes Services

Confidential & ProprietaryGoogle Cloud Platform 10
What is a Kubernetes “Application”?
Pods Config Volumes Services

Confidential & ProprietaryGoogle Cloud Platform 11
What is a Kubernetes “Application”?
YAML YAML YAML YAML

Confidential & ProprietaryGoogle Cloud Platform 12
Create a Config API to your Application
Pods Config Volumes Services

Confidential & ProprietaryGoogle Cloud Platform 13
Create a Config API to your Application
Pods Config Volumes Services

Confidential & ProprietaryGoogle Cloud Platform 14
Create a Config API to your Application
Pods Config Volumes Services
Config

Confidential & ProprietaryGoogle Cloud Platform 15
Create a Config API to your Application
Pods Config Volumes Services
Config

Confidential & ProprietaryGoogle Cloud Platform 16
Rollback your Application as a Unit
VERSION 1

Confidential & ProprietaryGoogle Cloud Platform 17
Rollback your Application as a Unit
VERSION 1 VERSION 2

Confidential & ProprietaryGoogle Cloud Platform 18
Rollback your Application as a Unit
VERSION 1 VERSION 2

Confidential & ProprietaryGoogle Cloud Platform 19
Rollback your Application as a Unit
VERSION 2

Confidential & ProprietaryGoogle Cloud Platform 20
Rollback your Application as a Unit
VERSION 1 VERSION 2

Confidential & ProprietaryGoogle Cloud Platform 21
Rollback your Application as a Unit
VERSION 1

Confidential & ProprietaryGoogle Cloud Platform 22
Rollback your Application as a Unit
VERSION 1 VERSION 3

Confidential & ProprietaryGoogle Cloud Platform 23
Go Templating - values.yaml

Confidential & ProprietaryGoogle Cloud Platform 24
Go Templating - templates/deployment.yaml

Confidential & ProprietaryGoogle Cloud Platform 25
Go Templating - templates/service.yaml

Confidential & ProprietaryGoogle Cloud Platform 26
Sprig Functions - templates/service.yaml

Confidential & ProprietaryGoogle Cloud Platform 27
Sprig Functions
● String Functions: trim, wrap, randAlpha, plural, etc.
● Math Functions: add, max, mul, etc.
● Date Functions: now, date, etc.
● Defaults Functions: default, empty, coalesce
● Encoding Functions: b64enc, b64dec, etc.
● Lists and List Functions: list, first, uniq, etc.

Confidential & ProprietaryGoogle Cloud Platform 29
What?
● https://github.com/kubernetes/charts
● Centralized repository hosting community
curated Helm Charts
● Continuous integration
● Code review provided by maintainers
● Default repository configured in Helm

Confidential & ProprietaryGoogle Cloud Platform 30
Why?
"Standards" by Randall Munroe is licensed under CC BY-NC 2.5

Confidential & ProprietaryGoogle Cloud Platform 31
Stats
● 130+ Charts
● 2000+ PRs
● ~100 Contributors

Confidential & ProprietaryGoogle Cloud Platform 32
Commits over time

Confidential & ProprietaryGoogle Cloud Platform 33
Weekly visitors

Confidential & ProprietaryGoogle Cloud Platform 34
Number of Forks

Confidential & ProprietaryGoogle Cloud Platform 35
Number of Forks

Confidential & ProprietaryGoogle Cloud Platform 37
Chart Structure
● Chart.yaml
● values.yaml
● README.md
● requirements.yaml
● templates/
● templates/NOTES.txt

Confidential & ProprietaryGoogle Cloud Platform 38
Chart.yaml

Confidential & ProprietaryGoogle Cloud Platform 39
values.yaml

Confidential & ProprietaryGoogle Cloud Platform 40
values.yaml
Flexible
Reproducible
Start Here
Move this way

Confidential & ProprietaryGoogle Cloud Platform 41
requirements.yaml

Confidential & ProprietaryGoogle Cloud Platform 42
templates folder

Confidential & ProprietaryGoogle Cloud Platform 43
NOTES.txt

Confidential & ProprietaryGoogle Cloud Platform 44
README.md

Confidential & ProprietaryGoogle Cloud Platform 46
Use helm create

Confidential & ProprietaryGoogle Cloud Platform 47
Use helm create with starter templates

Confidential & ProprietaryGoogle Cloud Platform 48
Update deployments on config change

Confidential & ProprietaryGoogle Cloud Platform 49
Update deployments on config change

Confidential & ProprietaryGoogle Cloud Platform 50
Run out of band steps with hooks

Confidential & ProprietaryGoogle Cloud Platform 51
Helm Hook Types
Before or after:
● Install
● Delete
● Upgrade
● Rollback

Confidential & ProprietaryGoogle Cloud Platform 52
Allow reuse of existing PVC for data

Confidential & ProprietaryGoogle Cloud Platform 53
Allow optional ingress config

Confidential & ProprietaryGoogle Cloud Platform 54
Create a functional test (even if it is simple)

Confidential & ProprietaryGoogle Cloud Platform 55
Create a functional test (even if it is simple)

Confidential & ProprietaryGoogle Cloud Platform 56
Allow use custom ConfigMaps

Confidential & ProprietaryGoogle Cloud Platform 57
Namespace your helper templates

Confidential & ProprietaryGoogle Cloud Platform 58
Conditional Dependencies

Confidential & ProprietaryGoogle Cloud Platform 59
Conditional Dependencies

Confidential & ProprietaryGoogle Cloud Platform 60
Use toYaml to give users more flexibility

Confidential & ProprietaryGoogle Cloud Platform 62
Future work
● Allow OWNERS file to dictate who can merge
● Delegate responsibility of charts to other Git repositories
● Purge unmaintained charts
● More functional tests for charts

Thank You!
@vicnastea
viglesias@google.com

Lessons learned from the charts repo

1. Vic Iglesias Cloud Solutions Architect @vicnastea Lessons Learned from the Charts Repo

2. Confidential & ProprietaryGoogle Cloud Platform 2 Vic Iglesias ● Cloud Solutions Architect ● Santa Barbara, CA ● viglesias@google.com ● @vicnastea

3. Agenda Slide 01 02 03 04 05 Helm 101 The kubernetes/charts Repo Chart Structure Chart Tricks What’s Next?

4. 01 Helm 101

5. Confidential & ProprietaryGoogle Cloud Platform 5 Helm Basics ● Helm is an OSS tool that streamlines installing and managing Kubernetes applications. ● Helm has two parts ○ Client (helm) on your laptop or CI/CD system ○ Server (tiller) in your Kubernetes cluster ● Helm is the equivalent of Apt or Yum in the OS packaging world

6. Confidential & ProprietaryGoogle Cloud Platform 6 Chart Basics ● Charts are Helm packages that contain: ○ A description of the package (Chart.yaml) ○ One or more templates, which contain Kubernetes manifest files ● Charts can be stored locally on disk or fetched from remote repositories ● Charts are the equivalent of Debs or RPMs in the OS packaging world

7. Confidential & ProprietaryGoogle Cloud Platform 7 What is a Kubernetes “Application”? Pods Config Volumes SecretsServices

8. Confidential & ProprietaryGoogle Cloud Platform 8 What is a Kubernetes “Application”? Pods Config Volumes SecretsServices

9. Confidential & ProprietaryGoogle Cloud Platform 9 What is a Kubernetes “Application”? Pods Config Volumes Services

10. Confidential & ProprietaryGoogle Cloud Platform 10 What is a Kubernetes “Application”? Pods Config Volumes Services

11. Confidential & ProprietaryGoogle Cloud Platform 11 What is a Kubernetes “Application”? YAML YAML YAML YAML

12. Confidential & ProprietaryGoogle Cloud Platform 12 Create a Config API to your Application Pods Config Volumes Services

13. Confidential & ProprietaryGoogle Cloud Platform 13 Create a Config API to your Application Pods Config Volumes Services

14. Confidential & ProprietaryGoogle Cloud Platform 14 Create a Config API to your Application Pods Config Volumes Services Config

15. Confidential & ProprietaryGoogle Cloud Platform 15 Create a Config API to your Application Pods Config Volumes Services Config

16. Confidential & ProprietaryGoogle Cloud Platform 16 Rollback your Application as a Unit VERSION 1

17. Confidential & ProprietaryGoogle Cloud Platform 17 Rollback your Application as a Unit VERSION 1 VERSION 2

18. Confidential & ProprietaryGoogle Cloud Platform 18 Rollback your Application as a Unit VERSION 1 VERSION 2

19. Confidential & ProprietaryGoogle Cloud Platform 19 Rollback your Application as a Unit VERSION 2

20. Confidential & ProprietaryGoogle Cloud Platform 20 Rollback your Application as a Unit VERSION 1 VERSION 2

21. Confidential & ProprietaryGoogle Cloud Platform 21 Rollback your Application as a Unit VERSION 1

22. Confidential & ProprietaryGoogle Cloud Platform 22 Rollback your Application as a Unit VERSION 1 VERSION 3

23. Confidential & ProprietaryGoogle Cloud Platform 23 Go Templating - values.yaml

24. Confidential & ProprietaryGoogle Cloud Platform 24 Go Templating - templates/deployment.yaml

25. Confidential & ProprietaryGoogle Cloud Platform 25 Go Templating - templates/service.yaml

26. Confidential & ProprietaryGoogle Cloud Platform 26 Sprig Functions - templates/service.yaml

27. Confidential & ProprietaryGoogle Cloud Platform 27 Sprig Functions ● String Functions: trim, wrap, randAlpha, plural, etc. ● Math Functions: add, max, mul, etc. ● Date Functions: now, date, etc. ● Defaults Functions: default, empty, coalesce ● Encoding Functions: b64enc, b64dec, etc. ● Lists and List Functions: list, first, uniq, etc.

28. 02 The kubernetes/charts repo

29. Confidential & ProprietaryGoogle Cloud Platform 29 What? ● https://github.com/kubernetes/charts ● Centralized repository hosting community curated Helm Charts ● Continuous integration ● Code review provided by maintainers ● Default repository configured in Helm

30. Confidential & ProprietaryGoogle Cloud Platform 30 Why? "Standards" by Randall Munroe is licensed under CC BY-NC 2.5

31. Confidential & ProprietaryGoogle Cloud Platform 31 Stats ● 130+ Charts ● 2000+ PRs ● ~100 Contributors

32. Confidential & ProprietaryGoogle Cloud Platform 32 Commits over time

33. Confidential & ProprietaryGoogle Cloud Platform 33 Weekly visitors

34. Confidential & ProprietaryGoogle Cloud Platform 34 Number of Forks

35. Confidential & ProprietaryGoogle Cloud Platform 35 Number of Forks

36. 03 Chart Structure

37. Confidential & ProprietaryGoogle Cloud Platform 37 Chart Structure ● Chart.yaml ● values.yaml ● README.md ● requirements.yaml ● templates/ ● templates/NOTES.txt

38. Confidential & ProprietaryGoogle Cloud Platform 38 Chart.yaml

39. Confidential & ProprietaryGoogle Cloud Platform 39 values.yaml

40. Confidential & ProprietaryGoogle Cloud Platform 40 values.yaml Flexible Reproducible Start Here Move this way

41. Confidential & ProprietaryGoogle Cloud Platform 41 requirements.yaml

42. Confidential & ProprietaryGoogle Cloud Platform 42 templates folder

43. Confidential & ProprietaryGoogle Cloud Platform 43 NOTES.txt

44. Confidential & ProprietaryGoogle Cloud Platform 44 README.md

45. 04 Chart Tricks

46. Confidential & ProprietaryGoogle Cloud Platform 46 Use helm create

47. Confidential & ProprietaryGoogle Cloud Platform 47 Use helm create with starter templates

48. Confidential & ProprietaryGoogle Cloud Platform 48 Update deployments on config change

49. Confidential & ProprietaryGoogle Cloud Platform 49 Update deployments on config change

50. Confidential & ProprietaryGoogle Cloud Platform 50 Run out of band steps with hooks

51. Confidential & ProprietaryGoogle Cloud Platform 51 Helm Hook Types Before or after: ● Install ● Delete ● Upgrade ● Rollback

52. Confidential & ProprietaryGoogle Cloud Platform 52 Allow reuse of existing PVC for data

53. Confidential & ProprietaryGoogle Cloud Platform 53 Allow optional ingress config

54. Confidential & ProprietaryGoogle Cloud Platform 54 Create a functional test (even if it is simple)

55. Confidential & ProprietaryGoogle Cloud Platform 55 Create a functional test (even if it is simple)

56. Confidential & ProprietaryGoogle Cloud Platform 56 Allow use custom ConfigMaps

57. Confidential & ProprietaryGoogle Cloud Platform 57 Namespace your helper templates

58. Confidential & ProprietaryGoogle Cloud Platform 58 Conditional Dependencies

59. Confidential & ProprietaryGoogle Cloud Platform 59 Conditional Dependencies

60. Confidential & ProprietaryGoogle Cloud Platform 60 Use toYaml to give users more flexibility

61. 05 What’s Next?

62. Confidential & ProprietaryGoogle Cloud Platform 62 Future work ● Allow OWNERS file to dictate who can merge ● Delegate responsibility of charts to other Git repositories ● Purge unmaintained charts ● More functional tests for charts

63. Thank You! @vicnastea viglesias@google.com

Lessons learned from the charts repo

More Related Content

What's hot (20)

Similar to Lessons learned from the charts repo (20)

Recently uploaded (20)

Lessons learned from the charts repo