Zack Williams | e940c7a | 2019-08-21 14:25:39 -0700 | [diff] [blame] | 1 | /* |
| 2 | Copyright 2014 The Kubernetes Authors. |
| 3 | |
| 4 | Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | you may not use this file except in compliance with the License. |
| 6 | You may obtain a copy of the License at |
| 7 | |
| 8 | http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | |
| 10 | Unless required by applicable law or agreed to in writing, software |
| 11 | distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | See the License for the specific language governing permissions and |
| 14 | limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | /* |
| 18 | Package clientcmd provides one stop shopping for building a working client from a fixed config, |
| 19 | from a .kubeconfig file, from command line flags, or from any merged combination. |
| 20 | |
| 21 | Sample usage from merged .kubeconfig files (local directory, home directory) |
| 22 | |
| 23 | loadingRules := clientcmd.NewDefaultClientConfigLoadingRules() |
| 24 | // if you want to change the loading rules (which files in which order), you can do so here |
| 25 | |
| 26 | configOverrides := &clientcmd.ConfigOverrides{} |
| 27 | // if you want to change override values or bind them to flags, there are methods to help you |
| 28 | |
| 29 | kubeConfig := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(loadingRules, configOverrides) |
| 30 | config, err := kubeConfig.ClientConfig() |
| 31 | if err != nil { |
| 32 | // Do something |
| 33 | } |
| 34 | client, err := metav1.New(config) |
| 35 | // ... |
| 36 | */ |
| 37 | package clientcmd // import "k8s.io/client-go/tools/clientcmd" |