Skip to content

Commit

Permalink
DOC: fix remaining references to old runtime.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
wagner-intevation committed Dec 22, 2022
1 parent 794ef7d commit 3e8da20
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions contrib/feeds-config-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ optional arguments:
feeds.yaml config file
--all iterate through all feeds
--runtime-output-file <filepath>
/tmp/runtime.conf
/tmp/runtime.yaml
--pipeline-output-file <filepath>
/tmp/pipeline.conf
Expand All @@ -43,5 +43,5 @@ optional arguments:
### Generate all bots configurations and send to file

```
./intelmq_gen_feeds_conf --feeds-file=../../intelmq/etc/feeds.yaml --all --runtime-output-file=/tmp/runtime.conf --pipeline-output-file=/tmp/pipeline.conf
./intelmq_gen_feeds_conf --feeds-file=../../intelmq/etc/feeds.yaml --all --runtime-output-file=/tmp/runtime.yaml --pipeline-output-file=/tmp/pipeline.conf
```
2 changes: 1 addition & 1 deletion contrib/feeds-config-generator/intelmq_gen_feeds_conf
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ if __name__ == "__main__":
dest="runtime_file",
metavar="<filepath>",
required=False,
help="write runtime configuration to the given file (e.g. '/tmp/runtime.conf') instead of stdout")
help="write runtime configuration to the given file (e.g. '/tmp/runtime.yaml') instead of stdout")

parser.add_argument('--pipeline-output-file',
action="store",
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ Layout Rules
<bot name>/
output.py
/conf
runtime.conf
runtime.yaml
Assuming you want to create a bot for a new 'Abuse.ch' feed. It turns out that here it is necessary to create different parsers for the respective kind of events (e.g. malicious URLs). Therefore, the usual hierarchy ‘intelmq/bots/parser/<FEED>/parser.py’ would not be suitable because it is necessary to have more parsers for each Abuse.ch Feed. The solution is to use the same hierarchy with an additional "description" in the file name, separated by underscore. Also see the section *Directories and Files naming*.

Expand Down
4 changes: 2 additions & 2 deletions docs/user/bots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ General remarks
By default all of the bots are started when you start the whole botnet, however there is a possibility to
*disable* a bot. This means that the bot will not start every time you start the botnet, but you can start
and stop the bot if you specify the bot explicitly. To disable a bot, add the following to your
`runtime.conf`: `"enabled": false`. Be aware that this is **not** a normal parameter (like the others
described in this file). It is set outside of the `parameters` object in `runtime.conf`. Check out
``runtime.yaml``: `"enabled": false`. Be aware that this is **not** a normal parameter (like the others
described in this file). It is set outside of the `parameters` object in ``runtime.yaml``. Check out
:doc:`configuration-management` for an example.

There are two different types of parameters: The initialization parameters are need to start the bot. The runtime parameters are needed by the bot itself during runtime.
Expand Down
12 changes: 6 additions & 6 deletions docs/user/configuration-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ In the shipped examples 4 collectors and parsers, 6 common experts and one outpu
Systemwide Configuration (global)
*********************************

All bots inherit the global configuration parameters in the ``runtime.conf`` and they can overwrite them using the same parameters in their individual configuration in the ``runtime.conf`` file.
All bots inherit the global configuration parameters in the ``runtime.yaml`` and they can overwrite them using the same parameters in their individual configuration in the ``runtime.yaml`` file.

.. _configuration-logging:

Expand Down Expand Up @@ -238,9 +238,9 @@ This configuration is used by each bot to load its specific (runtime) parameters
name: Blocklist.de Apache
rate_limit: 3600
More examples can be found in the ``intelmq/etc/runtime.conf`` directory. See :doc:`bots` for more details.
More examples can be found in the ``intelmq/etc/runtime.yaml`` file. See :doc:`bots` for more details.

By default, all of the bots are started when you start the whole botnet, however there is a possibility to *disable* a bot. This means that the bot will not start every time you start the botnet, but you can start and stop the bot if you specify the bot explicitly. To disable a bot, add the following to your runtime.conf: ``"enabled": false``. For example:
By default, all of the bots are started when you start the whole botnet, however there is a possibility to *disable* a bot. This means that the bot will not start every time you start the botnet, but you can start and stop the bot if you specify the bot explicitly. To disable a bot, add the following to your ``runtime.yaml``: ``"enabled": false``. For example:

.. code-block:: yaml
Expand All @@ -258,7 +258,7 @@ By default, all of the bots are started when you start the whole botnet, however
Pipeline Configuration
======================

The pipeline configuration defines how the data is exchanges between the bots. For each bot, it defines the source queue (there is always only one) and one or multiple destination queues. This section shows the possibilities and definition as well as examples. The configuration of the pipeline can be done by the |intelmq-manager-github-link| with no need to intervene manually. It is recommended to use this tool as it guarantees that the configuration is correct. The configuration of the pipelines is done in the ``runtime.conf`` as part of the individiual bots settings.
The pipeline configuration defines how the data is exchanges between the bots. For each bot, it defines the source queue (there is always only one) and one or multiple destination queues. This section shows the possibilities and definition as well as examples. The configuration of the pipeline can be done by the |intelmq-manager-github-link| with no need to intervene manually. It is recommended to use this tool as it guarantees that the configuration is correct. The configuration of the pipelines is done in the ``runtime.yaml`` as part of the individual bots settings.

Source queue
------------
Expand Down Expand Up @@ -483,7 +483,7 @@ Disabled bots can still be started explicitly using ``intelmqctl start <bot_id>`
Scheduled Run Mode
------------------

In many cases, it is useful to schedule a bot at a specific time (i.e. via cron(1)), for example to collect information from a website every day at midnight. To do this, set ``run_mode`` to ``scheduled`` in the ``runtime.conf`` for the bot. Check out the following example:
In many cases, it is useful to schedule a bot at a specific time (i.e. via cron(1)), for example to collect information from a website every day at midnight. To do this, set ``run_mode`` to ``scheduled`` in the ``runtime.yaml`` for the bot. Check out the following example:

.. code-block:: yaml
Expand Down Expand Up @@ -513,7 +513,7 @@ Setting ``enabled`` to ``false`` will cause the bot to not start with ``intelmqc
Continuous Run Mode
-------------------

Most of the cases, bots will need to be configured as ``continuous`` run mode (the default) in order to have them always running and processing events. Usually, the types of bots that will require the continuous mode will be Parsers, Experts and Outputs. To do this, set ``run_mode`` to ``continuous`` in the ``runtime.conf`` for the bot. Check the following example:
Most of the cases, bots will need to be configured as ``continuous`` run mode (the default) in order to have them always running and processing events. Usually, the types of bots that will require the continuous mode will be Parsers, Experts and Outputs. To do this, set ``run_mode`` to ``continuous`` in the ``runtime.yaml`` for the bot. Check the following example:

.. code-block:: yaml
Expand Down
4 changes: 2 additions & 2 deletions docs/user/intelmqctl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ Manage the botnet
-----------------

In IntelMQ, the botnet is the set of all currently configured and enabled bots.
All configured bots have their configuration in runtime.conf.
All configured bots have their configuration in ``runtime.yaml``.
By default, all bots are enabled. To disable a bot set `enabled` to `false`.
Also see :doc:`bots` and :ref:`runtime-configuration`.

Expand Down Expand Up @@ -364,7 +364,7 @@ The same as reload of every bot.
enable / disable
================

The sub commands `enable` and `disable` set the corresponding flags in runtime.conf.
The sub commands `enable` and `disable` set the corresponding flags in ``runtime.yaml``.

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bin/intelmqctl.py
Original file line number Diff line number Diff line change
Expand Up @@ -631,7 +631,7 @@ def write_updated_runtime_config(self, filename=RUNTIME_CONF_FILE):

def list_bots(self, non_zero=False, configured=False):
"""
Lists all (configured) bots from runtime.conf or generated on demand
Lists all (configured) bots from runtime configuration or generated on demand
with bot id/module and description and parameters.
If description is not set, None is used instead.
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bots/experts/asn_lookup/expert.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def update_database(cls, verbose=False):

if not bots:
if verbose:
print(f"Database update skipped. No bots of type {__name__} present in runtime.conf or database update disabled with parameter 'autoupdate_cached_database'.")
print(f"Database update skipped. No bots of type {__name__} present in runtime configuration or database update disabled with parameter 'autoupdate_cached_database'.")
sys.exit(0)

# we only need to import now. If there are no asn_lookup bots, this dependency does not need to be installed
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bots/experts/domain_suffix/expert.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def update_database(cls, verbose=False):

if not bots:
if verbose:
print(f"Database update skipped. No bots of type {__name__} present in runtime.conf or database update disabled with parameter 'autoupdate_cached_database'.")
print(f"Database update skipped. No bots of type {__name__} present in runtime configuration or database update disabled with parameter 'autoupdate_cached_database'.")
sys.exit(0)

# we only need to import now. If there are no asn_lookup bots, this dependency does not need to be installed
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bots/experts/domain_valid/expert.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def update_database(cls, verbose=False):

if not bots:
if verbose:
print(f"Database update skipped. No bots of type {__name__} present in runtime.conf.")
print(f"Database update skipped. No bots of type {__name__} present in runtime configuration.")
sys.exit(0)

try:
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bots/experts/maxmind_geoip/expert.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def update_database(cls, verbose=False):

if not bots:
if verbose:
print(f"Database update skipped. No bots of type {__name__} present in runtime.conf or database update disabled with parameter 'autoupdate_cached_database'.")
print(f"Database update skipped. No bots of type {__name__} present in runtime configuration or database update disabled with parameter 'autoupdate_cached_database'.")
sys.exit(0)

# we only need to import now, if there are no maxmind_geoip bots, this dependency does not need to be installed
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bots/experts/recordedfuture_iprisk/expert.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def update_database(cls, verbose=False):

if not bots:
if verbose:
print(f"Database update skipped. No bots of type {__name__} present in runtime.conf or database update disabled with parameter 'autoupdate_cached_database'.")
print(f"Database update skipped. No bots of type {__name__} present in runtime configuration or database update disabled with parameter 'autoupdate_cached_database'.")
sys.exit(0)

try:
Expand Down
2 changes: 1 addition & 1 deletion intelmq/bots/experts/tor_nodes/expert.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def update_database(cls, verbose=False):

if not bots:
if verbose:
print(f"Database update skipped. No bots of type {__name__} present in runtime.conf or database update disabled with parameter 'autoupdate_cached_database'.")
print(f"Database update skipped. No bots of type {__name__} present in runtime configuration or database update disabled with parameter 'autoupdate_cached_database'.")
sys.exit(0)

try:
Expand Down

0 comments on commit 3e8da20

Please sign in to comment.