ns8-rustfs

rustfs module for NS 8. This is a template module for NethServer 8.

Install

Instantiate the module with:

add-module ghcr.io/nethserver/rustfs:latest 1

The output of the command will return the instance name. Output example:

{"module_id": "rustfs1", "image_name": "rustfs", "image_url": "ghcr.io/nethserver/rustfs:latest"}

Configure

Let's assume that the rustfs instance is named rustfs1.

Launch configure-module, by setting the following parameters:

• host_server: rustfs API server host name
• host_console: rustfs UI server host name
• lets_encrypt: enable or disable Let's Encrypt certificate
• user: rustfs admin user name, default to rustfsadmin (optional)
• password: rustfs admin user password, default to rustfsadmin (optional)

Example:

api-cli run module/rustfs1/configure-module --data '{"host_server": "myrustfs.nethserver.org", "host_console": "console.myrustfs.nethserver.org", "lets_encrypt": true}'

The above command will:

• start and configure the rustfs instance: default root credentials rustfsadmin:rustfsadmin
• configure traefik to access rustfs with a valid Let's Encrypt certificate

Send a test HTTP request to the rustfs backend service:

curl https://myrustfs.nethserver.org

Use rustfs as NS8 backup storage

You can configure a NS8 machine to backup data to a rustfs bucket.

First, create a bucket. You can do from the UI or using the command line, eg:

curl  https://dl.min.io/client/mc/release/linux-amd64/mc -o /usr/local/bin/mc
chmod a+x /usr/local/bin/mc
mc alias set rustfs https://myrustfs.nethserver.org rustfsadmin rustfsadmin --api S3v4
mc mb rustfs/test1

Use the UI to create a generic S3 backup repository and schedule a backup for it.

Use an external disk as rustfs storage

You can configure a rustfs instance to use a local attached USB/SCSI disk. Given a disk named scsi-disk1, follow these steps:

# Create a mount point for your disk:
$ mkdir -p /mnt/data

# Change fstab to automatically mount the disk at boot
$ echo '/dev/disk/by-id/scsi-disk1 /mnt/data ext4 defaults,nofail,discard 0 0' >> /etc/fstab
$ systemctl daemon-reload

# Mount the disk
$ mount /mnt/data

# Make sure the disk is accessible from rustfs instance (eg. rustfs1)
$ chown rustfs1:rustfs1 /mnt/data/

From the module UI, setup the Storage path under the advanded section and set it to /mnt/data.

Uninstall

To uninstall the instance:

remove-module --no-preserve rustfs1

Testing

Test the module using the test-module.sh script:

./test-module.sh <NODE_ADDR> ghcr.io/nethserver/rustfs:latest

The tests are made using Robot Framework

UI translation

Translated with Weblate.

To setup the translation process:

• add GitHub Weblate app to your repository
• add your repository to [hosted.weblate.org]((https://hosted.weblate.org) or ask a NethServer developer to add it to ns8 Weblate project