OpenSearch
OpenSearch is a distributed search and analytics engine for full-text search, log analysis, and observability workloads.
| Property | Value | Notes |
|---|---|---|
| Provider name | opensearch | Use this in landscape provider definitions. |
| Version | v0 | Current schema version exposed by the provider. |
| Category | Search & Analytics | Shown in the managed services catalog. |
| Scope | global | Available at team scope rather than being tied to a single workspace runtime. |
| Team singleton | false | Teams can create multiple OpenSearch service instances. |
| Pause support | false | This provider does not support pausing. |
Closed testing
This provider is currently in an early testing state and is only available on dedicated installations (closed testing). The provider is still evolving, its schema, plans, and behavior may change in the future.
Schema
Config
| Field | Type | Required on create | Notes |
|---|---|---|---|
version | string | No | OpenSearch engine version. Default and only allowed value: 2.19. |
Secrets
| Field | Type | Required on create | Notes |
|---|---|---|---|
superuserPassword | string | Yes | Password for the administrative user. |
Details / Output
| Field | Type | Availability | Notes |
|---|---|---|---|
host | string | Exposed after provisioning | Internal service hostname. |
port | integer | Exposed after provisioning | REST API port. |
dashboardsUrl | string | Exposed after provisioning | URL of the OpenSearch Dashboards endpoint. |
replicas | integer | Exposed after provisioning | Reported number of replicas. |
readyReplicas | integer | Exposed after provisioning | Number of replicas currently ready. |
ready | boolean | Exposed after provisioning | Indicates whether the cluster is ready. |
Plans
The provider exposes multiple plans: Small (id: 0), Medium (id: 1), Large (id: 2), and Extra Large (id: 3).
Example plan: Small (id: 0).
| Parameter | Type | Default | Minimum | Maximum | Static | Notes |
|---|---|---|---|---|---|---|
storage | integer | 5120 | 5120 | - | No | Priced as storage-mib. |
cpu | number | 5 | - | - | No | Priced as cpu-tenths. |
memory | integer | 1024 | 1024 | - | No | Priced as ram-mib. |
replicas | integer | 3 | - | - | Yes | Fixed replica count in the example plan. |
Example in a Landscape
schemaVersion: v0.2
run:
search:
provider:
name: opensearch
version: v0
plan:
id: 0
parameters:
storage: 5120
cpu: 5
memory: 1024
replicas: 3
config:
version: "2.19"
secrets:
superuserPassword: "${{ vault.opensearchSuperuserPassword }}"
Application runtimes can connect over the REST API by using host, port, and the stored superuser credentials, while operational users can open dashboardsUrl for the dashboards interface.
The same endpoint is reachable from other Codesphere runtimes, including reactives, managed containers, and Virtual Cluster workloads.