├── .helmignore ├── Chart.yaml ├── LICENSE ├── README.md ├── charts └── .keep ├── templates ├── NOTES.txt ├── _helpers.tpl ├── configmap.yaml ├── deployment.yaml ├── rbac.yaml └── service.yaml └── values.yaml /.helmignore: -------------------------------------------------------------------------------- 1 | # Patterns to ignore when building packages. 2 | # This supports shell glob matching, relative path matching, and 3 | # negation (prefixed with !). Only one pattern per line. 4 | .DS_Store 5 | # Common VCS dirs 6 | .git/ 7 | .gitignore 8 | .bzr/ 9 | .bzrignore 10 | .hg/ 11 | .hgignore 12 | .svn/ 13 | # Common backup files 14 | *.swp 15 | *.bak 16 | *.tmp 17 | *~ 18 | # Various IDEs 19 | .project 20 | .idea/ 21 | *.tmproj 22 | .vscode/ 23 | 24 | README.md 25 | LICENSE 26 | -------------------------------------------------------------------------------- /Chart.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | appVersion: "1.0.0" 3 | description: A Helm chart starter for deploying a Spring Boot app to Kubernetes 4 | name: spring-boot 5 | version: 0.1.0 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring Boot Helm starter 2 | 3 | This project provides a simple way to generate Kubernetes descriptors 4 | using Helm, in order to deploy a Spring Boot app. 5 | Using a single command, you create YAML files for your app: you just need 6 | to customize these descriptors to set your container image, and you're done. 7 | 8 | 9 | 10 | The generated descriptors support these features: 11 | - app deployment with healthchecks & replication 12 | - [Spring Cloud Kubernetes](https://spring.io/projects/spring-cloud-kubernetes) support 13 | (`ConfigMap`, `Secret`, service discovery, client-side load balancing) 14 | - default `ConfigMap` configuration 15 | - Prometheus support 16 | 17 | **Using this Helm starter you don't need to write YAML files anymore!** 18 | 19 | ## How to use it? 20 | 21 | Install this repository in your local Helm starter repository: 22 | ```bash 23 | $ git clone https://github.com/alexandreroman/spring-boot-helm-starter.git $HOME/.helm/starters/spring-boot 24 | ``` 25 | 26 | Create an Helm chart for your app: 27 | ```bash 28 | $ helm create --starter=spring-boot myapp 29 | Creating myapp 30 | ``` 31 | 32 | Edit generated file `myapp/values.yml` and set your Docker image: 33 | ```yaml 34 | image: 35 | repository: myrepo/myapp 36 | ``` 37 | 38 | As you can see, you can also set some properties in this file, 39 | such as `ConfigMap` entries. 40 | 41 | You are now ready to deploy your app using Helm: 42 | ```bash 43 | $ helm install --namespace myns myapp 44 | ``` 45 | 46 | ## Contribute 47 | 48 | Contributions are always welcome! 49 | 50 | Feel free to open issues & send PR. 51 | 52 | ## License 53 | 54 | Copyright © 2019 [Pivotal Software, Inc](https://pivotal.io). 55 | 56 | This project is licensed under the [Apache Software License version 2.0](https://www.apache.org/licenses/LICENSE-2.0). 57 | -------------------------------------------------------------------------------- /charts/.keep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alexandreroman/spring-boot-helm-starter/716b80686dba4d6ec57edee32a241297d3b1c756/charts/.keep -------------------------------------------------------------------------------- /templates/NOTES.txt: -------------------------------------------------------------------------------- 1 | Thank you for installing {{ .Chart.Name }}. 2 | Your release is named {{ .Release.Name }}. 3 | 4 | Go to https://github.com/alexandreroman/k8s-with-no-dockerfile-no-yaml-files 5 | to find a sample app using Spring Cloud Kubernetes. 6 | 7 | To learn more about the release, try: 8 | 9 | $ helm status {{ .Release.Name }} 10 | $ helm get {{ .Release.Name }} 11 | 12 | Edit app configuration using this command: 13 | 14 | $ kubectl -n {{ .Release.Namespace }} edit configmap {{ include "spring-boot.fullname" . }} 15 | 16 | To scale out this app (add/remove instances), try: 17 | 18 | $ kubectl -n {{ .Release.Namespace }} scale --replicas 3 deployment {{ include "spring-boot.fullname" . }} 19 | 20 | {{- if eq .Values.service.type "LoadBalancer" }} 21 | 22 | Find public app endpoint here (see EXTERNAL-IP): 23 | 24 | $ kubectl -n {{ .Release.Namespace }} get service {{ include "spring-boot.fullname" . }} 25 | 26 | {{- end }} 27 | 28 | Remove this release from your cluster using this command: 29 | 30 | $ helm delete {{ .Release.Name }} 31 | -------------------------------------------------------------------------------- /templates/_helpers.tpl: -------------------------------------------------------------------------------- 1 | {{/* vim: set filetype=mustache: */}} 2 | {{/* 3 | Expand the name of the chart. 4 | */}} 5 | {{- define "spring-boot.name" -}} 6 | {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} 7 | {{- end -}} 8 | 9 | {{/* 10 | Create a default fully qualified app name. 11 | We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). 12 | If release name contains chart name it will be used as a full name. 13 | */}} 14 | {{- define "spring-boot.fullname" -}} 15 | {{- if .Values.fullnameOverride -}} 16 | {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} 17 | {{- else -}} 18 | {{- $name := default .Chart.Name .Values.nameOverride -}} 19 | {{- if contains $name .Release.Name -}} 20 | {{- .Release.Name | trunc 63 | trimSuffix "-" -}} 21 | {{- else -}} 22 | {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} 23 | {{- end -}} 24 | {{- end -}} 25 | {{- end -}} 26 | 27 | {{/* 28 | Create chart name and version as used by the chart label. 29 | */}} 30 | {{- define "spring-boot.chart" -}} 31 | {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} 32 | {{- end -}} 33 | 34 | {{/* 35 | Create Docker secrets for pulling images from a private container registry. 36 | */}} 37 | {{- define "imagePullSecret" }} 38 | {{- printf "{\"auths\": {\"%s\": {\"auth\": \"%s\"}}}" .Values.imageCredentials.registry (printf "%s:%s" .Values.imageCredentials.username .Values.imageCredentials.password | b64enc) | b64enc }} 39 | {{- end }} 40 | -------------------------------------------------------------------------------- /templates/configmap.yaml: -------------------------------------------------------------------------------- 1 | kind: ConfigMap 2 | apiVersion: v1 3 | metadata: 4 | name: {{ include "spring-boot.fullname" . }} 5 | data: 6 | application.yml: |- 7 | spring: 8 | application: 9 | name: {{ include "spring-boot.fullname" . }} 10 | {{- toYaml .Values.config | nindent 4 }} 11 | -------------------------------------------------------------------------------- /templates/deployment.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: apps/v1 2 | kind: Deployment 3 | metadata: 4 | name: {{ include "spring-boot.fullname" . }} 5 | labels: 6 | app.kubernetes.io/name: {{ include "spring-boot.name" . }} 7 | helm.sh/chart: {{ include "spring-boot.chart" . }} 8 | app.kubernetes.io/instance: {{ .Release.Name }} 9 | app.kubernetes.io/managed-by: {{ .Release.Service }} 10 | spec: 11 | replicas: {{ .Values.replicaCount }} 12 | selector: 13 | matchLabels: 14 | app.kubernetes.io/name: {{ include "spring-boot.name" . }} 15 | app.kubernetes.io/instance: {{ .Release.Name }} 16 | template: 17 | metadata: 18 | labels: 19 | app.kubernetes.io/name: {{ include "spring-boot.name" . }} 20 | app.kubernetes.io/instance: {{ .Release.Name }} 21 | {{- if .Values.monitoring }} 22 | annotations: 23 | prometheus.io/scrape: "true" 24 | prometheus.io/path: "/actuator/prometheus" 25 | prometheus.io/port: "8080" 26 | {{- end }} 27 | spec: 28 | {{- if .Values.imageCredentials.registry }} 29 | imagePullSecrets: 30 | - name: {{ include "spring-boot.fullname" . }}-registry 31 | {{- end }} 32 | containers: 33 | - name: {{ .Chart.Name }} 34 | image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" 35 | imagePullPolicy: {{ .Values.image.pullPolicy }} 36 | {{- if .Values.sck }} 37 | env: 38 | - name: SPRING_CLOUD_KUBERNETES_CONFIG_NAME 39 | value: "{{ include "spring-boot.fullname" . }}" 40 | - name: MANAGEMENT_ENDPOINT_RESTART_ENABLED 41 | value: "true" 42 | - name: SPRING_CLOUD_KUBERNETES_RELOAD_ENABLED 43 | value: "true" 44 | - name: SPRING_CLOUD_KUBERNETES_RELOAD_STRATEGY 45 | value: "refresh" 46 | {{- end }} 47 | ports: 48 | - name: http 49 | containerPort: 8080 50 | protocol: TCP 51 | livenessProbe: 52 | httpGet: 53 | path: /actuator/health 54 | port: http 55 | initialDelaySeconds: 60 56 | readinessProbe: 57 | httpGet: 58 | path: /actuator/health 59 | port: http 60 | initialDelaySeconds: 20 61 | {{- if .Values.imageCredentials.registry }} 62 | --- 63 | apiVersion: v1 64 | kind: Secret 65 | metadata: 66 | name: {{ include "spring-boot.fullname" . }}-registry 67 | type: kubernetes.io/dockerconfigjson 68 | data: 69 | .dockerconfigjson: {{ template "imagePullSecret" . }} 70 | {{- end }} 71 | -------------------------------------------------------------------------------- /templates/rbac.yaml: -------------------------------------------------------------------------------- 1 | kind: ClusterRole 2 | apiVersion: rbac.authorization.k8s.io/v1 3 | metadata: 4 | name: {{ include "spring-boot.fullname" . }}-role 5 | rules: 6 | - apiGroups: [""] 7 | resources: ["services", "pods", "configmaps", "endpoints", "secrets"] 8 | verbs: ["get", "watch", "list"] 9 | --- 10 | kind: RoleBinding 11 | apiVersion: rbac.authorization.k8s.io/v1 12 | metadata: 13 | name: default:{{ include "spring-boot.fullname" . }}-role 14 | subjects: 15 | - kind: ServiceAccount 16 | name: default 17 | roleRef: 18 | kind: ClusterRole 19 | name: {{ include "spring-boot.fullname" . }}-role 20 | apiGroup: rbac.authorization.k8s.io 21 | -------------------------------------------------------------------------------- /templates/service.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: v1 2 | kind: Service 3 | metadata: 4 | name: {{ include "spring-boot.fullname" . }} 5 | labels: 6 | app.kubernetes.io/name: {{ include "spring-boot.name" . }} 7 | helm.sh/chart: {{ include "spring-boot.chart" . }} 8 | app.kubernetes.io/instance: {{ .Release.Name }} 9 | app.kubernetes.io/managed-by: {{ .Release.Service }} 10 | spec: 11 | type: {{ .Values.service.type }} 12 | ports: 13 | - port: {{ .Values.service.port }} 14 | targetPort: http 15 | protocol: TCP 16 | name: http 17 | selector: 18 | app.kubernetes.io/name: {{ include "spring-boot.name" . }} 19 | app.kubernetes.io/instance: {{ .Release.Name }} 20 | -------------------------------------------------------------------------------- /values.yaml: -------------------------------------------------------------------------------- 1 | # Set how many application instances to run. 2 | replicaCount: 1 3 | 4 | # Override these settings and use your container image. 5 | image: 6 | repository: alexandreroman/hello 7 | tag: latest 8 | pullPolicy: IfNotPresent 9 | 10 | # Set image pull secrets (in case you're using a private container registry). 11 | imageCredentials: 12 | registry: # gcr.io 13 | username: # oauth2accesstoken 14 | password: # $(gcloud auth print-access-token) 15 | 16 | # Set service type: LoadBalancer, ClusterIP, NodePort 17 | service: 18 | type: LoadBalancer 19 | port: 80 20 | 21 | # Set to false to disable Prometheus support. 22 | monitoring: true 23 | 24 | # Set to false to disable Spring Cloud Kubernetes support. 25 | sck: true 26 | 27 | # Set configuration properties. 28 | config: 29 | foo: bar 30 | --------------------------------------------------------------------------------