Website: Issue with k8s.io/docs/tasks/access-application-cluster/access-cluster/

Created on 12 Sep 2017  路  15Comments  路  Source: kubernetes/website

This is a...

  • [x] Bug Report

Problem:
The documentation says that kubectl needs to know the location of the cluster and credentials to access it, but doesn't explain how to get these params out of existing cluster and how to save them in kubectl. I suppose that there could be even some login command that authenticates and stores these details automatically.

Proposed Solution:
Explain the procedure in detail how to access existing cluster with kubectl.

Page to Update:
https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-for-the-first-time-with-kubectl

lifecyclrotten

Most helpful comment

@abitrolly There are another 2 docs:
https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/
https://lukemarsden.github.io/docs/user-guide/sharing-clusters/

@zacharysarah Maybe we want to do something e.g. reorg to make our doc more easier for user to understand.

All 15 comments

@mengqiy 馃憢

We can add a section saying something like:
By default kubectl use the config file in ~/.kube/config.
You can view it by using kubectl config view.
And also link the following doc
https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/

Linked doc still doesn't explain:

  1. What is context?
  2. What is certificate-authority and why it is important?
  3. How to get that certificate-authority from the server?
  4. How to generate client certificate and add it to server?
  5. What for is client.key?

If that info is specific to cluster provider, then documentation could try to define common layout and link those docs.

For #4548 the journey is try minikube through ssh -> setup kubectl access to remote minikube through ssh tunnel (fails on https://github.com/kubernetes/minikube/issues/1974).

@abitrolly There are another 2 docs:
https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/
https://lukemarsden.github.io/docs/user-guide/sharing-clusters/

@zacharysarah Maybe we want to do something e.g. reorg to make our doc more easier for user to understand.

@mengqiy Agreed! I'm giving this the _Actionable_ label so that it stands a better chance of receiving work.

https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/

@mengqiy I don't remember seeing this link. At least there should be a link to it. Still it was not explained what context is for. so I edited the explanation https://github.com/kubernetes/kubernetes.github.io/pull/5611

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

Prevent issues from auto-closing with an /lifecycle frozen comment.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or @fejta.
/lifecycle stale

/remove-lifecycle stale

Still actual.

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

/remove-lifecycle frozen
/remove-lifecycle stale

/remove-lifecycle stale

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

@fejta-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.
Reopen the issue with /reopen.
Mark the issue as fresh with /remove-lifecycle rotten.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/close

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.

Was this page helpful?
0 / 5 - 0 ratings