Skip to content

Commit 7c43843

Browse files
docs: add database-management overview, update guides/selfhost-setup README links
Signed-off-by: Arnob kumar saha <arnob@appscode.com>
1 parent 541e4f0 commit 7c43843

3 files changed

Lines changed: 42 additions & 11 deletions

File tree

docs/platform/guides/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ This section contains practical, task-oriented guides for operating and managing
1919

2020
## Guide categories
2121

22-
- [Account Management](../account-management/)
23-
- [Billing and Usage Guide](../billing-and-usage-guide/)
24-
- [Cluster Management](../cluster-management/)
25-
- [Database Management](../database-management/)
26-
- [Get Started](../get-started/)
27-
- [Integrations](../integrations/)
28-
- [License Management](../license-management/)
22+
- [Account Management](../guides/account-management/manage-profile/)
23+
- [Billing and Usage Guide](../guides/billing-and-usage-guide/overview)
24+
- [Cluster Management](../guides/cluster-management/cluster-overview)
25+
- [Database Management](../guides/database-management/overview)
26+
- [Get Started](../guides/get-started/architecture)
27+
- [Integrations](../guides/integrations/rancher-extension)
28+
- [License Management](../guides/license-management/overview)
2929

3030
## Recommended path
3131

32-
For first-time users, start with [Get Started](../get-started/) and then move to the specific management areas relevant to your workflow.
32+
For first-time users, start with [Get Started](../guides/get-started/architecture) and then move to the specific management areas relevant to your workflow.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: docs
3+
menu:
4+
docsplatform_{{.version}}:
5+
identifier: database-management-overview
6+
name: Overview
7+
parent: database-management
8+
weight: 10
9+
menu_name: docsplatform_{{.version}}
10+
section_menu_id: guides
11+
---
12+
13+
## Overview <br>
14+
15+
**Database Management** is where you operate the databases provisioned through KubeDB Platform after they've been created. It brings the day-2 operational tasks — scaling, backup, restore, version upgrades, reconfiguration, TLS, monitoring, and more — into a single, per-database console so you don't need to reach for `kubectl` or hand-craft custom resources for routine work.
16+
17+
**Target Audience:** This guide is intended for `database administrators` and `operators` responsible for the ongoing health, availability, and data protection of databases running on KubeDB Platform.
18+
19+
![Database overview page showing status, resource usage, and available operations](../images/db-overview.png)
20+
21+
### Key Sections
22+
23+
- **[Database Usage & Insights](../database-usage-insight.md):** Monitor resource consumption and get at-a-glance health information for a database.
24+
- **[Scaling Databases](../scaling.md) / [Scaling Storages](../scaling-storage.md):** Adjust CPU, memory, replica count, or storage size — manually or through autoscaling policies.
25+
- **[Configure Backups](../backup.md), [Instant Backup & Restore](../instant-backup-restore.md), [Backup Restore](../restore.md):** Set up scheduled backups, trigger on-demand backups, and restore data when needed.
26+
- **[Upgrade Database Version](../upgrade-version.md), [Database Restarts](../restart-database.md), [Reconfigure Databases](../reconfigure-database.md):** Perform version upgrades, restarts, and configuration changes with minimal disruption.
27+
- **[Configure TLS](../tls.md), [Configure Monitoring](../monitoring.md), [Expose via Gateway](../expose-via-gateway.md):** Secure connections, enable Prometheus-based monitoring, and expose databases outside the cluster.
28+
- **[Manage Recommendations](../manage-recommendations.md), [Database Security Report](../security-report.md), [Database Constraint Violations](../contraint-violations.md):** Review platform-generated recommendations and compliance findings for a database.
29+
- **[Delete Database](../delete-database.md):** Safely remove a database and its associated resources.
30+
31+
Each operation is exposed as a dedicated form or panel in the left sidebar of a database's detail page. Under the hood, most actions are translated into Kubernetes `OpsRequest` custom resources, so every change is applied declaratively and can be tracked through its lifecycle — giving you the convenience of a UI with the auditability of GitOps-style operations.

docs/platform/selfhost-setup/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Welcome to KubeDB Platform's Self-Hosted deployment! Whether you're looking for
1919

2020
Navigate to [KubeDB Platform Self-Hosted](https://appscode.com/selfhost). Here you will find your previously generated self-hosted installers.
2121

22-
![Installer Home](../images/installer-home.png)
22+
![Installer Home](../selfhost-setup/images/installer-home.png)
2323
<br/>
2424

2525
<br/>
@@ -29,9 +29,9 @@ Click on the `Create New Installer` button to get started. You can choose variou
2929

3030
<br/>
3131

32-
To get detailed documentation on `Cloud Demo` installer, head over to [Demo Deployment](../install/cloud-demo.md).
32+
To get detailed documentation on `Cloud Demo` installer, head over to [Demo Deployment](../selfhost-setup/install/cloud-demo.md).
3333
<br/>
3434

3535
<br/>
3636

37-
To get detailed documentation on `Self Hosted Production` installer, head over to [Production Deployment](../install/selfhosted-production.md).
37+
To get detailed documentation on `Self Hosted Production` installer, head over to [Production Deployment](../selfhost-setup/install/selfhosted-production.md).

0 commit comments

Comments
 (0)