Update readme to include migration guide for users on the 0.x helm ch…

…art (#197) * Update readme to include migration guide for users on the 0.x helm chart --------- Co-authored-by: Grant Zyskowski <[email protected]>
superblocksteam · Oct 11, 2023 · 94ea152 · 94ea152
1 parent 23de221
commit 94ea152
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,6 @@
 
 <br/>
 
-
 This document contains configuration and deployment details for running the Superblocks agent independently.
 
 **DISCLAIMER**: Parts of this document currently refer to an `agent` service that has been deprecated in favor of the Superblocks Agent Platform. We have introduced an `agent-controller` service and an `agent-worker` service. For now, you can find updated information in linked repositories of the [Source-Available Repositories](#source-available-repositories) section. We are currently in the process of updating the other sections of this document.
@@ -41,11 +40,68 @@ helm repo update
 helm upgrade -i -n superblocks superblocks-agent superblocks/superblocks-agent \
   --create-namespace \
   --set superblocks.agentKey='<agent-key>' # obtained during agent onboarding \
-  --set superblocks.agentHostUrl='http[s]://<agent-host[:port]>/agent' \
-  --set superblocks.agentEnvironment='<"*"|"staging"|"production">' \
+  --set superblocks.agentHostUrl='http[s]://<agent-host[:port]>' \
+  --set superblocks.agentTags='<"profile:*"|"profile:staging"|"profile:production">' \
   --set superblocks.agentDataDomain='<"app.superblocks.com"|"eu.superblocks.com">'
 ```
 
+#### v0.x to v1.0 Migration Guide
+
+* Container ports are now specified under `service.ports.http`. It is recommended that you leave these settings as default.
+* Agent URL field `superblocks.agentUrl` must be updated from `https://myagent.example.com/agent` to `https://myagent.example.com`. The new OPA no longer has the `agent` suffix path on its endpoints.
+* Agent Environment variable `superblocks.agentEnvironment` is deprecated and you must start using `superblocks.agentTags`.
+  * `superblocks.agentEnvironment: "*"` is equivalent to `superblocks.agentTags: "profile:*"`
+  * `superblocks.agentEnvironment: "staging"` is equivalent to `superblocks.agentTags: "profile:staging"`
+  * `superblocks.agentEnvironment: "production"` is equivalent to `superblocks.agentTags: "profile:production"`
+* The `controller` block in the values file is deprecated. Everything underneath can be specified one level higher. You can simply delete the `controller` block and unindent everything underneath it.
+
+  For example:
+
+  ```yaml
+  controller:
+    ingress:
+      enabled: false
+      class: "" # nginx
+      annotations: {}
+        # kubernetes.io/tls-acme: "true"
+      hosts: []
+      # - host: chart-example.local
+      #   paths:
+      #   - /
+      tls: []
+      # - secretName: chart-example-tls
+      #   hosts:
+      #     - chart-example.local
+  ```
+
+  will become
+
+  ```yaml
+  ingress:
+    enabled: false
+    class: "" # nginx
+    annotations: {}
+      # kubernetes.io/tls-acme: "true"
+    hosts: []
+    # - host: chart-example.local
+    #   paths:
+    #   - /
+    tls: []
+    # - secretName: chart-example-tls
+    #   hosts:
+    #     - chart-example.local
+  ```
+
+* If you are managing your secrets outside of this chart, you will ensure that you have added an additional entry to your secrets object. It should look something like this:
+
+  ```yaml
+  apiVersion: v1
+  data:
+    SUPERBLOCKS_AGENT_KEY: <my-agent-key-in-b64>
+    SUPERBLOCKS_ORCHESTRATOR_SUPERBLOCKS_KEY: <my-agent-key-in-b64>
+  kind: Secret
+  ```
+
 ### docker
 
 The Superblocks agent can also be deployed using the docker CLI.
@@ -55,15 +111,15 @@ To do so, first export the agent configuration.
 ```sh
 # obtained during agent onboarding
 export SUPERBLOCKS_AGENT_KEY='<agent-key>'
-export SUPERBLOCKS_AGENT_HOST_URL='http[s]://<agent-host[:port]>/agent'
-export SUPERBLOCKS_AGENT_ENVIRONMENT='<"*"|"staging"|"production">'
+export SUPERBLOCKS_AGENT_HOST_URL='http[s]://<agent-host[:port]>'
+export SUPERBLOCKS_AGENT_TAGS='<"profile:*"|"profile:staging"|"profile:production">'
 export SUPERBLOCKS_AGENT_DATA_DOMAIN='<"app.superblocks.com"|"eu.superblocks.com">'
 ```
 
-Then, use our docker compose file to start the agent platform. The referenced docker compose file can be found [here](./docker/compose.yaml).
+Then, use our docker compose file to start the agent platform. The referenced docker compose file can be found [here](./docker/v2.compose.yaml).
 
 ```sh
-curl -s https://raw.githubusercontent.com/superblocksteam/agent/main/docker/compose.yaml | docker compose -p superblocks -f - up
+curl -s https://raw.githubusercontent.com/superblocksteam/agent/main/docker/v2.compose.yaml | docker compose -p superblocks -f - up
 ```
 
 ## Requests
@@ -83,32 +139,32 @@ The following is a comprehensive list of repositories required to build the agen
 
 ### Services
 
-- [superblocksteam/agent-controller](https://github.com/superblocksteam/agent-controller) - [Docs](https://docs.superblocks.com/on-premise-agent/overview)
-- [superblocksteam/agent-worker](https://github.com/superblocksteam/agent-worker) - [Docs](https://docs.superblocks.com/on-premise-agent/overview)
+* [superblocksteam/agent-controller](https://github.com/superblocksteam/agent-controller) - [Docs](https://docs.superblocks.com/on-premise-agent/overview)
+* [superblocksteam/agent-worker](https://github.com/superblocksteam/agent-worker) - [Docs](https://docs.superblocks.com/on-premise-agent/overview)
 
 ### Integrations
 
-- [superblocksteam/bigquery](https://github.com/superblocksteam/bigquery) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/bigquery)
-- [superblocksteam/dynamodb](https://github.com/superblocksteam/dynamodb) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/dynamodb)
-- [superblocksteam/email](https://github.com/superblocksteam/email)
-- [superblocksteam/graphql](https://github.com/superblocksteam/graphql) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/graphql-apis)
-- [superblocksteam/gsheets](https://github.com/superblocksteam/gsheets) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/google-sheets)
-- [superblocksteam/javascript](https://github.com/superblocksteam/javascript) - [Docs](https://docs.superblocks.com/build-applications/build-apis-with-data/write-javascript-business-logic)
-- [superblocksteam/mariadb](https://github.com/superblocksteam/mariadb) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/mariadb)
-- [superblocksteam/mongodb](https://github.com/superblocksteam/mongodb) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/mongodb)
-- [superblocksteam/mssql](https://github.com/superblocksteam/mssql) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/mssql)
-- [superblocksteam/mysql](https://github.com/superblocksteam/mysql) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/mysql)
-- [superblocksteam/postgres](https://github.com/superblocksteam/postgres) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/postgres)
-- [superblocksteam/python](https://github.com/superblocksteam/python) - [Docs](https://docs.superblocks.com/build-applications/build-apis-with-data/write-python-business-logic)
-- [superblocksteam/redshift](https://github.com/superblocksteam/redshift) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/redshift)
-- [superblocksteam/restapi](https://github.com/superblocksteam/restapi) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/rest-apis)
-- [superblocksteam/restapiintegration](https://github.com/superblocksteam/restapiintegration) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/rest-apis)
-- [superblocksteam/rockset](https://github.com/superblocksteam/rockset) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/rockset)
-- [superblocksteam/s3](https://github.com/superblocksteam/s3) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/s3)
-- [superblocksteam/snowflake](https://github.com/superblocksteam/snowflake) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/snowflake)
-- [superblocksteam/workflow](https://github.com/superblocksteam/workflow) - [Docs](https://docs.superblocks.com/build-workflows/what-is-a-workflow#1c-workflow-steps)
+* [superblocksteam/bigquery](https://github.com/superblocksteam/bigquery) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/bigquery)
+* [superblocksteam/dynamodb](https://github.com/superblocksteam/dynamodb) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/dynamodb)
+* [superblocksteam/email](https://github.com/superblocksteam/email)
+* [superblocksteam/graphql](https://github.com/superblocksteam/graphql) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/graphql-apis)
+* [superblocksteam/gsheets](https://github.com/superblocksteam/gsheets) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/google-sheets)
+* [superblocksteam/javascript](https://github.com/superblocksteam/javascript) - [Docs](https://docs.superblocks.com/build-applications/build-apis-with-data/write-javascript-business-logic)
+* [superblocksteam/mariadb](https://github.com/superblocksteam/mariadb) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/mariadb)
+* [superblocksteam/mongodb](https://github.com/superblocksteam/mongodb) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/mongodb)
+* [superblocksteam/mssql](https://github.com/superblocksteam/mssql) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/mssql)
+* [superblocksteam/mysql](https://github.com/superblocksteam/mysql) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/mysql)
+* [superblocksteam/postgres](https://github.com/superblocksteam/postgres) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/postgres)
+* [superblocksteam/python](https://github.com/superblocksteam/python) - [Docs](https://docs.superblocks.com/build-applications/build-apis-with-data/write-python-business-logic)
+* [superblocksteam/redshift](https://github.com/superblocksteam/redshift) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/redshift)
+* [superblocksteam/restapi](https://github.com/superblocksteam/restapi) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/rest-apis)
+* [superblocksteam/restapiintegration](https://github.com/superblocksteam/restapiintegration) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/rest-apis)
+* [superblocksteam/rockset](https://github.com/superblocksteam/rockset) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/rockset)
+* [superblocksteam/s3](https://github.com/superblocksteam/s3) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/s3)
+* [superblocksteam/snowflake](https://github.com/superblocksteam/snowflake) - [Docs](https://docs.superblocks.com/integrations/connect-integrations/snowflake)
+* [superblocksteam/workflow](https://github.com/superblocksteam/workflow) - [Docs](https://docs.superblocks.com/build-workflows/what-is-a-workflow#1c-workflow-steps)
 
 ### Libraries
 
-- [superblocksteam/shared](https://github.com/superblocksteam/shared)
-- [superblocksteam/shared-backend](https://github.com/superblocksteam/shared-backend)
+* [superblocksteam/shared](https://github.com/superblocksteam/shared)
+* [superblocksteam/shared-backend](https://github.com/superblocksteam/shared-backend)
diff --git a/docker/v2.compose.yaml b/docker/v2.compose.yaml
@@ -5,7 +5,6 @@ x-environment: &environment
   SUPERBLOCKS_ORCHESTRATOR_SUPERBLOCKS_KEY: ${SUPERBLOCKS_AGENT_KEY}
   SUPERBLOCKS_AGENT_KEY: ${SUPERBLOCKS_AGENT_KEY}
   # OPTIONAL
-  SUPERBLOCKS_ORCHESTRATOR_AGENT_ENVIRONMENT: ${SUPERBLOCKS_AGENT_ENVIRONMENT:-*}
   SUPERBLOCKS_ORCHESTRATOR_AGENT_TAGS: ${SUPERBLOCKS_AGENT_TAGS}
   SUPERBLOCKS_ORCHESTRATOR_AGENT_HOST_URL: ${SUPERBLOCKS_AGENT_HOST_URL:-http://localhost:8080}
   SUPERBLOCKS_ORCHESTRATOR_HTTP_PORT: ${SUPERBLOCKS_AGENT_PORT:-8080}

diff --git a/helm/v2/templates/deployment.yaml b/helm/v2/templates/deployment.yaml
@@ -71,7 +71,6 @@ spec:
         - "--intake.metadata.url=https://metadata.intake.superblocks.com"
         - "--file.server.url=http://127.0.0.1:{{$.Values.service.ports.http}}/v2/files"
         - "--agent.host.url={{ required "superblocks.agentHostUrl is required!" .Values.superblocks.agentHostUrl }}"
-        - "--agent.environment={{ default "*" .Values.superblocks.agentEnvironment  }}"
         - "--agent.tags={{ default "profile:*" .Values.superblocks.agentTags }}"
         {{- include "verify.datadomain" $ }}
         - "--data.domain={{ default "app.superblocks.com" .Values.superblocks.agentDataDomain  }}"

diff --git a/helm/v2/values.yaml b/helm/v2/values.yaml
@@ -6,7 +6,6 @@ superblocks:
   serverUrl: https://api.superblocks.com
   # agentKey: ""
   # agentHostUrl: "http[s]://<agent-host[:port]>"
-  # agentEnvironment: <"*"|"staging"|"production">
   # agentDataDomain: <"app.superblocks.com"|"eu.superblocks.com">
 
   # Existing agentKey secret must contain the value:
@@ -90,9 +89,6 @@ ingress:
   # - host: chart-example.local
   #   paths:
   #   - /
-  #   - path: /agent
-  #     pathType: Prefix
-  #   - path: /health
   tls: []
   # - secretName: chart-example-tls
   #   hosts: