@jupiterone/graph-artifactory
v3.10.4
Published
A graph conversion tool for https://jfrog.com/artifactory
Downloads
156
Readme
JupiterOne Integration
Learn about the data ingested, benefits of this integration, and how to use it with JupiterOne in the integration documentation.
Development
Prerequisites
Install Node.js using the installer or a version manager such as nvm or fnm.
npm
to install dependencies.Install dependencies with
npm install
.Register an account in the system this integration targets for ingestion and obtain API credentials.
cp .env.example .env
and add necessary values for runtime configuration.When an integration executes, it needs API credentials and any other configuration parameters necessary for its work (provider API credentials, data ingestion parameters, etc.). The names of these parameters are defined by the
IntegrationInstanceConfigFieldMap
insrc/config.ts
. When the integration is executed outside the JupiterOne managed environment (local development or on-prem), values for these parameters are read from Node'sprocess.env
by converting config field names to constant case. For example,clientId
is read fromprocess.env.CLIENT_ID
.The
.env
file is loaded intoprocess.env
before the integration code is executed. This file is not required should you configure the environment another way..gitignore
is configured to to avoid commiting the.env
file.
Running the integration
npm run start
to collect datanpm run graph
to show a visualization of the collected datanpm run j1-integration -h
for additional commands
Making Contributions
Start by taking a look at the source code. The integration is basically a set of functions called steps, each of which ingests a collection of resources and relationships. The goal is to limit each step to as few resource types as possible so that should the ingestion of one type of data fail, it does not necessarily prevent the ingestion of other, unrelated data. That should be enough information to allow you to get started coding!
See the SDK development documentation for a deep dive into the mechanics of how integrations work.
See docs/development.md for any additional details about developing this integration.
Changelog
The history of this integration's development can be viewed at CHANGELOG.md.