Merge branch 'dev' into issue-955

OpenMined · Feb 7, 2024 · 3d37857 · 3d37857
2 parents b25a01f + d10873f
commit 3d37857
Show file tree

Hide file tree

Showing 26 changed files with 622 additions and 381 deletions.
diff --git a/README.md b/README.md
@@ -81,14 +81,27 @@ SYFT_VERSION="<paste the chart version number>"
 #### 4. Provisioning Helm Charts
 
 ```sh
-helm install my-domain openmined/syft --version $SYFT_VERSION --namespace syft --create-namespace --set ingress.ingressClass=traefik
+helm install my-domain openmined/syft --version $SYFT_VERSION --namespace syft --create-namespace --set ingress.className="traefik"
 ```
 
-### Azure or GCP Ingress
+### Ingress Controllers
 
+For Azure AKS
+
+```sh
+helm install ... --set ingress.className="azure-application-gateway"
 ```
-helm install ... --set ingress.ingressClass="azure/application-gateway"
-helm install ... --set ingress.ingressClass="gce"
+
+For AWS EKS
+
+```sh
+helm install ... --set ingress.className="alb"
+```
+
+For Google GKE we need the [`gce` annotation](https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress#create-ingress) annotation.
+
+```sh
+helm install ... --set ingress.class="gce"
 ```
 
 ## Deploy to a Container Engine or Cloud

diff --git a/notebooks/tutorials/data-engineer/11-installing-and-upgrading-via-helm.ipynb b/notebooks/tutorials/data-engineer/11-installing-and-upgrading-via-helm.ipynb
@@ -142,7 +142,7 @@
    "metadata": {},
    "source": [
     "```bash\n",
-    "helm install my-domain openmined/syft --version $SYFT_VERSION --namespace syft --create-namespace --set ingress.ingressClass=traefik\n",
+    "helm install my-domain openmined/syft --version $SYFT_VERSION --namespace syft --create-namespace --set ingress.className=traefik\n",
     "```"
    ]
   },

diff --git a/packages/grid/devspace.yaml b/packages/grid/devspace.yaml
@@ -66,8 +66,8 @@ deployments:
         syft:
           registry: ${CONTAINER_REGISTRY}
           version: dev-${DEVSPACE_TIMESTAMP}
-        workerBuilds:
-          mountInBackend: true
+        registry:
+          maxStorage: "5Gi"
         node:
           settings:
             nodeName: ${NODE_NAME}

diff --git a/packages/grid/helm/syft/templates/backend-service-account.yaml b/packages/grid/helm/syft/templates/backend-service-account.yaml
@@ -2,7 +2,6 @@ apiVersion: v1
 kind: ServiceAccount
 metadata:
   name: backend-service-account
-  namespace: {{ .Release.Namespace }}
   labels:
     app.kubernetes.io/name: {{ .Chart.Name }}
     app.kubernetes.io/version: {{ .Chart.AppVersion }}
@@ -14,7 +13,6 @@ apiVersion: v1
 kind: Secret
 metadata:
   name: backend-service-secret
-  namespace: {{ .Release.Namespace }}
   annotations:
     kubernetes.io/service-account.name: "backend-service-account"
   labels:
@@ -29,7 +27,6 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: Role
 metadata:
   name: backend-service-role
-  namespace: {{ .Release.Namespace }}
   labels:
     app.kubernetes.io/name: {{ .Chart.Name }}
     app.kubernetes.io/version: {{ .Chart.AppVersion }}
@@ -53,15 +50,13 @@ apiVersion: rbac.authorization.k8s.io/v1
 kind: RoleBinding
 metadata:
   name: backend-service-role-binding
-  namespace: {{ .Release.Namespace }}
   labels:
     app.kubernetes.io/name: {{ .Chart.Name }}
     app.kubernetes.io/version: {{ .Chart.AppVersion }}
     app.kubernetes.io/managed-by: Helm
 subjects:
   - kind: ServiceAccount
     name: backend-service-account
-    namespace: {{ .Release.Namespace }}
 roleRef:
   kind: Role
   name: backend-service-role

diff --git a/packages/grid/helm/syft/templates/backend-statefulset.yaml b/packages/grid/helm/syft/templates/backend-statefulset.yaml
@@ -136,12 +136,6 @@ spec:
           name: credentials-data
           readOnly: false
           subPath: credentials-data
-        {{- if .Values.workerBuilds.mountInBackend }}
-        # mount for debugging and inspection of worker-build volume
-        - mountPath: /root/data/images/
-          name: worker-builds
-          readOnly: true
-        {{- end }}
       dnsConfig: null
       ephemeralContainers: null
       hostAliases: null
@@ -155,12 +149,6 @@ spec:
       terminationGracePeriodSeconds: 5
       tolerations: null
       topologySpreadConstraints: null
-      {{- if .Values.workerBuilds.mountInBackend }}
-      volumes:
-      - name: worker-builds
-        persistentVolumeClaim:
-          claimName: worker-builds
-      {{- end }}
   volumeClaimTemplates:
   - metadata:
       labels:

diff --git a/packages/grid/helm/syft/templates/frontend-deployment.yaml b/packages/grid/helm/syft/templates/frontend-deployment.yaml
@@ -29,7 +29,7 @@ spec:
         command: null
         env:
         - name: VERSION
-          value: {{ .Values.syft.version }}
+          value: "{{ .Values.syft.version }}"
         - name: VERSION_HASH
           value: {{ .Values.node.settings.versionHash }}
         - name: NODE_TYPE

diff --git a/packages/grid/helm/syft/templates/grid-stack-ingress-ingress.yaml b/packages/grid/helm/syft/templates/grid-stack-ingress-ingress.yaml
@@ -8,8 +8,14 @@ metadata:
     app.kubernetes.io/component: ingress
     app.kubernetes.io/managed-by: Helm
   name: grid-stack-ingress
+  {{- if .Values.ingress.class }}
+  annotations:
+    kubernetes.io/ingress.class: {{ .Values.ingress.class }}
+  {{- end }}
 spec:
-  ingressClassName: {{ .Values.ingress.ingressClass }}
+  {{- if .Values.ingress.className }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- end }}
   defaultBackend:
     service:
       name: proxy

diff --git a/packages/grid/helm/syft/templates/grid-stack-ingress-tls-ingress.yaml b/packages/grid/helm/syft/templates/grid-stack-ingress-tls-ingress.yaml
@@ -8,8 +8,14 @@ metadata:
     app.kubernetes.io/component: ingress
     app.kubernetes.io/managed-by: Helm
   name: grid-stack-ingress-tls
+  {{- if .Values.ingress.class }}
+  annotations:
+    kubernetes.io/ingress.class: {{ .Values.ingress.class }}
+  {{- end }}
 spec:
-  ingressClassName: {{ .Values.ingress.ingressClass }}
+  {{- if .Values.ingress.className }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- end }}
   defaultBackend:
     service:
       name: proxy

diff --git a/packages/grid/helm/syft/templates/registry-service.yaml b/packages/grid/helm/syft/templates/registry-service.yaml
@@ -0,0 +1,17 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: registry
+  labels:
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/version: {{ .Chart.AppVersion }}
+    app.kubernetes.io/managed-by: Helm
+spec:
+  type: ClusterIP
+  ports:
+  - protocol: TCP
+    port: 80
+    targetPort: 5000
+  selector:
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/component: registry
diff --git a/packages/grid/helm/syft/templates/registry-statefulset.yaml b/packages/grid/helm/syft/templates/registry-statefulset.yaml
@@ -0,0 +1,47 @@
+apiVersion: apps/v1
+kind: StatefulSet
+metadata:
+  name: registry
+  labels:
+    app.kubernetes.io/name: {{ .Chart.Name }}
+    app.kubernetes.io/version: {{ .Chart.AppVersion }}
+    app.kubernetes.io/component: registry
+    app.kubernetes.io/managed-by: Helm
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: {{ .Chart.Name }}
+      app.kubernetes.io/component: registry
+      app.kubernetes.io/managed-by: Helm
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: {{ .Chart.Name }}
+        app.kubernetes.io/component: registry
+        app.kubernetes.io/managed-by: Helm
+    spec:
+      containers:
+      - image: registry:2
+        name: registry
+        env:
+        - name: REGISTRY_STORAGE_DELETE_ENABLED
+          value: "true"
+        ports:
+        - containerPort: 5000
+        volumeMounts:
+        - mountPath: /var/lib/registry
+          name: registry-data
+  volumeClaimTemplates:
+  - metadata:
+      name: registry-data
+      labels:
+        app.kubernetes.io/name: {{ .Chart.Name }}
+        app.kubernetes.io/component: registry
+        app.kubernetes.io/managed-by: Helm
+    spec:
+      accessModes:
+      - ReadWriteOnce
+      resources:
+        requests:
+          storage: {{ .Values.registry.maxStorage }}
diff --git a/packages/grid/helm/syft/templates/worker-builds-pvc.yaml b/packages/grid/helm/syft/templates/worker-builds-pvc.yaml
diff --git a/packages/grid/helm/syft/values.yaml b/packages/grid/helm/syft/values.yaml
@@ -1,7 +1,3 @@
-# Default values for syft.
-# This is a YAML-formatted file.
-# Declare variables to be passed into your templates.
-
 secrets:
   syft: syft-default-secret
   mongo: mongo-default-secret
@@ -28,9 +24,8 @@ seaweedfs:
 queue:
   port: 5556
 
-workerBuilds:
+registry:
   maxStorage: "10Gi"
-  mountInBackend: false
 
 syft:
   registry: "docker.io"
@@ -49,7 +44,16 @@ node:
     inMemoryWorkers: false
     defaultWorkerPoolCount: 1
 
+# ----------------------------------------
+# For Azure
+# className: "azure-application-gateway"
+# ----------------------------------------
+# For AWS
+# className: "alb"
+# ----------------------------------------
+# For GCE, https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress#create-ingress
+# class: "gce"
+# ----------------------------------------
 ingress:
-  ingressClass: ""
-  # ingressClass: "azure/application-gateway"
-  # ingressClass: "gce"
+  class: null
+  className: null
diff --git a/packages/syft/PYPI.md b/packages/syft/PYPI.md
@@ -78,14 +78,27 @@ SYFT_VERSION="<paste the chart version number>"
 #### 4. Provisioning Helm Charts
 
 ```sh
-helm install my-domain openmined/syft --version $SYFT_VERSION --namespace syft --create-namespace --set ingress.ingressClass=traefik
+helm install my-domain openmined/syft --version $SYFT_VERSION --namespace syft --create-namespace --set ingress.className="traefik"
 ```
 
-### Azure or GCP Ingress
+### Ingress Controllers
 
+For Azure AKS
+
+```sh
+helm install ... --set ingress.className="azure-application-gateway"
 ```
-helm install ... --set ingress.ingressClass="azure/application-gateway"
-helm install ... --set ingress.ingressClass="gce"
+
+For AWS EKS
+
+```sh
+helm install ... --set ingress.className="alb"
+```
+
+For Google GKE we need the [`gce` annotation](https://cloud.google.com/kubernetes-engine/docs/how-to/load-balance-ingress#create-ingress) annotation.
+
+```sh
+helm install ... --set ingress.class="gce"
 ```
 
 ## Deploy to a Container Engine or Cloud

diff --git a/packages/syft/setup.cfg b/packages/syft/setup.cfg
@@ -62,7 +62,7 @@ syft =
     numpy>=1.23.5,<=1.24.4
     pandas==1.5.3
     docker==6.1.3
-    kr8s==0.13.0
+    kr8s==0.13.1
     PyYAML==6.0.1
     azure-storage-blob==12.19