kubernetes: github.com/erimatnor/kubernetes/pkg/client/clientcmd/api/v1 Index | Files

package v1

import "github.com/erimatnor/kubernetes/pkg/client/clientcmd/api/v1"

Index

Package Files

conversion.go register.go types.go

Variables

var Codec = runtime.CodecFor(api.Scheme, "v1")

Codec encodes internal objects to the v1 scheme

type AuthInfo Uses

type AuthInfo struct {
    // AuthPath is the path to a kubernetes auth file (~/.kubernetes_auth).  If you provide an AuthPath, the other options specified are ignored
    AuthPath string `json:"auth-path,omitempty"`
    // ClientCertificate is the path to a client cert file for TLS.
    ClientCertificate string `json:"client-certificate,omitempty"`
    // ClientCertificateData contains PEM-encoded data from a client cert file for TLS. Overrides ClientCertificate
    ClientCertificateData []byte `json:"client-certificate-data,omitempty"`
    // ClientKey is the path to a client key file for TLS.
    ClientKey string `json:"client-key,omitempty"`
    // ClientKeyData contains PEM-encoded data from a client key file for TLS. Overrides ClientKey
    ClientKeyData []byte `json:"client-key-data,omitempty"`
    // Token is the bearer token for authentication to the kubernetes cluster.
    Token string `json:"token,omitempty"`
    // Username is the username for basic authentication to the kubernetes cluster.
    Username string `json:"username,omitempty"`
    // Password is the password for basic authentication to the kubernetes cluster.
    Password string `json:"password,omitempty"`
    // Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
    Extensions []NamedExtension `json:"extensions,omitempty"`
}

AuthInfo contains information that describes identity information. This is use to tell the kubernetes cluster who you are.

type Cluster Uses

type Cluster struct {
    // Server is the address of the kubernetes cluster (https://hostname:port).
    Server string `json:"server"`
    // APIVersion is the preferred api version for communicating with the kubernetes cluster (v1beta1, v1beta2, v1beta3, etc).
    APIVersion string `json:"api-version,omitempty"`
    // InsecureSkipTLSVerify skips the validity check for the server's certificate. This will make your HTTPS connections insecure.
    InsecureSkipTLSVerify bool `json:"insecure-skip-tls-verify,omitempty"`
    // CertificateAuthority is the path to a cert file for the certificate authority.
    CertificateAuthority string `json:"certificate-authority,omitempty"`
    // CertificateAuthorityData contains PEM-encoded certificate authority certificates. Overrides CertificateAuthority
    CertificateAuthorityData []byte `json:"certificate-authority-data,omitempty"`
    // Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
    Extensions []NamedExtension `json:"extensions,omitempty"`
}

Cluster contains information about how to communicate with a kubernetes cluster

type Config Uses

type Config struct {
    v1beta3.TypeMeta `json:",inline"`
    // Preferences holds general information to be use for cli interactions
    Preferences Preferences `json:"preferences"`
    // Clusters is a map of referencable names to cluster configs
    Clusters []NamedCluster `json:"clusters"`
    // AuthInfos is a map of referencable names to user configs
    AuthInfos []NamedAuthInfo `json:"users"`
    // Contexts is a map of referencable names to context configs
    Contexts []NamedContext `json:"contexts"`
    // CurrentContext is the name of the context that you would like to use by default
    CurrentContext string `json:"current-context"`
    // Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
    Extensions []NamedExtension `json:"extensions,omitempty"`
}

Config holds the information needed to build connect to remote kubernetes clusters as a given user

func (*Config) IsAnAPIObject Uses

func (*Config) IsAnAPIObject()

type Context Uses

type Context struct {
    // Cluster is the name of the cluster for this context
    Cluster string `json:"cluster"`
    // AuthInfo is the name of the authInfo for this context
    AuthInfo string `json:"user"`
    // Namespace is the default namespace to use on unspecified requests
    Namespace string `json:"namespace,omitempty"`
    // Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
    Extensions []NamedExtension `json:"extensions,omitempty"`
}

Context is a tuple of references to a cluster (how do I communicate with a kubernetes cluster), a user (how do I identify myself), and a namespace (what subset of resources do I want to work with)

type NamedAuthInfo Uses

type NamedAuthInfo struct {
    // Name is the nickname for this AuthInfo
    Name string `json:"name"`
    // AuthInfo holds the auth information
    AuthInfo AuthInfo `json:"user"`
}

NamedAuthInfo relates nicknames to auth information

type NamedCluster Uses

type NamedCluster struct {
    // Name is the nickname for this Cluster
    Name string `json:"name"`
    // Cluster holds the cluster information
    Cluster Cluster `json:"cluster"`
}

NamedCluster relates nicknames to cluster information

type NamedContext Uses

type NamedContext struct {
    // Name is the nickname for this Context
    Name string `json:"name"`
    // Context holds the context information
    Context Context `json:"context"`
}

NamedContext relates nicknames to context information

type NamedExtension Uses

type NamedExtension struct {
    // Name is the nickname for this Extension
    Name string `json:"name"`
    // Extension holds the extension information
    Extension runtime.RawExtension `json:"extension"`
}

NamedExtension relates nicknames to extension information

type Preferences Uses

type Preferences struct {
    Colors bool `json:"colors,omitempty"`
    // Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
    Extensions []NamedExtension `json:"extensions,omitempty"`
}

Package v1 imports 5 packages (graph). Updated 2017-05-11. Refresh now. Tools for package owners.