S4 Core Docs
/
v1.4.0-free-space-warn
latestv1.4.0-free-space-warnv1.3.0-anti-entropyv1.2.0-extended-metricsv1.1.1-secret-filesv1.1.0-erasure-codingv1.0.0-beta-federationv0.0.7-alpha-fix-journal-compactionv0.0.6-alpha-fix-compaction-dead-volumesv0.0.5-alpha-fix-delimiter-list-objectsv0.0.4-alpha-fjall-fix-unregister-dedupv0.0.4-alpha-fjall-fix-compaction-edge-casesv0.0.3-alpha-fjall-fix-dedup-ref-countv0.0.3-alpha-fjall-fix-compactor-delete-iamv0.0.2-alpha-fjall-fix-compactionv0.0.2-alpha-fjallv0.0.1-alpha-end-redb-23v0.0.1-alpha-27-end-redbv0.0.1-alpha-26-end-redbv0.0.1-alpha-25-end-redbv0.0.1-alpha-24-end-redbv0.0.1-alpha-22v0.0.1-alpha-21v0.0.1-alpha-20v0.0.1-alpha-19v0.0.1-alpha-18v0.0.1-alpha-17v0.0.1-alpha-16v0.0.1-alpha-15v0.0.1-alpha-14v0.0.1-alpha12v0.0.1-alpha11v0.0.1-alpha10v0.0.1-alpha9v0.0.1-alpha8v0.0.1-alpha7v0.0.1-alpha6v0.0.1-alpha5v0.0.1-alpha4v0.0.1-alpha3v0.0.1-alpha2
  • Getting Started
  • Architecture
  • S3 API Reference
  • Features
  • IAM & Admin API
  • Monitoring
  • Web Admin Console
  • Deployment
  • Development
Getting Started
Configuration
Installation
Quick Start
Architecture
Data Flow
High-Level Design
Storage Engine
Workspace Structure
S3 API Reference
Authentication
Bucket Operations
Multipart Upload
Object Operations
Features
Volume Compaction
CORS Configuration
Content Deduplication
Federation Erasure Coding (Enterprise)
Federation (Distributed Mode)
Lifecycle Policies
Object Lock
TLS / HTTPS
Object Versioning
IAM & Admin API
Admin API
Roles and Permissions
S3 Credentials
Monitoring
Prometheus Metrics
Stats API
Web Admin Console
Console Features
Console Setup
Deployment
Cluster Deployment
Docker Deployment
Production Recommendations
Development
Building and Testing
Code Standards
Contributing
Disk-space validation
  1. Core Docs
  2. Development

Development

This section covers building, testing, and contributing to S4.

See disk-space validation for tmpfs scenarios, ledger checks and isolated source mutations.

Building and Testing
- Rust through [rustup](https://rustup.rs): the release is pinned in rust-toolchain.toml, and rustup toolchain install in the repository installs it - Git - protoc (protobuf compiler) for the cluster gRPC code generation - nasm 2.14 or newer, on x86_64 only
Code Standards
S4 follows strict coding standards to maintain quality and readability across the team.
Contributing
Thank you for your interest in contributing to S4. This guide will help you get started.
Disk-space validation
The disk-space scenario runs each storage node on a checked tmpfs inside an unprivileged user/mount namespace. It fails if namespaces are unavailable; it never substitutes the host disk. Install curl, Python 3, netcat, coreutils, procps and util-linux. Use a machine with at least 4 GiB for licensed EE. The six-node group measured about 1.18 GiB of aggregate node RSS in addition to its 384 MiB tmpfs allocation; allocator, compiler and host services need more.
Was this page helpful?
Предыдущая Production Recommendations
Следующая Building and Testing
S4 Core Docs

Company

  • About S4Core

Help & Community

  • Documentation

Resources

  • Home