How to Install Swordfish Mockups (1.0.2)

November 1, 2016

The Swordfish mockups extend the Redfish mockups, based on the Redfish specification from the DMTF.

The SNIA Scalable Storage Management TWG recommends using version 1.00 of the redfish mockups with the Swordfish mockups.  Version 1.00 of the Redfish mockups is available from the DMTF here: http://www.dmtf.org/sites/default/files/standards/documents/DSP2043_1.0.0.zip

 

Basic Installation

 

1.       Unzip the Redfish files to a user selected directory. 

a.       To ensure that everything will resolve properly from your browser, here is how to set up the directory structure:

 

For example, Say you set the http root directory to c:/httpdocs.

 The nginx.conf files to match this would look like:

 

I would then put the redfish and swordfish files in “c:\httpdocs\redfish\v1”

 

 

2.       Unzip the Swordfish mockups so that the “StorageServices” and “StorageSystems” directories are in the root (this is called the “Service Root” of the redfish directory structure (parallel to the chassis and systems directory, see figure below).  This is the same directory as the “v1” we set up in 1a, above.

a.       The “index.html” file should replace the “index.html” file from the redfish mockups (use the contents of the DSP2043-server directory from the redfish download).

The mockups are formatted json.  There are multiple ways to view these. If you would like to set up and view them in a browser from a web server, the following instructions are provided to give you an example of how to use the nginx web server to do so.

Installing a Local Web Server

Notes and recommendations:

·         Ensure that you don’t have any other http server running on ports 80.

·         Plugins to view formatted json are provided for the chrome web browser only

Configure HTTP server (nginx)

1. Download latest mainline nginx from http://nginx.org/

ex: Windows - nginx/Windows-1.9.4


 

2. Unzip to a folder in local disk: ex: c:\dev\nginx

3. Open command prompt and change directory to installation folder

4. Start nginx: ex: c:\dev\nginx>start nginx.exe

5. Windows might prompt you to allow nginx.exe through the firewall

6. Confirm that the http server is running by navigating to http://localhost/

Modify nginx configuration file

1. Open nginx configuration file in c:\dev\nginx\conf\nginx.conf

2. In HTTP/SERVER/LOCATION block, update root so it points to folder with Redfish and Swordfish files

        location / {

root       C:/…(folder containing redfish and swordfish mockups);

index  index.html index.htm  index.json;

3. Reload configuration in nginx using nginx.exe -s reload

ex: c:\dev\nginx\nginx.exe -s reload

4. Confirm that the http server is serving up redfish files by navigating to http://localhost/redfish/v1

5. Browser should show unformatted output for Redfish

 

Load JSONView and Advanced REST client plugins to Chrome

1. To view properly formatted json out, find and install JSONVIEW Chrome extension

2. Browser should show properly formatted output for Redfish

 

 

3. View from Advanced REST Client

 

Extras

The Advanced REST client supports navigating through links. The intention is to create a hypermedia so anyone should have the ability to navigate through the structure.

1.       Launch Advanced REST client. Navigate to  http://localhost/redfish/v1 

2.       In the output section, click on JSON tab

3.       Clicking on /redfish/v1/storageservices/1 will insert the string to the URL field

4.       Click on Send to see the results in the window