Skip to content

Commit 6fa0723

Browse files
phlogistonjohnphlogistonjohn
committed
docs: add new rados/striper package to api status
Signed-off-by: John Mulligan <jmulligan@redhat.com>
1 parent a5978a4 commit 6fa0723

File tree

2 files changed

+131
-1
lines changed

2 files changed

+131
-1
lines changed

‎docs/api-status.json

+107-1
Original file line numberDiff line numberDiff line change
@@ -2264,5 +2264,111 @@
22642264
"became_stable_version": "v0.18.0"
22652265
}
22662266
]
2267+
},
2268+
"rados/striper": {
2269+
"preview_api": [
2270+
{
2271+
"name": "Striper.Read",
2272+
"comment": "Read bytes into data from the striped object at the specified offset.\n\nImplements:\n\n\tint rados_striper_read(rados_striper_t striper,\n\t const char *soid,\n\t const char *buf,\n\t size_t len,\n\t uint64_t off);\n",
2273+
"added_in_version": "$NEXT_RELEASE",
2274+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2275+
},
2276+
{
2277+
"name": "Striper.Stat",
2278+
"comment": "Stat returns metadata describing the striped object.\n\nImplements:\n\n\tint rados_striper_stat2(rados_striper_t striper,\n\t const char* soid,\n\t uint64_t *psize,\n\t struct timespec *pmtime);\n",
2279+
"added_in_version": "$NEXT_RELEASE",
2280+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2281+
},
2282+
{
2283+
"name": "New",
2284+
"comment": "New returns a rados Striper object created from a rados IOContext.\n",
2285+
"added_in_version": "$NEXT_RELEASE",
2286+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2287+
},
2288+
{
2289+
"name": "NewWithLayout",
2290+
"comment": "NewWithLayout returns a rados Striper object created from a rados IOContext\nand striper layout parameters. These parameters will be used when new\nobjects are created.\n",
2291+
"added_in_version": "$NEXT_RELEASE",
2292+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2293+
},
2294+
{
2295+
"name": "Striper.Destroy",
2296+
"comment": "Destroy the radosstriper object at the Ceph API level.\n",
2297+
"added_in_version": "$NEXT_RELEASE",
2298+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2299+
},
2300+
{
2301+
"name": "Striper.SetObjectLayoutStripeUnit",
2302+
"comment": "SetObjectLayoutStripeUnit sets the stripe unit value used to layout\nnew objects.\n\nImplements:\n\n\tint rados_striper_set_object_layout_stripe_unit(rados_striper_t striper,\n\t unsigned int stripe_unit);\n",
2303+
"added_in_version": "$NEXT_RELEASE",
2304+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2305+
},
2306+
{
2307+
"name": "Striper.SetObjectLayoutStripeCount",
2308+
"comment": "SetObjectLayoutStripeCount sets the stripe count value used to layout\nnew objects.\n\nImplements:\n\n\tint rados_striper_set_object_layout_stripe_count(rados_striper_t striper,\n\t unsigned int stripe_count);\n",
2309+
"added_in_version": "$NEXT_RELEASE",
2310+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2311+
},
2312+
{
2313+
"name": "Striper.SetObjectLayoutObjectSize",
2314+
"comment": "SetObjectLayoutObjectSize sets the object size value used to layout\nnew objects.\n\nImplements:\n\n\tint rados_striper_set_object_layout_object_size(rados_striper_t striper,\n\t unsigned int object_size);\n",
2315+
"added_in_version": "$NEXT_RELEASE",
2316+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2317+
},
2318+
{
2319+
"name": "Striper.Write",
2320+
"comment": "Write bytes from data into the striped object at the specified offset.\n\nImplements:\n\n\tint rados_striper_write(rados_striper_t striper,\n\t const char *soid,\n\t const char *buf,\n\t size_t len,\n\t uint64_t off);\n",
2321+
"added_in_version": "$NEXT_RELEASE",
2322+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2323+
},
2324+
{
2325+
"name": "Striper.WriteFull",
2326+
"comment": "WriteFull writes all of the bytes in data to the striped object, truncating\nthe object to the length of data.\n\nImplements:\n\n\tint rados_striper_write_full(rados_striper_t striper,\n\t const char *soid,\n\t const char *buf,\n\t size_t len);\n",
2327+
"added_in_version": "$NEXT_RELEASE",
2328+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2329+
},
2330+
{
2331+
"name": "Striper.Append",
2332+
"comment": "Append the bytes in data to the end of the striped object.\n\nImplements:\n\n\tint rados_striper_append(rados_striper_t striper,\n\t const char *soid,\n\t const char *buf,\n\t size_t len);\n",
2333+
"added_in_version": "$NEXT_RELEASE",
2334+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2335+
},
2336+
{
2337+
"name": "Striper.Remove",
2338+
"comment": "Remove a striped RADOS object.\n\nImplements:\n\n\tint rados_striper_remove(rados_striper_t striper,\n\t const char *soid);\n",
2339+
"added_in_version": "$NEXT_RELEASE",
2340+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2341+
},
2342+
{
2343+
"name": "Striper.Truncate",
2344+
"comment": "Truncate a striped object, setting it to the specified size.\n\nImplements:\n\n\tint rados_striper_trunc(rados_striper_t striper, const char *soid, uint64_t size);\n",
2345+
"added_in_version": "$NEXT_RELEASE",
2346+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2347+
},
2348+
{
2349+
"name": "Striper.GetXattr",
2350+
"comment": "GetXattr retrieves an extended attribute (xattr) of the given name from the\nspecified striped object.\n\nImplements:\n\n\tint rados_striper_getxattr(rados_striper_t striper,\n\t const char *oid,\n\t const char *name,\n\t char *buf,\n\t size_t len);\n",
2351+
"added_in_version": "$NEXT_RELEASE",
2352+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2353+
},
2354+
{
2355+
"name": "Striper.SetXattr",
2356+
"comment": "SetXattr sets an extended attribute (xattr) of the given name on the\nspecified striped object.\n\nImplements:\n\n\tint rados_striper_setxattr(rados_striper_t striper,\n\t const char *oid,\n\t const char *name,\n\t const char *buf,\n\t size_t len);\n",
2357+
"added_in_version": "$NEXT_RELEASE",
2358+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2359+
},
2360+
{
2361+
"name": "Striper.RmXattr",
2362+
"comment": "RmXattr removes the extended attribute (xattr) of the given name from the\nstriped object.\n\nImplements:\n\n\tint rados_striper_rmxattr(rados_striper_t striper,\n\t const char *oid,\n\t const char *name);\n",
2363+
"added_in_version": "$NEXT_RELEASE",
2364+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2365+
},
2366+
{
2367+
"name": "Striper.ListXattrs",
2368+
"comment": "ListXattrs returns a map containing all of the extended attributes (xattrs)\nfor a striped object. The xattr names provide the key strings and the map's\nvalues are byte slices.\n\nImplements:\n\n\tint rados_striper_getxattrs(rados_striper_t striper,\n\t const char *oid,\n\t rados_xattrs_iter_t *iter);\n",
2369+
"added_in_version": "$NEXT_RELEASE",
2370+
"expected_stable_version": "$NEXT_RELEASE_STABLE"
2371+
}
2372+
]
22672373
}
2268-
}
2374+
}

‎docs/api-status.md

+24
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,27 @@ No Preview/Deprecated APIs found. All APIs are considered stable.
6161

6262
No Preview/Deprecated APIs found. All APIs are considered stable.
6363

64+
## Package: rados/striper
65+
66+
### Preview APIs
67+
68+
Name | Added in Version | Expected Stable Version |
69+
---- | ---------------- | ----------------------- |
70+
Striper.Read | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
71+
Striper.Stat | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
72+
New | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
73+
NewWithLayout | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
74+
Striper.Destroy | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
75+
Striper.SetObjectLayoutStripeUnit | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
76+
Striper.SetObjectLayoutStripeCount | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
77+
Striper.SetObjectLayoutObjectSize | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
78+
Striper.Write | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
79+
Striper.WriteFull | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
80+
Striper.Append | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
81+
Striper.Remove | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
82+
Striper.Truncate | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
83+
Striper.GetXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
84+
Striper.SetXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
85+
Striper.RmXattr | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
86+
Striper.ListXattrs | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |
87+

0 commit comments

Comments
 (0)