Skip to content

Commit 8c7fadb

Browse files
authored
Merge pull request #26 from nguptaopensds/guide
[Developer-Guide]Added developer guide for object lifecycle management
2 parents fc585aa + e1cf008 commit 8c7fadb

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

content/guides/developer-guides/object-lifecycle-management/_index.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,20 @@ disableToc: false
66
tags: ["developer guide", "object lifecycle"]
77
---
88
## Overview
9-
This guide is intended for Object Lifecycle feature developers. It provides detailed steps to write new API using OpenSDS. To understand the feature and requirements in detail, please refer to the Object Lifecycle Management user guide and Object Lifecycle design doc.
9+
10+
This guide is intended for Object Lifecycle feature developers. It provides detailed steps to write new API using OpenSDS. To understand the feature and requirements in detail, please refer to the Object Lifecycle Management [user guide](/guides/user-guides/object-lifecycle-management/) and Object Lifecycle [design spec](https://github.com/opensds/design-specs/blob/master/specs/capri/object_lifecycle_management.md).
11+
1012

1113
## APIs
1214
APIs are a set of functions and procedures that allow for the creation of applications that access data and features of other applications, services or operating system. In OpenSDS lifecycle management feature we are using APIs to communicate with different storage backend.
1315

16+
17+
### Write new API
18+
Before starting to write the APIs, it is required to have basic understanding of XML and JSON syntax.
19+
20+
#### There are three major steps involved:
21+
a) All APIs go into the 's3' module of the OpenSDS multi-cloud package, i,e. opensds/multi-cloud/api/pkg/s3 directory
22+
=======
1423
## Write new API
1524
Before starting to write the APIs, it is required to have basic understanding of XML and JSON syntax.
1625

@@ -76,7 +85,9 @@ eea40a48de97 wurstmeister/zookeeper "/bin/sh -c '/usr/sb…"
7685

7786
To check if the API changes are reflected in database, install mongoDB compass and check the metadata of the buckets
7887

79-
![mongo connection image ](opensds_mongo.PNG?raw=true)
88+
89+
![mongo connection image ](opensds_mongo.png?raw=true)
90+
8091

8192
#### The postman request for API call:
8293

93.2 KB
Loading

0 commit comments

Comments
 (0)