Skip to content

add documentation for the server & client side timeout - #1467

Merged
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout
Jul 15, 2021
Merged

add documentation for the server & client side timeout#1467
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout

Conversation

@Priyankasaggu11929

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR documents information about server-side & client-side timeout in the examples/pod_namespace_watch.py example script.

Which issue(s) this PR fixes:

Fixes#1402

Does this PR introduce a user-facing change?

NONE

Signed-off-by: Priyanka Saggu priyankasaggu11929@gmail.com

@k8s-ci-robotk8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 14, 2021
@k8s-ci-robotk8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 14, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 1d1fcfa to 8bdb484CompareMay 14, 2021 13:45
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

Thank you @yliaog for all the pointers.

I'll read through the links to understand the concepts better, & will update the PR.

@Priyankasaggu11929Priyankasaggu11929 changed the title add documentation for the server & client side timeout[WIP] add documentation for the server & client side timeoutMay 15, 2021
@k8s-ci-robotk8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8bdb484 to 8fa80dcCompareMay 31, 2021 06:43
@k8s-ci-robotk8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 31, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8fa80dc to 2b40cdfCompareMay 31, 2021 06:44
@Priyankasaggu11929Priyankasaggu11929 changed the title [WIP] add documentation for the server & client side timeoutadd documentation for the server & client side timeoutMay 31, 2021
@k8s-ci-robotk8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've tried to redo the previous attempt of documentation, adding more information after reading & understanding through the links/pointers you provided above.

Please review. Thank you!

@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 2b40cdf to 9bb536cCompareMay 31, 2021 11:56
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
- *[kubernetes/apiserver/pkg/endpoints/handlers/get.go#L258](https://github.com/kubernetes/apiserver/blob/92392ef22153d75b3645b0ae339f89c12767fb52/pkg/endpoints/handlers/get.go#L258)*
- *[kubernetes/release-1.1/docs/admin/kube-apiserver.md](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/admin/kube-apiserver.md)*

- In case of a network outage, this timeout value will have no effect & the client will hang indefinitely without raising any exception.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what kind of network outage would cause this? it hangs when not accounting for the client side timeout described below, right?

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re:

what kind of network outage would cause this?

I'm not sure how to define or specify the what kind of network outage part. Could you please phrase it or point me somewhere that talks more about the kind of network outage, I'll read more & try to add a proper definition here.

Thank you!

Re:

It hangs when not accounting for the client side timeout described below, right?

I might be wrong with my understanding, but so far, what I understood is ~

that it is the server side timeout (i.e. value of argument timeout_seconds, that would have no effect in case of the said network outage),

but in the same network outage situation, if there is a client-side timeout value set (i.e. a value for argument _requests_timeout) then the client would honor that timeout duration value & would wait for the same before dropping the connection.

Just a pointer from this comment here ~ #1148 (comment)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, no hurries at all. Just pointing in case, it was missed!

could you please take a look at this review comment too, as what more could be done to improve this section here?

Thank you so much!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think probably add the condition that client side timeout is not specified, something like below:

this timeout value will have no effect & the client will hang indefinitely without raising any exception if client side timeout (see below) is not specified

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, Thank you for the pointers.

I'm rephrasing it as following: ~

In case of a network outage, the server side timeout value will have no effect & the client will hang indefinitely without raising any exception. Note, that this is the case provided when there is no other client-side timeout (i.e., _request_timeout) value specified.

(See the section below for information on client side timeout)

Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 9bb536c to fc95388CompareJune 2, 2021 03:45
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
Signed-off-by: Priyanka Saggu <priyankasaggu11929@gmail.com>
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from fc95388 to bfb3222CompareJune 2, 2021 18:03
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've updated the PR with the suggested review changes.

@yliaog

Copy link
Copy Markdown
Contributor

thanks for the pr
/lgtm
/approve

@k8s-ci-robotk8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robotk8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

/retest

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@Priyankasaggu11929: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roycaihw

Copy link
Copy Markdown
Member

travis-ci.org is in read-only mode

@roycaihw
roycaihw merged commit 0543412 into kubernetes-client:masterJul 15, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.cncf-cla: yesIndicates the PR's author has signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.lgtm"Looks good to me", indicates that a PR is ready to be merged.release-note-noneDenotes a PR that doesn't merit a release note.size/MDenotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client-side timeouts in watch

4 participants

@Priyankasaggu11929@yliaog@k8s-ci-robot@roycaihw
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
add documentation for the server & client side timeout by Priyankasaggu11929 · Pull Request #1467 · kubernetes-client/python · GitHub
Skip to content

add documentation for the server & client side timeout - #1467

Merged
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout
Jul 15, 2021
Merged

add documentation for the server & client side timeout#1467
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout

Conversation

@Priyankasaggu11929

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR documents information about server-side & client-side timeout in the examples/pod_namespace_watch.py example script.

Which issue(s) this PR fixes:

Fixes#1402

Does this PR introduce a user-facing change?

NONE

Signed-off-by: Priyanka Saggu priyankasaggu11929@gmail.com

@k8s-ci-robotk8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 14, 2021
@k8s-ci-robotk8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 14, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 1d1fcfa to 8bdb484CompareMay 14, 2021 13:45
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

Thank you @yliaog for all the pointers.

I'll read through the links to understand the concepts better, & will update the PR.

@Priyankasaggu11929Priyankasaggu11929 changed the title add documentation for the server & client side timeout[WIP] add documentation for the server & client side timeoutMay 15, 2021
@k8s-ci-robotk8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8bdb484 to 8fa80dcCompareMay 31, 2021 06:43
@k8s-ci-robotk8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 31, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8fa80dc to 2b40cdfCompareMay 31, 2021 06:44
@Priyankasaggu11929Priyankasaggu11929 changed the title [WIP] add documentation for the server & client side timeoutadd documentation for the server & client side timeoutMay 31, 2021
@k8s-ci-robotk8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've tried to redo the previous attempt of documentation, adding more information after reading & understanding through the links/pointers you provided above.

Please review. Thank you!

@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 2b40cdf to 9bb536cCompareMay 31, 2021 11:56
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
- *[kubernetes/apiserver/pkg/endpoints/handlers/get.go#L258](https://github.com/kubernetes/apiserver/blob/92392ef22153d75b3645b0ae339f89c12767fb52/pkg/endpoints/handlers/get.go#L258)*
- *[kubernetes/release-1.1/docs/admin/kube-apiserver.md](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/admin/kube-apiserver.md)*

- In case of a network outage, this timeout value will have no effect & the client will hang indefinitely without raising any exception.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what kind of network outage would cause this? it hangs when not accounting for the client side timeout described below, right?

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re:

what kind of network outage would cause this?

I'm not sure how to define or specify the what kind of network outage part. Could you please phrase it or point me somewhere that talks more about the kind of network outage, I'll read more & try to add a proper definition here.

Thank you!

Re:

It hangs when not accounting for the client side timeout described below, right?

I might be wrong with my understanding, but so far, what I understood is ~

that it is the server side timeout (i.e. value of argument timeout_seconds, that would have no effect in case of the said network outage),

but in the same network outage situation, if there is a client-side timeout value set (i.e. a value for argument _requests_timeout) then the client would honor that timeout duration value & would wait for the same before dropping the connection.

Just a pointer from this comment here ~ #1148 (comment)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, no hurries at all. Just pointing in case, it was missed!

could you please take a look at this review comment too, as what more could be done to improve this section here?

Thank you so much!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think probably add the condition that client side timeout is not specified, something like below:

this timeout value will have no effect & the client will hang indefinitely without raising any exception if client side timeout (see below) is not specified

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, Thank you for the pointers.

I'm rephrasing it as following: ~

In case of a network outage, the server side timeout value will have no effect & the client will hang indefinitely without raising any exception. Note, that this is the case provided when there is no other client-side timeout (i.e., _request_timeout) value specified.

(See the section below for information on client side timeout)

Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 9bb536c to fc95388CompareJune 2, 2021 03:45
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
Signed-off-by: Priyanka Saggu <priyankasaggu11929@gmail.com>
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from fc95388 to bfb3222CompareJune 2, 2021 18:03
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've updated the PR with the suggested review changes.

@yliaog

Copy link
Copy Markdown
Contributor

thanks for the pr
/lgtm
/approve

@k8s-ci-robotk8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robotk8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

/retest

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@Priyankasaggu11929: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roycaihw

Copy link
Copy Markdown
Member

travis-ci.org is in read-only mode

@roycaihw
roycaihw merged commit 0543412 into kubernetes-client:masterJul 15, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.cncf-cla: yesIndicates the PR's author has signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.lgtm"Looks good to me", indicates that a PR is ready to be merged.release-note-noneDenotes a PR that doesn't merit a release note.size/MDenotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client-side timeouts in watch

4 participants

@Priyankasaggu11929@yliaog@k8s-ci-robot@roycaihw
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' add documentation for the server & client side timeout by Priyankasaggu11929 · Pull Request #1467 · kubernetes-client/python · GitHub
Skip to content

add documentation for the server & client side timeout - #1467

Merged
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout
Jul 15, 2021
Merged

add documentation for the server & client side timeout#1467
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout

Conversation

@Priyankasaggu11929

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR documents information about server-side & client-side timeout in the examples/pod_namespace_watch.py example script.

Which issue(s) this PR fixes:

Fixes#1402

Does this PR introduce a user-facing change?

NONE

Signed-off-by: Priyanka Saggu priyankasaggu11929@gmail.com

@k8s-ci-robotk8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 14, 2021
@k8s-ci-robotk8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 14, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 1d1fcfa to 8bdb484CompareMay 14, 2021 13:45
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

Thank you @yliaog for all the pointers.

I'll read through the links to understand the concepts better, & will update the PR.

@Priyankasaggu11929Priyankasaggu11929 changed the title add documentation for the server & client side timeout[WIP] add documentation for the server & client side timeoutMay 15, 2021
@k8s-ci-robotk8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8bdb484 to 8fa80dcCompareMay 31, 2021 06:43
@k8s-ci-robotk8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 31, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8fa80dc to 2b40cdfCompareMay 31, 2021 06:44
@Priyankasaggu11929Priyankasaggu11929 changed the title [WIP] add documentation for the server & client side timeoutadd documentation for the server & client side timeoutMay 31, 2021
@k8s-ci-robotk8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've tried to redo the previous attempt of documentation, adding more information after reading & understanding through the links/pointers you provided above.

Please review. Thank you!

@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 2b40cdf to 9bb536cCompareMay 31, 2021 11:56
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
- *[kubernetes/apiserver/pkg/endpoints/handlers/get.go#L258](https://github.com/kubernetes/apiserver/blob/92392ef22153d75b3645b0ae339f89c12767fb52/pkg/endpoints/handlers/get.go#L258)*
- *[kubernetes/release-1.1/docs/admin/kube-apiserver.md](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/admin/kube-apiserver.md)*

- In case of a network outage, this timeout value will have no effect & the client will hang indefinitely without raising any exception.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what kind of network outage would cause this? it hangs when not accounting for the client side timeout described below, right?

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re:

what kind of network outage would cause this?

I'm not sure how to define or specify the what kind of network outage part. Could you please phrase it or point me somewhere that talks more about the kind of network outage, I'll read more & try to add a proper definition here.

Thank you!

Re:

It hangs when not accounting for the client side timeout described below, right?

I might be wrong with my understanding, but so far, what I understood is ~

that it is the server side timeout (i.e. value of argument timeout_seconds, that would have no effect in case of the said network outage),

but in the same network outage situation, if there is a client-side timeout value set (i.e. a value for argument _requests_timeout) then the client would honor that timeout duration value & would wait for the same before dropping the connection.

Just a pointer from this comment here ~ #1148 (comment)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, no hurries at all. Just pointing in case, it was missed!

could you please take a look at this review comment too, as what more could be done to improve this section here?

Thank you so much!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think probably add the condition that client side timeout is not specified, something like below:

this timeout value will have no effect & the client will hang indefinitely without raising any exception if client side timeout (see below) is not specified

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, Thank you for the pointers.

I'm rephrasing it as following: ~

In case of a network outage, the server side timeout value will have no effect & the client will hang indefinitely without raising any exception. Note, that this is the case provided when there is no other client-side timeout (i.e., _request_timeout) value specified.

(See the section below for information on client side timeout)

Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 9bb536c to fc95388CompareJune 2, 2021 03:45
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
Signed-off-by: Priyanka Saggu <priyankasaggu11929@gmail.com>
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from fc95388 to bfb3222CompareJune 2, 2021 18:03
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've updated the PR with the suggested review changes.

@yliaog

Copy link
Copy Markdown
Contributor

thanks for the pr
/lgtm
/approve

@k8s-ci-robotk8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robotk8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

/retest

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@Priyankasaggu11929: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roycaihw

Copy link
Copy Markdown
Member

travis-ci.org is in read-only mode

@roycaihw
roycaihw merged commit 0543412 into kubernetes-client:masterJul 15, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.cncf-cla: yesIndicates the PR's author has signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.lgtm"Looks good to me", indicates that a PR is ready to be merged.release-note-noneDenotes a PR that doesn't merit a release note.size/MDenotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client-side timeouts in watch

4 participants

@Priyankasaggu11929@yliaog@k8s-ci-robot@roycaihw
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' add documentation for the server & client side timeout by Priyankasaggu11929 · Pull Request #1467 · kubernetes-client/python · GitHub
Skip to content

add documentation for the server & client side timeout - #1467

Merged
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout
Jul 15, 2021
Merged

add documentation for the server & client side timeout#1467
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout

Conversation

@Priyankasaggu11929

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR documents information about server-side & client-side timeout in the examples/pod_namespace_watch.py example script.

Which issue(s) this PR fixes:

Fixes#1402

Does this PR introduce a user-facing change?

NONE

Signed-off-by: Priyanka Saggu priyankasaggu11929@gmail.com

@k8s-ci-robotk8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 14, 2021
@k8s-ci-robotk8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 14, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 1d1fcfa to 8bdb484CompareMay 14, 2021 13:45
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

Thank you @yliaog for all the pointers.

I'll read through the links to understand the concepts better, & will update the PR.

@Priyankasaggu11929Priyankasaggu11929 changed the title add documentation for the server & client side timeout[WIP] add documentation for the server & client side timeoutMay 15, 2021
@k8s-ci-robotk8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8bdb484 to 8fa80dcCompareMay 31, 2021 06:43
@k8s-ci-robotk8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 31, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8fa80dc to 2b40cdfCompareMay 31, 2021 06:44
@Priyankasaggu11929Priyankasaggu11929 changed the title [WIP] add documentation for the server & client side timeoutadd documentation for the server & client side timeoutMay 31, 2021
@k8s-ci-robotk8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've tried to redo the previous attempt of documentation, adding more information after reading & understanding through the links/pointers you provided above.

Please review. Thank you!

@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 2b40cdf to 9bb536cCompareMay 31, 2021 11:56
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
- *[kubernetes/apiserver/pkg/endpoints/handlers/get.go#L258](https://github.com/kubernetes/apiserver/blob/92392ef22153d75b3645b0ae339f89c12767fb52/pkg/endpoints/handlers/get.go#L258)*
- *[kubernetes/release-1.1/docs/admin/kube-apiserver.md](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/admin/kube-apiserver.md)*

- In case of a network outage, this timeout value will have no effect & the client will hang indefinitely without raising any exception.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what kind of network outage would cause this? it hangs when not accounting for the client side timeout described below, right?

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re:

what kind of network outage would cause this?

I'm not sure how to define or specify the what kind of network outage part. Could you please phrase it or point me somewhere that talks more about the kind of network outage, I'll read more & try to add a proper definition here.

Thank you!

Re:

It hangs when not accounting for the client side timeout described below, right?

I might be wrong with my understanding, but so far, what I understood is ~

that it is the server side timeout (i.e. value of argument timeout_seconds, that would have no effect in case of the said network outage),

but in the same network outage situation, if there is a client-side timeout value set (i.e. a value for argument _requests_timeout) then the client would honor that timeout duration value & would wait for the same before dropping the connection.

Just a pointer from this comment here ~ #1148 (comment)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, no hurries at all. Just pointing in case, it was missed!

could you please take a look at this review comment too, as what more could be done to improve this section here?

Thank you so much!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think probably add the condition that client side timeout is not specified, something like below:

this timeout value will have no effect & the client will hang indefinitely without raising any exception if client side timeout (see below) is not specified

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, Thank you for the pointers.

I'm rephrasing it as following: ~

In case of a network outage, the server side timeout value will have no effect & the client will hang indefinitely without raising any exception. Note, that this is the case provided when there is no other client-side timeout (i.e., _request_timeout) value specified.

(See the section below for information on client side timeout)

Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 9bb536c to fc95388CompareJune 2, 2021 03:45
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
Signed-off-by: Priyanka Saggu <priyankasaggu11929@gmail.com>
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from fc95388 to bfb3222CompareJune 2, 2021 18:03
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've updated the PR with the suggested review changes.

@yliaog

Copy link
Copy Markdown
Contributor

thanks for the pr
/lgtm
/approve

@k8s-ci-robotk8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robotk8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

/retest

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@Priyankasaggu11929: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roycaihw

Copy link
Copy Markdown
Member

travis-ci.org is in read-only mode

@roycaihw
roycaihw merged commit 0543412 into kubernetes-client:masterJul 15, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.cncf-cla: yesIndicates the PR's author has signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.lgtm"Looks good to me", indicates that a PR is ready to be merged.release-note-noneDenotes a PR that doesn't merit a release note.size/MDenotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client-side timeouts in watch

4 participants

@Priyankasaggu11929@yliaog@k8s-ci-robot@roycaihw
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' add documentation for the server & client side timeout by Priyankasaggu11929 · Pull Request #1467 · kubernetes-client/python · GitHub
Skip to content

add documentation for the server & client side timeout - #1467

Merged
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout
Jul 15, 2021
Merged

add documentation for the server & client side timeout#1467
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout

Conversation

@Priyankasaggu11929

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR documents information about server-side & client-side timeout in the examples/pod_namespace_watch.py example script.

Which issue(s) this PR fixes:

Fixes#1402

Does this PR introduce a user-facing change?

NONE

Signed-off-by: Priyanka Saggu priyankasaggu11929@gmail.com

@k8s-ci-robotk8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 14, 2021
@k8s-ci-robotk8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 14, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 1d1fcfa to 8bdb484CompareMay 14, 2021 13:45
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

Thank you @yliaog for all the pointers.

I'll read through the links to understand the concepts better, & will update the PR.

@Priyankasaggu11929Priyankasaggu11929 changed the title add documentation for the server & client side timeout[WIP] add documentation for the server & client side timeoutMay 15, 2021
@k8s-ci-robotk8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8bdb484 to 8fa80dcCompareMay 31, 2021 06:43
@k8s-ci-robotk8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 31, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8fa80dc to 2b40cdfCompareMay 31, 2021 06:44
@Priyankasaggu11929Priyankasaggu11929 changed the title [WIP] add documentation for the server & client side timeoutadd documentation for the server & client side timeoutMay 31, 2021
@k8s-ci-robotk8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've tried to redo the previous attempt of documentation, adding more information after reading & understanding through the links/pointers you provided above.

Please review. Thank you!

@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 2b40cdf to 9bb536cCompareMay 31, 2021 11:56
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
- *[kubernetes/apiserver/pkg/endpoints/handlers/get.go#L258](https://github.com/kubernetes/apiserver/blob/92392ef22153d75b3645b0ae339f89c12767fb52/pkg/endpoints/handlers/get.go#L258)*
- *[kubernetes/release-1.1/docs/admin/kube-apiserver.md](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/admin/kube-apiserver.md)*

- In case of a network outage, this timeout value will have no effect & the client will hang indefinitely without raising any exception.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what kind of network outage would cause this? it hangs when not accounting for the client side timeout described below, right?

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re:

what kind of network outage would cause this?

I'm not sure how to define or specify the what kind of network outage part. Could you please phrase it or point me somewhere that talks more about the kind of network outage, I'll read more & try to add a proper definition here.

Thank you!

Re:

It hangs when not accounting for the client side timeout described below, right?

I might be wrong with my understanding, but so far, what I understood is ~

that it is the server side timeout (i.e. value of argument timeout_seconds, that would have no effect in case of the said network outage),

but in the same network outage situation, if there is a client-side timeout value set (i.e. a value for argument _requests_timeout) then the client would honor that timeout duration value & would wait for the same before dropping the connection.

Just a pointer from this comment here ~ #1148 (comment)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, no hurries at all. Just pointing in case, it was missed!

could you please take a look at this review comment too, as what more could be done to improve this section here?

Thank you so much!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think probably add the condition that client side timeout is not specified, something like below:

this timeout value will have no effect & the client will hang indefinitely without raising any exception if client side timeout (see below) is not specified

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, Thank you for the pointers.

I'm rephrasing it as following: ~

In case of a network outage, the server side timeout value will have no effect & the client will hang indefinitely without raising any exception. Note, that this is the case provided when there is no other client-side timeout (i.e., _request_timeout) value specified.

(See the section below for information on client side timeout)

Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 9bb536c to fc95388CompareJune 2, 2021 03:45
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
Signed-off-by: Priyanka Saggu <priyankasaggu11929@gmail.com>
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from fc95388 to bfb3222CompareJune 2, 2021 18:03
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've updated the PR with the suggested review changes.

@yliaog

Copy link
Copy Markdown
Contributor

thanks for the pr
/lgtm
/approve

@k8s-ci-robotk8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robotk8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

/retest

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@Priyankasaggu11929: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roycaihw

Copy link
Copy Markdown
Member

travis-ci.org is in read-only mode

@roycaihw
roycaihw merged commit 0543412 into kubernetes-client:masterJul 15, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.cncf-cla: yesIndicates the PR's author has signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.lgtm"Looks good to me", indicates that a PR is ready to be merged.release-note-noneDenotes a PR that doesn't merit a release note.size/MDenotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client-side timeouts in watch

4 participants

@Priyankasaggu11929@yliaog@k8s-ci-robot@roycaihw
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' add documentation for the server & client side timeout by Priyankasaggu11929 · Pull Request #1467 · kubernetes-client/python · GitHub
Skip to content

add documentation for the server & client side timeout - #1467

Merged
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout
Jul 15, 2021
Merged

add documentation for the server & client side timeout#1467
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout

Conversation

@Priyankasaggu11929

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR documents information about server-side & client-side timeout in the examples/pod_namespace_watch.py example script.

Which issue(s) this PR fixes:

Fixes#1402

Does this PR introduce a user-facing change?

NONE

Signed-off-by: Priyanka Saggu priyankasaggu11929@gmail.com

@k8s-ci-robotk8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 14, 2021
@k8s-ci-robotk8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 14, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 1d1fcfa to 8bdb484CompareMay 14, 2021 13:45
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

Thank you @yliaog for all the pointers.

I'll read through the links to understand the concepts better, & will update the PR.

@Priyankasaggu11929Priyankasaggu11929 changed the title add documentation for the server & client side timeout[WIP] add documentation for the server & client side timeoutMay 15, 2021
@k8s-ci-robotk8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8bdb484 to 8fa80dcCompareMay 31, 2021 06:43
@k8s-ci-robotk8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 31, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8fa80dc to 2b40cdfCompareMay 31, 2021 06:44
@Priyankasaggu11929Priyankasaggu11929 changed the title [WIP] add documentation for the server & client side timeoutadd documentation for the server & client side timeoutMay 31, 2021
@k8s-ci-robotk8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've tried to redo the previous attempt of documentation, adding more information after reading & understanding through the links/pointers you provided above.

Please review. Thank you!

@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 2b40cdf to 9bb536cCompareMay 31, 2021 11:56
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
- *[kubernetes/apiserver/pkg/endpoints/handlers/get.go#L258](https://github.com/kubernetes/apiserver/blob/92392ef22153d75b3645b0ae339f89c12767fb52/pkg/endpoints/handlers/get.go#L258)*
- *[kubernetes/release-1.1/docs/admin/kube-apiserver.md](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/admin/kube-apiserver.md)*

- In case of a network outage, this timeout value will have no effect & the client will hang indefinitely without raising any exception.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what kind of network outage would cause this? it hangs when not accounting for the client side timeout described below, right?

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re:

what kind of network outage would cause this?

I'm not sure how to define or specify the what kind of network outage part. Could you please phrase it or point me somewhere that talks more about the kind of network outage, I'll read more & try to add a proper definition here.

Thank you!

Re:

It hangs when not accounting for the client side timeout described below, right?

I might be wrong with my understanding, but so far, what I understood is ~

that it is the server side timeout (i.e. value of argument timeout_seconds, that would have no effect in case of the said network outage),

but in the same network outage situation, if there is a client-side timeout value set (i.e. a value for argument _requests_timeout) then the client would honor that timeout duration value & would wait for the same before dropping the connection.

Just a pointer from this comment here ~ #1148 (comment)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, no hurries at all. Just pointing in case, it was missed!

could you please take a look at this review comment too, as what more could be done to improve this section here?

Thank you so much!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think probably add the condition that client side timeout is not specified, something like below:

this timeout value will have no effect & the client will hang indefinitely without raising any exception if client side timeout (see below) is not specified

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, Thank you for the pointers.

I'm rephrasing it as following: ~

In case of a network outage, the server side timeout value will have no effect & the client will hang indefinitely without raising any exception. Note, that this is the case provided when there is no other client-side timeout (i.e., _request_timeout) value specified.

(See the section below for information on client side timeout)

Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 9bb536c to fc95388CompareJune 2, 2021 03:45
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
Signed-off-by: Priyanka Saggu <priyankasaggu11929@gmail.com>
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from fc95388 to bfb3222CompareJune 2, 2021 18:03
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've updated the PR with the suggested review changes.

@yliaog

Copy link
Copy Markdown
Contributor

thanks for the pr
/lgtm
/approve

@k8s-ci-robotk8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robotk8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

/retest

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@Priyankasaggu11929: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roycaihw

Copy link
Copy Markdown
Member

travis-ci.org is in read-only mode

@roycaihw
roycaihw merged commit 0543412 into kubernetes-client:masterJul 15, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.cncf-cla: yesIndicates the PR's author has signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.lgtm"Looks good to me", indicates that a PR is ready to be merged.release-note-noneDenotes a PR that doesn't merit a release note.size/MDenotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client-side timeouts in watch

4 participants

@Priyankasaggu11929@yliaog@k8s-ci-robot@roycaihw
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' add documentation for the server & client side timeout by Priyankasaggu11929 · Pull Request #1467 · kubernetes-client/python · GitHub
Skip to content

add documentation for the server & client side timeout - #1467

Merged
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout
Jul 15, 2021
Merged

add documentation for the server & client side timeout#1467
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout

Conversation

@Priyankasaggu11929

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR documents information about server-side & client-side timeout in the examples/pod_namespace_watch.py example script.

Which issue(s) this PR fixes:

Fixes#1402

Does this PR introduce a user-facing change?

NONE

Signed-off-by: Priyanka Saggu priyankasaggu11929@gmail.com

@k8s-ci-robotk8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 14, 2021
@k8s-ci-robotk8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 14, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 1d1fcfa to 8bdb484CompareMay 14, 2021 13:45
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

Thank you @yliaog for all the pointers.

I'll read through the links to understand the concepts better, & will update the PR.

@Priyankasaggu11929Priyankasaggu11929 changed the title add documentation for the server & client side timeout[WIP] add documentation for the server & client side timeoutMay 15, 2021
@k8s-ci-robotk8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8bdb484 to 8fa80dcCompareMay 31, 2021 06:43
@k8s-ci-robotk8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 31, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8fa80dc to 2b40cdfCompareMay 31, 2021 06:44
@Priyankasaggu11929Priyankasaggu11929 changed the title [WIP] add documentation for the server & client side timeoutadd documentation for the server & client side timeoutMay 31, 2021
@k8s-ci-robotk8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've tried to redo the previous attempt of documentation, adding more information after reading & understanding through the links/pointers you provided above.

Please review. Thank you!

@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 2b40cdf to 9bb536cCompareMay 31, 2021 11:56
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
- *[kubernetes/apiserver/pkg/endpoints/handlers/get.go#L258](https://github.com/kubernetes/apiserver/blob/92392ef22153d75b3645b0ae339f89c12767fb52/pkg/endpoints/handlers/get.go#L258)*
- *[kubernetes/release-1.1/docs/admin/kube-apiserver.md](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/admin/kube-apiserver.md)*

- In case of a network outage, this timeout value will have no effect & the client will hang indefinitely without raising any exception.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what kind of network outage would cause this? it hangs when not accounting for the client side timeout described below, right?

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re:

what kind of network outage would cause this?

I'm not sure how to define or specify the what kind of network outage part. Could you please phrase it or point me somewhere that talks more about the kind of network outage, I'll read more & try to add a proper definition here.

Thank you!

Re:

It hangs when not accounting for the client side timeout described below, right?

I might be wrong with my understanding, but so far, what I understood is ~

that it is the server side timeout (i.e. value of argument timeout_seconds, that would have no effect in case of the said network outage),

but in the same network outage situation, if there is a client-side timeout value set (i.e. a value for argument _requests_timeout) then the client would honor that timeout duration value & would wait for the same before dropping the connection.

Just a pointer from this comment here ~ #1148 (comment)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, no hurries at all. Just pointing in case, it was missed!

could you please take a look at this review comment too, as what more could be done to improve this section here?

Thank you so much!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think probably add the condition that client side timeout is not specified, something like below:

this timeout value will have no effect & the client will hang indefinitely without raising any exception if client side timeout (see below) is not specified

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, Thank you for the pointers.

I'm rephrasing it as following: ~

In case of a network outage, the server side timeout value will have no effect & the client will hang indefinitely without raising any exception. Note, that this is the case provided when there is no other client-side timeout (i.e., _request_timeout) value specified.

(See the section below for information on client side timeout)

Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 9bb536c to fc95388CompareJune 2, 2021 03:45
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
Signed-off-by: Priyanka Saggu <priyankasaggu11929@gmail.com>
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from fc95388 to bfb3222CompareJune 2, 2021 18:03
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've updated the PR with the suggested review changes.

@yliaog

Copy link
Copy Markdown
Contributor

thanks for the pr
/lgtm
/approve

@k8s-ci-robotk8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robotk8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

/retest

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@Priyankasaggu11929: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roycaihw

Copy link
Copy Markdown
Member

travis-ci.org is in read-only mode

@roycaihw
roycaihw merged commit 0543412 into kubernetes-client:masterJul 15, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.cncf-cla: yesIndicates the PR's author has signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.lgtm"Looks good to me", indicates that a PR is ready to be merged.release-note-noneDenotes a PR that doesn't merit a release note.size/MDenotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client-side timeouts in watch

4 participants

@Priyankasaggu11929@yliaog@k8s-ci-robot@roycaihw
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); add documentation for the server & client side timeout by Priyankasaggu11929 · Pull Request #1467 · kubernetes-client/python · GitHub
Skip to content

add documentation for the server & client side timeout - #1467

Merged
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout
Jul 15, 2021
Merged

add documentation for the server & client side timeout#1467
roycaihw merged 1 commit into
kubernetes-client:masterfrom
Priyankasaggu11929:documet-server-and-client-side-timeout

Conversation

@Priyankasaggu11929

Copy link
Copy Markdown
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR documents information about server-side & client-side timeout in the examples/pod_namespace_watch.py example script.

Which issue(s) this PR fixes:

Fixes#1402

Does this PR introduce a user-facing change?

NONE

Signed-off-by: Priyanka Saggu priyankasaggu11929@gmail.com

@k8s-ci-robotk8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 14, 2021
@k8s-ci-robotk8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 14, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 1d1fcfa to 8bdb484CompareMay 14, 2021 13:45
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
Comment threadexamples/pod_namespace_watch.py Outdated
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

Thank you @yliaog for all the pointers.

I'll read through the links to understand the concepts better, & will update the PR.

@Priyankasaggu11929Priyankasaggu11929 changed the title add documentation for the server & client side timeout[WIP] add documentation for the server & client side timeoutMay 15, 2021
@k8s-ci-robotk8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8bdb484 to 8fa80dcCompareMay 31, 2021 06:43
@k8s-ci-robotk8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 31, 2021
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 8fa80dc to 2b40cdfCompareMay 31, 2021 06:44
@Priyankasaggu11929Priyankasaggu11929 changed the title [WIP] add documentation for the server & client side timeoutadd documentation for the server & client side timeoutMay 31, 2021
@k8s-ci-robotk8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've tried to redo the previous attempt of documentation, adding more information after reading & understanding through the links/pointers you provided above.

Please review. Thank you!

@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 2b40cdf to 9bb536cCompareMay 31, 2021 11:56
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md Outdated
- *[kubernetes/apiserver/pkg/endpoints/handlers/get.go#L258](https://github.com/kubernetes/apiserver/blob/92392ef22153d75b3645b0ae339f89c12767fb52/pkg/endpoints/handlers/get.go#L258)*
- *[kubernetes/release-1.1/docs/admin/kube-apiserver.md](https://github.com/kubernetes/kubernetes/blob/release-1.1/docs/admin/kube-apiserver.md)*

- In case of a network outage, this timeout value will have no effect & the client will hang indefinitely without raising any exception.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what kind of network outage would cause this? it hangs when not accounting for the client side timeout described below, right?

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re:

what kind of network outage would cause this?

I'm not sure how to define or specify the what kind of network outage part. Could you please phrase it or point me somewhere that talks more about the kind of network outage, I'll read more & try to add a proper definition here.

Thank you!

Re:

It hangs when not accounting for the client side timeout described below, right?

I might be wrong with my understanding, but so far, what I understood is ~

that it is the server side timeout (i.e. value of argument timeout_seconds, that would have no effect in case of the said network outage),

but in the same network outage situation, if there is a client-side timeout value set (i.e. a value for argument _requests_timeout) then the client would honor that timeout duration value & would wait for the same before dropping the connection.

Just a pointer from this comment here ~ #1148 (comment)

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, no hurries at all. Just pointing in case, it was missed!

could you please take a look at this review comment too, as what more could be done to improve this section here?

Thank you so much!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think probably add the condition that client side timeout is not specified, something like below:

this timeout value will have no effect & the client will hang indefinitely without raising any exception if client side timeout (see below) is not specified

@Priyankasaggu11929Priyankasaggu11929Jun 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yliaog, Thank you for the pointers.

I'm rephrasing it as following: ~

In case of a network outage, the server side timeout value will have no effect & the client will hang indefinitely without raising any exception. Note, that this is the case provided when there is no other client-side timeout (i.e., _request_timeout) value specified.

(See the section below for information on client side timeout)

Comment threadexamples/watch/timeout-settings.md Outdated
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from 9bb536c to fc95388CompareJune 2, 2021 03:45
Comment threadexamples/watch/timeout-settings.md
Comment threadexamples/watch/timeout-settings.md Outdated
Signed-off-by: Priyanka Saggu <priyankasaggu11929@gmail.com>
@Priyankasaggu11929
Priyankasaggu11929force-pushed the documet-server-and-client-side-timeout branch from fc95388 to bfb3222CompareJune 2, 2021 18:03
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

@yliaog, I've updated the PR with the suggested review changes.

@yliaog

Copy link
Copy Markdown
Contributor

thanks for the pr
/lgtm
/approve

@k8s-ci-robotk8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 2, 2021
@k8s-ci-robot

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Priyankasaggu11929, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robotk8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2021
@Priyankasaggu11929

Copy link
Copy Markdown
ContributorAuthor

/retest

@k8s-ci-robot

Copy link
Copy Markdown
Contributor

@Priyankasaggu11929: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

Details

In response to this:

/retest

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@roycaihw

Copy link
Copy Markdown
Member

travis-ci.org is in read-only mode

@roycaihw
roycaihw merged commit 0543412 into kubernetes-client:masterJul 15, 2021
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approvedIndicates a PR has been approved by an approver from all required OWNERS files.cncf-cla: yesIndicates the PR's author has signed the CNCF CLA.kind/documentationCategorizes issue or PR as related to documentation.lgtm"Looks good to me", indicates that a PR is ready to be merged.release-note-noneDenotes a PR that doesn't merit a release note.size/MDenotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document client-side timeouts in watch

4 participants

@Priyankasaggu11929@yliaog@k8s-ci-robot@roycaihw