Namespace: K8sApi#
Renderer.K8sApi
Table of contents#
References#
- BaseKubeJsonApiObjectMetadata
- ClusterRole
- ClusterRoleBinding
- ClusterScopedMetadata
- ConfigMap
- CronJob
- CustomResourceDefinition
- DaemonSet
- Deployment
- Endpoint
- HorizontalPodAutoscaler
- HorizontalPodAutoscalerStore
- ILocalKubeApiConfig
- IPodContainer
- IPodContainerStatus
- IRemoteKubeApiConfig
- ISecretRef
- Ingress
- Job
- JsonPatch
- KubeEvent
- KubeJsonApiData
- KubeJsonApiDataFor
- KubeJsonApiObjectMetadata
- KubeObject
- KubeObjectMetadata
- KubeObjectStoreLoadAllParams
- KubeObjectStoreLoadingParams
- KubeObjectStoreSubscribeParams
- KubeStatus
- KubeStatusData
- LimitRange
- Namespace
- NamespaceScopedMetadata
- NetworkPolicy
- Node
- OwnerReference
- PersistentVolume
- PersistentVolumeClaim
- Pod
- PodDisruptionBudget
- PriorityClass
- ReplicaSet
- ResourceQuota
- Role
- RoleBinding
- Secret
- Service
- ServiceAccount
- StatefulSet
- StorageClass
Enumerations#
Classes#
- CRDResourceStore
- CRDStore
- ConfigMapsStore
- CronJobStore
- DaemonSetStore
- DeploymentStore
- EndpointStore
- EventStore
- HPAStore
- IngressClassStore
- IngressStore
- JobStore
- KubeObjectStore
- LimitRangesStore
- NamespaceStore
- NetworkPolicyStore
- NodesStore
- PersistentVolumesStore
- PodDisruptionBudgetsStore
- PodsStore
- PriorityClassStoreStore
- ReplicaSetStore
- ResourceQuotasStore
- ResourceStack
- RoleBindingsStore
- RolesStore
- SecretsStore
- ServiceAccountsStore
- ServiceStore
- StatefulSetStore
- StorageClassStore
- VerticalPodAutoscalerStore
- VolumeClaimStore
Interfaces#
- ExternalKubeApiOptions
- IKubeApiCluster
- IgnoredKubeApiOptions
- KubeObjectStatus
- MetricData
- MetricResult
- RequestMetricsParams
Type Aliases#
- DeploymentApi
- IngressApi
- KubeApi
- KubeJsonApi
- NodesApi
- PersistentVolumeClaimsApi
- PodsApi
- RequestMetrics
Variables#
- DeploymentApi
- IngressApi
- KubeApi
- KubeJsonApi
- NodesApi
- PersistentVolumeClaimsApi
- PodsApi
- apiManager
- clusterRoleApi
- clusterRoleBindingApi
- configMapApi
- crdApi
- cronJobApi
- daemonSetApi
- deploymentApi
- endpointApi
- eventApi
- hpaApi
- ingressApi
- jobApi
- limitRangeApi
- namespacesApi
- networkPolicyApi
- nodesApi
- pcApi
- pdbApi
- persistentVolumeApi
- podsApi
- pvcApi
- replicaSetApi
- resourceQuotaApi
- roleApi
- roleBindingApi
- secretsApi
- serviceAccountsApi
- serviceApi
- statefulSetApi
- storageClassApi
- vpaApi
Functions#
References#
BaseKubeJsonApiObjectMetadata#
Re-exports BaseKubeJsonApiObjectMetadata
ClusterRole#
Re-exports ClusterRole
ClusterRoleBinding#
Re-exports ClusterRoleBinding
ClusterScopedMetadata#
Re-exports ClusterScopedMetadata
ConfigMap#
Re-exports ConfigMap
CronJob#
Re-exports CronJob
CustomResourceDefinition#
Re-exports CustomResourceDefinition
DaemonSet#
Re-exports DaemonSet
Deployment#
Re-exports Deployment
Endpoint#
Re-exports Endpoint
HorizontalPodAutoscaler#
Re-exports HorizontalPodAutoscaler
HorizontalPodAutoscalerStore#
Renames and re-exports HPAStore
ILocalKubeApiConfig#
Re-exports ILocalKubeApiConfig
IPodContainer#
Re-exports IPodContainer
IPodContainerStatus#
Re-exports IPodContainerStatus
IRemoteKubeApiConfig#
Re-exports IRemoteKubeApiConfig
ISecretRef#
Re-exports ISecretRef
Ingress#
Re-exports Ingress
Job#
Re-exports Job
JsonPatch#
Re-exports JsonPatch
KubeEvent#
Re-exports KubeEvent
KubeJsonApiData#
Re-exports KubeJsonApiData
KubeJsonApiDataFor#
Re-exports KubeJsonApiDataFor
KubeJsonApiObjectMetadata#
Re-exports KubeJsonApiObjectMetadata
KubeObject#
Re-exports KubeObject
KubeObjectMetadata#
Re-exports KubeObjectMetadata
KubeObjectStoreLoadAllParams#
Re-exports KubeObjectStoreLoadAllParams
KubeObjectStoreLoadingParams#
Re-exports KubeObjectStoreLoadingParams
KubeObjectStoreSubscribeParams#
Re-exports KubeObjectStoreSubscribeParams
KubeStatus#
Re-exports KubeStatus
KubeStatusData#
Re-exports KubeStatusData
LimitRange#
Re-exports LimitRange
Namespace#
Re-exports Namespace
NamespaceScopedMetadata#
Re-exports NamespaceScopedMetadata
NetworkPolicy#
Re-exports NetworkPolicy
Node#
Re-exports Node
OwnerReference#
Re-exports OwnerReference
PersistentVolume#
Re-exports PersistentVolume
PersistentVolumeClaim#
Re-exports PersistentVolumeClaim
Pod#
Re-exports Pod
PodDisruptionBudget#
Re-exports PodDisruptionBudget
PriorityClass#
Re-exports PriorityClass
ReplicaSet#
Re-exports ReplicaSet
ResourceQuota#
Re-exports ResourceQuota
Role#
Re-exports Role
RoleBinding#
Re-exports RoleBinding
Secret#
Re-exports Secret
Service#
Re-exports Service
ServiceAccount#
Re-exports ServiceAccount
StatefulSet#
Re-exports StatefulSet
StorageClass#
Re-exports StorageClass
Type Aliases#
DeploymentApi#
Ƭ DeploymentApi: InternalDeploymentApi
IngressApi#
Ƭ IngressApi: InternalIngressApi
KubeApi#
Ƭ KubeApi<Object, Data>: InternalKubeApi<Object, Data>
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject = KubeObject |
Data |
extends KubeJsonApiDataFor<Object> = KubeJsonApiDataFor<Object> |
KubeJsonApi#
Ƭ KubeJsonApi: InternalKubeJsonApi
NodesApi#
Ƭ NodesApi: NodeApi
PersistentVolumeClaimsApi#
Ƭ PersistentVolumeClaimsApi: PersistentVolumeClaimApi
PodsApi#
Ƭ PodsApi: PodApi
RequestMetrics#
Ƭ RequestMetrics: ReturnType<typeof requestMetricsInjectable["instantiate"]>
Variables#
DeploymentApi#
• DeploymentApi: (opts?: DerivedKubeApiOptions) => DeploymentApi
Type declaration#
• new DeploymentApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions |
IngressApi#
• IngressApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => IngressApi
Type declaration#
• new IngressApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
KubeApi#
• KubeApi: <Object_1, Data>(opts: KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions) => KubeApi<Object_1, Data>
Type declaration#
• new KubeApi<Object_1, Data>(opts)
Type parameters#
| Name | Type |
|---|---|
Object_1 |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object_1> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> = KubeJsonApiDataFor<Object_1> |
Parameters#
| Name | Type |
|---|---|
opts |
KubeApiOptions<Object_1, Data> & ExternalKubeApiOptions |
KubeJsonApi#
• KubeJsonApi: (config: JsonApiConfig, reqInit?: RequestInit) => KubeJsonApi & { forCluster: CreateKubeJsonApiForCluster }
NodesApi#
• NodesApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => NodeApi
Type declaration#
• new NodesApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
PersistentVolumeClaimsApi#
• PersistentVolumeClaimsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PersistentVolumeClaimApi
Type declaration#
• new PersistentVolumeClaimsApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
PodsApi#
• PodsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PodApi
Type declaration#
• new PodsApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
apiManager#
• Const apiManager: ApiManager
clusterRoleApi#
• Const clusterRoleApi: ClusterRoleApi
clusterRoleBindingApi#
• Const clusterRoleBindingApi: ClusterRoleBindingApi
configMapApi#
• Const configMapApi: ConfigMapApi
crdApi#
• Const crdApi: CustomResourceDefinitionApi
cronJobApi#
• Const cronJobApi: CronJobApi
daemonSetApi#
• Const daemonSetApi: DaemonSetApi
deploymentApi#
• Const deploymentApi: DeploymentApi
endpointApi#
• Const endpointApi: EndpointsApi
eventApi#
• Const eventApi: KubeEventApi
hpaApi#
• Const hpaApi: HorizontalPodAutoscalerApi
ingressApi#
• Const ingressApi: IngressApi
jobApi#
• Const jobApi: JobApi
limitRangeApi#
• Const limitRangeApi: LimitRangeApi
namespacesApi#
• Const namespacesApi: NamespaceApi
networkPolicyApi#
• Const networkPolicyApi: NetworkPolicyApi
nodesApi#
• Const nodesApi: NodeApi
pcApi#
• Const pcApi: PriorityClassApi
pdbApi#
• Const pdbApi: PodDisruptionBudgetApi
persistentVolumeApi#
• Const persistentVolumeApi: PersistentVolumeApi
podsApi#
• Const podsApi: PodApi
pvcApi#
• Const pvcApi: PersistentVolumeClaimApi
replicaSetApi#
• Const replicaSetApi: ReplicaSetApi
resourceQuotaApi#
• Const resourceQuotaApi: ResourceQuotaApi
roleApi#
• Const roleApi: RoleApi
roleBindingApi#
• Const roleBindingApi: RoleBindingApi
secretsApi#
• Const secretsApi: SecretApi
serviceAccountsApi#
• Const serviceAccountsApi: ServiceAccountApi
serviceApi#
• Const serviceApi: ServiceApi
statefulSetApi#
• Const statefulSetApi: StatefulSetApi
storageClassApi#
• Const storageClassApi: StorageClassApi
vpaApi#
• Const vpaApi: VerticalPodAutoscalerApi
Functions#
createResourceStack#
▸ createResourceStack(cluster, name): ResourceApplyingStack
Parameters#
| Name | Type |
|---|---|
cluster |
KubernetesCluster<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> |
name |
string |
Returns#
ResourceApplyingStack
forCluster#
▸ forCluster<Object, Api, Data>(cluster, kubeClass, apiClass): Api
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> |
Api |
extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> |
Parameters#
| Name | Type |
|---|---|
cluster |
ILocalKubeApiConfig |
kubeClass |
KubeObjectConstructor<Object, Data> |
apiClass |
KubeApiConstructor<Object, Api> |
Returns#
Api
▸ forCluster<Object, Data>(cluster, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> |
Parameters#
| Name | Type |
|---|---|
cluster |
ILocalKubeApiConfig |
kubeClass |
KubeObjectConstructor<Object, Data> |
apiClass? |
KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>> |
Returns#
KubeApi<Object, KubeJsonApiDataFor<Object>>
forRemoteCluster#
▸ forRemoteCluster<Object, Api, Data>(config, kubeClass, apiClass): Api
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> |
Api |
extends KubeApi<Object, KubeJsonApiDataFor<Object>, Api> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> |
Parameters#
| Name | Type |
|---|---|
config |
IRemoteKubeApiConfig |
kubeClass |
KubeObjectConstructor<Object, Data> |
apiClass |
KubeApiConstructor<Object, Api> |
Returns#
Api
▸ forRemoteCluster<Object, Data>(config, kubeClass, apiClass?): KubeApi<Object, KubeJsonApiDataFor<Object>>
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> |
Parameters#
| Name | Type |
|---|---|
config |
IRemoteKubeApiConfig |
kubeClass |
KubeObjectConstructor<Object, Data> |
apiClass? |
KubeApiConstructor<Object, KubeApi<Object, KubeJsonApiDataFor<Object>>> |
Returns#
KubeApi<Object, KubeJsonApiDataFor<Object>>
getPodsByOwnerId#
▸ getPodsByOwnerId(ownerId): Pod[]
Parameters#
| Name | Type |
|---|---|
ownerId |
string |
Returns#
Pod[]
isAllowedResource#
▸ isAllowedResource(resources): boolean
Parameters#
| Name | Type |
|---|---|
resources |
KubeResource | KubeResource[] |
Returns#
boolean
requestMetrics#
▸ requestMetrics(query, params?): Promise<MetricData>
Parameters#
| Name | Type |
|---|---|
query |
string |
params? |
RequestMetricsParams |
Returns#
Promise<MetricData>
▸ requestMetrics(query, params?): Promise<MetricData[]>
Parameters#
| Name | Type |
|---|---|
query |
string[] |
params? |
RequestMetricsParams |
Returns#
Promise<MetricData[]>
▸ requestMetrics<Keys>(query, params?): Promise<Record<Keys, MetricData>>
Type parameters#
| Name | Type |
|---|---|
Keys |
extends string |
Parameters#
| Name | Type |
|---|---|
query |
Record<Keys, Partial<Record<string, string>>> |
params? |
RequestMetricsParams |
Returns#
Promise<Record<Keys, MetricData>>