Skip to content

Add CRD Documentation for Mission Control #387

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

moshloop
Copy link
Member

This pull request adds comprehensive documentation for various Custom Resource Definitions (CRDs) used in Mission Control. The following CRDs have been documented:

  • Canary: Defines health checks for monitoring service availability.
  • Component: Organizes and visualizes components in the infrastructure.
  • Connection: Manages connections to external systems.
  • IncidentRule: Automates incident creation based on conditions.
  • Notification: Configures notification channels for alerts.
  • PermissionGroup: Groups permissions for role-based access control.
  • Playbook: Defines automated workflows for operational tasks.
  • ScrapeConfig: Configures data scraping from various sources.
  • Topology: Models relationships between components.
  • NotificationSilence: Manages periods of silenced notifications.
  • Permission: Defines individual permissions for RBAC.
  • ScrapePlugin: Custom plugins for data scraping.

Each CRD includes a definition, schema, examples, and links to related documentation. This update ensures that users have access to detailed information about the CRDs available in Mission Control, enhancing usability and understanding.


This pull request was co-created with Cosine Genie

Original Task: docs/fyg03ygyxvnh
Author: Moshe Immerman

…anary, Component, Connection, IncidentRule, Notification, Permission, Playbook, ScrapeConfig, and Topology.

Co-authored-by: Genie <[email protected]>
Copy link

netlify bot commented Apr 25, 2025

Deploy Preview for canarychecker canceled.

Name Link
🔨 Latest commit 75b4b76
🔍 Latest deploy log https://app.netlify.com/sites/canarychecker/deploys/680b3ab7955a3e0008252761

Copy link

netlify bot commented Apr 25, 2025

Deploy Preview for flanksource-docs ready!

Name Link
🔨 Latest commit 75b4b76
🔍 Latest deploy log https://app.netlify.com/sites/flanksource-docs/deploys/680b3ab72329e60008a34be3
😎 Deploy Preview https://deploy-preview-387--flanksource-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant