Merge pull request #8218 from OpenMined/reset-protocol

reset protocol version json to dev
OpenMined · Nov 3, 2023 · cd2c0bf · cd2c0bf
2 parents 64b9dc3 + d61ac37
commit cd2c0bf
Show file tree

Hide file tree

Showing 3 changed files with 183 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -81,7 +81,7 @@ 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
+$ helm install my-domain openmined/syft --version $SYFT_VERSION --namespace syft --create-namespace --set ingress.ingressClass=traefik
 ```
 
 ### Azure or GCP Ingress

diff --git a/...data-engineer/11-upgrading-via-helm.ipynb → ...1-installing-and-upgrading-via-helm.ipynb b/...data-engineer/11-upgrading-via-helm.ipynb → ...1-installing-and-upgrading-via-helm.ipynb
@@ -1,5 +1,151 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "7c890e5b",
+   "metadata": {},
+   "source": [
+    "# Installing using Helm"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "4f07a05f",
+   "metadata": {},
+   "source": [
+    "## Add Helm Repo"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7802e064",
+   "metadata": {},
+   "source": [
+    "```bash\n",
+    "helm repo add openmined https://openmined.github.io/PySyft/helm\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "42898283",
+   "metadata": {},
+   "source": [
+    "## Update Repo"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "6368632b",
+   "metadata": {},
+   "source": [
+    "```bash\n",
+    "helm repo update openmined\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "92ac9973",
+   "metadata": {},
+   "source": [
+    "## Search for available Chart versions"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "82a0cf01",
+   "metadata": {},
+   "source": [
+    "### Search for available versions¶"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e115024d",
+   "metadata": {},
+   "source": [
+    "```bash\n",
+    "helm search repo openmined/syft --versions --devel\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b2a209fb",
+   "metadata": {},
+   "source": [
+    "### Set the version to install"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "ebb864aa",
+   "metadata": {},
+   "source": [
+    "```bash\n",
+    "export SYFT_VERSION=\"<paste your version here>\"\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "3aa153e6",
+   "metadata": {},
+   "source": [
+    "## Setup a registry"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "eb6413f3",
+   "metadata": {},
+   "source": [
+    "One needs to setup a registry either locally or on the cloud. To set one up locally, one can follow the following commands."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "918ddade",
+   "metadata": {},
+   "source": [
+    "```bash\n",
+    "k3d registry create registry.localhost --port 12345  -v `pwd`/k3d-registry:/var/lib/registry || true\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9c165a7f",
+   "metadata": {},
+   "source": [
+    "Setup a load balancer\n",
+    "\n",
+    "```bash\n",
+    "NODE_NAME=syft NODE_PORT=8080 && \\\n",
+    "k3d cluster create syft -p \"$NODE_PORT:80@loadbalancer\" --registry-use k3d-registry.localhost || true \\\n",
+    "k3d cluster start syft\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "8d2cf05f",
+   "metadata": {},
+   "source": [
+    "## Install using Helm"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "44fff50f",
+   "metadata": {},
+   "source": [
+    "```bash\n",
+    "helm install my-domain openmined/syft --version $SYFT_VERSION --namespace syft --create-namespace --set ingress.ingressClass=traefik\n",
+    "```"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "1721a9b0",
@@ -84,7 +230,7 @@
    "metadata": {},
    "source": [
     "```bash\n",
-    "export TARGET_VERSION=\"\"\n",
+    "export TARGET_VERSION=\"<paste your target version>\"\n",
     "```"
    ]
   },
@@ -104,8 +250,8 @@
     "Set the release name and namespace\n",
     "\n",
     "```bash\n",
-    "export RELEASE_NAME=syft\n",
-    "export NAMESPACE=syft\n",
+    "export RELEASE_NAME=\"<paste the release name>\"\n",
+    "export NAMESPACE=\"<paste the namespace>\"\n",
     "```"
    ]
   },
@@ -155,7 +301,7 @@
    "metadata": {},
    "source": [
     "```bash\n",
-    "kubectl describe sts $RELEASE_NAME --namespace $NAMESPACE | grep 'Replicas'\n",
+    "kubectl describe sts --namespace $NAMESPACE | grep 'Replicas'\n",
     "```"
    ]
   },

diff --git a/packages/syft/src/syft/protocol/protocol_version.json b/packages/syft/src/syft/protocol/protocol_version.json
@@ -1,5 +1,5 @@
 {
-  "1": {
+  "dev": {
     "object_versions": {
       "PartialSyftObject": {
         "1": {
@@ -25,6 +25,32 @@
           "version": 2,
           "hash": "f856169fea72486cd436875ce4411ef935da11eb7c5af48121adfa00d4c0cdb6",
           "action": "add"
+        },
+        "3": {
+          "version": 3,
+          "hash": "3cc67abf394a805066a88aef0bea15bde609b9ecbe7ec15172eac5e7a0b7ef7c",
+          "action": "add"
+        }
+      },
+      "StoreConfig": {
+        "1": {
+          "version": 1,
+          "hash": "17de8875cf590311ddb042140347ffc79d4a85028e504dad178ca4e1237ec861",
+          "action": "add"
+        }
+      },
+      "MongoDict": {
+        "1": {
+          "version": 1,
+          "hash": "640734396edae801e1601fe7777710e67685e552acb0244ad8b4f689599baca9",
+          "action": "add"
+        }
+      },
+      "MongoStoreConfig": {
+        "1": {
+          "version": 1,
+          "hash": "e52aa382e300b0b69aaa2d80aadb4e3a9a3c02b3c741b71d56f959c4d3891ce5",
+          "action": "add"
         }
       },
       "LinkedObject": {
@@ -146,13 +172,6 @@
           "action": "add"
         }
       },
-      "StoreConfig": {
-        "1": {
-          "version": 1,
-          "hash": "17de8875cf590311ddb042140347ffc79d4a85028e504dad178ca4e1237ec861",
-          "action": "add"
-        }
-      },
       "NodeSettingsUpdate": {
         "1": {
           "version": 1,
@@ -165,6 +184,11 @@
           "version": 1,
           "hash": "b662047bb278f4f5db77c102f94b733c3a929839271b3d6b82ea174a60e2aaf0",
           "action": "add"
+        },
+        "2": {
+          "version": 2,
+          "hash": "29a82afcb006a044b6ae04c6ea8a067d145d28b4210bb038ea9fa86ebde108c8",
+          "action": "add"
         }
       },
       "HTTPConnection": {
@@ -720,20 +744,6 @@
           "action": "add"
         }
       },
-      "MongoDict": {
-        "1": {
-          "version": 1,
-          "hash": "640734396edae801e1601fe7777710e67685e552acb0244ad8b4f689599baca9",
-          "action": "add"
-        }
-      },
-      "MongoStoreConfig": {
-        "1": {
-          "version": 1,
-          "hash": "e52aa382e300b0b69aaa2d80aadb4e3a9a3c02b3c741b71d56f959c4d3891ce5",
-          "action": "add"
-        }
-      },
       "SQLiteStoreConfig": {
         "1": {
           "version": 1,
@@ -749,23 +759,5 @@
         }
       }
     }
-  },
-  "2": {
-    "object_versions": {
-      "NodeMetadata": {
-        "3": {
-          "version": 3,
-          "hash": "3cc67abf394a805066a88aef0bea15bde609b9ecbe7ec15172eac5e7a0b7ef7c",
-          "action": "add"
-        }
-      },
-      "NodeSettings": {
-        "2": {
-          "version": 2,
-          "hash": "29a82afcb006a044b6ae04c6ea8a067d145d28b4210bb038ea9fa86ebde108c8",
-          "action": "add"
-        }
-      }
-    }
   }
 }