JupiterOne Integration

Learn about the data ingested, benefits of this integration, and how to use it
with JupiterOne in the integration documentation.

Development

$3

1. Install Node.js using the
installer or a version manager such as
nvm or fnm.
2. Install yarn or
npm to install dependencies.
3. Install dependencies with yarn install.
4. Register an account in the system this integration targets for ingestion and
obtain API credentials.
5. 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 IntegrationInstanceConfigFieldMapin src/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's
process.env by converting config field names to constant case. For example,
clientId is read from process.env.CLIENT_ID.

The .env file is loaded into process.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.

$3

1. yarn start to collect data
2. yarn graph to show a visualization of the collected data
3. yarn j1-integration -h for additional commands

$3

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.

Testing the integation

Ideally, all major calls to the API and converter functions would be tested. You
can run the tests with yarn test, and you can run the tests as they execute in
the CI/CD environment with yarn test:ci (adds linting and type-checking to
yarn test). If you have a valid runtime configuration, you can run the tests
with your credentials using yarn test:env.

For more details on setting up tests, and specifically on using recordings to
simulate API responses, see test/README.md.

$3

The history of this integration's development can be viewed at
CHANGELOG.md.

$3

To version this project and tag the repo with a new version number, run the
following (where major.minor.patch is the version you expect to move to):

``sh
git checkout -b release-..
vim CHANGELOG.md # remember to update CHANGELOG.md with version & date!
git add CHANGELOG.md
yarn version --new-version ..
git push --follow-tags -u origin release-..
`

NOTE: It is _critical_ that the tagged commit is the _last_ commit before
merging to main. If any commit is added _after_ the tagged commit, the project
will not be published to NPM.

NOTE: Make sure you select the _Create a merge commit_ option when merging
the PR for your release branch. Otherwise the publishing workflow will error
out.

TIP: We recommend updating your global ~/.gitconfig with the
push.followTags = true property. This will automatically add the
--follow-tags flag to any new commits. See


`
[push]
followTags = true
``

After the PR is merged to the main branch, the
Build github workflow should run the
Publish step to publish this project to NPM.