Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README.md): missing documentation on admins-ns #361

Open
josephmcasey opened this issue Jan 6, 2023 · 1 comment
Open

docs(README.md): missing documentation on admins-ns #361

josephmcasey opened this issue Jan 6, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@josephmcasey
Copy link

josephmcasey commented Jan 6, 2023

Is your feature request related to a problem? Please describe.

When recently looking at unexpected functionality gaps with the label macros, I stumbled upon an old issue that pointed out the inability to make admin specific configurations with a resolution changeset to provide that functionality.

Describe the solution you'd like

Due to the cm needing to exactly match the key to a magic string value of admin-ns, I think the functionality would benefit from a explanation in the README.md.

Describe alternatives you've considered

Given the migration from cm to crd, I considered that this was intentionally left out of the documentation, so I could think a deprecation of complete removal of its reference from the README.md would be an alternative approach here.

Additional context

Referenced in README.md

```xml
admin-ns.conf:
<match systemd.** docker kube.kube-system.** k8s.**>
@type loggly
loggly_url https://logs-01.loggly.com/inputs/TOKEN/tag/fluentd
</match>
<plugin test>
@type s3
aws_key_id YOUR_AWS_KEY_ID
aws_sec_key YOUR_AWS_SECRET_KEY
s3_bucket YOUR_S3_BUCKET_NAME
s3_region AWS_REGION
</plugin>
<plugin staging>
@type loggly
loggly_url https://logs-01.loggly.com/inputs/TOKEN/tag/fluentd
</plugin>
```

Logic for usage

err = util.WriteStringToFile(filepath.Join(outputDir, "admin-ns.conf"), renderedConfig)

@josephmcasey josephmcasey added the enhancement New feature or request label Jan 6, 2023
@josephmcasey
Copy link
Author

One question I had for the maintainers of this repository. Is it is desired that this functionality is compatible for the recommened FluentdConfig resources?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant