Merge pull request #65 from lightstep/update-readme-otelcol-arrow-exp…

…erimental-docker-image-ghcr

Update readme to include references to ghcr.io/lightstep/otel-collector-charts/otelcolarrow-experimental

README.md

@@ -14,7 +14,19 @@ This is the repository for recommended [Helm](https://helm.sh/) charts for runni
 > [!NOTE] 
 > Arrow usage is in beta, please use at your own risk. Reach out if you have any issues.
 
-In order to use an arrow trace collector, you will need to build your own custom image. We have supplied a collector builder config below. Once an image is a available, simply apply your desired helm chart with the values.yaml AND the arrow.yaml in the respective chart. Make sure to replace the image in arrow.yaml with your custom built image.
+In order to use an arrow trace collector, you can use  (1) the prebuilt image available via the Github Container Registry (GHCR) or you may (2) build your own custom image.
+
+### 1. Use the prebuilt Docker image
+1. We have built a Docker image using the example [build config](https://github.com/lightstep/otel-collector-charts/blob/main/arrow/otelcolarrow-build.yaml)
+2. This Docker [image](https://github.com/lightstep/otel-collector-charts/pkgs/container/otel-collector-charts%2Fotelarrowcol-experimental) can be pulled by running: `docker pull ghcr.io/lightstep/otel-collector-charts/otelarrowcol-experimental:latest`
+3. You can use the example collector config (`/arrow/config/saas-config.yaml`) by running:
+`docker run -it -v ./config/:/config --entrypoint /otelarrowcol ghcr.io/lightstep/otel-collector-charts/otelarrowcol-experimental:latest --config=/config/saas-collector.yaml`
+
+
+### 2. Build your own custom image
+1. We have supplied a collector builder config below. 
+2. Once an image is a available, simply apply your desired helm chart with the values.yaml AND the arrow.yaml in the respective chart. 
+3. Make sure to replace the image in arrow.yaml with your custom built image.
 
 ## Build configurations
 

charts/kube-otel-stack/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: kube-otel-stack
 description: Chart for sending Kubernetes metrics to Lightstep using the OpenTelemetry Operator.
 type: application
-version: 0.3.8
+version: 0.3.9
 appVersion: 0.83.0
 dependencies:
 # cert manager must be manually installed because it has CRDs

charts/kube-otel-stack/arrow.yaml

@@ -4,7 +4,7 @@
 # does not include these components yet, so a custom image will be
 # needed.  See https://github.com/lightstep/otel-collector-charts/blob/main/gateway-build.yaml
 tracesCollector:
-  image: "your-image-with-arrow-here"
+  image: "ghcr.io/lightstep/otel-collector-charts/otelarrowcol-experimental:latest"
   resources:
     # OTel-Arrow notes: to use OTel-Arrow in a gateway configuration,
     # we recommend the following adjustments:

charts/otel-cloud-stack/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: "0.2.8"
+version: "0.2.9"
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/otel-cloud-stack/arrow.yaml

@@ -4,7 +4,7 @@
 # does not include these components yet, so a custom image will be
 # needed.  See https://github.com/lightstep/otel-collector-charts/blob/main/gateway-build.yaml
 tracesCollector:
-  image: "your-image-with-arrow-here"
+  image: "ghcr.io/lightstep/otel-collector-charts/otelarrowcol-experimental:latest"
   resources:
     # OTel-Arrow notes: to use OTel-Arrow in a gateway configuration,
     # we recommend the following adjustments: