How to deploy K collectors on Windows VM

K collectors can be deployed on a VM running Windows using the following guide

About K collectors

Collectors are used to connect your data and tool sources to K. Collectors are customer managed deployments that are used for integrating metadata and logs from your sources to K. This is typically used for on-premise sources that are not accessible from your K instance, or to address IT security concerns for allowing inbound connections from K as a Service.

Find more information about collectors at the following link: https://kadaai.atlassian.net/wiki/spaces/KSL/pages/1901756492

Setting up the Collector

On the Windows VM

1. Install python 3.8 - 3.11 (recommend 3.11) if it is not already installed

2. (Recommended) Use a python environment manager such as pipenv to manage the packages. Install pipenv by running pip install pipenv

3. Create a working directory for the collector and place all the collector .whl files in the folder along with the python scripts.

   1. See the relevant https://kadaai.atlassian.net/wiki/spaces/KSL/pages/1901756492 page for details about the collector files for each source you want to connect to

   2. (Recommended) Use a seperate working directories for each collector/source

4. Within that directory setup the pipenv environment using pipenv install --python <python version>.

   1. Repeat for each working directory if using multiple.

5. Start the virtual environment pipenv shell

6. Install all the relevant downloaded .whl files using pip install <.whl file>

7. Follow the documentation for configuring the collector connections to your source.

8. To run the collector ensure you start the virtual environment first before, alternatively call pipenv run python <python script> to tell it to run the script within the virtual environment