APPS-8790 - Add support for specifying a DigitalOcean DBaaS OpenSearc…

…h cluster as a log forwarding destination. (#883) * Correct endpoint format. * Add support for specifying a DigitalOcean DBaaS OpenSearch cluster as a log forwarding destination. * Correct endpoint examples. * Update OpenSearch log forwarding destination example
digitalocean · Jun 20, 2024 · e3f71e8 · e3f71e8
1 parent f14abcb
commit e3f71e8
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git a/specification/resources/apps/examples/python/apps_update.yml b/specification/resources/apps/examples/python/apps_update.yml
@@ -81,7 +81,7 @@ source: |-
                         "token": "abcdefghijklmnopqrstuvwxyz0123456789"
                     },
                    "open_search": {
-                        "endpoint": "myopensearchendpoint.com:9300"
+                        "endpoint": "https://myopensearchendpoint.com:9300"
                         "index_name": "logs"
                         "basic_auth": {
                             "user": "doadmin",
@@ -134,7 +134,7 @@ source: |-
                         "token": "abcdefghijklmnopqrstuvwxyz0123456789"
                     },
                    "open_search": {
-                        "endpoint": "myopensearchendpoint.com:9300"
+                        "endpoint": "https://myopensearchendpoint.com:9300"
                         "index_name": "logs"
                         "basic_auth": {
                             "user": "doadmin",

diff --git a/specification/resources/apps/models/app_log_destination_open_search_spec.yml b/specification/resources/apps/models/app_log_destination_open_search_spec.yml
@@ -2,8 +2,9 @@ type: object
 properties:
   endpoint:
     type: string
-    description: >-
-      OpenSearch API Endpoint. Only HTTPS is supported. Format: `https://<host>:<port>`.
+    description: |-
+      OpenSearch API Endpoint. Only HTTPS is supported. Format: https://<host>:<port>.
+      Cannot be specified if `cluster_name` is also specified.
     example: "https://example.com:9300"
   basic_auth:
     $ref: app_log_destination_open_search_spec_basic_auth.yml
@@ -14,6 +15,10 @@ properties:
       The index name to use for the logs. If not set, the default index name
       is "logs".
     example: logs
+  cluster_name:
+    type: string
+    description: |-
+      The name of a DigitalOcean DBaaS OpenSearch cluster to use as a log forwarding destination.
+      Cannot be specified if `endpoint` is also specified.
+    example: my-opensearch-cluster
 description: OpenSearch configuration.
-required:
-  - endpoint
diff --git a/specification/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml b/specification/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml
@@ -2,13 +2,13 @@ type: object
 properties:
   user:
     type: string
-    description: Username to authenticate with.
+    description: |-
+      Username to authenticate with. Only required when `endpoint` is set.
+      Defaults to `doadmin` when `cluster_name` is set.
     example: apps_user
   password:
-    type: string
-    description: Password for user defined in User.
+    description: |-
+      Password for user defined in User. Is required when `endpoint` is set.
+      Cannot be set if using a DigitalOcean DBaaS OpenSearch cluster.
     example: password1
 description: Configure Username and/or Password for Basic authentication.
-required:
-  - user
-  - password