Interface PodSpec

Configuration needed to deploy a pod-based index.

Export

PodSpec

interface PodSpec {
    environment: string;
    metadataConfig?: PodSpecMetadataConfig;
    pods?: number;
    podType: string;
    replicas?: number;
    shards?: number;
    sourceCollection?: string;
}

Properties

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

Properties

environment

environment: string

The environment where the index is hosted.

Memberof

PodSpec

OptionalmetadataConfig

metadataConfig?: PodSpecMetadataConfig

Memberof

PodSpec

Optionalpods

pods?: number

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

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

Optionalreplicas

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

Optionalshards

shards?: number

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

Memberof

PodSpec

OptionalsourceCollection

sourceCollection?: string

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

Memberof

PodSpec

Settings

Member Visibility

On This Page

Properties