SNIA Swordfish™ | SNIA

The SNIA Swordfish™ specification helps to provide a unified approach for the management of storage and servers in hyperscale and cloud infrastructure environments, making it easier for IT administrators to integrate scalable solutions into their data centers. SNIA Swordfish is an extension of the DMTF Redfish specification, so the same easy-to-use RESTful interface is used, along with JavaScript Object Notation (JSON) and Open Data Protocol (OData), to seamlessly manage storage equipment and storage services in addition to servers.

SNIA Swordfish is designed to integrate with the technologies used in cloud data center environments and can be used to accomplish a broad range of storage management tasks from the simple to the advanced.

SNIA Swordfish has been designed around management use cases that focus on what IT administrators need to do with storage equipment and storage services in a data center. As a result, the API provides functionality that simplifies the way storage can be allocated, monitored, and managed.

Watch this short video for an introduction to SNIA Swordfish.

ONLINE DOCUMENTATION

SNIA SWORDFISH SPECIFICATIONS – Released SNIA Technical Positions
Version Title Release Date Comments
v1.0.7a SNIA Swordfish Specification (pdf, html) 23 December 2018 SNIA Technical Position
v1.0.6 SNIA Swordfish Specification (pdf, html) 25 May 2018 SNIA Technical Position
v1.0.3 SNIA Swordfish Specification (pdf, html) 24 January 2017 SNIA Technical Position

v1.0.0

SNIA Swordfish Specification (pdf) 8 December 2016 SNIA Technical Position
SNIA SWORDFISH SPECIFICATIONS – Released SNIA Working Drafts
Version Title Release Date Comments
v1.1.0 SNIA Swordfish Specification (pdf, html) 22 August 2019
Specification:

  • Restructured to add features and profiles
    • Add description of SupportedFeatures usage and requirements
    • Add requirements for subsets of features
  • Add language to clarify support for use with and without the class of service (now an optional feature)
    • Added descriptions of support for seamless extension of Redfish Storage model to Swordfish
    • Add updated model diagrams to reflect new model permutations
  • Added descriptions of new constructs (e.g., Consistency Groups)
  • Cleaned up references to Redfish Specification based on latest version
  • Add Status Codes clarification and constraints section
    See bundle manifest for full v1.1.0 change details.
v1.0.7a SNIA Swordfish Specification (pdf, html) 8 November 2018

Updated Enhanced Spare Capacity Management Model
Deprecated Remaining Capacity
Added OpenAPI support: schema references and OpenAPI YAML files
Added iSCSI properties for CHAP
Event usage enhancements and guidance
Volume schema updates – RAID Type enum (deprecating VolumeType usage), add ReplicaTargets

v1.0.6 SNIA Swordfish Specification (pdf, html) 13 February 2018 Updated storage systems models, schema, and User’s guide updates
v1.0.5 SNIA Swordfish Specification (pdf, html) 3 October 2017 Schema, Mockup and User’s Guide update
v1.0.4 SNIA Swordfish Specification (pdf, html) 25 April 2017 Schema and User’s Guide update
v1.0.2 SNIA Swordfish Specification (pdf, html) 16 November 2016 See v.1.0.2a for Schema update in ZIP file bundle below
v1.0.1 SNIA Swordfish Specification (pdf) 16 October 2016
v1.0.0 SNIA Swordfish Specification (pdf) 19 September 2016
SNIA SWORDFISH PROFILES – Released SNIA Working Drafts
Version Title Release Date Comments
v0.9 Swordfish Profile Core Bundle Working Draft version v0.9
(zip)
24 May 2019 The Swordfish Profile Core Bundle contains the definition of the set of features and the corresponding detailed profiles required to implement Swordfish. Swordfish uses advertised Features and corresponding Profile definitions to clearly define what functionality an implementation supports, and to assure interoperability. For example, the IOPerformance Feature and corresponding profile together specify that when an implementation advertises SNIA.Swordfish.Block.IOPerformance, any instances of Volumes and StoragePools will implement a fully populate IOStatistics object.
v0.9 Swordfish EnergyStar for Storage Profile Bundle v0.9 (zip) 27 June 2019 This Swordfish profile has been created to formalize the requirements from the ENERGY STAR Data Center Storage Version 1.1 Updated Program Requirements – April 1, 2019 on storage products. The profile indicates what properties Swordfish implementations need to support in order to properly instrument EnergyStar reporting capability. This functionality is intended to support EnergyStar data gathering requirements as part of the EnergyStar certification process.
SNIA SWORDFISH USER’S GUIDE
  • SNIA Swordfish User’s Guide (pdf, html)- This guide provides a common repository of best practices, common tasks and education for the users of the Swordfish API.
SNIA SWORDFISH PRACTICAL GUIDE
  • SNIA Swordfish Practical Guide – This guide provides a quick-start guide to implementers who are developing clients and providers for Redfish and Swordfish.
ONLINE SCHEMA
  • The following files are the primary Swordfish schemas defined for JSON resources conforming to the Redfish Specification. Each schema definition is available in both CSDL (XML) and json-schema formats.
    http://redfish.dmtf.org/schemas/swordfish/v1

DEVELOPMENT TOOLS

SNIA’s Storage Management Initiative sponsored the initial development of open source software tools that can help developers start working with Swordfish. These tools are already available in open repositories that are managed by the SNIA SSM TWG on GitHub.

Brief descriptions of these open source software tools are given below. Installation instructions are provided within each tool’s repository, along with basic documentation for users and developers.

Swordfish-API-Emulator

The Swordfish API Emulator can emulate a Swordfish-based system that responds to create, read, update, and delete RESTful API operations to allow developers to model new Swordfish functionality, test clients, demonstrate Swordfish, and do other similar functions.

The Swordfish API Emulator extends the DMTF Redfish Interface Emulator, adding code that supports dynamic interactions with all of the Swordfish schema.

The Swordfish API Emulator code is maintained on GitHub by the SNIA, and the Redfish Interface Emulator code is maintained on GitHub by the DMTF.

Swordfish-basic-web-client

The Swordfish Basic Web Client can connect to one or more Swordfish services (including the Swordfish API Emulator), and present in a web UI frame the entire Redfish and Swordfish hierarchy.

The Swordfish Basic Web Client provides basic capabilities for managing multiple services simultaneously, modifying configurable Properties and adding or removing elements from the service through the web UI.

Swordfish-datadog-sample-dashboard-integration

The Swordfish Datadog sample dashboard integration provides a dashboard for the Datadog monitoring service that can connect to a Swordfish service (including the Swordfish emulator), and provides an integration to the Datadog UI. It provides connectivity to a Swordfish service and displays system capacity information trending over time, configured capacity thresholds, and alert information based on crossing those thresholds.

Swordfish-powerBI-sample-dashboard-integration

The Swordfish Power BI sample dashboard integration provides a dashboard for the Power BI data center monitoring system that can connect to a Swordfish service (including the Swordfish emulator), and provides an integration to the Power BI UI. It provides connectivity to a Swordfish service and displays system capacity information and configured capacity thresholds.

SUPPORTING MATERIALS

SNIA SWORDFISH MOCKUPS

This site contains the latest public (static) mockups of SNIA Swordfish, a description of the contents, and pointers to client tools that may be helpful:

  • Swordfishmockups.com
SNIA SWORDFISH TECHNICAL POSITIONS (.ZIP File bundles )
Version Title Release Date Comments
v1.0.7a SNIA Swordfish Technical Position 23 December 2018 Latest v1.0.7a bundle. See included manifest for change details.

v1.0.6 SNIA Swordfish Technical Position 25 May 2018 Latest v1.0.6 bundle. See included manifest for change details.
v1.0.3 SNIA Swordfish Technical Position 24 January 2017 Latest v1.0 bundle
SNIA SWORDFISH WORKS IN PROGRESS (.ZIP File bundles)
Version Title Release Date Comments
v1.1.0 SNIA Swordfish Work in Progress 22 August 2019

Latest v1.1.0 bundle. See included manifest for change details.

v1.0.7a SNIA Swordfish Work in Progress 8 November 2018 Updated spare capacity management model, added OpenAPI support, Added iSCSI properties for CHAP, Event usage enhancements and guidance and Volume schema updates
v1.0.6 SNIA Swordfish Work in Progress 13 February 2018 Updated storage systems models, schema, and User’s guide updates.
v1.0.5 SNIA Swordfish Work in Progress 3 October 2017 Schema, Mockup and User’s Guide update
v1.0.4 SNIA Swordfish Work in Progress 25 April 2017 Schema and User’s Guide update
v1.0.2a SNIA Swordfish Work in Progress 18 November 2016 Schema update
v1.0.2 SNIA Swordfish Work in Progress 16 November 2016
v1.0.1 SNIA Swordfish Work in Progress 16 October 2016
v1.0.0 SNIA Swordfish Work in Progress 19 September 2016

RELATED MATERIALS

  • Redfish Specification Forum – swordfishforum.com
  • Redfish Developer Hub – redfish.dmtf.org
  • Redfish API Information – dmtf.org/redfish
  • Redfish User Forum – redfishforum.com

LEARN ABOUT SWORDFISH

  • Gone Fishing with Swordfish: Extending Data Center Control to the World of Storage, PDF of slides
  • Swordfish School of Videos on YouTube, Swordfish School Playlist
  • Introduction to Swordfish, Scalable Storage Management: 60 min webcast, PDF of slides
  • Casting the Net to Manage Your Storage: Redfish and Swordfish Concepts: 67 min webcast
  • SNIA Storage Field Day: Reel it In: SNIA Swordfish with Richelle Ahlvers: video /30 min
  • Storage Ridecast: Swordfish Overview: video /4:51 min
  • Dip your Toe in the Water: A Swordfish Introduction (Storage Developer Conference 2017): video /48:48 min
  • Deep Sea Fishing: A Swordfish Deep Dive (Storage Developer Conference 2017): video /41:30 min
  • Baiting the Hook: Navigating the Swordfish Waters (Storage Developer Conference 2017): video /36:56 min
  • SWFishJS – A Swordfish JS Library for SRM Developers (Storage Developer Conference 2017): video /32:15 min
  • Looking for a Swiss Knife for Storage Ecosystem Management? A comparitive study of SMI-S, Redfish, Swordfish and (Storage Developer Conference 2017): video /37:55 min
  • Spare Resource and Capacity Overview – whitepaper

For more information:

  • Track SNIA SMI activities on Twitter
  • Check out the SNIA newsroom for SMI Swordfish articles
  • Please e-mail the SNIA Swordfish Development Team at storagemanagement@snia.org

Join the Redfish Specification Forum to ask and answer questions about Swordfish!

Source

Leave a comment

Your email address will not be published. Required fields are marked *