Namespace: K8sApi#
Main.K8sApi
Table of contents#
References#
- BaseKubeJsonApiObjectMetadata
- ClusterRole
- ClusterRoleBinding
- ClusterScopedMetadata
- ConfigMap
- CronJob
- CustomResourceDefinition
- DaemonSet
- Deployment
- Endpoint
- HorizontalPodAutoscaler
- ILocalKubeApiConfig
- IPodContainer
- IPodContainerStatus
- IRemoteKubeApiConfig
- ISecretRef
- Ingress
- Job
- JsonPatch
- KubeEvent
- KubeJsonApiData
- 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
Classes#
Interfaces#
Variables#
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
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
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
Variables#
DeploymentApi#
• Const DeploymentApi: (opts?: DerivedKubeApiOptions) => DeploymentApi
Type declaration#
• new DeploymentApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions |
IngressApi#
• Const IngressApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => IngressApi
Type declaration#
• new IngressApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
KubeApi#
• Const KubeApi: <Object, Data>(opts: KubeApiOptions<Object, Data>) => KubeApi<Object, Data>
Type declaration#
• new KubeApi<Object, Data>(opts)
Type parameters#
| Name | Type |
|---|---|
Object |
extends KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Object> = KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown> |
Data |
extends KubeJsonApiData<KubeObjectMetadata<KubeObjectScope>, unknown, unknown, Data> = KubeJsonApiDataFor<Object> |
Parameters#
| Name | Type |
|---|---|
opts |
KubeApiOptions<Object, Data> |
KubeJsonApi#
• Const KubeJsonApi: (config: JsonApiConfig, reqInit?: RequestInit) => KubeJsonApi & { forCluster: CreateKubeJsonApiForCluster }
NodesApi#
• Const NodesApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => NodeApi
Type declaration#
• new NodesApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
PersistentVolumeClaimsApi#
• Const PersistentVolumeClaimsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PersistentVolumeClaimApi
Type declaration#
• new PersistentVolumeClaimsApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
PodsApi#
• Const PodsApi: (opts?: DerivedKubeApiOptions & IgnoredKubeApiOptions) => PodApi
Type declaration#
• new PodsApi(opts?)
Parameters#
| Name | Type |
|---|---|
opts? |
DerivedKubeApiOptions & IgnoredKubeApiOptions |
apiManager#
• Const apiManager: ApiManager
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>>
isAllowedResource#
▸ isAllowedResource(...args): boolean
Deprecated
This function never works
Parameters#
| Name | Type |
|---|---|
...args |
any[] |
Returns#
boolean
false