Skip to content

Commit ce09b64

Browse files
lpabonlpabon
committed
Next is installing
1 parent 519cb8a commit ce09b64

72 files changed

Lines changed: 202 additions & 327 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/README.md‎

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,43 @@
11
# OpenStorage Library API
22

3-
![sdk.png](images/sdk.png)
43

54
## Introduction
6-
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.
5+
Welcome to the _OpenStorage Library API_ documentation. Here you will find the
6+
API functions, examples, and references to multiple client libraries which can
7+
communicate with a OpenStorage REST server.
78

8-
## Status
9-
This document is under heavy development. Please check back for the latest changes.
9+
## Quick Example
10+
Here is a super quick example of how to get cluster information from an OpenStorage
11+
server using a mock container running the gRPC server and using [Polyglot](https://github.com/grpc-ecosystem/polyglot) as the gRPC client.
12+
13+
```
14+
$ docker run -d -p 9100:9100 openstorage/mock-sdk-server
15+
$ wget https://github.com/grpc-ecosystem/polyglot/releases/download/v1.6.0/polyglot.jar
16+
$ echo {} | java -jar polyglot.jar \
17+
--command=call \
18+
--endpoint=localhost:9100 \
19+
--full_method=openstorage.api.OpenStorageCluster/Enumerate
20+
```
21+
22+
Results in:
23+
24+
```yaml
25+
{
26+
"cluster": {
27+
"status": "STATUS_OK",
28+
"id": "deadbeeef",
29+
"nodeId": "1",
30+
"nodes": [{
31+
"id": "1",
32+
"cpu": 0.4993757802746567,
33+
"memTotal": "8320278528",
34+
"memUsed": "1895813120",
35+
"memFree": "6424465408",
36+
"status": "STATUS_OK",
37+
"mgmtIp": "172.17.0.2",
38+
"dataIp": "172.17.0.2",
39+
"hostname": "42f9d528292c"
40+
}]
41+
}
42+
}
43+
```

‎docs/arch.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
# Architecture
1+
# Architecture
2+
3+
![arch.png](images/arch.png)
4+
5+
## Overview
6+
The software development kit for OpenStorage is based on [gRPC](https://grpc.io/),
7+
allowing clients to be automatically generated in multiple languages.
8+
9+
Different OpenStorage drivers may run the OpenStorage gRPC server on different
10+
locations. Please, refer to your deployed driver documentation for instructions
11+
on how to setup a connection to the gRPC server.
12+
13+
In this document, examples will refer to both the [OpenStorage SDK Mock](installing.md)
14+
and Portworx drivers.
15+
16+
## Clients
17+
Currently, OpenStorage provides Python, Ruby, Golang, and JavaScript bindings
18+
under the [`api/client/sdk`](https://github.com/libopenstorage/openstorage/tree/master/api/client/sdk)
19+
directory. If your client is not available, please feel free to generate one
20+
from the [`api.proto`](https://github.com/libopenstorage/openstorage/blob/master/api/api.proto)
21+
file on OpenStorage.

‎docs/images/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
HAS_DITAA := $(shell command -v ditaa 2> /dev/null)
22

3-
DITAA_IMAGES := arch.png sdk.png
3+
DITAA_IMAGES := arch.png
44
DITAA_SRCS := $(patsubst %.png,%.ditaa,$(DITAA_IMAGES))
55

66
all: $(DITAA_IMAGES)

‎docs/images/arch.ditaa‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1-
+----------------------------------+
2-
| |
3-
| gRPC SDK |
4-
| |
5-
+----------------------------------+
6-
| |
7-
| OpenStorage Interfaces |
8-
| |
9-
+----------------------------------+
1+
+---------------+ +----------------------------------+
2+
| | | |
3+
| gRPC Client | ----> | gRPC SDK |
4+
| | | |
5+
+---------------+ +----------------------------------+
6+
| |
7+
| OpenStorage Interfaces |
8+
| |
9+
+----------------------------------+
10+
| |
11+
| OpenStorage Driver |
12+
| |
13+
+----------------------------------+

‎docs/images/arch.png‎

3.72 KB
Loading

‎docs/images/sdk.ditaa‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎docs/images/sdk.png‎

-3.14 KB
Binary file not shown.

‎docs/installing.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Installing OpenStorage SDK
1+
# Installing OpenStorage SDK

‎docs/status.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1-
# Status
1+
# Status
2+
3+
We are currently working to releasing v0.1 of the SDK in **May of 2018**.
4+
5+
This document is under heavy development. Please check back for the latest
6+
changes.

‎w/Code.html‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1138,7 +1138,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
11381138
<script>
11391139
var gitbook = gitbook || [];
11401140
gitbook.push(function() {
1141-
gitbook.page.hasChanged({"page":{"title":"_Website tests","level":"3.1","depth":1,"next":{"title":"_WebTest","level":"3.1.1","depth":2,"path":"More.md","ref":"More.md","articles":[]},"previous":{"title":"enumerate","level":"2.3.5.10.3","depth":4,"path":"volumes/backups/scheds/enumerate.md","ref":"volumes/backups/scheds/enumerate.md","articles":[]},"dir":"ltr"},"config":{"plugins":["codetabs","toggle-chapters","toggle-headers","edit-link","prism","github","page-toc","-highlight","-sharing","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/libopenstorage/openstorage/"},"livereload":{},"search":{},"page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2","showByDefault":true},"codetabs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"toggle-headers":{},"fontsettings":{"theme":"white","family":"sans","size":2},"edit-link":{"label":"Edit this page","base":"https://github.com/libopenstorage/libopenstorage.github.io/tree/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":true},"toggle-chapters":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OpenStorage API","gitbook":">=3.2.1"},"file":{"path":"Code.md","mtime":"2018-03-28T18:16:34.603Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-30T12:11:57.898Z"},"basePath":".","book":{"language":""}});
1141+
gitbook.page.hasChanged({"page":{"title":"_Website tests","level":"3.1","depth":1,"next":{"title":"_WebTest","level":"3.1.1","depth":2,"path":"More.md","ref":"More.md","articles":[]},"previous":{"title":"enumerate","level":"2.3.5.10.3","depth":4,"path":"volumes/backups/scheds/enumerate.md","ref":"volumes/backups/scheds/enumerate.md","articles":[]},"dir":"ltr"},"config":{"plugins":["codetabs","toggle-chapters","toggle-headers","edit-link","prism","github","page-toc","-highlight","-sharing"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/libopenstorage/openstorage/"},"search":{},"page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2","showByDefault":true},"codetabs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"toggle-headers":{},"fontsettings":{"theme":"white","family":"sans","size":2},"edit-link":{"label":"Edit this page","base":"https://github.com/libopenstorage/libopenstorage.github.io/tree/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":true},"toggle-chapters":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OpenStorage API","gitbook":">=3.2.1"},"file":{"path":"Code.md","mtime":"2018-03-28T18:16:34.603Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-30T14:03:56.330Z"},"basePath":".","book":{"language":""}});
11421142
});
11431143
</script>
11441144
</div>
@@ -1176,10 +1176,6 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
11761176

11771177

11781178

1179-
<script src="gitbook/gitbook-plugin-livereload/plugin.js"></script>
1180-
1181-
1182-
11831179
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
11841180

11851181

0 commit comments

Comments
 (0)