Skip to content

Commit d13b1d8

Browse files
docs(readme): update table of contents
1 parent 7e66d14 commit d13b1d8

File tree

1 file changed

+40
-14
lines changed

1 file changed

+40
-14
lines changed

README.md

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,45 @@ The Metrics Operator is a powerful tool designed to monitor and provide insights
66

77
## Table of Contents
88

9-
- [Key Features](#key-features)
10-
- [Architecture Overview](#architecture-overview)
11-
- [Installation](#installation)
12-
- [Getting Started](#getting-started)
13-
- [Usage](#usage)
14-
- [Remote Cluster Access](#remote-cluster-access)
15-
- [RBAC Configuration](#rbac-configuration)
16-
- [DataSink Configuration](#datasink-configuration)
17-
- [Data Sink Integration](#data-sink-integration)
18-
- [Support, Feedback, Contributing](#support-feedback-contributing)
19-
- [Security / Disclosure](#security--disclosure)
20-
- [Code of Conduct](#code-of-conduct)
21-
- [Licensing](#licensing)
9+
- [Metrics Operator](#metrics-operator)
10+
- [Table of Contents](#table-of-contents)
11+
- [Key Features](#key-features)
12+
- [Architecture Overview](#architecture-overview)
13+
- [Metric Resource Flow](#metric-resource-flow)
14+
- [ManagedMetric Resource Flow](#managedmetric-resource-flow)
15+
- [FederatedMetric Resource Flow](#federatedmetric-resource-flow)
16+
- [FederatedManagedMetric Resource Flow](#federatedmanagedmetric-resource-flow)
17+
- [Resource Type Descriptions:](#resource-type-descriptions)
18+
- [Installation](#installation)
19+
- [Prerequisites](#prerequisites)
20+
- [Deployment](#deployment)
21+
- [Getting Started](#getting-started)
22+
- [Quickstart](#quickstart)
23+
- [Common Development Tasks](#common-development-tasks)
24+
- [Usage](#usage)
25+
- [Metric](#metric)
26+
- [Managed Metric](#managed-metric)
27+
- [Federated Metric](#federated-metric)
28+
- [Federated Managed Metric](#federated-managed-metric)
29+
- [Remote Cluster Access](#remote-cluster-access)
30+
- [Remote Cluster Access](#remote-cluster-access-1)
31+
- [Federated Cluster Access](#federated-cluster-access)
32+
- [RBAC Configuration](#rbac-configuration)
33+
- [DataSink Configuration](#datasink-configuration)
34+
- [Creating a DataSink](#creating-a-datasink)
35+
- [DataSink Specification](#datasink-specification)
36+
- [Connection](#connection)
37+
- [Authentication](#authentication)
38+
- [Using DataSink in Metrics](#using-datasink-in-metrics)
39+
- [Default Behavior](#default-behavior)
40+
- [Supported Metric Types](#supported-metric-types)
41+
- [Examples and Detailed Documentation](#examples-and-detailed-documentation)
42+
- [Migration from Legacy Configuration](#migration-from-legacy-configuration)
43+
- [Data Sink Integration](#data-sink-integration)
44+
- [Support, Feedback, Contributing](#support-feedback-contributing)
45+
- [Security / Disclosure](#security--disclosure)
46+
- [Code of Conduct](#code-of-conduct)
47+
- [Licensing](#licensing)
2248

2349
## Key Features
2450

@@ -116,7 +142,7 @@ graph LR
116142
class DS dataType
117143
```
118144

119-
### Resource Type Descriptions:
145+
## Resource Type Descriptions:
120146

121147
- [**Metric**](config/crd/bases/metrics.cloud.sap_metrics.yaml): Monitors specific Kubernetes resources in the local or remote clusters using GroupVersionKind targeting
122148
- [**ManagedMetric**](config/crd/bases/metrics.cloud.sap_managedmetrics.yaml): Specialized for monitoring Crossplane managed resources (resources with "crossplane" and "managed" categories)

0 commit comments

Comments
 (0)