diff --git a/docs/concepts/README.md b/docs/concepts/README.md index 4e61cd088..8be518788 100644 --- a/docs/concepts/README.md +++ b/docs/concepts/README.md @@ -16,3 +16,15 @@ aliases: # Concepts Concepts help you learn about the different parts of the CLI and the abstractions it uses. + +- What is KubeDB + - [Overview](/docs/concepts/what-is-kubedb/overview.md). Provides a conceptual introduction to KubeDB, including the problems it solves and its high-level architecture. +- Databases + - [Elasticsearch](/docs/concepts/databases/elasticsearch.md). Introduces the concept of `Elasticsearch` to manage Elasticsearch using KubeDB. + - [Memcached](/docs/concepts/databases/memcached.md). Introduces the concept of `Memcached` to manage Memcached using KubeDB. + - [MongoDB](/docs/concepts/databases/mongodb.md). Introduces the concept of `MongoDB` to manage MongoDB using KubeDB. + - [MySQL](/docs/concepts/databases/mysql.md). Introduces the concept of `MySQL` to manage MySQL using KubeDB. + - [PostgreSQL](/docs/concepts/databases/postgres.md). Introduces the concept of `PostgreSQL` to manage PostgreSQL using KubeDB. + - [Redis](/docs/concepts/databases/redis.md). Introduces the concept of `Redis` to manage Redis using KubeDB. +- [Monitoring](/docs/concepts/monitoring.md). Introduces various aspects of KubeDB's support for monitoring via Prometheus. +- [Snapshot](/docs/concepts/snapshot.md). Introduces the concept of `Snapshot` to take backups of a KubeDB managed database. diff --git a/docs/concepts/monitoring.md b/docs/concepts/monitoring.md index d8f3ce5ed..e21289aa0 100644 --- a/docs/concepts/monitoring.md +++ b/docs/concepts/monitoring.md @@ -45,12 +45,12 @@ spec: | `spec.monitor.prometheus.labels` | map | `Required`. Indicates labels applied to service monitor. | | `spec.monitor.prometheus.interval` | string | `Optional`. Indicates the scrape interval for database exporter endpoint (eg, '10s') | -__Known Limitations:__ If the databse password is updated, exporter must be restarted to use the new credentials. This issue is tracked [here](https://github.com/kubedb/operator/issues/63). +__Known Limitations:__ If the databse password is updated, exporter must be restarted to use the new credentials. This issue is tracked [here](https://github.com/kubedb/project/issues/53). ## Next Steps - Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md). - Learn how to use KubeDB to run a PostgreSQL database [here](/docs/guides/postgres/overview.md). - Learn how to use KubeDB to run an Elasticsearch database [here](/docs/guides/elasticsearch/overview.md). -- Wondering what features are coming next? Please visit [here](/docs/roadmap.md). +- Wondering what features are coming next? Please visit [here](/docs/roadmap.md). - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/elasticsearch/overview.md b/docs/guides/elasticsearch/overview.md index e5f978614..c924b8a37 100644 --- a/docs/guides/elasticsearch/overview.md +++ b/docs/guides/elasticsearch/overview.md @@ -603,7 +603,7 @@ If you would like to uninstall KubeDB operator, please follow the steps [here](/ ## Next Steps -- Learn about the details of Elasticsearch object [here](/docs/concepts/elasticsearch.md). +- Learn about the details of Elasticsearch object [here](/docs/concepts/databases/elasticsearch.md). - See the list of supported storage providers for snapshots [here](/docs/concepts/snapshot.md). - Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md). - Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster. diff --git a/docs/guides/memcached/overview.md b/docs/guides/memcached/overview.md index 594fa1c4e..c82f8ed14 100644 --- a/docs/guides/memcached/overview.md +++ b/docs/guides/memcached/overview.md @@ -378,7 +378,7 @@ If you would like to uninstall KubeDB operator, please follow the steps [here](/ ## Next Steps -- Learn about the details of Memcached crd [here](/docs/concepts/memcached.md). +- Learn about the details of Memcached crd [here](/docs/concepts/databases/memcached.md). - Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md). - Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster. - Wondering what features are coming next? Please visit [here](/docs/roadmap.md). diff --git a/docs/guides/mongodb/overview.md b/docs/guides/mongodb/overview.md index c4b0ab37f..9debc3be1 100644 --- a/docs/guides/mongodb/overview.md +++ b/docs/guides/mongodb/overview.md @@ -719,7 +719,7 @@ If you would like to uninstall KubeDB operator, please follow the steps [here](/ ## Next Steps -- Learn about the details of MongoDB object [here](/docs/concepts/mongodb.md). +- Learn about the details of MongoDB object [here](/docs/concepts/databases/mongodb.md). - See the list of supported storage providers for snapshots [here](/docs/concepts/snapshot.md). - Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md). - Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster. diff --git a/docs/guides/mysql/overview.md b/docs/guides/mysql/overview.md index 37b5ffe87..9a1f5e32e 100644 --- a/docs/guides/mysql/overview.md +++ b/docs/guides/mysql/overview.md @@ -681,7 +681,7 @@ If you would like to uninstall KubeDB operator, please follow the steps [here](/ ## Next Steps -- Learn about the details of MySQL object [here](/docs/concepts/mysql.md). +- Learn about the details of MySQL object [here](/docs/concepts/databases/mysql.md). - See the list of supported storage providers for snapshots [here](/docs/concepts/snapshot.md). - Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md). - Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster. diff --git a/docs/guides/postgres/overview.md b/docs/guides/postgres/overview.md index 3c60ac373..fc5dd198d 100644 --- a/docs/guides/postgres/overview.md +++ b/docs/guides/postgres/overview.md @@ -602,7 +602,7 @@ If you would like to uninstall KubeDB operator, please follow the steps [here](/ ## Next Steps -- Learn about the details of Postgres object [here](/docs/concepts/postgres.md). +- Learn about the details of Postgres object [here](/docs/concepts/databases/postgres.md). - See the list of supported storage providers for snapshots [here](/docs/concepts/snapshot.md). - Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md). - Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster. diff --git a/docs/guides/redis/overview.md b/docs/guides/redis/overview.md index 0ce46e0df..106f78517 100644 --- a/docs/guides/redis/overview.md +++ b/docs/guides/redis/overview.md @@ -366,7 +366,7 @@ If you would like to uninstall KubeDB operator, please follow the steps [here](/ ## Next Steps -- Learn about the details of Redis object [here](/docs/concepts/redis.md). +- Learn about the details of Redis object [here](/docs/concepts/databases/redis.md). - Thinking about monitoring your database? KubeDB works [out-of-the-box with Prometheus](/docs/guides/monitoring.md). - Learn how to use KubeDB in a [RBAC](/docs/guides/rbac.md) enabled cluster. - Wondering what features are coming next? Please visit [here](/docs/roadmap.md).