You are here: Introduction to HyperStore > HyperStore Documentation

HyperStore Documentation

The HyperStore user documentation consists of:

The Help is available through the CMC (by clicking the Help button) and is also available in the directory /opt/cloudian-staging/7.5.2/doc/HyperStoreHelp on your Configuration Master node (in that directory you can open the HyperStoreHelp.html file). The PDF guides can be downloaded through the links above, and are also available in the directory /opt/cloudian-staging/7.5.2/doc/HyperStorePDFManuals on the Configuration Master node.

The Help has all of the content from the Administrator's guide and the API guides, plus information about each CMC screen.

The Help features a built-in search engine. The search box is in the upper right of the interface. As with any search engine, enclose your search phrase in quotes if you want to limit the results to exact match only.

In the Help, in most cases screen shots are presented initially as small thumbnail images. This allows for a more compact initial view of the content on a page and makes it easier for you to skim through the text on the page. If you want to see the full size image simply hold your cursor over the thumbnail image. When you're done looking at the full size image just move your cursor off of it and it will disappear, leaving only the thumbnail image.

Also in the interest of presenting a compact initial view of the content on a page, the Help often makes use of expandable/collapsible text. To expand (or subsequently collapse) such text you can click on the triangle icon to the left of the text or on the text itself.

Example of collapsed text in initial view of a Help page:

Example of that same page with the first expandable text item expanded:

To expand or collapse all of the expandable/collapsible text on a page, click this button in the upper left of the Help interface:

The Help is also responsive to the type of user logged in to the CMC: a system administrator logged in to the CMC sees the full Help content, but a group administrator or regular user logged in to the CMC sees only the content applicable to their role. Also, in the Help that group admins and regular users see, there is no Cloudian branding and no references to HyperStore or the Cloudian Management Console.

Note  A system administrator logged into the CMC can download any of the HyperStore PDF documents listed above. A group administrator or regular user logged into the CMC can only download the Cloudian HyperStore AWS APIs Support Reference PDF document.

 

Confidentiality Notice

The information contained in this document is confidential to, and is the intellectual property of, Cloudian, Inc. Neither this document nor any information contained herein may be (1) used in any manner other than to support the use of Cloudian software in accordance with a valid license obtained from Cloudian, Inc, or (2) reproduced, disclosed or otherwise provided to others under any circumstances, without the prior written permission of Cloudian, Inc. Without limiting the foregoing, use of any information contained in this document in connection with the development of a product or service that may be competitive with Cloudian software is strictly prohibited. Any permitted reproduction of this document or any portion hereof must be accompanied by this legend.