Merge pull request #21 from TykTechnologies/split-otel-fix-manifest

split out otel and fix manifest
TykTechnologies · Dec 18, 2023 · 000e108 · 000e108
2 parents ce04b4b + 90128a7
commit 000e108
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 78 deletions.
diff --git a/.github/workflows/makefile.yml b/.github/workflows/makefile.yml
@@ -16,12 +16,9 @@ jobs:
 
     - name: Copy Env Files
       run: cp .env.example .env
-
-    - name: Build Go Plugin
-      run: make go-build
 
     - name: Bundle Go Plugin
-      run: TYK_VERSION=v5.2.0 docker-compose run --rm --entrypoint "bundle/bundle-entrypoint.sh" tyk-gateway
+      run: DOCKER_USER=root make go-bundle
 
     - name: Upload Bundle
       uses: actions/upload-artifact@v3

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 .idea/*
 tyk/middleware/bundles/*
+tyk/bundle/manifest.json
 **/.env
 **/*.so
 **/*.zip

diff --git a/Makefile b/Makefile
@@ -4,7 +4,11 @@
 #
 ###############################################################################
 
-export TYK_VERSION := v5.2.2
+export TYK_VERSION := v5.2.4
+
+ifeq ($(origin DOCKER_USER), undefined)
+DOCKER_USER := 1000
+endif
 
 # Default task: sets up development environment
 install: up build
@@ -26,9 +30,15 @@ log: docker-gateway-log
 # Brings up the project - Pro
 up: docker-up bootstrap docker-status
 
+# Brings up the project - Pro w/ oTel
+up-otel: docker-up-otel bootstrap docker-status
+
 # Brings up the project - OSS
 up-oss: docker-up-oss bootstrap-oss docker-status
 
+# Brings up the project - OSS w/ oTel
+up-oss-otel: docker-up-oss-otel bootstrap-oss docker-status
+
 # Brings down the project
 down: docker-down docker-status
 
@@ -60,6 +70,21 @@ docker-gateway-log:
 docker-up:
 	docker-compose up -d --remove-orphans tyk-dashboard tyk-gateway
 
+# Bring docker containers up /w oTel
+.PHONY: docker-up-otel
+docker-up-otel:
+	docker-compose -f docker-compose.yml -f deployments/otel/docker-compose.yml up -d --remove-orphans tyk-dashboard tyk-gateway
+
+# Bring docker containers up in OSS
+.PHONY: docker-up-oss
+docker-up-oss:
+	docker-compose -f docker-compose-oss.yml up -d --remove-orphans tyk-gateway
+
+# Bring docker containers up in OSS /w oTel
+.PHONY: docker-up-oss-otel
+docker-up-oss-otel:
+	docker-compose -f docker-compose-oss.yml -f deployments/otel/docker-compose.yml up -d --remove-orphans tyk-gateway
+
 # Bootstrap dashboard
 .PHONY: bootstrap
 bootstrap:
@@ -116,7 +141,9 @@ coverage:
 # Builds production-ready Go plugin bundle as non-root user, using Tyk Bundler tool
 .PHONY: go-bundle
 go-bundle: go-build
-	docker-compose run --rm --user=1000 --entrypoint "bundle/bundle-entrypoint.sh" tyk-gateway
+	sed "s/replace_version/$(TYK_VERSION)/g" tyk/bundle/manifest-template.json | \
+	  sed "s/replace_platform/amd64/g" > tyk/bundle/manifest.json
+	docker-compose run --rm --user=$(DOCKER_USER) --entrypoint "bundle/bundle-entrypoint.sh" tyk-gateway
 
 # Cleans application files
 .PHONY: go-clean
@@ -125,18 +152,15 @@ go-clean:
 	-rm -rf ./go/src/go.mod
 	-rm -rf ./go/src/go.sum
 	-rm -f ./tyk/middleware/CustomGoPlugin*.so
-	-rm -f ./tyk/bundle/CustomGoPlugin.so
+	-rm -f ./tyk/bundle/CustomGoPlugin*.so
+	-rm -f ./tyk/bundle/manifest.so
 	-rm -f ./tyk/bundle/bundle.zip
 
 # Restarts the Tyk Gateway to instantly load new iterations of the Go plugin
 .PHONY: restart-gateway
 restart-gateway:
 	docker-compose restart tyk-gateway
 
-.PHONY: docker-up-oss
-docker-up-oss:
-	docker-compose -f docker-compose-oss.yml up -d
-
 # Bootstrap dashboard
 .PHONY: bootstrap-oss
 bootstrap-oss:

diff --git a/README.md b/README.md
@@ -152,6 +152,16 @@ To get started, please review our documentation on [Open Telemetry Overview](htt
 
 You can refer to our official documentation on [How to instrument Custom Go Plugins with OpenTelemetry](https://tyk.io/docs/product-stack/tyk-gateway/advanced-configurations/plugins/otel-plugins/).
 
+To stand up, oTel example: 
+```shell
+$ make up-otel build
+```
+
+To stand up, oTel example in OSS:
+```shell
+$ make up-oss-otel build
+```
+
 ### Examples
 - [Open Telemetry Instrumentation](plugins/otel-instrumentation/)
 

diff --git a/deployments/otel/docker-compose.yml b/deployments/otel/docker-compose.yml
@@ -0,0 +1,36 @@
+version: '3.8'
+services:
+
+  tyk-gateway:
+    depends_on:
+      - otel-jaeger-all-in-one
+      - otel-collector-gateway
+    environment:
+      - TYK_GW_OPENTELEMETRY_ENABLED=true
+      - TYK_GW_OPENTELEMETRY_EXPORTER=grpc
+      - TYK_GW_OPENTELEMETRY_ENDPOINT=otel-collector-gateway:4317
+
+  otel-jaeger-all-in-one:
+    image: jaegertracing/all-in-one:1.47
+    ports:
+      - "16686:16686"
+      - "14268"
+      - "14250"
+    networks:
+      - tyk
+
+  otel-collector-gateway:
+    image: otel/opentelemetry-collector:0.81.0
+    volumes:
+      - ./deployments/otel/confs/otel-collector.yml:/etc/otel-collector.yml
+    command: [ "--config=/etc/otel-collector.yml" ]
+    ports:
+      - "1888:1888"   # pprof extension
+      - "13133:13133" # health_check extension
+      - "4317:4317"   # OTLP gRPC receiver
+      - "4318:4318"   # OTLP http receiver
+      - "55670:55679" # zpages extension
+    depends_on:
+      - otel-jaeger-all-in-one
+    networks:
+      - tyk
diff --git a/docker-compose-oss.yml b/docker-compose-oss.yml
@@ -2,24 +2,17 @@ version: '3.8'
 services:
 
   tyk-plugin-compiler:
-    image: tykio/tyk-plugin-compiler:${TYK_VERSION:-v5.2.0}
+    image: tykio/tyk-plugin-compiler:${TYK_VERSION:-v5.2.4}
     volumes:
       - ./go/src:/plugin-source
 
   tyk-gateway:
-    image: tykio/tyk-gateway:${TYK_VERSION:-v5.2.0-amd64}
-    depends_on:
-      - otel-jaeger-all-in-one
-      - otel-collector-gateway
+    image: tykio/tyk-gateway:${TYK_VERSION:-v5.2.4-amd64}
     ports:
       - "8080:8080"
     volumes:
       - ./tyk/bundle:/opt/tyk-gateway/bundle
       - ./tyk/middleware:/opt/tyk-gateway/middleware
-    environment:
-      - TYK_GW_OPENTELEMETRY_ENABLED=true
-      - TYK_GW_OPENTELEMETRY_EXPORTER=grpc
-      - TYK_GW_OPENTELEMETRY_ENDPOINT=otel-collector-gateway:4317
     env_file:
       - ./tyk/confs/tyk-oss.env
     networks:
@@ -43,31 +36,6 @@ services:
       - redis-data:/data
     networks:
       - tyk
-
-  otel-jaeger-all-in-one:
-    image: jaegertracing/all-in-one:1.47
-    ports:
-      - "16686:16686"
-      - "14268"
-      - "14250"
-    networks:
-      - tyk
-
-  otel-collector-gateway:
-    image: otel/opentelemetry-collector:0.81.0
-    volumes:
-      - ./deployments/otel/confs/otel-collector.yml:/etc/otel-collector.yml
-    command: [ "--config=/etc/otel-collector.yml" ]
-    ports:
-      - "1888:1888"   # pprof extension
-      - "13133:13133" # health_check extension
-      - "4317:4317"   # OTLP gRPC receiver
-      - "4318:4318"   # OTLP http receiver
-      - "55670:55679" # zpages extension
-    depends_on:
-      - otel-jaeger-all-in-one
-    networks:
-      - tyk
 
 volumes:
   mongo-data:

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -9,19 +9,12 @@ services:
 
   tyk-gateway:
     image: tykio/tyk-gateway:${TYK_VERSION}
-    depends_on:
-      - otel-jaeger-all-in-one
-      - otel-collector-gateway
     platform: linux/amd64
     ports:
       - "8080:8080"
     volumes:
       - ./tyk/bundle:/opt/tyk-gateway/bundle
       - ./tyk/middleware:/opt/tyk-gateway/middleware
-    environment:
-      - TYK_GW_OPENTELEMETRY_ENABLED=true
-      - TYK_GW_OPENTELEMETRY_EXPORTER=grpc
-      - TYK_GW_OPENTELEMETRY_ENDPOINT=otel-collector-gateway:4317
     env_file:
       - ./tyk/confs/tyk.env
     networks:
@@ -70,31 +63,6 @@ services:
       - redis-data:/data
     networks:
       - tyk
-
-  otel-jaeger-all-in-one:
-    image: jaegertracing/all-in-one:1.47
-    ports:
-      - "16686:16686"
-      - "14268"
-      - "14250"
-    networks:
-      - tyk
-
-  otel-collector-gateway:
-    image: otel/opentelemetry-collector:0.81.0
-    volumes:
-      - ./deployments/otel/confs/otel-collector.yml:/etc/otel-collector.yml
-    command: [ "--config=/etc/otel-collector.yml" ]
-    ports:
-      - "1888:1888"   # pprof extension
-      - "13133:13133" # health_check extension
-      - "4317:4317"   # OTLP gRPC receiver
-      - "4318:4318"   # OTLP http receiver
-      - "55670:55679" # zpages extension
-    depends_on:
-      - otel-jaeger-all-in-one
-    networks:
-      - tyk
 
 volumes:
   mongo-data:

diff --git a/tyk/bundle/manifest.json → tyk/bundle/manifest-template.json b/tyk/bundle/manifest.json → tyk/bundle/manifest-template.json
@@ -1,6 +1,6 @@
 {
   "file_list": [
-    "CustomGoPlugin_v5.2.0_linux_amd64.so"
+    "CustomGoPlugin_replace_version_linux_replace_platform.so"
   ],
   "custom_middleware": {
     "pre": [