kaxil commented on a change in pull request #126: URL: https://github.com/apache/kibble/pull/126#discussion_r546442437
########## File path: docs/source/setup.rst ########## @@ -242,24 +215,54 @@ across all machines. .. _runscan: -************** +############### Running a Scan -************** +############### Once you have both scanners and the data server set up, you can begin scanning resources for data. Please refer to :ref:`configdatasources` for how to set up various resources for scanning via the Web UI. Scans can be initiated manually, but you may want to set up a cron job to handle daily scans of resources. To start a scan on a scanner machine, -run the following: ``python3 src/kibble-scanner.py`` +run the following: + +:: + + kibble scan This will load all plugins and use them in a sensible order on each resource that matches the appropriate type. The collected data will be pushed to the main data server and be available for visualizations instantly. It may be worth your while to run the scanner inside a timer wrapper, -as such: ``time python3 src/kibble-scanner.py`` in order to gauge the +as such: ``time kibble scan`` in order to gauge the amount of time a scan will take, and adjusting your cron jobs to match this. + +************ +Docker Image +************ + +If you want to spin up a development instance of Apache Kibble you can do: + +:: + + docker-compose -f docker-compose-dev.yaml run kibble setup --autoadmin --skiponexist + docker-compose -f docker-compose-dev.yaml up ui + +The ui should be available under `http://0.0.0.0:8000` or `http://localhost:8000`. +To log in you can use the dummy admin account `admin@kibble` and password `kibbleAdmin`. Review comment: ```suggestion The ui should be available under ``http://0.0.0.0:8000`` or ``http://localhost:8000``. To log in you can use the dummy admin account ``admin@kibble`` and password ``kibbleAdmin``. ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
