Update kubeflow/model-registry manifests from v0.2.0-alpha (kubeflow#…

…2697) * Update kubeflow/model-registry manifests from v0.2.0-alpha Signed-off-by: Ricardo M. Oliveira <[email protected]> * Setup KF Model Registry GH tests Signed-off-by: Andrea Lamparelli <[email protected]> Signed-off-by: Ricardo M. Oliveira <[email protected]> --------- Signed-off-by: Ricardo M. Oliveira <[email protected]> Signed-off-by: Andrea Lamparelli <[email protected]> Co-authored-by: Andrea Lamparelli <[email protected]>
doncorsean · Jul 18, 2024 · 2278a92 · 2278a92
1 parent 0cf6a01
commit 2278a92
Show file tree

Hide file tree

Showing 28 changed files with 625 additions and 29 deletions.
diff --git a/.github/workflows/model_registry_test.yaml b/.github/workflows/model_registry_test.yaml
@@ -0,0 +1,42 @@
+# If anyone changes or improve the following tests for Model Registry, please 
+# consider reflecting the same changes on https://github.com/kubeflow/model-registry
+name: Deploy and test Kubeflow Model Registry
+on:
+  pull_request:
+    paths:
+      - apps/model-registry/upstream/**
+      - tests/gh-actions/kind-cluster.yaml
+      - tests/gh-actions/install_istio.sh
+
+jobs:
+  build-kfmr:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Install KinD
+      run: ./tests/gh-actions/install_kind.sh
+
+    - name: Create KinD Cluster
+      run: kind create cluster --config tests/gh-actions/kind-cluster.yaml
+
+    - name: Install kustomize
+      run: ./tests/gh-actions/install_kustomize.sh
+
+    - name: Install Istio
+      run: ./tests/gh-actions/install_istio.sh
+
+    - name: Create kubeflow namespace
+      run: kustomize build common/kubeflow-namespace/base | kubectl apply -f -
+
+    - name: Build & Apply KF Model Registry manifests
+      run: |
+        kustomize build apps/model-registry/upstream/overlays/db | kubectl apply -f -
+        kustomize build apps/model-registry/upstream/options/istio | kubectl apply -f -
+
+    - name: Test KF Model Registry deployment
+      run: |
+        echo "Waiting for all Model Registry Pods to become ready..."
+        kubectl wait --for=condition=available -n kubeflow deployment/model-registry-db --timeout=600s
+        kubectl wait --for=condition=available -n kubeflow deployment/model-registry-deployment --timeout=600s
diff --git a/README.md b/README.md
@@ -59,7 +59,7 @@ This repo periodically syncs all official Kubeflow components from their respect
 | KServe Models Web App | contrib/kserve/models-web-app | [v0.10.0](https://github.com/kserve/models-web-app/tree/v0.10.0/config) |
 | Kubeflow Pipelines | apps/pipeline/upstream | [2.2.0](https://github.com/kubeflow/pipelines/tree/2.2.0/manifests/kustomize) |
 | Kubeflow Tekton Pipelines | apps/kfp-tekton/upstream | [2.0.5](https://github.com/kubeflow/kfp-tekton/tree/2.0.5/manifests/kustomize) |
-| Kubeflow Model Registry | apps/model-registry/upstream | [main](https://github.com/kubeflow/model-registry/tree/main/manifests/kustomize) |
+| Kubeflow Model Registry | apps/model-registry/upstream | [v0.2.0-alpha](https://github.com/kubeflow/model-registry/tree/v0.2.0-alpha/manifests/kustomize) |
 
 The following is also a matrix with versions from common components that are
 used from the different projects of Kubeflow:

diff --git a/apps/model-registry/upstream/OWNERS b/apps/model-registry/upstream/OWNERS
@@ -0,0 +1,8 @@
+approvers:
+  - tarilabs
+  - rareddy
+  - Tomcli
+reviewers:
+  - tarilabs
+  - rareddy
+  - Tomcli
diff --git a/apps/model-registry/upstream/README.md b/apps/model-registry/upstream/README.md
@@ -0,0 +1,56 @@
+# Install Kubeflow Model Registry
+
+This folder contains [Kubeflow Model Registry](https://www.kubeflow.org/docs/components/model-registry/installation/) Kustomize manifests
+
+## Installation
+
+To install Kubeflow Model Registry, follow [Kubeflow Model Registry deployment documentation](https://www.kubeflow.org/docs/components/model-registry/installation/)
+
+The following instructions will summarize how to deploy Model Registry as separate component in the context of a default Kubeflow >=1.8 installation.
+
+```bash
+kubectl apply -k overlays/db
+```
+
+As the default Kubeflow installation provides an Istio mesh, apply the necessary manifests:
+
+```bash
+kubectl apply -k options/istio
+```
+
+Check everything is up and running:
+
+```bash
+kubectl wait --for=condition=available -n kubeflow deployment/model-registry-deployment --timeout=2m
+kubectl logs -n kubeflow deployment/model-registry-deployment
+```
+
+Optionally, you can also port-forward the REST API container port of Model Registry to interact with it from your terminal:
+
+```bash
+kubectl port-forward svc/model-registry-service -n kubeflow 8081:8080
+```
+
+And then, from another terminal:
+
+```bash
+curl -sX 'GET' \
+  'http://localhost:8081/api/model_registry/v1alpha3/registered_models?pageSize=100&orderBy=ID&sortOrder=DESC' \
+  -H 'accept: application/json' | jq
+```
+
+## Usage
+
+For a basic usage of the Kubeflow Model Registry, follow the [Kubeflow Model Registry getting started documentation](https://www.kubeflow.org/docs/components/model-registry/getting-started/)
+
+## Uninstall
+
+To uninstall the Kubeflow Model Registry run:
+
+```bash
+# Delete istio options
+kubectl delete -k options/istio
+
+# Delete model registry db and deployment
+kubectl delete -k overlays/db
+```
diff --git a/apps/model-registry/upstream/base/kustomization.yaml b/apps/model-registry/upstream/base/kustomization.yaml
@@ -0,0 +1,7 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+  - model-registry-configmap.yaml
+  - model-registry-deployment.yaml
+  - model-registry-service.yaml
+  - model-registry-sa.yaml
diff --git a/apps/model-registry/upstream/base/model-registry-configmap.yaml b/apps/model-registry/upstream/base/model-registry-configmap.yaml
@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: model-registry-configmap
+  labels:
+    component: model-registry-server
+data:
+  MODEL_REGISTRY_REST_SERVICE_HOST: "model-registry-service"
+  MODEL_REGISTRY_REST_SERVICE_PORT: "8080"
+  MODEL_REGISTRY_GRPC_SERVICE_HOST: "model-registry-service"
+  MODEL_REGISTRY_GRPC_SERVICE_PORT: "9090"
diff --git a/apps/model-registry/upstream/base/model-registry-deployment.yaml b/apps/model-registry/upstream/base/model-registry-deployment.yaml
@@ -0,0 +1,103 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: model-registry-deployment
+  labels:
+    component: model-registry-server
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      component: model-registry-server
+  template:
+    metadata:
+      labels:
+        component: model-registry-server
+    spec:
+      containers:
+        - name: rest-container
+          args:
+            - --hostname=0.0.0.0
+            - --port=8080
+            - --mlmd-hostname=localhost
+            - --mlmd-port=9090
+          command:
+            - /model-registry
+            - proxy
+          image: kubeflow/model-registry:latest
+          # empty placeholder environment for patching
+          env: []
+          ports:
+            - name: http-api
+              containerPort: 8080
+          livenessProbe:
+            initialDelaySeconds: 30
+            periodSeconds: 5
+            tcpSocket:
+              port: http-api
+            timeoutSeconds: 2
+          readinessProbe:
+            initialDelaySeconds: 3
+            periodSeconds: 5
+            tcpSocket:
+              port: http-api
+            timeoutSeconds: 2
+        - name: grpc-container
+          # ! Sync to the same MLMD version:
+          # * backend/metadata_writer/requirements.in and requirements.txt
+          # * @kubeflow/frontend/src/mlmd/generated
+          # * .cloudbuild.yaml and .release.cloudbuild.yaml
+          # * manifests/kustomize/base/metadata/base/model-registry-deployment.yaml
+          # * test/tag_for_hosted.sh
+          image: gcr.io/tfx-oss-public/ml_metadata_store_server:1.14.0
+          env:
+          - name: DBCONFIG_USER
+            valueFrom:
+              secretKeyRef:
+                name: mysql-secret
+                key: username
+          - name: DBCONFIG_PASSWORD
+            valueFrom:
+              secretKeyRef:
+                name: mysql-secret
+                key: password
+          - name: MYSQL_DATABASE
+            valueFrom:
+              configMapKeyRef:
+                name: pipeline-install-config
+                key: mlmdDb
+          - name: MYSQL_HOST
+            valueFrom:
+              configMapKeyRef:
+                name: pipeline-install-config
+                key: dbHost
+          - name: MYSQL_PORT
+            valueFrom:
+              configMapKeyRef:
+                name: pipeline-install-config
+                key: dbPort
+          command: ["/bin/metadata_store_server"]
+          args: ["--grpc_port=9090",
+                 "--mysql_config_database=$(MYSQL_DATABASE)",
+                 "--mysql_config_host=$(MYSQL_HOST)",
+                 "--mysql_config_port=$(MYSQL_PORT)",
+                 "--mysql_config_user=$(DBCONFIG_USER)",
+                 "--mysql_config_password=$(DBCONFIG_PASSWORD)",
+                 "--enable_database_upgrade=true"
+                 ]
+          ports:
+          - name: grpc-api
+            containerPort: 9090
+          livenessProbe:
+            tcpSocket:
+              port: grpc-api
+            initialDelaySeconds: 3
+            periodSeconds: 5
+            timeoutSeconds: 2
+          readinessProbe:
+            tcpSocket:
+              port: grpc-api
+            initialDelaySeconds: 3
+            periodSeconds: 5
+            timeoutSeconds: 2
+      serviceAccountName: model-registry-server
diff --git a/apps/model-registry/upstream/base/model-registry-sa.yaml b/apps/model-registry/upstream/base/model-registry-sa.yaml
@@ -0,0 +1,4 @@
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: model-registry-server
diff --git a/apps/model-registry/upstream/base/model-registry-service.yaml b/apps/model-registry/upstream/base/model-registry-service.yaml
@@ -0,0 +1,17 @@
+kind: Service
+apiVersion: v1
+metadata:
+  labels:
+    app: metadata
+  name: model-registry-service
+spec:
+  selector:
+    component: model-registry-server
+  type: ClusterIP
+  ports:
+  - port: 8080
+    protocol: TCP
+    name: http-api
+  - port: 9090
+    protocol: TCP
+    name: grpc-api
diff --git a/apps/model-registry/upstream/options/istio/destination-rule.yaml b/apps/model-registry/upstream/options/istio/destination-rule.yaml
@@ -0,0 +1,9 @@
+apiVersion: networking.istio.io/v1alpha3
+kind: DestinationRule
+metadata:
+  name: model-registry-service
+spec:
+  host: model-registry-service.kubeflow.svc.cluster.local
+  trafficPolicy:
+    tls:
+      mode: ISTIO_MUTUAL
diff --git a/apps/model-registry/upstream/options/istio/istio-authorization-policy.yaml b/apps/model-registry/upstream/options/istio/istio-authorization-policy.yaml
@@ -0,0 +1,11 @@
+apiVersion: security.istio.io/v1beta1
+kind: AuthorizationPolicy
+metadata:
+  name: model-registry-service
+spec:
+  action: ALLOW
+  selector:
+    matchLabels:
+      component: model-registry-server
+  rules:
+  - {}
diff --git a/apps/model-registry/upstream/options/istio/kustomization.yaml b/apps/model-registry/upstream/options/istio/kustomization.yaml
@@ -0,0 +1,8 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+namespace: kubeflow
+
+resources:
+- istio-authorization-policy.yaml
+- destination-rule.yaml
+- virtual-service.yaml
diff --git a/apps/model-registry/upstream/options/istio/virtual-service.yaml b/apps/model-registry/upstream/options/istio/virtual-service.yaml
@@ -0,0 +1,24 @@
+apiVersion: networking.istio.io/v1alpha3
+kind: VirtualService
+metadata:
+  name: model-registry
+spec:
+  gateways:
+  - kubeflow-gateway
+  hosts:
+  - '*'
+  tcp:
+  - match:
+    - port: 8080
+    route:
+    - destination:
+        host: model-registry-service.kubeflow.svc.cluster.local
+        port:
+          number: 8080
+  - match:
+      - port: 9090
+    route:
+      - destination:
+          host: model-registry-service.kubeflow.svc.cluster.local
+          port:
+            number: 9090
diff --git a/apps/model-registry/upstream/overlays/db/kustomization.yaml b/apps/model-registry/upstream/overlays/db/kustomization.yaml
@@ -0,0 +1,38 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+namespace: kubeflow
+
+resources:
+- model-registry-db-pvc.yaml
+- model-registry-db-deployment.yaml
+- model-registry-db-service.yaml
+- ../../base
+
+patchesStrategicMerge:
+- patches/model-registry-deployment.yaml
+
+configMapGenerator:
+- envs:
+  - params.env
+  name: model-registry-db-parameters
+secretGenerator:
+- envs:
+  - secrets.env
+  name: model-registry-db-secrets
+generatorOptions:
+  disableNameSuffixHash: true
+
+
+images:
+- name: mysql
+  newName: mysql
+  newTag: 8.0.3
+
+vars:
+- fieldref:
+    fieldPath: metadata.name
+  name: MLMD_DB_HOST
+  objref:
+    apiVersion: v1
+    kind: Service
+    name: model-registry-db