Skip to main content

System requirements

This section specifies system requirements for installing core services and the API Platform. The component set is determined by the purchased delivery. Requirements for individual services apply only if those services are included in the installation.

Common requirements​

note

It is recommended to use the software and its versions listed below. Compatibility with other components was not tested, and correct operation in such configurations is not guaranteed.

Software licenses are purchased by the client.

  • Operating system on hosts. To deploy solution components, use host virtual machines (VM) with one of the following server operating systems:

    • Ubuntu 20.04 LTS, 22.04 LTS, 24.04 LTS
    • Oracle Linux 8, 9

  • General-purpose software:

    • Kubernetes: from 1.21 to 1.34.0
    • Docker Engine: 20.10.* or later
    • Docker Registry: 2.* or later

  • Data storage software:

    • For all services:

      • S3 compatible storage: e.g., Ceph (radosgw) or MinIO
      • PostgreSQL: 15.*
      • PostgreSQL extensions: PostGIS 3.3, PL/pgSQL 1.*, pg_trgm 1.4
      • Apache Cassandra: 4.0.*, 4.1.*

    • Additionally for Statistics Collection service:

      • Redis: 6.* (stable release)
      • Apache Kafka: 3.* for transmitting API key usage data
      • ClickHouse: 25.* for displaying statistics in the Platform Manager on the Statistics tab

    • Additionally for Tilegen API: Redis: 6.* (stable release).

    • Additionally for Distance Matrix Async API and TSP API: Apache Kafka: 3.*.

  • Storage size:

    • Docker Registry: depends on the number of installed services and the rotation rules for older versions. The basic value is 50 GB.
    • S3 compatible storage: depends on the size of the territory that the system must cover. The basic value for Moscow and the Moscow Region is 400 GB.
    • PostgreSQL: depends on the size of the territory that the system must cover and the set of services used. The size accounts for storing three copies of data to support rollback and updates. The basic value for Moscow and the Moscow Region is 170 GB.
    • Apache Cassandra: depends on the size of the territory that the system must cover and the set of services used. The size accounts for storing three copies of data to support rollback and updates. The basic value for Moscow and the Moscow Region is 150 GB.
    • Apache Kafka: depends on usage scenarios and message volume and retention period. The basic value is 350 GB.
    • ClickHouse: depends on the API Platform's RPS and the usage statistics retention and rotation policy. The basic value is 300 GB.

Computational resources​

The performance requirements for the On-Premise system are specified in the Helm charts. To check resources amount for each service, go to a corresponding folder in the GitHub repository, open the values.yaml file, and find the resources settings.

To ensure that Pods are placed on the nodes of the Kubernetes cluster, it is recommended to specify resources for all the components. Learn more about Resource Management for Pods and Containers in Kubernetes.

Code Example

resources:
    requests:
        cpu: 10m
        memory: 32Mi
    limits:
        cpu: 500m
        memory: 256Mi

Where:

  • requests: the minimum amount of resources required to run the service.
  • limits: the maximum amount of resources that can be allocated to run the service.
  • cpu: the number of cores. If the value is specified as Xm, it is converted to millicores.
  • memory: the amount of RAM in mebibytes (Mi).
Contact 2GIS before installation

The system requirements mentioned above are approximate, provided for informational purposes, and intended for test deployments.

When planning the installation, please contact 2GIS to obtain calculations suitable for your environments and needs.