Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document default connector variables #128

Closed
CherfaElyes opened this issue Oct 10, 2024 · 0 comments · Fixed by #131
Closed

Document default connector variables #128

CherfaElyes opened this issue Oct 10, 2024 · 0 comments · Fixed by #131
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@CherfaElyes
Copy link
Contributor

After adding the possibility to define default connector variables values, we need to update connectors.md to add the variables section in the examples:

extends:
- ../System/System
connector:
  displayName: Linux - Processes (ps)
  platforms: Any Linux system
  reliesOn: Linux ps command
  information: Monitors performance metrics (CPU, memory, etc.) of the processes that match the specified criteria in `matchName`, `matchCommand`, and `matchUser`.
  detection:
    connectionTypes:
    - remote
    - local
    appliesTo:
    - linux
    disableAutoDetection: true
    criteria:
    - type: commandLine
      commandLine: /usr/bin/which ps || /bin/which ps
      expectedResult: /bin/ps
      errorMessage: Not a valid Linux host.
    tags: [ system, linux ]
  variables:
    matchName:
      description: Regular expression pattern to match process names for monitoring.
      defaultValue: .* 
    matchCommand:
      description: Regular expression pattern to match process command lines for monitoring.
      defaultValue: .*
    matchUser:
      description: Regular expression pattern to match process users for inclusion.
      defaultValue: .*
@CherfaElyes CherfaElyes added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 10, 2024
@CherfaElyes CherfaElyes self-assigned this Oct 10, 2024
CherfaElyes added a commit that referenced this issue Oct 14, 2024
* Added default variables section under connector.md.
@CherfaElyes CherfaElyes linked a pull request Oct 14, 2024 that will close this issue
CherfaElyes added a commit that referenced this issue Oct 18, 2024
NassimBtk added a commit that referenced this issue Oct 22, 2024
@NassimBtk NassimBtk changed the title Add default Connectors in connectors.md Document default variables in connectors.md Oct 22, 2024
@NassimBtk NassimBtk added this to the 1.0.07 milestone Oct 22, 2024
@NassimBtk NassimBtk changed the title Document default variables in connectors.md Document default connector variables Oct 22, 2024
NassimBtk added a commit that referenced this issue Oct 22, 2024
…ault-connectors-in-connectorsmd

Issue #128: Add default `variables` in connector.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants