Merge pull request #18 from tigrisdata/main

chore: Release

Author: efirs

.goreleaser.yaml

@@ -2,7 +2,7 @@ version: 2
 builds:
   - env:
       - CGO_ENABLED=0
-      - ENDPOINT="https://fly.storage.tigris.dev"
+      - ENDPOINT=https://fly.storage.tigris.dev
     goos:
       - linux
       - windows
@@ -13,8 +13,8 @@ builds:
     binary: tigrisfs
     ldflags:
       - -w -extldflags '-static'
-      - -X 'github.com/tigrisdata/tigrisfs/main.Version={{.Version}}'
-      - -X 'github.com/tigrisdata/tigrisfs/main.Endpoint={{.Env.ENDPOINT}}'
+      - -X 'github.com/tigrisdata/tigrisfs/core/cfg.Version={{.Version}}'
+      - -X 'github.com/tigrisdata/tigrisfs/core/cfg.DefaultEndpoint={{.Env.ENDPOINT}}'
 
 archives:
   - format_overrides:

README.md

@@ -16,32 +16,43 @@ It solves these problems by using aggressive parallelism and asynchrony.
 
 The goal of TigrisFS is to further improve on performance and reliability especially in distributed cluster setup.
 
-In first release we worked on improving reliability of the code base:
- * Removed bundled, outdated AWS SDK with critical vulnerabilities.
- * Upgraded dependencies to fix security vulnerabilities.
- * Enabled race detector in tests and fixed all detected race conditions.
- * Enabled unit, xfs and cluster tests on every PR and push to main.
+In the first release we focused on improving security and reliability of the code base:
+ * Improved security by:
+   * removing bundled, outdated AWS SDK with critical vulnerabilities.
+   * upgrading dependencies to fix security vulnerabilities.
+ * Improved reliability by:
+   * fixing all race conditions found by race detector, which is now enabled by default in tests.
+   * fixing all linter issues and enabling linting by default in CI.
+   * running more extensive tests and enabling them by default in CI.
+
+## Tigris specific features
+
+When mounted with the [Tigris](https://www.tigrisdata.com) backend TigrisFS supports:
+  * POSIX permissions, special files, symbolic links.
+  * Auto-preload content of small files on directory list in single request.
+  * Allows to auto prefetch directory data to the region on list.
 
 # Installation
 
 ## Prebuilt DEB and RPM packages 
 
-* Download the latest release: [DEB](https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.0/tigrisfs_tigris_1.1.0_linux_amd64.deb), [RPM](https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.0/tigrisfs_tigris_1.1.0_linux_amd64.rpm).
+* Download the latest release: [DEB](https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.2/tigrisfs_1.1.2_linux_amd64.deb), [RPM](https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.2/tigrisfs_1.1.2_linux_amd64.rpm).
 * Install the package:
   * Debian-based systems:
     ```bash
-    dpkg -i tigrisfs_tigris_1.1.0_linux_amd64.deb
+    dpkg -i tigrisfs_1.1.2_linux_amd64.deb
     ```
   * RPM-based systems:
     ```bash
-    rpm -i tigrisfs_tigris_1.1.0_linux_amd64.rpm
+    rpm -i tigrisfs_1.1.2_linux_amd64.rpm
     ```
 * Configure credentials
   TigrisFS can use credentials from different sources:
   * Standard AWS credentials files `~/.aws/credentials` and `~/.aws/config`. Use `aws configure` to set them up and export
     `AWS_PROFILE` environment variable to use a specific profile.
   * Environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`.
   * TigrisFS credentials in `/etc/default/tigrisfs` or mount specific credentials in `/etc/default/tigrisfs-<bucket>`.
+See [docs](https://www.tigrisdata.com/docs/sdks/s3/aws-cli/) for more details.
 
 * Mount the bucket
   * as current user
@@ -60,7 +71,7 @@ In first release we worked on improving reliability of the code base:
 * Download and unpack the latest release:
   * MacOS ARM64
     ```
-      curl -L https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.0/tigrisfs_tigris_1.1.0_darwin_arm64.tar.gz | tar -xz -C /usr/local/bin
+      curl -L https://github.com/tigrisdata/tigrisfs/releases/download/v1.1.2/tigrisfs_1.1.2_darwin_arm64.tar.gz | tar -xz -C /usr/local/bin
     ```
 * Configuration is the same as for the DEB and RPM packages above.
 * Mount the bucket:

core/cfg/logger.go

@@ -23,7 +23,7 @@ import (
 	"github.com/tigrisdata/tigrisfs/log"
 )
 
-func InitLoggers(flags *FlagStorage) {
+func InitLoggers(flags *FlagStorage) error {
 	lf := flags.LogFile
 	if lf == "" {
 		lf = "stderr"
@@ -32,7 +32,10 @@ func InitLoggers(flags *FlagStorage) {
 		}
 	}
 
-	log.InitLoggerRedirect(lf)
+	err := log.InitLoggerRedirect(lf, len(flags.LogFile) == 0)
+	if err != nil {
+		return err
+	}
 
 	log.DefaultLogConfig = &log.LogConfig{
 		Level:  flags.LogLevel,
@@ -51,4 +54,6 @@ func InitLoggers(flags *FlagStorage) {
 	log.SetLoggersConfig(log.DefaultLogConfig)
 
 	//	log.DumpLoggers("InitLoggers")
+
+	return nil
 }

core/handles.go

@@ -227,6 +227,9 @@ func (inode *Inode) SetFromBlobItem(item *BlobItemOutput) {
 			inode.setMetadata(item.Metadata)
 			inode.userMetadataDirty = 0
 		}
+		if item.Content != nil {
+			inode.buffers.Add(0, item.Content, BUF_CLEAN, false)
+		}
 	}
 	if item.ETag != nil {
 		inode.s3Metadata["etag"] = []byte(*item.ETag)

log/dup_default.go

@@ -18,10 +18,11 @@
 package log
 
 import (
-	"golang.org/x/sys/unix"
 	"io"
 	"log/syslog"
 	"os"
+
+	"golang.org/x/sys/unix"
 )
 
 func redirectStdout(target *os.File) error {
@@ -32,10 +33,6 @@ func redirectStderr(target *os.File) error {
 	return unix.Dup2(int(target.Fd()), int(os.Stderr.Fd()))
 }
 
-func InitSyslog() io.Writer {
-	lf, err := syslog.New(syslog.LOG_INFO, "tigrisfs")
-	if err != nil {
-		Fatal().Err(err).Msg("Failed to connect to syslog")
-	}
-	return lf
+func InitSyslog() (io.Writer, error) {
+	return syslog.New(syslog.LOG_INFO, "tigrisfs")
 }

log/dup_windows.go

@@ -38,6 +38,6 @@ func redirectStderr(target *os.File) error {
 	return err
 }
 
-func InitSyslog() io.Writer {
-	return logWriter
+func InitSyslog() (io.Writer, error) {
+	return logWriter, nil
 }

log/log.go

@@ -22,6 +22,10 @@ func Error() *zerolog.Event {
 	return defaultLog.Error()
 }
 
+func Warn() *zerolog.Event {
+	return defaultLog.Warn()
+}
+
 func Info() *zerolog.Event {
 	return defaultLog.Info()
 }

log/logger.go

@@ -42,30 +42,42 @@ var (
 
 var logWriter io.Writer = os.Stderr
 
-func logStderr(msg string, args ...any) {
-	_, _ = fmt.Fprintf(os.Stderr, msg, args...)
-}
+func InitLoggerRedirect(logFileName string, defLog bool) error {
+	if logFileName == "stderr" || logFileName == "/dev/stderr" || logFileName == "" {
+		return nil
+	}
 
-func InitLoggerRedirect(logFileName string) {
 	if logFileName == "syslog" {
-		logWriter = InitSyslog()
-	} else if logFileName != "stderr" && logFileName != "/dev/stderr" && logFileName != "" {
 		var err error
-		lf, err := os.OpenFile(logFileName, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o666)
-		if err != nil {
-			logStderr("Couldn't open file %v for writing logs", logFileName)
-			return
-		}
-		if err = redirectStdout(lf); err != nil {
-			logStderr("Couldn't redirect STDOUT to the log file %v", logFileName)
-			return
+		logWriter, err = InitSyslog()
+		if err == nil {
+			return nil
 		}
-		if err = redirectStderr(lf); err != nil {
-			logStderr("Couldn't redirect STDERR to the log file %v", logFileName)
-			return
+
+		if !defLog {
+			return err
 		}
-		logWriter = lf
+
+		// log file is not set and we are deamonizing redirect to default file location
+		Warn().Err(err).Msg("failed to open syslog. redirecting logs to /var/log/tigrisfs.log")
+		logFileName = "/var/log/tigrisfs.log"
+	}
+
+	var err error
+	lf, err := os.OpenFile(logFileName, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0o666)
+	if err != nil {
+		return fmt.Errorf("couldn't open file %v for writing logs: %w", logFileName, err)
+	}
+	if err = redirectStdout(lf); err != nil {
+		return fmt.Errorf("couldn't redirect STDOUT to the log file %v: %w", logFileName, err)
 	}
+	if err = redirectStderr(lf); err != nil {
+		return fmt.Errorf("couldn't redirect STDERR to the log file %v: %w", logFileName, err)
+	}
+
+	logWriter = lf
+
+	return nil
 }
 
 func SetCloudLogLevel(level zerolog.Level) {

main.go

@@ -27,6 +27,7 @@ import (
 
 	"github.com/tigrisdata/tigrisfs/core"
 	"github.com/tigrisdata/tigrisfs/core/cfg"
+	"github.com/tigrisdata/tigrisfs/lib"
 	"github.com/tigrisdata/tigrisfs/log"
 	"github.com/urfave/cli"
 
@@ -112,7 +113,15 @@ func main() {
 			}
 		}
 
-		cfg.InitLoggers(flags)
+		err = cfg.InitLoggers(flags)
+		if err != nil {
+			if !flags.Foreground {
+				daemonizer.NotifySuccess(false)
+			}
+			mainLog.Fatal().Err(err).Msg("Unable to initialize logger")
+		}
+
+		mainLog.Debug().Interface("flags", flags).Msg("config")
 
 		mainLog.Info().Str("version", cfg.Version).Msg("Starting TigrisFS version")
 		mainLog.Info().Str("bucketName", bucketName).Str("mountPoint", flags.MountPoint).Msg("Mounting")
@@ -141,12 +150,20 @@ func main() {
 		if err != nil {
 			if !flags.Foreground {
 				daemonizer.NotifySuccess(false)
+				// if demonized but started from terminal show error to the user
+				if lib.IsTTY(os.Stderr) {
+					_, _ = fmt.Fprintf(os.Stderr, "Mounting file system failed: %v\n", err)
+				}
 			}
 			mainLog.Fatal().Err(err).Msg("Mounting file system failed")
 			// fatal also terminates itself
 		} else {
 			mainLog.Info().Msg("File system has been successfully mounted.")
 			if !flags.Foreground {
+				// if demonized but started from terminal show success to the user
+				if lib.IsTTY(os.Stderr) {
+					_, _ = fmt.Fprintf(os.Stderr, "File system has been successfully mounted\n")
+				}
 				daemonizer.NotifySuccess(true)
 				mainLog.Debug().Msg("Process is daemonized. Closing stdout and stderr.")
 				mainLog.E(os.Stderr.Close())

pkg/postinst

@@ -2,6 +2,8 @@
 
 set -e
 
-systemctl daemon-reload
+if command -v systemctl >/dev/null 2>&1; then
+    systemctl daemon-reload
+fi
 
 exit 0