feat: add backends docs and check ci is passing

.github/workflows/backends-docs-sync.yaml

@@ -31,7 +31,7 @@ jobs:
       - name: Check for changes in docs-backends
         run: |
           git diff --exit-code docs/backends || (
-            echo "Changes detected in docs/backends directory. You should update run python ./docs/sync-dest-doc.py and commit the changes.";
+            echo "Changes detected in docs/backends directory. You should update run cd docs ; python sync-dest-doc.py and commit the changes.";
             git diff docs/backends;
             exit 1;
           )

docs/backends/azureblob.mdx

@@ -10,4 +10,32 @@ Data can be exported either in JSON format or in binary format (protobuf).
 There are two required fields to configure Azure Blob Storage backend:
 
 - **Account name**: Azure Storage account name
-- **Container name**: Azure Storage container name
+- **Container name**: Azure Storage container name
+
+## Deploying using yaml
+
+### Applying the Configuration
+Save the below YAML to a file (e.g., `destination.yaml`) and apply it using kubectl:
+
+```bash
+kubectl apply -f destination.yaml
+```
+Optional fields are commented out; be sure to uncomment any relevant fields before applying.
+
+
+```yaml
+apiVersion: odigos.io/v1alpha1
+kind: Destination
+metadata:
+  name: azureblob-example
+  namespace: <odigos namespace>
+spec:
+  data:
+    AZURE_BLOB_ACCOUNT_NAME: <Account Name>
+    AZURE_BLOB_CONTAINER_NAME: <Container Name>
+  destinationName: azureblob
+  signals:
+  - TRACES
+  - LOGS
+  type: azureblob
+```

docs/backends/causely.mdx

@@ -20,4 +20,31 @@ The endpoint URL is the combined `<protocol>://<hostname>:<port>` to access your
     - `namespace` is the k8s namespace where the Causely Mediator service is deployed
 - Default port is `4317`; if no port is specified, it will be appended automatically
 
-Example: `http://mediator.causely:4317`
+Example: `http://mediator.causely:4317`
+
+## Deploying using yaml
+
+### Applying the Configuration
+Save the below YAML to a file (e.g., `destination.yaml`) and apply it using kubectl:
+
+```bash
+kubectl apply -f destination.yaml
+```
+Optional fields are commented out; be sure to uncomment any relevant fields before applying.
+
+
+```yaml
+apiVersion: odigos.io/v1alpha1
+kind: Destination
+metadata:
+  name: causely-example
+  namespace: <odigos namespace>
+spec:
+  data:
+    CAUSELY_URL: <Endpoint>
+  destinationName: causely
+  signals:
+  - TRACES
+  - METRICS
+  type: causely
+```

docs/backends/coralogix.mdx

@@ -16,4 +16,47 @@ Follow the [Domain instructions](https://coralogix.com/docs/coralogix-domain/) t
 
 ### Application and Subsystem Names
 
-You can configure the application and subsystem names for your Coralogix account. Follow the [Application and Subsystem Names guide](https://coralogix.com/docs/application-and-subsystem-names/) to learn more.
+You can configure the application and subsystem names for your Coralogix account. Follow the [Application and Subsystem Names guide](https://coralogix.com/docs/application-and-subsystem-names/) to learn more.
+
+## Deploying using yaml
+
+### Applying the Configuration
+Save the below YAML to a file (e.g., `destination.yaml`) and apply it using kubectl:
+
+```bash
+kubectl apply -f destination.yaml
+```
+Optional fields are commented out; be sure to uncomment any relevant fields before applying.
+
+
+```yaml
+apiVersion: odigos.io/v1alpha1
+kind: Destination
+metadata:
+  name: coralogix-example
+  namespace: <odigos namespace>
+spec:
+  data:
+    CORALOGIX_APPLICATION_NAME: <Application Name>
+    CORALOGIX_DOMAIN: <Domain [coralogix.com, eu2.coralogix.com, coralogix.us, cx498.coralogix.com,
+      coralogix.in, coralogixsg.com]>
+    CORALOGIX_SUBSYSTEM_NAME: <Subsystem Name>
+  destinationName: coralogix
+  secretRef:
+    name: coralogix-secret
+  signals:
+  - TRACES
+  - METRICS
+  - LOGS
+  type: coralogix
+
+---
+apiVersion: v1
+data:
+  CORALOGIX_PRIVATE_KEY: <base64 Send-Your-Data API Key>
+kind: Secret
+metadata:
+  name: coralogix-secret
+  namespace: <odigos namespace>
+type: Opaque
+```

docs/backends/datadog.mdx

@@ -23,3 +23,45 @@ Enter the following account details in Odigos UI:
 - **Name**: Choose a name for this backend (e.g. Datadog)
 - **Site** - The datadog site you are using (the url of the datadog site you are using). [click here for more details](https://docs.datadoghq.com/getting_started/site/).
 - **API Key**: The API key you obtained from Datadog
+
+
+## Deploying using yaml
+
+### Applying the Configuration
+Save the below YAML to a file (e.g., `destination.yaml`) and apply it using kubectl:
+
+```bash
+kubectl apply -f destination.yaml
+```
+Optional fields are commented out; be sure to uncomment any relevant fields before applying.
+
+
+```yaml
+apiVersion: odigos.io/v1alpha1
+kind: Destination
+metadata:
+  name: datadog-example
+  namespace: <odigos namespace>
+spec:
+  data:
+    DATADOG_SITE: <Site [us3.datadoghq.com, datadoghq.com, us5.datadoghq.com, datadoghq.eu,
+      ddog-gov.com, ap1.datadoghq.com]>
+  destinationName: datadog
+  secretRef:
+    name: datadog-secret
+  signals:
+  - TRACES
+  - METRICS
+  - LOGS
+  type: datadog
+
+---
+apiVersion: v1
+data:
+  DATADOG_API_KEY: <base64 API Key>
+kind: Secret
+metadata:
+  name: datadog-secret
+  namespace: <odigos namespace>
+type: Opaque
+```

docs/backends/dynatrace.mdx

@@ -12,4 +12,44 @@ On the left sidebar click on `Apps`, then under `Manage` select `Access Tokens`:
 
 Make sure to add the required capabilities for the access tokens (e.g `Ingest OpenTelemetry traces` for traces).
 
-The URL is usually of the form `https://{your-environment-id}.live.dynatrace.com` [click her for more details](https://docs.dynatrace.com/docs/extend-dynatrace/opentelemetry/getting-started/otlp-export)
+The URL is usually of the form `https://{your-environment-id}.live.dynatrace.com` [click her for more details](https://docs.dynatrace.com/docs/extend-dynatrace/opentelemetry/getting-started/otlp-export)
+
+## Deploying using yaml
+
+### Applying the Configuration
+Save the below YAML to a file (e.g., `destination.yaml`) and apply it using kubectl:
+
+```bash
+kubectl apply -f destination.yaml
+```
+Optional fields are commented out; be sure to uncomment any relevant fields before applying.
+
+
+```yaml
+apiVersion: odigos.io/v1alpha1
+kind: Destination
+metadata:
+  name: dynatrace-example
+  namespace: <odigos namespace>
+spec:
+  data:
+    DYNATRACE_URL: <Tenant URL>
+  destinationName: dynatrace
+  secretRef:
+    name: dynatrace-secret
+  signals:
+  - TRACES
+  - METRICS
+  - LOGS
+  type: dynatrace
+
+---
+apiVersion: v1
+data:
+  DYNATRACE_API_TOKEN: <base64 API Access Token>
+kind: Secret
+metadata:
+  name: dynatrace-secret
+  namespace: <odigos namespace>
+type: Opaque
+```

docs/backends/elasticsearch.mdx

@@ -25,3 +25,51 @@ If empty, the system root CA will be used to validate the server certificate.
 ## Authentication
 
 If your Elasticsearch cluster requires authentication, you can provide the username and password.
+
+
+## Deploying using yaml
+
+### Applying the Configuration
+Save the below YAML to a file (e.g., `destination.yaml`) and apply it using kubectl:
+
+```bash
+kubectl apply -f destination.yaml
+```
+Optional fields are commented out; be sure to uncomment any relevant fields before applying.
+
+
+```yaml
+apiVersion: odigos.io/v1alpha1
+kind: Destination
+metadata:
+  name: elasticsearch-example
+  namespace: <odigos namespace>
+spec:
+  data:
+    ELASTICSEARCH_URL: <Elasticsearch URL>
+    # ES_TRACES_INDEX: <Traces Index>
+    # ES_LOGS_INDEX: <Logs Index>
+    # ELASTICSEARCH_USERNAME: <Username>
+    # ELASTICSEARCH_CA_PEM: <CA Certificate>
+    # Note: The commented fields above are optional.
+  destinationName: elasticsearch
+  # Uncomment the secretRef below if you are using the optional Secret.
+  # secretRef:
+  #   name: elasticsearch-secret
+
+  signals:
+  - TRACES
+  - LOGS
+  type: elasticsearch
+
+---
+# The following Secret is optional. Uncomment the entire block if you need to use it.
+# apiVersion: v1
+# data:
+#   ELASTICSEARCH_PASSWORD: <base64 Password>
+# kind: Secret
+# metadata:
+#   name: elasticsearch-secret
+#   namespace: <odigos namespace>
+# type: Opaque
+```

docs/backends/googlecloud.mdx

@@ -4,3 +4,30 @@ title: "Google Cloud Monitoring"
 
 Odigos currently supports Standard (non-Autopilot) GKE clusters.
 Exporting into Google Cloud does not require credentials as the Kubernetes nodes are permissioned to access the Google Cloud Monitoring APIs by default.
+
+
+## Deploying using yaml
+
+### Applying the Configuration
+Save the below YAML to a file (e.g., `destination.yaml`) and apply it using kubectl:
+
+```bash
+kubectl apply -f destination.yaml
+```
+Optional fields are commented out; be sure to uncomment any relevant fields before applying.
+
+
+```yaml
+apiVersion: odigos.io/v1alpha1
+kind: Destination
+metadata:
+  name: googlecloud-example
+  namespace: <odigos namespace>
+spec:
+  data: {}
+  destinationName: googlecloud
+  signals:
+  - TRACES
+  - LOGS
+  type: googlecloud
+```

docs/backends/grafanacloudloki.mdx

@@ -35,3 +35,45 @@ Make sure your token scope includes "logs:write" scope.
 ### Loki Labels
 
 Read about setting grafana loki labels in the [Loki](/backends/loki#loki-labels) page.
+
+
+## Deploying using yaml
+
+### Applying the Configuration
+Save the below YAML to a file (e.g., `destination.yaml`) and apply it using kubectl:
+
+```bash
+kubectl apply -f destination.yaml
+```
+Optional fields are commented out; be sure to uncomment any relevant fields before applying.
+
+
+```yaml
+apiVersion: odigos.io/v1alpha1
+kind: Destination
+metadata:
+  name: grafanacloudloki-example
+  namespace: <odigos namespace>
+spec:
+  data:
+    GRAFANA_CLOUD_LOKI_ENDPOINT: <Endpoint>
+    # GRAFANA_CLOUD_LOKI_LABELS: <Labels>
+    # Note: The commented fields above are optional.
+    GRAFANA_CLOUD_LOKI_USERNAME: <Username>
+  destinationName: grafanacloudloki
+  secretRef:
+    name: grafanacloudloki-secret
+  signals:
+  - LOGS
+  type: grafanacloudloki
+
+---
+apiVersion: v1
+data:
+  GRAFANA_CLOUD_LOKI_PASSWORD: <base64 Password (Api Token)>
+kind: Secret
+metadata:
+  name: grafanacloudloki-secret
+  namespace: <odigos namespace>
+type: Opaque
+```