Skip to content

Latest commit

 

History

History
118 lines (96 loc) · 5.14 KB

README.md

File metadata and controls

118 lines (96 loc) · 5.14 KB

zeroconf

Zeroconf Storage Connection Utility

Zeroconf Storage Connection Utility - is a tool that allows you efficiently locate appliances of a hyperconverged storage system using zeroconf technologies.

What to expect

Zeroconf Storage Connection Utility (ZSCU) allows you to Discover, Connect and Manage storage systems.

Discover

The ZSCU will locate all available appliances within your network. It allows you to choose newly installed appliances and proceed to Initial Configuration Wizard so that you can create a new cluster, or add them to an existing one.

Connect

Once you have selected your appliances using the ZSCU, the Initial Configuration Wizard will launch. This wizard will guide you through the steps of creating a new cluster.

Manage

You will be redirected to the management app of your system. Here you will manage all aspects of your new cluster.

Build and run

You can download and run ZSCU binary files from this repository. Or you may complete several steps to build and run by yourself.

Howto Build

  1. Install Node.js (tested with 8.11.4) for your system. The installer will guide you through all necessary steps and will also install npm
  2. Clone or download this project
  3. Download and install all of the project libraries and dependencies by running the following commands (using any shell).
    1. run npm install in "./" of the project.
  4. In the directory "./" build the bundle by npm run dev command
  5. Now you can run or build binary files of ZSCU:

    1. For running this application you need enter npm run electron command in "./"

    2. You can build binary files only from the same platform type as the intended target. For building binary files you need run one of the following commands in "./":

      npm run build:win32
npm run build:win64
npm run build:linux

Supported format for publishing storage systems

In the local network Zeroconf auto assigns IP-addresses to devices (appliances). mDNS is used for name resolving. Whithin the network every appliance has a unique name, that contains information about itself. This information has the following format: <cluster>_<serialNumber>_<type>_<state>, where

  • <cluster> = {CycCluster, CycApp} - identifier of whether it is the cluster or not;
  • <serialNumber> - serial number of the appliance;
  • <type> = {Virtual_Dell, Another_type (with "_" sign)}
  • identifier of appliance's type. Virtual_Dell - appliances type is VMware, Another_type - - appliances type is SAN;
  • <state> = {Management, Unconfigured, Service} - identifier of appliance's state. Management - it works fine, Service - appliance is not healthy, Unconfigured - newly installed appliance;

Also a published appliance possesses information about its own IP-address and port.

Testing ZSCU

If you have no ability to test ZSCU with real storage systems, you can do that on the test network by publishing the name of appliances with folowing command: avahi-publish-service CycCluster_H2042_Virtual_Dell_Management _http._tcp 3000, where

  • _http._tcp - type of publishing and discovering appliances;
  • 3000 - port of that appliances (you may set any one);
  • CycCluster_H2042_Virtual_Dell_Management - unique name of the appliance.

Troubleshooting tips

With any problems feel free to contact us by EMAIL(TBD) or create an issue within this project. Also it may be helpful to view all current and closed issues for similar problems.

Bellow are some examples of common issues during the build and execution of ZSCU.

Trouble with build process

Be attentive to console output when you run any commands - sometimes it can give you an answer to your problem. One of the frequent issues is outdated version of Node.js and npm. You may update them by running npm install -g npm and npm install -g node respectively.

Also you can update nearly every library in your project by running npm install -g <libname>. Note, the version that will be used in the application is defined by corresponding package.json file.

Problems with detecting appliances

If you are having problems with detecting appliances, try the following:

  • Temporally disable your firewall or add the tool to the exclusion list.
  • For all versions of Windows, temporarily disable Cisco Access Manager and Cisco Security Manager.
  • Isolate your local link network by temporarily disabling other networks, such as your wireless network.
  • Disable security applications, such as antivirus software.
  • Ensure that you are running ZSCU on the same network as the appliance you are looking to discover. Your laptop or management station should be cabled directly to the network switch, or connected virtually on a host within the same network.

Enable developer tools

If you want to enable developer tools, you should set SHOW_DEV_CONSOLE state true: SHOW_DEV_CONSOLE: true in "/src/app_environment.js" file before build/run process