Skip to content

Latest commit

 

History

History
102 lines (73 loc) · 2.95 KB

README.md

File metadata and controls

102 lines (73 loc) · 2.95 KB
Raw

JupiterOne Integration

Development Environment

Prerequisites

You must have Node.JS installed to run this project. If you don't already have it installed, you can can download the installer here. You can alternatively install Node.JS using a version manager like fnm or nvm.

Setup

Installing dependencies

From the root of this project, run npm install to install dependencies. If you have yarn installed, you can install dependencies by running yarn.

Loading credentials

Create a .env file at the root of this project and add environment variables to match what is in src/instanceConfigFields.json. The .env file is ignored by git, so you won't have to worry about accidentally pushing credentials.

Given this example configuration:

{
  "clientId": {
    "type": "string"
  },
  "clientSecret": {
    "type": "string",
    "mask": true
  }
}

You would provide a .env file like this:

CLIENT_ID="client-id"
CLIENT_SECRET="supersecret"

The snake cased environment variables will automatically be converted and applied to the camel cased configuration field. So for example, CLIENT_ID will apply to the clientId config field, CLIENT_SECRET will apply to clientSecret, and MY_SUPER_SECRET_CONFIGURATION_VALUE will apply to a mySuperSecretConfigurationValue configuration field.

Running the integration

To start collecting data, run yarn start from the root of the project. This will load in your configuration and execute the steps stored in src/steps.

Project structure

This is the expected project structure for running integrations.

src/
  /instanceConfigFields.json
  /validateInvocation.ts
  /getStepStartStates.ts
  steps/
    exampleStep.ts
    // add additional steps here

Each of the files listed above contribute to creating an integration configuration.

Additional files can be placed under src and referenced from each of the integration files.

The template project hosted here provides a simple example of how an integration can be setup.

Documentation

Development

Please reference the @jupiterone/integration-sdk development documentation for more information on how to use the SDK.

See docs/development.md for details about how to get started with developing this integration.

Integration usage and resource coverage

More information about the resources covered by this integration and how to setup the integration in JupiterOne can be found in docs/jupiterone.md.

Changelog

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