miniMirror Helm chart

This creates the initial miniMirror chart with the following k8s objects:
- deployment
- service
- ingress

This adds new tests to the airship-utils check gate related to Helm charts:
- helm lint
- helm package
- helm install

Change-Id: I6f5a3edcd66c3386fbab3b87c421b96f7198fdf1
This commit is contained in:
Andrey Volkov 2018-10-25 12:43:47 -07:00
parent 2eaedf43d3
commit bafaef31bd
12 changed files with 408 additions and 2 deletions

View File

@ -31,12 +31,13 @@ UBUNTU_BASE_IMAGE ?= ubuntu:16.04
IMAGE:=${DOCKER_REGISTRY}/${IMAGE_PREFIX}/$(IMAGE_NAME):${IMAGE_TAG} IMAGE:=${DOCKER_REGISTRY}/${IMAGE_PREFIX}/$(IMAGE_NAME):${IMAGE_TAG}
MINI_MIRROR := mini-mirror MINI_MIRROR := mini-mirror
CHART := charts/mini-mirror
.PHONY: validate .PHONY: validate
validate: lint test validate: lint test
.PHONY: test .PHONY: test
test: test-containers test: test-containers test-charts
.PHONY: test-containers .PHONY: test-containers
test-containers: clean build test-containers: clean build
@ -49,12 +50,22 @@ test-containers: clean build
--name target \ --name target \
--volume $(shell pwd)/tools:/opt \ --volume $(shell pwd)/tools:/opt \
$(UBUNTU_BASE_IMAGE) /opt/install_packages.sh $(UBUNTU_BASE_IMAGE) /opt/install_packages.sh
$(MAKE) clean
.PHONY: test-charts
test-charts: clean-charts charts helm-lint
$(HELM) install --wait --debug -n mini-mirror mini-mirror-*.tgz --set nodeSelector=
$(MAKE) clean-charts
.PHONY: clean .PHONY: clean
clean: clean:
docker rm -f aptly || true docker rm -f aptly || true
docker rm -f target || true docker rm -f target || true
.PHONY: clean-charts
clean-charts:
$(HELM) delete --purge mini-mirror || true
.PHONY: lint .PHONY: lint
lint: lint:
shellcheck $(MINI_MIRROR)/assets/*.sh shellcheck $(MINI_MIRROR)/assets/*.sh
@ -88,3 +99,19 @@ endif
.PHONY: lint-install .PHONY: lint-install
lint-install: lint-install:
apt-get install -y shellcheck apt-get install -y shellcheck
.PHONY: helm-lint
helm-lint:
$(HELM) lint $(CHART)
# Create tgz of the chart
.PHONY: charts
charts:
rm -f mini-mirror-*.tgz
$(HELM) dep up $(CHART)
$(HELM) package $(CHART)
.PHONY: test-install
test-install:
rm -rf build
tools/helm_tk.sh $(HELM)

View File

@ -0,0 +1,21 @@
# 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
*~
# Various IDEs
.project
.idea/
*.tmproj

View File

@ -0,0 +1,7 @@
apiVersion: v1
appVersion: "1.0"
description: A Helm chart for miniMirror
name: mini-mirror
version: 0.1.0
maintainers:
- name: Airship

View File

@ -0,0 +1,19 @@
# Copyright 2017 The Openstack-Helm Authors.
# Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
dependencies:
- name: helm-toolkit
repository: http://localhost:8879/charts
version: 0.1.0

View File

@ -0,0 +1,19 @@
1. Get the application URL by running these commands:
{{- if .Values.ingress.enabled }}
{{- range .Values.ingress.hosts }}
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ . }}{{ $.Values.ingress.path }}
{{- end }}
{{- else if contains "NodePort" .Values.service.type }}
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "mini-mirror.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 svc -w {{ include "mini-mirror.fullname" . }}'
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "mini-mirror.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
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 "mini-mirror.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:8080 to use your application"
kubectl port-forward $POD_NAME 8080:80
{{- end }}

View File

@ -0,0 +1,32 @@
{{/* vim: set filetype=mustache: */}}
{{/*
Expand the name of the chart.
*/}}
{{- define "mini-mirror.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 "mini-mirror.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 "mini-mirror.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
{{- end -}}

View File

@ -0,0 +1,72 @@
# Copyright 2017 The Openstack-Helm Authors.
# Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
{{- if .Values.manifests.deployment_mini_mirror }}
{{- $envAll := . }}
apiVersion: apps/v1beta2
kind: Deployment
metadata:
name: {{ include "mini-mirror.fullname" . }}
annotations:
{{ tuple $envAll | include "helm-toolkit.snippets.release_uuid" }}
labels:
app.kubernetes.io/name: {{ include "mini-mirror.name" . }}
helm.sh/chart: {{ include "mini-mirror.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
spec:
replicas: {{ .Values.replicaCount }}
{{ tuple $envAll | include "helm-toolkit.snippets.kubernetes_upgrades_deployment" | indent 2 }}
selector:
matchLabels:
app.kubernetes.io/name: {{ include "mini-mirror.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
template:
metadata:
labels:
app.kubernetes.io/name: {{ include "mini-mirror.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{ tuple $envAll "mini-mirror" "mini-mirror" | include "helm-toolkit.snippets.kubernetes_metadata_labels" | indent 8 }}
spec:
containers:
- name: {{ .Chart.Name }}
image: "{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy }}
{{ tuple $envAll $envAll.Values.pod.resources.mini_mirror | include "helm-toolkit.snippets.kubernetes_resources" | indent 10 }}
ports:
- name: http
containerPort: 80
protocol: TCP
livenessProbe:
httpGet:
path: /
port: http
readinessProbe:
httpGet:
path: /
port: http
{{- with .Values.nodeSelector }}
nodeSelector:
{{ toYaml . | indent 8 }}
{{- end }}
{{- with .Values.affinity }}
affinity:
{{ toYaml . | indent 8 }}
{{- end }}
{{- with .Values.tolerations }}
tolerations:
{{ toYaml . | indent 8 }}
{{- end }}
{{- end }}

View File

@ -0,0 +1,55 @@
{{/*
Copyright 2017 The Openstack-Helm Authors.
Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/}}
{{- if .Values.manifests.ingress_mini_mirror }}
{{- $fullName := include "mini-mirror.fullname" . -}}
{{- $ingressPath := .Values.ingress.path -}}
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
name: {{ $fullName }}
labels:
app.kubernetes.io/name: {{ include "mini-mirror.name" . }}
helm.sh/chart: {{ include "mini-mirror.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- with .Values.ingress.annotations }}
annotations:
{{ toYaml . | indent 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: {{ . | quote }}
http:
paths:
- path: {{ $ingressPath }}
backend:
serviceName: {{ $fullName }}
servicePort: mm-port
{{- end }}
{{- end }}

View File

@ -0,0 +1,40 @@
{{/*
Copyright 2017 The Openstack-Helm Authors.
Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/}}
{{- if .Values.manifests.service_mini_mirror }}
{{- $envAll := . }}
---
apiVersion: v1
kind: Service
metadata:
name: {{ include "mini-mirror.fullname" . }}
labels:
app.kubernetes.io/name: {{ include "mini-mirror.name" . }}
helm.sh/chart: {{ include "mini-mirror.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
spec:
type: {{ .Values.service.type }}
ports:
- port: {{ .Values.service.port }}
targetPort: 80
protocol: TCP
name: mm-port
selector:
app.kubernetes.io/name: {{ include "mini-mirror.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}

View File

@ -0,0 +1,55 @@
# Default values for mini-mirror.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.
replicaCount: 1
image:
tag: docker.io/amadev/mini-mirror:latest
pullPolicy: IfNotPresent
nameOverride: "mini-mirror"
fullnameOverride: "mini-mirror"
service:
type: ClusterIP
port: 8889
ingress:
enabled: false
annotations: {}
path: /
hosts:
- cluster.local
tls: []
nodeSelector:
ucp-control-plane: enabled
tolerations: []
affinity: {}
pod:
lifecycle:
upgrades:
deployments:
revision_history: 3
pod_replacement_strategy: RollingUpdate
rolling_update:
max_unavailable: 1
max_surge: 3
resources:
enabled: false
mini_mirror:
limits:
cpu: 100m
memory: 128Mi
requests:
cpu: 100m
memory: 128Mi
manifests:
deployment_mini_mirror: true
service_mini_mirror: true
ingress_mini_mirror: true

View File

@ -16,6 +16,6 @@
tasks: tasks:
- name: Build and Run Container - name: Build and Run Container
become: true become: true
command: make test command: make test-install test
args: args:
chdir: "{{ zuul_osh_relative_path | default(zuul.project.src_dir) }}" chdir: "{{ zuul_osh_relative_path | default(zuul.project.src_dir) }}"

59
tools/helm_tk.sh Executable file
View File

@ -0,0 +1,59 @@
#!/bin/bash
# Copyright 2018 AT&T Intellectual Property. All other rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Script to setup helm-toolkit and helm dep up the shipyard chart
#
HELM=$1
HTK_REPO=${HTK_REPO:-"https://github.com/openstack/openstack-helm-infra"}
HTK_PATH=${HTK_PATH:-""}
if [[ ! -z $(echo $http_proxy) ]]
then
export no_proxy=$no_proxy,127.0.0.1
fi
set -x
function helm_serve {
if [[ -d "$HOME/.helm" ]]; then
echo ".helm directory found"
else
${HELM} init --client-only
fi
if [[ -z $(curl -s 127.0.0.1:8879 | grep 'Helm Repository') ]]; then
${HELM} serve & > /dev/null
while [[ -z $(curl -s 127.0.0.1:8879 | grep 'Helm Repository') ]]; do
sleep 1
echo "Waiting for Helm Repository"
done
else
echo "Helm serve already running"
fi
if ${HELM} repo list | grep -q "^stable" ; then
${HELM} repo remove stable
fi
${HELM} repo add local http://localhost:8879/charts
}
mkdir -p build
pushd build
git clone --depth 1 $HTK_REPO || true
pushd ${HTK_REPO##*/}/$HTK_PATH
git pull
make helm-toolkit
helm_serve