Module: lib/k8s
References
cluster
Renames and re-exports lib/k8s/cluster
clusterRole
Renames and re-exports lib/k8s/clusterRole
clusterRoleBinding
Renames and re-exports lib/k8s/clusterRoleBinding
configMap
Renames and re-exports lib/k8s/configMap
crd
Renames and re-exports lib/k8s/crd
cronJob
Renames and re-exports lib/k8s/cronJob
daemonSet
Renames and re-exports lib/k8s/daemonSet
deployment
Renames and re-exports lib/k8s/deployment
event
Renames and re-exports lib/k8s/event
ingress
Renames and re-exports lib/k8s/ingress
ingressClass
Renames and re-exports lib/k8s/ingressClass
job
Renames and re-exports lib/k8s/job
namespace
Renames and re-exports lib/k8s/namespace
node
Renames and re-exports lib/k8s/node
persistentVolume
Renames and re-exports lib/k8s/persistentVolume
persistentVolumeClaim
Renames and re-exports lib/k8s/persistentVolumeClaim
pod
Renames and re-exports lib/k8s/pod
replicaSet
Renames and re-exports lib/k8s/replicaSet
role
Renames and re-exports lib/k8s/role
roleBinding
Renames and re-exports lib/k8s/roleBinding
secret
Renames and re-exports lib/k8s/secret
service
Renames and re-exports lib/k8s/service
serviceAccount
Renames and re-exports lib/k8s/serviceAccount
statefulSet
Renames and re-exports lib/k8s/statefulSet
storageClass
Renames and re-exports lib/k8s/storageClass
Type aliases
CancellablePromise
Ƭ CancellablePromise: Promise<() => void>
Defined in
Variables
ResourceClasses
• ResourceClasses: Object = resourceClassesDict
Index signature
▪ [className: string]: KubeObject
Defined in
Functions
getVersion
▸ getVersion(clusterName?): Promise<StringDict>
Parameters
| Name | Type | Default value |
|---|---|---|
clusterName | string | '' |
Returns
Promise<StringDict>
Defined in
labelSelectorToQuery
▸ labelSelectorToQuery(labelSelector): string
See Label selector examples, deployment selector example, possible operators, and Format rule for expressions.
Parameters
| Name | Type |
|---|---|
labelSelector | LabelSelector |
Returns
string
Defined in
matchExpressionSimplifier
▸ matchExpressionSimplifier(matchExpressions): string[] | ""
Parameters
| Name | Type |
|---|---|
matchExpressions | undefined | { key: string ; operator: string ; values: string[] }[] |
Returns
string[] | ""
Defined in
matchLabelsSimplifier
▸ matchLabelsSimplifier(matchLabels, isEqualSeperator?): string[] | ""
Parameters
| Name | Type | Default value |
|---|---|---|
matchLabels | undefined | { [key: string]: string; } | undefined |
isEqualSeperator | boolean | false |
Returns
string[] | ""
Defined in
useCluster
▸ useCluster(): null | string
Returns
null | string
Defined in
useClustersConf
▸ useClustersConf(): ConfigState["allClusters"]
Hook for getting or fetching the clusters configuration. This gets the clusters from the redux store. The redux store is updated when the user changes the configuration. The configuration is stored in the local storage. When stateless clusters are present, it combines the stateless clusters with the clusters from the redux store.
Returns
ConfigState["allClusters"]
the clusters configuration.
Defined in
useClustersVersion
▸ useClustersVersion(clusters): readonly [{ [cluster: string]: StringDict; }, { [cluster: string]: ApiError | null; }]
Hook to get the version of the clusters given by the parameter.
Parameters
| Name | Type |
|---|---|
clusters | Cluster[] |
Returns
readonly [{ [cluster: string]: StringDict; }, { [cluster: string]: ApiError | null; }]
a map with cluster -> version-info, and a map with cluster -> error.
Defined in
useConnectApi
▸ useConnectApi(...apiCalls): void
Parameters
| Name | Type |
|---|---|
...apiCalls | () => CancellablePromise[] |
Returns
void