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

Should list bots output yaml? #2025

Closed
ghost opened this issue Aug 9, 2021 · 1 comment · Fixed by #2030
Closed

Should list bots output yaml? #2025

ghost opened this issue Aug 9, 2021 · 1 comment · Fixed by #2030
Labels
bug Indicates an unexpected problem or unintended behavior documentation Indicates a need for improvements or additions to documentation
Milestone

Comments

@ghost
Copy link

ghost commented Aug 9, 2021

The documentation says:

You can use the output of ``intelmqctl --type json list bots`` to write the ``runtime.conf``

One the one hand intelmqctl --type json list bots is not indented, thus not really usable for humans. On the other hand we are now using yaml. Should list bots get a --yaml switch?

@ghost
Copy link

ghost commented Aug 9, 2021

The documentation says:

You can use the output of ``intelmqctl --type json list bots`` to write the ``runtime.conf``

That was actually only true partially, as the user still needed to extract the relevant parts from the huge JSON-structure. And I see no real purpose in doing so unless we have a good and complete workflow which actually helps user in configuring bots using cli-tools only (that would also require to show get individual bot-configuration templates, not all available ones in a row etc.)

So, I propose to remove that line.

ghost pushed a commit that referenced this issue Aug 10, 2021
@ghost ghost closed this as completed in #2030 Aug 18, 2021
ghost pushed a commit that referenced this issue Aug 18, 2021
@ghost ghost added bug Indicates an unexpected problem or unintended behavior documentation Indicates a need for improvements or additions to documentation labels Aug 18, 2021
@ghost ghost added this to the 3.0.1 milestone Aug 18, 2021
@ghost ghost self-assigned this Aug 18, 2021
ghost pushed a commit that referenced this issue Aug 18, 2021
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Indicates an unexpected problem or unintended behavior documentation Indicates a need for improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

0 participants