Apache Hadoop 3.5.0 – HDFS Snapshots

##### General

- Overview
- Single Node Setup
- Cluster Setup
- Commands Reference
- FileSystem Shell
- Compatibility Specification
- Downstream Developer's Guide
- Admin Compatibility Guide
- Interface Classification
- FileSystem Specification

##### Common

- CLI Mini Cluster
- Fair Call Queue
- Native Libraries
- Proxy User
- Rack Awareness
- Secure Mode
- Service Level Authorization
- HTTP Authentication
- Credential Provider API
- Hadoop KMS
- Tracing
- Unix Shell Guide
- Registry
- Async Profiler

##### HDFS

- Architecture
- User Guide
- Commands Reference
- NameNode HA With QJM
- NameNode HA With NFS
- Observer NameNode
- Federation
- ViewFs
- ViewFsOverloadScheme
- Snapshots
- Edits Viewer
- Image Viewer
- Permissions and HDFS
- Quotas and HDFS
- libhdfs (C API)
- WebHDFS (REST API)
- HttpFS
- Short Circuit Local Reads
- Centralized Cache Management
- NFS Gateway
- Rolling Upgrade
- Extended Attributes
- Transparent Encryption
- Multihoming
- Storage Policies
- Memory Storage Support
- Synthetic Load Generator
- Erasure Coding
- Disk Balancer
- Upgrade Domain
- DataNode Admin
- Router Federation
- Provided Storage

##### MapReduce

- Tutorial
- Commands Reference
- Encrypted Shuffle
- Pluggable Shuffle/Sort
- Distributed Cache Deploy
- Support for YARN Shared Cache

##### MapReduce REST APIs

- MR Application Master
- MR History Server

##### YARN

- Architecture
- Commands Reference
- Capacity Scheduler
- Fair Scheduler
- ResourceManager Restart
- ResourceManager HA
- Resource Model
- Node Labels
- Node Attributes
- Web Application Proxy
- Timeline Server
- Timeline Service V.2
- Writing YARN Applications
- YARN Application Security
- NodeManager
- Running Applications in Docker Containers
- Running Applications in runC Containers
- Using CGroups
- Secure Containers
- Reservation System
- Graceful Decommission
- Opportunistic Containers
- YARN Federation
- Shared Cache
- Using GPU
- Using FPGA
- Placement Constraints
- YARN UI2

##### YARN REST APIs

- Introduction
- Resource Manager
- Node Manager
- Timeline Server
- Timeline Service V.2

##### YARN Service

- Overview
- QuickStart
- Concepts
- Yarn Service API
- Service Discovery
- System Services

##### Hadoop Compatible File Systems

- Aliyun OSS
- Amazon S3
- Azure Blob Storage
- Azure Data Lake Storage
- Tencent COS
- Huaweicloud OBS
- VolcanoEngine TOS

##### Auth

- Overview
- Examples
- Configuration
- Building

##### Tools

- Hadoop Streaming
- Hadoop Archives
- Hadoop Archive Logs
- DistCp
- HDFS Federation Balance
- GridMix
- Rumen
- Resource Estimator Service
- Scheduler Load Simulator
- Hadoop Benchmarking
- Dynamometer

##### Reference

- Changelog and Release Notes
- Java API docs
- Unix Shell API
- Metrics

##### Configuration

- core-default.xml
- hdfs-default.xml
- hdfs-rbf-default.xml
- mapred-default.xml
- yarn-default.xml
- kms-default.xml
- httpfs-default.xml
- Deprecated Properties

# HDFS Snapshots

- Overview
  - Snapshottable Directories
  - Snapshot Paths
- Upgrading to a version of HDFS with snapshots
- Snapshot Operations
  - Administrator Operations
    - Allow Snapshots
    - Disallow Snapshots
    - Provision SnapshotTrash
  - User Operations
    - Create Snapshots
    - Delete Snapshots
    - Rename Snapshots
    - Get Snapshottable Directory Listing
    - Get Snapshot Listing
    - Get Snapshots Difference Report

## Overview

HDFS Snapshots are read-only point-in-time copies of the file system. Snapshots can be taken on a subtree of the file system or the entire file system. Some common use cases of snapshots are data backup, protection against user errors and disaster recovery.

The implementation of HDFS Snapshots is efficient:

- Snapshot creation is instantaneous: the cost is O(1) excluding the inode lookup time.

- Additional memory is used only when modifications are made relative to a snapshot: memory usage is O(M), where M is the number of modified files/directories.

- Blocks in datanodes are not copied: the snapshot files record the block list and the file size. There is no data copying.

- Snapshots do not adversely affect regular HDFS operations: modifications are recorded in reverse chronological order so that the current data can be accessed directly. The snapshot data is computed by subtracting the modifications from the current data.

### Snapshottable Directories

Snapshots can be taken on any directory once the directory has been set as snapshottable. A snapshottable directory is able to accommodate 65,536 simultaneous snapshots. There is no limit on the number of snapshottable directories. Administrators may set any directory to be snapshottable. If there are snapshots in a snapshottable directory, the directory can be neither deleted nor renamed before all the snapshots are deleted.

Nested snapshottable directories are currently not allowed. In other words, a directory cannot be set to snapshottable if one of its ancestors/descendants is a snapshottable directory.

### Snapshot Paths

For a snapshottable directory, the path component “.snapshot” is used for accessing its snapshots. Suppose `/foo` is a snapshottable directory, `/foo/bar` is a file/directory in `/foo`, and `/foo` has a snapshot `s0`. Then, the path `/foo/.snapshot/s0/bar` refers to the snapshot copy of `/foo/bar`. The usual API and CLI can work with the “.snapshot” paths. The following are some examples.

- Listing all the snapshots under a snapshottable directory:

      hdfs dfs -ls /foo/.snapshot

- Listing the files in snapshot `s0`:

      hdfs dfs -ls /foo/.snapshot/s0

- Copying a file from snapshot `s0`:

      hdfs dfs -cp -ptopax /foo/.snapshot/s0/bar /tmp

  Note that this example uses the preserve option to preserve timestamps, ownership, permission, ACLs and XAttrs.

## Upgrading to a version of HDFS with snapshots

The HDFS snapshot feature introduces a new reserved path name used to interact with snapshots: `.snapshot`. When upgrading from an older version of HDFS which does not support snapshots, existing paths named `.snapshot` need to first be renamed or deleted to avoid conflicting with the reserved path. See the upgrade section in the HDFS user guide for more information.

## Snapshot Operations

### Administrator Operations

The operations described in this section require superuser privilege.

#### Allow Snapshots

Allowing snapshots of a directory to be created. If the operation completes successfully, the directory becomes snapshottable.

- Command:

      hdfs dfsadmin -allowSnapshot <path>

- Arguments:

  path | The path of the snapshottable directory.

See also the corresponding Java API `void allowSnapshot(Path path)` in `HdfsAdmin`.

#### Disallow Snapshots

Disallowing snapshots of a directory to be created. All snapshots of the directory must be deleted before disallowing snapshots.

- Command:

      hdfs dfsadmin -disallowSnapshot <path>

- Arguments:

  path | The path of the snapshottable directory.

See also the corresponding Java API `void disallowSnapshot(Path path)` in `HdfsAdmin`.

#### Provision SnapshotTrash

Provision trash root in one or all snapshottable directories.

- Command:

      hdfs dfsadmin -provisionSnapshotTrash <path> [-all]

- Arguments:

path | The path of the snapshottable directory.
-all | Which is an optional argument, when it is set will provision trash root in all snapshottable directories.

See also the corresponding Java API `void provisionSnapshotTrash(Path path)` in `HdfsAdmin`.

### User Operations

The section describes user operations. Note that HDFS superuser can perform all the operations without satisfying the permission requirement in the individual operations.

#### Create Snapshots

Create a snapshot of a snapshottable directory. This operation requires owner privilege of the snapshottable directory.

- Command:

      hdfs dfs -createSnapshot <path> [<snapshotName>]

- Arguments:

  path | The path of the snapshottable directory.
  snapshotName | The snapshot name, which is an optional argument. When it is omitted, a default name is generated using a timestamp with the format `"'s'yyyyMMdd-HHmmss.SSS"`, e.g. `"s20130412-151029.033"`.

See also the corresponding Java API `Path createSnapshot(Path path)` and `Path createSnapshot(Path path, String snapshotName)` in FileSystem The snapshot path is returned in these methods.

#### Delete Snapshots

Delete a snapshot from a snapshottable directory. This operation requires owner privilege of the snapshottable directory.

- Command:

      hdfs dfs -deleteSnapshot <path> <snapshotName>

- Arguments:

  path | The path of the snapshottable directory.
  snapshotName | The snapshot name.

See also the corresponding Java API `void deleteSnapshot(Path path, String snapshotName)` in FileSystem.

#### Rename Snapshots

Rename a snapshot. This operation requires owner privilege of the snapshottable directory.

- Command:

      hdfs dfs -renameSnapshot <path> <oldName> <newName>

- Arguments:

  path | The path of the snapshottable directory.
  oldName | The old snapshot name.
  newName | The new snapshot name.

See also the corresponding Java API `void renameSnapshot(Path path, String oldName, String newName)` in FileSystem.

#### Get Snapshottable Directory Listing

Get all the snapshottable directories where the current user has permission to take snapshtos.

- Command:

      hdfs lsSnapshottableDir

- Arguments: none

See also the corresponding Java API `SnapshottableDirectoryStatus[] getSnapshottableDirectoryListing()` in `DistributedFileSystem`.

#### Get Snapshot Listing

Get all the snapshots for a snapshottable directory.

- Command:

      hdfs lsSnapshot <snapshotRoot>

- Arguments:

  path | The path of the snapshottable directory.

See also the corresponding Java API `SnapshotStatus[] getSnapshotListing()` in `DistributedFileSystem`.

#### Get Snapshots Difference Report

Get the differences between two snapshots. This operation requires read access privilege for all files/directories in both snapshots.

- Command:

      hdfs snapshotDiff <path> <fromSnapshot> <toSnapshot>

- Arguments:

  path | The path of the snapshottable directory.
  fromSnapshot | The name of the starting snapshot.
  toSnapshot | The name of the ending snapshot.

  Note that snapshotDiff can be used to get the difference report between two snapshots, or between a snapshot and the current status of a directory. Users can use “.” to represent the current status.

- Results:

  + | The file/directory has been created.
  - | The file/directory has been deleted.
  M | The file/directory has been modified.
  R | The file/directory has been renamed.

A RENAME entry indicates a file/directory has been renamed but is still under the same snapshottable directory. A file/directory is reported as deleted if it was renamed to outside of the snapshottble directory. A file/directory renamed from outside of the snapshottble directory is reported as newly created.

The snapshot difference report does not guarantee the same operation sequence. For example, if we rename the directory “/foo” to “/foo2”, and then append new data to the file “/foo2/bar”, the difference report will be:

    R. /foo -> /foo2
    M. /foo/bar

I.e., the changes on the files/directories under a renamed directory is reported using the original path before the rename (“/foo/bar” in the above example).

See also the corresponding Java API `SnapshotDiffReport getSnapshotDiffReport(Path path, String fromSnapshot, String toSnapshot)` in `DistributedFileSystem`.