Skip to content

Commit

Permalink
release: make api-promote
Browse files Browse the repository at this point in the history 
Signed-off-by: Sven Anderson <[email protected]>
  • Loading branch information
@ansiwen @mergify
ansiwen authored and mergify[bot] committed Dec 17, 2024
1 parent 96f4c44 commit 366fda6
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 55 deletions.
61 changes: 31 additions & 30 deletions docs/api-status.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1139,27 +1139,27 @@
"comment": "RequiresAlignment returns true if the pool supports/requires alignment or an error if not successful.\nFor an EC pool, a buffer size multiple of its stripe size is required to call Append. See\nAlignment to know how to get the stripe size for pools requiring it.\n\nImplements:\n int rados_ioctx_pool_requires_alignment2(rados_ioctx_t io, int *req)\n",
"added_in_version": "v0.17.0",
"became_stable_version": "v0.19.0"
}
],
"preview_api": [
},
{
"name": "ReadOpExecStep.Bytes",
"comment": "Bytes returns the result of the executed command as a byte slice.\n",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "ReadOp.Exec",
"comment": "Exec executes an OSD class method on an object.\nSee rados_exec() in the RADOS C api documentation for a general description.\n\nImplements:\n\n\tvoid rados_read_op_exec(rados_read_op_t read_op,\n\t const char *cls,\n\t const char *method,\n\t const char *in_buf,\n\t size_t in_len,\n\t char **out_buf,\n\t size_t *out_len,\n\t int *prval);\n",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "WriteOp.Exec",
"comment": "Exec executes an OSD class method on an object.\nSee rados_exec() in the RADOS C api documentation for a general description.\n\nImplements:\n\n\tvoid rados_write_op_exec(rados_write_op_t write_op,\n\t const char *cls,\n\t const char *method,\n\t const char *in_buf,\n\t size_t in_len,\n\t int *prval)\n",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
},
"became_stable_version": "v0.31.0"
}
],
"preview_api": [
{
"name": "Conn.GetAddrs",
"comment": "GetAddrs returns the addresses of the RADOS session,\nsuitable for blocklisting.\n\nImplements:\n\n\tint rados_getaddrs(rados_t cluster, char **addrs)\n",
Expand Down Expand Up @@ -1939,15 +1939,15 @@
"comment": "GetSnapGroupNamespace returns the SnapGroupNamespace of the snapshot which\nis part of a group. The caller should make sure that the snapshot ID passed\nin this function belongs to a snapshot that was taken as part of a group\nsnapshot.\n\nImplements:\n\n\t\tint rbd_snap_get_group_namespace(rbd_image_t image, uint64_t snap_id,\n\t rbd_snap_group_namespace_t *group_snap,\n\t size_t group_snap_size)\n",
"added_in_version": "v0.27.0",
"became_stable_version": "v0.29.0"
}
],
"preview_api": [
},
{
"name": "CloneImageByID",
"comment": "CloneImageByID creates a clone of the image from a snapshot with the given\nID in the provided io-context with the given name and image options.\n\nImplements:\n\n\tint rbd_clone4(rados_ioctx_t p_ioctx, const char *p_name,\n\t uint64_t p_snap_id, rados_ioctx_t c_ioctx,\n\t const char *c_name, rbd_image_options_t c_opts);\n",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
},
"became_stable_version": "v0.31.0"
}
],
"preview_api": [
{
"name": "GroupSnapGetInfo",
"comment": "GroupSnapGetInfo returns a slice of RBD image snapshots that are part of a\ngroup snapshot.\n\nImplements:\n\n\tint rbd_group_snap_get_info(rados_ioctx_t group_p,\n\t const char *group_name,\n\t const char *snap_name,\n\t rbd_group_snap_info2_t *snaps);\n",
Expand Down Expand Up @@ -2257,108 +2257,109 @@
]
},
"rados/striper": {
"preview_api": [
"preview_api": [],
"stable_api": [
{
"name": "Striper.Read",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.Stat",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "New",
"comment": "New returns a rados Striper object created from a rados IOContext.\n",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "NewWithLayout",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.Destroy",
"comment": "Destroy the radosstriper object at the Ceph API level.\n",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.SetObjectLayoutStripeUnit",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.SetObjectLayoutStripeCount",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.SetObjectLayoutObjectSize",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.Write",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.WriteFull",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.Append",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.Remove",
"comment": "Remove a striped RADOS object.\n\nImplements:\n\n\tint rados_striper_remove(rados_striper_t striper,\n\t const char *soid);\n",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.Truncate",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.GetXattr",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.SetXattr",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.RmXattr",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
},
{
"name": "Striper.ListXattrs",
"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",
"added_in_version": "v0.29.0",
"expected_stable_version": "v0.31.0"
"became_stable_version": "v0.31.0"
}
]
}
Expand Down
26 changes: 1 addition & 25 deletions docs/api-status.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ No Preview/Deprecated APIs found. All APIs are considered stable.

Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
ReadOpExecStep.Bytes | v0.29.0 | v0.31.0 |
ReadOp.Exec | v0.29.0 | v0.31.0 |
WriteOp.Exec | v0.29.0 | v0.31.0 |
Conn.GetAddrs | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |

## Package: rbd
Expand All @@ -27,7 +24,6 @@ Conn.GetAddrs | $NEXT_RELEASE | $NEXT_RELEASE_STABLE |

Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
CloneImageByID | v0.29.0 | v0.31.0 |
GroupSnapGetInfo | v0.30.0 | v0.32.0 |

### Deprecated APIs
Expand Down Expand Up @@ -60,25 +56,5 @@ No Preview/Deprecated APIs found. All APIs are considered stable.

## Package: rados/striper

### Preview APIs

Name | Added in Version | Expected Stable Version |
---- | ---------------- | ----------------------- |
Striper.Read | v0.29.0 | v0.31.0 |
Striper.Stat | v0.29.0 | v0.31.0 |
New | v0.29.0 | v0.31.0 |
NewWithLayout | v0.29.0 | v0.31.0 |
Striper.Destroy | v0.29.0 | v0.31.0 |
Striper.SetObjectLayoutStripeUnit | v0.29.0 | v0.31.0 |
Striper.SetObjectLayoutStripeCount | v0.29.0 | v0.31.0 |
Striper.SetObjectLayoutObjectSize | v0.29.0 | v0.31.0 |
Striper.Write | v0.29.0 | v0.31.0 |
Striper.WriteFull | v0.29.0 | v0.31.0 |
Striper.Append | v0.29.0 | v0.31.0 |
Striper.Remove | v0.29.0 | v0.31.0 |
Striper.Truncate | v0.29.0 | v0.31.0 |
Striper.GetXattr | v0.29.0 | v0.31.0 |
Striper.SetXattr | v0.29.0 | v0.31.0 |
Striper.RmXattr | v0.29.0 | v0.31.0 |
Striper.ListXattrs | v0.29.0 | v0.31.0 |
No Preview/Deprecated APIs found. All APIs are considered stable.

0 comments on commit 366fda6

Please sign in to comment.