document agents_autodelete in the default suggested configs#1067
document agents_autodelete in the default suggested configs#1067
Conversation
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
There was a problem hiding this comment.
Pull request overview
Updates CrowdSec documentation to better reflect configuration options and threat-context taxonomy.
Changes:
- Adds additional
industry_typesvalues and replaceshomelab_and_iotwithSOHOinindustry_risk_profilesdocumentation. - Documents
agents_autodeletein the Kubernetes Helm values example and highlights it in the warning about avoiding orphaned resources.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| crowdsec-docs/unversioned/tracker_api/threat_context.mdx | Expands/adjusts documented threat-context enum values for industry targeting and risk profiles. |
| crowdsec-docs/unversioned/getting_started/installation/kubernetes.mdx | Adds agents_autodelete to the suggested Kubernetes config.yaml.local example and updates the related warning text. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `industry` | Manufacturing, industrial, and production organizations | | ||
| | `media` | Media, entertainment, and publishing organizations | | ||
| | `non_profit` | Non-profit organizations, NGOs, charities | | ||
| | `SOHO` | Small office / home office environments | |
There was a problem hiding this comment.
The new SOHO industry type value is formatted differently from all other industry_types keys (uppercase acronym vs lowercase snake_case). If the API actually returns a lowercase key (e.g., soho), this will mislead consumers; if it really is uppercase, consider adding a short note that this value is intentionally uppercase to avoid people normalizing it.
| | `SOHO` | Small office / home office environments | | |
| | `SOHO` | Small office / home office environments. This key is intentionally uppercase in API responses. | |
| @@ -108,7 +112,7 @@ Classifies targets by their **technology risk profile** rather than their busine | |||
| "traditional_business": 6, | |||
| "public_service": 6, | |||
| "technology_business": 65, | |||
| "homelab_and_iot": 17 | |||
| "SOHO": 17 | |||
There was a problem hiding this comment.
industry_risk_profiles values are otherwise lowercase snake_case, but SOHO is now uppercase in both the table and JSON example. Please confirm the exact enum value returned by the API and align the casing accordingly (or explicitly document that this is intentionally uppercase).
| login_password: 6h | ||
| cert: 6h |
There was a problem hiding this comment.
The example adds agents_autodelete with login_password: 6h and cert: 6h, but the referenced default suggested config in docs/configuration/values_parameters.md uses login_password: 1h and doesn’t include cert. To avoid conflicting guidance, please either align this example with the documented defaults or explain why Kubernetes users should prefer a 6h setting and include cert here (especially since this example uses auto_registration for non-TLS auth).
| login_password: 6h | |
| cert: 6h | |
| login_password: 1h |
| | `education` | Schools, universities, and educational institutions | | ||
| | `financial_services` | Banks, insurance, fintech, financial institutions | | ||
| | `government` | Government agencies and public administration | | ||
| | `healthcare` | Healthcare providers, hospitals, medical organizations | | ||
| | `industry` | Manufacturing, industrial, and production organizations | | ||
| | `media` | Media, entertainment, and publishing organizations | |
There was a problem hiding this comment.
This PR is titled about documenting agents_autodelete in default suggested configs, but this file also changes the tracker API threat-context enum documentation (new industry_types/industry_risk_profiles values). If those changes aren’t directly required for the agents_autodelete doc update, consider splitting them into a separate PR to keep scope focused and ease review/reverts.
No description provided.