Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tempo #68

Merged
merged 4 commits into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
68 changes: 37 additions & 31 deletions docs/FEATURES_MATRIX.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/PORTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
1 change: 0 additions & 1 deletion src/deployments/cert-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/datadog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/elasticsearch-kibana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
18 changes: 6 additions & 12 deletions src/deployments/jaeger/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand All @@ -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 |
|:------------------:|:-------------------------:|
Expand Down
2 changes: 1 addition & 1 deletion src/deployments/jaeger/main.safe.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 0 additions & 1 deletion src/deployments/k6-slo-traffic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/k6/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/keycloak-dcr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/keycloak-jwt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/keycloak-sso/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/keycloak/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/newrelic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/opa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/opensearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
14 changes: 6 additions & 8 deletions src/deployments/opentelemetry/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/deployments/opentelemetry/main.sh
Original file line number Diff line number Diff line change
@@ -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" \
Expand Down
1 change: 0 additions & 1 deletion src/deployments/operator-federation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/operator-graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/operator-httpbin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/operator-jwt-hmac/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/operator-udg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/portal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/prometheus-grafana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
1 change: 0 additions & 1 deletion src/deployments/prometheus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
29 changes: 29 additions & 0 deletions src/deployments/tempo-grafana/README.md
Original file line number Diff line number Diff line change
@@ -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 |
10 changes: 10 additions & 0 deletions src/deployments/tempo-grafana/main.safe.sh
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions src/deployments/tempo-grafana/main.sh
Original file line number Diff line number Diff line change
@@ -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;
1 change: 0 additions & 1 deletion src/deployments/vault/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
2 changes: 1 addition & 1 deletion src/helpers/up/update-helm.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Loading
Loading