Interface: KubeconfigObject
lib/k8s/kubeconfig .KubeconfigObject
KubeconfigObject is the object that is stored in indexDB as string format. It is a JSON encoded version of the kubeconfig file. It is used to store the kubeconfig for stateless clusters. This is basically a k8s client - go Kubeconfig object. KubeconfigObject holds the information needed to build connect to remote kubernetes clusters as a given user
- @see more info
see
storeStatelessClusterKubeconfig
see
getStatelessClusterKubeConfigs
see
findKubeconfigByClusterName
Properties
apiVersion
• apiVersion: string
version of the kubeconfig file.
Defined in
clusters
• clusters: { cluster
: { certificateAuthority?
: string
; certificateAuthorityData?
: string
; disableCompression?
: boolean
; extensions?
: { extension
: {} ; name
: string
}[] ; insecureSkipTLSVerify?
: boolean
; proxyURL?
: string
; server
: string
; tlsServerName?
: string
} ; name
: string
}[]
Clusters is a map of referencable names to cluster configs.
see
more info
Defined in
contexts
• contexts: { context
: { cluster
: string
; extensions?
: { extension
: {} ; name
: string
}[] ; namespace?
: string
; user
: string
} ; name
: string
}[]
Contexts is a map of referencable names to context configs.
see
more info
Defined in
current-context
• current-context: string
CurrentContext is the name of the context that you would like to use by default
Defined in
extensions
• Optional
extensions: { extension
: {} ; name
: string
}[]
Extensions holds additional information. This is useful for extenders so that reads and writes don’t clobber unknown fields
see
more info
Defined in
kind
• kind: string
kind is the type of the kubeconfig file. It is always ‘Config’.
Defined in
preferences
• Optional
preferences: Object
Preferences holds general information to be use for cli interactions
see
more info
Type declaration
Name | Type | Description |
---|---|---|
colors? |
boolean |
colors specifies whether output should use colors. |
extensions? |
{ extension : {} ; name : string }[] |
extensions holds additional information. This is useful for extenders so that reads and writes don’t clobber unknown fields on the Preferences object. |
Defined in
users
• users: { name
: string
; user
: { authProvider?
: { config
: { [key: string]
: string
; } ; name
: string
} ; clientCertificate?
: string
; clientCertificateData?
: string
; clientKey?
: string
; clientKeyData?
: string
; exec?
: { args?
: string
[] ; command
: string
; env?
: { [key: string]
: string
; } } ; extensions?
: { extension
: {} ; name
: string
}[] ; impersonate?
: string
; impersonateGroups?
: string
[] ; impersonateUserExtra?
: { [key: string]
: string
[]; } ; password?
: string
; token?
: string
; tokenFile?
: string
; username?
: string
} }[]
AuthInfos is a map of referencable names to user configs.
see
more info