Skip to content

Commit c203704

Browse files
committed
Put CHANGELOG in seperate file
Describe --default-configmap in README.
1 parent b9fe9e9 commit c203704

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# CHANGELOG
2+
3+
## 1.0.1
4+
5+
* install plugin `fluent-plugin-concat` in Fluentd
6+
7+
* support for default configmap name using `--default-configmap`
8+
9+
## 1.0.0
10+
11+
* initial version

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
# Contributing to kube-fluentd-operator
42

53
The kube-fluentd-operator project team welcomes contributions from the community. If you wish to contribute code and you have not

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -202,19 +202,19 @@ Flags:
202202
--help Show context-sensitive help (also try --help-long and --help-man).
203203
--version Show application version.
204204
--master="" The Kubernetes API server to connect to (default: auto-detect)
205-
--kubeconfig="" Retrieve target cluster configuration from a Kubernetes configuration file (default:
206-
auto-detect)
205+
--kubeconfig="" Retrieve target cluster configuration from a Kubernetes configuration file (default: auto-detect)
207206
--datasource=default Datasource to use
208207
--fs-dir=FS-DIR If datasource=fs is used, configure the dir hosting the files
209208
--interval=60 Run every x seconds
210209
--allow-file Allow @type file for namespace configuration
211-
--id="default" The id of this deployment. It is used internally so that two deployments don't overwrite each
212-
other's data
210+
--id="default" The id of this deployment. It is used internally so that two deployments don't overwrite each other's data
213211
--fluentd-rpc-port=24444 RPC port of Fluentd
214212
--log-level="info" Control verbosity of log
215-
--annotation="logging.csp.vmware.com/fluentd-configmap"
213+
--annotation="logging.csp.vmware.com/fluentd-configmap"
216214
Which annotation on the namespace stores the configmap name?
217-
--status-annotation="logging.csp.vmware.com/fluentd-status"
215+
--default-configmap="fluentd-config"
216+
Read the configmap by this name if namespace is not annotated. Use empty string to suppress the default.
217+
--status-annotation="logging.csp.vmware.com/fluentd-status"
218218
Store configuration errors in this annotation, leave empty to turn off
219219
--templates-dir="/templates" Where to find templates
220220
--output-dir="/fluentd/etc" Where to output config files
@@ -430,6 +430,11 @@ This will build the code, then `config-reloader` will connect to the K8S cluster
430430
431431
Use the `vmware/kube-fluentd-operator:TAG` as a base and do any modification as usual.
432432
433+
### I don't want to annotate all my namespaces with the same way
434+
435+
It is possible to reduce configuration burden by using a default configmap name. The default value is `fluentd-config` - kube-fluentd-operator will read the configmap by that name if the namespace is not annotated.
436+
If you don't like this default name or happen to use this configmap for other purposes then override the default with `--defualt-configmap=my-default`.
437+
433438
### How can I be sure to use a valid path for the .pos and .buf files
434439
435440
.pos files store the progress of the upload process and .buf are used for local buffering. Colliding .pos/.buf paths can lead to races in Fluentd. As such, `kube-fluentd-operator` tries hard to rewrite such path-based parameters in predictable way. You only need to make sure they are unique for your namespace and `config-reloader` will take care to make them unique cluster-wide.
@@ -459,7 +464,7 @@ helm install ... --set image.repository=acme.com/my-custom-image
459464
460465
## Releases
461466
462-
* 1.0.0: Initial version
467+
* [CHANGELOG.md](CHANGELOG.md).
463468
464469
## Resoures
465470

0 commit comments

Comments
 (0)