diff --git a/docs/guides/cassandra/README.md b/docs/guides/cassandra/README.md index a6acdefac1..05b69ef261 100644 --- a/docs/guides/cassandra/README.md +++ b/docs/guides/cassandra/README.md @@ -24,20 +24,17 @@ Apache Cassandra is a highly scalable, distributed NoSQL database designed to ha |---------------------------------------------------------------|:------------:| | Clustering | ✓ | | Custom Configuration | ✓ | -| Backup/Recovery | ✓ | -| Monitoring using Prometheus and Grafana | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Operator managed Prometheus Discovery | ✓ | -| Authentication & Authorization (TLS) | ✓ | -| Externally manageable Auth Secret | ✓ | -| Persistent volume | ✓ | -| Grafana Dashboards (Alerts and Monitoring) | ✓ | +| Backup & Recovery | ✓ | +| Monitoring (Prometheus & Grafana Dashboards) | ✓ | +| TLS/SSL Encryption (Add, Remove, Rotate, Update) | ✓ | +| Auth Secret Management & Rotation | ✓ | +| Persistent Volume | ✓ | | Automated Version Update | ✓ | -| Automated Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | +| Horizontal & Vertical Scaling | ✓ | | Automated Volume Expansion | ✓ | -| Autoscaling ( Compute resources & Storage ) | ✓ | -| Reconfigurable TLS Certificates (Add, Remove, Rotate, Update) | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Reconfigure | ✓ | +| Restart | ✓ | ## Supported Cassandra Versions diff --git a/docs/guides/clickhouse/README.md b/docs/guides/clickhouse/README.md index 453a1d9788..55cee8000a 100644 --- a/docs/guides/clickhouse/README.md +++ b/docs/guides/clickhouse/README.md @@ -17,16 +17,21 @@ aliases: ## Supported ClickHouse Features -| Features | Availability | -|---------------------------------------------------------------|:------------:| -| ClusterTopology | ✓ | -| Initialize using Script (\*.sql, \*sql.gz and/or \*.sh) | ✓ | -| Custom Configuration | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| Authentication & Authorization (TLS) | ✓ | -| Externally manageable Auth Secret | ✓ | -| Reconfigurable TLS Certificates (Add, Remove, Rotate, Update) | ✓ | +| Features | Availability | +|---------------------------------------------------------|:------------:| +| ClusterTopology | ✓ | +| Initialize using Script (\*.sql, \*sql.gz and/or \*.sh) | ✓ | +| Custom Configuration | ✓ | +| Monitoring (Prometheus) | ✓ | +| TLS/SSL Encryption | ✓ | +| Externally manageable Auth Secret | ✓ | +| Reconfigure | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| Update Version | ✓ | +| Restart | ✓ | +| Rotate Authentication | ✓ | +| Autoscaling | ✓ | ## Supported ClickHouse Versions @@ -43,4 +48,18 @@ KubeDB supports the following ClickHouse Versions. ## User Guide - [Quickstart ClickHouse](/docs/guides/clickhouse/quickstart/guide/quickstart.md) with KubeDB Operator. +- [Custom Configuration](/docs/guides/clickhouse/configuration/using-config-file.md) of ClickHouse. +- [Using Builtin Prometheus](/docs/guides/clickhouse/monitoring/using-builtin-prometheus.md) for monitoring. +- [Using Prometheus Operator](/docs/guides/clickhouse/monitoring/using-prometheus-operator.md) for monitoring. +- [Configure TLS/SSL](/docs/guides/clickhouse/tls/cluster.md) for ClickHouse. +- [Reconfigure TLS](/docs/guides/clickhouse/reconfigure-tls/clickhouse.md) for ClickHouse. +- [Reconfigure](/docs/guides/clickhouse/reconfigure/reconfigure.md) ClickHouse. +- [Horizontal Scaling](/docs/guides/clickhouse/scaling/horizontal-scaling/cluster.md) of ClickHouse. +- [Vertical Scaling](/docs/guides/clickhouse/scaling/vertical-scaling/cluster.md) of ClickHouse. +- [Volume Expansion](/docs/guides/clickhouse/volume-expansion/cluster.md) of ClickHouse. +- [Update Version](/docs/guides/clickhouse/update-version/update-version.md) of ClickHouse. +- [Restart](/docs/guides/clickhouse/restart/restart.md) ClickHouse. +- [Rotate Authentication](/docs/guides/clickhouse/rotate-auth/rotateauth.md) for ClickHouse. +- [Compute Autoscaling](/docs/guides/clickhouse/autoscaler/compute/compute-autoscale.md) of ClickHouse. +- [Storage Autoscaling](/docs/guides/clickhouse/autoscaler/storage/storage-autoscale.md) of ClickHouse. - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/druid/README.md b/docs/guides/druid/README.md index e1f9c98d61..62f357efcd 100644 --- a/docs/guides/druid/README.md +++ b/docs/guides/druid/README.md @@ -24,26 +24,26 @@ Apache Druid is a real-time analytics database designed for fast slice-and-dice | Features | Availability | |------------------------------------------------------------------------------------|:-----:| -| Clustering | ✓ | -| Druid Dependency Management (MySQL, PostgreSQL and ZooKeeper) | ✓ | -| Authentication & Authorization | ✓ | -| Custom Configuration | ✓ | -| Backup/Recovery: Instant, Scheduled ( [KubeStash](https://kubestash.com/)) | ✓ | -| Monitoring with Prometheus & Grafana | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| Externally manageable Auth Secret | ✓ | -| Reconfigurable Health Checker | ✓ | -| Persistent volume | ✓ | -| Dashboard ( Druid Web Console ) | ✓ | -| Automated Version Update | ✓ | -| Automatic Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | -| Automated db-configure Reconfiguration | ✓ | -| TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | -| Automated Reprovision | ✓ | -| Automated Volume Expansion | ✓ | -| Autoscaling (vertically) | ✓ | +| Clustering | ✓ | +| Druid Dependency Management (MySQL, PostgreSQL and ZooKeeper) | ✓ | +| Authentication & Authorization | ✓ | +| Externally manageable Auth Secret | ✓ | +| Rotate Authentication | ✓ | +| Custom Configuration | ✓ | +| Reconfiguration (db-configure) | ✓ | +| Backup & Recovery ( [KubeStash](https://kubestash.com/)) | ✓ | +| Monitoring (Prometheus & Grafana) | ✓ | +| Reconfigurable Health Checker | ✓ | +| Persistent Volume | ✓ | +| Dashboard ( Druid Web Console ) | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| TLS/SSL Encryption ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | +| Automated Reprovision | ✓ | +| Volume Expansion | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Failover & Disaster Recovery | ✓ | +| Restart | ✓ | ## Supported Druid Versions diff --git a/docs/guides/elasticsearch/README.md b/docs/guides/elasticsearch/README.md index 420dd8f603..0de9881d3a 100644 --- a/docs/guides/elasticsearch/README.md +++ b/docs/guides/elasticsearch/README.md @@ -17,27 +17,30 @@ aliases: ## Elasticsearch Features -| Features | Availability | -|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------:| -| Combined Cluster (n nodes with master,data,ingest: ture; n >= 1 ) | ✓ | -| Topology Cluster (n master, m data, x ingest nodes; n,m,x >= 1 ) | ✓ | -| Hot-Warm-Cold Topology Cluster (a hot, b warm, c cold nodes; a,b,c >= 1 ) | ✓ | -| TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | -| Automated Version Update | ✓ | -| Automatic Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | -| Automated Volume Expansion | ✓ | -| Backup/Recovery: Instant, Scheduled ( [Stash](https://stash.run/) ) | ✓ | -| Dashboard ( Kibana , Opensearch-Dashboards ) | ✓ | -| Grafana Dashboards | ✓ | -| Initialization from Snapshot ( [Stash](https://stash.run/) ) | ✓ | -| Authentication ( [OpensSearch](https://opensearch.org/) / [X-Pack](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/setup-xpack.html) / [OpenDistro](https://opendistro.github.io/for-elasticsearch-docs/) / [Search Guard](https://docs.search-guard.com/latest/) ) | ✓ | -| Authorization ( [OpensSearch](https://opensearch.org/) / [X-Pack](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/setup-xpack.html) / [OpenDistro](https://opendistro.github.io/for-elasticsearch-docs/) / [Search Guard](https://docs.search-guard.com/latest/) ) | ✓ | -| Persistent Volume | ✓ | -| Exports Prometheus Matrices | ✓ | -| Custom Configuration | ✓ | -| Using Custom Docker Image | ✓ | -| Autoscaling (vertically) | ✓ | +| Features | Availability | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------:| +| Combined Cluster (n nodes with master, data, ingest: true; n >= 1) | ✓ | +| Topology Cluster (dedicated master, data, ingest nodes) | ✓ | +| Hot-Warm-Cold Topology Cluster (dedicated hot, warm, cold nodes) | ✓ | +| TLS/SSL Encryption: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | +| Authentication & Authorization ( [OpenSearch](https://opensearch.org/) / [X-Pack](https://www.elastic.co/guide/en/elasticsearch/reference/7.9/setup-xpack.html) / [OpenDistro](https://opendistro.github.io/for-elasticsearch-docs/) / [Search Guard](https://docs.search-guard.com/latest/) ) | ✓ | +| Rotate Authentication Credentials | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Automated Volume Expansion | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Backup & Recovery: Instant, Scheduled ( [Stash](https://stash.run/) / [KubeStash](https://kubestash.com/) ) | ✓ | +| Backup & Recovery using Elasticsearch Snapshot Plugins (S3, GCS, Azure, etc.) | ✓ | +| Initialization from Snapshot ( [Stash](https://stash.run/) ) | ✓ | +| Dashboard (Kibana, Opensearch-Dashboards) | ✓ | +| Monitoring (Builtin Prometheus & Prometheus Operator) | ✓ | +| Grafana Dashboards | ✓ | +| Custom Configuration (incl. JVM Options) | ✓ | +| Using Custom Docker Image | ✓ | +| Custom RBAC Resources | ✓ | +| Persistent Volume | ✓ | +| Restart | ✓ | +| GitOps | ✓ | ## Lifecycle of Elasticsearch Object diff --git a/docs/guides/hazelcast/README.md b/docs/guides/hazelcast/README.md index 18f8264d37..fc67f52947 100644 --- a/docs/guides/hazelcast/README.md +++ b/docs/guides/hazelcast/README.md @@ -20,26 +20,22 @@ aliases: Hazelcast is an open-source, Java-based, information retrieval library with support for limited relational, graph, statistical, data analysis or storage related use cases. Hazelcast is designed to drive powerful document retrieval or analytical applications involving unstructured data, semi-structured data or a mix of unstructured and structured data. Hazelcast is highly reliable, scalable and fault tolerant, providing distributed indexing, replication and load-balanced querying, automated failover and recovery, centralized configuration and more. Hazelcast powers the search and navigation features of many of the world's largest internet sites. ## Supported Hazelcast Features -| Features | Availability | -|----------------------------------------------------|:------------:| -| Clustering | ✓ | -| Customized Docker Image | ✓ | -| Authentication & Autorization | ✓ | -| Reconfigurable Health Checker | ✓ | -| Custom Configuration | ✓ | -| Grafana Dashboards | ✓ | -| Externally manageable Auth Secret | ✓ | -| Persistent Volume | ✓ | -| Monitoring with Prometheus & Grafana | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Alert Dashboard | ✓ | -| Using Prometheus operator | ✓ | -| Automated Version Update | ✓ | -| Automatic Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | -| Automated Volume Expansion | ✓ | -| Autoscaling (vertically, volume) | ✓ | -| TLS: Add, Remove, Update, Rotate ( Cert Manager ) | ✓ | +| Features | Availability | +|-----------------------------------------------------------|:------------:| +| Clustering | ✓ | +| Authentication & Authorization | ✓ | +| Auth Secret Management & Rotation | ✓ | +| Reconfigurable Health Checker | ✓ | +| Custom Configuration | ✓ | +| Persistent Volume | ✓ | +| Monitoring (Prometheus & Grafana) | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Automated Volume Expansion | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| TLS/SSL Encryption (Add, Remove, Update, Rotate) | ✓ | +| Restart | ✓ | + ## Life Cycle of a Hazelcast Object

diff --git a/docs/guides/ignite/README.md b/docs/guides/ignite/README.md index 5e908c7055..56cc2b3620 100644 --- a/docs/guides/ignite/README.md +++ b/docs/guides/ignite/README.md @@ -15,20 +15,23 @@ aliases: > New to KubeDB? Please start [here](/docs/README.md). ## Supported Ignite Features -| Features | Availability | -| ------------------------------------ | :----------: | -| Clustering | ✓ | -| Persistent Volume | ✓ | -| Initialize using Script | ✓ | -| Multiple Ignite Versions | ✓ | -| Custom Configuration | ✓ | -| Externally manageable Auth Secret | ✓ | -| Reconfigurable Health Checker | ✓ | -| Using Custom docker image | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| Grafana Dashboard | ✓ | -| Alert Dashboard | ✓ | +| Features | Availability | +| ------------------------------------------------- | :----------: | +| Clustering | ✓ | +| Persistent Volume | ✓ | +| Multiple Ignite Versions | ✓ | +| Custom Configuration | ✓ | +| Externally manageable Auth Secret | ✓ | +| Reconfigurable Health Checker | ✓ | +| Using Custom docker image | ✓ | +| Monitoring (Prometheus) | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Automated Volume Expansion | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Reconfigure | ✓ | +| TLS/SSL Encryption (Cert Manager) | ✓ | +| Restart | ✓ | +| Custom RBAC | ✓ | @@ -43,5 +46,15 @@ aliases: - Monitor your Ignite server with KubeDB using [out-of-the-box Prometheus operator](/docs/guides/ignite/monitoring/using-prometheus-operator.md). - Monitor your Ignite server with KubeDB using [out-of-the-box builtin-Prometheus](/docs/guides/ignite/monitoring/using-builtin-prometheus.md). - Use [private Docker registry](/docs/guides/ignite/private-registry/using-private-registry.md) to deploy Ignite with KubeDB. +- Use [Custom Configuration](/docs/guides/ignite/custom-configuration/using-config-file.md) to configure Ignite. +- Use [Custom RBAC](/docs/guides/ignite/custom-rbac/using-custom-rbac.md) to run Ignite with custom RBAC resources. +- [Horizontal Scale](/docs/guides/ignite/scaling/horizontal-scaling/horizontal-scaling.md) your Ignite cluster with KubeDB Ops Manager. +- [Vertical Scale](/docs/guides/ignite/scaling/vertical-scaling/vertical-scaling.md) your Ignite cluster with KubeDB Ops Manager. +- [Volume Expansion](/docs/guides/ignite/volume-expansion/volume-expansion.md) of your Ignite cluster with KubeDB Ops Manager. +- [Reconfigure](/docs/guides/ignite/reconfigure/reconfigure.md) your Ignite cluster with KubeDB Ops Manager. +- [Reconfigure TLS/SSL](/docs/guides/ignite/reconfigure-tls/reconfigure-tls.md) of your Ignite cluster with KubeDB Ops Manager. +- [Autoscale Compute Resources](/docs/guides/ignite/autoscaler/compute/compute-autoscale.md) of your Ignite cluster with KubeDB Autoscaler. +- [Autoscale Storage](/docs/guides/ignite/autoscaler/storage/storage-autoscale.md) of your Ignite cluster with KubeDB Autoscaler. +- [Restart](/docs/guides/ignite/restart/restart.md) your Ignite cluster with KubeDB Ops Manager. - Detail concepts of [Ignite object](/docs/guides/ignite/concepts/ignite.md). - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). \ No newline at end of file diff --git a/docs/guides/kafka/README.md b/docs/guides/kafka/README.md index 59491e13f7..597914dc67 100644 --- a/docs/guides/kafka/README.md +++ b/docs/guides/kafka/README.md @@ -19,24 +19,29 @@ aliases: | Features | Kafka | ConnectCluster | |------------------------------------------------------------------------------------|----------|----------------| -| Clustering - Combined (shared controller and broker nodes) | ✓ | - | -| Clustering - Topology (dedicated controllers and broker nodes) | ✓ | - | +| Clustering (Combined & Topology) | ✓ | - | | Custom Configuration | ✓ | ✓ | -| Automated Version Update | ✓ | ✗ | -| Automatic Vertical Scaling | ✓ | ✗ | -| Automated Horizontal Scaling | ✓ | ✗ | -| Automated Volume Expansion | ✓ | - | | Custom Docker Image | ✓ | ✓ | | Authentication & Authorization | ✓ | ✓ | -| TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | ✓ | +| TLS/SSL Encryption ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | ✓ | +| Reconfigure TLS/SSL | ✓ | ✗ | | Reconfigurable Health Checker | ✓ | ✓ | | Externally manageable Auth Secret | ✓ | ✓ | -| Pre-Configured JMX Exporter for Metrics | ✓ | ✓ | +| Rotate Authentication | ✓ | ✗ | | Monitoring with Prometheus & Grafana | ✓ | ✓ | -| Autoscaling (vertically, volume) | ✓ | ✗ | -| Custom Volume | ✓ | ✓ | -| Persistent Volume | ✓ | - | +| Horizontal & Vertical Scaling | ✓ | ✗ | +| Automated Version Update | ✓ | ✗ | +| Autoscaling (Compute & Storage) | ✓ | ✗ | +| Volume Expansion | ✓ | - | +| Custom & Persistent Volume | ✓ | ✓ | +| Restart | ✓ | ✗ | +| Reconfigure | ✓ | ✗ | | Connectors | - | ✓ | +| Tiered Storage (S3, GCS, Azure) | ✓ | - | +| Schema Registry | ✓ | - | +| Rest Proxy | ✓ | - | +| GitOps | ✓ | - | +| Migration | ✓ | ✓ | ## Lifecycle of Kafka Object diff --git a/docs/guides/mariadb/README.md b/docs/guides/mariadb/README.md index 82833ca442..cabf063e59 100644 --- a/docs/guides/mariadb/README.md +++ b/docs/guides/mariadb/README.md @@ -18,19 +18,28 @@ aliases: ## Supported MariaDB Features -| Features | Availability | -|---------------------------------------------------------| :----------: | -| Clustering | ✓ | -| Persistent Volume | ✓ | -| Instant Backup | ✓ | -| Scheduled Backup | ✓ | -| Continuous Archiving using `wal-g` | ✓ | -| Initialize using Snapshot | ✓ | -| Initialize using Script (\*.sql, \*sql.gz and/or \*.sh) | ✓ | -| Custom Configuration | ✓ | -| Using Custom docker image | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | +| Features | Availability | +|------------------------------------------------------------------| :----------: | +| Clustering | ✓ | +| Persistent Volume | ✓ | +| Backup & Recovery (Instant & Scheduled) | ✓ | +| Continuous Archiving and Point-in-time Recovery | ✓ | +| Initialization (Script & Git Repository) | ✓ | +| Custom Configuration | ✓ | +| Using Custom Docker Image | ✓ | +| Monitoring (Prometheus) | ✓ | +| TLS/SSL Encryption | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Reconfigure | ✓ | +| Update Version | ✓ | +| Volume Expansion | ✓ | +| Restart | ✓ | +| Rotate Authentication | ✓ | +| Failover and Disaster Recovery | ✓ | +| Distributed (Multi-cluster) | ✓ | +| GitOps | ✓ | +| Custom RBAC | ✓ | ## Life Cycle of a MariaDB Object diff --git a/docs/guides/memcached/README.md b/docs/guides/memcached/README.md index d493889cbc..8749f23bb9 100644 --- a/docs/guides/memcached/README.md +++ b/docs/guides/memcached/README.md @@ -23,22 +23,19 @@ aliases: | Features | Availability | | ----------------------------------------------------- | :----------: | | Custom Configuration | ✓ | -| Externally manageable Auth Secret | ✓ | -| Reconfigurable Health Checker | ✓ | -| Using Custom docker image | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Operator Managed Prometheus Discovery | ✓ | -| Automated Version Update | ✓ | -| Automated Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | -| Automated db-configure Reconfiguration | ✓ | | Authentication & Authorization | ✓ | -| TLS: Add, Remove, Update, Rotate ( Cert Manager ) | ✓ | -| Autoscaling (Vertically) | ✓ | +| Externally Manageable Auth Secret | ✓ | +| Reconfigurable Health Checker | ✓ | +| Using Custom Docker Image | ✓ | | Multiple Memcached Versions | ✓ | -| Monitoring using Prometheus and Grafana | ✓ | -| Monitoring Grafana Dashboard | ✓ | -| Alert Grafana Dashboard | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Compute Autoscaling | ✓ | +| Reconfiguration (db-configure) | ✓ | +| TLS/SSL Encryption (Add, Remove, Update, Rotate) | ✓ | +| Monitoring (Builtin Prometheus & Prometheus Operator) | ✓ | +| Restart | ✓ | +| Custom RBAC | ✓ | ## Life Cycle of a Memcached Object @@ -54,4 +51,14 @@ aliases: - Use [private Docker registry](/docs/guides/memcached/private-registry/using-private-registry.md) to deploy Memcached with KubeDB. - Use [kubedb cli](/docs/guides/memcached/cli/cli.md) to manage databases like kubectl for Kubernetes. - Detail concepts of [Memcached object](/docs/guides/memcached/concepts/memcached.md). +- [Horizontal Scale](/docs/guides/memcached/scaling/horizontal-scaling/horizontal-scaling.md) your Memcached cluster. +- [Vertical Scale](/docs/guides/memcached/scaling/vertical-scaling/vertical-scaling.md) your Memcached cluster. +- [Autoscale](/docs/guides/memcached/autoscaler/compute/compute-autoscale.md) compute resources of your Memcached cluster. +- [Update Version](/docs/guides/memcached/update-version/update-version.md) of your Memcached cluster. +- [Reconfigure](/docs/guides/memcached/reconfigure/reconfigure.md) your Memcached cluster. +- Configure [TLS/SSL Encryption](/docs/guides/memcached/tls/tls.md) for your Memcached cluster. +- [Reconfigure TLS](/docs/guides/memcached/reconfigure-tls/reconfigure-tls.md) for your Memcached cluster. +- [Restart](/docs/guides/memcached/restart/restart.md) your Memcached cluster. +- [Rotate Authentication](/docs/guides/memcached/rotate-auth/rotateauth.md) credentials of your Memcached cluster. +- Use [Custom RBAC](/docs/guides/memcached/custom-rbac/using-custom-rbac.md) to manage Memcached with fine-grained access control. - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/mongodb/README.md b/docs/guides/mongodb/README.md index 7577452979..60fdf2797f 100644 --- a/docs/guides/mongodb/README.md +++ b/docs/guides/mongodb/README.md @@ -20,27 +20,31 @@ aliases: | Features | Availability | |------------------------------------------------------------------------------------|:------------:| -| Clustering - Sharding | ✓ | -| Clustering - Replication | ✓ | +| Clustering (Replication & Sharding) | ✓ | +| Arbiter & Hidden Node Support | ✓ | | Custom Configuration | ✓ | | Using Custom Docker Image | ✓ | -| Initialization From Script (\*.js and/or \*.sh) | ✓ | -| Initializing from Snapshot ( [Stash](https://stash.run/) ) | ✓ | -| Authentication & Autorization | ✓ | -| Arbiter support | ✓ | +| Initialization (Script, Git Repository & Snapshot) | ✓ | +| Authentication & Authorization | ✓ | +| Rotate Authentication Credentials | ✓ | | Persistent Volume | ✓ | -| Instant Backup | ✓ | -| Scheduled Backup | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | +| Backup & Recovery (Instant & Scheduled) | ✓ | +| Continuous Archiving & Point-in-time Recovery | ✓ | +| Monitoring (Prometheus) | ✓ | | Automated Version Update | ✓ | -| Automatic Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | -| Automated db-configure Reconfiguration | ✓ | -| TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | -| Automated Reprovision | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Autoscaling (Compute & Storage) | ✓ | | Automated Volume Expansion | ✓ | -| Autoscaling (vertically) | ✓ | +| Reconfiguration | ✓ | +| TLS/SSL Encryption ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | +| Automated Reprovision | ✓ | +| Restart | ✓ | +| Custom RBAC | ✓ | +| Schema Manager | ✓ | +| Encryption at Rest with Vault KMIP | ✓ | +| External Connections (MongoDB Horizon) | ✓ | +| GitOps | ✓ | +| Failure & Disaster Recovery | ✓ | ## Life Cycle of a MongoDB Object diff --git a/docs/guides/mssqlserver/README.md b/docs/guides/mssqlserver/README.md index 042c910c09..56522be8cd 100644 --- a/docs/guides/mssqlserver/README.md +++ b/docs/guides/mssqlserver/README.md @@ -20,31 +20,33 @@ Microsoft SQL Server is one of the most popular relational database management s ## Supported Microsoft SQL Server Features -| Features | Availability | -|--------------------------------------------------------------------|:------------:| -| Standalone and Availability Group Cluster (HA configuration) | ✓ | -| Synchronous Replication | ✓ | -| Automatic Fail over | ✓ | -| Arbiter Node for quorum in even-sized clusters | ✓ | -| Custom Configuration | ✓ | -| Authentication & Authorization | ✓ | -| Externally manageable Auth Secret | ✓ | -| Instant and Scheduled Backup ([KubeStash](https://kubestash.com/)) | ✓ | -| Continuous Archiving using `wal-g` | ✓ | -| Initialization from WAL archive | ✓ | -| Initializing from Snapshot ([KubeStash](https://kubestash.com/)) | ✓ | -| Reconfigurable Health Checker | ✓ | -| Persistent Volume | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| Automated Version Update | ✓ | -| Automated Vertical Scaling, Volume Expansion | ✓ | -| Automated Horizontal Scaling | ✓ | -| Autoscaling Compute and Storage Resources | ✓ | -| Reconfiguration | ✓ | -| TLS configuration ([Cert Manager](https://cert-manager.io/docs/)) | ✓ | -| Reconfiguration of TLS: Add, Remove, Update, Rotate | ✓ | -| Grafana Dashboards | ✓ | +| Features | Availability | +|-----------------------------------------------------------------------------|:------------:| +| Standalone and Availability Group Cluster (HA configuration) | ✓ | +| Distributed Availability Group (DAG) Cluster | ✓ | +| Synchronous Replication | ✓ | +| Automatic Failover | ✓ | +| Arbiter Node for quorum in even-sized clusters | ✓ | +| Custom Configuration | ✓ | +| Authentication & Authorization | ✓ | +| Externally manageable Auth Secret | ✓ | +| Rotate Authentication Credentials | ✓ | +| Initialization using Script | ✓ | +| Backup & Recovery ([KubeStash](https://kubestash.com/)) | ✓ | +| Point-in-Time Recovery (PITR) via Continuous Archiving | ✓ | +| Initializing from Snapshot ([KubeStash](https://kubestash.com/)) | ✓ | +| Reconfigurable Health Checker | ✓ | +| Persistent Volume | ✓ | +| Monitoring (Prometheus: Builtin & Operator) | ✓ | +| Grafana Dashboards | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Reconfiguration | ✓ | +| TLS/SSL Encryption & Reconfiguration ([Cert Manager](https://cert-manager.io/docs/)) | ✓ | +| Restart | ✓ | +| GitOps | ✓ | ## Supported Microsoft SQL Server Versions diff --git a/docs/guides/mysql/README.md b/docs/guides/mysql/README.md index 216774ac31..5371162a8a 100644 --- a/docs/guides/mysql/README.md +++ b/docs/guides/mysql/README.md @@ -17,25 +17,32 @@ aliases: ## Supported MySQL Features -| Features | Availability | -|------------------------------------------------------------------------------------|:------------:| -| Group Replication | ✓ | -| Innodb Cluster | ✓ | -| SemiSynchronous cluster | ✓ | -| Read Replicas | ✓ | -| TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | -| Automated Version update | ✓ | -| Automatic Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | -| Automated Volume Expansion | ✓ | -| Backup/Recovery: Instant, Scheduled ( [Stash](https://stash.run/) ) | ✓ | -| Continuous Archiving using `wal-g` | ✓ | -| Initialize using Snapshot | ✓ | -| Initialize using Script (\*.sql, \*sql.gz and/or \*.sh) | ✓ | -| Custom Configuration | ✓ | -| Using Custom docker image | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | +| Features | Availability | +|-------------------------------------------------------------------------------------------------|:------------:| +| Group Replication | ✓ | +| Innodb Cluster | ✓ | +| SemiSynchronous Cluster | ✓ | +| Read Replicas (Remote Replica) | ✓ | +| Replication Mode Transform | ✓ | +| Failure and Disaster Recovery / Auto-failover | ✓ | +| TLS/SSL Encryption: Add, Remove, Update, Rotate, Reconfigure ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Automated Volume Expansion | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Backup & Recovery (Stash & KubeStash) | ✓ | +| Continuous Archiving and Point-in-time Recovery | ✓ | +| Initialize using Script (\*.sql, \*sql.gz and/or \*.sh) | ✓ | +| Initialize using Git Repository | ✓ | +| Custom Configuration & Reconfigure | ✓ | +| Schema Manager | ✓ | +| Storage Class Migration | ✓ | +| Restart | ✓ | +| Rotate Authentication Credentials | ✓ | +| Custom RBAC | ✓ | +| Using Private Docker Registry | ✓ | +| Monitoring (Prometheus) | ✓ | +| GitOps | ✓ | ## Life Cycle of a MySQL Object diff --git a/docs/guides/neo4j/README.md b/docs/guides/neo4j/README.md index 272b18af69..82571e4252 100644 --- a/docs/guides/neo4j/README.md +++ b/docs/guides/neo4j/README.md @@ -21,13 +21,22 @@ KubeDB supports graph database deployment with Neo4j using the `Neo4j` CRD. ## Supported Neo4j Features -| Features | Availability | -|----------------------------------|:------------:| -| Standalone provisioning | ✓ | -| Cluster provisioning | ✓ | -| Monitoring | ✓ | -| TLS | ✓ | -| Ops Requests | ✓ | +| Features | Availability | +|---------------------------------------------------|:------------:| +| Standalone & Cluster Provisioning | ✓ | +| Custom Configuration | ✓ | +| Custom RBAC | ✓ | +| Private Registry | ✓ | +| Monitoring (Builtin & Prometheus Operator) | ✓ | +| TLS/SSL Encryption | ✓ | +| Reconfigure TLS (Add, Remove, Rotate, Update) | ✓ | +| Rotate Authentication | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| StorageClass Migration | ✓ | +| Reconfigure | ✓ | +| Restart | ✓ | ## Supported Ops Requests diff --git a/docs/guides/oracle/README.md b/docs/guides/oracle/README.md index e6952f370f..ad6e3ebf51 100644 --- a/docs/guides/oracle/README.md +++ b/docs/guides/oracle/README.md @@ -17,16 +17,14 @@ aliases: ## Supported Oracle Features -| Features | Availability | -|------------------------------------|:------------:| -| Clustering | ✓ | -| Data Guard | ✓ | -| Synchronous Replication | ✓ | -| Streaming Replication | ✓ | -| Automatic Failover | ✓ | -| Persistent Volume | ✓ | -| Initialization using Script | ✓ | -| Using Custom docker image | ✓ | +| Features | Availability | +|---------------------------------------------------|:------------:| +| Deployment Modes (Standalone & DataGuard) | ✓ | +| Physical Standby & Synchronous Replication | ✓ | +| Automatic Failover (FSFO) | ✓ | +| Persistent Volume | ✓ | +| Resource Management (CPU/Memory) | ✓ | +| Deletion Policy | ✓ | ## Life Cycle of a Oracle Object @@ -37,5 +35,7 @@ aliases: ## User Guide - [Quickstart Oracle](/docs/guides/oracle/quickstart/guide.md) with KubeDB Operator. +- [Oracle CRD Concepts](/docs/guides/oracle/concepts/oracle.md) - Understand the Oracle CRD specification. +- [Failover and Disaster Recovery](/docs/guides/oracle/failover/overview.md) - Data Guard based HA and auto-failover. diff --git a/docs/guides/percona-xtradb/README.md b/docs/guides/percona-xtradb/README.md index 7064337785..5f5d24e12e 100644 --- a/docs/guides/percona-xtradb/README.md +++ b/docs/guides/percona-xtradb/README.md @@ -18,17 +18,24 @@ aliases: ## Supported PerconaXtraDB Features -| Features | Availability | -|------------------------------|:------------:| -| Clustering | ✓ | -| Persistent Volume | ✓ | -| Instant Backup | ✓ | -| Scheduled Backup | ✓ | -| Initialize using Snapshot | ✓ | -| Custom Configuration | ✓ | -| Using Custom docker image | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | +| Features | Availability | +|---------------------------------|:------------:| +| Clustering | ✓ | +| Persistent Volume | ✓ | +| TLS/SSL Encryption | ✓ | +| Custom Configuration | ✓ | +| Using Pod Template | ✓ | +| Using Custom docker image | ✓ | +| Monitoring (Prometheus) | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| Autoscaling | ✓ | +| Reconfigure | ✓ | +| Update Version | ✓ | +| Restart | ✓ | +| Rotate Authentication | ✓ | +| Failover / High Availability | ✓ | +| Custom RBAC | ✓ | ## Life Cycle of a PerconaXtraDB Object diff --git a/docs/guides/pgbouncer/README.md b/docs/guides/pgbouncer/README.md index b64cf5f4bb..cb8c4e0f59 100644 --- a/docs/guides/pgbouncer/README.md +++ b/docs/guides/pgbouncer/README.md @@ -23,27 +23,44 @@ KubeDB operator now comes bundled with PgBouncer crd to handle connection poolin ## PgBouncer Features -| Features | Availability | -|-------------------------------------------------------------| :----------: | -| Multiple PgBouncer Versions | ✓ | -| Custom Configuration | ✓ | -| Externally manageable Auth Secret | ✓ | -| Reconfigurable Health Checker | ✓ | -| Integrate with externally managed PostgreSQL | ✓ | -| Sync Postgres Users to PgBouncer | ✓ | -| Custom docker images | ✓ | -| TLS: Add ( [Cert Manager]((https://cert-manager.io/docs/))) | ✓ | -| Monitoring with Prometheus & Grafana | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| Alert Dashboard | ✓ | -| Grafana Dashboard | ✓ | +| Features | Availability | +|--------------------------------------------------------------------------| :----------: | +| Multiple PgBouncer Versions | ✓ | +| Custom Configuration | ✓ | +| Externally manageable Auth Secret | ✓ | +| Reconfigurable Health Checker | ✓ | +| Integrate with externally managed PostgreSQL | ✓ | +| Sync Postgres Users to PgBouncer | ✓ | +| Custom Docker Images | ✓ | +| TLS/SSL Encryption ([Cert Manager](https://cert-manager.io/docs/)) | ✓ | +| Monitoring (Builtin Prometheus, Prometheus Operator, Grafana Dashboards) | ✓ | +| Update PgBouncer Version | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Autoscaling (Compute Resources) | ✓ | +| Restart | ✓ | +| Rotate Authentication Credentials | ✓ | +| Initialization from Git Repository | ✓ | +| Virtual Secrets | ✓ | +| Private Docker Registry | ✓ | ## User Guide - [Quickstart PgBouncer](/docs/guides/pgbouncer/quickstart/quickstart.md) with KubeDB Operator. +- [Update version](/docs/guides/pgbouncer/update-version/update_version.md) of PgBouncer. +- [Horizontal Scale](/docs/guides/pgbouncer/scaling/horizontal-scaling/horizontal-ops.md) PgBouncer. +- [Vertical Scale](/docs/guides/pgbouncer/scaling/vertical-scaling/vertical-ops.md) PgBouncer. +- [Autoscale](/docs/guides/pgbouncer/autoscaler/compute/compute-autoscale.md) compute resources of PgBouncer. +- [Reconfigure](/docs/guides/pgbouncer/reconfigure/reconfigure-pgbouncer.md) PgBouncer. +- [Configure TLS/SSL](/docs/guides/pgbouncer/tls/configure_ssl.md) for PgBouncer. +- [Reconfigure TLS/SSL](/docs/guides/pgbouncer/reconfigure-tls/reconfigure-tls.md) for PgBouncer. +- [Restart](/docs/guides/pgbouncer/restart/restart.md) PgBouncer. +- [Rotate Authentication Credentials](/docs/guides/pgbouncer/rotateauth/rotateauth.md) of PgBouncer. +- [Sync Users](/docs/guides/pgbouncer/sync-users/sync-users-pgbouncer.md) to PgBouncer at runtime. +- [Initialize PgBouncer from Git Repository](/docs/guides/pgbouncer/initialization/gitsync.md). +- [Use Virtual Secrets](/docs/guides/pgbouncer/virtual_secret/guide.md) for PgBouncer credentials. - Monitor your PgBouncer with KubeDB using [`out-of-the-box` builtin-Prometheus](/docs/guides/pgbouncer/monitoring/using-builtin-prometheus.md). - Monitor your PgBouncer with KubeDB using [`out-of-the-box` Prometheus operator](/docs/guides/pgbouncer/monitoring/using-prometheus-operator.md). - Use [private Docker registry](/docs/guides/pgbouncer/private-registry/using-private-registry.md) to deploy PgBouncer with KubeDB. +- Setup [custom PgBouncer versions](/docs/guides/pgbouncer/custom-versions/setup.md) with KubeDB. - Detail concepts of [PgBouncer object](/docs/guides/pgbouncer/concepts/pgbouncer.md). - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/pgpool/README.md b/docs/guides/pgpool/README.md index 453b514f2d..cfeb41397e 100644 --- a/docs/guides/pgpool/README.md +++ b/docs/guides/pgpool/README.md @@ -23,21 +23,28 @@ KubeDB operator now comes bundled with Pgpool crd to manage all the essential fe ## Supported Pgpool Features -| Features | Availability | -|-------------------------------------------------------------|:------------:| -| Multiple Pgpool Versions | ✓ | -| Custom Configuration | ✓ | -| Externally manageable Auth Secret | ✓ | -| Reconfigurable Health Checker | ✓ | -| Integrate with externally managed PostgreSQL | ✓ | -| Sync Postgres Users to Pgpool | ✓ | -| Custom docker images | ✓ | -| TLS: Add ( [Cert Manager]((https://cert-manager.io/docs/))) | ✓ | -| Monitoring with Prometheus & Grafana | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| Alert Dashboard | ✓ | -| Grafana Dashboard | ✓ | +| Features | Availability | +|---------------------------------------------------------------------------|:------------:| +| Multiple Pgpool Versions | ✓ | +| Custom Configuration | ✓ | +| Custom PodTemplate | ✓ | +| Externally manageable Auth Secret | ✓ | +| Reconfigurable Health Checker | ✓ | +| Integrate with externally managed PostgreSQL | ✓ | +| Sync Postgres Users to Pgpool | ✓ | +| Custom Docker Images | ✓ | +| Custom RBAC | ✓ | +| Initialization via Git Repository | ✓ | +| Virtual Secret Support | ✓ | +| TLS/SSL Encryption ([Cert Manager](https://cert-manager.io/docs/)) | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Autoscaling (Compute) | ✓ | +| Reconfigure | ✓ | +| Update Version | ✓ | +| Restart | ✓ | +| Rotate Authentication | ✓ | +| Monitoring (Builtin Prometheus & Prometheus Operator) | ✓ | +| Grafana & Alert Dashboards | ✓ | ## Supported Pgpool Versions diff --git a/docs/guides/postgres/README.md b/docs/guides/postgres/README.md index 3f15fda673..6a4aba6102 100644 --- a/docs/guides/postgres/README.md +++ b/docs/guides/postgres/README.md @@ -17,25 +17,36 @@ aliases: ## Supported PostgreSQL Features -| Features | Availability | -|------------------------------------|:------------:| -| Clustering | ✓ | -| Warm Standby | ✓ | -| Hot Standby | ✓ | -| Synchronous Replication | ✓ | -| Streaming Replication | ✓ | -| Automatic Failover | ✓ | -| Continuous Archiving using `wal-g` | ✓ | -| Initialization from WAL archive | ✓ | -| Persistent Volume | ✓ | -| Instant Backup | ✓ | -| Scheduled Backup | ✓ | -| Initialization from Snapshot | ✓ | -| Initialization using Script | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| Custom Configuration | ✓ | -| Using Custom docker image | ✓ | +| Features | Availability | +|------------------------------------------------------------|:------------:| +| HA Clustering (Warm/Hot Standby, Automatic Failover) | ✓ | +| Synchronous Replication | ✓ | +| Streaming Replication | ✓ | +| Arbiter Node Support | ✓ | +| Remote Replica | ✓ | +| Distributed Cluster (Multi-Cluster) | ✓ | +| Continuous Archiving using `wal-g` | ✓ | +| Point-in-Time Recovery (PITR) | ✓ | +| Initialization from WAL archive | ✓ | +| Persistent Volume | ✓ | +| Backup & Recovery (Instant, Scheduled, Auto-Backup) | ✓ | +| Initialization (Script / Snapshot) | ✓ | +| Monitoring (Prometheus) | ✓ | +| TLS/SSL Encryption | ✓ | +| Custom & Auto Configuration Tuning (pgtune) | ✓ | +| Reconfigure Database Parameters | ✓ | +| Version Upgrade | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| StorageClass Migration | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Restart | ✓ | +| Rotate Authentication | ✓ | +| Virtual Secrets | ✓ | +| GitOps | ✓ | +| Custom RBAC | ✓ | +| Custom Docker Image & Private Registry | ✓ | +| Failure and Disaster Recovery | ✓ | ## Life Cycle of a PostgreSQL Object diff --git a/docs/guides/proxysql/README.md b/docs/guides/proxysql/README.md index d554d46342..f62c38f97d 100644 --- a/docs/guides/proxysql/README.md +++ b/docs/guides/proxysql/README.md @@ -17,31 +17,35 @@ aliases: ## Supported ProxySQL Features -| Features | Availability | -|--------------------------------------|:------------:| -| Load balance MySQL Group Replication | ✓ | -| Load balance PerconaXtraDB Cluster | ✓ | -| Custom Configuration | ✓ | -| Declarative Configuration | ✓ | -| Version Update | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| ProxySQL server cluster | ✓ | -| ProxySQL server failure recovery | ✓ | -| TLS secured connection for backend | ✓ | -| TLS secured connection for frontend | ✓ | +| Features | Availability | +|-------------------------------------------------------------------|:------------:| +| Load Balancing (MySQL Group Replication, PerconaXtraDB, MariaDB) | ✓ | +| Custom & Declarative Configuration | ✓ | +| Version Update | ✓ | +| Monitoring (Prometheus) | ✓ | +| Clustering & Failure Recovery | ✓ | +| TLS/SSL Encryption (Frontend & Backend, Reconfigure) | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Autoscaling (Compute) | ✓ | +| Custom RBAC Resources | ✓ | +| Restart | ✓ | ## User Guide - [Overview of KubeDB ProxySQL CRD](/docs/guides/proxysql/concepts/proxysql/index.md) - [Configure KubeDB ProxySQL for MySQL Group Replication](/docs/guides/proxysql/quickstart/mysqlgrp/index.md) +- [Configure KubeDB ProxySQL for PerconaXtraDB Cluster (External)](/docs/guides/proxysql/quickstart/xtradbext/index.md) +- [Configure KubeDB ProxySQL for MariaDB Galera Cluster](/docs/guides/proxysql/backends/mariadb-galera/index.md) - [Deploy ProxySQL cluster with KubeDB](/docs/guides/proxysql/clustering/proxysql-cluster/index.md) - [Initialize KubeDB ProxySQL with declarative configuration](/docs/guides/proxysql/concepts/declarative-configuration/index.md) -- [Reconfigure KubeDB ProxySQL with ops-request](/docs/guides/proxysql/concepts/opsrequest/index.md) +- [Reconfigure KubeDB ProxySQL with ops-request](/docs/guides/proxysql/reconfigure/cluster/index.md) - [Deploy TLS/SSL secured KubeDB ProxySQL](/docs/guides/proxysql/tls/configure/index.md) - [Reconfigure TLS/SSL for KubeDB ProxySQL](/docs/guides/proxysql/reconfigure-tls/cluster/index.md) - [Detail concepts of ProxySQLVersion CRD](/docs/guides/proxysql/concepts/proxysql-version/index.md) - [Update KubeDB ProxySQL version with ops-request](/docs/guides/proxysql/update-version/cluster/index.md) -- [Scale horizontally and vertically KubeDB ProxySQL with ops-request](/docs/guides/proxysql/scaling/horizontal-scaling/cluster/index.md) +- [Horizontal Scale KubeDB ProxySQL with ops-request](/docs/guides/proxysql/scaling/horizontal-scaling/cluster/index.md) +- [Vertical Scale KubeDB ProxySQL with ops-request](/docs/guides/proxysql/scaling/vertical-scaling/cluster/index.md) - [Learn auto-scaling for KubeDB ProxySQL](/docs/guides/proxysql/autoscaler/compute/cluster/index.md) +- [Run ProxySQL with Custom RBAC resources](/docs/guides/proxysql/custom-rbac/index.md) +- [Restart KubeDB ProxySQL with ops-request](/docs/guides/proxysql/restart/index.md) - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/qdrant/README.md b/docs/guides/qdrant/README.md index 1ce6a6cb5c..e116f309c3 100644 --- a/docs/guides/qdrant/README.md +++ b/docs/guides/qdrant/README.md @@ -21,20 +21,26 @@ Qdrant is a high-performance open-source vector database designed for similarity ## Supported Qdrant Features -| Features | Availability | -|--------------------------|:------------:| -| Standalone provisioning | ✓ | -| Distributed provisioning | ✓ | -| TLS | ✓ | -| Logical Backup | ✓ | -| Volume Snapshot | ✓ | -| Monitoring | ✓ | -| Ops Requests | ✓ | -| Autoscaler | ✓ | - -## Supported Microsoft SQL Server Versions - -KubeDB supports the following Microsoft SQL Server Version. +| Features | Availability | +|-------------------------------|:------------:| +| Standalone Provisioning | ✓ | +| Distributed Provisioning | ✓ | +| Custom Configuration | ✓ | +| TLS/SSL Encryption | ✓ | +| Backup & Recovery | ✓ | +| Monitoring (Prometheus) | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| Reconfigure | ✓ | +| Update Version | ✓ | +| Restart | ✓ | +| Rotate Authentication | ✓ | +| Autoscaling | ✓ | +| StorageClass Migration | ✓ | + +## Supported Qdrant Versions + +KubeDB supports the following Qdrant versions. - `1.15.4` - `1.16.2` - `1.17.0` @@ -50,5 +56,20 @@ KubeDB supports the following Microsoft SQL Server Version. - [Quickstart Qdrant](/docs/guides/qdrant/quickstart/quickstart.md) with KubeDB operator. - Deploy [Distributed Qdrant](/docs/guides/qdrant/distributed-deployment/overview.md) cluster. +- Configure [Custom Configuration](/docs/guides/qdrant/configuration/using-config-file.md) for Qdrant. +- Configure [TLS/SSL](/docs/guides/qdrant/tls/overview.md) for Qdrant. +- [Backup and Restore](/docs/guides/qdrant/backup/overview/index.md) Qdrant databases using KubeStash. +- [Monitor Qdrant](/docs/guides/qdrant/monitoring/overview.md) with KubeDB. +- [Horizontal Scaling](/docs/guides/qdrant/scaling/horizontal-scaling/overview.md) of Qdrant. +- [Vertical Scaling](/docs/guides/qdrant/scaling/vertical-scaling/overview.md) of Qdrant. +- [Volume Expansion](/docs/guides/qdrant/volume-expansion/overview.md) of Qdrant. +- [Reconfigure](/docs/guides/qdrant/reconfigure/overview.md) Qdrant. +- [Reconfigure TLS](/docs/guides/qdrant/reconfigure-tls/overview.md) for Qdrant. +- [Update Version](/docs/guides/qdrant/update-version/overview.md) of Qdrant. +- [Restart](/docs/guides/qdrant/restart/restart.md) Qdrant. +- [Rotate Authentication](/docs/guides/qdrant/rotate-auth/overview.md) credentials for Qdrant. +- [Compute Autoscaling](/docs/guides/qdrant/autoscaler/compute/overview.md) for Qdrant. +- [Storage Autoscaling](/docs/guides/qdrant/autoscaler/storage/overview.md) for Qdrant. +- [StorageClass Migration](/docs/guides/qdrant/migration/storageMigration.md) for Qdrant. - Detail concepts of [Qdrant Object](/docs/guides/qdrant/concepts/). - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). diff --git a/docs/guides/rabbitmq/README.md b/docs/guides/rabbitmq/README.md index 5e1754e8ac..2c7b669802 100644 --- a/docs/guides/rabbitmq/README.md +++ b/docs/guides/rabbitmq/README.md @@ -20,26 +20,24 @@ RabbitMQ is a robust and flexible open-source message broker software that facil ## Supported RabbitMQ Features -| Features | Availability | -|---------------------------------------------------------------|:------------:| -| Clustering | ✓ | -| Custom Configuration | ✓ | -| Custom Plugin configurations | ✓ | -| Monitoring using Prometheus and Grafana | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Operator managed Prometheus Discovery | ✓ | -| Authentication & Authorization (TLS) | ✓ | -| Externally manageable Auth Secret | ✓ | -| Persistent volume | ✓ | -| Grafana Dashboards (Alerts and Monitoring) | ✓ | -| Pre-Enabled Dashboard ( Management UI ) | ✓ | -| Pre-Enabled utility plugins ( Shovel, Federation ) | ✓ | -| Pre-Enabled Protocols with web dispatch ( AMQP, MQTT, STOMP ) | ✓ | -| Automated Vertical & Horizontal Scaling | ✓ | -| Automated Volume Expansion | ✓ | -| Autoscaling ( Compute resources & Storage ) | ✓ | -| Reconfigurable Health Checker | ✓ | -| Reconfigurable TLS Certificates (Add, Remove, Rotate, Update) | ✓ | +| Features | Availability | +|-----------------------------------------------------------------|:------------:| +| Clustering | ✓ | +| Custom Configuration (Config File, PodTemplate, Plugins) | ✓ | +| Monitoring with Prometheus & Grafana (Builtin & Operator) | ✓ | +| Authentication & Authorization (Managed Auth Secret, Rotation) | ✓ | +| TLS/SSL Encryption (Configure & Reconfigure) | ✓ | +| Persistent Volume | ✓ | +| Pre-Enabled Dashboard (Management UI) | ✓ | +| Pre-Enabled Utility Plugins (Shovel, Federation) | ✓ | +| Pre-Enabled Protocols via Web Dispatch (AMQP, MQTT, STOMP) | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Reconfigure Cluster | ✓ | +| Reconfigurable Health Checker | ✓ | +| Version Update | ✓ | +| Rolling Restart | ✓ | ## Supported RabbitMQ Versions @@ -61,4 +59,19 @@ ref : https://cacoo.com/diagrams/4PxSEzhFdNJRIbIb/0281B ## User Guide - [Quickstart RabbitMQ](/docs/guides/rabbitmq/quickstart/quickstart.md) with KubeDB Operator. +- [Run RabbitMQ with Custom Configuration](/docs/guides/rabbitmq/configuration/using-config-file.md) +- [Run RabbitMQ with Custom PodTemplate](/docs/guides/rabbitmq/configuration/using-podtemplate.md) +- [Monitor RabbitMQ with Builtin Prometheus](/docs/guides/rabbitmq/monitoring/using-builtin-prometheus.md) +- [Monitor RabbitMQ with Prometheus Operator](/docs/guides/rabbitmq/monitoring/using-prometheus-operator.md) +- [Configure TLS/SSL for RabbitMQ](/docs/guides/rabbitmq/tls/tls.md) +- [Reconfigure RabbitMQ TLS/SSL Encryption](/docs/guides/rabbitmq/reconfigure-tls/reconfigure-tls.md) +- [Reconfigure RabbitMQ Cluster](/docs/guides/rabbitmq/reconfigure/reconfigure.md) +- [Horizontal Scale RabbitMQ](/docs/guides/rabbitmq/scaling/horizontal-scaling/horizontal-scaling.md) +- [Vertical Scale RabbitMQ](/docs/guides/rabbitmq/scaling/vertical-scaling/vertical-scaling.md) +- [Expand Volume of RabbitMQ](/docs/guides/rabbitmq/volume-expansion/volume-expansion.md) +- [Autoscale RabbitMQ Compute Resources](/docs/guides/rabbitmq/autoscaler/compute/compute-autoscale.md) +- [Autoscale RabbitMQ Storage](/docs/guides/rabbitmq/autoscaler/storage/storage-autoscale.md) +- [Update RabbitMQ Version](/docs/guides/rabbitmq/update-version/update-version.md) +- [Restart RabbitMQ](/docs/guides/rabbitmq/restart/restart.md) +- [Rotate RabbitMQ Authentication Credentials](/docs/guides/rabbitmq/rotate-auth/guide.md) - Want to hack on KubeDB? Check our [contribution guidelines](/docs/CONTRIBUTING.md). \ No newline at end of file diff --git a/docs/guides/redis/README.md b/docs/guides/redis/README.md index 22f67d259a..5db7b13d6d 100644 --- a/docs/guides/redis/README.md +++ b/docs/guides/redis/README.md @@ -16,31 +16,33 @@ aliases: > New to KubeDB? Please start [here](/docs/README.md). ## Supported Redis Features -| Features | Availability | -|-------------------------------------------------------------------|:------------:| -| Clustering (Sharding, Replication) | ✓ | -| Redis in Sentinel Mode (Use separate Sentinel Cluster for Redis) | ✓ | -| Standalone Mode | ✓ | -| External Client Connection | ✓ | -| Custom Configuration | ✓ | -| Using Custom Docker Image | ✓ | -| Initialization From Script (shell or lua script) | ✓ | -| Initializing from Snapshot ([KubeStash](https://kubestash.com/)) | ✓ | -| Authentication & Authorization | ✓ | -| Externally manageable Authentication Secret | ✓ | -| Persistent Volume | ✓ | -| Reconfigurable Health Checker | ✓ | -| Backup (Instant, Scheduled) | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus Operator | ✓ | -| Automated Version Update | ✓ | -| Automatic Vertical Scaling, Volume Expansion | ✓ | -| Automated Horizontal Scaling | ✓ | -| Automated db-configure Reconfiguration | ✓ | -| TLS configuration ([Cert Manager](https://cert-manager.io/docs/)) | ✓ | -| Reconfiguration of TLS: Add, Remove, Update, Rotate | ✓ | -| Autoscaling Compute and Storage Resources (vertically) | ✓ | -| Grafana Dashboards | ✓ | +| Features | Availability | +|-----------------------------------------------------------------------------------|:------------:| +| Clustering (Sharding, Replication) | ✓ | +| Redis in Sentinel Mode (Use separate Sentinel Cluster for Redis) | ✓ | +| Standalone Mode | ✓ | +| External Client Connection | ✓ | +| Custom Configuration | ✓ | +| Using Custom Docker Image | ✓ | +| Initialization (Script & Git Sync) | ✓ | +| Initializing from Snapshot ([KubeStash](https://kubestash.com/)) | ✓ | +| Authentication & Credential Management (Auth, External Secret, Rotate Credential) | ✓ | +| Access Control Lists (ACL) | ✓ | +| Virtual Secrets (External Secret Management) | ✓ | +| Persistent Volume | ✓ | +| Reconfigurable Health Checker | ✓ | +| Backup (Instant, Scheduled) | ✓ | +| Monitoring (Prometheus — Builtin & Operator) | ✓ | +| Grafana Dashboards | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| Automated db-configure Reconfiguration | ✓ | +| TLS/SSL Encryption ([Cert Manager](https://cert-manager.io/docs/)) | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Custom RBAC Resources | ✓ | +| Restart via OpsRequest | ✓ | +| GitOps | ✓ | `Note`: If you want to use `Valkey` you need to install KubeDB version greater than or equal to `v2025.4.30` diff --git a/docs/guides/singlestore/README.md b/docs/guides/singlestore/README.md index 9518f4926f..2496ebde27 100644 --- a/docs/guides/singlestore/README.md +++ b/docs/guides/singlestore/README.md @@ -20,22 +20,25 @@ SingleStore, a distributed SQL database for real-time analytics, transactional w ## Supported SingleStore Features -| Features | Availability | -|----------------------------------------------------------------------------|:------------:| -| Clustering | ✓ | -| Authentication & Authorization | ✓ | -| Initialize using Script (\*.sql, \*sql.gz and/or \*.sh) | ✓ | -| Backup/Recovery: Instant, Scheduled ( [KubeStash](https://kubestash.com/)) | ✓ | -| Custom Configuration | ✓ | -| Initializing from Snapshot ( [KubeStash](https://kubestash.com/)) | ✓ | -| TLS: Add ( [Cert Manager]((https://cert-manager.io/docs/))) | ✓ | -| Monitoring with Prometheus & Grafana | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | -| Externally manageable Auth Secret | ✓ | -| Reconfigurable Health Checker | ✓ | -| Persistent volume | ✓ | -| SingleStore Studio (UI) | ✓ | +| Features | Availability | +|--------------------------------------------------------------------------------------------------|:------------:| +| Clustering | ✓ | +| Authentication & Authorization | ✓ | +| Externally Manageable Auth Secret | ✓ | +| Initialize using Script (\*.sql, \*sql.gz and/or \*.sh) | ✓ | +| Backup & Recovery (Instant, Scheduled, Restore from Snapshot via [KubeStash](https://kubestash.com/)) | ✓ | +| Custom Configuration | ✓ | +| Reconfigure | ✓ | +| TLS/SSL Encryption (Add, Rotate, Update, Remove via [Cert Manager](https://cert-manager.io/docs/)) | ✓ | +| Monitoring with Prometheus (Builtin & Operator) & Grafana | ✓ | +| Reconfigurable Health Checker | ✓ | +| Persistent Volume | ✓ | +| SingleStore Studio (UI) | ✓ | +| Horizontal & Vertical Scaling | ✓ | +| Volume Expansion | ✓ | +| Version Update | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Restart | ✓ | ## Supported SingleStore Versions diff --git a/docs/guides/solr/README.md b/docs/guides/solr/README.md index 3216aeb272..fdf70b1bf8 100644 --- a/docs/guides/solr/README.md +++ b/docs/guides/solr/README.md @@ -23,26 +23,22 @@ Solr is an open-source, Java-based, information retrieval library with support f | Features | Availability | |------------------------------------------------------------------------------------|:------------:| | Clustering | ✓ | -| Customized Docker Image | ✓ | -| Authentication & Autorization | ✓ | +| Authentication & Authorization | ✓ | | Reconfigurable Health Checker | ✓ | -| Custom Configuration | ✓ | -| Grafana Dashboards | ✓ | +| Custom Configuration | ✓ | +| Custom PodTemplate | ✓ | | Externally manageable Auth Secret | ✓ | +| Rotate Authentication | ✓ | | Persistent Volume | ✓ | -| Monitoring with Prometheus & Grafana | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Alert Dashboard | ✓ | -| Using Prometheus operator | ✓ | -| Dashboard ( Solr UI ) | ✓ | +| Monitoring (Prometheus & Grafana) | ✓ | | Automated Version Update | ✓ | -| Automatic Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | +| Horizontal & Vertical Scaling | ✓ | | Automated db-configure Reconfiguration | ✓ | | TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | -| Automated Reprovision | ✓ | | Automated Volume Expansion | ✓ | -| Autoscaling (vertically) | ✓ | +| Autoscaling (Compute & Storage) | ✓ | +| Failover and Disaster Recovery | ✓ | +| Restart | ✓ | ## Life Cycle of a Solr Object diff --git a/docs/guides/zookeeper/README.md b/docs/guides/zookeeper/README.md index 16d087f674..d23f3cc291 100644 --- a/docs/guides/zookeeper/README.md +++ b/docs/guides/zookeeper/README.md @@ -18,23 +18,19 @@ aliases: ## Supported ZooKeeper Features | Features | Availability | |------------------------------------------------------------------------------------|:------------:| -| Ensemble | ✓ | -| Standalone | ✓ | -| Authentication & Autorization | ✓ | -| Custom Configuration | ✓ | -| Grafana Dashboards | ✓ | +| Ensemble & Standalone Modes | ✓ | +| Authentication & Authorization | ✓ | | Externally manageable Auth Secret | ✓ | +| Custom Configuration | ✓ | | Reconfigurable Health Checker | ✓ | -| TLS: Add, Remove, Update, Rotate ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | -| Automated Version update | ✓ | -| Automatic Vertical Scaling | ✓ | -| Automated Horizontal Scaling | ✓ | +| TLS/SSL Encryption ( [Cert Manager](https://cert-manager.io/docs/) ) | ✓ | +| Automated Version Update | ✓ | +| Horizontal & Vertical Scaling | ✓ | | Automated Volume Expansion | ✓ | -| Backup/Recovery: Instant, Scheduled ([KubeStash](https://kubestash.com/)) | ✓ | +| Backup & Recovery: Instant, Scheduled ([KubeStash](https://kubestash.com/)) | ✓ | | Persistent Volume | ✓ | -| Initializing from Snapshot ( [Stash](https://stash.run/) ) | ✓ | -| Builtin Prometheus Discovery | ✓ | -| Using Prometheus operator | ✓ | +| Monitoring (Prometheus: Builtin & Operator) | ✓ | +| Restart | ✓ | ## Life Cycle of a ZooKeeper Object