github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-31 07:20:13 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #14296 from technosophos/master

Browse Source 
Fix documentation in clientcmd/doc.go.
This commit is contained in:
Alex Robinson 2015-10-05 16:31:09 -07:00
commit 7a33a4b0e9
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pkg/client/unversioned/clientcmd/doc.go
View File

@ -19,13 +19,19 @@ Package clientcmd provides one stop shopping for building a working client from
from a .kubeconfig file, from command line flags, or from any merged combination. from a .kubeconfig file, from command line flags, or from any merged combination.
Sample usage from merged .kubeconfig files (local directory, home directory) Sample usage from merged .kubeconfig files (local directory, home directory)
loadingRules := clientcmd.NewKubeConfigLoadingRules()
loadingRules := clientcmd.NewDefaultClientConfigLoadingRules()
// if you want to change the loading rules (which files in which order), you can do so here // if you want to change the loading rules (which files in which order), you can do so here
configOverrides := &clientcmd.ConfigOverrides{} configOverrides := &clientcmd.ConfigOverrides{}
// if you want to change override values or bind them to flags, there are methods to help you // if you want to change override values or bind them to flags, there are methods to help you
kubeConfig := clientcmd.NewNonInteractiveDeferredLoadingKubeConfig(loadingRules, configOverrides) kubeConfig := clientcmd.NewNonInteractiveDeferredLoadingClientConfig(loadingRules, configOverrides)
kubeConfig.Client() config, err := kubeConfig.ClientConfig()
if err != nil {
// Do something
}
client, err := unversioned.New(config)
// ...
*/ */
package clientcmd package clientcmd

4
pkg/client/unversioned/doc.go
View File

@ -15,14 +15,14 @@ limitations under the License.
*/ */
/* /*
Package client contains the implementation of the client side communication with the Package unversioned contains the implementation of the client side communication with the
Kubernetes master. The Client class provides methods for reading, creating, updating, Kubernetes master. The Client class provides methods for reading, creating, updating,
and deleting pods, replication controllers, daemons, services, and nodes. and deleting pods, replication controllers, daemons, services, and nodes.
Most consumers should use the Config object to create a Client: Most consumers should use the Config object to create a Client:
import ( import (
"k8s.io/kubernetes/pkg/client" client "k8s.io/kubernetes/pkg/client/unversioned"
"k8s.io/kubernetes/pkg/api" "k8s.io/kubernetes/pkg/api"
"k8s.io/kubernetes/pkg/fields" "k8s.io/kubernetes/pkg/fields"
"k8s.io/kubernetes/pkg/labels" "k8s.io/kubernetes/pkg/labels"