Skip to content

Latest commit

 

History

History
131 lines (102 loc) · 5.15 KB

README.md

File metadata and controls

131 lines (102 loc) · 5.15 KB
Raw

daos_server

This Go package provides a control server that implements the DAOS control-plane. The control server is a Go process responsible for the initialisation and management of the DAOS IO servers mainly through a Unix domain socket.

The control server implements the gRPC protocol to communicate with client gRPC applications.

Multiple gRPC server modules are loaded by the control server. Currently included modules are security and management.

The shell is an example client application which can connect to both the agent to perform security functions (such as providing credentials and retrieving security contexts) and to the local management server to perform management functions (such as storage device discovery).

Usage

In order to run the shell to perform administrative tasks, build and run the daos_server as per the quickstart guide. Then the shell can be used to connect to and interact with the gRPC server (running on port 10000 by default) as follows:

$ projects/daos_m/install/bin/DAOSShell
DAOS Management Shell
>>> connect -t '127.0.0.1:10000'
>>> help
Commands:
  clear                 clear the screen
  connect               Connect to management infrastructure
  exit                  exit the program
  gethandle             Command to test requesting a security handle
  getmgmtfeature        Command to retrieve the description of a given feature
  getsecctx             Command to test requesting a security context from a handle
  help                  display help
  listmgmtfeatures      Command to retrieve all supported management features
  nvme                  Perform tasks on NVMe controllers
>>> listmgmtfeatures
Listing supported mgmt features:
nvme-namespaces : Discover NVMe namespaces on controllers
nvme-burn-in : Perform burn-in quality test on NVMe controllers
nvme-fw-update : Perform firmware image update on NVMe controllers
io-start : Start DAOS IO Service
>>> getmgmtfeature nvme-namespaces
Feature: nvme-namespaces
Description: Discover NVMe namespaces on controllers
Category: nvme
>>>

To use a supported management feature, run the relevant top-level command e.g. nvme and follow the interactive prompts:

>>> nvme

enter

Select the controllers you want to run tasks on.
 >- [0] model:"INTEL SSDPED1K375GA " serial:"PHKS7335006W375AGN  " pciaddr:"0000:81:00.0" fwrev:"E2010324"

space

 >X [0] model:"INTEL SSDPED1K375GA " serial:"PHKS7335006W375AGN  " pciaddr:"0000:81:00.0" fwrev:"E2010324"

enter

Select the task you would like to run on the selected controllers.
 > [0] nvme-namespaces - Discover NVMe namespaces on controllers
   [1] nvme-burn-in - Perform burn-in quality test on NVMe controllers
   [2] nvme-fw-update - Perform firmware image update on NVMe controllers

enter

Running task nvme-namespaces on the following controllers:
        - model:"INTEL SSDPED1K375GA " serial:"PHKS7335006W375AGN  " pciaddr:"0000:81:00.0" fwrev:"E2010324"

Controller: model:"INTEL SSDPED1K375GA " serial:"PHKS7335006W375AGN  " pciaddr:"0000:81:00.0" fwrev:"E2010324"
        - Namespace ID: 1, Capacity: 375GB
>>>

Architecture

    ┌───────────────┐ ┌───────────────┐
    │  Go Shell     │ │ Other Client  │
    └───────────────┘ └───────────────┘
            │                 │
            └────────┬────────┘
                     ▼
          ┌─────────────────────┐
          │    Go daos_server   │
          └─────────────────────┘
                     │
                     ▼
       ┌───────────────────────────┐
       │     Unix Domain Socket    │
       └───────────────────────────┘
                     │
                     ▼
          ┌─────────────────────┐
          │   C daos_io_server  │
          └─────────────────────┘
                     │
                     ▼
           ┌────────────────────┐
           │ Persistent Storage │
           └────────────────────┘

TODO: include details of daos_agent interaction

Development Requirements

Development setup

  • Install Go dependencies: utils/fetch_go_packages.sh -i . from daos checkout root directory.
  • (Optional) protoc protocol buffer compiler

Building the app

Local

  • scons (binaries should be produced in install/bin directory)

Testing the app

  • Run the tests go test within each directory containing tests