github.com/muhammadn/cortex@v1.9.1-0.20220510110439-46bb7000d03d/docs/guides/grpc-storage-plugin.md (about)

     1  ---
     2  title: "gRPC storage plugin"
     3  linkTitle: "gRPC storage plugin"
     4  weight: 10
     5  slug: grpc-based-plugin
     6  ---
     7  
     8  _This feature is currently experimental and is only supported for Chunks storage (deprecated)._
     9  
    10  Cortex chunks storage supports a **gRPC-based plugin system** to use alternative backends for the index and chunks store.
    11  A store plugin is a gRPC-based server which implements the methods required by the index and chunks store. Cortex chunks storage schema is then configured to use the plugin as backend system and gRPC will be used to communicate between Cortex and the plugin.
    12  For example, if you're deploying your Cortex cluster on Kubernetes, the plugin would run as a sidecar container of your Cortex pods and the Cortex's `-grpc-store.server-address` should be configured to the endpoint exposed by the sidecar plugin (eg. `localhost:<port>`).
    13  
    14  ### How it works
    15  
    16  In the cortex configuration file, add `store` and `object_store` as `grpc-store` and configure storage with plugin server endpoint (ie. the address to the gRPC server which implements the cortex chunk store methods).
    17  
    18  ```
    19  schema:
    20    configs:
    21    - from: 2019-07-29
    22      store: grpc-store
    23      object_store: grpc-store
    24      schema: v10
    25      index:
    26        prefix: index_
    27        period: 168h
    28      chunks:
    29        prefix: chunk_
    30        period: 168h
    31  
    32  storage:
    33    grpc_store:
    34      # gRPC server address
    35      server_address: localhost:6666
    36  ```
    37  
    38  ## Community plugins
    39  
    40  
    41  The following list shows Cortex storage plugins built and shared by the community:
    42  
    43  1. [gRPC based Cortex chunk store for Mongo](https://github.com/VineethReddy02/cortex-mongo-store)
    44  2. [gRPC based Cortex chunk store for Mysql](https://github.com/VineethReddy02/cortex-mysql-store)