From 05b9011e3f905f22e7a2ebe11ad4a79b1bc4a85f Mon Sep 17 00:00:00 2001 From: Sara Lambert Date: Wed, 15 Nov 2023 00:52:54 -0600 Subject: [PATCH] fix: include charts/ directory for metaflow-service and metaflow-ui --- .gitignore | 2 +- charts/metaflow-service/.helmignore | 23 ++ charts/metaflow-service/Chart.yaml | 6 + charts/metaflow-service/LICENSE | 201 ++++++++++++++++++ charts/metaflow-service/templates/NOTES.txt | 22 ++ .../metaflow-service/templates/_helpers.tpl | 84 ++++++++ .../templates/deployment.yaml | 81 +++++++ .../metaflow-service/templates/ingress.yaml | 61 ++++++ .../metaflow-service/templates/service.yaml | 23 ++ .../templates/serviceaccount.yaml | 12 ++ .../templates/tests/test-connection.yaml | 15 ++ charts/metaflow-service/values.yaml | 102 +++++++++ charts/metaflow-ui/.helmignore | 23 ++ charts/metaflow-ui/Chart.yaml | 6 + charts/metaflow-ui/LICENSE | 201 ++++++++++++++++++ charts/metaflow-ui/README.md | 3 + charts/metaflow-ui/templates/NOTES.txt | 22 ++ charts/metaflow-ui/templates/_helpers.tpl | 118 ++++++++++ .../templates/backend_deployment.yaml | 90 ++++++++ .../templates/backend_service.yaml | 15 ++ charts/metaflow-ui/templates/ingress.yaml | 90 ++++++++ .../metaflow-ui/templates/serviceaccount.yaml | 12 ++ .../templates/static_deployment.yaml | 66 ++++++ .../metaflow-ui/templates/static_service.yaml | 15 ++ .../templates/tests/test-connection.yaml | 15 ++ charts/metaflow-ui/values.yaml | 122 +++++++++++ 26 files changed, 1429 insertions(+), 1 deletion(-) create mode 100644 charts/metaflow-service/.helmignore create mode 100644 charts/metaflow-service/Chart.yaml create mode 100644 charts/metaflow-service/LICENSE create mode 100644 charts/metaflow-service/templates/NOTES.txt create mode 100644 charts/metaflow-service/templates/_helpers.tpl create mode 100644 charts/metaflow-service/templates/deployment.yaml create mode 100644 charts/metaflow-service/templates/ingress.yaml create mode 100644 charts/metaflow-service/templates/service.yaml create mode 100644 charts/metaflow-service/templates/serviceaccount.yaml create mode 100644 charts/metaflow-service/templates/tests/test-connection.yaml create mode 100644 charts/metaflow-service/values.yaml create mode 100644 charts/metaflow-ui/.helmignore create mode 100644 charts/metaflow-ui/Chart.yaml create mode 100644 charts/metaflow-ui/LICENSE create mode 100644 charts/metaflow-ui/README.md create mode 100644 charts/metaflow-ui/templates/NOTES.txt create mode 100644 charts/metaflow-ui/templates/_helpers.tpl create mode 100644 charts/metaflow-ui/templates/backend_deployment.yaml create mode 100644 charts/metaflow-ui/templates/backend_service.yaml create mode 100644 charts/metaflow-ui/templates/ingress.yaml create mode 100644 charts/metaflow-ui/templates/serviceaccount.yaml create mode 100644 charts/metaflow-ui/templates/static_deployment.yaml create mode 100644 charts/metaflow-ui/templates/static_service.yaml create mode 100644 charts/metaflow-ui/templates/tests/test-connection.yaml create mode 100644 charts/metaflow-ui/values.yaml diff --git a/.gitignore b/.gitignore index ee3892e..948259a 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -charts/ +charts/*.tgz diff --git a/charts/metaflow-service/.helmignore b/charts/metaflow-service/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/metaflow-service/.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/charts/metaflow-service/Chart.yaml b/charts/metaflow-service/Chart.yaml new file mode 100644 index 0000000..5550113 --- /dev/null +++ b/charts/metaflow-service/Chart.yaml @@ -0,0 +1,6 @@ +apiVersion: v2 +appVersion: v2.3.6 +description: A Helm chart to deploy Metadata Service for Metaflow +name: metaflow-service +type: application +version: 0.2.0 diff --git a/charts/metaflow-service/LICENSE b/charts/metaflow-service/LICENSE new file mode 100644 index 0000000..2cc5fb7 --- /dev/null +++ b/charts/metaflow-service/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 Step Computing, Inc. + + 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. diff --git a/charts/metaflow-service/templates/NOTES.txt b/charts/metaflow-service/templates/NOTES.txt new file mode 100644 index 0000000..be5330d --- /dev/null +++ b/charts/metaflow-service/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 "metaflow-service.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 "metaflow-service.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "metaflow-service.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 "metaflow-service.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/charts/metaflow-service/templates/_helpers.tpl b/charts/metaflow-service/templates/_helpers.tpl new file mode 100644 index 0000000..297efc7 --- /dev/null +++ b/charts/metaflow-service/templates/_helpers.tpl @@ -0,0 +1,84 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "metaflow-service.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 "metaflow-service.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 "metaflow-service.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "metaflow-service.labels" -}} +helm.sh/chart: {{ include "metaflow-service.chart" . }} +{{ include "metaflow-service.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "metaflow-service.selectorLabels" -}} +app.kubernetes.io/name: {{ include "metaflow-service.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "metaflow-service.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "metaflow-service.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{- define "metaflow-service.metadatadbEnvVars" -}} +- name: MF_METADATA_DB_NAME + value: {{ .Values.metadatadb.name | quote }} +- name: MF_METADATA_DB_PORT + value: {{ .Values.metadatadb.port | quote }} +- name: MF_METADATA_DB_PSWD + value: {{ .Values.metadatadb.password | quote }} +- name: MF_METADATA_DB_USER + value: {{ .Values.metadatadb.user | quote }} +{{- if .Values.metadatadb.host }} +- name: MF_METADATA_DB_HOST + value: {{ .Values.metadatadb.host | quote }} +{{- else }} +- name: MF_METADATA_DB_HOST + value: {{ .Release.Name }}-postgresql +{{- end }} +{{- if .Values.metadatadb.schema }} +- name: DB_SCHEMA_NAME + value: {{ .Values.metadatadb.schema | quote }} +{{- end }} +{{- end -}} diff --git a/charts/metaflow-service/templates/deployment.yaml b/charts/metaflow-service/templates/deployment.yaml new file mode 100644 index 0000000..426dacf --- /dev/null +++ b/charts/metaflow-service/templates/deployment.yaml @@ -0,0 +1,81 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "metaflow-service.fullname" . }} + labels: + {{- include "metaflow-service.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "metaflow-service.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "metaflow-service.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "metaflow-service.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + {{- if .Values.dbMigrations.runOnStart }} + initContainers: + - name: db-migrations + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + command: + - "/opt/latest/bin/python3" + - "/root/run_goose.py" + {{- if .Values.dbMigrations.onlyIfDbEmpty }} + - "--only-if-empty-db" + {{- end }} + env: + {{- include "metaflow-service.metadatadbEnvVars" . | nindent 12 }} + {{- end }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + command: ["/opt/latest/bin/python3", "-m", "services.metadata_service.server" ] + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: 8080 + protocol: TCP + livenessProbe: + httpGet: + path: /ping + port: http + readinessProbe: + httpGet: + path: /ping + port: http + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.envFrom }} + envFrom: + {{- toYaml . | nindent 12 }} + {{- end }} + env: + {{- include "metaflow-service.metadatadbEnvVars" . | 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/charts/metaflow-service/templates/ingress.yaml b/charts/metaflow-service/templates/ingress.yaml new file mode 100644 index 0000000..2755c6a --- /dev/null +++ b/charts/metaflow-service/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "metaflow-service.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 "metaflow-service.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/charts/metaflow-service/templates/service.yaml b/charts/metaflow-service/templates/service.yaml new file mode 100644 index 0000000..4d0fc44 --- /dev/null +++ b/charts/metaflow-service/templates/service.yaml @@ -0,0 +1,23 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "metaflow-service.fullname" . }} + labels: + {{- include "metaflow-service.labels" . | nindent 4 }} + {{- with .Values.service.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + type: {{ .Values.service.type }} + ports: + - name: metadata + port: {{ .Values.service.port }} + protocol: TCP + targetPort: 8080 + - name: upgrades + port: 8082 + protocol: TCP + targetPort: 8082 + selector: + {{- include "metaflow-service.selectorLabels" . | nindent 4 }} diff --git a/charts/metaflow-service/templates/serviceaccount.yaml b/charts/metaflow-service/templates/serviceaccount.yaml new file mode 100644 index 0000000..64b9fd5 --- /dev/null +++ b/charts/metaflow-service/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "metaflow-service.serviceAccountName" . }} + labels: + {{- include "metaflow-service.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/metaflow-service/templates/tests/test-connection.yaml b/charts/metaflow-service/templates/tests/test-connection.yaml new file mode 100644 index 0000000..5eb864f --- /dev/null +++ b/charts/metaflow-service/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "metaflow-service.fullname" . }}-test-connection" + labels: + {{- include "metaflow-service.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "metaflow-service.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/charts/metaflow-service/values.yaml b/charts/metaflow-service/values.yaml new file mode 100644 index 0000000..b5914a3 --- /dev/null +++ b/charts/metaflow-service/values.yaml @@ -0,0 +1,102 @@ +# Default values for metaflow-service. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: public.ecr.aws/outerbounds/metaflow_metadata_service + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + +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 + +dbMigrations: + # Set to true to run migrations on every container start + runOnStart: true + # Set to true to only run them if db is empty. This setting has no effect is + # runOnStart is false. + # + # We recommend setting this to true for production environments with lots + # of runs, since running the migrations may lock the database for a while. + # For smaller/toy deployments you can set this to false + onlyIfDbEmpty: true + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: ClusterIP + port: 8080 + annotations: {} + +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: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +envFrom: [] + +metadatadb: + port: 5432 + password: "" + host: "" + user: "" diff --git a/charts/metaflow-ui/.helmignore b/charts/metaflow-ui/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/charts/metaflow-ui/.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/charts/metaflow-ui/Chart.yaml b/charts/metaflow-ui/Chart.yaml new file mode 100644 index 0000000..23a0506 --- /dev/null +++ b/charts/metaflow-ui/Chart.yaml @@ -0,0 +1,6 @@ +apiVersion: v2 +appVersion: v2.3.11 +description: A Helm chart for Kubernetes +name: metaflow-ui +type: application +version: 0.2.0 diff --git a/charts/metaflow-ui/LICENSE b/charts/metaflow-ui/LICENSE new file mode 100644 index 0000000..2cc5fb7 --- /dev/null +++ b/charts/metaflow-ui/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 Step Computing, Inc. + + 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. diff --git a/charts/metaflow-ui/README.md b/charts/metaflow-ui/README.md new file mode 100644 index 0000000..3aca66f --- /dev/null +++ b/charts/metaflow-ui/README.md @@ -0,0 +1,3 @@ +## Helm Chart for Metaflow UI + +This helm chart deploys the static and backend components of the metaflow UI. It assumes that these deployments will mostly share similar configurations like `imagePullSecrets`, `tolerations`, and `affinity`. However, you can also configure the static and backend components separately via the `uiStatic` and `uiBackend` blocks respectively. Plus the helm chart also includes a way to configure the ingress resources that can optionally be deployed to server the metaflow UI. diff --git a/charts/metaflow-ui/templates/NOTES.txt b/charts/metaflow-ui/templates/NOTES.txt new file mode 100644 index 0000000..b67d11c --- /dev/null +++ b/charts/metaflow-ui/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.uiBackend.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "metaflow-ui.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.uiBackend.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 "metaflow-ui.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "metaflow-ui.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") + echo http://$SERVICE_IP:{{ .Values.uiBackend.service.port }} +{{- else if contains "ClusterIP" .Values.uiBackend.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "metaflow-ui.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/charts/metaflow-ui/templates/_helpers.tpl b/charts/metaflow-ui/templates/_helpers.tpl new file mode 100644 index 0000000..06e648d --- /dev/null +++ b/charts/metaflow-ui/templates/_helpers.tpl @@ -0,0 +1,118 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "metaflow-ui.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{- define "metaflow-ui.name-static" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}-static +{{- 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 "metaflow-ui.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 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 "metaflow-ui.fullname-static" -}} +{{ include "metaflow-ui.fullname" . }}-static +{{- end }} + + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "metaflow-ui.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "metaflow-ui.labels" -}} +helm.sh/chart: {{ include "metaflow-ui.chart" . }} +{{ include "metaflow-ui.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "metaflow-ui.labelsStatic" -}} +helm.sh/chart: {{ include "metaflow-ui.chart" . }} +{{ include "metaflow-ui.selectorLabelsStatic" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "metaflow-ui.selectorLabels" -}} +app.kubernetes.io/name: {{ include "metaflow-ui.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "metaflow-ui.selectorLabelsStatic" -}} +app.kubernetes.io/name: {{ include "metaflow-ui.name-static" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "metaflow-ui.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "metaflow-ui.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} + +{{- define "metaflow-ui.metadatadbEnvVars" -}} +- name: MF_METADATA_DB_NAME + value: {{ .Values.uiBackend.metadatadb.name | quote }} +- name: MF_METADATA_DB_PORT + value: {{ .Values.uiBackend.metadatadb.port | quote }} +- name: MF_METADATA_DB_PSWD + value: {{ .Values.uiBackend.metadatadb.password | quote }} +- name: MF_METADATA_DB_USER + value: {{ .Values.uiBackend.metadatadb.user | quote }} +{{- if .Values.uiBackend.metadatadb.host }} +- name: MF_METADATA_DB_HOST + value: {{ .Values.uiBackend.metadatadb.host | quote }} +{{- else }} +- name: MF_METADATA_DB_HOST + value: {{ .Release.Name }}-postgresql +{{- end -}} +{{- if .Values.uiBackend.metadatadb.schema }} +- name: DB_SCHEMA_NAME + value: {{ .Values.uiBackend.metadatadb.schema | quote }} +{{- end }} +{{- end -}} diff --git a/charts/metaflow-ui/templates/backend_deployment.yaml b/charts/metaflow-ui/templates/backend_deployment.yaml new file mode 100644 index 0000000..fbe988c --- /dev/null +++ b/charts/metaflow-ui/templates/backend_deployment.yaml @@ -0,0 +1,90 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "metaflow-ui.fullname" . }} + labels: + {{- include "metaflow-ui.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.uiBackend.replicaCount }} + selector: + matchLabels: + {{- include "metaflow-ui.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.uiBackend.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "metaflow-ui.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "metaflow-ui.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.uiBackend.image.name }}:{{ .Values.uiBackend.image.tag | default .Chart.AppVersion }}" + command: ["/opt/latest/bin/python3", "-m", "services.ui_backend_service.ui_server" ] + imagePullPolicy: {{ .Values.uiBackend.image.pullPolicy }} + ports: + - name: http + containerPort: 8083 + protocol: TCP + livenessProbe: + httpGet: + path: /api/ping + port: http + readinessProbe: + httpGet: + path: /api/ping + port: http + {{- with .Values.uiBackend.envFrom }} + envFrom: + {{- toYaml . | nindent 12 }} + {{- end }} + env: + {{- range .Values.uiBackend.env }} + - name: {{ .name | quote }} + value: {{ .value | quote }} + {{- end }} + - name: UI_ENABLED + value: "1" + - name: PATH_PREFIX + value: "/api" + - name: MF_DATASTORE_ROOT + value: {{ .Values.uiBackend.metaflowDatastoreSysRootS3 | quote }} + - name: METAFLOW_DATASTORE_SYSROOT_S3 + value: {{ .Values.uiBackend.metaflowDatastoreSysRootS3 | quote }} + {{- if .Values.uiBackend.metaflowS3EndpointURL }} + - name: METAFLOW_S3_ENDPOINT_URL + value: {{ .Values.uiBackend.metaflowS3EndpointURL | quote }} + {{- end }} + - name: LOGLEVEL + value: "DEBUG" + - name: METAFLOW_SERVICE_URL + value: {{ .Values.uiBackend.metaflowServiceURL | quote }} + - name: METAFLOW_DEFAULT_DATASTORE + value: "s3" + - name: METAFLOW_DEFAULT_METADATA + value: "service" + {{- include "metaflow-ui.metadatadbEnvVars" . | nindent 12 }} + resources: + {{- toYaml .Values.uiBackend.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/charts/metaflow-ui/templates/backend_service.yaml b/charts/metaflow-ui/templates/backend_service.yaml new file mode 100644 index 0000000..01281f1 --- /dev/null +++ b/charts/metaflow-ui/templates/backend_service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "metaflow-ui.fullname" . }} + labels: + {{- include "metaflow-ui.labels" . | nindent 4 }} +spec: + type: {{ .Values.uiBackend.service.type }} + ports: + - port: {{ .Values.uiBackend.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "metaflow-ui.selectorLabels" . | nindent 4 }} diff --git a/charts/metaflow-ui/templates/ingress.yaml b/charts/metaflow-ui/templates/ingress.yaml new file mode 100644 index 0000000..033c6dd --- /dev/null +++ b/charts/metaflow-ui/templates/ingress.yaml @@ -0,0 +1,90 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "metaflow-ui.fullname" . -}} +{{- $svcPort := .Values.uiBackend.service.port -}} +{{- $fullNameStatic := include "metaflow-ui.fullname-static" . -}} +{{- $svcPortStatic := .Values.uiStatic.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 "metaflow-ui.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: + - path: "/api" + {{- if semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion }} + pathType: Prefix + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- else }} + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + - path: "/" + {{- if semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion }} + pathType: Prefix + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullNameStatic }} + port: + number: {{ $svcPortStatic }} + {{- else }} + serviceName: {{ $fullNameStatic }} + servicePort: {{ $svcPortStatic }} + {{- end }} + - path: "/static" + {{- if semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion }} + pathType: Prefix + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullNameStatic }} + port: + number: {{ $svcPortStatic }} + {{- else }} + serviceName: {{ $fullNameStatic }} + servicePort: {{ $svcPortStatic }} + {{- end }} + + {{- end }} +{{- end }} diff --git a/charts/metaflow-ui/templates/serviceaccount.yaml b/charts/metaflow-ui/templates/serviceaccount.yaml new file mode 100644 index 0000000..4798c61 --- /dev/null +++ b/charts/metaflow-ui/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "metaflow-ui.serviceAccountName" . }} + labels: + {{- include "metaflow-ui.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/charts/metaflow-ui/templates/static_deployment.yaml b/charts/metaflow-ui/templates/static_deployment.yaml new file mode 100644 index 0000000..299fe0b --- /dev/null +++ b/charts/metaflow-ui/templates/static_deployment.yaml @@ -0,0 +1,66 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: "{{ include "metaflow-ui.fullname-static" . }}" + labels: + {{- include "metaflow-ui.labelsStatic" . | nindent 4 }} +spec: + replicas: {{ .Values.uiStatic.replicaCount }} + selector: + matchLabels: + {{- include "metaflow-ui.selectorLabelsStatic" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "metaflow-ui.selectorLabelsStatic" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "metaflow-ui.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: "{{ .Chart.Name }}-static" + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.uiStatic.image.name }}:{{ .Values.uiStatic.image.tag }}" + imagePullPolicy: {{ .Values.uiStatic.image.pullPolicy }} + ports: + - name: http + containerPort: 3000 + protocol: TCP + livenessProbe: + httpGet: + path: / + port: http + readinessProbe: + httpGet: + path: / + port: http + env: + - name: METAFLOW_SERVICE + value: {{ .Values.uiStatic.metaflowUIBackendURL | quote }} + {{- range .Values.env }} + - name: {{ .name | quote }} + value: {{ .value | quote }} + {{- end }} + resources: + {{- toYaml .Values.uiStatic.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/charts/metaflow-ui/templates/static_service.yaml b/charts/metaflow-ui/templates/static_service.yaml new file mode 100644 index 0000000..3627ca9 --- /dev/null +++ b/charts/metaflow-ui/templates/static_service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: "{{ include "metaflow-ui.fullname-static" . }}" + labels: + {{- include "metaflow-ui.labelsStatic" . | nindent 4 }} +spec: + type: {{ .Values.uiStatic.service.type }} + ports: + - port: {{ .Values.uiStatic.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "metaflow-ui.selectorLabelsStatic" . | nindent 4 }} diff --git a/charts/metaflow-ui/templates/tests/test-connection.yaml b/charts/metaflow-ui/templates/tests/test-connection.yaml new file mode 100644 index 0000000..8966050 --- /dev/null +++ b/charts/metaflow-ui/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "metaflow-ui.fullname" . }}-test-connection" + labels: + {{- include "metaflow-ui.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "metaflow-ui.fullname" . }}:{{ .Values.uiBackend.service.port }}'] + restartPolicy: Never diff --git a/charts/metaflow-ui/values.yaml b/charts/metaflow-ui/values.yaml new file mode 100644 index 0000000..fccf446 --- /dev/null +++ b/charts/metaflow-ui/values.yaml @@ -0,0 +1,122 @@ +uiBackend: + image: + name: public.ecr.aws/outerbounds/metaflow_metadata_service + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "" + + podAnnotations: {} + + env: [] + # Additional environment variables for metaflow-ui static deployment. Example config: + # - name: METAFLOW_SERVICE + # value: "http://localhost:8083/api/" + + envFrom: [] + + 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: 200m + # memory: 256Mi + # requests: + # cpu: 100m + # memory: 128Mi + + service: + type: ClusterIP + port: 8083 + + replicaCount: 1 + + metaflowDatastoreSysRootS3: "" + # The root S3 bucket prefix that will be used by metaflow + + metaflowServiceURL: "http://localhost:8083/api/metadata" + # The metaflow metadata service URL + + metaflowS3EndpointURL: "" + # This should be set only when using an S3 compatible object storage like minio + + metadatadb: + port: 5432 + password: "" + host: "" + user: "" + +uiStatic: + image: + name: public.ecr.aws/outerbounds/metaflow_ui + pullPolicy: IfNotPresent + tag: "v1.3.3" + + podAnnotations: {} + + 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: 200m + # memory: 256Mi + # requests: + # cpu: 100m + # memory: 128Mi + + env: [] + # Environment variables for metaflow-ui static deployment. Example config: + # - name: var_name + # value: "var_value" + + metaflowUIBackendURL: "http://localhost:8083/api/" + + service: + type: ClusterIP + port: 3000 + + replicaCount: 1 + +# values common to both the UI static and backend deployments +imagePullSecrets: [] +podSecurityContext: {} + # fsGroup: 2000 +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 +nodeSelector: {} +tolerations: [] +affinity: {} + +# name overrides +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: "" + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: /api + pathType: ImplementationSpecific + tls: []