Document using SOCKS5 to access Kubernetes API #31527

xens · 2022-01-26T19:55:25Z

Goal of this commit is to document the usage of SOCKS5 proxies to reach the Kubernetes API.

k8s-ci-robot · 2022-01-26T19:55:32Z

Welcome @xens!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

netlify · 2022-01-26T20:09:04Z

✔️ Deploy Preview for kubernetes-io-main-staging ready!

🔨 Explore the source changes: 6323e81

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/61f9911c1f1da900071f6b78

😎 Browse the preview: https://deploy-preview-31527--kubernetes-io-main-staging.netlify.app

jihoon-seo

@xens Welcome and thank you for your first PR on this repo! 😊

there's a way to have a preview of the compiled file ? I've added a Mermaid diagram and I'm not sure if it'll render properly.

Preview: https://deploy-preview-31527--kubernetes-io-main-staging.netlify.app/docs/tasks/extend-kubernetes/socks5-proxy-access-api/

I added some comments.
PTAL! 😊

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

jihoon-seo

@xens PTAL one more time! 😊

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

xens · 2022-01-27T21:20:10Z

@jihoon-seo done :) let me know if there's anything else to fix.

jihoon-seo · 2022-01-28T01:50:47Z

@xens Thanks!

LGTM for doc style aspect.

And it will be great if someone does a tech review on this PR! 😊

mehabhalodiya · 2022-01-30T16:54:22Z

Hey @xens
I think the pull request to add these docs should target the dev-1.24 branch as per the Tim's comment.

mehabhalodiya · 2022-01-30T17:01:42Z

@kubernetes/sig-cli-misc does this look OK in terms of technical correctness?

sftim

Thanks for this PR @xens

Overall feedback:

nice diagram!
avoid using we; see other task pages for examples; most of them follow this style recommendation. Instead, address the reader as “you”.

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

Goal of this commit is to document the usage of SOCKS5 proxies to reach the Kubernetes API.

xens · 2022-02-01T20:00:02Z

Hey @xens I think the pull request to add these docs should target the dev-1.24 branch as per the Tim's comment.

Thanks it's done!

sftim · 2022-04-20T10:44:46Z

/milestone 1.24

sftim · 2022-04-20T10:45:09Z

/retitle Document using SOCKS5 to access Kubernetes API

nate-double-u · 2022-04-29T16:02:56Z

Hello, with code freeze for k/website on Monday May 2, we need to make a decision about this PR. It appears to need some updates before getting merged in. @xens are you able to take a look?

…i.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

nate-double-u · 2022-04-29T23:40:28Z

Thanks for the updates @xens!

divya-mohan0209

This lgtm from a content perspective except a grammatical nit.

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

aojea · 2022-05-01T09:26:06Z

the technical part LGTM

divya-mohan0209

lgtm. just a few non-blocking nits/suggestions.

divya-mohan0209 · 2022-05-01T11:41:53Z

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

+
+{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}
+
+You need SSH client software (the `ssh` tool), and an SSH server running on the remote server.


Referring to it as a service would help clarify, I believe.

Suggested change

You need SSH client software (the `ssh` tool), and an SSH server running on the remote server.

You need SSH client software (the `ssh` tool), and an SSH service running on the remote server.

OR

Suggested change

You need SSH client software (the `ssh` tool), and an SSH server running on the remote server.

You need SSH client software (the `ssh` tool), and an SSH server running on the remote host.

divya-mohan0209 · 2022-05-01T11:42:45Z

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

+{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}
+
+You need SSH client software (the `ssh` tool), and an SSH server running on the remote server.
+You must be able to log in to the SSH server on the remote server.


Similar to the above.

Suggested change

You must be able to log in to the SSH server on the remote server.

You must be able to log in to the SSH server on the remote host.

OR

Suggested change

You must be able to log in to the SSH server on the remote server.

You must be able to log in to the SSH service on the remote server.

divya-mohan0209 · 2022-05-01T11:44:45Z

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md

+
+Figure 1 represents what you're going to achieve in this task.
+
+* You have a client computer from where you're going to create requests to talk to the Kubernetes API


Do we want to mention here that the client computer will be referred to as local in the diagram/steps ahead? I understand we explicitly speak about how localhost is not the local client computer somewhere below. But I think it'd help if we state this explicitly for step #3.

Suggested change

* You have a client computer from where you're going to create requests to talk to the Kubernetes API

* You have a client computer, referred to as local in the steps ahead, from where you're going to create requests to talk to the Kubernetes API.

reylejano · 2022-05-02T15:12:59Z

Applying lgtm from @aojea and @divya-mohan0209
/lgtm

k8s-ci-robot · 2022-05-02T15:13:19Z

LGTM label has been added.

Git tree hash: eb36863142c21ae7444f20b82c4b169812c251f0

reylejano · 2022-05-02T15:13:22Z

/approve

I'll open a follow-up PR to add suggestions

k8s-ci-robot · 2022-05-02T15:13:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: reylejano

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [reylejano]

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

nate-double-u · 2022-05-02T15:17:42Z

Thanks everyone!

reylejano · 2022-05-04T01:48:18Z

Follow-up PR #33429

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 26, 2022

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 26, 2022

k8s-ci-robot requested review from celestehorgan and mehabhalodiya January 26, 2022 19:56

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jan 26, 2022

xens mentioned this pull request Jan 26, 2022

Document SOCKS5 proxy mode for kubectl #31497

Closed

jihoon-seo reviewed Jan 26, 2022

View reviewed changes

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md Outdated Show resolved Hide resolved

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md Outdated Show resolved Hide resolved

xens force-pushed the feat/add_socks5_documentation branch 3 times, most recently from 98bf32b to 57f6c91 Compare January 27, 2022 10:21

jihoon-seo reviewed Jan 27, 2022

View reviewed changes

xens force-pushed the feat/add_socks5_documentation branch from 57f6c91 to d914c61 Compare January 27, 2022 12:12

xens requested a review from jihoon-seo January 27, 2022 12:14

k8s-ci-robot added the sig/cli Categorizes an issue or PR as relevant to SIG CLI. label Jan 30, 2022

sftim reviewed Feb 1, 2022

View reviewed changes

xens force-pushed the feat/add_socks5_documentation branch from d914c61 to cc8b265 Compare February 1, 2022 19:43

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 1, 2022

xens force-pushed the feat/add_socks5_documentation branch from cc8b265 to f01ea2b Compare February 1, 2022 19:57

ofeat: add SOCKS5 proxy documentation

6323e81

Goal of this commit is to document the usage of SOCKS5 proxies to reach the Kubernetes API.

xens force-pushed the feat/add_socks5_documentation branch from f01ea2b to 6323e81 Compare February 1, 2022 19:59

xens changed the base branch from main to dev-1.24 February 1, 2022 19:59

k8s-ci-robot added this to the 1.24 milestone Apr 20, 2022

k8s-ci-robot changed the title ~~feat: add SOCKS5 proxy documentation~~ Document using SOCKS5 to access Kubernetes API Apr 20, 2022

sftim mentioned this pull request Apr 20, 2022

Control Plane-Node Communication needs to introduce "Konnectivity" from a community perspective #33032

Closed

xens and others added 2 commits April 29, 2022 21:59

Update content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-ap…

f09b412

…i.md Co-authored-by: Tim Bannister <tim@scalefactory.com>

feat: add cleanup and furter reading sections

cb8473a

xens force-pushed the feat/add_socks5_documentation branch from e6ec645 to cb8473a Compare April 29, 2022 20:42

fix: comment on SOCKS5 proxy

df6fa2d

divya-mohan0209 requested changes Apr 30, 2022

View reviewed changes

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md Outdated Show resolved Hide resolved

aojea reviewed Apr 30, 2022

View reviewed changes

content/en/docs/tasks/extend-kubernetes/socks5-proxy-access-api.md Outdated Show resolved Hide resolved

xens added 2 commits May 1, 2022 08:17

nit

1e5a7aa

fix: workflow

378b188

xens force-pushed the feat/add_socks5_documentation branch from 9d268b1 to 378b188 Compare May 1, 2022 06:48

divya-mohan0209 reviewed May 1, 2022

View reviewed changes

k8s-ci-robot assigned reylejano May 2, 2022

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

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 2, 2022

k8s-ci-robot merged commit 7f13ad0 into kubernetes:dev-1.24 May 2, 2022

reylejano mentioned this pull request May 4, 2022

Update SOCKS5 page, follow-up to pr 31527 #33429

Merged

sftim mentioned this pull request Jun 20, 2022

Technically accurate advise, but could mislead user who skimming it in “Use a SOCKS5 Proxy to Access the Kubernetes API” #34419

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document using SOCKS5 to access Kubernetes API #31527

Document using SOCKS5 to access Kubernetes API #31527

xens commented Jan 26, 2022 •

edited

Loading

k8s-ci-robot commented Jan 26, 2022

netlify bot commented Jan 26, 2022 •

edited

Loading

jihoon-seo left a comment

jihoon-seo left a comment

xens commented Jan 27, 2022

jihoon-seo commented Jan 28, 2022

mehabhalodiya commented Jan 30, 2022

mehabhalodiya commented Jan 30, 2022

sftim left a comment

xens commented Feb 1, 2022

sftim commented Apr 20, 2022

sftim commented Apr 20, 2022

nate-double-u commented Apr 29, 2022

nate-double-u commented Apr 29, 2022

divya-mohan0209 left a comment

aojea commented May 1, 2022

divya-mohan0209 left a comment

divya-mohan0209 May 1, 2022

divya-mohan0209 May 1, 2022

divya-mohan0209 May 1, 2022

reylejano commented May 2, 2022

k8s-ci-robot commented May 2, 2022

reylejano commented May 2, 2022

k8s-ci-robot commented May 2, 2022

nate-double-u commented May 2, 2022

reylejano commented May 4, 2022


		{{< include "task-tutorial-prereqs.md" >}} {{< version-check >}}

		You need SSH client software (the `ssh` tool), and an SSH server running on the remote server.

	You must be able to log in to the SSH server on the remote server.
	You must be able to log in to the SSH server on the remote host.


		Figure 1 represents what you're going to achieve in this task.

		* You have a client computer from where you're going to create requests to talk to the Kubernetes API

	* You have a client computer from where you're going to create requests to talk to the Kubernetes API
	* You have a client computer, referred to as local in the steps ahead, from where you're going to create requests to talk to the Kubernetes API.

Document using SOCKS5 to access Kubernetes API #31527

Document using SOCKS5 to access Kubernetes API #31527

Conversation

xens commented Jan 26, 2022 • edited Loading

k8s-ci-robot commented Jan 26, 2022

netlify bot commented Jan 26, 2022 • edited Loading

jihoon-seo left a comment

Choose a reason for hiding this comment

jihoon-seo left a comment

Choose a reason for hiding this comment

xens commented Jan 27, 2022

jihoon-seo commented Jan 28, 2022

mehabhalodiya commented Jan 30, 2022

mehabhalodiya commented Jan 30, 2022

sftim left a comment

Choose a reason for hiding this comment

xens commented Feb 1, 2022

sftim commented Apr 20, 2022

sftim commented Apr 20, 2022

nate-double-u commented Apr 29, 2022

nate-double-u commented Apr 29, 2022

divya-mohan0209 left a comment

Choose a reason for hiding this comment

aojea commented May 1, 2022

divya-mohan0209 left a comment

Choose a reason for hiding this comment

divya-mohan0209 May 1, 2022

Choose a reason for hiding this comment

divya-mohan0209 May 1, 2022

Choose a reason for hiding this comment

divya-mohan0209 May 1, 2022

Choose a reason for hiding this comment

reylejano commented May 2, 2022

k8s-ci-robot commented May 2, 2022

reylejano commented May 2, 2022

k8s-ci-robot commented May 2, 2022

nate-double-u commented May 2, 2022

reylejano commented May 4, 2022

xens commented Jan 26, 2022 •

edited

Loading

netlify bot commented Jan 26, 2022 •

edited

Loading