Merge pull request #12 from axoflow/docs/add-examples

docs: add helm examples

Author: csatib02

README.md

@@ -22,7 +22,7 @@ You can find guides per connector:
 
 | Variable | Required | Default | Description |
 |----------|----------|---------|-------------|
-| `AZURE_EVENTHUB_CONNECTION_STRING` | Yes | - | Azure Event Hub connection string |
+| `AZURE_EVENT_HUBS_CONNECTION_STRING` | Yes | - | Azure Event Hub connection string |
 
 ### AWS Provider
 

charts/cloudconnectors/values.yaml

@@ -58,11 +58,11 @@ storage:
 env:
   # - name: "AXOROUTER_ENDPOINT"
   #   value: "axorouter.axoflow-local.svc.cluster.local:4317"
-  # - name: "AZURE_EVENTHUB_CONNECTION_STRING"
+  # - name: "AZURE_EVENT_HUBS_CONNECTION_STRING"
   #   valueFrom:
   #     secretKeyRef:
-  #       name: "azure-eventhub"
-  #       key: "connection"
+  #       name: "azure-event-hubs"
+  #       key: "connection-string"
   # - name: "AWS_REGION"
   #   value: "eu-central-1"
   # - name: "AWS_PROFILE"

connectors/aws/README.md

@@ -60,3 +60,32 @@ awsConfig:
   # -- Filesystem configuration (when useSecret: false)
   hostPath: "/root/.aws"
 ```
+
+### Example deploy with Axorouter in cluster
+
+```bash
+make minikube-cluster
+make docker-build
+make minikube-load-image
+
+kubectl create namespace cloudconnectors
+kubectl create secret generic aws-credentials \
+  --from-literal=access-key-id="<YOUR-AWS-ACCESS-KEY-ID>" \
+  --from-literal=secret-access-key="<YOUR-AWS-SECRET-ACCESS-KEY>" \
+  --namespace cloudconnectors \
+  --dry-run=client -o yaml | kubectl apply -f -
+
+helm upgrade --install --wait --namespace cloudconnectors cloudconnectors ./charts/cloudconnectors \
+  --set image.repository="axocloudconnectors" \
+  --set image.tag="dev" \
+  --set 'env[0].name=AXOROUTER_ENDPOINT' \
+  --set 'env[0].value=axorouter.axoflow-local.svc.cluster.local:4317' \
+  --set 'env[1].name=AWS_REGION' \
+  --set 'env[1].value=<YOUR-AWS-REGION>' \
+  --set 'env[2].name=AWS_ACCESS_KEY_ID' \
+  --set 'env[2].valueFrom.secretKeyRef.name=aws-credentials' \
+  --set 'env[2].valueFrom.secretKeyRef.key=access-key-id' \
+  --set 'env[3].name=AWS_SECRET_ACCESS_KEY' \
+  --set 'env[3].valueFrom.secretKeyRef.name=aws-credentials' \
+  --set 'env[3].valueFrom.secretKeyRef.key=secret-access-key'
+```

connectors/azure/README.md

@@ -10,7 +10,7 @@ Make sure the required environment variables are set before running the connecto
 docker run \
         --rm \
         -v "${STORAGE_DIRECTORY}":"${STORAGE_DIRECTORY}" \
-        -e AZURE_EVENTHUB_CONNECTION_STRING="${AZURE_EVENTHUB_CONNECTION_STRING}" \
+        -e AZURE_EVENT_HUBS_CONNECTION_STRING="${AZURE_EVENT_HUBS_CONNECTION_STRING}" \
         -e AXOROUTER_ENDPOINT="${AXOROUTER_ENDPOINT}" \
         -e STORAGE_DIRECTORY="${STORAGE_DIRECTORY}" \
         ghcr.io/axoflow/axocloudconnectors:latest
@@ -19,3 +19,26 @@ docker run \
 ## Deploy with Helm-chart
 
 1. Set the required environment-variables.
+
+### Example deploy with Axorouter in cluster
+
+```bash
+make minikube-cluster
+make docker-build
+make minikube-load-image
+
+kubectl create namespace cloudconnectors
+kubectl create secret generic azure-event-hubs \
+  --from-literal=connection-string="<YOUR-AZURE-EVENT-HUBS-CONNECTION-STRING>" \
+  --namespace cloudconnectors \
+  --dry-run=client -o yaml | kubectl apply -f -
+
+helm upgrade --install --wait --namespace cloudconnectors cloudconnectors ./charts/cloudconnectors \
+  --set image.repository="axocloudconnectors" \
+  --set image.tag="dev" \
+  --set 'env[0].name=AXOROUTER_ENDPOINT' \
+  --set 'env[0].value=axorouter.axoflow-local.svc.cluster.local:4317' \
+  --set 'env[1].name=AZURE_EVENT_HUBS_CONNECTION_STRING' \
+  --set 'env[1].valueFrom.secretKeyRef.name=azure-event-hubs' \
+  --set 'env[1].valueFrom.secretKeyRef.key=connection-string'
+```

connectors/azure/config.yaml

@@ -1,6 +1,6 @@
 receivers:
   azureeventhub:
-    connection: ${env:AZURE_EVENTHUB_CONNECTION_STRING}
+    connection: ${env:AZURE_EVENT_HUBS_CONNECTION_STRING}
     format: azure
     apply_semantic_conventions: true
     storage: file_storage