Add opensearch engine details (#868)

Co-authored-by: Rahul Bhardwaj <[email protected]>

specification/resources/databases/models/database_cluster.yml

@@ -20,10 +20,11 @@ properties:
       - redis
       - mongodb
       - kafka
+      - opensearch
     description: >-
       A slug representing the database engine used for the cluster. The possible values
       are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB,
-      and "kafka" for Kafka.
+      "kafka" for Kafka and "opensearch" for Opensearch.
   version:
     type: string
     example: '8'
@@ -92,6 +93,12 @@ properties:
     description: >-
       An array of strings containing the names of databases created in the
       database cluster.
+  ui_connection:
+    allOf:
+    - $ref: './opensearch_connection.yml'
+    - readOnly: true
+    description: >-
+     The connection details for OpenSearch dashboard. 
   connection:
     allOf:
     - $ref: './database_connection.yml'

specification/resources/databases/models/opensearch_connection.yml

@@ -0,0 +1,34 @@
+type: object
+
+properties:
+  uri:
+    type: string
+    description: >-
+     This is provided as a convenience and should be able to be constructed by the other attributes.
+    example: opensearch://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require
+    readOnly: true
+  host:
+    type: string
+    description: The FQDN pointing to the opensearch cluster's current primary node.
+    example: backend-do-user-19081923-0.db.ondigitalocean.com
+    readOnly: true
+  port:
+    type: integer
+    description: The port on which the opensearch dashboard is listening.
+    example: 25060
+    readOnly: true
+  user:
+    type: string
+    description: The default user for the opensearch dashboard.
+    example: doadmin
+    readOnly: true
+  password:
+    type: string
+    description: The randomly generated password for the default user.
+    example: wv78n3zpz42xezdk
+    readOnly: true
+  ssl:
+    type: boolean
+    description: A boolean value indicating if the connection should be made over SSL.
+    example: true
+    readOnly: true

specification/resources/databases/models/options.yml

@@ -6,39 +6,46 @@ properties:
     properties:
       kafka:
         allOf:
-        - $ref: './database_region_options.yml'
-        - $ref: './database_version_options.yml'
-        - $ref: './database_layout_options.yml'
+          - $ref: "./database_region_options.yml"
+          - $ref: "./database_version_options.yml"
+          - $ref: "./database_layout_options.yml"
       mongodb:
         allOf:
-        - $ref: './database_region_options.yml'
-        - $ref: './database_version_options.yml'
-        - $ref: './database_layout_options.yml'
+          - $ref: "./database_region_options.yml"
+          - $ref: "./database_version_options.yml"
+          - $ref: "./database_layout_options.yml"
       pg:
         allOf:
-          - $ref: './database_region_options.yml'
-          - $ref: './database_version_options.yml'
-          - $ref: './database_layout_options.yml'
+          - $ref: "./database_region_options.yml"
+          - $ref: "./database_version_options.yml"
+          - $ref: "./database_layout_options.yml"
       mysql:
         allOf:
-          - $ref: './database_region_options.yml'
-          - $ref: './database_version_options.yml'
-          - $ref: './database_layout_options.yml'
+          - $ref: "./database_region_options.yml"
+          - $ref: "./database_version_options.yml"
+          - $ref: "./database_layout_options.yml"
       redis:
         allOf:
-          - $ref: './database_region_options.yml'
-          - $ref: './database_version_options.yml'
-          - $ref: './database_layout_options.yml'
+          - $ref: "./database_region_options.yml"
+          - $ref: "./database_version_options.yml"
+          - $ref: "./database_layout_options.yml"
+      opensearch:
+        allOf:
+          - $ref: "./database_region_options.yml"
+          - $ref: "./database_version_options.yml"
+          - $ref: "./database_layout_options.yml"
   version_availability:
     type: object
     properties:
       kafka:
-        $ref: './database_version_availabilities.yml'
+        $ref: "./database_version_availabilities.yml"
       pg:
-        $ref: './database_version_availabilities.yml'
+        $ref: "./database_version_availabilities.yml"
       mysql:
-        $ref: './database_version_availabilities.yml'
+        $ref: "./database_version_availabilities.yml"
       redis:
-        $ref: './database_version_availabilities.yml'
+        $ref: "./database_version_availabilities.yml"
       mongodb:
-        $ref: './database_version_availabilities.yml'
+        $ref: "./database_version_availabilities.yml"
+      opensearch:
+        $ref: "./database_version_availabilities.yml"

specification/resources/databases/responses/options.yml

@@ -365,6 +365,45 @@ content:
                 - m-16vcpu-128gb
                 - m-24vcpu-192gb
                 - m-32vcpu-256gb
+        opensearch:
+          regions:
+            - ams3
+            - blr1
+            - fra1
+            - lon1
+            - nyc1
+            - nyc3
+            - sfo2
+            - sfo3
+            - sgp1
+            - syd1
+            - tor1
+          versions:
+            - '1'
+            - '2'
+          layouts:
+            - num_nodes: 1
+              sizes:
+                - db-s-2vcpu-4gb
+                - db-s-4vcpu-8gb
+            - num_nodes: 3
+              sizes:
+                - db-s-2vcpu-4gb
+                - db-s-4vcpu-8gb
+                - m3-2vcpu-16gb
+                - m3-4vcpu-32gb
+            - num_nodes: 6
+              sizes:
+                - m3-2vcpu-16gb
+                - m3-4vcpu-32gb
+            - num_nodes: 9
+              sizes:
+                - m3-2vcpu-16gb
+                - m3-4vcpu-32gb
+            - num_nodes: 15
+              sizes:
+                - m3-2vcpu-16gb
+                - m3-4vcpu-32gb
       version_availability:
         kafka:
           - end_of_life: '2024-05-13T00:00:00Z'
@@ -387,6 +426,13 @@ content:
           - end_of_life: null
             end_of_availability: null
             version: '8'
+        opensearch:
+          - end_of_life: null
+            end_of_availability: null
+            version: '1'
+          - end_of_life: null
+            end_of_availability: null
+            version: '2' 
         pg:
           - end_of_life: '2024-11-14T00:00:00Z'
             end_of_availability: '2024-05-14T00:00:00Z'