Skip to content

Module: "renderer-api/k8s-api"#

Index#

Enumerations#

Classes#

Interfaces#

Type aliases#

Variables#

Functions#

Type aliases#

KubeObjectStatus#

Ƭ KubeObjectStatus: object

Defined in src/extensions/renderer-api/kube-object-status.ts:22

Copyright (c) 2021 OpenLens Authors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Type declaration:#

Variables#

Const apiManager#

• apiManager: ApiManager‹› = new ApiManager()

Defined in src/renderer/api/api-manager.ts:89


Const clusterRoleApi#

• clusterRoleApi: KubeApi‹ClusterRole‹›› = new KubeApi({ objectConstructor: ClusterRole, })

Defined in src/renderer/api/endpoints/cluster-role.api.ts:31


Const clusterRoleBindingApi#

• clusterRoleBindingApi: KubeApi‹ClusterRoleBinding‹›› = new KubeApi({ objectConstructor: ClusterRoleBinding, })

Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:31


Const configMapApi#

• configMapApi: KubeApi‹ConfigMap‹›› = new KubeApi({ objectConstructor: ConfigMap, })

Defined in src/renderer/api/endpoints/configmap.api.ts:50


Const crdApi#

• crdApi: KubeApi‹CustomResourceDefinition‹›› = new KubeApi({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, })

Defined in src/renderer/api/endpoints/crd.api.ts:177


Const cronJobApi#

• cronJobApi: CronJobApi‹› = new CronJobApi({ objectConstructor: CronJob, })

Defined in src/renderer/api/endpoints/cron-job.api.ts:143


Const daemonSetApi#

• daemonSetApi: KubeApi‹DaemonSet‹›› = new KubeApi({ objectConstructor: DaemonSet, })

Defined in src/renderer/api/endpoints/daemon-set.api.ts:100


Const deploymentApi#

• deploymentApi: DeploymentApi‹› = new DeploymentApi({ objectConstructor: Deployment, })

Defined in src/renderer/api/endpoints/deployment.api.ts:218


Const endpointApi#

• endpointApi: KubeApi‹Endpoint‹›› = new KubeApi({ objectConstructor: Endpoint, })

Defined in src/renderer/api/endpoints/endpoint.api.ts:155


Const eventApi#

• eventApi: KubeApi‹KubeEvent‹›› = new KubeApi({ objectConstructor: KubeEvent, })

Defined in src/renderer/api/endpoints/events.api.ts:80


Const hpaApi#

• hpaApi: KubeApi‹HorizontalPodAutoscaler‹›› = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, })

Defined in src/renderer/api/endpoints/hpa.api.ts:166


Const ingressApi#

• ingressApi: IngressApi‹› = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: ["/apis/extensions/v1beta1/ingresses"], logStuff: true } as any)

Defined in src/renderer/api/endpoints/ingress.api.ts:205


Const jobApi#

• jobApi: KubeApi‹Job‹›› = new KubeApi({ objectConstructor: Job, })

Defined in src/renderer/api/endpoints/job.api.ts:132


Const limitRangeApi#

• limitRangeApi: KubeApi‹LimitRange‹›› = new KubeApi({ objectConstructor: LimitRange, })

Defined in src/renderer/api/endpoints/limit-range.api.ts:83


Const namespacesApi#

• namespacesApi: KubeApi‹Namespace‹›› = new KubeApi({ objectConstructor: Namespace, })

Defined in src/renderer/api/endpoints/namespaces.api.ts:53


Const networkPolicyApi#

• networkPolicyApi: KubeApi‹NetworkPolicy‹›› = new KubeApi({ objectConstructor: NetworkPolicy, })

Defined in src/renderer/api/endpoints/network-policy.api.ts:99


Const nodesApi#

• nodesApi: NodesApi‹› = new NodesApi({ objectConstructor: Node, })

Defined in src/renderer/api/endpoints/nodes.api.ts:219


Const pdbApi#

• pdbApi: KubeApi‹PodDisruptionBudget‹›› = new KubeApi({ objectConstructor: PodDisruptionBudget, })

Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:75


Const persistentVolumeApi#

• persistentVolumeApi: KubeApi‹PersistentVolume‹›› = new KubeApi({ objectConstructor: PersistentVolume, })

Defined in src/renderer/api/endpoints/persistent-volume.api.ts:105


Const podsApi#

• podsApi: PodsApi‹› = new PodsApi({ objectConstructor: Pod, })

Defined in src/renderer/api/endpoints/pods.api.ts:505


Const pvcApi#

• pvcApi: PersistentVolumeClaimsApi‹› = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, })

Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:118


Const replicaSetApi#

• replicaSetApi: ReplicaSetApi‹› = new ReplicaSetApi({ objectConstructor: ReplicaSet, })

Defined in src/renderer/api/endpoints/replica-set.api.ts:110


Const resourceQuotaApi#

• resourceQuotaApi: KubeApi‹ResourceQuota‹›› = new KubeApi({ objectConstructor: ResourceQuota, })

Defined in src/renderer/api/endpoints/resource-quota.api.ts:83


Const roleApi#

• roleApi: KubeApi‹Role‹›› = new KubeApi({ objectConstructor: Role, })

Defined in src/renderer/api/endpoints/role.api.ts:44


Const roleBindingApi#

• roleBindingApi: KubeApi‹RoleBinding‹›› = new KubeApi({ objectConstructor: RoleBinding, })

Defined in src/renderer/api/endpoints/role-binding.api.ts:62


Const secretsApi#

• secretsApi: KubeApi‹Secret‹›› = new KubeApi({ objectConstructor: Secret, })

Defined in src/renderer/api/endpoints/secret.api.ts:72


Const serviceAccountsApi#

• serviceAccountsApi: KubeApi‹ServiceAccount‹›› = new KubeApi({ objectConstructor: ServiceAccount, })

Defined in src/renderer/api/endpoints/service-accounts.api.ts:55


Const serviceApi#

• serviceApi: KubeApi‹Service‹›› = new KubeApi({ objectConstructor: Service, })

Defined in src/renderer/api/endpoints/service.api.ts:146


Const statefulSetApi#

• statefulSetApi: StatefulSetApi‹› = new StatefulSetApi({ objectConstructor: StatefulSet, })

Defined in src/renderer/api/endpoints/stateful-set.api.ts:136


Const storageClassApi#

• storageClassApi: KubeApi‹StorageClass‹›› = new KubeApi({ objectConstructor: StorageClass, })

Defined in src/renderer/api/endpoints/storage-class.api.ts:65

Functions#

forCluster#

▸ forCluster‹T›(cluster: IKubeApiCluster, kubeClass: IKubeObjectConstructor‹T›): KubeApi‹T›

Defined in src/renderer/api/kube-api.ts:102

Type parameters:

▪ T: KubeObject

Parameters:

Name Type
cluster IKubeApiCluster
kubeClass IKubeObjectConstructor‹T›

Returns: KubeApi‹T›


isAllowedResource#

▸ isAllowedResource(resources: KubeResource | KubeResource[]): boolean

Defined in src/common/rbac.ts:77

Parameters:

Name Type
resources KubeResource | KubeResource[]

Returns: boolean