Skip to content

Commit 9ad9352

Browse files
committed
alerts example
1 parent f03b1c5 commit 9ad9352

25 files changed

Lines changed: 5196 additions & 69 deletions

docs/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Preface
2-
Preface here.
1+
# OpenStorage Library API
32

4-
# Introduction
5-
Introduction to the book here.
3+
## Introduction
4+
Welcome to the _OpenStorage Library API_ documentation. Here you will find the API functions, examples, and references to multiple client libraries which can communicate with a OpenStorage REST server.
65

6+
## Status
7+
This document is under heavy development. Please check back for the latest changes.

docs/SUMMARY.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
1-
# Summary
2-
1+
### Concepts
32
* [Introduction](README.md)
4-
* [Test Code](Code.md)
5-
* [More Info](More.md)
6-
* [Last](Last.md)
3+
4+
### Reference
5+
* [API Reference](api.md)
6+
* [Clusters](clusters/README.md)
7+
* [alerts](clusters/alerts.md)
8+
* [enumerate](clusters/enumerate.md)
9+
* [get node id from ip](clusters/getnodeidfromip.md)
10+
* [inspect](clusters/inspect.md)
11+
* [status](clusters/status.md)
12+
* [versions](clusters/versions.md)
13+
* [Volumes](volumes/README.md)
14+
15+
### Examples - Please ignore
16+
* [_Website tests](Code.md)
17+
* [_WebTest](More.md)
18+
* [Last](Last.md)

docs/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# API Information

docs/clusters/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Clusters
2+
3+
These set of APIs manage cluster information.
4+
5+
## Overview
6+
The cluster API is used to interact with the cluster as whole. You will need to create a cluster client to be able to interact with the server and utilize the functions described in this chapter.
7+
8+
### Creating a client
9+
Below shows examples of how to create a client in multiple languages:
10+
11+
{% codetabs name="Golang", type="go" -%}
12+
import (
13+
clusterclient "github.com/libopenstorage/openstorage/api/client/cluster"
14+
"github.com/libopenstorage/openstorage/cluster"
15+
)
16+
17+
// Create a client setup to talk to a specific node URL
18+
c, err := clusterclient.NewClusterClient(url, "v1")
19+
if err != nil {
20+
return err
21+
}
22+
23+
// Create a manager which is an implementation of the
24+
// cluster.Cluster interface
25+
m := clusterclient.ClusterManager(c)
26+
27+
// Example - Enumerate
28+
resp, err := m.Enumerate()
29+
30+
{%- language name="Python", type="py" -%}
31+
TBD
32+
{%- endcodetabs %}
33+
34+
35+
## Reference
36+
37+
* [Golang](https://godoc.org/github.com/libopenstorage/openstorage/cluster#Cluster)

docs/clusters/alerts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Alerts

docs/clusters/enumerate.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Enumerate

docs/clusters/getnodeidfromip.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Get node ID from IP

docs/clusters/inspect.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Inspect

docs/clusters/status.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Status

docs/clusters/versions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Versions

0 commit comments

Comments
 (0)