Baike.dev
All toolsOnline toolsAI codingTrendingOpen sourceNewsSubmit
Log in
< Back to tools
Y

yig

> 编程语言
Open source

An open source object storage server with Amazon S3 compatible API

368 stars0 likes0 views
WebsiteGitHub

About

An open source object storage server with Amazon S3 compatible API

YIG

Yet another Index Gateway

YIG is a SODA Foundation project

Introduction

A completely new designed object storage gateway framework that fully compatible with Amazon S3

At its core, Yig extend minio backend storage to allow more than one ceph cluster work together and form a super large storage resource pool, users could easily enlarge the pool`s capacity to EB level by adding a new ceph cluser to this pool. Benifits are avoiding data movement and IO drop down caused by adding new host or disks to old ceph cluster as usual way. To accomplish this goal, Yig need a distribute database to store meta infomation. Now already Support Tidb,MySql.

Getting Started

Build

How to build?

Require:

  • ceph-devel
  • go(>=1.7)

Steps:

bash
mkdir -p $GOPATH/src/github.com/journeymidnight
cd $GOPATH/src/github.com/journeymidnight
git clone [email protected]:yig/yig.git
cd $YIG_DIR
go get ./...
go build

build rpm package

bash
yum install ceph-devel
sh package/rpmbuild.sh

Dependency

Before running Yig, requirments below are needed:

  • Deploy at least a ceph cluster with two specify pools named 'tiger' and 'rabbit' are created. About how to deploy ceph, please refer https://ceph.com or our [Sample]

  • Deploy a TiDB/Mysql, then create tables. [Sample]

    • Tidb/Mysql:
     MariaDB [(none)]> create database yig
     MariaDB [(none)]> source ../yig/integrate/yig.sql
  • Deploy yig-iam used for user management and authorize request. If Yig is running in Debug Mode, request will not sent to yig-iam. So this deployment is optional, but in real factory environment, you still need it.

  • Deploy a standalone Redis instance used as cache for better performance. This deployment is optional but strong recommend

bash
yum install redis

Config files

Main config file of Yig is located at /etc/yig/yig.toml by default

…

Meanings of options above:

…

Ceph config files

Combine your ceph cluster config file [/etc/ceph/ceph.conf] with [/etc/ceph/ceph.client.admin.keyring] together, then put it to the location which 'CephConfigPattern' specified, a sample is below

[global]
fsid = 7b3c9d3a-65f3-4024-aaf1-a29b9422665c
mon_initial_members = ceph57
mon_host = 10.180.92.57
auth_cluster_required = cephx
auth_service_required = cephx
auth_client_required = cephx
filestore_xattr_use_omap = true
osd pool default size = 3
osd pool default min size = 2
osd pool default pg num = 128
osd pool default pgp num = 128

[client.admin]
        key = AQCulvxWKAl/MRAA0weYOmmkArUm/CGBHX0eSA==

Run

Start server:

bash
cd $YIG_DIR
sudo ./yig

OR

systemctl start yig

Documentation

  • why develop yig

Please refer our wiki for other information

License

Feedback & Contact

  • Github Issues:You are sincerely welcomed to issue any bugs you came across or any suggestions through Github. If you have any questions you can create issues or scan QR code below with wechat for more details.
  • User group:We use Wechat group currently.

Issues· 0 open

View all issuesOpen on GitHub

No open issues yet, or sync has not completed.

> Tags

Go

No comments yet. Be the first to share.

> Details

PublishedAug 1, 2026
UpdatedSep 17, 2026
Category编程语言
PricingOpen source

> Related tools

T
TypeScript
JavaScript 的超集,为前端与全栈提供静态类型
P
Python
通用编程语言,广泛用于 Web、数据与 AI
G
Go
Google 推出的简洁高效系统语言