risedev.yml

risedev:
  #########################################
  ### Configurations used by developers ###
  #########################################

  # The default configuration will start 1 compute node, 1 meta node and 1 frontend.
  default:
    # If you want to use the local s3 storage, enable the following line
    # - use: minio

    # If you want to use aws-s3, configure AK and SK in env var and enable the following lines:
    # - use: aws-s3
    #   bucket: some-bucket

    # if you want to enable etcd backend, uncomment the following lines.
    # - use: etcd
    #   unsafe-no-fsync: true

    - use: meta-node
      enable-dashboard-v2: false
      unsafe-disable-recovery: true
    - use: compute-node
    - use: frontend

    # If you want to enable metrics, uncomment those two lines.
    # - use: prometheus
    # - use: grafana

    # If you want to enable tracing, uncomment the following line.
    # - use: jaeger

    # If you want to use the legacy frontend, uncomment the following line.
    # - use: frontend-legacy

    # If you want to create source from Kafka, uncomment the following lines
    # - use: zookeeper
    #   persist-data: true
    # - use: kafka
    #   persist-data: true

  legacy:
    - use: meta-node
    - use: compute-node
    - use: frontend-legacy

  # `dev-compute-node` have the same settings as default except the the compute node will be started by user.
  dev-compute-node:
    - use: meta-node
    - use: compute-node
      user-managed: true
    - use: frontend-legacy

  # `dev-frontend` have the same settings as default except the the frontend-legacy node will be started by user.
  dev-frontend:
    - use: meta-node
    - use: compute-node
    - use: frontend-legacy
      user-managed: true

  # `dev-meta-node` have the same settings as default except the the meta node will be started by user.
  dev-meta-node:
    - use: meta-node
      user-managed: true
    - use: compute-node
    - use: frontend-legacy

  dev-frontend-v2:
    - use: minio
    - use: meta-node
    - use: compute-node
    - use: frontend
      user-managed: true

  #################################
  ### Configurations used on CI ###
  #################################

  ci-1cn-1fe:
    - use: minio
    - use: etcd
      unsafe-no-fsync: true
    - use: meta-node
      unsafe-disable-recovery: true
    - use: compute-node
    - use: frontend

  ci-3cn-1fe:
    - use: minio
    - use: etcd
      unsafe-no-fsync: true
    - use: meta-node
      unsafe-disable-recovery: true
    - use: compute-node
      port: 5687
      exporter-port: 1222
    - use: compute-node
      port: 5688
      exporter-port: 1223
    - use: compute-node
      port: 5689
      exporter-port: 1224
    - use: frontend

  ci-3node:
    - use: minio
    - use: etcd
      unsafe-no-fsync: true
    - use: meta-node
      unsafe-disable-recovery: true
    - use: compute-node
      port: 5687
      exporter-port: 1222
    - use: compute-node
      port: 5688
      exporter-port: 1223
    - use: compute-node
      port: 5689
      exporter-port: 1224
    - use: frontend-legacy

  ci-1node:
    - use: minio
    - use: etcd
      unsafe-no-fsync: true
    - use: meta-node
      unsafe-disable-recovery: true
    - use: compute-node
    - use: frontend-legacy

# The `use` field specified in the above `risedev` section will refer to the templates below.
template:
  minio:
    # Listen address of MinIO s3 endpoint
    address: "127.0.0.1"

    # Listen port of MinIO s3 endpoint
    port: 9301

    # Console address of MinIO s3 endpoint
    console-address: "127.0.0.1"

    # Console port of MinIO s3 endpoint
    console-port: 9400

    # Root username (can be used to login to MinIO console)
    root-user: hummockadmin

    # Root password (can be used to login to MinIO console)
    root-password: hummockadmin

    # Hummock username
    hummock-user: hummock

    # Hummock user password
    hummock-password: "12345678"

    # Bucket name to store hummock information
    hummock-bucket: hummock001

    # Id of this instance
    id: minio

    # Prometheus nodes used by this MinIO
    provide-prometheus: "prometheus*"

  etcd:
    # Id of this instance
    id: "etcd"

    # Address of the single-node etcd.
    address: "127.0.0.1"

    # Listen port of the single-node etcd.
    port: 2388

    # Peer listen port of the single-node etcd.
    peer-port: 2389

    # Whether to enable fsync (NEVER SET TO TRUE IN PRODUCTION ENVIRONMENT!)
    unsafe-no-fsync: false

  compute-node:
    # Compute-node listen address
    address: "127.0.0.1"

    # Compute-node listen port
    port: 5688

    # Prometheus exporter listen address
    exporter-address: "127.0.0.1"

    # Prometheus exporter listen port
    exporter-port: 1222

    # Id of this instance
    id: compute-node-${port}

    # Minio instances used by this compute node
    provide-minio: "minio*"

    # AWS s3 bucket used by this compute node
    provide-aws-s3: "aws-s3*"

    # Meta-nodes used by this compute node
    provide-meta-node: "meta-node*"

    # Jaeger used by this compute node
    provide-jaeger: "jaeger*"

    # Sanity check: should use shared storage if there're multiple compute nodes
    provide-compute-node: "compute-node*"

    # If `user-managed` is true, this service will be started by user with the above config
    user-managed: false

    # Whether to enable in-memory pure KV state backend
    enable-in-memory-kv-state-backend: false

  meta-node:
    # Meta-node listen address
    address: "127.0.0.1"

    # Meta-node listen port
    port: 5690

    # Dashboard listen address
    dashboard-address: "127.0.0.1"

    # Dashboard listen port
    dashboard-port: 5691

    # Prometheus exporter listen address
    exporter-address: "127.0.0.1"

    # Prometheus exporter listen port
    exporter-port: 1250

    # Id of this instance
    id: meta-node-${port}

    # If `user-managed` is true, this service will be started by user with the above config
    user-managed: false

    # Etcd backend config
    provide-etcd-backend: "etcd*"

    # Whether to enable dashboard-v2
    enable-dashboard-v2: false

    # Whether to disable recovery mode
    unsafe-disable-recovery: false

  prometheus:
    # Listen address of Prometheus
    address: "127.0.0.1"

    # Listen port of Prometheus
    port: 9500

    # Id of this instance
    id: prometheus

    # Compute-nodes used by this Prometheus instance
    provide-compute-node: "compute-node*"

    # Meta-nodes used by this Prometheus instance
    provide-meta-node: "meta-node*"

    # Minio instances used by this Prometheus instance
    provide-minio: "minio*"

  frontend-legacy:
    # Listen address of frontend-legacy
    address: "127.0.0.1"

    # Listen port of frontend-legacy
    port: 4567

    # Id of this instance
    id: frontend-legacy-${port}

    # Meta-nodes used by this frontend-legacy instance
    provide-meta-node: "meta-node*"

    # If `user-managed` is true, this service will be started by user with the above config
    user-managed: false

  frontend:
    # Listen address of frontend
    address: "127.0.0.1"

    # Listen port of frontend
    port: 4566

    # Id of this instance
    id: frontend-${port}

    # Meta-nodes used by this frontend instance
    provide-meta-node: "meta-node*"

    # If `user-managed` is true, this service will be started by user with the above config
    user-managed: false

  grafana:
    # Listen address of Grafana
    address: "127.0.0.1"

    # Listen port of Grafana
    port: 3001

    # Id of this instance
    id: grafana

    # Prometheus used by this Grafana instance
    provide-prometheus: "prometheus*"

  jaeger:
    # Id of this instance
    id: jaeger

    # Dashboard listen address of Jaeger
    dashboard-address: "127.0.0.1"

    # Dashboard listen port of Jaeger
    dashboard-port: 16680

    # Jaeger has a lot of ports open, and we don't want to make this config more complex.
    # So we keep the default value of jaeger instead of making it part of RiseDev config.

  # aws-s3 is a placeholder service to provide configurations
  aws-s3:
    # Id to be picked-up by services
    id: aws-s3

    # The bucket to be used for AWS S3
    bucket: test-bucket

    # access key, secret key and region should be set in aws config (either by env var or .aws/config)

  # Apache Kafka service
  kafka:
    # Id to be picked-up by services
    id: kafka-${port}

    # Listen address of Kafka
    address: "127.0.0.1"

    # Listen port of Kafka
    port: 39092

    # ZooKeeper used by this Kafka instance
    provide-zookeeper: "zookeeper*"

    # If set to true, data will be persisted at data/{id}.
    persist-data: true

    # Kafka broker id. If there are multiple instances of Kafka, we will need to set.
    broker-id: 0

  # Apache ZooKeeper service
  zookeeper:
    # Id to be picked-up by services
    id: zookeeper-${port}

    # Listen address of ZooKeeper
    address: "127.0.0.1"

    # Listen port of ZooKeeper
    port: 32888

    # If set to true, data will be persisted at data/{id}.
    persist-data: true