Skip to content

Commit

Permalink
Merge pull request #26 from netboxlabs/fix/diode-api-key
Browse files Browse the repository at this point in the history
fix: rename INGESTION_API_KEY to DIODE_API_KEY
  • Loading branch information
mfiedorowicz authored Jul 23, 2024
2 parents 672bd90 + a10d484 commit 80ce300
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/netbox-extensions/diode-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ pip install netboxlabs-diode-sdk

### Configure the client

Set the following environment variable with the `INGESTION_API_KEY` API key from the plugin installation:
Set the following environment variable with the `DIODE_API_KEY` API key from the plugin installation:

```bash
export DIODE_API_KEY=<API key from Diode plugin installation>
Expand Down
4 changes: 2 additions & 2 deletions docs/netbox-extensions/diode-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export DIODE_TO_NETBOX_API_KEY=$(head -c20 </dev/urandom|xxd -p); env | grep DIO
# API key for the NetBox service to interact with Diode
export NETBOX_TO_DIODE_API_KEY=$(head -c20 </dev/urandom|xxd -p); env | grep NETBOX_TO_DIODE_API_KEY
# API key for Diode SDKs to ingest data into Diode
export INGESTION_API_KEY=$(head -c20 </dev/urandom|xxd -p); env | grep INGESTION_API_KEY
export DIODE_API_KEY=$(head -c20 </dev/urandom|xxd -p); env | grep DIODE_API_KEY
```

!!! warning
Expand All @@ -62,7 +62,7 @@ The plugin is successfully installed and configured:

- The NetBox Labs DIODE plugin is visible in the right-hand navigation bar
- Three NetBox users and three corresponding API keys have been created:
- `INGESTION`
- `DIODE`
- `DIODE_TO_NETBOX`
- `NETBOX_TO_DIODE`

Expand Down
2 changes: 1 addition & 1 deletion docs/netbox-extensions/diode-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Edit the `.env` to match the environment:

* `NETBOX_DIODE_PLUGIN_API_BASE_URL`: URL for NetBox, appended with `/api/plugins/diode`
* `DIODE_TO_NETBOX_API_KEY`: API key from Diode plugin installation
* `INGESTION_API_KEY`: API key from Diode plugin installation
* `DIODE_API_KEY`: API key from Diode plugin installation
* `NETBOX_TO_DIODE_API_KEY`: API key from Diode plugin installation

### Run the Diode server
Expand Down

0 comments on commit 80ce300

Please sign in to comment.