From a57510a455dc5559a187a9266edf7ead836056b8 Mon Sep 17 00:00:00 2001 From: Christian Stewart Date: Wed, 21 Oct 2015 03:09:30 -0400 Subject: [PATCH] Add NewRelic system monitor DaemonSet example Adds an example using DaemonSets to distribute the NewRelic worker onto all nodes in a k8s cluster. Signed-off-by: Christian Stewart --- examples/newrelic/README.md | 179 ++++++++++++++++++ examples/newrelic/config-to-secret.sh | 20 ++ .../newrelic/newrelic-config-template.yaml | 7 + examples/newrelic/newrelic-config.yaml | 10 + examples/newrelic/newrelic-daemonset.yaml | 60 ++++++ examples/newrelic/nrconfig.env | 2 + 6 files changed, 278 insertions(+) create mode 100644 examples/newrelic/README.md create mode 100755 examples/newrelic/config-to-secret.sh create mode 100644 examples/newrelic/newrelic-config-template.yaml create mode 100644 examples/newrelic/newrelic-config.yaml create mode 100644 examples/newrelic/newrelic-daemonset.yaml create mode 100644 examples/newrelic/nrconfig.env diff --git a/examples/newrelic/README.md b/examples/newrelic/README.md new file mode 100644 index 0000000000..b22d6289c3 --- /dev/null +++ b/examples/newrelic/README.md @@ -0,0 +1,179 @@ + + + + +WARNING +WARNING +WARNING +WARNING +WARNING + +

PLEASE NOTE: This document applies to the HEAD of the source tree

+ +If you are using a released version of Kubernetes, you should +refer to the docs that go with that version. + + +The latest 1.0.x release of this document can be found +[here](http://releases.k8s.io/release-1.0/examples/newrelic/README.md). + +Documentation for other releases can be found at +[releases.k8s.io](http://releases.k8s.io). + +-- + + + + + +## New Relic Server Monitoring Agent Example + +This example shows how to run a New Relic server monitoring agent as a pod in a DaemonSet on an existing Kubernetes cluster. + +This example will create a DaemonSet which places the New Relic monitoring agent on every node in the cluster. It's also fairly trivial to exclude specific Kubernetes nodes from the DaemonSet to just monitor specific servers. + +### Step 0: Prerequisites + +This process will create priviliged containers which have full access to the host system for logging. Beware of the security implications of this. + +If you are using a Salt based KUBERNETES\_PROVIDER (**gce**, **vagrant**, **aws**), you should make sure the creation of privileged containers via the API is enabled. Check `cluster/saltbase/pillar/privilege.sls`. + +DaemonSets must be enabled on your cluster. Instructions for enabling DaemonSet can be found [here](../../docs/api.md#enabling-the-extensions-group). + +### Step 1: Configure New Relic Agent + +The New Relic agent is configured via environment variables. We will configure these environment variables in a sourced bash script, encode the environment file data, and store it in a secret which will be loaded at container runtime. + +The [New Relic Linux Server configuration page] +(https://docs.newrelic.com/docs/servers/new-relic-servers-linux/installation-configuration/configuring-servers-linux) lists all the other settings for nrsysmond. + +To create an environment variable for a setting, prepend NRSYSMOND_ to its name. For example, + +```console +loglevel=debug +``` + +translates to + +```console +NRSYSMOND_loglevel=debug +``` + +Edit examples/newrelic/nrconfig.env and set up the environment variables for your NewRelic agent. Be sure to edit the license key field and fill in your own New Relic license key. + +Now, let's vendor the config into a secret. + +```console +$ cd examples/newrelic/ +$ ./config-to-secret.sh +``` + + + +```yaml +apiVersion: v1 +kind: Secret +metadata: + name: newrelic-config +type: Opaque +data: + config: {{config_data}} +``` + +[Download example](newrelic-config-template.yaml?raw=true) + + +The script will encode the config file and write it to `newrelic-config.yaml`. + +Finally, submit the config to the cluster: + +```console +$ kubectl create -f examples/newrelic/newrelic-config.yaml +``` + +### Step 2: Create the DaemonSet definition. + +The DaemonSet definition instructs Kubernetes to place a newrelic sysmond agent on each Kubernetes node. + + + +```yaml +apiVersion: extensions/v1beta1 +kind: DaemonSet +metadata: + name: newrelic-agent + labels: + tier: monitoring + app: newrelic-agent + version: v1 +spec: + template: + metadata: + labels: + name: newrelic + spec: + # Filter to specific nodes: + # nodeSelector: + # app: newrelic + securityContext: + privileged: true + hostPID: true + hostIPC: true + hostNetwork: true + containers: + - resources: + requests: + cpu: 0.15 + env: + - name: NRSYSMOND_logfile + value: "/var/log/nrsysmond.log" + image: newrelic/nrsysmond + name: newrelic + command: [ "bash", "-c", "source /etc/kube-newrelic/config && /usr/sbin/nrsysmond -E -F" ] + volumeMounts: + - name: newrelic-config + mountPath: /etc/kube-newrelic + readOnly: true + - name: dev + mountPath: /dev + - name: run + mountPath: /var/run/docker.sock + - name: sys + mountPath: /sys + - name: log + mountPath: /var/log + volumes: + - name: newrelic-config + secret: + secretName: newrelic-config + - name: dev + hostPath: + path: /dev + - name: run + hostPath: + path: /var/run/docker.sock + - name: sys + hostPath: + path: /sys + - name: log + hostPath: + path: /var/log +``` + +[Download example](newrelic-daemonset.yaml?raw=true) + + +The daemonset instructs Kubernetes to spawn pods on each node, mapping /dev/, /run/, /sys/, and /var/log to the container. It also maps the secrets we set up earlier to /etc/kube-newrelic/config, and sources them in the startup script, configuring the agent properly. + +### Known issues + +It's a bit cludgy to define the environment variables like we do here in these config files. There is [another issue](https://github.com/kubernetes/kubernetes/issues/4710) to discuss adding mapping secrets to environment variables in Kubernetes. + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/examples/newrelic/README.md?pixel)]() + diff --git a/examples/newrelic/config-to-secret.sh b/examples/newrelic/config-to-secret.sh new file mode 100755 index 0000000000..823aa4fde3 --- /dev/null +++ b/examples/newrelic/config-to-secret.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +# Copyright 2014 The Kubernetes Authors All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Encodes the environment variables into a Kubernetes secret. + +BASE64_ENC=$(cat nrconfig.env | base64 --wrap=0) +sed -e "s#{{config_data}}#${BASE64_ENC}#g" ./newrelic-config-template.yaml > newrelic-config.yaml diff --git a/examples/newrelic/newrelic-config-template.yaml b/examples/newrelic/newrelic-config-template.yaml new file mode 100644 index 0000000000..361a307924 --- /dev/null +++ b/examples/newrelic/newrelic-config-template.yaml @@ -0,0 +1,7 @@ +apiVersion: v1 +kind: Secret +metadata: + name: newrelic-config +type: Opaque +data: + config: {{config_data}} diff --git a/examples/newrelic/newrelic-config.yaml b/examples/newrelic/newrelic-config.yaml new file mode 100644 index 0000000000..0a22ee91f1 --- /dev/null +++ b/examples/newrelic/newrelic-config.yaml @@ -0,0 +1,10 @@ +# This file should be overwritten by ./config-to-secret.sh +# This file is in place to statisfy the kubernetes documentation tests. + +# apiVersion: v1 +# kind: Secret +# metadata: +# name: newrelic-config +# type: Opaque +# data: +# config: base64 encoded diff --git a/examples/newrelic/newrelic-daemonset.yaml b/examples/newrelic/newrelic-daemonset.yaml new file mode 100644 index 0000000000..b4cc29f51f --- /dev/null +++ b/examples/newrelic/newrelic-daemonset.yaml @@ -0,0 +1,60 @@ +apiVersion: extensions/v1beta1 +kind: DaemonSet +metadata: + name: newrelic-agent + labels: + tier: monitoring + app: newrelic-agent + version: v1 +spec: + template: + metadata: + labels: + name: newrelic + spec: + # Filter to specific nodes: + # nodeSelector: + # app: newrelic + securityContext: + privileged: true + hostPID: true + hostIPC: true + hostNetwork: true + containers: + - resources: + requests: + cpu: 0.15 + env: + - name: NRSYSMOND_logfile + value: "/var/log/nrsysmond.log" + image: newrelic/nrsysmond + name: newrelic + command: [ "bash", "-c", "source /etc/kube-newrelic/config && /usr/sbin/nrsysmond -E -F" ] + volumeMounts: + - name: newrelic-config + mountPath: /etc/kube-newrelic + readOnly: true + - name: dev + mountPath: /dev + - name: run + mountPath: /var/run/docker.sock + - name: sys + mountPath: /sys + - name: log + mountPath: /var/log + volumes: + - name: newrelic-config + secret: + secretName: newrelic-config + - name: dev + hostPath: + path: /dev + - name: run + hostPath: + path: /var/run/docker.sock + - name: sys + hostPath: + path: /sys + - name: log + hostPath: + path: /var/log diff --git a/examples/newrelic/nrconfig.env b/examples/newrelic/nrconfig.env new file mode 100644 index 0000000000..ddce85294d --- /dev/null +++ b/examples/newrelic/nrconfig.env @@ -0,0 +1,2 @@ +export NRSYSMOND_loglevel=debug +export NRSYSMOND_license_key=REPLACE_LICENSE_KEY_HERE