Namespace: K8sApi#
Renderer.K8sApi
Table of contents#
Enumerations#
Classes#
- CRDResourceStore
- CRDStore
- ClusterRole
- ClusterRoleBinding
- ConfigMap
- ConfigMapsStore
- CronJob
- CronJobStore
- CustomResourceDefinition
- DaemonSet
- DaemonSetStore
- Deployment
- DeploymentApi
- DeploymentStore
- Endpoint
- EndpointStore
- EventStore
- HPAStore
- HorizontalPodAutoscaler
- Ingress
- IngressApi
- IngressStore
- Job
- JobStore
- KubeApi
- KubeEvent
- KubeObject
- KubeObjectStore
- KubeStatus
- LimitRange
- LimitRangesStore
- Namespace
- NamespaceStore
- NetworkPolicy
- NetworkPolicyStore
- Node
- NodesApi
- NodesStore
- PersistentVolume
- PersistentVolumeClaim
- PersistentVolumeClaimsApi
- PersistentVolumesStore
- Pod
- PodDisruptionBudget
- PodDisruptionBudgetsStore
- PodsApi
- PodsStore
- PriorityClass
- PriorityClassStoreStore
- ReplicaSet
- ReplicaSetStore
- ResourceQuota
- ResourceQuotasStore
- ResourceStack
- Role
- RoleBinding
- RoleBindingsStore
- RolesStore
- Secret
- SecretsStore
- Service
- ServiceAccount
- ServiceAccountsStore
- ServiceStore
- StatefulSet
- StatefulSetStore
- StorageClass
- StorageClassStore
- VolumeClaimStore
Interfaces#
- BaseKubeJsonApiObjectMetadata
- IKubeApiCluster
- ILocalKubeApiConfig
- IPodContainer
- IPodContainerStatus
- IRemoteKubeApiConfig
- ISecretRef
- KubeJsonApiData
- KubeObjectStatus
- KubeObjectStoreLoadAllParams
- KubeObjectStoreLoadingParams
- KubeObjectStoreSubscribeParams
- KubeStatusData
- OwnerReference
Type Aliases#
- ClusterScopedMetadata
- JsonPatch
- KubeJsonApiObjectMetadata
- KubeObjectMetadata
- NamespaceScopedMetadata
Variables#
- 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
Functions#
Type Aliases#
ClusterScopedMetadata#
Ƭ ClusterScopedMetadata: KubeObjectMetadata<KubeObjectScope.Cluster>
JsonPatch#
Ƭ JsonPatch: Patch
KubeJsonApiObjectMetadata#
Ƭ KubeJsonApiObjectMetadata<Namespaced>: BaseKubeJsonApiObjectMetadata<Namespaced> & Namespaced extends KubeObjectScope.Namespace ? { namespace: string } : {}
Type parameters#
| Name | Type |
|---|---|
Namespaced |
extends KubeObjectScope = KubeObjectScope |
KubeObjectMetadata#
Ƭ KubeObjectMetadata<Namespaced>: KubeJsonApiObjectMetadata<Namespaced> & { name: string ; resourceVersion: string ; selfLink: string ; uid: string }
Type parameters#
| Name | Type |
|---|---|
Namespaced |
extends KubeObjectScope = KubeObjectScope |
NamespaceScopedMetadata#
Ƭ NamespaceScopedMetadata: KubeObjectMetadata<KubeObjectScope.Namespace>
Variables#
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: NodesApi
pcApi#
• Const pcApi: PriorityClassApi
pdbApi#
• Const pdbApi: PodDisruptionBudgetApi
persistentVolumeApi#
• Const persistentVolumeApi: PersistentVolumeApi
podsApi#
• Const podsApi: PodsApi
pvcApi#
• Const pvcApi: PersistentVolumeClaimsApi
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
Functions#
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 |
(apiOpts: KubeApiOptions<Object, KubeJsonApiDataFor<Object>>) => Api |
Returns#
Api
▸ forCluster<Object, Data>(cluster, kubeClass, apiClass?): KubeApi<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? |
(apiOpts: KubeApiOptions<Object, KubeJsonApiDataFor<Object>>) => KubeApi<Object, KubeJsonApiDataFor<Object>> |
Returns#
KubeApi<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 |
(apiOpts: KubeApiOptions<Object, KubeJsonApiDataFor<Object>>) => Api |
Returns#
Api
▸ forRemoteCluster<Object, Data>(config, kubeClass, apiClass?): KubeApi<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? |
(apiOpts: KubeApiOptions<Object, KubeJsonApiDataFor<Object>>) => KubeApi<Object, KubeJsonApiDataFor<Object>> |
Returns#
KubeApi<Object>
isAllowedResource#
▸ isAllowedResource(resource): boolean
Parameters#
| Name | Type |
|---|---|
resource |
KubeResource | KubeResource[] |
Returns#
boolean