Diese Seite wurde maschinell übersetzt. Englisches Original lesen.

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.

Herkunft

OffiziellSigniert von einer Signaturidentität, die dieser Katalog als offiziellen Herausgeber anerkennt.
Inhalts-Digest
sha256:eb87045f077ae39210c3844a719977680bd1cf0fb23b1ff237b18c7e2b599551
Veröffentlicht
2026-11-10T10:10:59Z
Signaturidentität
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signatur

  • Offiziellapplication/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

Referenz zu dieser Version

oci://hub.aggrega.ai/component/core/datastore/opensearch:1.0.0

Entwicklerparameter

Werte, die der Entwickler im Aggregate festlegt.

Keine Entwicklerparameter deklariert.

Dimensionierung durch den Operator

Infrastrukturdimensionierung, die der Operator pro Umgebung anpasst.

NameTypStandardwertErforderlichBeschreibung
portinteger (min 1024, max 65535)9200neinPort 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_versionstring3.9.0@sha256:adfa61f85025d06b4aeb562e7e74fde7e31c437039c93c3862c17e9acebd6c7cneinTag 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_versionstring—neinVersion 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.
computeobject—nein—
storageobject—nein—
overridesobject (open)—neinProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Ausgabevertrag

Werte, die diese Komponente über die uses-Topologie an Konsumenten veröffentlicht.

NameTypStandardwertErforderlichBeschreibung
hoststring—jaAddress 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.
portinteger—jaTCP 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.
userstring—neinName 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.
protocolstring—neinScheme 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.
endpointstring—neinThe 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.

uses-Sockets

Die Abhängigkeits-Sockets, über die sich diese Komponente verbindet. Das Ziel jeder über einen Socket verdrahteten Verbindung muss dessen Label-Selektor erfüllen, und jede Verbindung kann in den Slots, die der Socket deklariert, eine Anbindung tragen. Einen erforderlichen Slot muss jede Verbindung füllen, die das Aggregate oder das Release über den Socket verdrahtet.

Keine uses-Sockets deklariert.

Anbindungs-Slots

Benannte Bindungspunkte, an denen ein Feature an diese Komponente angebunden wird. Der Selektor eines Slots schränkt ein, welches Feature ihn füllen darf, und seine inject-Liste benennt, wie das Feature sein Material liefern darf. Ein erforderlicher Slot muss auf jeder Instanz gebunden sein, durch eine Anbindung an der Instanz oder in einem darüberliegenden Geltungsbereich, und ein sensibler Slot ist für den Umgang mit geheimem Material deklariert. Ein Feature kann auch unter einem Namen angebunden werden, den kein Slot deklariert.

SlotSelektorErforderlichInjektionSensibelBeschreibung
passwordfeature.aggrega.ai/kind=secretneinenvjaOptional 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.

Zulassungsliste für Selbstinjektion

env

Beziehungen

Typisierte Kanten zu und von anderen veröffentlichten Entitäten. Eine Referenz ohne veröffentlichtes Ziel wird als unterbrochene Kante statt als Link dargestellt.

Verwendet

Diese Entität verwendet nichts aus dem Katalog.

Verwendet von

Konzeptreferenz zu Component →

Der Aggrega-Katalog — ein offener Index von Komponenten, Funktionen, Rezepten und den Plugins, die sie rendern.

Erstellt mit dem gemeinsamen Aggrega-Designsystem.

Datenschutz