Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

eliminate auth-path #8064

Merged
merged 2 commits into from May 11, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions cmd/kubelet/app/server.go
Expand Up @@ -193,6 +193,7 @@ func (s *KubeletServer) AddFlags(fs *pflag.FlagSet) {
fs.IntVar(&s.MaxPerPodContainerCount, "maximum-dead-containers-per-container", s.MaxPerPodContainerCount, "Maximum number of old instances of a container to retain per container. Each container takes up some disk space. Default: 5.")
fs.IntVar(&s.MaxContainerCount, "maximum-dead-containers", s.MaxContainerCount, "Maximum number of old instances of a containers to retain globally. Each container takes up some disk space. Default: 100.")
fs.StringVar(&s.AuthPath, "auth-path", s.AuthPath, "Path to .kubernetes_auth file, specifying how to authenticate to API server.")
fs.MarkDeprecated("auth-path", "will be removed in a future version")
fs.UintVar(&s.CadvisorPort, "cadvisor-port", s.CadvisorPort, "The port of the localhost cAdvisor endpoint")
fs.IntVar(&s.HealthzPort, "healthz-port", s.HealthzPort, "The port of the localhost healthz endpoint")
fs.Var(&s.HealthzBindAddress, "healthz-bind-address", "The IP address for the healthz server to serve on, defaulting to 127.0.0.1 (set to 0.0.0.0 for all interfaces)")
Expand Down
3 changes: 0 additions & 3 deletions contrib/completions/bash/kubectl
Expand Up @@ -721,7 +721,6 @@ _kubectl_config_set-credentials()
flags_with_completion=()
flags_completion=()

flags+=("--auth-path=")
flags+=("--client-certificate=")
flags+=("--client-key=")
flags+=("--embed-certs")
Expand Down Expand Up @@ -916,8 +915,6 @@ _kubectl()

flags+=("--alsologtostderr")
flags+=("--api-version=")
flags+=("--auth-path=")
two_word_flags+=("-a")
flags+=("--certificate-authority=")
flags+=("--client-certificate=")
flags+=("--client-key=")
Expand Down
34 changes: 2 additions & 32 deletions docs/kubeconfig-file.md
Expand Up @@ -49,36 +49,6 @@ users:
client-key: path/to/my/client/key
```

## .kubernetes_auth files

**WARNING**: merging auth from a mixture of kubernetes_auth file entries and kubeconfig user entries is hard to debug and should be avoided. kubernetes_auth file support exists mostly for tests and is being deprecated.

The kubernetes_auth file is a legacy config file that can contain a mix of server and client auth info. It is supported in kubeconfig via `auth-path` for a user:
```
users:
- name: black-user
user:
auth-path: path/to/my/existing/.kubernetes_auth_file
```

The entries in a file loaded via auth-path will be applied to both the user and cluster of the current context.

### Example .kubernetes_auth file
```
{
"User": "admin",
"Password": "secret",
"CertFile": "/path/to/my/client/cert",
"KeyFile": "/path/to/my/client/key",
"CAFile": "/path/to/my/server/cafile",
"BearerToken": "secrettoken",
"Insecure": false
}
```
All entries are optional. `User`, `Password`, `CertFile`, `KeyFile`, and `BearerToken` are applied to the kubectl user. `CAFile` and `Insecure` apply to the cluster. Note that it is invalid to set both `CAFile` and `Insecure`, or both `BearerToken` and `User,Password` (see loading and merging rules below).

If the contents of the kubernetes_auth file conflict with entries in kubeconfig, they are ignored. E.g, if the kubeconfig cluster specifies a `certificate-authority`, and the user specifies an `auth-path` to a kubernetes_file that contains a `CAFile` entry, the former will be used and the latter ignored.

## Loading and merging rules
The rules for loading and merging the kubeconfig files are straightforward, but there are a lot of them. The final config is built in this order:
1. Get the kubeconfig from disk. This is done with the following hierarchy and merge rules:
Expand Down Expand Up @@ -108,8 +78,8 @@ The rules for loading and merging the kubeconfig files are straightforward, but
1. If cluster info is present and a value for the attribute is present, use it.
1. If you don't have a server location, error.
1. Determine the actual user info to use. User is built using the same rules as cluster info, EXCEPT that you can only have one authentication technique per user.
1. Load precedence is 1) command line flag, 2) user fields from kubeconfig, 3) kubernetes_auth file fields (if user has a `auth-path` or the `--auth-path` was provided)
1. The command line flags are: `auth-path`, `client-certificate`, `client-key`, `username`, `password`, and `token`.
1. Load precedence is 1) command line flag, 2) user fields from kubeconfig
1. The command line flags are: `client-certificate`, `client-key`, `username`, `password`, and `token`.
1. If there are two conflicting techniques, fail.
1. For any information still missing, use default values and potentially prompt for authentication information

Expand Down
3 changes: 1 addition & 2 deletions docs/kubectl.md
Expand Up @@ -18,7 +18,6 @@ kubectl
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -66,4 +65,4 @@ kubectl
* [kubectl update](kubectl_update.md) - Update a resource by filename or stdin.
* [kubectl version](kubectl_version.md) - Print the client and server version information.

###### Auto generated by spf13/cobra at 2015-05-01 20:16:42.546735249 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.494626806 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_api-versions.md
Expand Up @@ -22,7 +22,6 @@ kubectl api-versions
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -50,4 +49,4 @@ kubectl api-versions
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.036328233 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.494346454 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_cluster-info.md
Expand Up @@ -22,7 +22,6 @@ kubectl cluster-info
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -50,4 +49,4 @@ kubectl cluster-info
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.036176301 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.494226337 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_config.md
Expand Up @@ -29,7 +29,6 @@ kubectl config SUBCOMMAND
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -63,4 +62,4 @@ kubectl config SUBCOMMAND
* [kubectl config use-context](kubectl_config_use-context.md) - Sets the current-context in a kubeconfig file
* [kubectl config view](kubectl_config_view.md) - displays Merged kubeconfig settings or a specified kubeconfig file.

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.036002047 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.494113712 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_config_set-cluster.md
Expand Up @@ -40,7 +40,6 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true

```
--alsologtostderr=false: log to standard error as well as files
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
Expand All @@ -65,4 +64,4 @@ $ kubectl config set-cluster e2e --insecure-skip-tls-verify=true
### SEE ALSO
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.034991096 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.493372429 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_config_set-context.md
Expand Up @@ -33,7 +33,6 @@ $ kubectl config set-context gce --user=cluster-admin
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand All @@ -58,4 +57,4 @@ $ kubectl config set-context gce --user=cluster-admin
### SEE ALSO
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.035371239 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.493620985 +0000 UTC
5 changes: 2 additions & 3 deletions docs/kubectl_config_set-credentials.md
Expand Up @@ -21,7 +21,7 @@ Specifying a name that already exists will merge new fields on top of existing v


```
kubectl config set-credentials NAME [--auth-path=/path/to/authfile] [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password]
kubectl config set-credentials NAME [--client-certificate=path/to/certfile] [--client-key=path/to/keyfile] [--token=bearer_token] [--username=basic_user] [--password=basic_password]
```

### Examples
Expand All @@ -41,7 +41,6 @@ $ kubectl set-credentials cluster-admin --client-certificate=~/.kube/admin.crt -
### Options

```
--auth-path=: auth-path for the user entry in kubeconfig
--client-certificate=: path to client-certificate for the user entry in kubeconfig
--client-key=: path to client-key for the user entry in kubeconfig
--embed-certs=false: embed client cert/key for the user entry in kubeconfig
Expand Down Expand Up @@ -78,4 +77,4 @@ $ kubectl set-credentials cluster-admin --client-certificate=~/.kube/admin.crt -
### SEE ALSO
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.035167812 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.493498685 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_config_set.md
Expand Up @@ -24,7 +24,6 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -52,4 +51,4 @@ kubectl config set PROPERTY_NAME PROPERTY_VALUE
### SEE ALSO
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.035532103 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.49374188 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_config_unset.md
Expand Up @@ -23,7 +23,6 @@ kubectl config unset PROPERTY_NAME
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -51,4 +50,4 @@ kubectl config unset PROPERTY_NAME
### SEE ALSO
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.035684858 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.493867298 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_config_use-context.md
Expand Up @@ -22,7 +22,6 @@ kubectl config use-context CONTEXT_NAME
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -50,4 +49,4 @@ kubectl config use-context CONTEXT_NAME
### SEE ALSO
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.035835782 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.493987321 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_config_view.md
Expand Up @@ -45,7 +45,6 @@ $ kubectl config view -o template --template='{{range .users}}{{ if eq .name "e2
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -73,4 +72,4 @@ $ kubectl config view -o template --template='{{range .users}}{{ if eq .name "e2
### SEE ALSO
* [kubectl config](kubectl_config.md) - config modifies kubeconfig files

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.034809963 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.493241636 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_create.md
Expand Up @@ -35,7 +35,6 @@ $ cat pod.json | kubectl create -f -
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -63,4 +62,4 @@ $ cat pod.json | kubectl create -f -
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.030664101 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.491140012 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_delete.md
Expand Up @@ -55,7 +55,6 @@ $ kubectl delete pods --all
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -83,4 +82,4 @@ $ kubectl delete pods --all
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-30 14:53:47.856200003 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.491421364 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_describe.md
Expand Up @@ -35,7 +35,6 @@ $ kubectl describe pods/nginx
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -63,4 +62,4 @@ $ kubectl describe pods/nginx
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.030447061 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.490982332 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_exec.md
Expand Up @@ -36,7 +36,6 @@ $ kubectl exec -p 123456-7890 -c ruby-container -i -t -- bash -il
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -64,4 +63,4 @@ $ kubectl exec -p 123456-7890 -c ruby-container -i -t -- bash -il
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.032352238 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.492105038 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_expose.md
Expand Up @@ -54,7 +54,6 @@ $ kubectl expose rc streamer --port=4100 --protocol=udp --service-name=video-str
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -82,4 +81,4 @@ $ kubectl expose rc streamer --port=4100 --protocol=udp --service-name=video-str
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-30 06:01:21.51286228 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.49295951 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_get.md
Expand Up @@ -57,7 +57,6 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -85,4 +84,4 @@ $ kubectl get rc/web service/frontend pods/web-pod-13je7
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.030165061 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.490776443 +0000 UTC
3 changes: 1 addition & 2 deletions docs/kubectl_label.md
Expand Up @@ -53,7 +53,6 @@ $ kubectl label pods foo bar-
```
--alsologtostderr=false: log to standard error as well as files
--api-version="": The API version to use when talking to the server
-a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
Expand Down Expand Up @@ -81,4 +80,4 @@ $ kubectl label pods foo bar-
### SEE ALSO
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager

###### Auto generated by spf13/cobra at 2015-04-29 15:25:11.03459192 +0000 UTC
###### Auto generated by spf13/cobra at 2015-05-08 20:26:40.493103008 +0000 UTC