diff --git a/README.md b/README.md index 630c5bf..775dbca 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,10 @@ Java Logs (students-api-logger.log) are created under project root/logs director v2.0: The repository now supports spring boot application and MongoDB deployment to Kubernetes local cluster. -MongoDB credentials are stored in secret file. +MongoDB credentials are stored in a secret file. + +v2.1: +The repository now supports application builds using helm charts. Instructions ----------------- @@ -35,8 +38,8 @@ Instructions 4. Build the project with Maven: ``` -cd students-api/ -mvn clean install +> cd students-api/ +> mvn clean install ``` 5. Run the spring boot application 'StudentsApplication' 6. Test the application using postman [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.postman.co/run-collection/04fec31e35710e9bdb41#?env%5Bstudents-api-local-env%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoibG9jYWxob3N0OjgxODAiLCJlbmFibGVkIjp0cnVlfV0=) @@ -50,8 +53,8 @@ mvn clean install 3. Build the project with Maven: ``` -cd students-api/ -mvn clean install +> cd students-api/ +> mvn clean install ``` The build will output a docker image. @@ -88,6 +91,41 @@ The build will output a docker image. 7.2 Run postman collection [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/04fec31e35710e9bdb41#?env%5Bstudents-api-local-env%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoibG9jYWxob3N0OjgxODAiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCJ9XQ==) +### v2.1 Build Instructions: +1. Clone this repository: + +`git clone https://github.com/sainik73/students-api` + +2. Checkout branch v2.1 +3. Build the project with Maven: + +``` +> cd students-api/ +> mvn clean install +``` +The build will output a docker image. +4. Install helm repo +``` +> helm repo add bitnami https://charts.bitnami.com/bitnami +``` +5. Update helm chart dependencies and Install helm chart [Its located under /src/main/resources] + +``` +> cd students-api/src/main/resources/helm +> helm dependency update students-api +> helm install students-api students-api +``` +6. Start service on windows host [It will expose port on host to access service] +``` +> minikube service students-api +``` +7. Test application + +7.1 Modify the postman environment for exposed port + +7.2 Run postman collection [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/04fec31e35710e9bdb41#?env%5Bstudents-api-local-env%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoibG9jYWxob3N0OjgxODAiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoidGV4dCJ9XQ==) + + Known Issues ----------------- Version v2.0: diff --git a/src/main/resources/helm/students-api/.helmignore b/src/main/resources/helm/students-api/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/src/main/resources/helm/students-api/.helmignore @@ -0,0 +1,23 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/src/main/resources/helm/students-api/Chart.yaml b/src/main/resources/helm/students-api/Chart.yaml new file mode 100644 index 0000000..871e685 --- /dev/null +++ b/src/main/resources/helm/students-api/Chart.yaml @@ -0,0 +1,32 @@ +apiVersion: v2 +name: students-api +description: students-api Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 1.0.0 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "1.0.0" +dependencies: + - name: mongodb + version: 10.7.0 + repository: "https://charts.bitnami.com/bitnami" + condition: mongodb.enabled + tags: + - database + - mongodb diff --git a/src/main/resources/helm/students-api/templates/NOTES.txt b/src/main/resources/helm/students-api/templates/NOTES.txt new file mode 100644 index 0000000..bb3da0e --- /dev/null +++ b/src/main/resources/helm/students-api/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "students-api.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "students-api.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "students-api.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "students-api.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/src/main/resources/helm/students-api/templates/_helpers.tpl b/src/main/resources/helm/students-api/templates/_helpers.tpl new file mode 100644 index 0000000..ff3ecc2 --- /dev/null +++ b/src/main/resources/helm/students-api/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "students-api.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "students-api.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "students-api.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "students-api.labels" -}} +helm.sh/chart: {{ include "students-api.chart" . }} +{{ include "students-api.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "students-api.selectorLabels" -}} +app.kubernetes.io/name: {{ include "students-api.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "students-api.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "students-api.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/src/main/resources/helm/students-api/templates/deployment.yaml b/src/main/resources/helm/students-api/templates/deployment.yaml new file mode 100644 index 0000000..327e77a --- /dev/null +++ b/src/main/resources/helm/students-api/templates/deployment.yaml @@ -0,0 +1,48 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "students-api.fullname" . }} + labels: + {{- include "students-api.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "students-api.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "students-api.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "students-api.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: 8080 + protocol: TCP + env: + - name: MONGO_USERNAME + value: {{ .Values.mongodb.auth.username }} + - name: MONGO_PASSWORD + value: {{ .Values.mongodb.auth.password }} + - name: MONGO_DB + value: {{ .Values.mongodb.auth.database }} + - name: MONGO_HOST + value: {{ .Values.mongodb.service.nameOverride }} \ No newline at end of file diff --git a/src/main/resources/helm/students-api/templates/hpa.yaml b/src/main/resources/helm/students-api/templates/hpa.yaml new file mode 100644 index 0000000..2048cd9 --- /dev/null +++ b/src/main/resources/helm/students-api/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "students-api.fullname" . }} + labels: + {{- include "students-api.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "students-api.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/src/main/resources/helm/students-api/templates/ingress.yaml b/src/main/resources/helm/students-api/templates/ingress.yaml new file mode 100644 index 0000000..c60e11f --- /dev/null +++ b/src/main/resources/helm/students-api/templates/ingress.yaml @@ -0,0 +1,41 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "students-api.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: apps/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "students-api.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + backend: + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} diff --git a/src/main/resources/helm/students-api/templates/pvc.yaml b/src/main/resources/helm/students-api/templates/pvc.yaml new file mode 100644 index 0000000..357becf --- /dev/null +++ b/src/main/resources/helm/students-api/templates/pvc.yaml @@ -0,0 +1,14 @@ +--- +apiVersion: v1 +kind: PersistentVolumeClaim +metadata: + name: mongodb-pv-claim # name of PVC essential for identifying the storage data + labels: + app: mongo + tier: database +spec: + accessModes: + - ReadWriteOnce #This specifies the mode of the claim that we are trying to create. + resources: + requests: + storage: 1Gi #This will tell kubernetes about the amount of space we are trying to claim. \ No newline at end of file diff --git a/src/main/resources/helm/students-api/templates/service.yaml b/src/main/resources/helm/students-api/templates/service.yaml new file mode 100644 index 0000000..7c83d2c --- /dev/null +++ b/src/main/resources/helm/students-api/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "students-api.fullname" . }} + labels: + {{- include "students-api.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "students-api.selectorLabels" . | nindent 4 }} diff --git a/src/main/resources/helm/students-api/templates/serviceaccount.yaml b/src/main/resources/helm/students-api/templates/serviceaccount.yaml new file mode 100644 index 0000000..9c0323c --- /dev/null +++ b/src/main/resources/helm/students-api/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "students-api.serviceAccountName" . }} + labels: + {{- include "students-api.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/src/main/resources/helm/students-api/values.yaml b/src/main/resources/helm/students-api/values.yaml new file mode 100644 index 0000000..a26484c --- /dev/null +++ b/src/main/resources/helm/students-api/values.yaml @@ -0,0 +1,98 @@ +# Default values for students-api. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 2 + +image: + repository: sainik73/students-api + pullPolicy: Never + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +imagePullSecrets: [] +nameOverride: "students-api" +fullnameOverride: "students-api" + +serviceAccount: + # Specifies whether a service account should be created + create: false + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: ClusterIP + port: 80 + +ingress: + enabled: false + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: [] + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +## +## MongoDB chart configuration +## Override values - https://github.com/bitnami/charts/tree/master/bitnami/mongodb +## +mongodb: + nameOverride: "mongodb" + fullnameOverride: "mongodb" + auth: + database: studentsdb + rootPassword: admin + username: studentadmin + password: studentadmin + service: + nameOverride: mongodb + persistence: + enabled: true + mountPath: /bitnami/mongodb + existingClaim: mongodb-pv-claim \ No newline at end of file