blob: 424311ee12db5e9b8a74b02b7490cf8f3aec4f84 [file] [log] [blame]
Zack Williamse940c7a2019-08-21 14:25:39 -07001/*
2Copyright 2014 The Kubernetes Authors.
3
4Licensed under the Apache License, Version 2.0 (the "License");
5you may not use this file except in compliance with the License.
6You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10Unless required by applicable law or agreed to in writing, software
11distributed under the License is distributed on an "AS IS" BASIS,
12WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13See the License for the specific language governing permissions and
14limitations under the License.
15*/
16
17/*
18Package clientcmd provides one stop shopping for building a working client from a fixed config,
19from a .kubeconfig file, from command line flags, or from any merged combination.
20
21Sample 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*/
37package clientcmd // import "k8s.io/client-go/tools/clientcmd"