[
https://issues.apache.org/jira/browse/CASSSIDECAR-266?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18003927#comment-18003927
]
Yifan Cai commented on CASSSIDECAR-266:
---------------------------------------
Thanks for putting together the updated API docs. It is more consistent with
the existing APIs. Listing a few observations below.
Sidecar APIs do not currently declare {{nodeId}} / {{instanceId}} as path
parameter, as proposed in "{{POST /api/v1/cassandra/lifecycle/<nodeId>}}".
There are currently two ways to locate a local node it manages.
1. Extracting the {{instanceId}} from *_query parameter_*, e.g.
{{/api/...?instanceId=1}}.
2. Extracting the {{hostname}} of the managed Cassandra node from the uri, e.g.
{{[node1_hostname]:9043/api/...}}
The implementation details can be found at
{{org.apache.cassandra.sidecar.handlers.AbstractHandler#host}}. (Note that the
javadoc of the method is incorrect).
After removing the path parameter {{nodeId}}, the endpoints becomes more
succinct as the following.
- {{POST /api/v1/cassandra/lifecycle}}
- {{GET /api/v1/cassandra/lifecycle}}
> Implement lifecycle APIs for safely stopping, starting, and restarting local
> Cassandra instances
> -------------------------------------------------------------------------------------------------
>
> Key: CASSSIDECAR-266
> URL: https://issues.apache.org/jira/browse/CASSSIDECAR-266
> Project: Sidecar for Apache Cassandra
> Issue Type: New Feature
> Components: Rest API
> Reporter: Andres Beck-Ruiz
> Priority: Normal
>
> We would like to implement APIs to safely stop, start, and restart local
> connected Cassandra instances through Cassandra Sidecar in a generic way.
> This could lead to future work to implement Cassandra native rolling restarts
> in Sidecar and automate the Cassandra upgrade process.
> We propose implementing an {{AbstractLifecycleOperationsHandler}} interface
> that defines start, stop, restart, and status endpoints to allow Sidecar
> operators to implement their own lifecycle handlers, depending on how they
> host their Cassandra processes. To provide a default implementation, we would
> create a {{LocalProcessLifecycleOperationsHandler}} to implement this
> interface and provide lifecycle operations for OS native Cassandra processes.
> This could be defined as the default lifecycle manager in
> {{{}sidecar.yaml{}}}, disabled by default.
> We propose the following APIs, leveraging the {{OperationalJob}} interface to
> provide support for async non-blocking jobs. We will use the existing
> implemented {{OperationalJobRoute}} ,
> {{/api/v1/cassandra/operational-jobs/:operationId}} , to track the status of
> these jobs. These endpoints will live under a {{/node}} path to specify
> operations on the local connected Cassandra instance, allowing for future
> development of lifecycle endpoints for an entire Cassandra cluster:
> h5. *GET /api/v1/cassandra/operations/lifecycle/node/status*
> Gets the status of whether the local Cassandra process is running.
> h6. Response
> * 200 Ok
> ** {{cassandra_running :: bool}}
> * 500 Internal Sever Error
> ** {{error :: string}}
> h5. *POST /api/v1/cassandra/operations/lifecycle/node/start*
> Start the connected Cassandra process. This request will succeed if the
> process is already started to ensure idempotency.
> h6. Parameters
> * {{block :: boolean (default False)}}
> h6. Response
> * 202 Accepted
> ** {{operationId :: string}}
> * 500 Internal Sever Error
> ** {{error :: string}}
> h5. *POST /api/v1/cassandra/operations/lifecycle/node/stop*
> Stop the connected Cassandra process after a pluggable health check passes.
> This request will succeed if the process is already stopped to ensure
> idempotency.
> h6. Parameters
> * {{block :: boolean (default False)}}
> * {{skipHealthCheck :: boolean (default False)}}
> h6. Response
> * 202 Accepted
> ** {{operationId :: string}}
> * 412 Precondition Failed
> ** {{error :: string (health check fails)}}
> * 500 Internal Sever Error
> ** {{error :: string}}
> h5. *POST /api/v1/cassandra/operations/lifecycle/node/restart*
> Restart the connected Cassandra process after a pluggable health check
> passes.
> h6. Parameters
> * {{block :: boolean (default False)}}
> * {{skipHealthCheck :: boolean (default False)}}
> h6. Response
> * 202 Accepted
> ** {{operationId :: string}}
> * 412 Precondition Failed
> ** {{error :: string (health check fails)}}
> * 500 Internal Sever Error
> ** {{error :: string}}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org
