The Cloud Pak for Security (CP4S) SDK is a tool provided as a part of the integration ecosystem to streamline the creation of new Connectors for either the CAR or UDI services.
### Generating Connectors: Cloud Pak for Security exposes connectors as a new mechanism or point of integration for the platform. Alongside SOAR Functions, Playbooks and QRadar Apps; the CAR framework compliments the integration framework and this connector SDK aims to simplify the developer experience of working with Connectors.
Code generation is a powerful tool in a new ecosystem not only for helping to cultivate best practices among the community but also to help decrease the time to response for our users working with these tools. Customers have to work with many many tools and ideally want to learn as little as possible about another tool.
For this reason we provided a best practice package someone can take and simply extend. We called this the car-reference-connector and distributed it over github. The generated connector packages from this tool are based on the reference package and provide a way for a developer to streamline the bootstrapping process of getting a new connector working.
The package is currently available on the test pypi in order to preserve the namespace for IBM on the main pypi repo To install this from the test pypi :
pip install -i https://test.pypi.org/simple/ cp4s-connector-sdkThis SDK depends on other packages such as the resilient-sdk and resilient python api packages. If you encounter issues with these during installation, try to download them individually using pypi.
pip install resilient resilient-sdkgit clone <url>cd cp4s-connector-sdkpython setup.py install
The above will install the sdk but if you want to make changes to the SDK and see those changes on next run rather than needing to reinstall the package use the develop flag:
python setup.py develop
Generate boilerplate code to start developing a connector
connector-sdk codegen -p my_aws_connector
Coming soon -- generate boilerplates for any of the connectors
connector-sdk codegen -p my_udi_connector --connectortype UDI
The Cloud Pak for Security Connector SDK has been developed by IBM Security, with Ryan Gordon as the initial core author, along with many contributors.
You can contact us by opening a new issue in the repository.