diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..9cefa99 --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,68 @@ +variables: + CONTAINER_REGISTRY: "docker.io/parity" + CONTAINER_REPO: "substrate-telemetry-backend" + KUBE_NAMESPACE: "substrate-telemetry" + IMAGE_FULL_NAME: "${CONTAINER_REGISTRY}/${CONTAINER_REPO}:${CI_COMMIT_SHORT_SHA}" + +stages: + - dockerize + - staging + +#.delete_deployment: &delete_deployment +# - helm uninstall -n "$KUBE_NAMESPACE" "$KUBE_NAMESPACE" + +.deploy-k8s: &deploy-k8s + image: paritytech/kubetools:3.5.3 + script: + - echo "Deploying using image $IMAGE_FULL_NAME" + - echo "Using Helm `helm version --short`" + - export KUBERNETES_VERSION_TAG="$CI_PIPELINE_ID" + - |- + sed -i "s/version:.*/version: $KUBERNETES_VERSION_TAG/" ./helm/Chart.yaml + - |- + sed -i "s/appVersion:.*/appVersion: $KUBERNETES_VERSION_TAG/" ./helm/Chart.yaml + # validate the chart + - helm --debug template + --create-namespace + --namespace $KUBE_NAMESPACE + --set image.repository="${CONTAINER_REGISTRY}/${CONTAINER_REPO}" + --set image.tag="${CI_COMMIT_SHORT_SHA}" + $KUBE_NAMESPACE ./helm/ + # install the chart into the relevant cluster + - helm --debug upgrade + --install + --atomic + --timeout 120s + --create-namespace + --namespace $KUBE_NAMESPACE + --set image.repository="${CONTAINER_REGISTRY}/${CONTAINER_REPO}" + --set image.tag="${CI_COMMIT_SHORT_SHA}" + $KUBE_NAMESPACE ./helm/ + rules: + - if: '$CI_COMMIT_BRANCH == "jsdw-sharding"' + when: manual + tags: + - kubernetes-parity-build + +dockerize: + stage: dockerize + image: quay.io/buildah/stable + script: + - echo "Building image $IMAGE_FULL_NAME" + - buildah bud + --format=docker + --tag "$IMAGE_FULL_NAME" ./backend/ + - echo ${Docker_Hub_Pass_Parity} | + buildah login --username ${Docker_Hub_User_Parity} --password-stdin docker.io + - buildah push --format=v2s2 "$IMAGE_FULL_NAME" + rules: + - if: '$CI_COMMIT_BRANCH == "jsdw-sharding"' + when: manual + tags: + - kubernetes-parity-build + +deploy-parity-stg: + stage: staging + <<: *deploy-k8s + environment: + name: parity-stg diff --git a/backend/Dockerfile b/backend/Dockerfile index 117ca76..0ffd8c6 100644 --- a/backend/Dockerfile +++ b/backend/Dockerfile @@ -1,4 +1,4 @@ -FROM paritytech/ci-linux:production as builder +FROM docker.io/paritytech/ci-linux:production as builder ARG PROFILE=release WORKDIR /app @@ -8,7 +8,7 @@ COPY . . RUN cargo build --${PROFILE} --bins # MAIN IMAGE FOR PEOPLE TO PULL --- small one# -FROM debian:buster-slim +FROM docker.io/debian:buster-slim LABEL maintainer="Parity Technologies" LABEL description="Polkadot Telemetry backend shard/core binaries, static build" diff --git a/helm/.helmignore b/helm/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/helm/.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/helm/Chart.yaml b/helm/Chart.yaml new file mode 100644 index 0000000..44296d3 --- /dev/null +++ b/helm/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: substrate-telemetry +description: A 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: 0.1.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.16.0" diff --git a/helm/templates/NOTES.txt b/helm/templates/NOTES.txt new file mode 100644 index 0000000..2100821 --- /dev/null +++ b/helm/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.shard.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "substrate-telemetry.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.shard.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 telemetry-shard' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "substrate-telemetry.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.service.shard.port }} +{{- else if contains "ClusterIP" .Values.service.shard.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "substrate-telemetry.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/helm/templates/_helpers.tpl b/helm/templates/_helpers.tpl new file mode 100644 index 0000000..d1022e9 --- /dev/null +++ b/helm/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "substrate-telemetry.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 "substrate-telemetry.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 "substrate-telemetry.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "substrate-telemetry.labels" -}} +helm.sh/chart: {{ include "substrate-telemetry.chart" . }} +{{ include "substrate-telemetry.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "substrate-telemetry.selectorLabels" -}} +app.kubernetes.io/name: {{ include "substrate-telemetry.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "substrate-telemetry.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "substrate-telemetry.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/helm/templates/core-deployment.yaml b/helm/templates/core-deployment.yaml new file mode 100644 index 0000000..d4c47b0 --- /dev/null +++ b/helm/templates/core-deployment.yaml @@ -0,0 +1,68 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: telemetry-core + labels: + {{- include "substrate-telemetry.labels" . | nindent 4 }} + telemetry-component: core +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount.core }} + {{- end }} + selector: + matchLabels: + {{- include "substrate-telemetry.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "substrate-telemetry.selectorLabels" . | nindent 8 }} + telemetry-component: core + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "substrate-telemetry.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 }} + command: + - "telemetry_core" + args: + - "--listen" + - "0.0.0.0:{{ .Values.service.core.targetPort }}" + ports: + - name: http + containerPort: {{ .Values.service.core.targetPort }} + protocol: TCP + livenessProbe: + httpGet: + path: /health + port: http + readinessProbe: + httpGet: + path: /health + port: http + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/helm/templates/core-service.yaml b/helm/templates/core-service.yaml new file mode 100644 index 0000000..c8472e2 --- /dev/null +++ b/helm/templates/core-service.yaml @@ -0,0 +1,19 @@ +apiVersion: v1 +kind: Service +metadata: + name: telemetry-core + labels: + {{- include "substrate-telemetry.labels" . | nindent 4 }} + telemetry-component: core + annotations: + {{- toYaml .Values.service.core.annotations | nindent 4 }} +spec: + type: {{ .Values.service.core.type }} + ports: + - port: {{ .Values.service.core.port }} + targetPort: {{ .Values.service.core.targetPort }} + protocol: TCP + name: http + selector: + {{- include "substrate-telemetry.selectorLabels" . | nindent 4 }} + telemetry-component: core diff --git a/helm/templates/ingress.yaml b/helm/templates/ingress.yaml new file mode 100644 index 0000000..30dc97e --- /dev/null +++ b/helm/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "substrate-telemetry.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }} + {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }} + {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}} + {{- end }} +{{- end }} +{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1 +{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: extensions/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "substrate-telemetry.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- 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 }} + {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }} + pathType: {{ .pathType }} + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- else }} + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} +{{- end }} diff --git a/helm/templates/serviceaccount.yaml b/helm/templates/serviceaccount.yaml new file mode 100644 index 0000000..a6a6722 --- /dev/null +++ b/helm/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "substrate-telemetry.serviceAccountName" . }} + labels: + {{- include "substrate-telemetry.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/helm/templates/shard-deployment.yaml b/helm/templates/shard-deployment.yaml new file mode 100644 index 0000000..4ed4333 --- /dev/null +++ b/helm/templates/shard-deployment.yaml @@ -0,0 +1,70 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: telemetry-shard + labels: + {{- include "substrate-telemetry.labels" . | nindent 4 }} + telemetry-component: shard +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount.shard }} + {{- end }} + selector: + matchLabels: + {{- include "substrate-telemetry.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "substrate-telemetry.selectorLabels" . | nindent 8 }} + telemetry-component: shard + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "substrate-telemetry.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 }} + command: + - "telemetry_shard" + args: + - "--listen" + - "0.0.0.0:{{ .Values.service.shard.targetPort }}" + - "--core" + - "http://telemetry-core:{{ .Values.service.core.port }}/shard_submit" + ports: + - name: http + containerPort: {{ .Values.service.shard.targetPort }} + protocol: TCP + livenessProbe: + httpGet: + path: /health + port: http + readinessProbe: + httpGet: + path: /health + port: http + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/helm/templates/shard-hpa.yaml b/helm/templates/shard-hpa.yaml new file mode 100644 index 0000000..eabbced --- /dev/null +++ b/helm/templates/shard-hpa.yaml @@ -0,0 +1,29 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: telemetry-shard + labels: + {{- include "substrate-telemetry.labels" . | nindent 4 }} + telemetry-component: shard +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: telemetry-shard + 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/helm/templates/shard-service.yaml b/helm/templates/shard-service.yaml new file mode 100644 index 0000000..1149f84 --- /dev/null +++ b/helm/templates/shard-service.yaml @@ -0,0 +1,20 @@ +apiVersion: v1 +kind: Service +metadata: + name: telemetry-shard + labels: + {{- include "substrate-telemetry.labels" . | nindent 4 }} + telemetry-component: shard + annotations: + {{- toYaml .Values.service.shard.annotations | nindent 4 }} + +spec: + type: {{ .Values.service.shard.type }} + ports: + - port: {{ .Values.service.shard.port }} + targetPort: {{ .Values.service.shard.targetPort }} + protocol: TCP + name: http + selector: + {{- include "substrate-telemetry.selectorLabels" . | nindent 4 }} + telemetry-component: shard diff --git a/helm/values.yaml b/helm/values.yaml new file mode 100644 index 0000000..1b38cef --- /dev/null +++ b/helm/values.yaml @@ -0,0 +1,121 @@ +# Default values for substrate-telemtry. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: + shard: 3 + core: 1 + +image: + repository: docker.io/parity/substrate-telemetry-backend + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: master-b4117d3a + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # 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: + shard: + type: LoadBalancer + port: 80 + targetPort: 8000 + annotations: + cloud.google.com/load-balancer-type: Internal + networking.gke.io/internal-load-balancer-allow-global-access: "true" + external-dns.alpha.kubernetes.io/hostname: substrate-telemetry.parity-stg.parity.io. + core: + type: LoadBalancer + port: 80 + targetPort: 8000 + annotations: + cloud.google.com/load-balancer-type: Internal + networking.gke.io/internal-load-balancer-allow-global-access: "true" + external-dns.alpha.kubernetes.io/hostname: substrate-telemetry-core.parity-stg.parity.io. + + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + 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: + shard: + enabled: true + minReplicas: 3 + maxReplicas: 6 + targetCPUUtilizationPercentage: 80 + targetMemoryUtilizationPercentage: 80 + # telemetry-core is not scalable atm. + core: + enabled: false + minReplicas: 3 + maxReplicas: 6 + targetCPUUtilizationPercentage: 80 + targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + + +affinity: + nodeAffinity: + requiredDuringSchedulingIgnoredDuringExecution: + nodeSelectorTerms: + - matchExpressions: + - key: cloud.google.com/gke-nodepool + operator: In + values: + - substrate-telemetry-pool + +tolerations: +- key: "app" + operator: "Equal" + value: "substrate-telemetry" + effect: "NoExecute" +