diff --git a/docs/platform/guides/database-management/create-database.md b/docs/platform/guides/database-management/create-database.md deleted file mode 100644 index 758d890..0000000 --- a/docs/platform/guides/database-management/create-database.md +++ /dev/null @@ -1,247 +0,0 @@ ---- -layout: docs -menu: - docsplatform_{{.version}}: - identifier: database-management-create - name: Creating a Database - parent: database-management - weight: 10 -menu_name: docsplatform_{{.version}} -section_menu_id: guides ---- - - -# Creating a Database - -Creating a database is a multi-step wizard: select a database engine, set a name and namespace, configure topology and resources, and enable optional features like monitoring, TLS, and backups. - ---- - -## 1. Getting Started - -Navigate to the **Datastore** section in the left sidebar. The **Datastore Overview** page lists all existing database instances across your connected engines. - -To create a new database, click the green **+ Create New Instance** button in the top-right corner of the page. - -![Datastore Overview page showing existing database instances and the Create New Instance button](../images/db-create/overview-create.png) - ---- - -## 2. Select a Database Type - -You will be presented with a grid of all supported database engines. Click on the engine you want to provision. - -![Database type selection grid showing all supported engines including MongoDB, PostgreSQL, MySQL, Redis, and more](../images/db-create/db-type-select.png) - -> **Tip:** Supported engines include relational, document, key-value, search, and time-series databases. - ---- - -## 3. Choose Namespace and Name - -After selecting the database type, you will be prompted to choose a namespace and provide a name for the new instance. - -![Choose Namespace and Name step showing Select Namespace dropdown and Name field](../images/db-create/name-namespace-select.png) - -1. **Select Namespace:** Choose the Kubernetes namespace where the database will be deployed. If the namespace has resource quotas, available CPU and memory will be shown to help you stay within limits. -1. **Name:** Enter a unique name for the database instance. The name must start with a lowercase letter and can contain letters, numbers, or dashes. - -Click **Next** to proceed to the configuration step. - -> **Note:** Both fields are required (marked with a red asterisk). The name cannot be changed after creation. - ---- - -## 4. Configure the Database - -The main configuration page shows all settings for the new database. At the top, the namespace and name you chose are displayed as a breadcrumb (e.g., `demo / mongo-test`). - -![Create MongoDB configuration page showing Database Version, Database Mode cards, Machine Profile, Storage Class, Advanced Configuration, and Additional Options](../images/db-create/create-overview-page.png) - -### 4.1 - Database Version - -Select the database engine version from the **Database Version** dropdown. The version determines engine features, compatibility, and runtime behaviour. - -### 4.2 - Database Mode - -Select the topology for your database under **Database Mode**. Three modes are available: - -- **Standalone** — A single-node database without high availability or sharding. Best for development or low-traffic workloads. -- **Replicated Cluster** — A MongoDB ReplicaSet for high availability. -- **Sharded Cluster** — A fully sharded MongoDB cluster for high performance and high availability. - -#### Replicated Cluster - -When **Replicated Cluster** is selected, two additional fields appear: - -![Replicated Cluster mode selected showing Replicaset Name (rs0) and Replicaset Number (3) fields](../images/db-create/replicaset-mode.png) - -| Field | Description | -|---|---| -| **Replicaset Name** | The name for the replica set (e.g., `rs0`). Required. | -| **Replicaset Number** | The number of replica members (e.g., `3`). Required. | -| **mongodb+srv style DNS** | Toggle on to enable `mongodb+srv` connection string support for this replica set. | - -#### Sharded Cluster - -When **Sharded Cluster** is selected, three subsections appear — **Shard Nodes**, **Config Server**, and **Mongos** — each configurable independently. - -![Sharded Cluster mode selected showing Shard Nodes, Config Server, and Mongos collapsible panels](../images/db-create/shard-mode.png) - -**Shard Nodes** — Configure how MongoDB data is partitioned, replicated, and resourced across your cluster. - -![Shard Nodes panel showing Shards, Replicaset Number, Storage size, Machine, CPU, and Memory fields](../images/db-create/shard-nodes.png) - -| Field | Description | -|---|---| -| **Shards** | Number of shard partitions (e.g., `2`). Required. | -| **Replicaset Number** | Number of replicas per shard (e.g., `3`). Required. | -| **Storage size** | Disk size per shard node (e.g., `2Gi`). Required. | -| **Machine** | Preset machine profile or `custom` for manual CPU/memory. | -| **CPU** | CPU request per shard node (e.g., `900m`). | -| **Memory** | Memory request per shard node (e.g., `1Gi`). | - -**Config Server** — Stores metadata about the sharded cluster including chunk distribution and shard configuration. Must run as a replica set. - -![Config Server panel showing Replicaset Number, Storage size, Machine, CPU, and Memory fields](../images/db-create/config-server.png) - -| Field | Description | -|---|---| -| **Replicaset Number** | Number of config server replicas (e.g., `3`). Required. | -| **Storage size** | Disk size per config server node (e.g., `2Gi`). Required. | -| **Machine** | Preset machine profile or `custom`. | -| **CPU** | CPU request (e.g., `800m`). | -| **Memory** | Memory request (e.g., `1Gi`). | - -**Mongos** — Acts as the query router for the sharded cluster, directing client requests to the appropriate shards based on metadata from Config Servers. - -![Mongos panel showing Replicaset number, Machine, CPU, and Memory fields](../images/db-create/mongos-mode.png) - -| Field | Description | -|---|---| -| **Replicaset number** | Number of Mongos router instances (e.g., `2`). Required. | -| **Machine** | Preset machine profile or `custom`. | -| **CPU** | CPU request (e.g., `500m`). | -| **Memory** | Memory request (e.g., `1Gi`). | - -### 4.3 - Machine Profile - -The **Machine Profile** dropdown lets you select a preset CPU and memory configuration for your database nodes. Choose `custom` to enter specific CPU and memory values manually. - -![Machine Profile dropdown showing preset options alongside the Storage Class and Advanced Configuration panels](../images/db-create/machine-profile.png) - -> **Tip:** Preset profiles are named by size (e.g., `db.t4large`). Use `custom` when your workload requires resources that do not match any preset. - -### 4.4 - Storage Class and Size - -Select the Kubernetes **Storage Class** that will back the database persistent volumes, and enter the required **Storage size**. - -![Storage Class dropdown showing local-path, longhorn, and longhorn-static options, alongside the Storage size field set to 2Gi](../images/db-create/storage-class.png) - -| Field | Description | -|---|---| -| **Storage Class** | The Kubernetes StorageClass for persistent volumes (e.g., `longhorn`). Required. | -| **Storage size** | The disk capacity to allocate per node (e.g., `2Gi`). Required. | - ---- - -## 5. Advanced Configuration - -Expand the **Advanced Configuration** panel (labelled *Configure Credentials, Deployment Mode etc.*) to access additional settings. - -### 5.1 - Labels & Annotations - -Add custom Kubernetes labels and annotations to the database resources. - -![Advanced Configuration panel showing Labels and Annotations sections each with Key-Value input rows and Add new buttons](../images/db-create/advance-lavel-annotation.png) - -- Use **+ Add new** under **Labels** to attach key-value label pairs. -- Use **+ Add new** under **Annotations** to attach key-value annotation pairs. -- Use the delete icon on any row to remove it. - -### 5.2 - Deletion Policy - -The **Deletion Policy** dropdown controls what happens to the database resources when the database object is deleted from Kubernetes. - -![Deletion Policy dropdown showing Delete, Halt, WipeOut, and DoNotTerminate options](../images/db-create/deletion-policy.png) - -| Option | Behaviour | -|---|---| -| **Delete** | Deletes the database pods and services but retains the PersistentVolumeClaims. | -| **Halt** | Stops the database without deleting any resources. Can be resumed later. | -| **WipeOut** | Deletes all resources including PersistentVolumeClaims. All data is permanently removed. | -| **DoNotTerminate** | Prevents deletion — the database cannot be removed until this policy is changed. | - -> **Warning:** **WipeOut** permanently destroys all data. Ensure you have a valid backup before selecting this policy. - -### 5.3 - Authentication Credentials - -Configure how the database root credentials are managed. - -![Authentication Credentials section showing Provide Authentication Credentials toggle, Refer existing Secret toggle, Secret dropdown, Password field, Configure Database toggle, and Configuration textarea](../images/db-create/auth-creds.png) - -| Field | Description | -|---|---| -| **Provide Authentication Credentials** | Toggle on to supply custom credentials instead of auto-generating them. | -| **Refer existing Secret** | Toggle on to reference an existing Kubernetes Secret for credentials. Select the secret from the dropdown. | -| **Password** | Manually enter a password if not using an existing Secret. | -| **Configure Database** | Toggle on to provide a custom database configuration. Enter the configuration in the **Configuration** textarea (required when enabled). | - -### 5.4 - Point in-time Recovery - -Enable **Point in-time Recovery** to restore the new database from a previous backup to an exact timestamp. - -![Point in-time Recovery toggle and form showing Namespace, Name, and Recovery Timestamp fields](../images/db-create/point-in-time-recovery.png) - -1. **Namespace:** The namespace where the source backup resides. Required. -1. **Name:** The name of the source database to recover from. Required. -1. **Recovery Timestamp:** The exact date and time to restore to (`mm/dd/yyyy, hh:mm`). Required. - -> **Note:** All three fields are required when Point in-time Recovery is enabled. Leaving any field empty will show an "Error in fields" warning. - ---- - -## 6. Additional Options - -Expand the **Additional Options** panel (labelled *Enable Backup, Monitoring, TLS etc.*) to enable integrated platform features for the new database. - -![Additional Options panel showing Enable Monitoring with Alert Options, Enable Backup, Enable TLS with Cluster Issuers, and Expose via Gateway toggles](../images/db-create/Additional-option.png) - -| Option | Description | -|---|---| -| **Enable Monitoring** | Enables Prometheus metrics collection. Select an **Alert Options** level (`critical`, `warning`, `info`) to control which alerts are fired. | -| **Enable Backup** | Registers the database with the backup system so scheduled backups can be configured after creation. | -| **Enable TLS** | Enables TLS encryption. Select a **Cluster Issuer** from the dropdown (e.g., `ace-incluster`) to sign the certificates. | -| **Expose via Gateway** | Toggles external access through the configured gateway endpoint. | - ---- - -## 7. Deploy - -Once all required fields are filled and options are configured, click the green **Deploy** button at the bottom-right of the form to create the database. - -> **Note:** Required fields are marked with a red asterisk. The **Deploy** button will be active only when all required fields are valid. If any field has an error, a validation summary will appear above the button. - ---- - -## Quick Reference - -| Action | Where / How | -|---|---| -| Start creating a database | **Datastore Overview** → **+ Create New Instance** | -| Select database engine | Click the desired engine from the type grid | -| Set namespace and name | **Choose Namespace and Name** step → fill both fields → **Next** | -| Use a single node | **Database Mode** → **Standalone** | -| Create a replica set | **Database Mode** → **Replicated Cluster** → set Replicaset Name and Number | -| Create a sharded cluster | **Database Mode** → **Sharded Cluster** → configure Shard Nodes, Config Server, Mongos | -| Set CPU and memory | **Machine Profile** → select preset or choose `custom` | -| Set storage | **Storage Class** → select class → set **Storage size** | -| Add labels or annotations | **Advanced Configuration** → **Labels & Annotations** → **+ Add new** | -| Control deletion behaviour | **Advanced Configuration** → **Deletion Policy** → select option | -| Provide custom credentials | **Advanced Configuration** → toggle **Provide Authentication Credentials** | -| Restore to a point in time | **Advanced Configuration** → toggle **Point in-time Recovery** → fill Namespace, Name, Timestamp | -| Enable monitoring | **Additional Options** → toggle **Enable Monitoring** → set Alert Options | -| Enable backup at creation | **Additional Options** → toggle **Enable Backup** | -| Enable TLS at creation | **Additional Options** → toggle **Enable TLS** → select Cluster Issuer | -| Expose via gateway | **Additional Options** → toggle **Expose via Gateway** | -| Apply and create | Click **Deploy** | diff --git a/docs/platform/guides/database-management/create-database/_index.md b/docs/platform/guides/database-management/create-database/_index.md new file mode 100644 index 0000000..404803b --- /dev/null +++ b/docs/platform/guides/database-management/create-database/_index.md @@ -0,0 +1,74 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create + name: Creating a Database + parent: database-management + weight: 10 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + +# Creating a Database + +Creating a database is a multi-step wizard: select a database engine, set a name and +namespace, configure topology and resources, and enable optional features like +monitoring, TLS, and backups. + +The overall flow is the same for every engine and is documented once in +[**Common Steps**](common-steps.md). Where it differs is the **Database Mode** (topology) +and a handful of engine-specific settings — pick your engine below for a guide tailored to +it, then follow the common steps for everything else. + +--- + +## Supported Engines + +### Relational +- [PostgreSQL](postgres.md) +- [MySQL](mysql.md) +- [MariaDB](mariadb.md) +- [Percona XtraDB](perconaxtradb.md) +- [Microsoft SQL Server](mssqlserver.md) +- [Oracle](oracle.md) +- [SingleStore](singlestore.md) +- [IBM Db2](db2.md) +- [SAP HANA](hanadb.md) + +### Document & Search +- [MongoDB](mongodb.md) +- [Elasticsearch](elasticsearch.md) +- [Solr](solr.md) +- [DocumentDB](documentdb.md) + +### Key-Value & Cache +- [Redis](redis.md) +- [Memcached](memcached.md) +- [Ignite](ignite.md) +- [Hazelcast](hazelcast.md) + +### Vector +- [Qdrant](qdrant.md) +- [Milvus](milvus.md) +- [Weaviate](weaviate.md) + +### Wide-column & Time-series +- [Cassandra](cassandra.md) +- [ClickHouse](clickhouse.md) +- [Druid](druid.md) + +### Streaming & Messaging +- [Kafka](kafka.md) +- [RabbitMQ](rabbitmq.md) + +### Graph +- [Neo4j](neo4j.md) + +### Coordination +- [ZooKeeper](zookeeper.md) + +### Connection Poolers & Proxies +- [PgBouncer](pgbouncer.md) +- [Pgpool](pgpool.md) +- [ProxySQL](proxysql.md) diff --git a/docs/platform/guides/database-management/create-database/cassandra.md b/docs/platform/guides/database-management/create-database/cassandra.md new file mode 100644 index 0000000..5c039cd --- /dev/null +++ b/docs/platform/guides/database-management/create-database/cassandra.md @@ -0,0 +1,40 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-cassandra + name: Cassandra + parent: database-management-create + weight: 210 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Cassandra Database + +This page covers the configuration specific to **Cassandra** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Standalone** — A single-node Cassandra instance for development or testing. +- **Topology** — A multi-node Cassandra cluster, optionally organized into named **Racks** for rack-aware replication. + +![Topology mode selected showing Racks configuration](../images/db-create/cassandra/topology-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of Cassandra nodes (e.g., `3`). Required. | +| **Racks** | Optional list of rack names to spread nodes across for fault tolerance. | + +## Create a Cassandra Database + +1. Open the wizard and select **Cassandra** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/clickhouse.md b/docs/platform/guides/database-management/create-database/clickhouse.md new file mode 100644 index 0000000..0c772d5 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/clickhouse.md @@ -0,0 +1,44 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-clickhouse + name: ClickHouse + parent: database-management-create + weight: 220 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a ClickHouse Database + +This page covers the configuration specific to **ClickHouse** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Standalone** — A single-node ClickHouse instance. +- **Topology** — A distributed ClickHouse cluster with sharding/replication, coordinated by ClickHouse Keeper. + +![Topology mode selected showing Cluster and ClickHouse Keeper configuration](../images/db-create/clickhouse/topology-mode.png) + +**Cluster** + +| Field | Description | +|---|---| +| **Shards** | Number of shard partitions. Required. | +| **Replicas** | Number of replicas per shard. Required. | + +**ClickHouse Keeper** — Provides coordination/metadata for the cluster (the ClickHouse-native alternative to ZooKeeper). Configure its node count and resources. + +## Create a ClickHouse Database + +1. Open the wizard and select **ClickHouse** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/common-steps.md b/docs/platform/guides/database-management/create-database/common-steps.md new file mode 100644 index 0000000..c9275ca --- /dev/null +++ b/docs/platform/guides/database-management/create-database/common-steps.md @@ -0,0 +1,189 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-common + name: Common Steps + parent: database-management-create + weight: 5 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Common Steps for Creating a Database + +These steps are the same for every database engine. Each engine's own page covers only +the engine-specific **Database Mode**; everything else — opening the wizard, naming, +versions, resources, and optional features — is described here. + +> Start on your engine's page (e.g. [PostgreSQL](postgres.md), [Redis](redis.md)) for the +> Database Mode, and refer back to this page for the surrounding steps. + +--- + +## 1. Getting Started + +Navigate to the **Datastore** section in the left sidebar. The **Datastore Overview** page lists all existing database instances across your connected engines. + +To create a new database, click the green **+ Create New Instance** button in the top-right corner of the page. + +![Datastore Overview page showing existing database instances and the Create New Instance button](../images/db-create/shared/overview-create.png) + +--- + +## 2. Select a Database Type + +You will be presented with a grid of all supported database engines. Click the engine you want to provision. + +![Database type selection grid showing all supported engines](../images/db-create/shared/db-type-select.png) + +> **Tip:** Supported engines include relational, document, key-value, search, vector, and time-series databases. + +--- + +## 3. Choose Namespace and Name + +After selecting the database type, choose a namespace and provide a name for the new instance. + +![Choose Namespace and Name step showing Select Namespace dropdown and Name field](../images/db-create/shared/name-namespace-select.png) + +1. **Select Namespace:** The Kubernetes namespace where the database will be deployed. If the namespace has resource quotas, available CPU and memory are shown. +1. **Name:** A unique name that starts with a lowercase letter and contains only letters, numbers, or dashes. + +Click **Next** to proceed to the configuration step. + +> **Note:** Both fields are required. The name cannot be changed after creation. + +--- + +## 4. Configure the Database + +The configuration page shows all settings for the new database, with the chosen namespace and name displayed as a breadcrumb (e.g., `demo / mongo-test`). + +### 4.1 - Database Version + +Select the engine version from the **Database Version** dropdown. The version determines engine features, compatibility, and runtime behaviour. + +### 4.2 - Database Mode + +The available topologies depend on the engine. See your engine's page for its **Database Mode** options and fields — for example [MongoDB](mongodb.md) (Standalone / Replicaset / Sharded) or [PostgreSQL](postgres.md) (Standalone / Cluster / RemoteReplica). + +### 4.3 - Machine Profile + +The **Machine Profile** dropdown selects a preset CPU and memory configuration for your database nodes. Choose `custom` to enter CPU and memory values manually. + +![Machine Profile dropdown alongside the Storage Class and Advanced Configuration panels](../images/db-create/shared/machine-profile.png) + +> **Tip:** Preset profiles are named by size (e.g., `db.t4large`). Use `custom` when your workload requires resources that do not match any preset. + +### 4.4 - Storage Class and Size + +Select the Kubernetes **Storage Class** that backs the persistent volumes and enter the required **Storage size**. + +![Storage Class dropdown and Storage size field](../images/db-create/shared/storage-class.png) + +| Field | Description | +|---|---| +| **Storage Class** | The Kubernetes StorageClass for persistent volumes (e.g., `longhorn`). Required. | +| **Storage size** | The disk capacity per node (e.g., `2Gi`). Required. | + +--- + +## 5. Advanced Configuration + +Expand the **Advanced Configuration** panel (*Configure Credentials, Deployment Mode etc.*) for additional settings. + +### 5.1 - Labels & Annotations + +Add custom Kubernetes labels and annotations to the database resources. + +![Labels and Annotations sections each with Key-Value input rows and Add new buttons](../images/db-create/shared/advance-lavel-annotation.png) + +- Use **+ Add new** under **Labels** / **Annotations** to attach key-value pairs. +- Use the delete icon on any row to remove it. + +### 5.2 - Deletion Policy + +The **Deletion Policy** dropdown controls what happens to the resources when the database object is deleted. + +![Deletion Policy dropdown showing Delete, Halt, WipeOut, and DoNotTerminate options](../images/db-create/shared/deletion-policy.png) + +| Option | Behaviour | +|---|---| +| **Delete** | Deletes pods and services but retains the PersistentVolumeClaims. | +| **Halt** | Stops the database without deleting resources. Can be resumed later. | +| **WipeOut** | Deletes all resources including PersistentVolumeClaims. All data is permanently removed. | +| **DoNotTerminate** | Prevents deletion until the policy is changed. | + +> **Warning:** **WipeOut** permanently destroys all data. Ensure you have a valid backup before selecting this policy. + +### 5.3 - Authentication Credentials + +Configure how the database credentials are managed. + +![Authentication Credentials section showing credential toggles, Secret dropdown, Password field, and Configuration textarea](../images/db-create/shared/auth-creds.png) + +| Field | Description | +|---|---| +| **Provide Authentication Credentials** | Toggle on to supply custom credentials instead of auto-generating them. | +| **Refer existing Secret** | Toggle on to reference an existing Kubernetes Secret. Select it from the dropdown. | +| **Password** | Manually enter a password if not using an existing Secret. | +| **Configure Database** | Toggle on to provide a custom database configuration in the **Configuration** textarea. | + +### 5.4 - Point in-time Recovery + +For engines that support continuous archiving (e.g. **PostgreSQL**, **MySQL**), enable **Point in-time Recovery** to restore the new database from a previous backup to an exact timestamp. + +![Point in-time Recovery form showing Namespace, Name, and Recovery Timestamp fields](../images/db-create/shared/point-in-time-recovery.png) + +1. **Namespace:** The namespace where the source backup resides. Required. +1. **Name:** The name of the source database to recover from. Required. +1. **Recovery Timestamp:** The exact date and time to restore to (`mm/dd/yyyy, hh:mm`). Required. + +> **Note:** All three fields are required when Point in-time Recovery is enabled. + +--- + +## 6. Additional Options + +Expand the **Additional Options** panel (*Enable Backup, Monitoring, TLS etc.*) to enable integrated platform features. + +![Additional Options panel showing Monitoring, Backup, TLS, and Gateway toggles](../images/db-create/shared/Additional-option.png) + +| Option | Description | +|---|---| +| **Enable Monitoring** | Enables Prometheus metrics collection. Select an **Alert Options** level (`critical`, `warning`, `info`). | +| **Enable Backup** | Registers the database with the backup system so scheduled backups can be configured after creation. | +| **Enable TLS** | Enables TLS encryption. Select a **Cluster Issuer** from the dropdown (e.g., `ace-incluster`). | +| **Expose via Gateway** | Toggles external access through the configured gateway endpoint. | + +--- + +## 7. Deploy + +Once all required fields are filled and options are configured, click the green **Deploy** button at the bottom-right of the form to create the database. + +> **Note:** Required fields are marked with a red asterisk. The **Deploy** button is active only when all required fields are valid. If any field has an error, a validation summary will appear above the button. + +--- + +## Quick Reference + +| Action | Where / How | +|---|---| +| Start creating a database | **Datastore Overview** → **+ Create New Instance** | +| Select database engine | Click the desired engine from the type grid | +| Set namespace and name | **Choose Namespace and Name** → fill both → **Next** | +| Choose topology | **Database Mode** → see your engine's page | +| Set CPU and memory | **Machine Profile** → select preset or `custom` | +| Set storage | **Storage Class** → select class → set **Storage size** | +| Add labels or annotations | **Advanced Configuration** → **Labels & Annotations** → **+ Add new** | +| Control deletion behaviour | **Advanced Configuration** → **Deletion Policy** | +| Provide custom credentials | **Advanced Configuration** → toggle **Provide Authentication Credentials** | +| Restore to a point in time | **Advanced Configuration** → toggle **Point in-time Recovery** | +| Enable monitoring | **Additional Options** → **Enable Monitoring** → set Alert Options | +| Enable backup at creation | **Additional Options** → **Enable Backup** | +| Enable TLS at creation | **Additional Options** → **Enable TLS** → select Cluster Issuer | +| Expose via gateway | **Additional Options** → **Expose via Gateway** | +| Apply and create | Click **Deploy** | diff --git a/docs/platform/guides/database-management/create-database/db2.md b/docs/platform/guides/database-management/create-database/db2.md new file mode 100644 index 0000000..d8f7ce5 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/db2.md @@ -0,0 +1,36 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-db2 + name: IBM Db2 + parent: database-management-create + weight: 90 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a IBM Db2 Database + +This page covers the configuration specific to **IBM Db2** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +IBM Db2 is deployed as a single logical instance. Set the **Number of Replicas** to control how many nodes back the instance for availability. + +![Replicas configuration for IBM Db2](../images/db-create/db2/replicas.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes for the instance (e.g., `1` for a single node, `3` for high availability). | + +## Create a IBM Db2 Database + +1. Open the wizard and select **IBM Db2** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/documentdb.md b/docs/platform/guides/database-management/create-database/documentdb.md new file mode 100644 index 0000000..3e424ee --- /dev/null +++ b/docs/platform/guides/database-management/create-database/documentdb.md @@ -0,0 +1,36 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-documentdb + name: DocumentDB + parent: database-management-create + weight: 130 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a DocumentDB Database + +This page covers the configuration specific to **DocumentDB** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +DocumentDB is deployed as a single logical instance. Set the **Number of Replicas** to control how many nodes back the instance for availability. + +![Replicas configuration for DocumentDB](../images/db-create/documentdb/replicas.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes for the instance (e.g., `1` for a single node, `3` for high availability). | + +## Create a DocumentDB Database + +1. Open the wizard and select **DocumentDB** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/druid.md b/docs/platform/guides/database-management/create-database/druid.md new file mode 100644 index 0000000..e5097c9 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/druid.md @@ -0,0 +1,69 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-druid + name: Druid + parent: database-management-create + weight: 230 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Druid Database + +This page covers the configuration specific to **Druid** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Druid is always deployed as a **Topology** of role-separated process tiers. Configure each tier's node count and resources independently. + +![Druid topology showing Coordinators, Overlords/MiddleManagers, Historicals, and Brokers panels](../images/db-create/druid/topology-mode.png) + +| Node | Description | +|---|---| +| **Coordinators** | Manage data availability, segment balancing, and cluster coordination. | +| **MiddleManagers** | Run ingestion tasks and index new data. | +| **Historicals** | Store and serve queryable historical segments. | +| **Brokers** | Receive queries and route them to the appropriate Historicals/MiddleManagers. | + +Each tier has its own **Number of Replicas**, **Storage size**, **Machine**, **CPU**, and **Memory** fields. Druid also requires dependent metadata storage and deep storage, configured by the platform. + +## Druid Dependencies + +Druid relies on external dependencies for metadata, deep storage, and coordination. Each can be provisioned by the platform or pointed at an existing, externally-managed instance. + +![Druid deep storage, metadata storage, and ZooKeeper configuration](../images/db-create/druid/dependencies.png) + +**Deep Storage** — Durable storage for Druid segments. + +| Field | Description | +|---|---| +| **Type** | Deep storage backend: `s3`, `google`, `azure`, or `hdfs`. | +| **Config Secret** | Secret holding the credentials/configuration for the chosen backend. | + +**Metadata Storage** — Relational database holding Druid metadata. + +| Field | Description | +|---|---| +| **Type** | `MySQL` or `Postgres`. | +| **Externally Managed** | Toggle on to reference an existing database instead of provisioning one. | +| **Namespace / Name** | Reference to the metadata database when externally managed. | + +**ZooKeeper** — Coordination service for the Druid cluster. + +| Field | Description | +|---|---| +| **Externally Managed** | Toggle on to reference an existing ZooKeeper instead of provisioning one. | +| **Namespace / Name** | Reference to the ZooKeeper instance when externally managed. | + +## Create a Druid Database + +1. Open the wizard and select **Druid** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/elasticsearch.md b/docs/platform/guides/database-management/create-database/elasticsearch.md new file mode 100644 index 0000000..8643b14 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/elasticsearch.md @@ -0,0 +1,52 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-elasticsearch + name: Elasticsearch + parent: database-management-create + weight: 110 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Elasticsearch Database + +This page covers the configuration specific to **Elasticsearch** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Combined** — A single pool of nodes that perform all roles (master, data, ingest). Simpler; best for smaller deployments. +- **Topology** — Role-separated nodes split into **Master**, **Data**, and **Ingest** tiers, each scaled and resourced independently. + +![Topology mode selected showing Master, Data, and Ingest node panels](../images/db-create/elasticsearch/topology-mode.png) + +| Node | Description | +|---|---| +| **Master** | Manages cluster state and coordination. | +| **Data** | Stores shards and serves indexing/search traffic. | +| **Ingest** | Pre-processes documents via ingest pipelines before indexing. | + +Each tier has its own **Number of Replicas**, **Storage size**, **Machine**, **CPU**, and **Memory** fields. You may also select the security **Auth Plugin** (e.g., `X-Pack`, `OpenSearch`, `OpenDistro`, `SearchGuard`). + +## Elasticsearch Settings + +![Elasticsearch auth plugin selection](../images/db-create/elasticsearch/settings.png) + +| Field | Description | +|---|---| +| **Auth Plugin** | The security plugin / distribution: `X-Pack`, `OpenSearch`, `OpenDistro`, or `SearchGuard`. Determines the security implementation. | +| **Disable Kernel Defaults** | Skip the default `vm.max_map_count` and related kernel tuning applied via an init container. | + +## Create a Elasticsearch Database + +1. Open the wizard and select **Elasticsearch** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/hanadb.md b/docs/platform/guides/database-management/create-database/hanadb.md new file mode 100644 index 0000000..c6779d5 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/hanadb.md @@ -0,0 +1,43 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-hanadb + name: SAP HANA + parent: database-management-create + weight: 100 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a SAP HANA Database + +This page covers the configuration specific to **SAP HANA** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Standalone** — A single-node SAP HANA instance. +- **SystemReplication** — A HANA System Replication setup with a primary and secondary site for high availability. + +![SystemReplication mode selected showing replication configuration](../images/db-create/hanadb/mode-select.png) + +When **SystemReplication** is selected: + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of HANA nodes. Required. | +| **Replication Mode** | `logreplay`, `delta_datashipping`, or `logreplay_readaccess`. | +| **Operation Mode** | The system replication operation mode. | + +## Create a SAP HANA Database + +1. Open the wizard and select **SAP HANA** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/hazelcast.md b/docs/platform/guides/database-management/create-database/hazelcast.md new file mode 100644 index 0000000..21dca4b --- /dev/null +++ b/docs/platform/guides/database-management/create-database/hazelcast.md @@ -0,0 +1,47 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-hazelcast + name: Hazelcast + parent: database-management-create + weight: 170 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Hazelcast Database + +This page covers the configuration specific to **Hazelcast** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Combined** — A single pool of members forming one Hazelcast cluster. Best for most deployments. +- **Topology** — Role-separated member tiers, each scaled and resourced independently. + +![Topology mode selected showing member node configuration](../images/db-create/hazelcast/topology-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of Hazelcast members in the cluster. Required. | + +## License + +Hazelcast Enterprise features require a license. + +| Field | Description | +|---|---| +| **License Secret** | Name of the Kubernetes Secret containing your Hazelcast license key. | + +## Create a Hazelcast Database + +1. Open the wizard and select **Hazelcast** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/ignite.md b/docs/platform/guides/database-management/create-database/ignite.md new file mode 100644 index 0000000..ddb61fd --- /dev/null +++ b/docs/platform/guides/database-management/create-database/ignite.md @@ -0,0 +1,39 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-ignite + name: Ignite + parent: database-management-create + weight: 160 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Ignite Database + +This page covers the configuration specific to **Ignite** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/ignite/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Create a Ignite Database + +1. Open the wizard and select **Ignite** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/kafka.md b/docs/platform/guides/database-management/create-database/kafka.md new file mode 100644 index 0000000..349d8fa --- /dev/null +++ b/docs/platform/guides/database-management/create-database/kafka.md @@ -0,0 +1,42 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-kafka + name: Kafka + parent: database-management-create + weight: 240 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Kafka Database + +This page covers the configuration specific to **Kafka** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Combined** — Nodes act as both controller and broker. Simpler; best for smaller deployments. +- **Topology** — Role-separated **Controller** and **Broker** node tiers (KRaft), each scaled and resourced independently. + +![Topology mode selected showing Controller and Broker node panels](../images/db-create/kafka/topology-mode.png) + +| Node | Description | +|---|---| +| **Controller** | Manages cluster metadata and the KRaft quorum. | +| **Broker** | Handles produce/consume traffic and stores partition data. | + +Each tier has its own **Number of Replicas**, **Storage size**, **Machine**, **CPU**, and **Memory** fields. + +## Create a Kafka Database + +1. Open the wizard and select **Kafka** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/mariadb.md b/docs/platform/guides/database-management/create-database/mariadb.md new file mode 100644 index 0000000..c04b8ba --- /dev/null +++ b/docs/platform/guides/database-management/create-database/mariadb.md @@ -0,0 +1,39 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-mariadb + name: MariaDB + parent: database-management-create + weight: 40 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a MariaDB Database + +This page covers the configuration specific to **MariaDB** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/mariadb/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Create a MariaDB Database + +1. Open the wizard and select **MariaDB** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/memcached.md b/docs/platform/guides/database-management/create-database/memcached.md new file mode 100644 index 0000000..7bdd2c2 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/memcached.md @@ -0,0 +1,39 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-memcached + name: Memcached + parent: database-management-create + weight: 150 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Memcached Database + +This page covers the configuration specific to **Memcached** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/memcached/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Create a Memcached Database + +1. Open the wizard and select **Memcached** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/milvus.md b/docs/platform/guides/database-management/create-database/milvus.md new file mode 100644 index 0000000..39c2532 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/milvus.md @@ -0,0 +1,67 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-milvus + name: Milvus + parent: database-management-create + weight: 190 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Milvus Database + +This page covers the configuration specific to **Milvus** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Standalone** — A single-node Milvus instance. +- **Distributed** — A multi-node Milvus deployment with separated components for scale and availability. + +![Distributed mode selected showing component configuration](../images/db-create/milvus/mode-select.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes/components in the distributed deployment. Required for Distributed. | + +## Milvus Dependencies & Settings + +Milvus depends on a metadata store (etcd) and object storage, and exposes a few instance-level toggles. + +![Milvus meta storage and object storage configuration](../images/db-create/milvus/dependencies.png) + +**Meta Storage (etcd)** + +| Field | Description | +|---|---| +| **Externally Managed** | Toggle on to use an existing etcd instead of provisioning one. | +| **Endpoints** | etcd endpoints to connect to when externally managed. | +| **Size** | Number of etcd nodes when provisioned by the platform. | + +**Object Storage** + +| Field | Description | +|---|---| +| **Config Secret Name** | Secret holding the object storage (e.g. S3/MinIO) configuration. | + +**Other Settings** + +| Field | Description | +|---|---| +| **Disable Security** | Run without authentication (development only). | +| **Halted** | Create the instance in a halted (stopped) state. | +| **Configuration Secret / Inline** | Provide engine configuration via a referenced Secret or inline key-value pairs. | + +## Create a Milvus Database + +1. Open the wizard and select **Milvus** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/mongodb.md b/docs/platform/guides/database-management/create-database/mongodb.md new file mode 100644 index 0000000..e804700 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/mongodb.md @@ -0,0 +1,98 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-mongodb + name: MongoDB + parent: database-management-create + weight: 10 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a MongoDB Database + +This page covers the configuration specific to **MongoDB** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Three modes are available: + +- **Standalone** — A single-node database without high availability or sharding. Best for development or low-traffic workloads. +- **Replicated Cluster** — A MongoDB ReplicaSet for high availability. +- **Sharded Cluster** — A fully sharded MongoDB cluster for high performance and high availability. + +#### Replicated Cluster + +When **Replicated Cluster** is selected, two additional fields appear: + +![Replicated Cluster mode selected showing Replicaset Name (rs0) and Replicaset Number (3) fields](../images/db-create/mongodb/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Replicaset Name** | The name for the replica set (e.g., `rs0`). Required. | +| **Replicaset Number** | The number of replica members (e.g., `3`). Required. | +| **mongodb+srv style DNS** | Toggle on to enable `mongodb+srv` connection string support for this replica set. | + +#### Sharded Cluster + +When **Sharded Cluster** is selected, three subsections appear — **Shard Nodes**, **Config Server**, and **Mongos** — each configurable independently. + +![Sharded Cluster mode selected showing Shard Nodes, Config Server, and Mongos collapsible panels](../images/db-create/mongodb/shard-mode.png) + +**Shard Nodes** — Configure how MongoDB data is partitioned, replicated, and resourced across your cluster. + +![Shard Nodes panel showing Shards, Replicaset Number, Storage size, Machine, CPU, and Memory fields](../images/db-create/mongodb/shard-nodes.png) + +| Field | Description | +|---|---| +| **Shards** | Number of shard partitions (e.g., `2`). Required. | +| **Replicaset Number** | Number of replicas per shard (e.g., `3`). Required. | +| **Storage size** | Disk size per shard node (e.g., `2Gi`). Required. | +| **Machine** | Preset machine profile or `custom` for manual CPU/memory. | +| **CPU** | CPU request per shard node (e.g., `900m`). | +| **Memory** | Memory request per shard node (e.g., `1Gi`). | + +**Config Server** — Stores metadata about the sharded cluster including chunk distribution and shard configuration. Must run as a replica set. + +![Config Server panel showing Replicaset Number, Storage size, Machine, CPU, and Memory fields](../images/db-create/mongodb/config-server.png) + +| Field | Description | +|---|---| +| **Replicaset Number** | Number of config server replicas (e.g., `3`). Required. | +| **Storage size** | Disk size per config server node (e.g., `2Gi`). Required. | +| **Machine** | Preset machine profile or `custom`. | +| **CPU** | CPU request (e.g., `800m`). | +| **Memory** | Memory request (e.g., `1Gi`). | + +**Mongos** — Acts as the query router for the sharded cluster, directing client requests to the appropriate shards based on metadata from Config Servers. + +![Mongos panel showing Replicaset number, Machine, CPU, and Memory fields](../images/db-create/mongodb/mongos-mode.png) + +| Field | Description | +|---|---| +| **Replicaset number** | Number of Mongos router instances (e.g., `2`). Required. | +| **Machine** | Preset machine profile or `custom`. | +| **CPU** | CPU request (e.g., `500m`). | +| **Memory** | Memory request (e.g., `1Gi`). | + +## Additional MongoDB Options + +![MongoDB arbiter and hidden node options](../images/db-create/mongodb/extra-options.png) + +| Field | Description | +|---|---| +| **Arbiter** | Toggle on to add an arbiter member (votes in elections but stores no data). Configure its pod resources. | +| **Hidden Node** | Toggle on to add hidden replica members (replicate data but are invisible to clients). Set **Replicas**, resources, and storage. | +| **HostName / IP** | Optional host name and IP used to build the connection string and certificate SANs. | + +## Create a MongoDB Database + +1. Open the wizard and select **MongoDB** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/mssqlserver.md b/docs/platform/guides/database-management/create-database/mssqlserver.md new file mode 100644 index 0000000..ca7de48 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/mssqlserver.md @@ -0,0 +1,54 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-mssqlserver + name: Microsoft SQL Server + parent: database-management-create + weight: 60 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Microsoft SQL Server Database + +This page covers the configuration specific to **Microsoft SQL Server** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Standalone** — A single-node SQL Server instance. +- **Topology** — A high-availability deployment using an **Availability Group**. + +![Topology mode selected showing Availability Group configuration](../images/db-create/mssqlserver/topology-mode.png) + +**Availability Group** + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of replicas participating in the availability group (e.g., `3`). Required. | + +## SQL Server Settings + +Microsoft SQL Server requires you to accept the licensing terms and choose a product edition. + +![SQL Server license acceptance and PID edition fields](../images/db-create/mssqlserver/settings.png) + +| Field | Description | +|---|---| +| **Accept EULA** | You must accept the SQL Server End-User License Agreement before the database can be deployed. Required. | +| **PID (Edition)** | The SQL Server product edition: `Developer`, `Express`, `Standard`, `Evaluation`, `Enterprise`, `EnterpriseCore`, or `Custom`. | + +When **Topology** mode is used, you may also list the **Databases** to include in the Availability Group. + +## Create a Microsoft SQL Server Database + +1. Open the wizard and select **Microsoft SQL Server** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/mysql.md b/docs/platform/guides/database-management/create-database/mysql.md new file mode 100644 index 0000000..1df5cb8 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/mysql.md @@ -0,0 +1,45 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-mysql + name: MySQL + parent: database-management-create + weight: 30 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a MySQL Database + +This page covers the configuration specific to **MySQL** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Available modes: + +- **Standalone** — A single-node MySQL instance. +- **GroupReplication** — A MySQL Group Replication cluster. Choose a group **Mode**: `Single-Primary` or `Multi-Primary`. +- **InnoDBCluster** — A MySQL InnoDB Cluster fronted by MySQL Router. Choose `Single-Primary` or `Multi-Primary`. +- **SemiSync** — A semi-synchronous replication topology with configurable acknowledgement. +- **RemoteReplica** — A replica that streams from an external/primary MySQL. + +![Mode options showing GroupReplication, InnoDBCluster, SemiSync, and RemoteReplica](../images/db-create/mysql/mode-select.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for clustered modes. | +| **Mode** (Group/InnoDB) | `Single-Primary` or `Multi-Primary`. | +| **SemiSync** | `Source Wait For Replica Count`, `Source Timeout`, and `Errant Transaction Recovery Policy` (`Clone` or `PseudoTransaction`). | +| **Router** (InnoDB) | MySQL Router instance count and resources. | + +## Create a MySQL Database + +1. Open the wizard and select **MySQL** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/neo4j.md b/docs/platform/guides/database-management/create-database/neo4j.md new file mode 100644 index 0000000..8f1ca7f --- /dev/null +++ b/docs/platform/guides/database-management/create-database/neo4j.md @@ -0,0 +1,49 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-neo4j + name: Neo4j + parent: database-management-create + weight: 260 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Neo4j Database + +This page covers the configuration specific to **Neo4j** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/neo4j/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Neo4j Settings + +![Neo4j storage type, security, and TLS options](../images/db-create/neo4j/settings.png) + +| Field | Description | +|---|---| +| **Storage Type** | `Durable` (persistent volumes) or `Ephemeral` (no persistence). | +| **Disable Security** | Run without authentication (development only). | +| **TLS** | Configure TLS per protocol — **Bolt**, **HTTP**, and **Cluster** — each signed by the selected **Issuer**. | + +## Create a Neo4j Database + +1. Open the wizard and select **Neo4j** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/oracle.md b/docs/platform/guides/database-management/create-database/oracle.md new file mode 100644 index 0000000..c0a238e --- /dev/null +++ b/docs/platform/guides/database-management/create-database/oracle.md @@ -0,0 +1,45 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-oracle + name: Oracle + parent: database-management-create + weight: 70 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Oracle Database + +This page covers the configuration specific to **Oracle** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Standalone** — A single-node Oracle instance. +- **DataGuard** — An Oracle Data Guard configuration with a primary and standby database for disaster recovery. + +![DataGuard mode selected showing Protection Mode, Sync Mode, and Standby Type](../images/db-create/oracle/mode-select.png) + +When **DataGuard** is selected: + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of database nodes. Required. | +| **Protection Mode** | `MaximumAvailability`, `MaximumPerformance`, or `MaximumProtection`. | +| **Sync Mode** | `SYNC` or `ASYNC` redo transport. | +| **Standby Type** | `PHYSICAL` or `LOGICAL` standby. | +| **Apply Lag Threshold** | Optional threshold for the observer to act on apply lag. | + +## Create a Oracle Database + +1. Open the wizard and select **Oracle** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/perconaxtradb.md b/docs/platform/guides/database-management/create-database/perconaxtradb.md new file mode 100644 index 0000000..d374e86 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/perconaxtradb.md @@ -0,0 +1,36 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-perconaxtradb + name: Percona XtraDB + parent: database-management-create + weight: 50 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Percona XtraDB Database + +This page covers the configuration specific to **Percona XtraDB** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Percona XtraDB is deployed as a single logical instance. Set the **Number of Replicas** to control how many nodes back the instance for availability. + +![Replicas configuration for Percona XtraDB](../images/db-create/perconaxtradb/replicas.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes for the instance (e.g., `1` for a single node, `3` for high availability). | + +## Create a Percona XtraDB Database + +1. Open the wizard and select **Percona XtraDB** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/pgbouncer.md b/docs/platform/guides/database-management/create-database/pgbouncer.md new file mode 100644 index 0000000..a5b18bc --- /dev/null +++ b/docs/platform/guides/database-management/create-database/pgbouncer.md @@ -0,0 +1,49 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-pgbouncer + name: PgBouncer + parent: database-management-create + weight: 280 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a PgBouncer Database + +This page covers the configuration specific to **PgBouncer** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/pgbouncer/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Backend Database + +PgBouncer pools connections to a backend PostgreSQL database. + +| Field | Description | +|---|---| +| **Database Ref (Namespace / Name)** | Reference to the backend PostgreSQL instance to pool connections for. | +| **Database Name** | The database name PgBouncer exposes to clients. | +| **Sync Users** | Toggle on to synchronize users from the backend PostgreSQL. | + +## Create a PgBouncer Database + +1. Open the wizard and select **PgBouncer** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/pgpool.md b/docs/platform/guides/database-management/create-database/pgpool.md new file mode 100644 index 0000000..b1f5f66 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/pgpool.md @@ -0,0 +1,48 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-pgpool + name: Pgpool + parent: database-management-create + weight: 290 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Pgpool Database + +This page covers the configuration specific to **Pgpool** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/pgpool/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Backend Database + +Pgpool sits in front of a PostgreSQL instance for connection pooling and load balancing. + +| Field | Description | +|---|---| +| **Postgres Ref (Namespace / Name)** | Reference to the backend PostgreSQL instance. Required. | +| **Sync Users** | Toggle on to synchronize users from the backend PostgreSQL. | + +## Create a Pgpool Database + +1. Open the wizard and select **Pgpool** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/postgres.md b/docs/platform/guides/database-management/create-database/postgres.md new file mode 100644 index 0000000..5461c13 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/postgres.md @@ -0,0 +1,44 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-postgres + name: PostgreSQL + parent: database-management-create + weight: 20 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a PostgreSQL Database + +This page covers the configuration specific to **PostgreSQL** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Three modes are available: + +- **Standalone** — A single-node PostgreSQL instance. +- **Cluster** — A primary with one or more streaming replicas for high availability. Set the **Number of Replicas**. +- **RemoteReplica** — A replica that streams from an external/primary PostgreSQL for cross-cluster replication. + +![Cluster mode selected showing Number of Replicas, Standby Mode, and Streaming Mode](../images/db-create/postgres/mode-select.png) + +When **Cluster** is selected, configure replication behaviour: + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of standby replicas (e.g., `3`). Required. | +| **Standby Mode** | `Hot` (replicas accept read queries) or `Warm` (replicas stay in standby, no reads). | +| **Streaming Mode** | `Synchronous` (commit waits for replica acknowledgement) or `Asynchronous` (commit does not wait). | + +## Create a PostgreSQL Database + +1. Open the wizard and select **PostgreSQL** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/proxysql.md b/docs/platform/guides/database-management/create-database/proxysql.md new file mode 100644 index 0000000..a67621b --- /dev/null +++ b/docs/platform/guides/database-management/create-database/proxysql.md @@ -0,0 +1,48 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-proxysql + name: ProxySQL + parent: database-management-create + weight: 300 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a ProxySQL Database + +This page covers the configuration specific to **ProxySQL** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/proxysql/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Backend + +ProxySQL proxies traffic to a backend MySQL-family cluster. + +| Field | Description | +|---|---| +| **Backend** | Reference to the backend database the proxy fronts. | +| **Sync Users** | Toggle on to synchronize users from the backend. | + +## Create a ProxySQL Database + +1. Open the wizard and select **ProxySQL** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/qdrant.md b/docs/platform/guides/database-management/create-database/qdrant.md new file mode 100644 index 0000000..476cfb4 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/qdrant.md @@ -0,0 +1,50 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-qdrant + name: Qdrant + parent: database-management-create + weight: 180 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Qdrant Database + +This page covers the configuration specific to **Qdrant** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Standalone** — A single-node Qdrant instance. +- **Distributed** — A multi-node Qdrant cluster that shards collections across nodes for scale and availability. + +![Distributed mode selected showing the Number of Replicas field](../images/db-create/qdrant/mode-select.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the distributed cluster (e.g., `3`). Required for Distributed. | + +## Qdrant Settings + +![Qdrant storage type, security, and TLS options](../images/db-create/qdrant/settings.png) + +| Field | Description | +|---|---| +| **Storage Type** | `Durable` (persistent volumes) or `Ephemeral` (no persistence). | +| **Disable Security** | Run without API-key authentication (development only). | +| **Halted** | Create the instance in a halted (stopped) state. | +| **TLS** | Enable TLS for **Client** and/or **P2P** (inter-node) traffic, signed by the selected **Issuer**. | + +## Create a Qdrant Database + +1. Open the wizard and select **Qdrant** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/rabbitmq.md b/docs/platform/guides/database-management/create-database/rabbitmq.md new file mode 100644 index 0000000..acef558 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/rabbitmq.md @@ -0,0 +1,39 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-rabbitmq + name: RabbitMQ + parent: database-management-create + weight: 250 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a RabbitMQ Database + +This page covers the configuration specific to **RabbitMQ** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/rabbitmq/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Create a RabbitMQ Database + +1. Open the wizard and select **RabbitMQ** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/redis.md b/docs/platform/guides/database-management/create-database/redis.md new file mode 100644 index 0000000..281f37e --- /dev/null +++ b/docs/platform/guides/database-management/create-database/redis.md @@ -0,0 +1,41 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-redis + name: Redis + parent: database-management-create + weight: 140 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Redis Database + +This page covers the configuration specific to **Redis** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Three modes are available: + +- **Standalone** — A single-node Redis instance. Best for development or low-traffic workloads. +- **Cluster** — A sharded Redis Cluster for horizontal scaling and high availability. +- **Sentinel** — A primary/replica setup monitored by Redis Sentinel for automatic failover. + +![Cluster and Sentinel mode options](../images/db-create/redis/mode-select.png) + +| Mode | Key fields | +|---|---| +| **Cluster** | **Master** count and **Replicas** per master. | +| **Sentinel** | **Number of Replicas** and the referenced **Sentinel** instance. | + +## Create a Redis Database + +1. Open the wizard and select **Redis** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/singlestore.md b/docs/platform/guides/database-management/create-database/singlestore.md new file mode 100644 index 0000000..9cbd595 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/singlestore.md @@ -0,0 +1,57 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-singlestore + name: SingleStore + parent: database-management-create + weight: 80 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a SingleStore Database + +This page covers the configuration specific to **SingleStore** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**: + +- **Standalone** — A single-node SingleStore instance. +- **Topology** — A distributed cluster split into **Aggregator** and **Leaf** node tiers. + +![Topology mode selected showing Aggregator and Leaf node panels](../images/db-create/singlestore/topology-mode.png) + +**Aggregator** — Routes queries and aggregates results. + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of aggregator nodes. Required. | +| **Storage size**, **Machine**, **CPU**, **Memory** | Resources per aggregator node. | + +**Leaf** — Stores and processes the partitioned data. + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of leaf nodes. Required. | +| **Storage size**, **Machine**, **CPU**, **Memory** | Resources per leaf node. | + +## License + +SingleStore is commercial software and requires a license. + +| Field | Description | +|---|---| +| **License Secret** | Name of the Kubernetes Secret containing your SingleStore license key. Required. | + +## Create a SingleStore Database + +1. Open the wizard and select **SingleStore** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/solr.md b/docs/platform/guides/database-management/create-database/solr.md new file mode 100644 index 0000000..c399960 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/solr.md @@ -0,0 +1,52 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-solr + name: Solr + parent: database-management-create + weight: 120 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Solr Database + +This page covers the configuration specific to **Solr** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Three modes are available: + +- **Standalone** — A single-node Solr instance. +- **Replicaset** — A multi-node Solr cluster. Set the **Number of Replicas**. +- **Topology** — A role-separated cluster with dedicated **Overseer**, **Data**, and **Coordinator** node tiers. + +![Topology mode selected showing Overseer, Data, and Coordinator node panels](../images/db-create/solr/topology-mode.png) + +| Node | Description | +|---|---| +| **Overseer** | Cluster-management nodes that handle cluster state and coordination. | +| **Data** | Nodes that host collections/shards and serve indexing and query traffic. | +| **Coordinator** | Query-routing nodes that distribute requests across data nodes. | + +Each tier has its own **Number of Replicas**, **Storage size**, **Machine**, **CPU**, and **Memory** fields. + +## ZooKeeper + +SolrCloud requires ZooKeeper for coordination. + +| Field | Description | +|---|---| +| **ZooKeeper Ref (Namespace / Name)** | Reference to the ZooKeeper instance Solr uses for coordination. | + +## Create a Solr Database + +1. Open the wizard and select **Solr** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/weaviate.md b/docs/platform/guides/database-management/create-database/weaviate.md new file mode 100644 index 0000000..8fc6492 --- /dev/null +++ b/docs/platform/guides/database-management/create-database/weaviate.md @@ -0,0 +1,45 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-weaviate + name: Weaviate + parent: database-management-create + weight: 200 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a Weaviate Database + +This page covers the configuration specific to **Weaviate** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Weaviate is deployed as a single logical instance. Set the **Number of Replicas** to control how many nodes back the instance for availability. + +![Replicas configuration for Weaviate](../images/db-create/weaviate/replicas.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes for the instance (e.g., `1` for a single node, `3` for high availability). | + +> **Note:** Weaviate exposes a **Disable Security** toggle to run without authentication (development only). + +## Weaviate Settings + +| Field | Description | +|---|---| +| **Disable Security** | Run without authentication (development only). | +| **Health Checker** | Tune the health probe: **Period (s)**, **Timeout (s)**, and **Failure Threshold**. | + +## Create a Weaviate Database + +1. Open the wizard and select **Weaviate** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/create-database/zookeeper.md b/docs/platform/guides/database-management/create-database/zookeeper.md new file mode 100644 index 0000000..adc78bc --- /dev/null +++ b/docs/platform/guides/database-management/create-database/zookeeper.md @@ -0,0 +1,39 @@ +--- +layout: docs +menu: + docsplatform_{{.version}}: + identifier: database-management-create-zookeeper + name: ZooKeeper + parent: database-management-create + weight: 270 +menu_name: docsplatform_{{.version}} +section_menu_id: guides +--- + + +# Creating a ZooKeeper Database + +This page covers the configuration specific to **ZooKeeper** — its **Database Mode** and any engine-specific settings shown below. The rest of the creation flow — +opening the wizard, namespace and name, version, machine profile, storage, and optional +features — is the same for every engine and is documented in [Common Steps](common-steps.md). + +## Database Mode + +Select the topology under **Database Mode**. Two modes are available: + +- **Standalone** — A single-node instance. Best for development or low-traffic workloads. +- **Replicaset** — A multi-node cluster for high availability. Set the **Number of Replicas** (e.g., `3`). + +![Replicaset mode selected showing the Number of Replicas field](../images/db-create/zookeeper/replicaset-mode.png) + +| Field | Description | +|---|---| +| **Number of Replicas** | Number of nodes in the cluster (e.g., `3`). Required for Replicaset. | + +## Create a ZooKeeper Database + +1. Open the wizard and select **ZooKeeper** — see [Getting Started](common-steps.md#1-getting-started) and [Select a Database Type](common-steps.md#2-select-a-database-type). +1. Set the [namespace and name](common-steps.md#3-choose-namespace-and-name). +1. Pick the database version and the **Database Mode** described above, then set the machine profile and storage — see [Configure the Database](common-steps.md#4-configure-the-database). +1. Optionally configure [Advanced Configuration](common-steps.md#5-advanced-configuration) (labels, deletion policy, credentials, point-in-time recovery) and [Additional Options](common-steps.md#6-additional-options) (monitoring, backup, TLS, gateway). +1. Click [**Deploy**](common-steps.md#7-deploy). diff --git a/docs/platform/guides/database-management/images/db-create/config-server.png b/docs/platform/guides/database-management/images/db-create/mongodb/config-server.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/config-server.png rename to docs/platform/guides/database-management/images/db-create/mongodb/config-server.png diff --git a/docs/platform/guides/database-management/images/db-create/create-overview-page.png b/docs/platform/guides/database-management/images/db-create/mongodb/create-overview-page.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/create-overview-page.png rename to docs/platform/guides/database-management/images/db-create/mongodb/create-overview-page.png diff --git a/docs/platform/guides/database-management/images/db-create/mongos-mode.png b/docs/platform/guides/database-management/images/db-create/mongodb/mongos-mode.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/mongos-mode.png rename to docs/platform/guides/database-management/images/db-create/mongodb/mongos-mode.png diff --git a/docs/platform/guides/database-management/images/db-create/replicaset-mode.png b/docs/platform/guides/database-management/images/db-create/mongodb/replicaset-mode.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/replicaset-mode.png rename to docs/platform/guides/database-management/images/db-create/mongodb/replicaset-mode.png diff --git a/docs/platform/guides/database-management/images/db-create/shard-mode.png b/docs/platform/guides/database-management/images/db-create/mongodb/shard-mode.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/shard-mode.png rename to docs/platform/guides/database-management/images/db-create/mongodb/shard-mode.png diff --git a/docs/platform/guides/database-management/images/db-create/shard-nodes.png b/docs/platform/guides/database-management/images/db-create/mongodb/shard-nodes.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/shard-nodes.png rename to docs/platform/guides/database-management/images/db-create/mongodb/shard-nodes.png diff --git a/docs/platform/guides/database-management/images/db-create/Additional-option.png b/docs/platform/guides/database-management/images/db-create/shared/Additional-option.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/Additional-option.png rename to docs/platform/guides/database-management/images/db-create/shared/Additional-option.png diff --git a/docs/platform/guides/database-management/images/db-create/advance-lavel-annotation.png b/docs/platform/guides/database-management/images/db-create/shared/advance-lavel-annotation.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/advance-lavel-annotation.png rename to docs/platform/guides/database-management/images/db-create/shared/advance-lavel-annotation.png diff --git a/docs/platform/guides/database-management/images/db-create/auth-creds.png b/docs/platform/guides/database-management/images/db-create/shared/auth-creds.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/auth-creds.png rename to docs/platform/guides/database-management/images/db-create/shared/auth-creds.png diff --git a/docs/platform/guides/database-management/images/db-create/db-type-select.png b/docs/platform/guides/database-management/images/db-create/shared/db-type-select.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/db-type-select.png rename to docs/platform/guides/database-management/images/db-create/shared/db-type-select.png diff --git a/docs/platform/guides/database-management/images/db-create/deletion-policy.png b/docs/platform/guides/database-management/images/db-create/shared/deletion-policy.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/deletion-policy.png rename to docs/platform/guides/database-management/images/db-create/shared/deletion-policy.png diff --git a/docs/platform/guides/database-management/images/db-create/machine-profile.png b/docs/platform/guides/database-management/images/db-create/shared/machine-profile.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/machine-profile.png rename to docs/platform/guides/database-management/images/db-create/shared/machine-profile.png diff --git a/docs/platform/guides/database-management/images/db-create/name-namespace-select.png b/docs/platform/guides/database-management/images/db-create/shared/name-namespace-select.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/name-namespace-select.png rename to docs/platform/guides/database-management/images/db-create/shared/name-namespace-select.png diff --git a/docs/platform/guides/database-management/images/db-create/overview-create.png b/docs/platform/guides/database-management/images/db-create/shared/overview-create.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/overview-create.png rename to docs/platform/guides/database-management/images/db-create/shared/overview-create.png diff --git a/docs/platform/guides/database-management/images/db-create/point-in-time-recovery.png b/docs/platform/guides/database-management/images/db-create/shared/point-in-time-recovery.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/point-in-time-recovery.png rename to docs/platform/guides/database-management/images/db-create/shared/point-in-time-recovery.png diff --git a/docs/platform/guides/database-management/images/db-create/storage-class.png b/docs/platform/guides/database-management/images/db-create/shared/storage-class.png similarity index 100% rename from docs/platform/guides/database-management/images/db-create/storage-class.png rename to docs/platform/guides/database-management/images/db-create/shared/storage-class.png