Skip to content

Namespace: K8sApi#

Renderer.K8sApi

Table of contents#

Enumerations#

Classes#

Interfaces#

Variables#

Functions#

Variables#

apiManager#

Const apiManager: ApiManager


clusterRoleApi#

clusterRoleApi: KubeApi<ClusterRole>

Only available within kubernetes cluster pages


clusterRoleBindingApi#

clusterRoleBindingApi: KubeApi<ClusterRoleBinding>

Only available within kubernetes cluster pages


configMapApi#

configMapApi: KubeApi<ConfigMap>

Only available within kubernetes cluster pages


crdApi#

crdApi: KubeApi<CustomResourceDefinition>

Only available within kubernetes cluster pages


cronJobApi#

cronJobApi: CronJobApi

Only available within kubernetes cluster pages


daemonSetApi#

daemonSetApi: DaemonSetApi

Only available within kubernetes cluster pages


deploymentApi#

deploymentApi: DeploymentApi


endpointApi#

endpointApi: KubeApi<Endpoint>


eventApi#

eventApi: KubeApi<KubeEvent>


hpaApi#

hpaApi: KubeApi<HorizontalPodAutoscaler>


ingressApi#

ingressApi: IngressApi


jobApi#

jobApi: JobApi


limitRangeApi#

limitRangeApi: KubeApi<LimitRange>


namespacesApi#

namespacesApi: NamespaceApi


networkPolicyApi#

networkPolicyApi: KubeApi<NetworkPolicy>


nodesApi#

nodesApi: NodesApi


pdbApi#

pdbApi: KubeApi<PodDisruptionBudget>


persistentVolumeApi#

persistentVolumeApi: KubeApi<PersistentVolume>


podsApi#

podsApi: PodsApi


pvcApi#

pvcApi: PersistentVolumeClaimsApi


replicaSetApi#

replicaSetApi: ReplicaSetApi


resourceQuotaApi#

resourceQuotaApi: KubeApi<ResourceQuota>


roleApi#

roleApi: KubeApi<Role>


roleBindingApi#

roleBindingApi: KubeApi<RoleBinding>


secretsApi#

secretsApi: KubeApi<Secret>


serviceAccountsApi#

serviceAccountsApi: KubeApi<ServiceAccount>


serviceApi#

serviceApi: KubeApi<Service>


statefulSetApi#

statefulSetApi: StatefulSetApi


storageClassApi#

storageClassApi: KubeApi<StorageClass>

Functions#

forCluster#

forCluster<T, Y>(cluster, kubeClass, apiClass?): KubeApi<T>

Type parameters#

Name Type
T extends KubeObject<KubeObjectMetadata, any, any, T>
Y extends KubeApi<T, Y> = KubeApi<T>

Parameters#

Name Type Default value
cluster ILocalKubeApiConfig undefined
kubeClass KubeObjectConstructor<T> undefined
apiClass (apiOpts: IKubeApiOptions<T>) => Y null

Returns#

KubeApi<T>


forRemoteCluster#

forRemoteCluster<T, Y>(config, kubeClass, apiClass?): Y

Type parameters#

Name Type
T extends KubeObject<KubeObjectMetadata, any, any, T>
Y extends KubeApi<T, Y> = KubeApi<T>

Parameters#

Name Type Default value
config IRemoteKubeApiConfig undefined
kubeClass KubeObjectConstructor<T> undefined
apiClass (apiOpts: IKubeApiOptions<T>) => Y null

Returns#

Y


isAllowedResource#

isAllowedResource(resource): boolean

Parameters#

Name Type
resource KubeResource | KubeResource[]

Returns#

boolean