Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
packageapi
import(
"k8s.io/apimachinery/pkg/runtime"
)
// Where possible, json tags match the cli argument names.
// Top level config objects and all values required for proper functioning are not "omitempty". Any truly optional piece of config is allowed to be omitted.
// Config holds the information needed to build connect to remote kubernetes clusters as a given user
// IMPORTANT if you add fields to this struct, please update IsConfigEmpty()
typeConfigstruct{
// Legacy field from pkg/api/types.go TypeMeta.
// TODO(jlowdermilk): remove this after eliminating downstream dependencies.
// +optional
Kindstring`json:"kind,omitempty"`
// DEPRECATED: APIVersion is the preferred api version for communicating with the kubernetes cluster (v1, v2, etc).
// Because a cluster can run multiple API groups and potentially multiple versions of each, it no longer makes sense to specify
// a single value for the cluster version.
// This field isn't really needed anyway, so we are deprecating it without replacement.
// It will be ignored if it is present.
// +optional
APIVersionstring`json:"apiVersion,omitempty"`
// Preferences holds general information to be use for cli interactions
PreferencesPreferences`json:"preferences"`
// Clusters is a map of referencable names to cluster configs
Clustersmap[string]*Cluster`json:"clusters"`
// AuthInfos is a map of referencable names to user configs
AuthInfosmap[string]*AuthInfo`json:"users"`
// Contexts is a map of referencable names to context configs
Contextsmap[string]*Context`json:"contexts"`
// CurrentContext is the name of the context that you would like to use by default
CurrentContextstring`json:"current-context"`
// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
// Token is the bearer token for authentication to the kubernetes cluster.
// +optional
Tokenstring`json:"token,omitempty"`
// TokenFile is a pointer to a file that contains a bearer token (as described above). If both Token and TokenFile are present, Token takes precedence.
// +optional
TokenFilestring`json:"tokenFile,omitempty"`
// Impersonate is the username to act-as.
// +optional
Impersonatestring`json:"act-as,omitempty"`
// Username is the username for basic authentication to the kubernetes cluster.
// +optional
Usernamestring`json:"username,omitempty"`
// Password is the password for basic authentication to the kubernetes cluster.
// +optional
Passwordstring`json:"password,omitempty"`
// AuthProvider specifies a custom authentication plugin for the kubernetes cluster.
// 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)
typeContextstruct{
// LocationOfOrigin indicates where this object came from. It is used for round tripping config post-merge, but never serialized.
LocationOfOriginstring
// Cluster is the name of the cluster for this context
Clusterstring`json:"cluster"`
// AuthInfo is the name of the authInfo for this context
AuthInfostring`json:"user"`
// Namespace is the default namespace to use on unspecified requests
// +optional
Namespacestring`json:"namespace,omitempty"`
// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
packagev1
import(
"k8s.io/apimachinery/pkg/runtime"
)
// Where possible, json tags match the cli argument names.
// Top level config objects and all values required for proper functioning are not "omitempty". Any truly optional piece of config is allowed to be omitted.
// Config holds the information needed to build connect to remote kubernetes clusters as a given user
typeConfigstruct{
// Legacy field from pkg/api/types.go TypeMeta.
// TODO(jlowdermilk): remove this after eliminating downstream dependencies.
// +optional
Kindstring`json:"kind,omitempty"`
// DEPRECATED: APIVersion is the preferred api version for communicating with the kubernetes cluster (v1, v2, etc).
// Because a cluster can run multiple API groups and potentially multiple versions of each, it no longer makes sense to specify
// a single value for the cluster version.
// This field isn't really needed anyway, so we are deprecating it without replacement.
// It will be ignored if it is present.
// +optional
APIVersionstring`json:"apiVersion,omitempty"`
// Preferences holds general information to be use for cli interactions
PreferencesPreferences`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
CurrentContextstring`json:"current-context"`
// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields
// Token is the bearer token for authentication to the kubernetes cluster.
// +optional
Tokenstring`json:"token,omitempty"`
// TokenFile is a pointer to a file that contains a bearer token (as described above). If both Token and TokenFile are present, Token takes precedence.
// +optional
TokenFilestring`json:"tokenFile,omitempty"`
// Impersonate is the username to imperonate. The name matches the flag.
// +optional
Impersonatestring`json:"as,omitempty"`
// Username is the username for basic authentication to the kubernetes cluster.
// +optional
Usernamestring`json:"username,omitempty"`
// Password is the password for basic authentication to the kubernetes cluster.
// +optional
Passwordstring`json:"password,omitempty"`
// AuthProvider specifies a custom authentication plugin for the kubernetes cluster.
// 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)
typeContextstruct{
// Cluster is the name of the cluster for this context
Clusterstring`json:"cluster"`
// AuthInfo is the name of the authInfo for this context
AuthInfostring`json:"user"`
// Namespace is the default namespace to use on unspecified requests
// +optional
Namespacestring`json:"namespace,omitempty"`
// Extensions holds additional information. This is useful for extenders so that reads and writes don't clobber unknown fields