Record a privacy-aware summary of run inputs

Open
  • Is something wrong?
#26 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
28/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
python
Domain
backend, security

Research direction

Begin by mapping the queueing path, recurring successors, and NetBox Job access boundary described in the issue. Define the recording and access policy before implementation, covering sensitive variables, model references, uploads, Event Rule snapshots, revisions, and omissions. Done means permitted JSON-safe summaries are retained without credentials or file contents and redactions are identified without exposing values.

Written by the indexing model from the issue text.

Description

app: scripts complexity: high status: backlog type: feature
Plugin Version

v0.0.1

Proposed functionality

Save a JSON-safe summary of each run's inputs alongside its execution provenance, so the history remains useful after its queue task is gone.

Define the recording and access policy first. Cover sensitive variables, model references, uploads, and Event Rule snapshots, including who can read data stored on a NetBox Job. Do not store credentials or file contents by default. Identify omitted or redacted fields without exposing their values.

Capture the permitted summary when queueing the run, carry it to recurring successors, and record the revision actually used by each occurrence. Replaying historical inputs remains separate work.

Use case

Investigating a run requires knowing both which code executed and what it was asked to do. Operators need that context, while authors need clear rules about which inputs are retained and who can see them.

External dependencies

No new package or service is expected.

Dominant language
Python
Stars
8
Forks
0
Avg merge
9h 56m
Merged PRs (30d)
29

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from netbox-community/netbox-scripts

All issues in netbox-community/netbox-scripts

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.