You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2021/07/05 19:13:04 UTC
[GitHub] [kafka] kpatelatwork opened a new pull request #10975: KAFKA-13035 updated documentation for connector restart REST API to …
kpatelatwork opened a new pull request #10975:
URL: https://github.com/apache/kafka/pull/10975
…include the tasks restart behavior
Targets AK 3.0.0 where KAFKA-4793 will get released.
@kkonstantine and @rhauch Could you please review and see if the changes look good.
### Committer Checklist (excluded from commit message)
- [ ] Verify design and implementation
- [ ] Verify test coverage and CI build status
- [ ] Verify documentation (including upgrade notes)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] kpatelatwork commented on pull request #10975: KAFKA-13035 updated documentation for connector restart REST API to …
Posted by GitBox <gi...@apache.org>.
kpatelatwork commented on pull request #10975:
URL: https://github.com/apache/kafka/pull/10975#issuecomment-874289811
This is how formatting looks locally
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] rhauch merged pull request #10975: KAFKA-13035 updated documentation for connector restart REST API to …
Posted by GitBox <gi...@apache.org>.
rhauch merged pull request #10975:
URL: https://github.com/apache/kafka/pull/10975
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] kpatelatwork commented on a change in pull request #10975: KAFKA-13035 updated documentation for connector restart REST API to …
Posted by GitBox <gi...@apache.org>.
kpatelatwork commented on a change in pull request #10975:
URL: https://github.com/apache/kafka/pull/10975#discussion_r664677454
##########
File path: docs/connect.html
##########
@@ -310,7 +310,12 @@ <h4><a id="connect_rest" href="#connect_rest">REST API</a></h4>
<li><code>GET /connectors/{name}/tasks/{taskid}/status</code> - get current status of the task, including if it is running, failed, paused, etc., which worker it is assigned to, and error information if it has failed</li>
<li><code>PUT /connectors/{name}/pause</code> - pause the connector and its tasks, which stops message processing until the connector is resumed</li>
<li><code>PUT /connectors/{name}/resume</code> - resume a paused connector (or do nothing if the connector is not paused)</li>
- <li><code>POST /connectors/{name}/restart</code> - restart a connector (typically because it has failed)</li>
+ <li><code>POST /connectors/{name}/restart?includeTasks=<true|false>&onlyFailed=<true|false></code> - restart a connector and its tasks instances.
+ <ul>
+ <li>the "includeTasks" parameter specifies whether to restart the connector instance and task instances ("includeTasks=true") or just the connector instance ("includeTasks=false"), and defaults to "false".</li>
+ <li>the "onlyFailed" parameter specifies whether to restart just the instances with a FAILED status ("onlyFailed=true") or all instances ("onlyFailed=false"), and defaults to "false".</li>
Review comment:
Fixed
##########
File path: docs/connect.html
##########
@@ -310,7 +310,12 @@ <h4><a id="connect_rest" href="#connect_rest">REST API</a></h4>
<li><code>GET /connectors/{name}/tasks/{taskid}/status</code> - get current status of the task, including if it is running, failed, paused, etc., which worker it is assigned to, and error information if it has failed</li>
<li><code>PUT /connectors/{name}/pause</code> - pause the connector and its tasks, which stops message processing until the connector is resumed</li>
<li><code>PUT /connectors/{name}/resume</code> - resume a paused connector (or do nothing if the connector is not paused)</li>
- <li><code>POST /connectors/{name}/restart</code> - restart a connector (typically because it has failed)</li>
+ <li><code>POST /connectors/{name}/restart?includeTasks=<true|false>&onlyFailed=<true|false></code> - restart a connector and its tasks instances.
+ <ul>
+ <li>the "includeTasks" parameter specifies whether to restart the connector instance and task instances ("includeTasks=true") or just the connector instance ("includeTasks=false"), and defaults to "false".</li>
Review comment:
Fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] kpatelatwork commented on pull request #10975: KAFKA-13035 updated documentation for connector restart REST API to …
Posted by GitBox <gi...@apache.org>.
kpatelatwork commented on pull request #10975:
URL: https://github.com/apache/kafka/pull/10975#issuecomment-874876791
@rhauch great call about the backward compatibility note, I applied the suggestions. When you get time, could you please check again if it looks good?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] kpatelatwork commented on pull request #10975: KAFKA-13035 updated documentation for connector restart REST API to …
Posted by GitBox <gi...@apache.org>.
kpatelatwork commented on pull request #10975:
URL: https://github.com/apache/kafka/pull/10975#issuecomment-874289811
This is how formatting looks locally
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] rhauch commented on a change in pull request #10975: KAFKA-13035 updated documentation for connector restart REST API to …
Posted by GitBox <gi...@apache.org>.
rhauch commented on a change in pull request #10975:
URL: https://github.com/apache/kafka/pull/10975#discussion_r664659210
##########
File path: docs/connect.html
##########
@@ -310,7 +310,12 @@ <h4><a id="connect_rest" href="#connect_rest">REST API</a></h4>
<li><code>GET /connectors/{name}/tasks/{taskid}/status</code> - get current status of the task, including if it is running, failed, paused, etc., which worker it is assigned to, and error information if it has failed</li>
<li><code>PUT /connectors/{name}/pause</code> - pause the connector and its tasks, which stops message processing until the connector is resumed</li>
<li><code>PUT /connectors/{name}/resume</code> - resume a paused connector (or do nothing if the connector is not paused)</li>
- <li><code>POST /connectors/{name}/restart</code> - restart a connector (typically because it has failed)</li>
+ <li><code>POST /connectors/{name}/restart?includeTasks=<true|false>&onlyFailed=<true|false></code> - restart a connector and its tasks instances.
+ <ul>
+ <li>the "includeTasks" parameter specifies whether to restart the connector instance and task instances ("includeTasks=true") or just the connector instance ("includeTasks=false"), and defaults to "false".</li>
+ <li>the "onlyFailed" parameter specifies whether to restart just the instances with a FAILED status ("onlyFailed=true") or all instances ("onlyFailed=false"), and defaults to "false".</li>
Review comment:
```suggestion
<li>the "onlyFailed" parameter specifies whether to restart just the instances with a FAILED status ("onlyFailed=true") or all instances ("onlyFailed=false"), with the default ("false") preserving the same behavior as earlier versions.</li>
```
##########
File path: docs/connect.html
##########
@@ -310,7 +310,12 @@ <h4><a id="connect_rest" href="#connect_rest">REST API</a></h4>
<li><code>GET /connectors/{name}/tasks/{taskid}/status</code> - get current status of the task, including if it is running, failed, paused, etc., which worker it is assigned to, and error information if it has failed</li>
<li><code>PUT /connectors/{name}/pause</code> - pause the connector and its tasks, which stops message processing until the connector is resumed</li>
<li><code>PUT /connectors/{name}/resume</code> - resume a paused connector (or do nothing if the connector is not paused)</li>
- <li><code>POST /connectors/{name}/restart</code> - restart a connector (typically because it has failed)</li>
+ <li><code>POST /connectors/{name}/restart?includeTasks=<true|false>&onlyFailed=<true|false></code> - restart a connector and its tasks instances.
+ <ul>
+ <li>the "includeTasks" parameter specifies whether to restart the connector instance and task instances ("includeTasks=true") or just the connector instance ("includeTasks=false"), and defaults to "false".</li>
Review comment:
Let's mention maintaining backward compatibility:
```suggestion
<li>the "includeTasks" parameter specifies whether to restart the connector instance and task instances ("includeTasks=true") or just the connector instance ("includeTasks=false"), with the default ("false") preserving the same behavior as earlier versions.</li>
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org