Component
core/datastore/opensearch
An OpenSearch search and analytics engine. Indexes documents for full-text and analytical queries and indexes embedding vectors beside them, answering similarity searches through its k-NN plugin, so a component that retrieves by similarity can be wired here. Indexes are created through OpenSearch's own API at runtime; the component declares the server, not its contents. It runs as one node. Exports its host, port, protocol, an endpoint joining them and the account a client signs in as. The security plugin stays on with one account, the administrator, whose password is the attached credential. Realized self-hosted by the product's own Helm chart on Kubernetes, fetched at build time, and by a Compose Recipe for local development. Each runs the product's image with no demonstration account or certificate, each node generating its own transport key when it starts; the API is served over plain HTTP, not encrypted, reachable only inside the Release, and with no credential attached the password is a development default. Realized on Amazon OpenSearch Service by terraform/opensearch-service and, in a CloudFormation stack, cloudformation/opensearch-service: each a domain in the operator's AWS account and VPC that serves HTTPS alone on port 443 and answers similarity searches through the service's own k-NN support, and each halts unless core/random-password, with values.symbols true, supplies the password. Reach for them where the engine is the operator's managed AWS service; reach for the self-hosted Recipes on a cluster or a Docker host. The Recipes are verified by their rendered output, not by a started server.
Procedencia
- Digest del contenido
- sha256:eb87045f077ae39210c3844a719977680bd1cf0fb23b1ff237b18c7e2b599551
- Publicado
- 2026-11-10T10:10:59Z
- Identidad de firma
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Firma
- Oficialapplication/vnd.dev.sigstore.bundle.v0.3+json
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
sha256:a1ce0ac66f5099cba15bdcd4c4f9abe79266d649b0a04172e66027a04c4b289d
Referencia en esta versión
oci://hub.aggrega.ai/component/core/datastore/opensearch:1.0.0Parámetros del desarrollador
Valores que el desarrollador establece en el Aggregate.
No se declararon parámetros del desarrollador.
Dimensionamiento del operador
Dimensionamiento de la infraestructura que el operador ajusta para cada entorno.
| Nombre | Tipo | Predeterminado | Obligatorio | Descripción |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 9200 | no | Port the server's REST API is published on. Most operators should omit this and let the Recipe assign the default (9200). The server listens on it on both self-hosted targets; on Kubernetes it is also the Service port. The OpenSearch Service realizations do not read it: the domain serves port 443 alone, and any other value than the default halts there. |
| engine_version | string | 3.9.0@sha256:adfa61f85025d06b4aeb562e7e74fde7e31c437039c93c3862c17e9acebd6c7c | no | Tag of the opensearchproject/opensearch image every Recipe runs, optionally followed by @ and the digest it must resolve to. It begins with the release's version number, which the Kubernetes Recipe reads its major version from. The Recipes configure the server through the settings of the 3.x releases; another release may need other ones. The OpenSearch Service realizations read the major and minor version the value begins with as the domain's engine version, among those Amazon OpenSearch Service offers; the default names a release it does not run, so it halts there and the Release sets one it offers, such as 3.5. |
| source_version | string | — | no | Version of the Helm chart the Kubernetes Recipe pulls. Read only by that Recipe; the Compose Recipe pulls no source artifact and ignores it, terraform/opensearch-service pins its module in its own lock and ignores it too, and cloudformation/opensearch-service, which pulls nothing, ignores it as well. Changing it away from the Recipe's default does not guarantee value-mapping compatibility with the new chart. |
| compute | object | — | no | — |
| storage | object | — | no | — |
| overrides | object (open) | — | no | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Contrato de salida
Valores que este componente publica para los consumidores a través de la topología uses.
| Nombre | Tipo | Predeterminado | Obligatorio | Descripción |
|---|---|---|---|---|
| host | string | — | sí | Address a client connects to. On Kubernetes it is the Service's DNS name, and on Compose the service name; on the OpenSearch Service realizations a pointer string Terraform or CloudFormation resolves to the domain's endpoint, or the DNS name the Release sets in infra.overrides.host instead, so a consumer on another target receives an address it can resolve. That name becomes the domain's custom endpoint, which presents the AWS Certificate Manager certificate the Release names beside it, in infra.overrides.custom_endpoint_certificate_arn on terraform and infra.overrides.CustomEndpointCertificateArn on CloudFormation, so a client checking the certificate reaches the domain by that name; a name without a certificate halts, and so does a certificate without a name. |
| port | integer | — | sí | TCP port the server's REST API answers on. On the self-hosted Recipes it follows the port an operator set in the Release, so a consumer reads it rather than assuming 9200; on the OpenSearch Service realizations it is 443, the one port the domain serves. |
| user | string | — | no | Name of the account a client signs in as — `admin`, the server's one account, which on Amazon OpenSearch Service is the domain's master user. The matching password arrives through the credential attached to the component, never through this contract. |
| protocol | string | — | no | Scheme a client composes the server's address with — `http` on the self-hosted Recipes, as in http://<host>:<port>, where the REST API is served over plain HTTP, and `https` on the OpenSearch Service realizations, whose domain accepts HTTPS alone. A client composing the address from its parts reads this key rather than assuming either. |
| endpoint | string | — | no | The server's address as one URI, for a client that takes one address rather than its parts: http://<host>:<port> on the self-hosted Recipes, and https://<host> on the OpenSearch Service realizations, the scheme's own port 443. It carries no credential. |
Sockets uses
Los sockets de dependencia a través de los cuales se conecta este componente. El destino de cada conexión cableada a través de un socket debe satisfacer su selector de etiquetas, y cada conexión puede llevar un acoplamiento en los slots que declara el socket. Cada conexión que el Aggregate o la Release cablea a través del socket debe llenar los slots obligatorios.
No se declararon sockets uses.
Slots de acoplamiento
Puntos de enlace con nombre en los que una Feature se acopla a este componente. El selector de un slot restringe qué Feature puede llenarlo y su lista inject indica cómo puede entregarse el material de la Feature. Un slot obligatorio debe estar enlazado en cada instancia, mediante un acoplamiento en la instancia o en un ámbito superior, y un slot sensible se declara para manejar material secreto. Una Feature también puede acoplarse con un nombre que ningún slot declara.
| Slot | Selector | Obligatorio | Inyección | Sensible | Descripción |
|---|---|---|---|---|---|
| password | feature.aggrega.ai/kind=secret | no | env | sí | Optional password of the server's administrator account, admin. When attached, the Kubernetes Recipe reads it from the credential's Secret by reference and the Compose Recipe writes the value the credential delivers; unattached, compose/opensearch and helm/opensearch-chart set it to the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password, and attaching a credential replaces it. The OpenSearch Service realizations take core/random-password alone, with values.symbols true so the password holds every character class — as a reference to the password Terraform draws at apply time on terraform, as a Secrets Manager dynamic reference to the secret the stack generates on CloudFormation — and halt on any other credential, on punctuation left off, or on none. |
Lista de permitidos de autoinyección
env
Relaciones
Aristas tipadas hacia y desde otras entidades publicadas. Una referencia sin un destino publicado se muestra como una arista rota en lugar de como un enlace.
Usa
Esta entidad no usa nada del catálogo.
Usado por
usa el socket «backend»
usa el socket «cache»
usa el socket «queue»
usa el socket «backend»
usa el socket «cache»
usa el socket «queue»
usa el socket «backend»
usa el socket «backend»
usa el socket «cache»
usa el socket «queue»
usa el socket «backend»
usa el socket «cache»
usa el socket «queue»
usa el socket «backend»
usa el socket «cache»
usa el socket «queue»
usa el socket «knowledge_base»
usa el socket «backend»
usa el socket «cache»
usa el socket «vector_store»
usa el socket «backend»
usa el socket «cache»
usa el socket «vector_store»
usa el socket «backend»
usa el socket «cache»
usa el socket «backend»
usa el socket «cache»
usa el socket «vector_store»
usa el socket «backend»
usa el socket «cache»
usa el socket «vector_store»
usa el socket «backend»
usa el socket «cache»
usa el socket «backend»
usa el socket «cache»
usa el socket «state_store»
usa el socket «vector_store»
usa el socket «vector_store»
usa el socket «task_memory»
usa el socket «document_store»
usa el socket «vector_store»
usa el socket «vector_store»
usa el socket «checkpointer_db»
usa el socket «checkpointer_db»
usa el socket «backend»
usa el socket «backend»
usa el socket «backend»
usa el socket «vector_store»
usa el socket «vector_store»
usa el socket «storage»
usa el socket «knowledge_base»
usa el socket «data_store»
usa el socket «metadata_store»
usa el socket «target_datastore»
usa el socket «target_datastore»
usa el socket «target_datastore»
usa el socket «backend»
usa el socket «databases»
usa el socket «etcd»
usa el socket «backend»
usa el socket «backend»
usa el socket «cache»
usa el socket «state_store»
usa el socket «forward_target»
usa el socket «backend»
usa el socket «cache»
usa el socket «chunk_cache»
usa el socket «scrape_target»
usa el socket «backend»
usa el socket «backend»
usa el socket «database»
se aplica a
se aplica a
se aplica a
implementa
implementa
implementa
implementa