feat: add k8s node and cluster config

Author: kb-newrelic

.github/workflows/ci-config-drift.yaml

@@ -16,23 +16,6 @@ jobs:
       - name: Set up Helm
         uses: azure/[email protected]
 
-      - name: Setup local kind cluster
-        uses: helm/kind-action@v1
-        with:
-          version: v0.21.0
-          cluster_name: "config-drift"
-          wait: 60s
-
-      - name: Install nr-k8s-otel-collector chart
+      - name: Sync k8s distro configs from helm chart
         run: |
-          helm repo add newrelic https://newrelic.github.io/helm-charts
-          
-          helm install test newrelic/nr-k8s-otel-collector -n default \
-            --set cluster=config-drift --set licenseKey=PLACEHOLDER \
-            --create-namespace --dependency-update
-          
-          kubectl get configmaps -n default test-nr-k8s-otel-collector-daemonset-config \
-            -o "jsonpath={.data['daemonset-config\.yaml']}" | yq .
-          
-          kubectl get configmaps -n default test-nr-k8s-otel-collector-deployment-config \
-            -o "jsonpath={.data['deployment-config\.yaml']}" | yq .
+          make -f ./distributions/nrdot-collector-k8s/Makefile sync-configs

.github/workflows/ci-nightly.yaml

@@ -48,6 +48,7 @@ jobs:
         distribution:
           - nr-otel-collector
           - nrdot-collector-host
+          - nrdot-collector-k8s
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/ci.yaml

@@ -18,6 +18,7 @@ jobs:
         distribution:
           - nr-otel-collector
           - nrdot-collector-host
+          - nrdot-collector-k8s
     uses: ./.github/workflows/ci-base.yaml
     with:
       distribution: ${{ matrix.distribution }}

Makefile

@@ -16,7 +16,7 @@ TOOLS_BIN_NAMES := $(addprefix $(TOOLS_BIN_DIR)/, $(notdir $(shell echo $(TOOLS_
 GO_LICENCE_DETECTOR        := $(TOOLS_BIN_DIR)/go-licence-detector
 GO_LICENCE_DETECTOR_CONFIG   := $(SRC_ROOT)/internal/assets/license/rules.json
 
-DISTRIBUTIONS ?= "nr-otel-collector,nrdot-collector-host"
+DISTRIBUTIONS ?= "nr-otel-collector,nrdot-collector-host,nrdot-collector-k8s"
 
 ci: check build licenses-check
 check: ensure-goreleaser-up-to-date

cmd/goreleaser/internal/configure.go

@@ -42,9 +42,20 @@ const (
 var (
 	ImagePrefixes        = []string{DockerHub}
 	NightlyImagePrefixes = []string{EnvRegistry}
-
-	Architectures      = []string{"amd64", "arm64"}
-	DefaultConfigDists = map[string]bool{LegacyDistro: true, HostDistro: true}
+	Architectures        = []string{"amd64", "arm64"}
+	SkipBinaries         = map[string]bool{
+		K8sDistro: true,
+	}
+	NfpmDefaultConfig = map[string]string{
+		LegacyDistro: "config.yaml",
+		HostDistro:   "config.yaml",
+		// k8s missing due to not packaged via nfpm
+	}
+	DockerIncludedConfigs = map[string][]string{
+		LegacyDistro: {"config.yaml"},
+		HostDistro:   {"config.yaml"},
+		K8sDistro:    {"config-node.yaml", "config-cluster.yaml"},
+	}
 	K8sDockerSkipArchs = map[string]bool{"arm": true, "386": true}
 	K8sGoos            = []string{"linux"}
 	K8sArchs           = []string{"amd64", "arm64"}
@@ -85,10 +96,9 @@ func Generate(dist string, nightly bool) config.Project {
 }
 
 func Blobs(dist string, nightly bool) []config.Blob {
-	if dist == K8sDistro {
+	if skip, ok := SkipBinaries[dist]; ok && skip {
 		return nil
 	}
-
 	version := "{{ .Version }}"
 
 	if nightly {
@@ -154,6 +164,9 @@ func ArmVersions(dist string) []string {
 }
 
 func Archives(dist string) []config.Archive {
+	if skip, ok := SkipBinaries[dist]; ok && skip {
+		return nil
+	}
 	return []config.Archive{
 		Archive(dist),
 	}
@@ -175,7 +188,7 @@ func Archive(dist string) config.Archive {
 }
 
 func Packages(dist string) []config.NFPM {
-	if dist == K8sDistro {
+	if skip, ok := SkipBinaries[dist]; ok && skip {
 		return nil
 	}
 	return []config.NFPM{
@@ -197,9 +210,9 @@ func Package(dist string) config.NFPM {
 			Type:        "config|noreplace",
 		},
 	}
-	if _, ok := DefaultConfigDists[dist]; ok {
+	if defaultConfig, ok := NfpmDefaultConfig[dist]; ok {
 		nfpmContents = append(nfpmContents, config.NFPMContent{
-			Source:      "config.yaml",
+			Source:      defaultConfig,
 			Destination: path.Join("/etc", dist, "config.yaml"),
 			Type:        "config",
 		})
@@ -294,8 +307,10 @@ func DockerImage(dist string, nightly bool, arch string, armVersion string) conf
 		return fmt.Sprintf("--label=org.opencontainers.image.%s={{%s}}", name, template)
 	}
 	files := make([]string, 0)
-	if _, ok := DefaultConfigDists[dist]; ok {
-		files = append(files, "config.yaml")
+	if configFiles, ok := DockerIncludedConfigs[dist]; ok {
+		for _, configFile := range configFiles {
+			files = append(files, configFile)
+		}
 	}
 	return config.Docker{
 		ImageTemplates: imageTemplates,

configs/README.md

@@ -2,17 +2,26 @@
 
 ## Installation
 
-### General
+### Docker
 
-#### Environment variables
-- `NEW_RELIC_LICENSE_KEY`: New Relic ingest key.
-- `NEW_RELIC_MEMORY_LIMIT_MIB`: Maximum amount of memory to be used. 
-- `OTEL_EXPORTER_OTLP_ENDPOINT`: New Relic OTLP endpoint to export metrics to, see [official docs](https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/)
+Each distribution is available as a Docker image under the [newrelic](https://hub.docker.com/u/newrelic?page=1&search=nrdot-collector) organization on Docker Hub.
+
+### OS-specific packages
+For certain distributions, signed OS-specific packages are also available under [Releases](https://github.com/newrelic/opentelemetry-collector-releases/releases) on GitHub.
+
+## Configuration
 
 ### Components
 
 The full list of components is available in the respective `manifest.yaml`
 
-### Configuration
+### Customize Default Configuration
+
+The default configuration exposes some options via environment variables:
+
+| Environment Variable | Description | Default |
+|---|---|---|
+| `NEW_RELIC_LICENSE_KEY` | New Relic ingest key | N/A - Required |
+| `NEW_RELIC_MEMORY_LIMIT_MIB` | Maximum amount of memory to be used | 100 |
+| `OTEL_EXPORTER_OTLP_ENDPOINT` | New Relic OTLP endpoint to export metrics to, see [official docs](https://docs.newrelic.com/docs/opentelemetry/best-practices/opentelemetry-otlp/) | `https://otlp.nr-data.net:4317` |
 
-The default configuration is `config.yaml` which is embedded in the `Dockerfile` and any OS-specific packaging (if available).

configs/nr-otel-collector-gateway.yaml

@@ -5,3 +5,5 @@ Note: See [general README](../README.md) for information that applies to all dis
 A distribution of the NRDOT collector focused on
 - monitoring the host the collector is deployed on via `hostmetricsreceiver` and `filelogreceiver`
 - support piping other telemetry through it via the `otlpreceiver`
+
+Distribution is available as docker image and as OS-specific package.

distributions/README.md

@@ -1,5 +1,7 @@
 version: 2
 project_name: nrdot-collector-releases-nightly
+release:
+  disable: "true"
 builds:
   - id: nrdot-collector-k8s
     goos:
@@ -16,15 +18,6 @@ builds:
       - -trimpath
     env:
       - CGO_ENABLED=0
-archives:
-  - id: nrdot-collector-k8s
-    builds:
-      - nrdot-collector-k8s
-    name_template: '{{ .Binary }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}{{ if .Mips }}_{{ .Mips }}{{ end }}'
-    format_overrides:
-      - goos: windows
-        formats:
-          - zip
 snapshot:
   version_template: '{{ incpatch .Version }}-SNAPSHOT-{{.ShortCommit}}'
 checksum:
@@ -38,6 +31,9 @@ dockers:
     image_templates:
       - '{{ .Env.REGISTRY }}/nrdot-collector-k8s:{{ .Version }}-nightly-amd64'
       - '{{ .Env.REGISTRY }}/nrdot-collector-k8s:nightly-amd64'
+    extra_files:
+      - config-node.yaml
+      - config-cluster.yaml
     build_flag_templates:
       - --pull
       - --platform=linux/amd64
@@ -54,6 +50,9 @@ dockers:
     image_templates:
       - '{{ .Env.REGISTRY }}/nrdot-collector-k8s:{{ .Version }}-nightly-arm64'
       - '{{ .Env.REGISTRY }}/nrdot-collector-k8s:nightly-arm64'
+    extra_files:
+      - config-node.yaml
+      - config-cluster.yaml
     build_flag_templates:
       - --pull
       - --platform=linux/arm64
@@ -82,9 +81,3 @@ signs:
       - ${artifact}
     signature: ${artifact}.sig
     artifacts: all
-    certificate: ${artifact}.pem
-docker_signs:
-  - args:
-      - sign
-      - ${artifact}
-    artifacts: all