Merge pull request #145 from flanksource/registry-docs

feat: registry docs

mission-control/docs/registry/aws.md

@@ -0,0 +1,119 @@
+# AWS
+
+The AWS helm chart installs a [catalog scraper](/config-db/scrapers/aws)
+
+## Setup
+
+```sh
+helm repo add flanksource https://flanksource.github.io/charts
+helm repo update
+helm install {release-name} flanksource/mission-control-registry-aws
+```
+
+### Values
+
+This document provides an overview of configurable values for deploying Mission Control Registry on AWS using Helm.
+
+## Configuration
+
+The following table lists the configurable parameters and their default values:
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `nameOverride` | Overrides the name of the chart. | "" |
+| `fullnameOverride` | Overrides the full name of the chart. | "" |
+| `labels` | Additional labels to apply to resources. | {} |
+| `scraper.name` | Name of the AWS scraper. | "aws" |
+
+### Connection Details
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `connectionDetails.connection` | AWS connection details. | "" |
+| `connectionDetails.accessKey.name` | Name of the access key. | "" |
+| `connectionDetails.accessKey.value` | Value of the access key. | "" |
+| `connectionDetails.accessKey.valueFrom.serviceAccount` | Service account for fetching the value. | "" |
+| `connectionDetails.accessKey.valueFrom.helmRef.key` | Key for Helm reference. | "" |
+| `connectionDetails.accessKey.valueFrom.helmRef.name` | Name for Helm reference. | "" |
+| `connectionDetails.accessKey.valueFrom.configMapKeyRef.key` | Key for ConfigMap key reference. | "" |
+| `connectionDetails.accessKey.valueFrom.configMapKeyRef.name` | Name for ConfigMap key reference. | "" |
+| `connectionDetails.accessKey.valueFrom.secretKeyRef.key` | Key for Secret key reference. | "" |
+| `connectionDetails.accessKey.valueFrom.secretKeyRef.name` | Name for Secret key reference. | "" |
+| `connectionDetails.secretKey.name` | Name of the secret key. | "" |
+| `connectionDetails.secretKey.value` | Value of the secret key. | "" |
+| `connectionDetails.secretKey.valueFrom.serviceAccount` | Service account for fetching the value. | "" |
+| `connectionDetails.secretKey.valueFrom.helmRef.key` | Key for Helm reference. | "" |
+| `connectionDetails.secretKey.valueFrom.helmRef.name` | Name for Helm reference. | "" |
+| `connectionDetails.secretKey.valueFrom.configMapKeyRef.key` | Key for ConfigMap key reference. | "" |
+| `connectionDetails.secretKey.valueFrom.configMapKeyRef.name` | Name for ConfigMap key reference. | "" |
+| `connectionDetails.secretKey.valueFrom.secretKeyRef.key` | Key for Secret key reference. | "" |
+| `connectionDetails.secretKey.valueFrom.secretKeyRef.name` | Name for Secret key reference. | "" |
+| `connectionDetails.region` | AWS region. | "" |
+| `connectionDetails.endpoint` | AWS endpoint. | "" |
+| `connectionDetails.skipTLSVerify` | Skip TLS verification. | "" |
+| `connectionDetails.assumeRole` | Assume AWS role. | "" |
+
+### Cloudtrail
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `cloudtrail.maxAge` | Maximum age for CloudTrail. | "" |
+| `cloudtrail.exclude` | List of excluded items for CloudTrail. | [] |
+
+### Compliance
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `compliance` | Enable or disable compliance. | true |
+
+### Cost Reporting
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `costReporting.enabled` | Enable or disable cost reporting. | false |
+| `costReporting.database` | Cost reporting database. | "" |
+| `costReporting.region` | Cost reporting region. | "" |
+| `costReporting.s3BucketPath` | S3 bucket path for cost reporting. | "" |
+| `costReporting.table` | Table for cost reporting. | "" |
+
+### Inventory
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `inventory` | Enable or disable inventory. | true |
+
+### Patch Details
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `patchDetails` | Enable or disable patch details. | true |
+
+### Patch States
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `patchStates` | Enable or disable patch states. | true |
+
+### Trusted Advisor Check
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `trustedAdvisorCheck` | Enable or disable Trusted Advisor check. | false |
+
+### AWS Regions
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `regions` | List of AWS regions to pull from. | [] |
+
+### Include Resources
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `includeResources` | List of resources to include. | [] |
+
+### Exclude Resources
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `excludeResources` | List of resources to exclude. | [] |

mission-control/docs/registry/kubernetes.md

@@ -0,0 +1,49 @@
+# Kubernetes
+
+## Setup
+
+The Kubernetes helm chart installs a [catalog scraper](/config-db/scrapers/kubernetes) and a [topology](/topology/examples/kubernetes) for a kubernetes
+
+```sh
+helm repo add flanksource https://flanksource.github.io/charts
+helm repo update
+helm install {release-name} flanksource/mission-control-registry-kubernetes
+```
+
+## Values
+
+This document provides an overview of configurable values for deploying the Kubernetes Scraper component using Helm.
+
+### Configuration
+
+The following table lists the configurable parameters and their default values:
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `nameOverride` | Overrides the name of the chart. | "" |
+| `fullnameOverride` | Overrides the full name of the chart. | "" |
+| `labels` | Additional labels to apply to resources. | {} |
+
+### Topology
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `topology.name` | Topology name. | "cluster" |
+| `topology.schedule` | Topology schedule. | "@every 5m" |
+
+### Scraper
+
+| Parameter | Description | Default |
+| --- | --- | --- |
+| `scraper.name` | Scraper name. | "kubernetes" |
+| `scraper.clusterName` | Cluster name for scraping. | "kubernetes" |
+| `scraper.defaultScrapeExclusions` | Default scrape exclusions. | ["APIService", "PodMetrics", "NodeMetrics", "endpoints.discovery.k8s.io", "endpointslices.discovery.k8s.io", "leases.coordination.k8s.io", "podmetrics.metrics.k8s.io", "nodemetrics.metrics.k8s.io", "controllerrevision", "certificaterequest", "orders.acme.cert-manager.io"] |
+| `scraper.scrapeExclusions` | Additional scrape exclusions. | ["Secret", "customresourcedefinition"] |
+| `scraper.eventExclusions` | Event exclusions. | ["SuccessfulCreate", "Created", "DNSConfigForming"] |
+| `scraper.transform.changes.exclude` | Transformation changes exclusions. | ["details.source.component == \"canary-checker\" && details.reason == \"Failed\"", "details.source.component == \"canary-checker\" && details.reason == \"Succeeded\""] |
+| `scraper.severityKeywords.error` | Keywords indicating error severity. | ["failed", "error"] |
+| `scraper.severityKeywords.warn` | Keywords indicating warning severity. | ["backoff", "nodeoutofmemory"] |
+| `scraper.retention.changes` | Retention changes. | [{"name": "ReconciliationSucceeded", "count": 10}] |
+| `scraper.relationships` | Kubernetes relationships to create via name, namespace and kind. [Reference Docs](/config-db/scrapers/kubernetes#kubernetesrelationships) | [{"name": {"label": "helm.toolkit.fluxcd.io/name"}, {"name": {"label": "helm.toolkit.fluxcd.io/namespace"}, {"kind": {"value": "HelmRelease"}] |
+
+Feel free to customize this template according to your specific needs.

mission-control/docs/registry/overview.md

@@ -0,0 +1,8 @@
+# Registry
+
+We provide ready to use helm charts for setting up:
+
+- [Kubernetes](/registry/kubernetes)
+- [AWS](/registry/aws)
+- Azure
+- Prometheus

mission-control/docusaurus.config.js

@@ -113,6 +113,12 @@ const config = {
             label: 'Playbooks',
             position: 'left',
           },
+          {
+            to: 'registry/overview',
+            activeBasePath: 'registry',
+            label: 'Registry',
+            position: 'left',
+          },
           {
             to: 'reference/scripting',
             label: 'Reference',

mission-control/sidebars.js

@@ -836,6 +836,23 @@ const sidebars = {
       ]
     }
   ],
+  registrySidebar: [
+    {
+        type: 'doc',
+        id: 'registry/overview',
+        label: 'Overview',
+    },
+    {
+        type: 'doc',
+        id: 'registry/aws',
+        label: 'AWS',
+    },
+    {
+        type: 'doc',
+        id: 'registry/kubernetes',
+        label: 'Kubernetes',
+    },
+  ],
   reference: [
     {
       type: 'doc',