Interface PodSpec

Configuration needed to deploy a pod-based index.

Export

PodSpec

Hierarchy

  • PodSpec

Properties

environment metadataConfig? podType pods? replicas? shards? sourceCollection?

Properties

environment

environment: string

The environment where the index is hosted.

Memberof

PodSpec

Optional metadataConfig

metadataConfig?: PodSpecMetadataConfig

Memberof

PodSpec

podType

podType: string

The type of pod to use. One of s1, p1, or p2 appended with . and one of x1, x2, x4, or x8.

Memberof

PodSpec

Optional pods

pods?: number

The number of pods to be used in the index. This should be equal to shards x replicas.'

Memberof

PodSpec

Optional replicas

replicas?: number

The number of replicas. Replicas duplicate your index. They provide higher availability and throughput. Replicas can be scaled up or down as your needs change.

Memberof

PodSpec

Optional shards

shards?: number

The number of shards. Shards split your data across multiple pods so you can fit more data into an index.

Memberof

PodSpec

Optional sourceCollection

sourceCollection?: string

The name of the collection to be used as the source for the index.

Memberof

PodSpec

Settings

Member Visibility

Theme

On This Page