Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/influxdb/clustered/admin/scale-cluster.md

12 KiB
Raw Blame History

title description menu weight influxdb/clustered/tags related
Scale your InfluxDB cluster InfluxDB Clustered lets you scale individual components of your cluster both vertically and horizontally to match your specific workload.
influxdb_clustered
parent name
Administer InfluxDB Clustered Scale your cluster
207
scale
/influxdb/clustered/reference/internals/storage-engine/
https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits, Kubernetes resource requests and limits

InfluxDB Clustered lets you scale individual components of your cluster both vertically and horizontally to match your specific workload. Use the AppInstance resource defined in your influxdb.yml to manage resources available to each component.

Scaling strategies

The following scaling strategies can be applied to components in your InfluxDB cluster.

Vertical scaling

Vertical scaling (also known as "scaling up") involves increasing the resources (such as RAM or CPU) available to a process or system. Vertical scaling is typically used to handle resource-intensive tasks that require more processing power.

{{< html-diagram/scaling-strategy "vertical" >}}

Horizontal scaling

Horizontal scaling (also known as "scaling out") involves increasing the number of nodes or processes available to perform a given task. Horizontal scaling is typically used to increase the amount of workload or throughput a system can manage, but also provides additional redundancy and failover.

{{< html-diagram/scaling-strategy "horizontal" >}}

Scale components in your cluster

The following components of your InfluxDB cluster are scaled by modifying properties in your AppInstance resource:

  • Ingester
  • Querier
  • Compactor
  • Router

{{% note %}}

Scale your Catalog and Object store

Your InfluxDB Catalog and Object store are managed outside of your AppInstance resource. Scaling mechanisms for these components depend on the technology and underlying provider used for each. {{% /note %}}

Use the spec.package.spec.resources property in your AppInstance resource defined in your influxdb.yml to define system resource minimums and limits for each pod and the number of replicas per component. requests are the minimum that the Kubernetes scheduler should reserve for a pod. limits are the maximum that a pod should be allowed to use.

Your AppInstance resource can include the following properties to define resource minimums and limits per pod and replicas per component:

  • spec.package.spec.resources
    • ingester
      • requests
        • cpu: Minimum CPU resource units to assign to ingesters
        • memory: Minimum memory resource units to assign to ingesters
        • replicas: Number of ingester replicas to provision
      • limits
        • cpu: Maximum CPU resource units to assign to ingesters
        • memory: Maximum memory resource units to assign to ingesters
    • compactor
      • requests
        • cpu: Minimum CPU resource units to assign to compactors
        • memory: Minimum memory resource units to assign to compactors
        • replicas: Number of compactor replicas to provision
      • limits
        • cpu: Maximum CPU resource units to assign to compactors
        • memory: Maximum memory resource units to assign to compactors
    • querier
      • requests
        • cpu: Minimum CPU resource units to assign to queriers
        • memory: Minimum memory resource units to assign to queriers
        • replicas: Number of querier replicas to provision
      • limits
        • cpu: Maximum CPU resource units to assign to queriers
        • memory: Maximum memory resource units to assign to queriers
    • router
      • requests
        • cpu: Minimum CPU resource units to assign to routers
        • memory: Minimum memory resource units to assign to routers
        • replicas: Number of router replicas to provision
      • limits
        • cpu: Maximum CPU Resource units to assign to routers
        • memory: Maximum memory resource units to assign to routers

{{< expand-wrapper >}} {{% expand "View example AppInstance with resource requests and limits" %}}

{{% code-placeholders "(INGESTER|COMPACTOR|QUERIER|ROUTER)(CPU(MAX|MIN)|MEMORY_(MAX|MIN)|REPLICAS)" %}}

apiVersion: kubecfg.dev/v1alpha1
kind: AppInstance
# ...
spec:
  package:
    spec:
      # The following settings tune the various pods for their cpu/memory/replicas
      # based on workload needs. Only uncomment the specific resources you want
      # to change. Anything left commented will use the package default.
      resources:
        ingester:
          requests:
            cpu: INGESTER_CPU_MIN
            memory: INGESTER_MEMORY_MIN
            replicas: INGESTER_REPLICAS # Default is 3
          limits:
            cpu: INGESTER_CPU_MAX
            memory: INGESTER_MEMORY_MAX
        compactor:
          requests:
            cpu: COMPACTOR_CPU_MIN
            memory: COMPACTOR_MEMORY_MIN
            replicas: COMPACTOR_REPLICAS # Default is 1
          limits:
            cpu: COMPACTOR_CPU_MAX
            memory: COMPACTOR_MEMORY_MAX
        querier:
          requests:
            cpu: QUERIER_CPU_MIN
            memory: QUERIER_MEMORY_MIN
            replicas: QUERIER_REPLICAS # Default is 1          
          limits:
            cpu: QUERIER_CPU_MAX
            memory: QUERIER_MEMORY_MAX
        router:
          requests:
            cpu: ROUTER_CPU_MIN
            memory: ROUTER_MEMORY_MIN
            replicas: ROUTER_REPLICAS # Default is 1
          limits:
            cpu: ROUTER_CPU_MAX
            memory: ROUTER_MEMORY_MAX

{{% /code-placeholders %}}

{{% /expand %}} {{< /expand-wrapper >}}

{{% note %}} Applying resource limits to pods is optional, but provides better resource isolation and protects against pods using more resources than intended. For information, see Kubernetes resource requests and limits. {{% /note %}}

Related Kubernetes documentation

Horizontally scale a component

To horizontally scale a component in your InfluxDB cluster, increase or decrease the number of replicas for the component in the spec.package.spec.resources property in your AppInstance resource and apply the change.

{{% warn %}}

Only use the AppInstance to scale component replicas

Only use the AppInstance resource to scale component replicas. Manually scaling replicas may cause errors. {{% /warn %}}

For example--to horizontally scale your Ingester:

apiVersion: kubecfg.dev/v1alpha1
kind: AppInstance
# ...
spec:
  package:
    spec:
      resources:
        ingester:
          requests:
            # ...
            replicas: 6

Vertically scale a component

To vertically scale a component in your InfluxDB cluster, increase or decrease the CPU and memory resource units to assign to component pods in the spec.package.spec.resources property in your AppInstance resource and apply the change.

apiVersion: kubecfg.dev/v1alpha1
kind: AppInstance
# ...
spec:
  package:
    spec:
      resources:
        ingester:
          requests:
            cpu: "500m"
            memory: "512MiB"
            # ...
          limits:
            cpu: "1000m"
            memory: "1024MiB"

Apply your changes

After modifying the AppInstance resource, use kubectl apply to apply the configuration changes to your cluster and scale the updated components.

kubectl apply \
  --filename myinfluxdb.yml \
  --namespace influxdb

Scale your cluster as a whole

Scaling your entire InfluxDB Cluster is done by scaling your Kubernetes cluster and is managed outside of InfluxDB. The process of scaling your entire Kubernetes cluster depends on your underlying Kubernetes provider. You can also use Kubernetes autoscaling to automatically scale your cluster as needed.

Recommended scaling strategies per component

Ingester

The Ingester can be scaled both vertically and horizontally. Vertical scaling increases write throughput and is typically the most effective scaling strategy for the Ingester.

Ingester storage volume

Ingesters use an attached storage volume to store the Write-Ahead Log (WAL). With more storage available, Ingesters can keep bigger WAL buffers, which improves query performance and reduces pressure on the Compactor. Storage speed also helps with query performance.

Configure the storage volume attached to Ingester pods in the spec.package.spec.ingesterStorage property of your AppInstance resource.

{{< expand-wrapper >}} {{% expand "View example Ingester storage configuration" %}}

{{% code-placeholders "STORAGE_(CLASS|SIZE)" %}}

apiVersion: kubecfg.dev/v1alpha1
kind: AppInstance
# ...
spec:
  package:
    spec:
      # ...
      ingesterStorage:
        # (Optional) Set the storage class. This will differ based on the K8s
        #environment and desired storage characteristics.
        # If not set, the default storage class is used.
        storageClassName: STORAGE_CLASS
        # Set the storage size (minimum 2Gi recommended)
        storage: STORAGE_SIZE

{{% /code-placeholders %}}

{{% /expand %}} {{< /expand-wrapper >}}

Querier

The Querier can be scaled both vertically and horizontally. Horizontal scaling increases query throughput to handle more concurrent queries. Vertical scaling improves the Querier’s ability to process computationally intensive queries.

Router

The Router can be scaled both vertically and horizontally. Horizontal scaling increases request throughput and is typically the most effective scaling strategy for the Router.

Compactor

The Compactor can be scaled both vertically and horizontally. Because compaction is a compute-heavy process, vertical scaling (especially increasing the available CPU) is the most effective scaling strategy for the Compactor. Horizontal scaling increases compaction throughput, but not as efficiently as vertical scaling.

Catalog

Scaling strategies available for the Catalog depend on the PostgreSQL-compatible database used to run the catalog. All support vertical scaling. Most support horizontal scaling for redundancy and failover.

Object store

Scaling strategies available for the Object store depend on the underlying object storage services used to run the object store. Most support horizontal scaling for redundancy, failover, and increased capacity.