[nr-k8s-otel-collector] Rendered examples instructions + updates. (#1709)

<!--
Thank you for contributing to New Relic's Helm charts. Before you submit
this PR we'd like to
make sure you are aware of our technical requirements:

*
https://github.com/newrelic-experimental/helm-charts/blob/master/CONTRIBUTING.md#technical-requirements

For a quick overview across what we will look at reviewing your PR,
please read
our review guidelines:

*
https://github.com/newrelic-experimental/helm-charts/blob/master/REVIEW_GUIDELINES.md

Following our best practices right from the start will accelerate the
review process and
help get your PR merged quicker.

When updates to your PR are requested, please add new commits and do not
squash the
history. This will make it easier to identify new changes. The PR will
be squashed
anyways when it is merged. Thanks.

For fast feedback, please @-mention maintainers that are listed in the
Chart.yaml file.

Please make sure you test your changes before you push them. Once
pushed, a Github Action
will run across your changes and do some initial checks and linting.
These checks run
very quickly. Please check the results. We would like these checks to
pass before we
even continue reviewing your changes.
-->
#### Is this a new chart
No.

#### What this PR does / why we need it:
Adds instructions for using the rendered yaml files. 

* Moves the rendered namespace to `newrelic` instead of `default`. 
* Runs the integration on Pull requests instead of merges to master. 
  + This is necessary since all changes to main needs a 🟢 to be applied.
* uses a symbolic link for the values.yaml so we don't have to maintain
a separate values.yaml for rendering these files.

#### Which issue this PR fixes
*(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)`
format, will close that issue when PR gets merged)*
  - fixes #

#### Special notes for your reviewer:

#### Checklist
[Place an '[x]' (no spaces) in all applicable fields. Please remove
unrelated fields.]
- [x] Chart Version bumped
- [x] Variables are documented in the README.md
- [ ] Title of the PR starts with chart name (e.g. `[mychartname]`)

---------

Co-authored-by: Daniel Budziwojski <[email protected]>

Author: Philip-R-Beckwith

.github/workflows/run-makefile.yaml

@@ -2,8 +2,9 @@ name: Run Makefile
 
 on:
   push:
-    branches:
-      - master
+    branches-ignore:
+      - '**master'
+      - '**main'
     paths:
       - 'charts/nr-k8s-otel-collector/**'
 
@@ -13,7 +14,9 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
       - name: Set up Helm
         uses: azure/setup-helm@v3

Makefile

@@ -13,7 +13,7 @@ generate-examples:
 			VALUES=$$(find $${EXAMPLES_DIR}/$${example} -name *values.yaml); \
 			rm -rf "$${EXAMPLES_DIR}/$${example}/rendered"; \
 			for value in $${VALUES}; do \
-				helm template example charts/$${chart_name} --namespace default --values $${value} --output-dir "$${EXAMPLES_DIR}/$${example}/rendered"; \
+				helm template example charts/$${chart_name} --namespace newrelic --set licenseKey='<NR_licenseKey>' --set cluster='<cluser_name>' --values $${value} --output-dir "$${EXAMPLES_DIR}/$${example}/rendered"; \
 				mv $${EXAMPLES_DIR}/$${example}/rendered/$${chart_name}/templates/* "$${EXAMPLES_DIR}/$${example}/rendered"; \
 				SUBCHARTS_DIR=$${EXAMPLES_DIR}/$${example}/rendered/$${chart_name}/charts; \
 				if [ -d "$${SUBCHARTS_DIR}" ]; then \
@@ -39,7 +39,7 @@ check-examples:
 			for value in $${VALUES}; do \
 			  	make install-helm-dependencies -C charts/$${chart_name}; \
 				helm dependency build charts/$${chart_name}; \
-				helm template example charts/$${chart_name} --namespace default --values $${value} --output-dir "${TMP_DIRECTORY}/$${example}"; \
+				helm template example charts/$${chart_name} --namespace newrelic --set licenseKey='<NR_licenseKey>' --set cluster='<cluser_name>' --values $${value} --output-dir "${TMP_DIRECTORY}/$${example}"; \
 				SUBCHARTS_DIR=${TMP_DIRECTORY}/$${example}/$${chart_name}/charts; \
 				SUBCHARTS=$$(find $${SUBCHARTS_DIR} -maxdepth 1 -mindepth 1 -type d -exec basename \{\} \;); \
 				for subchart in $${SUBCHARTS}; do \

charts/nr-k8s-otel-collector/Chart.yaml

@@ -17,7 +17,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.8.13
+version: 0.8.14
 
 dependencies:
   - name: common-library

charts/nr-k8s-otel-collector/README.md

@@ -68,6 +68,41 @@ If using GKE Autopilot, please set the following configuration in your values.ya
 gkeAutopilot: true
 ```
 
+## Helmless installation
+In the event that you cannot use helm to install this chart we have provided rendered files for you.
+The rendered files can be found under [examples/k8s/rendered](examples/k8s/rendered). 
+Copy the contents of [examples/k8s/rendered](examples/k8s/rendered) to your local workspace.
+There's a couple of values you'll need to plug in first, but after you make some quick edits you'll be able to deploy these K8s files as you normally would. 
+
+Update the license key in [secret.yaml](examples/k8s/rendered/secret.yaml).
+Ensure that you have encoded your license key in base64
+```yaml
+data:
+  licenseKey: <Your Base64 encoded License key>
+```
+
+You will also have to manually update your cluster name in [daemonset-configmap.yaml](examples/k8s/rendered/daemonset-configmap.yaml), and [deployment-configmap.yaml](examples/k8s/rendered/deployment-configmap.yaml).
+Look for uses of `k8s.cluster.name` and replace `<cluster_name>` with your cluster's name.
+```yaml
+- key: k8s.cluster.name
+  action: upsert
+  value: <cluster_name>
+```
+
+After these required fields are updated you can use the yamls to install this project onto your cluster with your preferred method.
+
+### Install the chart with kubectl
+```bash
+kubectl create namespace newrelic
+kubectl apply -n newrelic -R -f rendered
+```
+
+### Uninstall the chart with kubectl
+```bash
+kubectl delete -R -f rendered
+kubectl delete namespaces newrelic
+```
+
 ## Values
 
 | Key                                   | Type | Default | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

charts/nr-k8s-otel-collector/examples/k8s/rendered/clusterrole.yaml

@@ -9,7 +9,7 @@ metadata:
     app.kubernetes.io/managed-by: Helm
     app.kubernetes.io/name: nr-k8s-otel-collector
     app.kubernetes.io/version: 1.0.3
-    helm.sh/chart: nr-k8s-otel-collector-0.8.9
+    helm.sh/chart: nr-k8s-otel-collector-0.8.12
 rules: 
   - apiGroups:
     - ""

charts/nr-k8s-otel-collector/examples/k8s/rendered/clusterrolebinding.yaml

@@ -9,11 +9,11 @@ metadata:
     app.kubernetes.io/managed-by: Helm
     app.kubernetes.io/name: nr-k8s-otel-collector
     app.kubernetes.io/version: 1.0.3
-    helm.sh/chart: nr-k8s-otel-collector-0.8.9
+    helm.sh/chart: nr-k8s-otel-collector-0.8.12
 subjects:
   - kind: ServiceAccount
     name: example-nr-k8s-otel-collector
-    namespace: default
+    namespace: newrelic
 roleRef:
   kind: ClusterRole
   name: example-nr-k8s-otel-collector

charts/nr-k8s-otel-collector/examples/k8s/rendered/daemonset-configmap.yaml

@@ -1,16 +1,16 @@
 ---
 # Source: nr-k8s-otel-collector/templates/daemonset-configmap.yaml
-apiVersion: v1 
+apiVersion: v1
 kind: ConfigMap
 metadata:
   name: example-nr-k8s-otel-collector-daemonset-config
-  namespace: default
+  namespace: newrelic
   labels:
     app.kubernetes.io/instance: example
     app.kubernetes.io/managed-by: Helm
     app.kubernetes.io/name: nr-k8s-otel-collector
     app.kubernetes.io/version: 1.0.3
-    helm.sh/chart: nr-k8s-otel-collector-0.8.9
+    helm.sh/chart: nr-k8s-otel-collector-0.8.12
 data:
   daemonset-config.yaml: |
     receivers:
@@ -459,13 +459,13 @@ data:
           # We set the cluster name to what the customer specified in the helm chart
           - key: k8s.cluster.name
             action: upsert
-            value: DEMO_CLUSTER
+            value: <cluser_name>
           - key: newrelicOnly
             action: upsert
             value: 'true'
           - key: "newrelic.chart.version"
             action: upsert
-            value: 0.8.9
+            value: 0.8.12
           - key: service.name
             action: delete
           - key: service_name
@@ -590,7 +590,7 @@ data:
             - k8s.node.name
             - k8s.pod.start_time
         pod_association:
-          - sources: 
+          - sources:
             - from: resource_attribute
               name: k8s.pod.uid
 
@@ -624,6 +624,7 @@ data:
             - kubeletstats
             - prometheus
           processors:
+            - memory_limiter
             - metricstransform/ldm
             - metricstransform/kubeletstats
             - metricstransform/cadvisor
@@ -648,7 +649,6 @@ data:
             - resource/low_data_mode_inator
             - attributes/self
             - k8sattributes
-            - memory_limiter
             - cumulativetodelta
             - batch
           exporters:
@@ -657,6 +657,7 @@ data:
           receivers:
             - filelog
           processors:
+            - memory_limiter
             - transform/truncate
             - resource
             - k8sattributes

charts/nr-k8s-otel-collector/examples/k8s/rendered/daemonset.yaml

@@ -4,14 +4,14 @@ apiVersion: apps/v1
 kind: DaemonSet
 metadata:
   name: example-nr-k8s-otel-collector-daemonset
-  namespace: default
+  namespace: newrelic
   labels:
     app.kubernetes.io/instance: example
     app.kubernetes.io/managed-by: Helm
     app.kubernetes.io/name: nr-k8s-otel-collector
     app.kubernetes.io/version: 1.0.3
-    helm.sh/chart: nr-k8s-otel-collector-0.8.9
-spec: 
+    helm.sh/chart: nr-k8s-otel-collector-0.8.12
+spec:
   selector:
     matchLabels:
       app.kubernetes.io/instance: example
@@ -24,31 +24,31 @@ spec:
         app.kubernetes.io/name: nr-k8s-otel-collector
         component: daemonset
       annotations:
-        checksum/config: e8edfd79b4ef3661b44f3399f42c6b8374dbce6c016e11b36109b094cad39457
+        checksum/config: 8046db691ebcb15a77d39e8fb1898aedc4b122c7a1fb4d8c464202fae6ac12a7
     spec:
       serviceAccountName: example-nr-k8s-otel-collector
       containers:
         - name: otel-collector-daemonset
           securityContext:
             privileged: true
-          image: "newrelic/nr-otel-collector:0.8.3"
+          image: "newrelic/nrdot-collector-k8s:1.0.3"
           imagePullPolicy: IfNotPresent
           args: ["--config", "/config/daemonset-config.yaml", "--feature-gates","receiver.kubeletstats.enableCPUUsageMetrics"]
           resources:
             {}
           env:
             - name: HOST_IP
-              valueFrom: 
+              valueFrom:
                 fieldRef:
-                  fieldPath: status.hostIP 
-            - name: OTEL_EXPORTER_OTLP_ENDPOINT 
+                  fieldPath: status.hostIP
+            - name: OTEL_EXPORTER_OTLP_ENDPOINT
               value: "http://$(HOST_IP):55680"
             - name: POD_NAME
               valueFrom:
                 fieldRef:
                   fieldPath: metadata.name
             - name: POD_UID
-              valueFrom: 
+              valueFrom:
                 fieldRef:
                   fieldPath: metadata.uid
             - name: KUBE_NODE_NAME

charts/nr-k8s-otel-collector/examples/k8s/rendered/deployment-configmap.yaml

@@ -4,13 +4,13 @@ apiVersion: v1
 kind: ConfigMap
 metadata:
   name: example-nr-k8s-otel-collector-deployment-config
-  namespace: default
+  namespace: newrelic
   labels:
     app.kubernetes.io/instance: example
     app.kubernetes.io/managed-by: Helm
     app.kubernetes.io/name: nr-k8s-otel-collector
     app.kubernetes.io/version: 1.0.3
-    helm.sh/chart: nr-k8s-otel-collector-0.8.9
+    helm.sh/chart: nr-k8s-otel-collector-0.8.12
 data:
   deployment-config.yaml: |
     receivers:
@@ -383,13 +383,13 @@ data:
           # We set the cluster name to what the customer specified in the helm chart
           - key: k8s.cluster.name
             action: upsert
-            value: DEMO_CLUSTER
+            value: <cluser_name>
           - key: newrelicOnly
             action: upsert
             value: 'true'
           - key: "newrelic.chart.version"
             action: upsert
-            value: 0.8.9
+            value: 0.8.12
           - key: service.name
             action: delete
           - key: service_name
@@ -408,13 +408,13 @@ data:
             value: "kubernetes"
           - key: k8s.cluster.name
             action: upsert
-            value: DEMO_CLUSTER
+            value: <cluser_name>
           - key: newrelicOnly
             action: upsert
             value: 'true'
           - key: "newrelic.chart.version"
             action: upsert
-            value: 0.8.9
+            value: 0.8.12
 
       transform/events:
         log_statements:
@@ -568,6 +568,7 @@ data:
           receivers:
             - prometheus/ksm
           processors:
+            - memory_limiter
             - metricstransform/kube_pod_status_phase
             - filter/exclude_zero_value_kube_node_status_condition
             - filter/exclude_zero_value_kube_persistentvolumeclaim_status_phase
@@ -590,6 +591,7 @@ data:
           receivers:
             - prometheus/controlplane
           processors:
+            - memory_limiter
             - metricstransform/k8s_cluster_info
             - metricstransform/ldm
             - metricstransform/k8s_cluster_info_ldm
@@ -600,7 +602,6 @@ data:
             - resource/metrics
             - attributes/self
             - k8sattributes
-            - memory_limiter
             - cumulativetodelta
             - batch
           exporters:
@@ -609,6 +610,7 @@ data:
           receivers:
             - k8s_events
           processors:
+            - memory_limiter
             - transform/events
             - resource/events
             - batch

charts/nr-k8s-otel-collector/examples/k8s/rendered/deployment.yaml

@@ -4,13 +4,13 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: example-nr-k8s-otel-collector-deployment
-  namespace: default
+  namespace: newrelic
   labels:
     app.kubernetes.io/instance: example
     app.kubernetes.io/managed-by: Helm
     app.kubernetes.io/name: nr-k8s-otel-collector
     app.kubernetes.io/version: 1.0.3
-    helm.sh/chart: nr-k8s-otel-collector-0.8.9
+    helm.sh/chart: nr-k8s-otel-collector-0.8.12
 spec:
   replicas: 1
   minReadySeconds: 5
@@ -26,12 +26,12 @@ spec:
         app.kubernetes.io/name: nr-k8s-otel-collector
         component: deployment
       annotations:
-        checksum/config: d53bb22046dc8c2ef5d0d9cb9fff42ce6cea0f69df0ab5a5e4200b5bff6b95cd
+        checksum/config: fa5ac66a7144336872fe12ab075a6c8ab3f8ef2bcf17e37d1c82f71c48b47a92
     spec:
       serviceAccountName: example-nr-k8s-otel-collector
       containers:
         - name: otel-collector-deployment
-          image: "newrelic/nr-otel-collector:0.8.3"
+          image: "newrelic/nrdot-collector-k8s:1.0.3"
           imagePullPolicy: IfNotPresent
           args: ["--config", "/config/deployment-config.yaml"]
           resources:

charts/nr-k8s-otel-collector/examples/k8s/rendered/kube-state-metrics/clusterrolebinding.yaml

@@ -19,4 +19,4 @@ roleRef:
 subjects:
 - kind: ServiceAccount
   name: example-kube-state-metrics
-  namespace: default
+  namespace: newrelic

charts/nr-k8s-otel-collector/examples/k8s/rendered/kube-state-metrics/deployment.yaml

@@ -4,7 +4,7 @@ apiVersion: apps/v1
 kind: Deployment
 metadata:
   name: example-kube-state-metrics
-  namespace: default
+  namespace: newrelic
   labels:    
     helm.sh/chart: kube-state-metrics-5.18.0
     app.kubernetes.io/managed-by: Helm

charts/nr-k8s-otel-collector/examples/k8s/rendered/kube-state-metrics/service.yaml

@@ -4,7 +4,7 @@ apiVersion: v1
 kind: Service
 metadata:
   name: example-kube-state-metrics
-  namespace: default
+  namespace: newrelic
   labels:    
     helm.sh/chart: kube-state-metrics-5.18.0
     app.kubernetes.io/managed-by: Helm

charts/nr-k8s-otel-collector/examples/k8s/rendered/kube-state-metrics/serviceaccount.yaml

@@ -12,4 +12,4 @@ metadata:
     app.kubernetes.io/instance: example
     app.kubernetes.io/version: "2.11.0"
   name: example-kube-state-metrics
-  namespace: default
+  namespace: newrelic

charts/nr-k8s-otel-collector/examples/k8s/rendered/secret.yaml

@@ -4,12 +4,12 @@ apiVersion: v1
 kind: Secret
 metadata:
   name: example-nr-k8s-otel-collector-license
-  namespace: default
+  namespace: newrelic
   labels:
     app.kubernetes.io/instance: example
     app.kubernetes.io/managed-by: Helm
     app.kubernetes.io/name: nr-k8s-otel-collector
     app.kubernetes.io/version: 1.0.3
-    helm.sh/chart: nr-k8s-otel-collector-0.8.9
+    helm.sh/chart: nr-k8s-otel-collector-0.8.12
 data:
-  licenseKey: REVNT19MSUNFTlNFX0tFWQ==
+  licenseKey: PE5SX2xpY2Vuc2VLZXk+