FastCFS ops tools introduction

• fcfs.sh -- a ops tool for quickly manage FastCFS clusters
• fcfs_conf.sh -- a ops tool for quickly create FastCFS clusters config files

1. fcfs.sh introduction

fcfs.sh is a ops tool for quickly deploy and manage FastCFS clusters. It only relying on SSH access to the servers and sudo. It runs fully on your workstation, requiring no servers, databases, or anything like that.

If you set up and tear down FastCFS clusters a lot, and want minimal extra repeating works, this is for you.

Tip： This shell support for the following operating systems:

• CentOS 7, CentOS 8;
• Red Hat Linux 8 or higher;
• Rocky Linux 8 or higher;
• Fedora Linux 20 or higher;
• Oracle Linux 8 or higher;
• Debian 10 or higher;
• Ubuntu 18 or higher;

1.1. What this tool can do?

It can quickly setup FastCFS cluster, include install softwares, distribute config files, manage cluster services and query cluster logs.

It can also upgrade or downgrade FastCFS softwares on single node or full cluster.

It can reinstall software or redistribute config files.

1.2. What this tool cannot do?

It is not a generic deployment tool, it is only for FastCFS. It does not handle cluster configuration beyond distribute config files to cluster servers. You must provide usable cluster config files for it.

1.3. Fetch fcfs.sh

Get it from http://fastcfs.net/fastcfs/ops/fcfs.sh and put it in workstation's bin path.

sudo curl -o /usr/bin/fcfs.sh http://fastcfs.net/fastcfs/ops/fcfs.sh && sudo chmod +x /usr/bin/fcfs.sh

1.4. Use preconditions

• fcfs.settings -- cluster ops settings, in current working directory
• conf -- cluster config files, in current working directory
• remote server SSH password-free login, see also SSH password-free login

You must create a independent working directory(exp: fastcfs-ops) for a cluster, put "fcfs.settings" and "conf" into it. And then, all subsequent commands for this cluster must be execute at the same working directory.

1.4.1. fcfs.settings

fcfs.settings include two fields fastcfs_version and fuseclient_ips, fastcfs_version specify FastCFS main version number, fuseclient_ips specify host to deploy fuse client. When upgrade or downgrade FastCFS, you need change fastcfs_version to version you expect.

fcfs.settings content Example:

# Version of FastCFS cluster
fastcfs_version=5.2.0

# Hosts which fuseclient will install，multiple hosts separated by comma
fuseclient_ips=10.0.1.14

Tip：Use version 5.2.0 and later for deploy.

1.4.2. conf

All config files of FastCFS cluster must be put into working directory beforehand, conf include five subdirectories：

• vote -- config files for fvote server
• fdir -- config files for fdir server
• fstore -- config files for fstore server
• auth -- config files for fauth server
• fcfs -- config files for fuseclient

Fetch config sample

mkdir fastcfs-ops
cd fastcfs-ops/
curl -o fcfs-config-sample.tar.gz http://fastcfs.net/fastcfs/ops/fcfs-config-sample.tar.gz
tar -xzvf fcfs-config-sample.tar.gz

Create config files use fcfs_conf.sh

You can also create FastCFS cluster config files use fcfs_conf.sh according to your own needs. see also fcfs_conf.sh

1.5. SSH password-free login

fcfs.sh will connect to cluster hosts via SSH. It requires that the workstation machine from which the shell is being run can connect via SSH as root(or sudo user) without password into cluster nodes.

To enable password-free login, you need generate rsa key pair for ssh:

ssh-keygen -t rsa -C cfs -f cfs-ssh-key

it will generate key files：

• cfs-ssh-key -- private key file
• cfs-ssh-key.pub -- public key file

1.5.1. Deploy private key

Copy private key file cfs-ssh-key to workstation machine's current user directory "~/.ssh/", and add the following phrase to ~/.ssh/config(for each host):

Host [node ip]
    HostName [node host name]
    User [ssh user]
    Port 22
    PubkeyAuthentication yes
    IdentityFile ~/.ssh/cfs-ssh-key

1.5.2. Deploy public key

Copy public key to file .ssh/authorized_keys in every node server's sudo user home:

ssh-copy-id -i cfs-ssh-key.pub [user name]@[node server ip]

and ensure that the following lines are in server's sshd config:

RSAAuthentication yes
PubkeyAuthentication yes
AuthorizedKeysFile      .ssh/authorized_keys

1.6. Tool commands introduction

The tool's command include three parts: command, module and node. Command is required, module and node are optional.

Usage:

fcfs.sh command [module] [node]

Commands:

• setup -- Setup FastCFS softwares, a shortcut command combines install, config, and restart
• install -- Install FastCFS softwares
• reinstall -- Reinstall FastCFS softwares
• remove -- Remove FastCFS softwares, same as erase
• erase -- Erase FastCFS softwares
• config -- Copy cluster config files to target host path
• start -- Start all or one module service in cluster
• restart -- Restart all or one module service in cluster
• stop -- Stop all or one module service in cluster
• tail -- Display the last part of the specified module's log
• status -- Display the service processes status
• help -- Show the detail of commands and examples

Modules:

• fvote -- Vote server
• fdir -- fastDIR server
• fstore -- faststore server
• fauth -- FastCFS auth server
• fuseclient -- FastCFS fuse client

Node:

You can specify a single cluster IP, or command will be executed on all nodes.

1.6.1. FastCFS setup

You can use command setup to quickly setup FastCFS softwares on nodes, then config and start module services.

Examples

Setup the full FastCFS cluster:

fcfs.sh setup

Setup fdir server on all fdir nodes:

fcfs.sh setup fdir

Setup fdir server on node 10.0.1.11:

fcfs.sh setup fdir 10.0.1.11

node 10.0.1.11 must belong to fdir cluster, or it will fail.

1.6.2. FastCFS softwares install

You can use command install to install softwares only. This command is part of setup.

First time, you must install all softwares on all nodes(that is to say you can't specify module and node). After that, you can install a new node with module and node params.

Examples

Install all FastCFS softwares on all nodes:

fcfs.sh install

Install fdir server on all fdir nodes:

fcfs.sh install fdir

Install fdir server on node 10.0.1.11:

fcfs.sh install fdir 10.0.1.11

1.6.3. FastCFS softwares upgrade

When you want to upgrade FastCFS's software, you can modify fcfs.settings, change field fastcfs_version to new version, then execute install command:

fcfs.sh install

1.6.4. FastCFS softwares downgrade

If you realy want to downgrade FastCFS softwares to an old version, you must execute command remove first:

fcfs.sh remove

or:

fcfs.sh erase

and change field fastcfs_version to old version, then execute install command:

fcfs.sh install

1.6.5. FastCFS softwares remove

You can use command remove or erase to remove FastCFS softwares.

Examples

Remove all softwares on all nodes:

fcfs.sh remove

Remove fdir server on all nodes:

fcfs.sh remove fdir

Remove fdir server on node 10.0.1.11:

fcfs.sh remove fdir 10.0.1.11

1.6.6. FastCFS config files distribute

After install FastCFS softwares, you must execute command config to distribute config files to cluster nodes. If target config file directory does't exist on node, it will create it automatically.

Exmaples

Distribute all module config files to all nodes respective：

fcfs.sh config

Distribute fdir server config files to all fdir nodes：

fcfs.sh config fdir

Distribute fdir server config files to fdir node 10.0.1.11：

fcfs.sh config fdir 10.0.1.11

1.6.7. Cluster manage

Manage commands include start, stop, restart. You can operate on all modules or one module's all nodes at same time, or a single node for one module.

If you want to operate on a single node, you must specify node host after module, that is to say you can't operate on all modules on a single node at same time.

Start all service on all nodes:

fcfs.sh start

Restart fdir service on all fdir nodes:

fcfs.sh restart fdir

Stop fdir service on fdir node 10.0.1.11:

fcfs.sh stop fdir 10.0.1.11

1.6.8. Display cluster logs

When you want to query FastCFS services last logs, you can use command tail to display the last part of the specified module's log.

Example

Display the last 100 lines of fdir server log:

fcfs.sh tail fdir 10.0.1.11 -n 100

or:

fcfs.sh tail fdir 10.0.1.11 -100

Display the last 10 lines of each fdir server log:

fcfs.sh tail fdir

1.6.9. Display cluster service status

When you want to query FastCFS services process status, you can use command status to display the status of the specified module's service process.

Example

Display the status of fdir service process:

fcfs.sh status fdir 10.0.1.11

Display the status of each fdir service process:

fcfs.sh status fdir

Display the status of all service processes:

fcfs.sh status

2. fcfs_conf.sh introduction

fcfs_conf.sh is a ops tool for quickly generate FastCFS cluster config files.It only relying on bash shell access to the local fcfs_conf.settings file. It runs fully on your workstation, requiring no servers, databases, or anything like that.

If you want to generate cluster config files with specify server ips quickly, this is for you.

2.1. Fetch fcfs_conf.sh

Get it from http://fastcfs.net/fastcfs/ops/fcfs_conf.sh and put it in workstation's bin path.

sudo curl -o /usr/bin/fcfs_conf.sh http://fastcfs.net/fastcfs/ops/fcfs_conf.sh && sudo chmod +x /usr/bin/fcfs_conf.sh

2.2. Use preconditions of fcfs_conf.sh

• fcfs_conf.settings -- cluster ops settings for create config files, in current working directory

You must create a independent working directory(exp: fastcfs-ops) for a cluster, put "fcfs_conf.settings" into it. And then, subsequent commands for fcfs_conf.sh must be execute at the same working directory.

2.2.1. fcfs_conf.settings

fcfs.settings include six fields: fastcfs_version and fuseclient_ips, fastcfs_version specify FastCFS main version number, fuseclient_ips specify host to deploy fuse client. When upgrade or downgrade FastCFS, you need change fastcfs_version to version you expect.

• fastcfs_version -- The FastCFS version you expect to create config files for.
• vote_ips -- vote server IP list, multiple hosts separated by comma
• auth_ips -- FastCFS auth server IP list, multiple hosts separated by comma
• fdir_ips -- fastDIR server IP list, multiple hosts separated by comma
• fstore_group_count -- faststore server group count
• fstore_group_[N] -- faststore server group IP list, multiple hosts separated by comma
• data_group_count - faststore data group count(multiples of 64 are recommended)

Parameter fstore_group_count's value must match fstore_group_[N], and N increases from 1。

fcfs_conf.settings content Example:

# Version of FastCFS cluster
fastcfs_version=5.2.0

# Cluster hosts list and group count
vote_ips=10.0.1.11,10.0.1.12,10.0.1.13
auth_ips=10.0.1.11,10.0.1.12,10.0.1.13
fdir_ips=10.0.1.11,10.0.1.12,10.0.1.13
fstore_group_count=2
fstore_group_1=10.0.1.11,10.0.1.12,10.0.1.13
fstore_group_2=10.0.2.14,10.0.2.15,10.0.2.16
data_group_count=128

Tip：Use version 5.2.0 and later for create config files, especially for vote server.

2.3. fcfs_conf.sh Tool commands introduction

The fcfs_conf.sh command include two parts: command and module. Command is required, module is optional.

Usage:

fcfs_conf.sh command [module]

Commands:

• create -- Create config files.
• help -- Show the detail of commands and examples

Modules:

• fvote -- Vote server
• fdir -- fastDIR server
• fstore -- faststore server
• fauth -- FastCFS auth server
• fuseclient -- FastCFS fuse client

3. conf_tpl_tar.sh introduction

A simple cluster config file templates pack tool for developer of FastCFS.

It will pack FastCFS cluster config file templates to a tar file from source code repository FastCFS, fastDIR, faststore.

Three repository FastCFS, fastDIR, faststore must at same path, and execute conf_tpl_tar.sh in FastCFS/shell/

Command:

conf_tpl_tar.sh <version> [update]

• version -- Cluster version number to create template tar file.
• update -- Pull the last source codes before create tar file. Optional

Exmaple:

./conf_tpl_tar.sh 5.2.0 update

It will create tar file conf.5.2.0.tpl.tar.gz in current dir.