diff --git a/README.md b/README.md index 32071034..0be4d9e3 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ You will need the following tools to be able to run this project. - [git](https://git-scm.com/downloads) - CLI used to obtain the project from GitHub - [Terraform](https://www.terraform.io/) (only when using `--cloud` flag) -Tested on Linux/Unix based systems on AMD64 and ARM architectures +Tested on Linux/Unix based systems ### License Requirements - **Tyk OSS**: No license required as it is open-source. diff --git a/docs/FEATURES_MATRIX.md b/docs/FEATURES_MATRIX.md index e56665ac..20115628 100644 --- a/docs/FEATURES_MATRIX.md +++ b/docs/FEATURES_MATRIX.md @@ -1,35 +1,37 @@ # Features, Tests, and Support matrices -| Deployment | OpenShift Support | ARM Support | CI Tests | Postman Test | SSL | Chart/Manifest | Version | -|----------------------|:------------------:|:------------------:|:------------------:|:------------------:|:------------------:|:--------------------------------------------------------------------------------------------------------:|:-------:| -| tyk-gateway | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-oss | 2.1.0 | -| tyk-dp | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-data-plane | 2.1.0 | -| tyk-stack | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-stack | 2.1.0 | -| tyk-cp | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-control-plane | 2.1.0 | -| cert-manager | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | N/A | [jetstack](https://charts.jetstack.io)/cert-manager | 1.15.1 | -| datadog | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | [datadog](https://helm.datadoghq.com)/datadog | 3.69.0 | -| elasticsearch | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [bitnami](https://charts.bitnami.com/bitnami)/elasticsearch | 21.3.5 | -| elasticsearch-kibana | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [bitnami](https://charts.bitnami.com/bitnami)/kibana | 11.2.14 | -| jaeger | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | [jaegertracing](https://jaegertracing.github.io/helm-charts)/jaeger-operator | 2.46.2 | -| k6 | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | N/A | [grafana](https://grafana.github.io/helm-charts)/k6-operator | 3.8.0 | -| k6-slo-traffic | N/A | N/A | :white_check_mark: | N/A | N/A | N/A | N/A | -| keycloak | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [keycloak-operator](https://raw.githubusercontent.com/keycloak/keycloak-k8s-resources/21.0.1/kubernetes) | 25.0.2 | -| keycloak-dcr | N/A | N/A | :white_check_mark: | N/A | N/A | N/A | N/A | -| keycloak-jwt | N/A | N/A | :white_check_mark: | :white_check_mark: | N/A | N/A | N/A | -| keycloak-sso | N/A | N/A | :white_check_mark: | N/A | N/A | N/A | N/A | -| newrelic | :warning: | :white_check_mark: | :white_check_mark: | N/A | N/A | [nri-bundle](https://helm-charts.newrelic.com/) | 5.0.87 | -| opa | N/A | N/A | N/A | N/A | N/A | N/A | N/A | -| opensearch | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [bitnami](https://charts.bitnami.com/bitnami)/opensearch | 1.2.8 | -| operator | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | N/A | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-operator | 0.18.0 | -| operator-federation | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | N/A | N/A | -| operator-graphql | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | N/A | N/A | -| operator-httpbin | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | N/A | N/A | -| operator-jwt-hmac | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | N/A | N/A | -| operator-udg | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | N/A | N/A | -| portal | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-dev-portal | 2.1.0 | -| prometheus | :no_entry: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | [prometheus-community](https://prometheus-community.github.io/helm-charts)/prometheus | 25.24.1 | -| prometheus-grafana | :warning: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | [grafana](https://grafana.github.io/helm-charts)/grafana | 8.3.6 | -| vault | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | [hashicorp](https://helm.releases.hashicorp.com)/vault | 0.28.1 | +| Deployment | OpenShift Support | CI Tests | Postman Test | SSL | Chart/Manifest | Version | +|----------------------|:------------------:|:------------------:|:------------------:|:------------------:|:--------------------------------------------------------------------------------------------------------:|:-------:| +| tyk-gateway | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-oss | 2.1.0 | +| tyk-dp | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-data-plane | 2.1.0 | +| tyk-stack | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-stack | 2.1.0 | +| tyk-cp | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-control-plane | 2.1.0 | +| cert-manager | :white_check_mark: | :white_check_mark: | N/A | N/A | [jetstack](https://charts.jetstack.io)/cert-manager | 1.15.1 | +| datadog | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | [datadog](https://helm.datadoghq.com)/datadog | 3.69.0 | +| elasticsearch | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [bitnami](https://charts.bitnami.com/bitnami)/elasticsearch | 21.3.5 | +| elasticsearch-kibana | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [bitnami](https://charts.bitnami.com/bitnami)/kibana | 11.2.14 | +| jaeger | :warning: | :white_check_mark: | :x: | :x: | [jaegertracing](https://jaegertracing.github.io/helm-charts)/jaeger-operator | 2.46.2 | +| k6 | :white_check_mark: | :white_check_mark: | N/A | N/A | [grafana](https://grafana.github.io/helm-charts)/k6-operator | 3.8.0 | +| k6-slo-traffic | N/A | :white_check_mark: | N/A | N/A | N/A | N/A | +| keycloak | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [keycloak-operator](https://raw.githubusercontent.com/keycloak/keycloak-k8s-resources/21.0.1/kubernetes) | 25.0.2 | +| keycloak-dcr | N/A | :white_check_mark: | N/A | N/A | N/A | N/A | +| keycloak-jwt | N/A | :white_check_mark: | :white_check_mark: | N/A | N/A | N/A | +| keycloak-sso | N/A | :white_check_mark: | N/A | N/A | N/A | N/A | +| newrelic | :warning: | :white_check_mark: | N/A | N/A | [nri-bundle](https://helm-charts.newrelic.com/) | 5.0.87 | +| opa | N/A | N/A | N/A | N/A | N/A | N/A | +| opensearch | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [bitnami](https://charts.bitnami.com/bitnami)/opensearch | 1.2.8 | +| opentelemetry | :white_check_mark: | :white_check_mark: | :x: | :x: | [opentelemetry](https://open-telemetry.github.io/opentelemetry-helm-charts)/opentelemetry-collector | 0.108.1 | +| operator | :white_check_mark: | :white_check_mark: | N/A | N/A | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-operator | 0.18.0 | +| operator-federation | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | N/A | N/A | +| operator-graphql | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | N/A | N/A | +| operator-httpbin | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | N/A | N/A | +| operator-jwt-hmac | :white_check_mark: | :white_check_mark: | :white_check_mark: | N/A | N/A | N/A | +| operator-udg | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | N/A | N/A | +| portal | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | [tyk-helm](https://helm.tyk.io/public/helm/charts)/tyk-dev-portal | 2.1.0 | +| prometheus | :no_entry: | :white_check_mark: | :white_check_mark: | :no_entry: | [prometheus-community](https://prometheus-community.github.io/helm-charts)/prometheus | 25.24.1 | +| prometheus-grafana | :warning: | :white_check_mark: | :white_check_mark: | :no_entry: | [grafana](https://grafana.github.io/helm-charts)/grafana | 8.3.6 | +| tempo-grafana | :warning: | :white_check_mark: | :x: | :x: | [grafana](https://grafana.github.io/helm-charts)/tempo | 1.10.3 | +| vault | :white_check_mark: | :white_check_mark: | :white_check_mark: | :no_entry: | [hashicorp](https://helm.releases.hashicorp.com)/vault | 0.28.1 | ## Integrations compatible with Tyk deployments @@ -48,6 +50,7 @@ | newrelic | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | opa | N/A | :white_check_mark: | :white_check_mark: | :white_check_mark: | | operator | N/A | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| opentelemetry | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | operator-federation | N/A | :white_check_mark: | :white_check_mark: | :white_check_mark: | | operator-graphql | N/A | :white_check_mark: | :white_check_mark: | :white_check_mark: | | operator-httpbin | N/A | :white_check_mark: | :white_check_mark: | :white_check_mark: | @@ -56,6 +59,7 @@ | portal | N/A | :white_check_mark: | :white_check_mark: | :white_check_mark: | | prometheus | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | prometheus-grafana | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| tempo-grafana | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | | vault | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | ## `--expose` flag support @@ -68,7 +72,7 @@ | datadog | :white_check_mark: | N/A | N/A | | elasticsearch | :white_check_mark: | :white_check_mark: | :white_check_mark: | | elasticsearch-kibana | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| jaeger | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| jaeger | :white_check_mark: | :x: | :x: | | k6 | N/A | N/A | N/A | | k6-slo-traffic | N/A | N/A | N/A | | keycloak | :white_check_mark: | :no_entry: | :no_entry: | @@ -78,6 +82,7 @@ | newrelic | N/A | N/A | N/A | | opa | N/A | N/A | N/A | | opensearch | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| opentelemetry | N/A | N/A | N/A | | operator | N/A | N/A | N/A | | operator-federation | :white_check_mark: | :x: | :x: | | operator-graphql | N/A | N/A | N/A | @@ -87,6 +92,7 @@ | portal | :white_check_mark: | :white_check_mark: | :white_check_mark: | | prometheus | :white_check_mark: | :white_check_mark: | :white_check_mark: | | prometheus-grafana | :white_check_mark: | :white_check_mark: | :white_check_mark: | +| tempo-grafana | :white_check_mark: | :x: | :x: | | vault | :white_check_mark: | :x: | :x: | | Icon | Description | diff --git a/docs/PORTS.md b/docs/PORTS.md index db1991cb..62c138c8 100644 --- a/docs/PORTS.md +++ b/docs/PORTS.md @@ -31,4 +31,4 @@ All the ports that this library uses. | prometheus | pump-svc-*-tyk-pump | `9091` | | elasticsearch | elasticsearch | `9200` | | opensearch | opensearch | `9201` | -| jaeger | tyk-jaeger-query | `16686` | +| jaeger | tyk-jaeger | `16686` | diff --git a/src/deployments/cert-manager/README.md b/src/deployments/cert-manager/README.md index 6efb1a0e..cef4c857 100644 --- a/src/deployments/cert-manager/README.md +++ b/src/deployments/cert-manager/README.md @@ -11,7 +11,6 @@ This is a requirement for the Tyk Operator. | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | N/A | | SSL | N/A | diff --git a/src/deployments/datadog/README.md b/src/deployments/datadog/README.md index bb42e812..679c320c 100644 --- a/src/deployments/datadog/README.md +++ b/src/deployments/datadog/README.md @@ -20,7 +20,6 @@ DATADOG_SITE=datadoghq.com | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | N/A | diff --git a/src/deployments/elasticsearch-kibana/README.md b/src/deployments/elasticsearch-kibana/README.md index 1bd53713..9c7f4427 100644 --- a/src/deployments/elasticsearch-kibana/README.md +++ b/src/deployments/elasticsearch-kibana/README.md @@ -13,7 +13,6 @@ analytics. | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | :white_check_mark: | diff --git a/src/deployments/elasticsearch/README.md b/src/deployments/elasticsearch/README.md index 621ef32b..24681a98 100644 --- a/src/deployments/elasticsearch/README.md +++ b/src/deployments/elasticsearch/README.md @@ -11,7 +11,6 @@ Stands up a Tyk pump to push analytics data from the Tyk platform to Elasticsear | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | :white_check_mark: | diff --git a/src/deployments/jaeger/README.md b/src/deployments/jaeger/README.md index 363bee46..3f761d22 100644 --- a/src/deployments/jaeger/README.md +++ b/src/deployments/jaeger/README.md @@ -1,10 +1,5 @@ ## Jaeger -Deploys the Jaeger operator using the `jaegertracing/jaeger-operator` chart -version `v2.46.2`, a Jaeger instance using the Jaeger `jaegertracing.io/v1` -CRD, and the OpenTelemetry collector using the -`open-telemetryopentelemetry-collector` chart version `0.99.0` and configures -the Tyk deployment to send telemetry data to Jaeger through the OpenTelemetry -collector. +Deploys a Grafana Tempo deployment which exposes a Jaeger UI. ### Example ``` @@ -14,18 +9,17 @@ collector. ### Support | Item | Status | |:------------:|:------------------:| -| OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | -| CI Tests | :white_check_mark: | +| OpenShift | :warning: | +| CI Tests | :x: | | Postman Test | :white_check_mark: | -| SSL | :no_entry: | +| SSL | :x: | ### Supported Service Types with `--expose` flag | Item | Status | |:-------------:|:------------------:| | Port Forward | :white_check_mark: | -| Ingress | :white_check_mark: | -| Load Balancer | :white_check_mark: | +| Ingress | :x: | +| Load Balancer | :x: | | Icon | Description | |:------------------:|:-------------------------:| diff --git a/src/deployments/jaeger/main.safe.sh b/src/deployments/jaeger/main.safe.sh index 2b55c4a4..793247f9 100644 --- a/src/deployments/jaeger/main.safe.sh +++ b/src/deployments/jaeger/main.safe.sh @@ -4,6 +4,6 @@ if [ -z "$jaegerRegistered" ]; then jaegerReleaseName="tyk-jaeger"; jaegerDeploymentPath="src/deployments/jaeger"; - source "src/deployments/tempo/main.safe.sh"; + source "src/deployments/tempo-grafana/main.safe.sh"; source "$jaegerDeploymentPath/main.sh"; fi diff --git a/src/deployments/k6-slo-traffic/README.md b/src/deployments/k6-slo-traffic/README.md index 7ab9e70f..ed99926c 100644 --- a/src/deployments/k6-slo-traffic/README.md +++ b/src/deployments/k6-slo-traffic/README.md @@ -10,7 +10,6 @@ Deploys a k6 CRD to generate a load of traffic to seed analytics data. | Item | Status | |:------------:|:------------------:| | OpenShift | N/A | -| ARM | N/A | | CI Tests | :white_check_mark: | | Postman Test | N/A | | SSL | N/A | diff --git a/src/deployments/k6/README.md b/src/deployments/k6/README.md index 4c2365dc..fbf583dd 100644 --- a/src/deployments/k6/README.md +++ b/src/deployments/k6/README.md @@ -11,7 +11,6 @@ Deploys a Grafana K6 Operator using the `grafana/k6-operator` chart version | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | N/A | | SSL | N/A | diff --git a/src/deployments/keycloak-dcr/README.md b/src/deployments/keycloak-dcr/README.md index a1dfe677..8ef6d1d4 100644 --- a/src/deployments/keycloak-dcr/README.md +++ b/src/deployments/keycloak-dcr/README.md @@ -18,7 +18,6 @@ documentation page. | Item | Status | |:------------:|:------------------:| | OpenShift | N/A | -| ARM | N/A | | CI Tests | :white_check_mark: | | Postman Test | N/A | | SSL | N/A | diff --git a/src/deployments/keycloak-jwt/README.md b/src/deployments/keycloak-jwt/README.md index 987ca09f..393eb6a0 100644 --- a/src/deployments/keycloak-jwt/README.md +++ b/src/deployments/keycloak-jwt/README.md @@ -47,7 +47,6 @@ curl 'http://localhost:8080/keycloak-jwt/get' \ | Item | Status | |:------------:|:------------------:| | OpenShift | N/A | -| ARM | N/A | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | N/A | diff --git a/src/deployments/keycloak-sso/README.md b/src/deployments/keycloak-sso/README.md index 82384948..eb0d8692 100644 --- a/src/deployments/keycloak-sso/README.md +++ b/src/deployments/keycloak-sso/README.md @@ -20,7 +20,6 @@ localhost. | Item | Status | |:------------:|:------------------:| | OpenShift | N/A | -| ARM | N/A | | CI Tests | :white_check_mark: | | Postman Test | N/A | | SSL | N/A | diff --git a/src/deployments/keycloak/README.md b/src/deployments/keycloak/README.md index 03b8c7a5..d214ed52 100644 --- a/src/deployments/keycloak/README.md +++ b/src/deployments/keycloak/README.md @@ -14,7 +14,6 @@ Keycloak resource. | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | :white_check_mark: | diff --git a/src/deployments/newrelic/README.md b/src/deployments/newrelic/README.md index 65604210..5d55a45e 100644 --- a/src/deployments/newrelic/README.md +++ b/src/deployments/newrelic/README.md @@ -19,7 +19,6 @@ NEWRELIC_CLUSTER=minikube | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | N/A | diff --git a/src/deployments/opa/README.md b/src/deployments/opa/README.md index 5d03633b..1a12deba 100644 --- a/src/deployments/opa/README.md +++ b/src/deployments/opa/README.md @@ -10,7 +10,6 @@ Enables Open Policy Agent to manage Tyk Dashboard API. | Item | Status | |:------------:|:------:| | OpenShift | N/A | -| ARM | N/A | | CI Tests | N/A | | Postman Test | N/A | | SSL | N/A | diff --git a/src/deployments/opensearch/README.md b/src/deployments/opensearch/README.md index 8584f39e..8c9e04d2 100644 --- a/src/deployments/opensearch/README.md +++ b/src/deployments/opensearch/README.md @@ -11,7 +11,6 @@ Stands up a Tyk pump to push analytics data from the Tyk platform to Opensearch. | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | :white_check_mark: | diff --git a/src/deployments/opentelemetry/README.md b/src/deployments/opentelemetry/README.md index a0b1a04a..2dd15b5b 100644 --- a/src/deployments/opentelemetry/README.md +++ b/src/deployments/opentelemetry/README.md @@ -1,8 +1,7 @@ ## OpenTelemetry -Deploys the OpenTelemetry collector using the -`open-telemetryopentelemetry-collector` chart version `0.108.1` and configures -the Tyk deployment to send telemetry data to Grafana Tempo through the OpenTelemetry -collector. +Deploys the OpenTelemetry collector using the `opentelemetry-collector` chart +version `0.108.1` and configures the Tyk deployment to send telemetry data to +Grafana Tempo through the OpenTelemetry collector. ### Example ``` @@ -12,10 +11,9 @@ collector. ### Support | Item | Status | |:------------:|:------------------:| -| OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | -| CI Tests | N/A | -| Postman Test | N/A | +| OpenShift | :warning: | +| CI Tests | :white_check_mark: | +| Postman Test | :x: | | SSL | N/A | ### Supported Service Types with `--expose` flag diff --git a/src/deployments/opentelemetry/main.sh b/src/deployments/opentelemetry/main.sh index 8f6529ce..4818c852 100644 --- a/src/deployments/opentelemetry/main.sh +++ b/src/deployments/opentelemetry/main.sh @@ -1,7 +1,7 @@ logger "$INFO" "installing $opentelemetrReleaseName in $namespace namespace..."; setVerbose; -helm upgrade tyk-otel-collector open-telemetry/opentelemetry-collector --version 0.108.1 \ +helm upgrade tyk-otel-collector opentelemetry/opentelemetry-collector --version 0.108.1 \ --install \ --set "mode=deployment" \ --set "image.repository=otel/opentelemetry-collector-contrib" \ diff --git a/src/deployments/operator-federation/README.md b/src/deployments/operator-federation/README.md index 3548264f..6240c97a 100644 --- a/src/deployments/operator-federation/README.md +++ b/src/deployments/operator-federation/README.md @@ -27,7 +27,6 @@ minikube addons enable ingress | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | N/A | diff --git a/src/deployments/operator-graphql/README.md b/src/deployments/operator-graphql/README.md index 9a945b29..9352e36a 100644 --- a/src/deployments/operator-graphql/README.md +++ b/src/deployments/operator-graphql/README.md @@ -23,7 +23,6 @@ minikube addons enable ingress | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | N/A | diff --git a/src/deployments/operator-httpbin/README.md b/src/deployments/operator-httpbin/README.md index 02c3ef8b..a30c6304 100644 --- a/src/deployments/operator-httpbin/README.md +++ b/src/deployments/operator-httpbin/README.md @@ -24,7 +24,6 @@ minikube addons enable ingress | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | N/A | diff --git a/src/deployments/operator-jwt-hmac/README.md b/src/deployments/operator-jwt-hmac/README.md index b20241c5..d308b048 100644 --- a/src/deployments/operator-jwt-hmac/README.md +++ b/src/deployments/operator-jwt-hmac/README.md @@ -33,7 +33,6 @@ minikube addons enable ingress | Item | Status | |:------------:|:------------------:| | OpenShift | N/A | -| ARM | N/A | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | N/A | diff --git a/src/deployments/operator-udg/README.md b/src/deployments/operator-udg/README.md index f6a8d4fc..3bbb0d8e 100644 --- a/src/deployments/operator-udg/README.md +++ b/src/deployments/operator-udg/README.md @@ -26,7 +26,6 @@ minikube addons enable ingress | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | N/A | diff --git a/src/deployments/operator/README.md b/src/deployments/operator/README.md index bd1f2a18..9da6bc30 100644 --- a/src/deployments/operator/README.md +++ b/src/deployments/operator/README.md @@ -20,7 +20,6 @@ minikube addons enable ingress | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | N/A | | SSL | N/A | diff --git a/src/deployments/portal/README.md b/src/deployments/portal/README.md index aee1b968..5788c72c 100644 --- a/src/deployments/portal/README.md +++ b/src/deployments/portal/README.md @@ -20,7 +20,6 @@ minikube addons enable ingress | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | :white_check_mark: | diff --git a/src/deployments/prometheus-grafana/README.md b/src/deployments/prometheus-grafana/README.md index a0cf4efc..5edb4049 100644 --- a/src/deployments/prometheus-grafana/README.md +++ b/src/deployments/prometheus-grafana/README.md @@ -13,7 +13,6 @@ analytics. | Item | Status | |:------------:|:------------------:| | OpenShift | :warning: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | :no_entry: | diff --git a/src/deployments/prometheus/README.md b/src/deployments/prometheus/README.md index 913c9ac5..14ec8660 100644 --- a/src/deployments/prometheus/README.md +++ b/src/deployments/prometheus/README.md @@ -35,7 +35,6 @@ This deployment will do the following: | Item | Status | |:------------:|:------------------:| | OpenShift | :no_entry: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | :no_entry: | diff --git a/src/deployments/tempo-grafana/README.md b/src/deployments/tempo-grafana/README.md new file mode 100644 index 00000000..8156ac13 --- /dev/null +++ b/src/deployments/tempo-grafana/README.md @@ -0,0 +1,29 @@ +## Tempo +Deploys the Tempo using the `grafana/tempo` chart version `v1.10.3`. + +### Example +``` +./up.sh --deployments tempo tyk-stack +``` + +### Support +| Item | Status | +|:------------:|:------------------:| +| OpenShift | :warning: | +| CI Tests | :white_check_mark: | +| Postman Test | :x: | +| SSL | N/A | + +### Supported Service Types with `--expose` flag +| Item | Status | +|:-------------:|:------:| +| Port Forward | N/A | +| Ingress | N/A | +| Load Balancer | N/A | + +| Icon | Description | +|:------------------:|:-------------------------:| +| :white_check_mark: | Supported and tested | +| :warning: | Not tested | +| :x: | Not supported | +| :no_entry: | Not supported by the tool | diff --git a/src/deployments/tempo-grafana/main.safe.sh b/src/deployments/tempo-grafana/main.safe.sh new file mode 100644 index 00000000..c78eb2e1 --- /dev/null +++ b/src/deployments/tempo-grafana/main.safe.sh @@ -0,0 +1,10 @@ +if [ -z "$tempoRegistered" ]; then + tempoRegistered=true; + + tempoReleaseName="tyk-tempo"; + tempoDeploymentPath="src/deployments/tempo-grafana"; + + source "src/deployments/opentelemetry/main.safe.sh"; + source "src/deployments/prometheus-grafana/main.safe.sh"; + source "$tempoDeploymentPath/main.sh"; +fi diff --git a/src/deployments/tempo-grafana/main.sh b/src/deployments/tempo-grafana/main.sh new file mode 100644 index 00000000..98cf731d --- /dev/null +++ b/src/deployments/tempo-grafana/main.sh @@ -0,0 +1,9 @@ +logger "$INFO" "installing $tempoReleaseName in $namespace namespace..."; + +setVerbose; +helm upgrade "$tempoReleaseName" grafana/tempo --version v1.10.3 \ + --install \ + --namespace "$namespace" \ + --set "tempoQuery.enabled=true" \ + "${helmFlags[@]}" > /dev/null; +unsetVerbose; diff --git a/src/deployments/vault/README.md b/src/deployments/vault/README.md index fcae7a7b..b9480b10 100644 --- a/src/deployments/vault/README.md +++ b/src/deployments/vault/README.md @@ -11,7 +11,6 @@ version `0.28.1`. | Item | Status | |:------------:|:------------------:| | OpenShift | :white_check_mark: | -| ARM | :white_check_mark: | | CI Tests | :white_check_mark: | | Postman Test | :white_check_mark: | | SSL | :no_entry: | diff --git a/src/helpers/up/update-helm.sh b/src/helpers/up/update-helm.sh index 2097ed53..b11848cf 100644 --- a/src/helpers/up/update-helm.sh +++ b/src/helpers/up/update-helm.sh @@ -6,7 +6,7 @@ helm repo add prometheus-community https://prometheus-community.github.io/helm-c helm repo add grafana https://grafana.github.io/helm-charts > /dev/null; helm repo add datadog https://helm.datadoghq.com > /dev/null; helm repo add jaegertracing https://jaegertracing.github.io/helm-charts > /dev/null; -helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts > /dev/null; +helm repo add opentelemetry https://open-telemetry.github.io/opentelemetry-helm-charts > /dev/null; helm repo add hashicorp https://helm.releases.hashicorp.com > /dev/null; helm repo add newrelic https://helm-charts.newrelic.com > /dev/null; helm repo update > /dev/null; diff --git a/tyk-k8s-demo.postman_collection.json b/tyk-k8s-demo.postman_collection.json index cd6fa62d..bb163978 100644 --- a/tyk-k8s-demo.postman_collection.json +++ b/tyk-k8s-demo.postman_collection.json @@ -1,6 +1,6 @@ { "info": { - "_postman_id": "8e320278-1224-42db-829c-8753244485b5", + "_postman_id": "685ff936-782b-4941-be66-7312e2eae6f6", "name": "tyk-k8s-demo", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "13702323" @@ -113,45 +113,6 @@ } ] }, - { - "name": "newrelic", - "item": [ - { - "name": "healthz", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Newrelic status is healthy\", function () {", - " var health = pm.response.text();", - " pm.expect(health).to.eql(\"OK\");", - "});" - ], - "type": "text/javascript", - "packages": {} - } - } - ], - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "http://localhost:{{newrelic.port}}/healthz", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "{{newrelic.port}}", - "path": [ - "healthz" - ] - } - }, - "response": [] - } - ] - }, { "name": "elasticsearch", "item": [ @@ -191,53 +152,6 @@ } ] }, - { - "name": "opensearch", - "item": [ - { - "name": "health", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Opensearch status is green\", function () {", - " var health = pm.response.json();", - " pm.expect(health.status).to.eql(\"green\");", - "});" - ], - "type": "text/javascript", - "packages": {} - } - }, - { - "listen": "prerequest", - "script": { - "packages": {}, - "type": "text/javascript" - } - } - ], - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "http://localhost:{{opensearch.port}}/_cluster/health", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "{{opensearch.port}}", - "path": [ - "_cluster", - "health" - ] - } - }, - "response": [] - } - ] - }, { "name": "elasticsearch-kibana", "item": [ @@ -279,42 +193,7 @@ }, { "name": "jaeger", - "item": [ - { - "name": "health", - "event": [ - { - "listen": "test", - "script": { - "exec": [ - "pm.test(\"Jaeger status is UP\", function () {", - " var health = pm.response.json();", - " pm.expect(health.status).to.eql(\"Server available\");", - "});", - "" - ], - "type": "text/javascript" - } - } - ], - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "http://localhost:{{jaeger.health-port}}/health", - "protocol": "http", - "host": [ - "localhost" - ], - "port": "{{jaeger.health-port}}", - "path": [ - "health" - ] - } - }, - "response": [] - } - ] + "item": [] }, { "name": "k6", @@ -675,6 +554,96 @@ "name": "keycloak-sso", "item": [] }, + { + "name": "newrelic", + "item": [ + { + "name": "healthz", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Newrelic status is healthy\", function () {", + " var health = pm.response.text();", + " pm.expect(health).to.eql(\"OK\");", + "});" + ], + "type": "text/javascript", + "packages": {} + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "http://localhost:{{newrelic.port}}/healthz", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "{{newrelic.port}}", + "path": [ + "healthz" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "opensearch", + "item": [ + { + "name": "health", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "pm.test(\"Opensearch status is green\", function () {", + " var health = pm.response.json();", + " pm.expect(health.status).to.eql(\"green\");", + "});" + ], + "type": "text/javascript", + "packages": {} + } + }, + { + "listen": "prerequest", + "script": { + "packages": {}, + "type": "text/javascript" + } + } + ], + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "http://localhost:{{opensearch.port}}/_cluster/health", + "protocol": "http", + "host": [ + "localhost" + ], + "port": "{{opensearch.port}}", + "path": [ + "_cluster", + "health" + ] + } + }, + "response": [] + } + ] + }, + { + "name": "opentelemetry", + "item": [] + }, { "name": "operator", "item": [] @@ -1021,6 +990,10 @@ } ] }, + { + "name": "tempo-grafana", + "item": [] + }, { "name": "vault", "item": [ @@ -1129,14 +1102,14 @@ "key": "datadog.port", "value": "5555" }, - { - "key": "keycloak-service.port", - "value": "7001" - }, - { - "key": "keycloak-management.port", - "value": "7002" - }, + { + "key": "keycloak-service.port", + "value": "7001" + }, + { + "key": "keycloak-management.port", + "value": "7002" + }, { "key": "portal.port", "value": "3000" @@ -1171,4 +1144,4 @@ "value": "9201" } ] -} +} \ No newline at end of file