跳转到主要内容

User-friendly Releases

Summary

A simple user-friendly release solution.

Motivation

In the past, only specific binaries were included in the Databend release. Understanding how to operate and maintain Databend often requires extensive discussion.

This proposal aims to improve this process by providing some simple tips and default configs to help make the process painless for users.

Detailed design

The release directory structure is roughly as follows:

.
├── bin
│   ├── databend-query
│   ├── databend-meta
│   └── databend-metactl (?)
├── configs
│   ├── databend-query.toml
│   └── databend-meta.toml
├── scripts/ (?)
│   ├── bootstrap.sh
│   └── benchmark.sh
└── README.txt

- `(?)` means optional.

Required​

  • README.txt, basic information and important tips, useful links.
  • bin, of course, our binaries.
  • configs, the basic configs, to prompt for configuration usage and start the Databend service.

Optional​

  • databend-metactl, perhaps we no longer need to release databend-tools.
  • scripts, for easy installation and deployment.

Rationale and alternatives

Why not use a directory structure closer to a package like /etc, /usr ?​

Just for a quick glance, users can find the content they care about very intuitively.

It would also be easy to switch to a more package-like directory structure, but we don't have enough motivation to do so at the moment.

What are other good practices?​

The releases of most open source databases are no different with us. However, some good examples can still be found.

  • clickhouse, package-like directory structure, includes configs and utilities, the documentation is mainly a collection of useful links.
  • cayley, a notable highlight is the inclusion of data and queries to help users quickly explore linked data.