docs: warn that new Hive records are disabled by default#235
Merged
Conversation
Every new Hive record (D&R rules, FP rules, secrets, lookups, YARA sources, cloud sensors, AI skills, playbooks, …) is created disabled unless usr_mtd.enabled is explicitly set to true. Several create/update examples in the docs omit this and would silently produce a disabled record — most painful for secrets and lookups, where the record is stored normally but its consumers (outputs, D&R rules) skip it. - config-hive/index.md: new top-level admonition listing the three create-and-enable paths (CLI --enabled flag, usr_mtd.enabled in body, SDK enabled=True / Enabled: &enabled). - secrets.md and lookups.md: Create/Update examples now set enabled across REST, Python, Go, and CLI tabs. - dr-rules.md, false-positives.md, detection-response/index.md, writing-testing-rules.md tutorial: CLI examples updated to include --enabled. (The REST/Python/Go tabs in those docs already set it.) - yara.md: Python SDK example now passes enabled=True. - python-sdk.md: "Create or update a rule" snippet now sets enabled. - skills.md: CLI ai-skill set examples and Python SDK example now enable the skill at creation. The CLI --enabled / --disabled flag referenced here is being added to python-limacharlie in refractionPOINT/python-limacharlie#296. Until that lands, the SDK/REST patterns still apply, and the CLI path remains "set + enable" two-step. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
maximelb
added
the
to-code-review
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Every new Hive record (D&R rules, FP rules, secrets, lookups, YARA sources, cloud sensors, AI skills, playbooks, …) is created disabled unless
usr_mtd.enabledis set totrue. Several Create/Update examples in the docs omit that, so a reader copying them ends up with a record that is stored but does nothing. Most painful for secrets and lookups, where the record is silently skipped by every consumer (outputs, D&R rules, etc.).This PR:
config-hive/index.mddocumenting the disabled-by-default behavior and listing the three create-and-enable paths.secrets.mdandlookups.mdto explicitly setenabled.dr-rules.md,false-positives.md,3-detection-response/index.md, thewriting-testing-rules.mdtutorial, and9-ai-sessions/skills.mdto use--enabled. (The REST/Python/Go tabs in those docs already set it.)enabled=True.python-sdk.mdto setenabled=True.Dependency
The CLI
--enabled/--disabledflag referenced in the updated CLI examples is being added in refractionPOINT/python-limacharlie#296. Until that lands, the REST/SDK patterns in this PR still apply, and the CLI path remains the existing two-step (setfollowed byenable). Holding this PR as draft until that one merges.Test plan
npx markdownlint-cli2— 308 files, 0 errorsconfig-hive/index.md🤖 Generated with Claude Code