Merge pull request #206 from Cryptophobia/master

feat(reloader): add custom --buffer-mount-folder option

Author: gautam2187

README.md

@@ -622,6 +622,7 @@ Flags:
   --fluentd-rpc-port=24444      RPC port of Fluentd
   --log-level="info"            Control verbosity of config-reloader logs
   --fluentd-loglevel="info"     Control verbosity of fluentd logs
+  --buffer-mount-folder=""      Folder in /var/log/{} where to create all fluentd buffers
   --annotation="logging.csp.vmware.com/fluentd-configmap"
                                 Which annotation on the namespace stores the configmap name?
   --default-configmap="fluentd-config"
@@ -659,6 +660,7 @@ Flags:
 | `image.pullSecret`                       | Optional pull secret name                 | `""`                                |
 | `logLevel`                               | Default log level for config-reloader                | `info`                               |
 | `fluentdLogLevel`                        | Default log level for fluentd               | `info`                               |
+| `bufferMountFolder`                      | Folder in /var/log/{} where to create all fluentd buffers               | `""`                               |
 | `kubeletRoot`                            | The home dir of the kubelet, usually set using `--root-dir` on the kubelet           | `/var/lib/kubelet`                               |
 | `namespaces`                             | List of namespaces to operate on. Empty means all namespaces                 | `[]`                               |
 | `interval`                               | How often to check for config changes (seconds)                 | `45`          |

charts/log-router/Chart.yaml

@@ -4,7 +4,7 @@
 apiVersion: v1
 description: Distribution of Fluentd as K8S daemonset
 name: log-router
-version: 0.3.7
+version: 0.3.8
 home: https://github.com/vmware/kube-fluentd-operator
 sources:
   - https://github.com/vmware/kube-fluentd-operator

charts/log-router/templates/daemonset.yaml

@@ -106,6 +106,11 @@ spec:
           - --interval={{ .Values.interval }}
           - --log-level={{ .Values.logLevel }}
           - --fluentd-loglevel={{ .Values.fluentdLogLevel }}
+          {{- if not (empty .Values.bufferMountFolder) }}
+          - --buffer-mount-folder={{ .Values.bufferMountFolder }}
+          {{ else }}
+          - --buffer-mount-folder=""
+          {{- end }}
           - --output-dir=/fluentd/etc
           - --templates-dir=/templates
           - --id={{ template "fluentd-router.fullname" . }}

charts/log-router/values.yaml

@@ -29,11 +29,12 @@ image:
   tag: latest
   pullSecret: ""
 
-
 logLevel: debug
 fluentdLogLevel: debug
 interval: 45
 kubeletRoot: /var/lib/kubelet
+# bufferMountFolder -- a folder inside /var/log to write all fluentd buffers to
+bufferMountFolder: ""
 
 # fullnameOverride -- String to fully override `fluentd-router.fullname` template.
 fullnameOverride: ""
@@ -121,10 +122,10 @@ serviceMonitor:
 
     # Scrape interval. If not set, the Prometheus default scrape interval is used.
     interval: ""
-    
+
 allowTagExpansion: false
 
 # Change the following value to define a different namespace that is treated as admin
 # namespace, i.e. its configs are not validated or processed and virtual plugins can be
 # defined to be used in all other namespaces.
-adminNamespace: "kube-system"
+adminNamespace: "kube-system"

config-reloader/Makefile

@@ -87,74 +87,77 @@ delete-test-ns:
 run-loop-fs: install
 	rm -fr tmp
 	config-reloader \
-	  --interval 5 \
-	  --log-level=debug \
-	  --output-dir=tmp \
-	  --meta-key=prefix \
-	  --meta-values=aws_region=us-west-2,csp_cluster=mon \
-	  --templates-dir=templates \
-	  --datasource=fs \
-	  --fs-dir=examples \
-	  --fluentd-binary "fluentd/fake-fluentd.sh -p /plugins"
+		--interval 5 \
+		--log-level=debug \
+		--output-dir=tmp \
+		--meta-key=prefix \
+		--meta-values=aws_region=us-west-2,csp_cluster=mon \
+		--templates-dir=templates \
+		--datasource=fs \
+		--fs-dir=examples \
+		--fluentd-binary "fluentd/fake-fluentd.sh -p /plugins"
 
 run-once-fs: install
 	rm -fr tmp
 	config-reloader \
-	  --interval 0 \
-	  --log-level=debug \
-	  --fluentd-loglevel=debug \
-	  --output-dir=tmp \
-	  --meta-key=prefix2 \
-	  --meta-values=aws_region=us-west-2,csp_cluster=mon \
-	  --templates-dir=templates \
-	  --datasource=fs \
-	  --fs-dir=examples \
-	  --fluentd-binary "fluentd/fake-fluentd.sh -p /plugins"
+		--interval 0 \
+		--log-level=debug \
+		--fluentd-loglevel=debug \
+		--buffer-mount-folder="" \
+		--output-dir=tmp \
+		--meta-key=prefix2 \
+		--meta-values=aws_region=us-west-2,csp_cluster=mon \
+		--templates-dir=templates \
+		--datasource=fs \
+		--fs-dir=examples \
+		--fluentd-binary "fluentd/fake-fluentd.sh -p /plugins"
 
 run-once: install
 	rm -fr tmp
 	config-reloader \
-	  --interval 0 \
-	  --log-level=debug \
-	  --fluentd-loglevel=debug \
-	  --output-dir=tmp \
-	  --templates-dir=templates \
-	  --meta-key=run-once \
-	  --meta-values=aws_region=us-west-2,csp_cluster=mon \
-	  --fluentd-binary "fluentd/fake-fluentd.sh -p /plugins"
+		--interval 0 \
+		--log-level=debug \
+		--fluentd-loglevel=debug \
+		--buffer-mount-folder="" \
+		--output-dir=tmp \
+		--templates-dir=templates \
+		--meta-key=run-once \
+		--meta-values=aws_region=us-west-2,csp_cluster=mon \
+		--fluentd-binary "fluentd/fake-fluentd.sh -p /plugins"
 
 run-loop: install
 	rm -fr tmp
 	config-reloader \
-	  --interval 5 \
-	  --log-level=debug \
-	  --fluentd-loglevel=debug \
-	  --output-dir=tmp \
-	  --meta-key=prefix3 \
-	  --meta-values=aws_region=us-west-2,csp_cluster=mon \
-	  --templates-dir=templates
+		--interval 5 \
+		--log-level=debug \
+		--fluentd-loglevel=debug \
+		--buffer-mount-folder="" \
+		--output-dir=tmp \
+		--meta-key=prefix3 \
+		--meta-values=aws_region=us-west-2,csp_cluster=mon \
+		--templates-dir=templates
 
 run-fluentd:
 	docker run --entrypoint=fluentd \
-	  -ti --rm -v `pwd`:/workspace --net=host \
-	  $(IMAGE):$(TAG) \
-	  -p /fluentd/plugins -v -c /workspace/local-fluent.conf
+		-ti --rm -v `pwd`:/workspace --net=host \
+		$(IMAGE):$(TAG) \
+		-p /fluentd/plugins -v -c /workspace/local-fluent.conf
 
 dep-graph:
 	godepgraph -s \
-	  -l 4 \
-	  -p github.com/alecthomas/units,github.com/alecthomas/template,github.com/spf13,github.com/jackc,k8s.io/kubernetes,k8s.io/apimachinery,github.com/palantir,github.com/sirupsen,github.com/prometheus,golang.org,gopkg.in \
-	  github.com/vmware/kube-fluentd-operator/config-reloader \
-	  | sed 's|github.com/vmware/kube-fluentd-operator/config-reloader/||g'\
-	  | dot -Tpng -o godepgraph.png
+		-l 4 \
+		-p github.com/alecthomas/units,github.com/alecthomas/template,github.com/spf13,github.com/jackc,k8s.io/kubernetes,k8s.io/apimachinery,github.com/palantir,github.com/sirupsen,github.com/prometheus,golang.org,gopkg.in \
+		github.com/vmware/kube-fluentd-operator/config-reloader \
+		| sed 's|github.com/vmware/kube-fluentd-operator/config-reloader/||g'\
+		| dot -Tpng -o godepgraph.png
 
 validate-config:
 	docker run --entrypoint=fluentd \
-	  -ti --rm -v `pwd`:/workspace --net=host \
-	  $(IMAGE):$(TAG) \
-	  --dry-run -p /fluentd/plugins -v -c /workspace/tmp/fluent.conf
+		-ti --rm -v `pwd`:/workspace --net=host \
+		$(IMAGE):$(TAG) \
+		--dry-run -p /fluentd/plugins -v -c /workspace/tmp/fluent.conf
 
 shell:
 	docker run --entrypoint=/bin/bash \
-	  -ti --rm -v `pwd`:/workspace --net=host \
-	  $(IMAGE):$(TAG)
+		-ti --rm -v `pwd`:/workspace --net=host \
+		$(IMAGE):$(TAG)

config-reloader/config/config.go

@@ -9,6 +9,7 @@ import (
 	"regexp"
 	"strconv"
 	"strings"
+	"unicode"
 
 	"github.com/alecthomas/kingpin"
 	"github.com/sirupsen/logrus"
@@ -30,6 +31,7 @@ type Config struct {
 	OutputDir              string
 	LogLevel               string
 	FluentdLogLevel        string
+	BufferMountFolder      string
 	AnnotConfigmapName     string
 	AnnotStatus            string
 	DefaultConfigmapName   string
@@ -65,6 +67,7 @@ var defaultConfig = &Config{
 	Datasource:           "default",
 	LogLevel:             logrus.InfoLevel.String(),
 	FluentdLogLevel:      "info",
+	BufferMountFolder:    "",
 	AnnotConfigmapName:   "logging.csp.vmware.com/fluentd-configmap",
 	AnnotStatus:          "logging.csp.vmware.com/fluentd-status",
 	DefaultConfigmapName: "fluentd-config",
@@ -116,6 +119,10 @@ func (cfg *Config) Validate() error {
 		return fmt.Errorf("invalid annotation name: '%s'", cfg.AnnotConfigmapName)
 	}
 
+	if cfg.BufferMountFolder != "" && cfg.hasValidBufferMountFolder() {
+		return fmt.Errorf("invalid fluentd buffer mount folder: '%s%s'", "/var/log/", cfg.BufferMountFolder)
+	}
+
 	// this can be empty
 	if cfg.AnnotStatus != "" && !reValidAnnotationName.MatchString(cfg.AnnotStatus) {
 		return fmt.Errorf("invalid annotation name: '%s'", cfg.AnnotStatus)
@@ -221,6 +228,8 @@ func (cfg *Config) ParseFlags(args []string) error {
 	app.Flag("log-level", "Control verbosity of log level for reloader").Default(defaultConfig.LogLevel).StringVar(&cfg.LogLevel)
 	app.Flag("fluentd-loglevel", "Control verbosity of log level for fluentd").Default(defaultConfig.FluentdLogLevel).StringVar(&cfg.FluentdLogLevel)
 
+	app.Flag("buffer-mount-folder", "Folder in /var/log/{} where to create all fluentd buffers").Default(defaultConfig.BufferMountFolder).StringVar(&cfg.BufferMountFolder)
+
 	app.Flag("annotation", "Which annotation on the namespace stores the configmap name?").Default(defaultConfig.AnnotConfigmapName).StringVar(&cfg.AnnotConfigmapName)
 	app.Flag("default-configmap", "Read the configmap by this name if namespace is not annotated. Use empty string to suppress the default.").Default(defaultConfig.DefaultConfigmapName).StringVar(&cfg.DefaultConfigmapName)
 	app.Flag("status-annotation", "Store configuration errors in this annotation, leave empty to turn off").Default(defaultConfig.AnnotStatus).StringVar(&cfg.AnnotStatus)
@@ -274,3 +283,15 @@ func (cfg *Config) ParseFluentdLogLevel() (string, error) {
 
 	return "", fmt.Errorf("not a valid Fluentd log Level: %q", cfg.FluentdLogLevel)
 }
+
+// isValidFolderName takes a folder name and checks if there are any dangerous characters:
+func (cfg *Config) hasValidBufferMountFolder() bool {
+	for _, r := range cfg.BufferMountFolder {
+		if !unicode.IsLetter(r) && !unicode.IsDigit(r) && r != '-' && r != '_' {
+			continue
+		} else {
+			return false
+		}
+	}
+	return true
+}

config-reloader/config/config_test.go

@@ -16,6 +16,8 @@ func TestBadConfigs(t *testing.T) {
 		{"--id", "???"},
 		{"--log-level", "hobbit"},
 		{"--fluentd-loglevel", "hobbit"},
+		{"--buffer-mount-folder", "../"},
+		{"--buffer-mount-folder", "   "},
 		{"--annotation", "|kl"},
 		{"--status-annotation", "/hello"},
 		{"--meta-key=test"},

config-reloader/generator/generator.go

@@ -112,6 +112,7 @@ func (g *Generator) renderMainFile(mainFile string, outputDir string, dest strin
 		MetaKey                 string
 		MetaValue               string
 		FluentdLogLevel         string
+		BufferMountFolder       string
 		PreprocessingDirectives []string
 	}{}
 
@@ -124,6 +125,10 @@ func (g *Generator) renderMainFile(mainFile string, outputDir string, dest strin
 		model.FluentdLogLevel = g.cfg.FluentdLogLevel
 	}
 
+	if g.cfg.BufferMountFolder != "" {
+		model.BufferMountFolder = g.cfg.BufferMountFolder
+	}
+
 	genCtx := &processors.GenerationContext{
 		ReferencedBridges: map[string]bool{},
 	}
@@ -286,6 +291,7 @@ func (g *Generator) makeContext(ns *datasource.NamespaceConfig, genCtx *processo
 		DeploymentID:      g.cfg.ID,
 		MiniContainers:    ns.MiniContainers,
 		KubeletRoot:       g.cfg.KubeletRoot,
+		BufferMountFolder: g.cfg.BufferMountFolder,
 		GenerationContext: genCtx,
 		AllowTagExpansion: g.cfg.AllowTagExpansion,
 	}

config-reloader/processors/destinations.go

@@ -20,6 +20,10 @@ type fixDestinations struct {
 }
 
 func makeSafeBufferPath(ctx *ProcessorContext, origBufPath string) string {
+	// make a custom buffer path directory if BufferMountFolder is set:
+	if ctx.BufferMountFolder != "" {
+		return fmt.Sprintf("/var/log/%s/kfo-%s-%s-%s.buf", ctx.BufferMountFolder, util.MakeFluentdSafeName(ctx.DeploymentID), ctx.Namespace, util.Hash("", origBufPath))
+	}
 	return fmt.Sprintf("/var/log/kfo-%s-%s-%s.buf", util.MakeFluentdSafeName(ctx.DeploymentID), ctx.Namespace, util.Hash("", origBufPath))
 }
 

config-reloader/processors/processor.go

@@ -43,6 +43,7 @@ type ProcessorContext struct {
 	DeploymentID      string
 	MiniContainers    []*datasource.MiniContainer
 	KubeletRoot       string
+	BufferMountFolder string
 	GenerationContext *GenerationContext
 	AllowTagExpansion bool
 }