Feature/devops admin rules
Summary by CodeRabbit
-
New Features
- Introduced comprehensive best practice rule sets for DevOps, SRE, database (MySQL, PostgreSQL, MongoDB, Redis), network, system, and VMware administration, as well as scripting (Bash, Zsh, PowerShell, PowerCLI).
- Added a universal security rule for DevSecOps, SSDLC, and Application Security across multiple languages.
-
Documentation
- Major overhaul and enhancement of the main README for improved navigation, clarity, and structure.
- Added detailed READMEs for new rule directories covering DevOps, administration (database, network, system, VMware), and scripting categories.
Walkthrough
This update introduces a comprehensive set of best practice rules and documentation for DevOps, SRE, system, network, database, VMware, and scripting domains. It adds new .cursorrules files for each specialty, detailed READMEs for new rule directories, a universal security rule, and a significantly reorganized and enhanced main README for improved navigation and clarity.
Changes
| File(s) | Change Summary |
|---|---|
| README.md | Major reorganization and enhancement: navigation bar, badges, new sections, improved formatting, and clarity. |
| rules/admin/database/README.md rules/admin/network/README.md rules/admin/system/README.md rules/admin/vmware/README.md |
New READMEs describing purpose, usage, and contribution guidelines for each rule directory. |
| rules/admin/database/mongodb-dba.cursorrules rules/admin/database/mysql-dba.cursorrules rules/admin/database/postgresql-dba.cursorrules rules/admin/database/redis-dba.cursorrules |
New best practice rule files for MongoDB, MySQL, PostgreSQL, and Redis database administration. |
| rules/admin/network/network-engineer.cursorrules | New best practice rule file for network engineering. |
| rules/admin/system/system-engineer.cursorrules | New best practice rule file for system engineering. |
| rules/admin/vmware/vmware-admin.cursorrules | New best practice rule file for VMware administration. |
| rules/devops/devops-engineer.cursorrules rules/devops/devops-engineer-enhanced.cursorrules |
New comprehensive best practice rule files for DevOps engineering. |
| rules/devops/sre-engineer.cursorrules | New best practice rule file for Site Reliability Engineering (SRE). |
| rules/scripts/posix/bash-script.cursorrules rules/scripts/posix/zsh-script.cursorrules |
New best practice rule files for POSIX Bash and Zsh scripting. |
| rules/scripts/powercli/powercli-script.cursorrules | New best practice rule file for PowerCLI scripting. |
| rules/scripts/powershell/powershell-script.cursorrules | New best practice rule file for PowerShell scripting. |
| rules/security-devsecops-ssdls-appsec.mdc | New universal security enforcement rule for DevSecOps, SSDLC, and AppSec across multiple languages. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant CursorAI
participant RuleLoader
participant RuleFile
User->>CursorAI: Opens file or context (e.g., DB, DevOps, Script)
CursorAI->>RuleLoader: Detect context (e.g., MySQL, Bash, DevOps)
RuleLoader->>RuleFile: Load relevant .cursorrules/.mdc files
RuleFile-->>RuleLoader: Provide best practice rules/guidelines
RuleLoader-->>CursorAI: Inject rules into context
CursorAI-->>User: Apply rules for suggestions, validation, or guidance
Poem
In burrows deep, new rules appear,
For DevOps, SRE, and scripts so clear.
Networks, systems, databases too,
Best practices guide what we do.
With README polished, badges bright,
This rabbit hops with pure delight!
🐇✨
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-
I pushed a fix in commit <commit_id>, please review it. -
Explain this complex logic. -
Open a follow-up GitHub issue for this discussion.
-
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:-
@coderabbitai explain this code block. -
@coderabbitai modularize this function.
-
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:-
@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase. -
@coderabbitai read src/utils.ts and explain its main purpose. -
@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format. -
@coderabbitai help me debug CodeRabbit configuration file.
-
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
-
@coderabbitai pauseto pause the reviews on a PR. -
@coderabbitai resumeto resume the paused reviews. -
@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository. -
@coderabbitai full reviewto do a full review from scratch and review all the files again. -
@coderabbitai summaryto regenerate the summary of the PR. -
@coderabbitai generate docstringsto generate docstrings for this PR. -
@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR. -
@coderabbitai resolveresolve all the CodeRabbit review comments. -
@coderabbitai configurationto show the current CodeRabbit configuration for the repository. -
@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.