diff --git a/docs/contributing.md b/docs/contributing.md index 717d9b4bf9..ea91d823a7 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,13 +1,13 @@ --- title: Contribution Guidelines -linktitle: Contributing +sidebar_label: Contributing +sidebar_position: 4 --- This section has information on how to contribute to Headlamp. It assumes you have cloned this repository (or your own Github fork). - Any contributions to the project are accepted under the terms of the project's -license ([Apache 2.0](../LICENSE)). +license ([Apache 2.0](https://github.com/headlamp-k8s/headlamp/blob/main/LICENSE)). ## Code of Conduct @@ -69,7 +69,6 @@ For the general guidelines on making PRs/commits easier to review, please check out Kinvolk's [contribution guidelines on git](https://github.com/kinvolk/contribution/tree/master/topics/git.md). - ## Testing The frontend is tested via Storybook related snapshots. So new components should have diff --git a/docs/development/api/_index.md b/docs/development/api/_index.md deleted file mode 100644 index 2ea4690b4d..0000000000 --- a/docs/development/api/_index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "API" -linkTitle: "API" -slug: "_index" ---- - -## Modules - -- [lib/k8s](modules/lib_k8s.md) -- [lib/k8s/apiProxy](modules/lib_k8s_apiProxy.md) -- [lib/k8s/cluster](modules/lib_k8s_cluster.md) -- [lib/k8s/cluster](modules/lib_k8s_cluster.md) -- [lib/k8s/clusterRole](modules/lib_k8s_clusterRole.md) -- [lib/k8s/clusterRoleBinding](modules/lib_k8s_clusterRoleBinding.md) -- [lib/k8s/configMap](modules/lib_k8s_configMap.md) -- [lib/k8s/crd](modules/lib_k8s_crd.md) -- [lib/k8s/cronJob](modules/lib_k8s_cronJob.md) -- [lib/k8s/daemonSet](modules/lib_k8s_daemonSet.md) -- [lib/k8s/deployment](modules/lib_k8s_deployment.md) -- [lib/k8s/endpoints](modules/lib_k8s_endpoints.md) -- [lib/k8s/event](modules/lib_k8s_event.md) -- [lib/k8s/hpa](modules/lib_k8s_hpa.md) -- [lib/k8s/ingress](modules/lib_k8s_ingress.md) -- [lib/k8s/ingressClass](modules/lib_k8s_ingressClass.md) -- [lib/k8s/job](modules/lib_k8s_job.md) -- [lib/k8s/kubeconfig](modules/lib_k8s_kubeconfig.md) -- [lib/k8s/lease](modules/lib_k8s_lease.md) -- [lib/k8s/limitRange](modules/lib_k8s_limitRange.md) -- [lib/k8s/mutatingWebhookConfiguration](modules/lib_k8s_mutatingWebhookConfiguration.md) -- [lib/k8s/namespace](modules/lib_k8s_namespace.md) -- [lib/k8s/networkpolicy](modules/lib_k8s_networkpolicy.md) -- [lib/k8s/node](modules/lib_k8s_node.md) -- [lib/k8s/persistentVolume](modules/lib_k8s_persistentVolume.md) -- [lib/k8s/persistentVolumeClaim](modules/lib_k8s_persistentVolumeClaim.md) -- [lib/k8s/pod](modules/lib_k8s_pod.md) -- [lib/k8s/podDisruptionBudget](modules/lib_k8s_podDisruptionBudget.md) -- [lib/k8s/priorityClass](modules/lib_k8s_priorityClass.md) -- [lib/k8s/priorityClasses](modules/lib_k8s_priorityClasses.md) -- [lib/k8s/replicaSet](modules/lib_k8s_replicaSet.md) -- [lib/k8s/resourceQuota](modules/lib_k8s_resourceQuota.md) -- [lib/k8s/role](modules/lib_k8s_role.md) -- [lib/k8s/roleBinding](modules/lib_k8s_roleBinding.md) -- [lib/k8s/runtime](modules/lib_k8s_runtime.md) -- [lib/k8s/secret](modules/lib_k8s_secret.md) -- [lib/k8s/service](modules/lib_k8s_service.md) -- [lib/k8s/serviceAccount](modules/lib_k8s_serviceAccount.md) -- [lib/k8s/statefulSet](modules/lib_k8s_statefulSet.md) -- [lib/k8s/storageClass](modules/lib_k8s_storageClass.md) -- [lib/k8s/token](modules/lib_k8s_token.md) -- [lib/k8s/validatingWebhookConfiguration](modules/lib_k8s_validatingWebhookConfiguration.md) -- [lib/k8s/vpa](modules/lib_k8s_vpa.md) -- [lib/router](modules/lib_router.md) -- [lib/util](modules/lib_util.md) -- [plugin/lib](modules/plugin_lib.md) -- [plugin/registry](modules/plugin_registry.md) diff --git a/docs/development/api/classes/_index.md b/docs/development/api/classes/_index.md deleted file mode 100644 index 1ed3581679..0000000000 --- a/docs/development/api/classes/_index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: "Classes" ---- \ No newline at end of file diff --git a/docs/development/api/classes/lib_k8s_clusterRole.ClusterRole.md b/docs/development/api/classes/lib_k8s_clusterRole.ClusterRole.md index 77df84f1cb..e07226fb73 100644 --- a/docs/development/api/classes/lib_k8s_clusterRole.ClusterRole.md +++ b/docs/development/api/classes/lib_k8s_clusterRole.ClusterRole.md @@ -1,8 +1,6 @@ ---- -title: "Class: ClusterRole" -linkTitle: "ClusterRole" -slug: "lib_k8s_clusterRole.ClusterRole" ---- +[API](../API.md) / [lib/k8s/clusterRole](../modules/lib_k8s_clusterRole.md) / ClusterRole + +# Class: ClusterRole [lib/k8s/clusterRole](../modules/lib_k8s_clusterRole.md).ClusterRole @@ -30,7 +28,7 @@ slug: "lib_k8s_clusterRole.ClusterRole" #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,7 +46,7 @@ slug: "lib_k8s_clusterRole.ClusterRole" | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Overrides @@ -57,7 +55,7 @@ slug: "lib_k8s_clusterRole.ClusterRole" #### Defined in -[lib/k8s/clusterRole.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/clusterRole.ts#L5) +[lib/k8s/clusterRole.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/clusterRole.ts#L5) ## Accessors @@ -71,7 +69,7 @@ slug: "lib_k8s_clusterRole.ClusterRole" #### Defined in -[lib/k8s/clusterRole.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/clusterRole.ts#L11) +[lib/k8s/clusterRole.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/clusterRole.ts#L11) ___ @@ -89,7 +87,7 @@ Role.rules #### Defined in -[lib/k8s/role.ts:17](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/role.ts#L17) +[lib/k8s/role.ts:17](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/role.ts#L17) ___ @@ -107,7 +105,7 @@ Role.className #### Defined in -[lib/k8s/clusterRole.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/clusterRole.ts#L7) +[lib/k8s/clusterRole.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/clusterRole.ts#L7) ## Methods @@ -133,7 +131,7 @@ Role.className #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -158,7 +156,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -182,7 +180,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -209,7 +207,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -235,7 +233,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -260,7 +258,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -284,4 +282,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_clusterRoleBinding.ClusterRoleBinding.md b/docs/development/api/classes/lib_k8s_clusterRoleBinding.ClusterRoleBinding.md index 3be3f12638..58aff08d5e 100644 --- a/docs/development/api/classes/lib_k8s_clusterRoleBinding.ClusterRoleBinding.md +++ b/docs/development/api/classes/lib_k8s_clusterRoleBinding.ClusterRoleBinding.md @@ -1,8 +1,6 @@ ---- -title: "Class: ClusterRoleBinding" -linkTitle: "ClusterRoleBinding" -slug: "lib_k8s_clusterRoleBinding.ClusterRoleBinding" ---- +[API](../API.md) / [lib/k8s/clusterRoleBinding](../modules/lib_k8s_clusterRoleBinding.md) / ClusterRoleBinding + +# Class: ClusterRoleBinding [lib/k8s/clusterRoleBinding](../modules/lib_k8s_clusterRoleBinding.md).ClusterRoleBinding @@ -30,7 +28,7 @@ slug: "lib_k8s_clusterRoleBinding.ClusterRoleBinding" #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,7 +46,7 @@ slug: "lib_k8s_clusterRoleBinding.ClusterRoleBinding" | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Overrides @@ -57,7 +55,7 @@ slug: "lib_k8s_clusterRoleBinding.ClusterRoleBinding" #### Defined in -[lib/k8s/clusterRoleBinding.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/clusterRoleBinding.ts#L5) +[lib/k8s/clusterRoleBinding.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/clusterRoleBinding.ts#L5) ## Accessors @@ -71,7 +69,7 @@ slug: "lib_k8s_clusterRoleBinding.ClusterRoleBinding" #### Defined in -[lib/k8s/clusterRoleBinding.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/clusterRoleBinding.ts#L11) +[lib/k8s/clusterRoleBinding.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/clusterRoleBinding.ts#L11) ___ @@ -89,7 +87,7 @@ RoleBinding.roleRef #### Defined in -[lib/k8s/roleBinding.ts:21](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/roleBinding.ts#L21) +[lib/k8s/roleBinding.ts:21](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/roleBinding.ts#L21) ___ @@ -107,7 +105,7 @@ RoleBinding.subjects #### Defined in -[lib/k8s/roleBinding.ts:25](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/roleBinding.ts#L25) +[lib/k8s/roleBinding.ts:25](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/roleBinding.ts#L25) ___ @@ -125,7 +123,7 @@ RoleBinding.className #### Defined in -[lib/k8s/clusterRoleBinding.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/clusterRoleBinding.ts#L7) +[lib/k8s/clusterRoleBinding.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/clusterRoleBinding.ts#L7) ## Methods @@ -151,7 +149,7 @@ RoleBinding.className #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -176,7 +174,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -200,7 +198,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -227,7 +225,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -253,7 +251,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -278,7 +276,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -302,4 +300,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_configMap.ConfigMap.md b/docs/development/api/classes/lib_k8s_configMap.ConfigMap.md index 910e3c9e2a..e1cfaccbf5 100644 --- a/docs/development/api/classes/lib_k8s_configMap.ConfigMap.md +++ b/docs/development/api/classes/lib_k8s_configMap.ConfigMap.md @@ -1,8 +1,6 @@ ---- -title: "Class: ConfigMap" -linkTitle: "ConfigMap" -slug: "lib_k8s_configMap.ConfigMap" ---- +[API](../API.md) / [lib/k8s/configMap](../modules/lib_k8s_configMap.md) / ConfigMap + +# Class: ConfigMap [lib/k8s/configMap](../modules/lib_k8s_configMap.md).ConfigMap @@ -30,7 +28,7 @@ makeKubeObject('configMap').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('configMap').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/configMap.ts:9](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/configMap.ts#L9) +[lib/k8s/configMap.ts:9](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/configMap.ts#L9) ___ @@ -66,7 +65,7 @@ makeKubeObject('configMap').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('configMap').className #### Defined in -[lib/k8s/configMap.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/configMap.ts#L11) +[lib/k8s/configMap.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/configMap.ts#L11) ## Methods @@ -106,7 +105,7 @@ makeKubeObject('configMap').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -131,7 +130,7 @@ makeKubeObject('configMap').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -155,7 +154,7 @@ makeKubeObject('configMap').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -182,7 +181,7 @@ makeKubeObject('configMap').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -208,7 +207,7 @@ makeKubeObject('configMap').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -233,7 +232,7 @@ makeKubeObject('configMap').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -257,4 +256,4 @@ makeKubeObject('configMap').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_crd.CustomResourceDefinition.md b/docs/development/api/classes/lib_k8s_crd.CustomResourceDefinition.md index 3abe69bc57..5643d61cdc 100644 --- a/docs/development/api/classes/lib_k8s_crd.CustomResourceDefinition.md +++ b/docs/development/api/classes/lib_k8s_crd.CustomResourceDefinition.md @@ -1,8 +1,6 @@ ---- -title: "Class: CustomResourceDefinition" -linkTitle: "CustomResourceDefinition" -slug: "lib_k8s_crd.CustomResourceDefinition" ---- +[API](../API.md) / [lib/k8s/crd](../modules/lib_k8s_crd.md) / CustomResourceDefinition + +# Class: CustomResourceDefinition [lib/k8s/crd](../modules/lib_k8s_crd.md).CustomResourceDefinition @@ -30,7 +28,7 @@ makeKubeObject('crd').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,18 +46,28 @@ makeKubeObject('crd').constructor | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/crd.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L34) +[lib/k8s/crd.ts:51](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L51) + +___ + +### readOnlyFields + +▪ `Static` **readOnlyFields**: `string`[] + +#### Defined in + +[lib/k8s/crd.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L55) ## Accessors -### isNamespaced +### isNamespacedScope -• `get` **isNamespaced**(): `boolean` +• `get` **isNamespacedScope**(): `boolean` #### Returns @@ -67,7 +75,7 @@ makeKubeObject('crd').constructor #### Defined in -[lib/k8s/crd.ts:75](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L75) +[lib/k8s/crd.ts:97](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L97) ___ @@ -81,7 +89,7 @@ ___ #### Defined in -[lib/k8s/crd.ts:51](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L51) +[lib/k8s/crd.ts:73](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L73) ___ @@ -96,7 +104,8 @@ ___ | Name | Type | | :------ | :------ | | `group` | `string` | -| `names` | { `kind`: `string` ; `listKind`: `string` ; `plural`: `string` ; `singular`: `string` } | +| `names` | { `categories?`: `string`[] ; `kind`: `string` ; `listKind`: `string` ; `plural`: `string` ; `singular`: `string` } | +| `names.categories?` | `string`[] | | `names.kind` | `string` | | `names.listKind` | `string` | | `names.plural` | `string` | @@ -107,7 +116,21 @@ ___ #### Defined in -[lib/k8s/crd.ts:47](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L47) +[lib/k8s/crd.ts:65](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L65) + +___ + +### status + +• `get` **status**(): `undefined` \| { `acceptedNames?`: { `categories?`: `string`[] ; `kind`: `string` ; `plural`: `string` ; `shortNames`: `string`[] } ; `conditions?`: { `lastTransitionTime`: `string` ; `message`: `string` ; `reason`: `string` ; `status`: `string` ; `type`: `string` }[] ; `storedVersions?`: `string`[] } + +#### Returns + +`undefined` \| { `acceptedNames?`: { `categories?`: `string`[] ; `kind`: `string` ; `plural`: `string` ; `shortNames`: `string`[] } ; `conditions?`: { `lastTransitionTime`: `string` ; `message`: `string` ; `reason`: `string` ; `status`: `string` ; `type`: `string` }[] ; `storedVersions?`: `string`[] } + +#### Defined in + +[lib/k8s/crd.ts:69](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L69) ___ @@ -125,7 +148,7 @@ makeKubeObject<KubeCRD\>('crd').className #### Defined in -[lib/k8s/crd.ts:39](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L39) +[lib/k8s/crd.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L57) ___ @@ -139,10 +162,24 @@ ___ #### Defined in -[lib/k8s/crd.ts:43](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L43) +[lib/k8s/crd.ts:61](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L61) ## Methods +### getCategories + +▸ **getCategories**(): `string`[] + +#### Returns + +`string`[] + +#### Defined in + +[lib/k8s/crd.ts:114](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L114) + +___ + ### getMainAPIGroup ▸ **getMainAPIGroup**(): [`string`, `string`, `string`] @@ -153,7 +190,7 @@ ___ #### Defined in -[lib/k8s/crd.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L55) +[lib/k8s/crd.ts:77](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L77) ___ @@ -167,7 +204,7 @@ ___ #### Defined in -[lib/k8s/crd.ts:79](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L79) +[lib/k8s/crd.ts:101](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L101) ___ @@ -193,7 +230,7 @@ makeKubeObject('crd').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -218,7 +255,7 @@ makeKubeObject('crd').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -242,7 +279,7 @@ makeKubeObject('crd').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -269,7 +306,7 @@ makeKubeObject('crd').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -295,7 +332,7 @@ makeKubeObject('crd').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -320,7 +357,7 @@ makeKubeObject('crd').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -344,4 +381,4 @@ makeKubeObject('crd').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_cronJob.CronJob.md b/docs/development/api/classes/lib_k8s_cronJob.CronJob.md index c9a5a6c69e..b15a9ea886 100644 --- a/docs/development/api/classes/lib_k8s_cronJob.CronJob.md +++ b/docs/development/api/classes/lib_k8s_cronJob.CronJob.md @@ -1,8 +1,6 @@ ---- -title: "Class: CronJob" -linkTitle: "CronJob" -slug: "lib_k8s_cronJob.CronJob" ---- +[API](../API.md) / [lib/k8s/cronJob](../modules/lib_k8s_cronJob.md) / CronJob + +# Class: CronJob [lib/k8s/cronJob](../modules/lib_k8s_cronJob.md).CronJob @@ -30,7 +28,7 @@ makeKubeObject('CronJob').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('CronJob').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/cronJob.ts:38](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cronJob.ts#L38) +[lib/k8s/cronJob.ts:38](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cronJob.ts#L38) ___ @@ -66,7 +65,7 @@ makeKubeObject('CronJob').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('CronJob').className #### Defined in -[lib/k8s/cronJob.ts:43](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cronJob.ts#L43) +[lib/k8s/cronJob.ts:43](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cronJob.ts#L43) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/cronJob.ts:47](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cronJob.ts#L47) +[lib/k8s/cronJob.ts:47](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cronJob.ts#L47) ## Methods @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/cronJob.ts:51](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cronJob.ts#L51) +[lib/k8s/cronJob.ts:51](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cronJob.ts#L51) ___ @@ -134,7 +133,7 @@ makeKubeObject('CronJob').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -159,7 +158,7 @@ makeKubeObject('CronJob').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -183,7 +182,7 @@ makeKubeObject('CronJob').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -210,7 +209,7 @@ makeKubeObject('CronJob').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -236,7 +235,7 @@ makeKubeObject('CronJob').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -261,7 +260,7 @@ makeKubeObject('CronJob').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -285,4 +284,4 @@ makeKubeObject('CronJob').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_daemonSet.DaemonSet.md b/docs/development/api/classes/lib_k8s_daemonSet.DaemonSet.md index 194b38f6f4..1e0e15eab5 100644 --- a/docs/development/api/classes/lib_k8s_daemonSet.DaemonSet.md +++ b/docs/development/api/classes/lib_k8s_daemonSet.DaemonSet.md @@ -1,8 +1,6 @@ ---- -title: "Class: DaemonSet" -linkTitle: "DaemonSet" -slug: "lib_k8s_daemonSet.DaemonSet" ---- +[API](../API.md) / [lib/k8s/daemonSet](../modules/lib_k8s_daemonSet.md) / DaemonSet + +# Class: DaemonSet [lib/k8s/daemonSet](../modules/lib_k8s_daemonSet.md).DaemonSet @@ -30,7 +28,7 @@ makeKubeObject('DaemonSet').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('DaemonSet').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/daemonSet.ts:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/daemonSet.ts#L32) +[lib/k8s/daemonSet.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/daemonSet.ts#L32) ___ @@ -66,7 +65,7 @@ makeKubeObject('DaemonSet').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('DaemonSet').className #### Defined in -[lib/k8s/daemonSet.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/daemonSet.ts#L34) +[lib/k8s/daemonSet.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/daemonSet.ts#L34) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/daemonSet.ts:38](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/daemonSet.ts#L38) +[lib/k8s/daemonSet.ts:38](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/daemonSet.ts#L38) ## Methods @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/daemonSet.ts:42](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/daemonSet.ts#L42) +[lib/k8s/daemonSet.ts:42](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/daemonSet.ts#L42) ___ @@ -122,7 +121,7 @@ ___ #### Defined in -[lib/k8s/daemonSet.ts:46](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/daemonSet.ts#L46) +[lib/k8s/daemonSet.ts:46](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/daemonSet.ts#L46) ___ @@ -148,7 +147,7 @@ makeKubeObject('DaemonSet').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -173,7 +172,7 @@ makeKubeObject('DaemonSet').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -197,7 +196,7 @@ makeKubeObject('DaemonSet').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -224,7 +223,7 @@ makeKubeObject('DaemonSet').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -250,7 +249,7 @@ makeKubeObject('DaemonSet').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -275,7 +274,7 @@ makeKubeObject('DaemonSet').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -299,4 +298,4 @@ makeKubeObject('DaemonSet').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_deployment.Deployment.md b/docs/development/api/classes/lib_k8s_deployment.Deployment.md index 320a54b8f8..b86717b58c 100644 --- a/docs/development/api/classes/lib_k8s_deployment.Deployment.md +++ b/docs/development/api/classes/lib_k8s_deployment.Deployment.md @@ -1,8 +1,6 @@ ---- -title: "Class: Deployment" -linkTitle: "Deployment" -slug: "lib_k8s_deployment.Deployment" ---- +[API](../API.md) / [lib/k8s/deployment](../modules/lib_k8s_deployment.md) / Deployment + +# Class: Deployment [lib/k8s/deployment](../modules/lib_k8s_deployment.md).Deployment @@ -30,7 +28,7 @@ makeKubeObject('Deployment').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('Deployment').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/deployment.ts:30](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/deployment.ts#L30) +[lib/k8s/deployment.ts:30](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/deployment.ts#L30) ___ @@ -66,7 +65,7 @@ makeKubeObject('Deployment').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('Deployment').className #### Defined in -[lib/k8s/deployment.ts:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/deployment.ts#L32) +[lib/k8s/deployment.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/deployment.ts#L32) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/deployment.ts:36](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/deployment.ts#L36) +[lib/k8s/deployment.ts:36](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/deployment.ts#L36) ## Methods @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/deployment.ts:40](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/deployment.ts#L40) +[lib/k8s/deployment.ts:40](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/deployment.ts#L40) ___ @@ -122,7 +121,7 @@ ___ #### Defined in -[lib/k8s/deployment.ts:44](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/deployment.ts#L44) +[lib/k8s/deployment.ts:44](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/deployment.ts#L44) ___ @@ -148,7 +147,7 @@ makeKubeObject('Deployment').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -173,7 +172,7 @@ makeKubeObject('Deployment').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -197,7 +196,7 @@ makeKubeObject('Deployment').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -224,7 +223,7 @@ makeKubeObject('Deployment').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -250,7 +249,7 @@ makeKubeObject('Deployment').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -275,7 +274,7 @@ makeKubeObject('Deployment').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -299,4 +298,4 @@ makeKubeObject('Deployment').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_endpoints.Endpoints.md b/docs/development/api/classes/lib_k8s_endpoints.Endpoints.md index 729998dae6..d30f55bf27 100644 --- a/docs/development/api/classes/lib_k8s_endpoints.Endpoints.md +++ b/docs/development/api/classes/lib_k8s_endpoints.Endpoints.md @@ -1,8 +1,6 @@ ---- -title: "Class: Endpoints" -linkTitle: "Endpoints" -slug: "lib_k8s_endpoints.Endpoints" ---- +[API](../API.md) / [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md) / Endpoints + +# Class: Endpoints [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md).Endpoints @@ -30,7 +28,7 @@ makeKubeObject('endpoint').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('endpoint').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/endpoints.ts:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L32) +[lib/k8s/endpoints.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L32) ___ @@ -66,7 +65,7 @@ makeKubeObject('endpoint').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('endpoint').className #### Defined in -[lib/k8s/endpoints.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L34) +[lib/k8s/endpoints.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L34) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:38](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L38) +[lib/k8s/endpoints.ts:38](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L38) ___ @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:42](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L42) +[lib/k8s/endpoints.ts:42](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L42) ## Methods @@ -122,7 +121,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:50](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L50) +[lib/k8s/endpoints.ts:50](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L50) ___ @@ -136,7 +135,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:46](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L46) +[lib/k8s/endpoints.ts:46](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L46) ___ @@ -162,7 +161,7 @@ makeKubeObject('endpoint').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -187,7 +186,7 @@ makeKubeObject('endpoint').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -211,7 +210,7 @@ makeKubeObject('endpoint').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -238,7 +237,7 @@ makeKubeObject('endpoint').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -264,7 +263,7 @@ makeKubeObject('endpoint').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -289,7 +288,7 @@ makeKubeObject('endpoint').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -313,4 +312,4 @@ makeKubeObject('endpoint').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_event.Event.md b/docs/development/api/classes/lib_k8s_event.Event.md index aa2f22a7aa..28df1d9658 100644 --- a/docs/development/api/classes/lib_k8s_event.Event.md +++ b/docs/development/api/classes/lib_k8s_event.Event.md @@ -1,8 +1,6 @@ ---- -title: "Class: Event" -linkTitle: "Event" -slug: "lib_k8s_event.Event" ---- +[API](../API.md) / [lib/k8s/event](../modules/lib_k8s_event.md) / Event + +# Class: Event [lib/k8s/event](../modules/lib_k8s_event.md).Event @@ -30,7 +28,7 @@ makeKubeObject('Event').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('Event').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/event.ts:25](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L25) +[lib/k8s/event.ts:25](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L25) ___ @@ -66,7 +65,7 @@ makeKubeObject('Event').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('Event').className #### Defined in -[lib/k8s/event.ts:68](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L68) +[lib/k8s/event.ts:68](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L68) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/event.ts:102](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L102) +[lib/k8s/event.ts:102](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L102) ___ @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/event.ts:48](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L48) +[lib/k8s/event.ts:48](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L48) ___ @@ -122,7 +121,7 @@ ___ #### Defined in -[lib/k8s/event.ts:147](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L147) +[lib/k8s/event.ts:147](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L147) ___ @@ -136,7 +135,7 @@ ___ #### Defined in -[lib/k8s/event.ts:77](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L77) +[lib/k8s/event.ts:77](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L77) ___ @@ -150,7 +149,7 @@ ___ #### Defined in -[lib/k8s/event.ts:60](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L60) +[lib/k8s/event.ts:60](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L60) ___ @@ -164,7 +163,7 @@ ___ #### Defined in -[lib/k8s/event.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L56) +[lib/k8s/event.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L56) ___ @@ -178,7 +177,7 @@ ___ #### Defined in -[lib/k8s/event.ts:64](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L64) +[lib/k8s/event.ts:64](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L64) ___ @@ -192,7 +191,7 @@ ___ #### Defined in -[lib/k8s/event.ts:40](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L40) +[lib/k8s/event.ts:40](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L40) ___ @@ -206,7 +205,7 @@ ___ #### Defined in -[lib/k8s/event.ts:44](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L44) +[lib/k8s/event.ts:44](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L44) ___ @@ -220,7 +219,7 @@ ___ #### Defined in -[lib/k8s/event.ts:52](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L52) +[lib/k8s/event.ts:52](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L52) ___ @@ -234,7 +233,7 @@ ___ #### Defined in -[lib/k8s/event.ts:31](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L31) +[lib/k8s/event.ts:31](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L31) • `Static` `set` **maxLimit**(`limit`): `void` @@ -250,7 +249,7 @@ ___ #### Defined in -[lib/k8s/event.ts:36](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L36) +[lib/k8s/event.ts:36](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L36) ## Methods @@ -276,7 +275,7 @@ makeKubeObject('Event').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -301,7 +300,7 @@ makeKubeObject('Event').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -325,7 +324,7 @@ makeKubeObject('Event').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -345,7 +344,7 @@ ___ #### Defined in -[lib/k8s/event.ts:117](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L117) +[lib/k8s/event.ts:117](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L117) ___ @@ -372,7 +371,7 @@ makeKubeObject('Event').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -398,7 +397,7 @@ makeKubeObject('Event').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -423,7 +422,7 @@ makeKubeObject('Event').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -447,7 +446,7 @@ makeKubeObject('Event').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) ___ @@ -469,7 +468,7 @@ ___ #### Defined in -[lib/k8s/event.ts:167](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L167) +[lib/k8s/event.ts:167](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L167) ___ @@ -491,4 +490,4 @@ ___ #### Defined in -[lib/k8s/event.ts:238](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L238) +[lib/k8s/event.ts:238](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L238) diff --git a/docs/development/api/classes/lib_k8s_hpa.HPA.md b/docs/development/api/classes/lib_k8s_hpa.HPA.md index 6391680086..94ad7d38d5 100644 --- a/docs/development/api/classes/lib_k8s_hpa.HPA.md +++ b/docs/development/api/classes/lib_k8s_hpa.HPA.md @@ -1,8 +1,6 @@ ---- -title: "Class: HPA" -linkTitle: "HPA" -slug: "lib_k8s_hpa.HPA" ---- +[API](../API.md) / [lib/k8s/hpa](../modules/lib_k8s_hpa.md) / HPA + +# Class: HPA [lib/k8s/hpa](../modules/lib_k8s_hpa.md).HPA @@ -30,7 +28,7 @@ makeKubeObject('horizontalPodAutoscaler').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('horizontalPodAutoscaler').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/hpa.ts:170](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L170) +[lib/k8s/hpa.ts:170](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L170) ___ @@ -66,7 +65,7 @@ makeKubeObject('horizontalPodAutoscaler').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('horizontalPodAutoscaler').className #### Defined in -[lib/k8s/hpa.ts:336](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L336) +[lib/k8s/hpa.ts:336](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L336) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/hpa.ts:172](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L172) +[lib/k8s/hpa.ts:172](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L172) ___ @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/hpa.ts:176](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L176) +[lib/k8s/hpa.ts:176](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L176) ## Methods @@ -128,7 +127,7 @@ ___ #### Defined in -[lib/k8s/hpa.ts:180](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L180) +[lib/k8s/hpa.ts:180](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L180) ___ @@ -154,7 +153,7 @@ makeKubeObject('horizontalPodAutoscaler').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -179,7 +178,7 @@ makeKubeObject('horizontalPodAutoscaler').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -203,7 +202,7 @@ makeKubeObject('horizontalPodAutoscaler').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -230,7 +229,7 @@ makeKubeObject('horizontalPodAutoscaler').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -256,7 +255,7 @@ makeKubeObject('horizontalPodAutoscaler').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -281,7 +280,7 @@ makeKubeObject('horizontalPodAutoscaler').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -305,4 +304,4 @@ makeKubeObject('horizontalPodAutoscaler').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_ingress.Ingress.md b/docs/development/api/classes/lib_k8s_ingress.Ingress.md index 6222339e86..49be90a644 100644 --- a/docs/development/api/classes/lib_k8s_ingress.Ingress.md +++ b/docs/development/api/classes/lib_k8s_ingress.Ingress.md @@ -1,8 +1,6 @@ ---- -title: "Class: Ingress" -linkTitle: "Ingress" -slug: "lib_k8s_ingress.Ingress" ---- +[API](../API.md) / [lib/k8s/ingress](../modules/lib_k8s_ingress.md) / Ingress + +# Class: Ingress [lib/k8s/ingress](../modules/lib_k8s_ingress.md).Ingress @@ -30,7 +28,7 @@ makeKubeObject('ingress').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('ingress').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/ingress.ts:72](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L72) +[lib/k8s/ingress.ts:72](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L72) ___ @@ -66,7 +65,7 @@ makeKubeObject('ingress').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -96,7 +95,7 @@ makeKubeObject('ingress').className #### Defined in -[lib/k8s/ingress.ts:79](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L79) +[lib/k8s/ingress.ts:79](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L79) ___ @@ -110,7 +109,7 @@ ___ #### Defined in -[lib/k8s/ingress.ts:126](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L126) +[lib/k8s/ingress.ts:126](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L126) ___ @@ -124,7 +123,7 @@ ___ #### Defined in -[lib/k8s/ingress.ts:130](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L130) +[lib/k8s/ingress.ts:130](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L130) ## Methods @@ -138,7 +137,7 @@ ___ #### Defined in -[lib/k8s/ingress.ts:83](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L83) +[lib/k8s/ingress.ts:83](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L83) ___ @@ -152,7 +151,7 @@ ___ #### Defined in -[lib/k8s/ingress.ts:87](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L87) +[lib/k8s/ingress.ts:87](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L87) ___ @@ -178,7 +177,7 @@ makeKubeObject('ingress').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -203,7 +202,7 @@ makeKubeObject('ingress').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -227,7 +226,7 @@ makeKubeObject('ingress').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -254,7 +253,7 @@ makeKubeObject('ingress').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -280,7 +279,7 @@ makeKubeObject('ingress').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -305,7 +304,7 @@ makeKubeObject('ingress').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -329,4 +328,4 @@ makeKubeObject('ingress').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_ingressClass.IngressClass.md b/docs/development/api/classes/lib_k8s_ingressClass.IngressClass.md index 290daf3d26..0fcb3ff6db 100644 --- a/docs/development/api/classes/lib_k8s_ingressClass.IngressClass.md +++ b/docs/development/api/classes/lib_k8s_ingressClass.IngressClass.md @@ -1,8 +1,6 @@ ---- -title: "Class: IngressClass" -linkTitle: "IngressClass" -slug: "lib_k8s_ingressClass.IngressClass" ---- +[API](../API.md) / [lib/k8s/ingressClass](../modules/lib_k8s_ingressClass.md) / IngressClass + +# Class: IngressClass [lib/k8s/ingressClass](../modules/lib_k8s_ingressClass.md).IngressClass @@ -30,7 +28,7 @@ makeKubeObject('ingressClass').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,12 +46,12 @@ makeKubeObject('ingressClass').constructor | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/ingressClass.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingressClass.ts#L12) +[lib/k8s/ingressClass.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingressClass.ts#L12) ___ @@ -67,7 +65,7 @@ makeKubeObject('ingressClass').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -81,7 +79,7 @@ makeKubeObject('ingressClass').className #### Defined in -[lib/k8s/ingressClass.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingressClass.ts#L18) +[lib/k8s/ingressClass.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingressClass.ts#L18) ___ @@ -99,7 +97,7 @@ ___ #### Defined in -[lib/k8s/ingressClass.ts:14](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingressClass.ts#L14) +[lib/k8s/ingressClass.ts:14](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingressClass.ts#L14) ___ @@ -113,7 +111,7 @@ ___ #### Defined in -[lib/k8s/ingressClass.ts:26](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingressClass.ts#L26) +[lib/k8s/ingressClass.ts:26](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingressClass.ts#L26) ___ @@ -127,7 +125,7 @@ ___ #### Defined in -[lib/k8s/ingressClass.ts:30](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingressClass.ts#L30) +[lib/k8s/ingressClass.ts:30](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingressClass.ts#L30) ## Methods @@ -153,7 +151,7 @@ makeKubeObject('ingressClass').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -178,7 +176,7 @@ makeKubeObject('ingressClass').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -202,7 +200,7 @@ makeKubeObject('ingressClass').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -229,7 +227,7 @@ makeKubeObject('ingressClass').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -255,7 +253,7 @@ makeKubeObject('ingressClass').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -280,7 +278,7 @@ makeKubeObject('ingressClass').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -304,4 +302,4 @@ makeKubeObject('ingressClass').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_job.Job.md b/docs/development/api/classes/lib_k8s_job.Job.md index 10e544f4eb..0a4c78b5bb 100644 --- a/docs/development/api/classes/lib_k8s_job.Job.md +++ b/docs/development/api/classes/lib_k8s_job.Job.md @@ -1,8 +1,6 @@ ---- -title: "Class: Job" -linkTitle: "Job" -slug: "lib_k8s_job.Job" ---- +[API](../API.md) / [lib/k8s/job](../modules/lib_k8s_job.md) / Job + +# Class: Job [lib/k8s/job](../modules/lib_k8s_job.md).Job @@ -30,7 +28,7 @@ makeKubeObject('Job').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('Job').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/job.ts:26](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/job.ts#L26) +[lib/k8s/job.ts:26](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/job.ts#L26) ___ @@ -66,7 +65,7 @@ makeKubeObject('Job').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('Job').className #### Defined in -[lib/k8s/job.ts:28](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/job.ts#L28) +[lib/k8s/job.ts:28](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/job.ts#L28) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/job.ts:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/job.ts#L32) +[lib/k8s/job.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/job.ts#L32) ## Methods @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/job.ts:36](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/job.ts#L36) +[lib/k8s/job.ts:36](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/job.ts#L36) ___ @@ -124,7 +123,7 @@ Returns the duration of the job in milliseconds. #### Defined in -[lib/k8s/job.ts:41](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/job.ts#L41) +[lib/k8s/job.ts:41](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/job.ts#L41) ___ @@ -150,7 +149,7 @@ makeKubeObject('Job').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -175,7 +174,7 @@ makeKubeObject('Job').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -199,7 +198,7 @@ makeKubeObject('Job').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -226,7 +225,7 @@ makeKubeObject('Job').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -252,7 +251,7 @@ makeKubeObject('Job').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -277,7 +276,7 @@ makeKubeObject('Job').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -301,4 +300,4 @@ makeKubeObject('Job').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_lease.Lease.md b/docs/development/api/classes/lib_k8s_lease.Lease.md index 766f769614..5c4d5ee408 100644 --- a/docs/development/api/classes/lib_k8s_lease.Lease.md +++ b/docs/development/api/classes/lib_k8s_lease.Lease.md @@ -1,8 +1,6 @@ ---- -title: "Class: Lease" -linkTitle: "Lease" -slug: "lib_k8s_lease.Lease" ---- +[API](../API.md) / [lib/k8s/lease](../modules/lib_k8s_lease.md) / Lease + +# Class: Lease [lib/k8s/lease](../modules/lib_k8s_lease.md).Lease @@ -30,7 +28,7 @@ makeKubeObject('Lease').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('Lease').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/lease.ts:16](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/lease.ts#L16) +[lib/k8s/lease.ts:16](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/lease.ts#L16) ___ @@ -66,7 +65,7 @@ makeKubeObject('Lease').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('Lease').className #### Defined in -[lib/k8s/lease.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/lease.ts#L18) +[lib/k8s/lease.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/lease.ts#L18) ## Methods @@ -106,7 +105,7 @@ makeKubeObject('Lease').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -131,7 +130,7 @@ makeKubeObject('Lease').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -155,7 +154,7 @@ makeKubeObject('Lease').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -182,7 +181,7 @@ makeKubeObject('Lease').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -208,7 +207,7 @@ makeKubeObject('Lease').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -233,7 +232,7 @@ makeKubeObject('Lease').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -257,4 +256,4 @@ makeKubeObject('Lease').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_limitRange.LimitRange.md b/docs/development/api/classes/lib_k8s_limitRange.LimitRange.md index 91fe059ee9..445d87ca0e 100644 --- a/docs/development/api/classes/lib_k8s_limitRange.LimitRange.md +++ b/docs/development/api/classes/lib_k8s_limitRange.LimitRange.md @@ -1,8 +1,6 @@ ---- -title: "Class: LimitRange" -linkTitle: "LimitRange" -slug: "lib_k8s_limitRange.LimitRange" ---- +[API](../API.md) / [lib/k8s/limitRange](../modules/lib_k8s_limitRange.md) / LimitRange + +# Class: LimitRange [lib/k8s/limitRange](../modules/lib_k8s_limitRange.md).LimitRange @@ -30,7 +28,7 @@ makeKubeObject('LimitRange').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('LimitRange').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/limitRange.tsx:31](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/limitRange.tsx#L31) +[lib/k8s/limitRange.tsx:31](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/limitRange.tsx#L31) ___ @@ -66,7 +65,7 @@ makeKubeObject('LimitRange').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('LimitRange').className #### Defined in -[lib/k8s/limitRange.tsx:33](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/limitRange.tsx#L33) +[lib/k8s/limitRange.tsx:33](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/limitRange.tsx#L33) ## Methods @@ -106,7 +105,7 @@ makeKubeObject('LimitRange').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -131,7 +130,7 @@ makeKubeObject('LimitRange').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -155,7 +154,7 @@ makeKubeObject('LimitRange').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -182,7 +181,7 @@ makeKubeObject('LimitRange').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -208,7 +207,7 @@ makeKubeObject('LimitRange').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -233,7 +232,7 @@ makeKubeObject('LimitRange').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -257,4 +256,4 @@ makeKubeObject('LimitRange').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_mutatingWebhookConfiguration.MutatingWebhookConfiguration.md b/docs/development/api/classes/lib_k8s_mutatingWebhookConfiguration.MutatingWebhookConfiguration.md index 6bdd7826d3..5beb9e5425 100644 --- a/docs/development/api/classes/lib_k8s_mutatingWebhookConfiguration.MutatingWebhookConfiguration.md +++ b/docs/development/api/classes/lib_k8s_mutatingWebhookConfiguration.MutatingWebhookConfiguration.md @@ -1,8 +1,6 @@ ---- -title: "Class: MutatingWebhookConfiguration" -linkTitle: "MutatingWebhookConfiguration" -slug: "lib_k8s_mutatingWebhookConfiguration.MutatingWebhookConfiguration" ---- +[API](../API.md) / [lib/k8s/mutatingWebhookConfiguration](../modules/lib_k8s_mutatingWebhookConfiguration.md) / MutatingWebhookConfiguration + +# Class: MutatingWebhookConfiguration [lib/k8s/mutatingWebhookConfiguration](../modules/lib_k8s_mutatingWebhookConfiguration.md).MutatingWebhookConfiguration @@ -32,7 +30,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -50,12 +48,12 @@ makeKubeObject( | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:48](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L48) +[lib/k8s/mutatingWebhookConfiguration.ts:48](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L48) ___ @@ -71,7 +69,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -85,7 +83,7 @@ makeKubeObject( #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L54) +[lib/k8s/mutatingWebhookConfiguration.ts:54](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L54) ## Methods @@ -113,7 +111,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -140,7 +138,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -166,7 +164,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -195,7 +193,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -223,7 +221,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -250,7 +248,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -276,4 +274,4 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_namespace.Namespace.md b/docs/development/api/classes/lib_k8s_namespace.Namespace.md index dc023bad1a..2923dbbbe1 100644 --- a/docs/development/api/classes/lib_k8s_namespace.Namespace.md +++ b/docs/development/api/classes/lib_k8s_namespace.Namespace.md @@ -1,8 +1,6 @@ ---- -title: "Class: Namespace" -linkTitle: "Namespace" -slug: "lib_k8s_namespace.Namespace" ---- +[API](../API.md) / [lib/k8s/namespace](../modules/lib_k8s_namespace.md) / Namespace + +# Class: Namespace [lib/k8s/namespace](../modules/lib_k8s_namespace.md).Namespace @@ -30,7 +28,7 @@ makeKubeObject('namespace').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,12 +46,12 @@ makeKubeObject('namespace').constructor | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/namespace.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/namespace.ts#L11) +[lib/k8s/namespace.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/namespace.ts#L11) ___ @@ -67,7 +65,7 @@ makeKubeObject('namespace').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -81,7 +79,7 @@ makeKubeObject('namespace').className #### Defined in -[lib/k8s/namespace.ts:13](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/namespace.ts#L13) +[lib/k8s/namespace.ts:13](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/namespace.ts#L13) ## Methods @@ -107,7 +105,7 @@ makeKubeObject('namespace').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -132,7 +130,7 @@ makeKubeObject('namespace').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -156,7 +154,35 @@ makeKubeObject('namespace').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) + +___ + +### isValidNamespaceFormat + +▸ `Static` **isValidNamespaceFormat**(`namespace`): `boolean` + +This function validates the custom namespace input matches the crieria for DNS-1123 label names. + +**`params`** namespace: string + +**`see`** https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `namespace` | `string` | + +#### Returns + +`boolean` + +true if the namespace is valid, false otherwise. + +#### Defined in + +[lib/k8s/namespace.ts:23](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/namespace.ts#L23) ___ @@ -183,7 +209,7 @@ makeKubeObject('namespace').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -209,7 +235,7 @@ makeKubeObject('namespace').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -234,7 +260,7 @@ makeKubeObject('namespace').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -258,4 +284,4 @@ makeKubeObject('namespace').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_networkpolicy.NetworkPolicy.md b/docs/development/api/classes/lib_k8s_networkpolicy.NetworkPolicy.md index 0906c6a571..1ee14205a4 100644 --- a/docs/development/api/classes/lib_k8s_networkpolicy.NetworkPolicy.md +++ b/docs/development/api/classes/lib_k8s_networkpolicy.NetworkPolicy.md @@ -1,8 +1,6 @@ ---- -title: "Class: NetworkPolicy" -linkTitle: "NetworkPolicy" -slug: "lib_k8s_networkpolicy.NetworkPolicy" ---- +[API](../API.md) / [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md) / NetworkPolicy + +# Class: NetworkPolicy [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md).NetworkPolicy @@ -30,7 +28,7 @@ makeKubeObject('NetworkPolicy').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('NetworkPolicy').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/networkpolicy.tsx:39](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L39) +[lib/k8s/networkpolicy.tsx:39](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L39) ___ @@ -66,7 +65,7 @@ makeKubeObject('NetworkPolicy').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('NetworkPolicy').className #### Defined in -[lib/k8s/networkpolicy.tsx:41](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L41) +[lib/k8s/networkpolicy.tsx:41](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L41) ## Methods @@ -106,7 +105,7 @@ makeKubeObject('NetworkPolicy').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -131,7 +130,7 @@ makeKubeObject('NetworkPolicy').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -155,7 +154,7 @@ makeKubeObject('NetworkPolicy').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -182,7 +181,7 @@ makeKubeObject('NetworkPolicy').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -208,7 +207,7 @@ makeKubeObject('NetworkPolicy').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -233,7 +232,7 @@ makeKubeObject('NetworkPolicy').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -257,4 +256,4 @@ makeKubeObject('NetworkPolicy').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_node.Node.md b/docs/development/api/classes/lib_k8s_node.Node.md index c019886ed8..bc59199833 100644 --- a/docs/development/api/classes/lib_k8s_node.Node.md +++ b/docs/development/api/classes/lib_k8s_node.Node.md @@ -1,8 +1,6 @@ ---- -title: "Class: Node" -linkTitle: "Node" -slug: "lib_k8s_node.Node" ---- +[API](../API.md) / [lib/k8s/node](../modules/lib_k8s_node.md) / Node + +# Class: Node [lib/k8s/node](../modules/lib_k8s_node.md).Node @@ -30,7 +28,7 @@ makeKubeObject('node').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,12 +46,12 @@ makeKubeObject('node').constructor | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/node.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/node.ts#L56) +[lib/k8s/node.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/node.ts#L56) ___ @@ -67,7 +65,7 @@ makeKubeObject('node').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -86,7 +84,7 @@ makeKubeObject('node').className #### Defined in -[lib/k8s/node.ts:62](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/node.ts#L62) +[lib/k8s/node.ts:62](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/node.ts#L62) ___ @@ -130,7 +128,7 @@ ___ #### Defined in -[lib/k8s/node.ts:58](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/node.ts#L58) +[lib/k8s/node.ts:58](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/node.ts#L58) ## Methods @@ -144,7 +142,7 @@ ___ #### Defined in -[lib/k8s/node.ts:83](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/node.ts#L83) +[lib/k8s/node.ts:83](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/node.ts#L83) ___ @@ -158,7 +156,7 @@ ___ #### Defined in -[lib/k8s/node.ts:87](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/node.ts#L87) +[lib/k8s/node.ts:87](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/node.ts#L87) ___ @@ -184,7 +182,7 @@ makeKubeObject('node').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -209,7 +207,7 @@ makeKubeObject('node').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -233,7 +231,7 @@ makeKubeObject('node').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -260,7 +258,7 @@ makeKubeObject('node').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -286,7 +284,7 @@ makeKubeObject('node').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -311,7 +309,7 @@ makeKubeObject('node').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -335,7 +333,7 @@ makeKubeObject('node').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) ___ @@ -349,4 +347,4 @@ ___ #### Defined in -[lib/k8s/node.ts:66](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/node.ts#L66) +[lib/k8s/node.ts:66](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/node.ts#L66) diff --git a/docs/development/api/classes/lib_k8s_persistentVolume.PersistentVolume.md b/docs/development/api/classes/lib_k8s_persistentVolume.PersistentVolume.md index 6a5d298a67..d3ce80536f 100644 --- a/docs/development/api/classes/lib_k8s_persistentVolume.PersistentVolume.md +++ b/docs/development/api/classes/lib_k8s_persistentVolume.PersistentVolume.md @@ -1,8 +1,6 @@ ---- -title: "Class: PersistentVolume" -linkTitle: "PersistentVolume" -slug: "lib_k8s_persistentVolume.PersistentVolume" ---- +[API](../API.md) / [lib/k8s/persistentVolume](../modules/lib_k8s_persistentVolume.md) / PersistentVolume + +# Class: PersistentVolume [lib/k8s/persistentVolume](../modules/lib_k8s_persistentVolume.md).PersistentVolume @@ -30,7 +28,7 @@ makeKubeObject('persistentVolume').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,12 +46,12 @@ makeKubeObject('persistentVolume').constructor | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/persistentVolume.ts:19](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolume.ts#L19) +[lib/k8s/persistentVolume.ts:19](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolume.ts#L19) ___ @@ -67,7 +65,7 @@ makeKubeObject('persistentVolume').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -81,7 +79,7 @@ makeKubeObject('persistentVolume').className #### Defined in -[lib/k8s/persistentVolume.ts:21](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolume.ts#L21) +[lib/k8s/persistentVolume.ts:21](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolume.ts#L21) ___ @@ -95,7 +93,7 @@ ___ #### Defined in -[lib/k8s/persistentVolume.ts:25](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolume.ts#L25) +[lib/k8s/persistentVolume.ts:25](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolume.ts#L25) ## Methods @@ -121,7 +119,7 @@ makeKubeObject('persistentVolume').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -146,7 +144,7 @@ makeKubeObject('persistentVolume').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -170,7 +168,7 @@ makeKubeObject('persistentVolume').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -197,7 +195,7 @@ makeKubeObject('persistentVolume').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -223,7 +221,7 @@ makeKubeObject('persistentVolume').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -248,7 +246,7 @@ makeKubeObject('persistentVolume').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -272,4 +270,4 @@ makeKubeObject('persistentVolume').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_persistentVolumeClaim.PersistentVolumeClaim.md b/docs/development/api/classes/lib_k8s_persistentVolumeClaim.PersistentVolumeClaim.md index e723de0302..c7db1ad080 100644 --- a/docs/development/api/classes/lib_k8s_persistentVolumeClaim.PersistentVolumeClaim.md +++ b/docs/development/api/classes/lib_k8s_persistentVolumeClaim.PersistentVolumeClaim.md @@ -1,8 +1,6 @@ ---- -title: "Class: PersistentVolumeClaim" -linkTitle: "PersistentVolumeClaim" -slug: "lib_k8s_persistentVolumeClaim.PersistentVolumeClaim" ---- +[API](../API.md) / [lib/k8s/persistentVolumeClaim](../modules/lib_k8s_persistentVolumeClaim.md) / PersistentVolumeClaim + +# Class: PersistentVolumeClaim [lib/k8s/persistentVolumeClaim](../modules/lib_k8s_persistentVolumeClaim.md).PersistentVolumeClaim @@ -32,7 +30,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,13 +46,14 @@ makeKubeObject( | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/persistentVolumeClaim.ts:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolumeClaim.ts#L32) +[lib/k8s/persistentVolumeClaim.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolumeClaim.ts#L32) ___ @@ -70,7 +69,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -84,7 +83,7 @@ makeKubeObject( #### Defined in -[lib/k8s/persistentVolumeClaim.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolumeClaim.ts#L34) +[lib/k8s/persistentVolumeClaim.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolumeClaim.ts#L34) ___ @@ -98,7 +97,7 @@ ___ #### Defined in -[lib/k8s/persistentVolumeClaim.ts:38](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolumeClaim.ts#L38) +[lib/k8s/persistentVolumeClaim.ts:38](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolumeClaim.ts#L38) ## Methods @@ -126,7 +125,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -153,7 +152,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -179,7 +178,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -208,7 +207,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -236,7 +235,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -263,7 +262,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -289,4 +288,4 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_pod.Pod.md b/docs/development/api/classes/lib_k8s_pod.Pod.md index 5be46a470d..e2930ddc23 100644 --- a/docs/development/api/classes/lib_k8s_pod.Pod.md +++ b/docs/development/api/classes/lib_k8s_pod.Pod.md @@ -1,8 +1,6 @@ ---- -title: "Class: Pod" -linkTitle: "Pod" -slug: "lib_k8s_pod.Pod" ---- +[API](../API.md) / [lib/k8s/pod](../modules/lib_k8s_pod.md) / Pod + +# Class: Pod [lib/k8s/pod](../modules/lib_k8s_pod.md).Pod @@ -30,7 +28,7 @@ makeKubeObject<KubePod\>('Pod').constructor #### Defined in -[lib/k8s/pod.ts:93](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L93) +[lib/k8s/pod.ts:93](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L93) ## Properties @@ -46,13 +44,14 @@ makeKubeObject<KubePod\>('Pod').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/pod.ts:90](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L90) +[lib/k8s/pod.ts:90](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L90) ___ @@ -66,7 +65,7 @@ makeKubeObject('Pod').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('Pod').className #### Defined in -[lib/k8s/pod.ts:98](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L98) +[lib/k8s/pod.ts:98](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L98) ___ @@ -97,7 +96,7 @@ ___ | `conditions` | [`KubeCondition`](../interfaces/lib_k8s_cluster.KubeCondition.md)[] | | `containerStatuses` | [`KubeContainerStatus`](../interfaces/lib_k8s_cluster.KubeContainerStatus.md)[] | | `ephemeralContainerStatuses?` | [`KubeContainerStatus`](../interfaces/lib_k8s_cluster.KubeContainerStatus.md)[] | -| `hostIP` | `string` | +| `hostIP?` | `string` | | `initContainerStatuses?` | [`KubeContainerStatus`](../interfaces/lib_k8s_cluster.KubeContainerStatus.md)[] | | `message?` | `string` | | `phase` | `string` | @@ -107,7 +106,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:102](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L102) +[lib/k8s/pod.ts:102](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L102) ## Methods @@ -134,7 +133,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:172](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L172) +[lib/k8s/pod.ts:172](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L172) ___ @@ -161,7 +160,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:184](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L184) +[lib/k8s/pod.ts:184](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L184) ___ @@ -175,7 +174,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:222](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L222) +[lib/k8s/pod.ts:222](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L222) ___ @@ -201,7 +200,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:106](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L106) +[lib/k8s/pod.ts:106](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L106) ___ @@ -227,7 +226,7 @@ makeKubeObject('Pod').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -252,7 +251,7 @@ makeKubeObject('Pod').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -276,7 +275,7 @@ makeKubeObject('Pod').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -303,7 +302,7 @@ makeKubeObject('Pod').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -329,7 +328,7 @@ makeKubeObject('Pod').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -354,7 +353,7 @@ makeKubeObject('Pod').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -378,4 +377,4 @@ makeKubeObject('Pod').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_podDisruptionBudget.PDB.md b/docs/development/api/classes/lib_k8s_podDisruptionBudget.PDB.md index 9c95768d05..95975424ff 100644 --- a/docs/development/api/classes/lib_k8s_podDisruptionBudget.PDB.md +++ b/docs/development/api/classes/lib_k8s_podDisruptionBudget.PDB.md @@ -1,8 +1,6 @@ ---- -title: "Class: PDB" -linkTitle: "PDB" -slug: "lib_k8s_podDisruptionBudget.PDB" ---- +[API](../API.md) / [lib/k8s/podDisruptionBudget](../modules/lib_k8s_podDisruptionBudget.md) / PDB + +# Class: PDB [lib/k8s/podDisruptionBudget](../modules/lib_k8s_podDisruptionBudget.md).PDB @@ -30,7 +28,7 @@ makeKubeObject('podDisruptionBudget').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('podDisruptionBudget').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/podDisruptionBudget.ts:40](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/podDisruptionBudget.ts#L40) +[lib/k8s/podDisruptionBudget.ts:40](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/podDisruptionBudget.ts#L40) ___ @@ -66,7 +65,7 @@ makeKubeObject('podDisruptionBudget').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('podDisruptionBudget').className #### Defined in -[lib/k8s/podDisruptionBudget.ts:50](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/podDisruptionBudget.ts#L50) +[lib/k8s/podDisruptionBudget.ts:50](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/podDisruptionBudget.ts#L50) ___ @@ -105,7 +104,7 @@ ___ #### Defined in -[lib/k8s/podDisruptionBudget.ts:42](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/podDisruptionBudget.ts#L42) +[lib/k8s/podDisruptionBudget.ts:42](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/podDisruptionBudget.ts#L42) ___ @@ -129,7 +128,7 @@ ___ #### Defined in -[lib/k8s/podDisruptionBudget.ts:46](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/podDisruptionBudget.ts#L46) +[lib/k8s/podDisruptionBudget.ts:46](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/podDisruptionBudget.ts#L46) ## Methods @@ -155,7 +154,7 @@ makeKubeObject('podDisruptionBudget').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -180,7 +179,7 @@ makeKubeObject('podDisruptionBudget').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -204,7 +203,7 @@ makeKubeObject('podDisruptionBudget').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -231,7 +230,7 @@ makeKubeObject('podDisruptionBudget').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -257,7 +256,7 @@ makeKubeObject('podDisruptionBudget').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -282,7 +281,7 @@ makeKubeObject('podDisruptionBudget').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -306,4 +305,4 @@ makeKubeObject('podDisruptionBudget').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_priorityClass.PriorityClass.md b/docs/development/api/classes/lib_k8s_priorityClass.PriorityClass.md index 9061a1584e..ed3f5d703a 100644 --- a/docs/development/api/classes/lib_k8s_priorityClass.PriorityClass.md +++ b/docs/development/api/classes/lib_k8s_priorityClass.PriorityClass.md @@ -1,8 +1,6 @@ ---- -title: "Class: PriorityClass" -linkTitle: "PriorityClass" -slug: "lib_k8s_priorityClass.PriorityClass" ---- +[API](../API.md) / [lib/k8s/priorityClass](../modules/lib_k8s_priorityClass.md) / PriorityClass + +# Class: PriorityClass [lib/k8s/priorityClass](../modules/lib_k8s_priorityClass.md).PriorityClass @@ -30,7 +28,7 @@ makeKubeObject('priorityClass').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,12 +46,12 @@ makeKubeObject('priorityClass').constructor | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/priorityClass.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L12) +[lib/k8s/priorityClass.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L12) ___ @@ -67,7 +65,7 @@ makeKubeObject('priorityClass').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -81,7 +79,7 @@ makeKubeObject('priorityClass').className #### Defined in -[lib/k8s/priorityClass.ts:30](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L30) +[lib/k8s/priorityClass.ts:30](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L30) ___ @@ -95,7 +93,7 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:26](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L26) +[lib/k8s/priorityClass.ts:26](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L26) ___ @@ -109,7 +107,7 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L34) +[lib/k8s/priorityClass.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L34) ___ @@ -123,7 +121,7 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:22](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L22) +[lib/k8s/priorityClass.ts:22](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L22) ___ @@ -137,7 +135,7 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L18) +[lib/k8s/priorityClass.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L18) ___ @@ -151,7 +149,7 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:14](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L14) +[lib/k8s/priorityClass.ts:14](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L14) ## Methods @@ -177,7 +175,7 @@ makeKubeObject('priorityClass').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -202,7 +200,7 @@ makeKubeObject('priorityClass').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -226,7 +224,7 @@ makeKubeObject('priorityClass').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -253,7 +251,7 @@ makeKubeObject('priorityClass').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -279,7 +277,7 @@ makeKubeObject('priorityClass').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -304,7 +302,7 @@ makeKubeObject('priorityClass').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -328,4 +326,4 @@ makeKubeObject('priorityClass').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_replicaSet.ReplicaSet.md b/docs/development/api/classes/lib_k8s_replicaSet.ReplicaSet.md index 0eb266372c..a8fcddcc28 100644 --- a/docs/development/api/classes/lib_k8s_replicaSet.ReplicaSet.md +++ b/docs/development/api/classes/lib_k8s_replicaSet.ReplicaSet.md @@ -1,8 +1,6 @@ ---- -title: "Class: ReplicaSet" -linkTitle: "ReplicaSet" -slug: "lib_k8s_replicaSet.ReplicaSet" ---- +[API](../API.md) / [lib/k8s/replicaSet](../modules/lib_k8s_replicaSet.md) / ReplicaSet + +# Class: ReplicaSet [lib/k8s/replicaSet](../modules/lib_k8s_replicaSet.md).ReplicaSet @@ -30,7 +28,7 @@ makeKubeObject('ReplicaSet').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('ReplicaSet').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/replicaSet.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/replicaSet.ts#L34) +[lib/k8s/replicaSet.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/replicaSet.ts#L34) ___ @@ -66,7 +65,7 @@ makeKubeObject('ReplicaSet').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -89,7 +88,7 @@ makeKubeObject('ReplicaSet').className #### Defined in -[lib/k8s/replicaSet.ts:36](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/replicaSet.ts#L36) +[lib/k8s/replicaSet.ts:36](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/replicaSet.ts#L36) ___ @@ -112,7 +111,7 @@ ___ #### Defined in -[lib/k8s/replicaSet.ts:40](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/replicaSet.ts#L40) +[lib/k8s/replicaSet.ts:40](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/replicaSet.ts#L40) ## Methods @@ -126,7 +125,7 @@ ___ #### Defined in -[lib/k8s/replicaSet.ts:44](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/replicaSet.ts#L44) +[lib/k8s/replicaSet.ts:44](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/replicaSet.ts#L44) ___ @@ -140,7 +139,7 @@ ___ #### Defined in -[lib/k8s/replicaSet.ts:48](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/replicaSet.ts#L48) +[lib/k8s/replicaSet.ts:48](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/replicaSet.ts#L48) ___ @@ -166,7 +165,7 @@ makeKubeObject('ReplicaSet').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -191,7 +190,7 @@ makeKubeObject('ReplicaSet').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -215,7 +214,7 @@ makeKubeObject('ReplicaSet').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -242,7 +241,7 @@ makeKubeObject('ReplicaSet').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -268,7 +267,7 @@ makeKubeObject('ReplicaSet').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -293,7 +292,7 @@ makeKubeObject('ReplicaSet').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -317,4 +316,4 @@ makeKubeObject('ReplicaSet').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_resourceQuota.ResourceQuota.md b/docs/development/api/classes/lib_k8s_resourceQuota.ResourceQuota.md index b7af158ed1..643f0960a9 100644 --- a/docs/development/api/classes/lib_k8s_resourceQuota.ResourceQuota.md +++ b/docs/development/api/classes/lib_k8s_resourceQuota.ResourceQuota.md @@ -1,8 +1,6 @@ ---- -title: "Class: ResourceQuota" -linkTitle: "ResourceQuota" -slug: "lib_k8s_resourceQuota.ResourceQuota" ---- +[API](../API.md) / [lib/k8s/resourceQuota](../modules/lib_k8s_resourceQuota.md) / ResourceQuota + +# Class: ResourceQuota [lib/k8s/resourceQuota](../modules/lib_k8s_resourceQuota.md).ResourceQuota @@ -30,7 +28,7 @@ makeKubeObject('resourceQuota').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('resourceQuota').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/resourceQuota.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/resourceQuota.ts#L34) +[lib/k8s/resourceQuota.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/resourceQuota.ts#L34) ___ @@ -66,7 +65,7 @@ makeKubeObject('resourceQuota').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('resourceQuota').className #### Defined in -[lib/k8s/resourceQuota.ts:60](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/resourceQuota.ts#L60) +[lib/k8s/resourceQuota.ts:60](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/resourceQuota.ts#L60) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/resourceQuota.ts:44](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/resourceQuota.ts#L44) +[lib/k8s/resourceQuota.ts:44](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/resourceQuota.ts#L44) ___ @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/resourceQuota.ts:76](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/resourceQuota.ts#L76) +[lib/k8s/resourceQuota.ts:76](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/resourceQuota.ts#L76) ___ @@ -122,7 +121,7 @@ ___ #### Defined in -[lib/k8s/resourceQuota.ts:36](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/resourceQuota.ts#L36) +[lib/k8s/resourceQuota.ts:36](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/resourceQuota.ts#L36) ___ @@ -136,7 +135,7 @@ ___ #### Defined in -[lib/k8s/resourceQuota.ts:40](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/resourceQuota.ts#L40) +[lib/k8s/resourceQuota.ts:40](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/resourceQuota.ts#L40) ## Methods @@ -162,7 +161,7 @@ makeKubeObject('resourceQuota').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -187,7 +186,7 @@ makeKubeObject('resourceQuota').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -211,7 +210,7 @@ makeKubeObject('resourceQuota').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -238,7 +237,7 @@ makeKubeObject('resourceQuota').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -264,7 +263,7 @@ makeKubeObject('resourceQuota').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -289,7 +288,7 @@ makeKubeObject('resourceQuota').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -313,4 +312,4 @@ makeKubeObject('resourceQuota').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_role.Role.md b/docs/development/api/classes/lib_k8s_role.Role.md index f1350cb56b..72f7de78c4 100644 --- a/docs/development/api/classes/lib_k8s_role.Role.md +++ b/docs/development/api/classes/lib_k8s_role.Role.md @@ -1,8 +1,6 @@ ---- -title: "Class: Role" -linkTitle: "Role" -slug: "lib_k8s_role.Role" ---- +[API](../API.md) / [lib/k8s/role](../modules/lib_k8s_role.md) / Role + +# Class: Role [lib/k8s/role](../modules/lib_k8s_role.md).Role @@ -32,7 +30,7 @@ makeKubeObject('role').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,13 +46,14 @@ makeKubeObject('role').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/role.ts:15](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/role.ts#L15) +[lib/k8s/role.ts:15](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/role.ts#L15) ___ @@ -68,7 +67,7 @@ makeKubeObject('role').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -82,7 +81,7 @@ makeKubeObject('role').className #### Defined in -[lib/k8s/role.ts:17](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/role.ts#L17) +[lib/k8s/role.ts:17](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/role.ts#L17) ## Methods @@ -108,7 +107,7 @@ makeKubeObject('role').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -133,7 +132,7 @@ makeKubeObject('role').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -157,7 +156,7 @@ makeKubeObject('role').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -184,7 +183,7 @@ makeKubeObject('role').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -210,7 +209,7 @@ makeKubeObject('role').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -235,7 +234,7 @@ makeKubeObject('role').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -259,4 +258,4 @@ makeKubeObject('role').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_roleBinding.RoleBinding.md b/docs/development/api/classes/lib_k8s_roleBinding.RoleBinding.md index b18f5ccbc9..1569cab836 100644 --- a/docs/development/api/classes/lib_k8s_roleBinding.RoleBinding.md +++ b/docs/development/api/classes/lib_k8s_roleBinding.RoleBinding.md @@ -1,8 +1,6 @@ ---- -title: "Class: RoleBinding" -linkTitle: "RoleBinding" -slug: "lib_k8s_roleBinding.RoleBinding" ---- +[API](../API.md) / [lib/k8s/roleBinding](../modules/lib_k8s_roleBinding.md) / RoleBinding + +# Class: RoleBinding [lib/k8s/roleBinding](../modules/lib_k8s_roleBinding.md).RoleBinding @@ -32,7 +30,7 @@ makeKubeObject('roleBinding').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,13 +46,14 @@ makeKubeObject('roleBinding').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/roleBinding.ts:19](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/roleBinding.ts#L19) +[lib/k8s/roleBinding.ts:19](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/roleBinding.ts#L19) ___ @@ -68,7 +67,7 @@ makeKubeObject('roleBinding').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -82,7 +81,7 @@ makeKubeObject('roleBinding').className #### Defined in -[lib/k8s/roleBinding.ts:21](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/roleBinding.ts#L21) +[lib/k8s/roleBinding.ts:21](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/roleBinding.ts#L21) ___ @@ -96,7 +95,7 @@ ___ #### Defined in -[lib/k8s/roleBinding.ts:25](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/roleBinding.ts#L25) +[lib/k8s/roleBinding.ts:25](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/roleBinding.ts#L25) ## Methods @@ -122,7 +121,7 @@ makeKubeObject('roleBinding').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -147,7 +146,7 @@ makeKubeObject('roleBinding').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -171,7 +170,7 @@ makeKubeObject('roleBinding').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -198,7 +197,7 @@ makeKubeObject('roleBinding').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -224,7 +223,7 @@ makeKubeObject('roleBinding').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -249,7 +248,7 @@ makeKubeObject('roleBinding').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -273,4 +272,4 @@ makeKubeObject('roleBinding').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_runtime.RuntimeClass.md b/docs/development/api/classes/lib_k8s_runtime.RuntimeClass.md index 165cc7068d..0f913758d9 100644 --- a/docs/development/api/classes/lib_k8s_runtime.RuntimeClass.md +++ b/docs/development/api/classes/lib_k8s_runtime.RuntimeClass.md @@ -1,8 +1,6 @@ ---- -title: "Class: RuntimeClass" -linkTitle: "RuntimeClass" -slug: "lib_k8s_runtime.RuntimeClass" ---- +[API](../API.md) / [lib/k8s/runtime](../modules/lib_k8s_runtime.md) / RuntimeClass + +# Class: RuntimeClass [lib/k8s/runtime](../modules/lib_k8s_runtime.md).RuntimeClass @@ -30,7 +28,7 @@ makeKubeObject('RuntimeClass').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,12 +46,12 @@ makeKubeObject('RuntimeClass').constructor | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/runtime.ts:9](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/runtime.ts#L9) +[lib/k8s/runtime.ts:9](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/runtime.ts#L9) ___ @@ -67,7 +65,7 @@ makeKubeObject('RuntimeClass').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -81,7 +79,7 @@ makeKubeObject('RuntimeClass').className #### Defined in -[lib/k8s/runtime.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/runtime.ts#L11) +[lib/k8s/runtime.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/runtime.ts#L11) ___ @@ -95,7 +93,7 @@ ___ #### Defined in -[lib/k8s/runtime.ts:19](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/runtime.ts#L19) +[lib/k8s/runtime.ts:19](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/runtime.ts#L19) ___ @@ -109,7 +107,7 @@ ___ #### Defined in -[lib/k8s/runtime.ts:15](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/runtime.ts#L15) +[lib/k8s/runtime.ts:15](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/runtime.ts#L15) ## Methods @@ -135,7 +133,7 @@ makeKubeObject('RuntimeClass').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -160,7 +158,7 @@ makeKubeObject('RuntimeClass').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -184,7 +182,7 @@ makeKubeObject('RuntimeClass').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -211,7 +209,7 @@ makeKubeObject('RuntimeClass').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -237,7 +235,7 @@ makeKubeObject('RuntimeClass').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -262,7 +260,7 @@ makeKubeObject('RuntimeClass').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -286,4 +284,4 @@ makeKubeObject('RuntimeClass').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_secret.Secret.md b/docs/development/api/classes/lib_k8s_secret.Secret.md index 520a6ff9eb..72736ca66e 100644 --- a/docs/development/api/classes/lib_k8s_secret.Secret.md +++ b/docs/development/api/classes/lib_k8s_secret.Secret.md @@ -1,8 +1,6 @@ ---- -title: "Class: Secret" -linkTitle: "Secret" -slug: "lib_k8s_secret.Secret" ---- +[API](../API.md) / [lib/k8s/secret](../modules/lib_k8s_secret.md) / Secret + +# Class: Secret [lib/k8s/secret](../modules/lib_k8s_secret.md).Secret @@ -30,7 +28,7 @@ makeKubeObject('secret').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('secret').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/secret.ts:10](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/secret.ts#L10) +[lib/k8s/secret.ts:10](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/secret.ts#L10) ___ @@ -66,7 +65,7 @@ makeKubeObject('secret').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('secret').className #### Defined in -[lib/k8s/secret.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/secret.ts#L12) +[lib/k8s/secret.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/secret.ts#L12) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/secret.ts:16](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/secret.ts#L16) +[lib/k8s/secret.ts:16](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/secret.ts#L16) ## Methods @@ -120,7 +119,7 @@ makeKubeObject('secret').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -145,7 +144,7 @@ makeKubeObject('secret').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -169,7 +168,7 @@ makeKubeObject('secret').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -196,7 +195,7 @@ makeKubeObject('secret').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -222,7 +221,7 @@ makeKubeObject('secret').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -247,7 +246,7 @@ makeKubeObject('secret').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -271,4 +270,4 @@ makeKubeObject('secret').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_service.Service.md b/docs/development/api/classes/lib_k8s_service.Service.md index 89c34a61ad..fa98cbb54a 100644 --- a/docs/development/api/classes/lib_k8s_service.Service.md +++ b/docs/development/api/classes/lib_k8s_service.Service.md @@ -1,8 +1,6 @@ ---- -title: "Class: Service" -linkTitle: "Service" -slug: "lib_k8s_service.Service" ---- +[API](../API.md) / [lib/k8s/service](../modules/lib_k8s_service.md) / Service + +# Class: Service [lib/k8s/service](../modules/lib_k8s_service.md).Service @@ -30,7 +28,7 @@ makeKubeObject('service').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('service').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/service.ts:43](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L43) +[lib/k8s/service.ts:43](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L43) ___ @@ -66,7 +65,7 @@ makeKubeObject('service').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -82,13 +81,13 @@ makeKubeObject('service').className | :------ | :------ | | `clusterIP` | `string` | | `externalIPs` | `string`[] | -| `ports` | { `name`: `string` ; `nodePort`: `number` ; `port`: `number` ; `protocol`: `string` ; `targetPort`: `string` \| `number` }[] | +| `ports?` | { `name`: `string` ; `nodePort`: `number` ; `port`: `number` ; `protocol`: `string` ; `targetPort`: `string` \| `number` }[] | | `selector` | { `[key: string]`: `string`; } | | `type` | `string` | #### Defined in -[lib/k8s/service.ts:45](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L45) +[lib/k8s/service.ts:45](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L45) ___ @@ -102,7 +101,7 @@ ___ #### Defined in -[lib/k8s/service.ts:49](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L49) +[lib/k8s/service.ts:49](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L49) ## Methods @@ -116,21 +115,21 @@ ___ #### Defined in -[lib/k8s/service.ts:53](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L53) +[lib/k8s/service.ts:53](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L53) ___ ### getPorts -▸ **getPorts**(): `number`[] +▸ **getPorts**(): `undefined` \| `number`[] #### Returns -`number`[] +`undefined` \| `number`[] #### Defined in -[lib/k8s/service.ts:63](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L63) +[lib/k8s/service.ts:63](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L63) ___ @@ -144,7 +143,7 @@ ___ #### Defined in -[lib/k8s/service.ts:67](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L67) +[lib/k8s/service.ts:67](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L67) ___ @@ -170,7 +169,7 @@ makeKubeObject('service').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -195,7 +194,7 @@ makeKubeObject('service').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -219,7 +218,7 @@ makeKubeObject('service').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -246,7 +245,7 @@ makeKubeObject('service').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -272,7 +271,7 @@ makeKubeObject('service').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -297,7 +296,7 @@ makeKubeObject('service').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -321,4 +320,4 @@ makeKubeObject('service').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_serviceAccount.ServiceAccount.md b/docs/development/api/classes/lib_k8s_serviceAccount.ServiceAccount.md index 33eb7e677f..6cec2df6b7 100644 --- a/docs/development/api/classes/lib_k8s_serviceAccount.ServiceAccount.md +++ b/docs/development/api/classes/lib_k8s_serviceAccount.ServiceAccount.md @@ -1,8 +1,6 @@ ---- -title: "Class: ServiceAccount" -linkTitle: "ServiceAccount" -slug: "lib_k8s_serviceAccount.ServiceAccount" ---- +[API](../API.md) / [lib/k8s/serviceAccount](../modules/lib_k8s_serviceAccount.md) / ServiceAccount + +# Class: ServiceAccount [lib/k8s/serviceAccount](../modules/lib_k8s_serviceAccount.md).ServiceAccount @@ -30,7 +28,7 @@ makeKubeObject('serviceAccount').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('serviceAccount').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/serviceAccount.ts:16](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/serviceAccount.ts#L16) +[lib/k8s/serviceAccount.ts:16](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/serviceAccount.ts#L16) ___ @@ -66,7 +65,7 @@ makeKubeObject('serviceAccount').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('serviceAccount').className #### Defined in -[lib/k8s/serviceAccount.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/serviceAccount.ts#L18) +[lib/k8s/serviceAccount.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/serviceAccount.ts#L18) ## Methods @@ -106,7 +105,7 @@ makeKubeObject('serviceAccount').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -131,7 +130,7 @@ makeKubeObject('serviceAccount').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -155,7 +154,7 @@ makeKubeObject('serviceAccount').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -182,7 +181,7 @@ makeKubeObject('serviceAccount').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -208,7 +207,7 @@ makeKubeObject('serviceAccount').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -233,7 +232,7 @@ makeKubeObject('serviceAccount').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -257,4 +256,4 @@ makeKubeObject('serviceAccount').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_statefulSet.StatefulSet.md b/docs/development/api/classes/lib_k8s_statefulSet.StatefulSet.md index 0b40438da9..e75f7b76c2 100644 --- a/docs/development/api/classes/lib_k8s_statefulSet.StatefulSet.md +++ b/docs/development/api/classes/lib_k8s_statefulSet.StatefulSet.md @@ -1,8 +1,6 @@ ---- -title: "Class: StatefulSet" -linkTitle: "StatefulSet" -slug: "lib_k8s_statefulSet.StatefulSet" ---- +[API](../API.md) / [lib/k8s/statefulSet](../modules/lib_k8s_statefulSet.md) / StatefulSet + +# Class: StatefulSet [lib/k8s/statefulSet](../modules/lib_k8s_statefulSet.md).StatefulSet @@ -30,7 +28,7 @@ makeKubeObject('StatefulSet').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('StatefulSet').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/statefulSet.ts:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/statefulSet.ts#L32) +[lib/k8s/statefulSet.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/statefulSet.ts#L32) ___ @@ -66,7 +65,7 @@ makeKubeObject('StatefulSet').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('StatefulSet').className #### Defined in -[lib/k8s/statefulSet.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/statefulSet.ts#L34) +[lib/k8s/statefulSet.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/statefulSet.ts#L34) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/statefulSet.ts:38](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/statefulSet.ts#L38) +[lib/k8s/statefulSet.ts:38](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/statefulSet.ts#L38) ## Methods @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/statefulSet.ts:42](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/statefulSet.ts#L42) +[lib/k8s/statefulSet.ts:42](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/statefulSet.ts#L42) ___ @@ -134,7 +133,7 @@ makeKubeObject('StatefulSet').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -159,7 +158,7 @@ makeKubeObject('StatefulSet').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -183,7 +182,7 @@ makeKubeObject('StatefulSet').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -210,7 +209,7 @@ makeKubeObject('StatefulSet').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -236,7 +235,7 @@ makeKubeObject('StatefulSet').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -261,7 +260,7 @@ makeKubeObject('StatefulSet').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -285,4 +284,4 @@ makeKubeObject('StatefulSet').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_storageClass.StorageClass.md b/docs/development/api/classes/lib_k8s_storageClass.StorageClass.md index 76ec3f9a64..f6553424e8 100644 --- a/docs/development/api/classes/lib_k8s_storageClass.StorageClass.md +++ b/docs/development/api/classes/lib_k8s_storageClass.StorageClass.md @@ -1,8 +1,6 @@ ---- -title: "Class: StorageClass" -linkTitle: "StorageClass" -slug: "lib_k8s_storageClass.StorageClass" ---- +[API](../API.md) / [lib/k8s/storageClass](../modules/lib_k8s_storageClass.md) / StorageClass + +# Class: StorageClass [lib/k8s/storageClass](../modules/lib_k8s_storageClass.md).StorageClass @@ -30,7 +28,7 @@ makeKubeObject('storageClass').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -48,12 +46,12 @@ makeKubeObject('storageClass').constructor | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/storageClass.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L11) +[lib/k8s/storageClass.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L11) ___ @@ -67,7 +65,7 @@ makeKubeObject('storageClass').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -81,7 +79,7 @@ makeKubeObject('storageClass').className #### Defined in -[lib/k8s/storageClass.ts:13](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L13) +[lib/k8s/storageClass.ts:13](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L13) ___ @@ -95,7 +93,7 @@ ___ #### Defined in -[lib/k8s/storageClass.ts:17](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L17) +[lib/k8s/storageClass.ts:17](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L17) ___ @@ -109,7 +107,7 @@ ___ #### Defined in -[lib/k8s/storageClass.ts:21](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L21) +[lib/k8s/storageClass.ts:21](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L21) ___ @@ -123,7 +121,7 @@ ___ #### Defined in -[lib/k8s/storageClass.ts:25](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L25) +[lib/k8s/storageClass.ts:25](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L25) ___ @@ -137,7 +135,7 @@ ___ #### Defined in -[lib/k8s/storageClass.ts:29](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L29) +[lib/k8s/storageClass.ts:29](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L29) ## Methods @@ -163,7 +161,7 @@ makeKubeObject('storageClass').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -188,7 +186,7 @@ makeKubeObject('storageClass').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -212,7 +210,7 @@ makeKubeObject('storageClass').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -239,7 +237,7 @@ makeKubeObject('storageClass').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -265,7 +263,7 @@ makeKubeObject('storageClass').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -290,7 +288,7 @@ makeKubeObject('storageClass').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -314,4 +312,4 @@ makeKubeObject('storageClass').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_validatingWebhookConfiguration.ValidatingWebhookConfiguration.md b/docs/development/api/classes/lib_k8s_validatingWebhookConfiguration.ValidatingWebhookConfiguration.md index cf587a29a0..4ad7faf64a 100644 --- a/docs/development/api/classes/lib_k8s_validatingWebhookConfiguration.ValidatingWebhookConfiguration.md +++ b/docs/development/api/classes/lib_k8s_validatingWebhookConfiguration.ValidatingWebhookConfiguration.md @@ -1,8 +1,6 @@ ---- -title: "Class: ValidatingWebhookConfiguration" -linkTitle: "ValidatingWebhookConfiguration" -slug: "lib_k8s_validatingWebhookConfiguration.ValidatingWebhookConfiguration" ---- +[API](../API.md) / [lib/k8s/validatingWebhookConfiguration](../modules/lib_k8s_validatingWebhookConfiguration.md) / ValidatingWebhookConfiguration + +# Class: ValidatingWebhookConfiguration [lib/k8s/validatingWebhookConfiguration](../modules/lib_k8s_validatingWebhookConfiguration.md).ValidatingWebhookConfiguration @@ -32,7 +30,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -50,12 +48,12 @@ makeKubeObject( | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](../modules/lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](../modules/lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/validatingWebhookConfiguration.ts:29](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/validatingWebhookConfiguration.ts#L29) +[lib/k8s/validatingWebhookConfiguration.ts:29](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/validatingWebhookConfiguration.ts#L29) ___ @@ -71,7 +69,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -85,7 +83,7 @@ makeKubeObject( #### Defined in -[lib/k8s/validatingWebhookConfiguration.ts:35](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/validatingWebhookConfiguration.ts#L35) +[lib/k8s/validatingWebhookConfiguration.ts:35](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/validatingWebhookConfiguration.ts#L35) ## Methods @@ -113,7 +111,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -140,7 +138,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -166,7 +164,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -195,7 +193,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -223,7 +221,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -250,7 +248,7 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -276,4 +274,4 @@ makeKubeObject( #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/lib_k8s_vpa.VPA.md b/docs/development/api/classes/lib_k8s_vpa.VPA.md index bad35d6c5b..a20215acf3 100644 --- a/docs/development/api/classes/lib_k8s_vpa.VPA.md +++ b/docs/development/api/classes/lib_k8s_vpa.VPA.md @@ -1,8 +1,6 @@ ---- -title: "Class: VPA" -linkTitle: "VPA" -slug: "lib_k8s_vpa.VPA" ---- +[API](../API.md) / [lib/k8s/vpa](../modules/lib_k8s_vpa.md) / VPA + +# Class: VPA [lib/k8s/vpa](../modules/lib_k8s_vpa.md).VPA @@ -30,7 +28,7 @@ makeKubeObject('verticalPodAutoscaler').constructor #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -46,13 +44,14 @@ makeKubeObject('verticalPodAutoscaler').constructor | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/vpa.ts:80](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/vpa.ts#L80) +[lib/k8s/vpa.ts:80](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/vpa.ts#L80) ___ @@ -66,7 +65,7 @@ makeKubeObject('verticalPodAutoscaler').className #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Accessors @@ -80,7 +79,7 @@ makeKubeObject('verticalPodAutoscaler').className #### Defined in -[lib/k8s/vpa.ts:112](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/vpa.ts#L112) +[lib/k8s/vpa.ts:112](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/vpa.ts#L112) ___ @@ -94,7 +93,7 @@ ___ #### Defined in -[lib/k8s/vpa.ts:104](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/vpa.ts#L104) +[lib/k8s/vpa.ts:104](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/vpa.ts#L104) ___ @@ -108,7 +107,7 @@ ___ #### Defined in -[lib/k8s/vpa.ts:108](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/vpa.ts#L108) +[lib/k8s/vpa.ts:108](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/vpa.ts#L108) ___ @@ -122,7 +121,7 @@ ___ #### Defined in -[lib/k8s/vpa.ts:132](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/vpa.ts#L132) +[lib/k8s/vpa.ts:132](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/vpa.ts#L132) ## Methods @@ -148,7 +147,7 @@ makeKubeObject('verticalPodAutoscaler').apiList #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -173,7 +172,7 @@ makeKubeObject('verticalPodAutoscaler').getAuthorization #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -197,7 +196,7 @@ makeKubeObject('verticalPodAutoscaler').getErrorMessage #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -211,7 +210,7 @@ ___ #### Defined in -[lib/k8s/vpa.ts:86](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/vpa.ts#L86) +[lib/k8s/vpa.ts:86](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/vpa.ts#L86) ___ @@ -238,7 +237,7 @@ makeKubeObject('verticalPodAutoscaler').useApiGet #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -264,7 +263,7 @@ makeKubeObject('verticalPodAutoscaler').useApiList #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -289,7 +288,7 @@ makeKubeObject('verticalPodAutoscaler').useGet #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -313,4 +312,4 @@ makeKubeObject('verticalPodAutoscaler').useList #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/classes/plugin_lib.Headlamp.md b/docs/development/api/classes/plugin_lib.Headlamp.md index 2cc38f94d7..2f7676c3a4 100644 --- a/docs/development/api/classes/plugin_lib.Headlamp.md +++ b/docs/development/api/classes/plugin_lib.Headlamp.md @@ -1,8 +1,6 @@ ---- -title: "Class: Headlamp" -linkTitle: "Headlamp" -slug: "plugin_lib.Headlamp" ---- +[API](../API.md) / [plugin/lib](../modules/plugin_lib.md) / Headlamp + +# Class: Headlamp [plugin/lib](../modules/plugin_lib.md).Headlamp @@ -31,7 +29,7 @@ the name of the product. #### Defined in -[plugin/lib.ts:172](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L172) +[plugin/lib.ts:172](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L172) ___ @@ -51,12 +49,12 @@ the version of Headlamp. | Name | Type | | :------ | :------ | -| `GIT_VERSION` | `string` | -| `VERSION` | `string` | +| `GIT_VERSION` | `any` | +| `VERSION` | `any` | #### Defined in -[plugin/lib.ts:162](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L162) +[plugin/lib.ts:162](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L162) ___ @@ -74,7 +72,7 @@ true if Headlamp is running as a desktop app. #### Defined in -[plugin/lib.ts:151](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L151) +[plugin/lib.ts:151](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L151) ___ @@ -111,7 +109,7 @@ Headlamp.registerPlugin("aPluginIdString", myPlugin) #### Defined in -[plugin/lib.ts:106](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L106) +[plugin/lib.ts:106](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L106) ___ @@ -134,7 +132,7 @@ If Headlamp is not running as a desktop app, then this method prints an error an #### Defined in -[plugin/lib.ts:135](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L135) +[plugin/lib.ts:135](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L135) ___ @@ -163,4 +161,4 @@ a promise which completes to Headlamp's configuration (showing the list of confi #### Defined in -[plugin/lib.ts:123](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L123) +[plugin/lib.ts:123](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L123) diff --git a/docs/development/api/classes/plugin_lib.Plugin.md b/docs/development/api/classes/plugin_lib.Plugin.md index 2461820fe0..0a9b7612fe 100644 --- a/docs/development/api/classes/plugin_lib.Plugin.md +++ b/docs/development/api/classes/plugin_lib.Plugin.md @@ -1,8 +1,6 @@ ---- -title: "Class: Plugin" -linkTitle: "Plugin" -slug: "plugin_lib.Plugin" ---- +[API](../API.md) / [plugin/lib](../modules/plugin_lib.md) / Plugin + +# Class: Plugin [plugin/lib](../modules/plugin_lib.md).Plugin @@ -40,4 +38,4 @@ The return code is not used, but used to be required. #### Defined in -[plugin/lib.ts:49](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L49) +[plugin/lib.ts:49](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L49) diff --git a/docs/development/api/classes/plugin_registry.PluginManager.md b/docs/development/api/classes/plugin_registry.PluginManager.md new file mode 100644 index 0000000000..ae0ea5d090 --- /dev/null +++ b/docs/development/api/classes/plugin_registry.PluginManager.md @@ -0,0 +1,195 @@ +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / PluginManager + +# Class: PluginManager + +[plugin/registry](../modules/plugin_registry.md).PluginManager + +A wrapper class for initiating calls to Electron via desktopApi for managing plugins. + +## Constructors + +### constructor + +• **new PluginManager**() + +## Methods + +### cancel + +▸ `Static` **cancel**(`identifier`): `Promise`<`void`\> + +Sends a request to cancel the operation (install, update, uninstall) for a plugin with the specified identifier. + +**`static`** + +**`async`** + +**`example`** +PluginManager.cancel('pluginID'); + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `identifier` | `string` | The unique identifier for the plugin. | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[components/App/pluginManager.ts:130](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/pluginManager.ts#L130) + +___ + +### getStatus + +▸ `Static` **getStatus**(`identifier`): `Promise`<`ProgressResp`\> + +Sends a request to get the status of a plugin with the specified identifier. + +**`static`** + +**`async`** + +**`example`** +try { + const status = await PluginManager.getStatus('pluginID'); + console.log('Plugin status:', status); +} catch (error) { + console.error('Error:', error.message); +} + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `identifier` | `string` | The unique identifier for the plugin. | + +#### Returns + +`Promise`<`ProgressResp`\> + +- A promise that resolves with the status of the plugin, or rejects with an error if the message limit or timeout is exceeded. + +#### Defined in + +[components/App/pluginManager.ts:186](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/pluginManager.ts#L186) + +___ + +### install + +▸ `Static` **install**(`identifier`, `name`, `URL`): `void` + +Sends a request to install a plugin from the specified ArtifactHub URL. + +**`static`** + +**`example`** +PluginManager.install('pluginID', ' https://artifacthub.io/packages/headlamp//'); + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `identifier` | `string` | The unique identifier for the plugin. | +| `name` | `string` | The name of the plugin to be installed. | +| `URL` | `string` | The URL from where the plugin will be installed. | + +#### Returns + +`void` + +#### Defined in + +[components/App/pluginManager.ts:69](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/pluginManager.ts#L69) + +___ + +### list + +▸ `Static` **list**(): `Promise`<`undefined` \| `Record`<`string`, `any`\>\> + +Sends a request to list all installed plugins. + +**`throws`** {Error} - Throws an error if the response type is 'error'. + +**`static`** + +**`async`** + +**`example`** +try { + const plugins = await PluginManager.list(); + console.log('Installed plugins:', plugins); +} catch (error) { + console.error('Error:', error.message); +} + +#### Returns + +`Promise`<`undefined` \| `Record`<`string`, `any`\>\> + +- A promise that resolves with a record of all installed plugins, or undefined if there was an error. + +#### Defined in + +[components/App/pluginManager.ts:155](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/pluginManager.ts#L155) + +___ + +### uninstall + +▸ `Static` **uninstall**(`identifier`, `name`): `void` + +Sends a request to uninstall a plugin with the specified identifier and name. + +**`static`** + +**`example`** +PluginManager.uninstall('pluginID', 'my-plugin'); + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `identifier` | `string` | The unique identifier for the plugin. | +| `name` | `string` | The name of the plugin to be uninstalled. | + +#### Returns + +`void` + +#### Defined in + +[components/App/pluginManager.ts:110](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/pluginManager.ts#L110) + +___ + +### update + +▸ `Static` **update**(`identifier`, `name`): `void` + +Sends a request to update a plugin with the specified identifier and name. + +**`static`** + +**`example`** +PluginManager.update('pluginID', 'my-plugin'); + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `identifier` | `string` | The unique identifier for the plugin. | +| `name` | `string` | The name of the plugin to be updated. | + +#### Returns + +`void` + +#### Defined in + +[components/App/pluginManager.ts:90](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/pluginManager.ts#L90) diff --git a/docs/development/api/classes/plugin_registry.Registry.md b/docs/development/api/classes/plugin_registry.Registry.md index 4668dddb31..5df1541457 100644 --- a/docs/development/api/classes/plugin_registry.Registry.md +++ b/docs/development/api/classes/plugin_registry.Registry.md @@ -1,8 +1,6 @@ ---- -title: "Class: Registry" -linkTitle: "Registry" -slug: "plugin_registry.Registry" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / Registry + +# Class: Registry [plugin/registry](../modules/plugin_registry.md).Registry @@ -33,7 +31,7 @@ slug: "plugin_registry.Registry" #### Defined in -[plugin/registry.tsx:163](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L163) +[plugin/registry.tsx:164](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L164) ___ @@ -55,7 +53,7 @@ ___ #### Defined in -[plugin/registry.tsx:212](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L212) +[plugin/registry.tsx:213](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L213) ___ @@ -77,7 +75,7 @@ ___ #### Defined in -[plugin/registry.tsx:220](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L220) +[plugin/registry.tsx:221](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L221) ___ @@ -100,7 +98,7 @@ ___ #### Defined in -[plugin/registry.tsx:153](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L153) +[plugin/registry.tsx:154](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L154) ___ @@ -137,7 +135,7 @@ register.registerDetailsViewSection('biolatency', resource => { #### Defined in -[plugin/registry.tsx:185](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L185) +[plugin/registry.tsx:186](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L186) ___ @@ -159,7 +157,7 @@ ___ #### Defined in -[plugin/registry.tsx:145](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L145) +[plugin/registry.tsx:146](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L146) ___ @@ -177,7 +175,7 @@ ___ | `itemName` | `string` | | `itemLabel` | `string` | | `url` | `string` | -| `opts` | `Pick`<[`SidebarEntryProps`](../interfaces/plugin_registry.SidebarEntryProps.md), ``"sidebar"`` \| ``"icon"`` \| ``"useClusterURL"``\> | +| `opts` | `Pick`<[`SidebarEntryProps`](../interfaces/plugin_registry.SidebarEntryProps.md), ``"sidebar"`` \| ``"useClusterURL"`` \| ``"icon"``\> | #### Returns @@ -185,4 +183,4 @@ ___ #### Defined in -[plugin/registry.tsx:121](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L121) +[plugin/registry.tsx:122](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L122) diff --git a/docs/development/api/enums/_index.md b/docs/development/api/enums/_index.md deleted file mode 100644 index 79cd7870f6..0000000000 --- a/docs/development/api/enums/_index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: "Enumerations" ---- \ No newline at end of file diff --git a/docs/development/api/enums/plugin_registry.DefaultAppBarAction.md b/docs/development/api/enums/plugin_registry.DefaultAppBarAction.md index b023c49b75..7fad569461 100644 --- a/docs/development/api/enums/plugin_registry.DefaultAppBarAction.md +++ b/docs/development/api/enums/plugin_registry.DefaultAppBarAction.md @@ -1,8 +1,6 @@ ---- -title: "Enumeration: DefaultAppBarAction" -linkTitle: "DefaultAppBarAction" -slug: "plugin_registry.DefaultAppBarAction" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / DefaultAppBarAction + +# Enumeration: DefaultAppBarAction [plugin/registry](../modules/plugin_registry.md).DefaultAppBarAction @@ -14,7 +12,7 @@ slug: "plugin_registry.DefaultAppBarAction" #### Defined in -[redux/actionButtonsSlice.ts:42](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/actionButtonsSlice.ts#L42) +[redux/actionButtonsSlice.ts:42](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/actionButtonsSlice.ts#L42) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[redux/actionButtonsSlice.ts:43](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/actionButtonsSlice.ts#L43) +[redux/actionButtonsSlice.ts:43](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/actionButtonsSlice.ts#L43) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[redux/actionButtonsSlice.ts:44](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/actionButtonsSlice.ts#L44) +[redux/actionButtonsSlice.ts:44](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/actionButtonsSlice.ts#L44) ___ @@ -44,4 +42,4 @@ ___ #### Defined in -[redux/actionButtonsSlice.ts:45](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/actionButtonsSlice.ts#L45) +[redux/actionButtonsSlice.ts:45](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/actionButtonsSlice.ts#L45) diff --git a/docs/development/api/enums/plugin_registry.DefaultDetailsViewSection.md b/docs/development/api/enums/plugin_registry.DefaultDetailsViewSection.md index 335b8dc756..4f838c26b8 100644 --- a/docs/development/api/enums/plugin_registry.DefaultDetailsViewSection.md +++ b/docs/development/api/enums/plugin_registry.DefaultDetailsViewSection.md @@ -1,8 +1,6 @@ ---- -title: "Enumeration: DefaultDetailsViewSection" -linkTitle: "DefaultDetailsViewSection" -slug: "plugin_registry.DefaultDetailsViewSection" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / DefaultDetailsViewSection + +# Enumeration: DefaultDetailsViewSection [plugin/registry](../modules/plugin_registry.md).DefaultDetailsViewSection @@ -14,7 +12,7 @@ slug: "plugin_registry.DefaultDetailsViewSection" #### Defined in -[components/DetailsViewSection/detailsViewSectionSlice.ts:13](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L13) +[components/DetailsViewSection/detailsViewSectionSlice.ts:13](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L13) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[components/DetailsViewSection/detailsViewSectionSlice.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L18) +[components/DetailsViewSection/detailsViewSectionSlice.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L18) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[components/DetailsViewSection/detailsViewSectionSlice.ts:16](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L16) +[components/DetailsViewSection/detailsViewSectionSlice.ts:16](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L16) ___ @@ -44,7 +42,7 @@ ___ #### Defined in -[components/DetailsViewSection/detailsViewSectionSlice.ts:15](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L15) +[components/DetailsViewSection/detailsViewSectionSlice.ts:15](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L15) ___ @@ -54,7 +52,7 @@ ___ #### Defined in -[components/DetailsViewSection/detailsViewSectionSlice.ts:17](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L17) +[components/DetailsViewSection/detailsViewSectionSlice.ts:17](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L17) ___ @@ -64,7 +62,7 @@ ___ #### Defined in -[components/DetailsViewSection/detailsViewSectionSlice.ts:14](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L14) +[components/DetailsViewSection/detailsViewSectionSlice.ts:14](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L14) ___ @@ -74,4 +72,4 @@ ___ #### Defined in -[components/DetailsViewSection/detailsViewSectionSlice.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L12) +[components/DetailsViewSection/detailsViewSectionSlice.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/detailsViewSectionSlice.ts#L12) diff --git a/docs/development/api/enums/plugin_registry.DefaultSidebars.md b/docs/development/api/enums/plugin_registry.DefaultSidebars.md index 26ac70f904..8d42eee5f4 100644 --- a/docs/development/api/enums/plugin_registry.DefaultSidebars.md +++ b/docs/development/api/enums/plugin_registry.DefaultSidebars.md @@ -1,8 +1,6 @@ ---- -title: "Enumeration: DefaultSidebars" -linkTitle: "DefaultSidebars" -slug: "plugin_registry.DefaultSidebars" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / DefaultSidebars + +# Enumeration: DefaultSidebars [plugin/registry](../modules/plugin_registry.md).DefaultSidebars @@ -14,7 +12,7 @@ slug: "plugin_registry.DefaultSidebars" #### Defined in -[components/Sidebar/sidebarSlice.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L6) +[components/Sidebar/sidebarSlice.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L6) ___ @@ -24,4 +22,4 @@ ___ #### Defined in -[components/Sidebar/sidebarSlice.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L7) +[components/Sidebar/sidebarSlice.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L7) diff --git a/docs/development/api/interfaces/_index.md b/docs/development/api/interfaces/_index.md deleted file mode 100644 index 69cfb26373..0000000000 --- a/docs/development/api/interfaces/_index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: "Interfaces" ---- \ No newline at end of file diff --git a/docs/development/api/interfaces/lib_k8s_apiProxy.ApiError.md b/docs/development/api/interfaces/lib_k8s_apiProxy.ApiError.md index 82ef39ecf3..d7127e22e0 100644 --- a/docs/development/api/interfaces/lib_k8s_apiProxy.ApiError.md +++ b/docs/development/api/interfaces/lib_k8s_apiProxy.ApiError.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ApiError" -linkTitle: "ApiError" -slug: "lib_k8s_apiProxy.ApiError" ---- +[API](../API.md) / [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md) / ApiError + +# Interface: ApiError [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md).ApiError @@ -20,4 +18,4 @@ slug: "lib_k8s_apiProxy.ApiError" #### Defined in -[lib/k8s/apiProxy.ts:1568](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1568) +[lib/k8s/apiProxy.ts:1592](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1592) diff --git a/docs/development/api/interfaces/lib_k8s_apiProxy.ApiInfo.md b/docs/development/api/interfaces/lib_k8s_apiProxy.ApiInfo.md index 99a5becb5b..306f12024f 100644 --- a/docs/development/api/interfaces/lib_k8s_apiProxy.ApiInfo.md +++ b/docs/development/api/interfaces/lib_k8s_apiProxy.ApiInfo.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ApiInfo" -linkTitle: "ApiInfo" -slug: "lib_k8s_apiProxy.ApiInfo" ---- +[API](../API.md) / [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md) / ApiInfo + +# Interface: ApiInfo [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md).ApiInfo @@ -18,7 +16,7 @@ The API group. #### Defined in -[lib/k8s/apiProxy.ts:639](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L639) +[lib/k8s/apiProxy.ts:648](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L648) ___ @@ -30,7 +28,7 @@ The resource name. #### Defined in -[lib/k8s/apiProxy.ts:643](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L643) +[lib/k8s/apiProxy.ts:652](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L652) ___ @@ -42,4 +40,4 @@ The API version. #### Defined in -[lib/k8s/apiProxy.ts:641](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L641) +[lib/k8s/apiProxy.ts:650](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L650) diff --git a/docs/development/api/interfaces/lib_k8s_apiProxy.ClusterRequest.md b/docs/development/api/interfaces/lib_k8s_apiProxy.ClusterRequest.md index 4d0e919c70..6a2ff3a218 100644 --- a/docs/development/api/interfaces/lib_k8s_apiProxy.ClusterRequest.md +++ b/docs/development/api/interfaces/lib_k8s_apiProxy.ClusterRequest.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ClusterRequest" -linkTitle: "ClusterRequest" -slug: "lib_k8s_apiProxy.ClusterRequest" ---- +[API](../API.md) / [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md) / ClusterRequest + +# Interface: ClusterRequest [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md).ClusterRequest @@ -16,7 +14,7 @@ The certificate authority data #### Defined in -[lib/k8s/apiProxy.ts:77](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L77) +[lib/k8s/apiProxy.ts:77](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L77) ___ @@ -28,7 +26,7 @@ Whether the server's certificate should not be checked for validity #### Defined in -[lib/k8s/apiProxy.ts:75](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L75) +[lib/k8s/apiProxy.ts:75](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L75) ___ @@ -40,7 +38,7 @@ KubeConfig (base64 encoded) #### Defined in -[lib/k8s/apiProxy.ts:79](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L79) +[lib/k8s/apiProxy.ts:79](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L79) ___ @@ -52,7 +50,7 @@ The name of the cluster (has to be unique, or it will override an existing clust #### Defined in -[lib/k8s/apiProxy.ts:71](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L71) +[lib/k8s/apiProxy.ts:71](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L71) ___ @@ -64,4 +62,4 @@ The cluster URL #### Defined in -[lib/k8s/apiProxy.ts:73](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L73) +[lib/k8s/apiProxy.ts:73](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L73) diff --git a/docs/development/api/interfaces/lib_k8s_apiProxy.ClusterRequestParams.md b/docs/development/api/interfaces/lib_k8s_apiProxy.ClusterRequestParams.md index 69f29c3bc8..8acd306329 100644 --- a/docs/development/api/interfaces/lib_k8s_apiProxy.ClusterRequestParams.md +++ b/docs/development/api/interfaces/lib_k8s_apiProxy.ClusterRequestParams.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ClusterRequestParams" -linkTitle: "ClusterRequestParams" -slug: "lib_k8s_apiProxy.ClusterRequestParams" ---- +[API](../API.md) / [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md) / ClusterRequestParams + +# Interface: ClusterRequestParams [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md).ClusterRequestParams @@ -28,7 +26,7 @@ Whether to automatically log out the user if there is an authentication error. #### Defined in -[lib/k8s/apiProxy.ts:325](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L325) +[lib/k8s/apiProxy.ts:334](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L334) ___ @@ -44,7 +42,7 @@ Cluster context name. #### Defined in -[lib/k8s/apiProxy.ts:324](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L324) +[lib/k8s/apiProxy.ts:333](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L333) ___ @@ -60,7 +58,7 @@ Is the request expected to receive JSON data? #### Defined in -[lib/k8s/apiProxy.ts:62](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L62) +[lib/k8s/apiProxy.ts:62](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L62) ___ @@ -76,4 +74,4 @@ Number of milliseconds to wait for a response. #### Defined in -[lib/k8s/apiProxy.ts:60](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L60) +[lib/k8s/apiProxy.ts:60](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L60) diff --git a/docs/development/api/interfaces/lib_k8s_apiProxy.QueryParameters.md b/docs/development/api/interfaces/lib_k8s_apiProxy.QueryParameters.md index 65ba103e8a..19a411cc6a 100644 --- a/docs/development/api/interfaces/lib_k8s_apiProxy.QueryParameters.md +++ b/docs/development/api/interfaces/lib_k8s_apiProxy.QueryParameters.md @@ -1,8 +1,6 @@ ---- -title: "Interface: QueryParameters" -linkTitle: "QueryParameters" -slug: "lib_k8s_apiProxy.QueryParameters" ---- +[API](../API.md) / [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md) / QueryParameters + +# Interface: QueryParameters [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md).QueryParameters @@ -28,7 +26,7 @@ Can be 'true' #### Defined in -[lib/k8s/apiProxy.ts:164](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L164) +[lib/k8s/apiProxy.ts:164](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L164) ___ @@ -61,7 +59,7 @@ the last resourceVersion value returned by the server and not miss any modificat #### Defined in -[lib/k8s/apiProxy.ts:112](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L112) +[lib/k8s/apiProxy.ts:112](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L112) ___ @@ -76,7 +74,7 @@ Can be '' or 'All' #### Defined in -[lib/k8s/apiProxy.ts:119](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L119) +[lib/k8s/apiProxy.ts:119](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L119) ___ @@ -90,7 +88,7 @@ fieldSeletor restricts the list of returned objects by their fields. Defaults to #### Defined in -[lib/k8s/apiProxy.ts:125](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L125) +[lib/k8s/apiProxy.ts:125](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L125) ___ @@ -106,7 +104,7 @@ labelSelector restricts the list of returned objects by their labels. Defaults t #### Defined in -[lib/k8s/apiProxy.ts:132](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L132) +[lib/k8s/apiProxy.ts:132](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L132) ___ @@ -132,7 +130,7 @@ This field is not supported if watch is true. #### Defined in -[lib/k8s/apiProxy.ts:149](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L149) +[lib/k8s/apiProxy.ts:149](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L149) ___ @@ -147,7 +145,7 @@ Can be '' or 'true' #### Defined in -[lib/k8s/apiProxy.ts:184](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L184) +[lib/k8s/apiProxy.ts:184](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L184) ___ @@ -164,7 +162,7 @@ Defaults to unset #### Defined in -[lib/k8s/apiProxy.ts:157](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L157) +[lib/k8s/apiProxy.ts:157](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L157) ___ @@ -178,7 +176,7 @@ The resource version to match. #### Defined in -[lib/k8s/apiProxy.ts:178](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L178) +[lib/k8s/apiProxy.ts:178](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L178) ___ @@ -195,7 +193,7 @@ Can be 'true'. #### Defined in -[lib/k8s/apiProxy.ts:172](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L172) +[lib/k8s/apiProxy.ts:172](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L172) ___ @@ -211,4 +209,4 @@ Can be 1. #### Defined in -[lib/k8s/apiProxy.ts:191](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L191) +[lib/k8s/apiProxy.ts:191](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L191) diff --git a/docs/development/api/interfaces/lib_k8s_apiProxy.RequestParams.md b/docs/development/api/interfaces/lib_k8s_apiProxy.RequestParams.md index 5ea58f6b92..1b29206e9b 100644 --- a/docs/development/api/interfaces/lib_k8s_apiProxy.RequestParams.md +++ b/docs/development/api/interfaces/lib_k8s_apiProxy.RequestParams.md @@ -1,8 +1,6 @@ ---- -title: "Interface: RequestParams" -linkTitle: "RequestParams" -slug: "lib_k8s_apiProxy.RequestParams" ---- +[API](../API.md) / [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md) / RequestParams + +# Interface: RequestParams [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md).RequestParams @@ -26,7 +24,7 @@ Whether to automatically log out the user if there is an authentication error. #### Defined in -[lib/k8s/apiProxy.ts:66](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L66) +[lib/k8s/apiProxy.ts:66](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L66) ___ @@ -38,7 +36,7 @@ Cluster context name. #### Defined in -[lib/k8s/apiProxy.ts:64](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L64) +[lib/k8s/apiProxy.ts:64](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L64) ___ @@ -50,7 +48,7 @@ Is the request expected to receive JSON data? #### Defined in -[lib/k8s/apiProxy.ts:62](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L62) +[lib/k8s/apiProxy.ts:62](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L62) ___ @@ -62,4 +60,4 @@ Number of milliseconds to wait for a response. #### Defined in -[lib/k8s/apiProxy.ts:60](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L60) +[lib/k8s/apiProxy.ts:60](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L60) diff --git a/docs/development/api/interfaces/lib_k8s_apiProxy.StreamArgs.md b/docs/development/api/interfaces/lib_k8s_apiProxy.StreamArgs.md index 1e670b4310..78fa67a4b1 100644 --- a/docs/development/api/interfaces/lib_k8s_apiProxy.StreamArgs.md +++ b/docs/development/api/interfaces/lib_k8s_apiProxy.StreamArgs.md @@ -1,8 +1,6 @@ ---- -title: "Interface: StreamArgs" -linkTitle: "StreamArgs" -slug: "lib_k8s_apiProxy.StreamArgs" ---- +[API](../API.md) / [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md) / StreamArgs + +# Interface: StreamArgs [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md).StreamArgs @@ -24,7 +22,7 @@ Additional WebSocket protocols to use when connecting. #### Defined in -[lib/k8s/apiProxy.ts:1262](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1262) +[lib/k8s/apiProxy.ts:1286](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1286) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1273](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1273) +[lib/k8s/apiProxy.ts:1297](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1297) ___ @@ -46,7 +44,7 @@ Whether the stream is expected to receive JSON data. #### Defined in -[lib/k8s/apiProxy.ts:1260](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1260) +[lib/k8s/apiProxy.ts:1284](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1284) ___ @@ -58,7 +56,7 @@ Whether to attempt to reconnect the WebSocket connection if it fails. #### Defined in -[lib/k8s/apiProxy.ts:1266](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1266) +[lib/k8s/apiProxy.ts:1290](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1290) ___ @@ -68,7 +66,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1272](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1272) +[lib/k8s/apiProxy.ts:1296](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1296) ___ @@ -78,7 +76,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1270](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1270) +[lib/k8s/apiProxy.ts:1294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1294) ___ @@ -88,7 +86,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1271](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1271) +[lib/k8s/apiProxy.ts:1295](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1295) ___ @@ -98,7 +96,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1269](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1269) +[lib/k8s/apiProxy.ts:1293](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1293) ## Methods @@ -114,7 +112,7 @@ A callback function to execute when the WebSocket connection is established. #### Defined in -[lib/k8s/apiProxy.ts:1264](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1264) +[lib/k8s/apiProxy.ts:1288](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1288) ___ @@ -130,4 +128,4 @@ A callback function to execute when the WebSocket connection fails. #### Defined in -[lib/k8s/apiProxy.ts:1268](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1268) +[lib/k8s/apiProxy.ts:1292](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1292) diff --git a/docs/development/api/interfaces/lib_k8s_apiProxy.StreamResultsParams.md b/docs/development/api/interfaces/lib_k8s_apiProxy.StreamResultsParams.md index db81243243..6cc3bd8d89 100644 --- a/docs/development/api/interfaces/lib_k8s_apiProxy.StreamResultsParams.md +++ b/docs/development/api/interfaces/lib_k8s_apiProxy.StreamResultsParams.md @@ -1,8 +1,6 @@ ---- -title: "Interface: StreamResultsParams" -linkTitle: "StreamResultsParams" -slug: "lib_k8s_apiProxy.StreamResultsParams" ---- +[API](../API.md) / [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md) / StreamResultsParams + +# Interface: StreamResultsParams [lib/k8s/apiProxy](../modules/lib_k8s_apiProxy.md).StreamResultsParams @@ -14,7 +12,7 @@ slug: "lib_k8s_apiProxy.StreamResultsParams" #### Defined in -[lib/k8s/apiProxy.ts:1113](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1113) +[lib/k8s/apiProxy.ts:1137](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1137) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1115](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1115) +[lib/k8s/apiProxy.ts:1139](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1139) ___ @@ -34,4 +32,4 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1114](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1114) +[lib/k8s/apiProxy.ts:1138](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1138) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.ApiListOptions.md b/docs/development/api/interfaces/lib_k8s_cluster.ApiListOptions.md index aa7c308bb9..7e28292773 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.ApiListOptions.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.ApiListOptions.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ApiListOptions" -linkTitle: "ApiListOptions" -slug: "lib_k8s_cluster.ApiListOptions" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / ApiListOptions + +# Interface: ApiListOptions [lib/k8s/cluster](../modules/lib_k8s_cluster.md).ApiListOptions @@ -30,7 +28,7 @@ Can be 'true' #### Defined in -[lib/k8s/apiProxy.ts:164](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L164) +[lib/k8s/apiProxy.ts:164](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L164) ___ @@ -42,7 +40,7 @@ The cluster to list objects from. By default uses the current cluster being view #### Defined in -[lib/k8s/cluster.ts:225](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L225) +[lib/k8s/cluster.ts:226](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L226) ___ @@ -79,7 +77,7 @@ the last resourceVersion value returned by the server and not miss any modificat #### Defined in -[lib/k8s/apiProxy.ts:112](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L112) +[lib/k8s/apiProxy.ts:112](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L112) ___ @@ -98,7 +96,7 @@ Can be '' or 'All' #### Defined in -[lib/k8s/apiProxy.ts:119](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L119) +[lib/k8s/apiProxy.ts:119](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L119) ___ @@ -116,7 +114,7 @@ fieldSeletor restricts the list of returned objects by their fields. Defaults to #### Defined in -[lib/k8s/apiProxy.ts:125](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L125) +[lib/k8s/apiProxy.ts:125](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L125) ___ @@ -136,7 +134,7 @@ labelSelector restricts the list of returned objects by their labels. Defaults t #### Defined in -[lib/k8s/apiProxy.ts:132](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L132) +[lib/k8s/apiProxy.ts:132](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L132) ___ @@ -166,7 +164,7 @@ This field is not supported if watch is true. #### Defined in -[lib/k8s/apiProxy.ts:149](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L149) +[lib/k8s/apiProxy.ts:149](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L149) ___ @@ -178,7 +176,7 @@ The namespace to list objects from. #### Defined in -[lib/k8s/cluster.ts:223](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L223) +[lib/k8s/cluster.ts:224](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L224) ___ @@ -197,7 +195,7 @@ Can be '' or 'true' #### Defined in -[lib/k8s/apiProxy.ts:184](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L184) +[lib/k8s/apiProxy.ts:184](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L184) ___ @@ -218,7 +216,7 @@ Defaults to unset #### Defined in -[lib/k8s/apiProxy.ts:157](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L157) +[lib/k8s/apiProxy.ts:157](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L157) ___ @@ -236,7 +234,7 @@ The resource version to match. #### Defined in -[lib/k8s/apiProxy.ts:178](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L178) +[lib/k8s/apiProxy.ts:178](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L178) ___ @@ -257,7 +255,7 @@ Can be 'true'. #### Defined in -[lib/k8s/apiProxy.ts:172](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L172) +[lib/k8s/apiProxy.ts:172](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L172) ___ @@ -277,4 +275,4 @@ Can be 1. #### Defined in -[lib/k8s/apiProxy.ts:191](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L191) +[lib/k8s/apiProxy.ts:191](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L191) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.ApiListSingleNamespaceOptions.md b/docs/development/api/interfaces/lib_k8s_cluster.ApiListSingleNamespaceOptions.md index 27860e16a4..c89be9bf34 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.ApiListSingleNamespaceOptions.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.ApiListSingleNamespaceOptions.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ApiListSingleNamespaceOptions" -linkTitle: "ApiListSingleNamespaceOptions" -slug: "lib_k8s_cluster.ApiListSingleNamespaceOptions" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / ApiListSingleNamespaceOptions + +# Interface: ApiListSingleNamespaceOptions [lib/k8s/cluster](../modules/lib_k8s_cluster.md).ApiListSingleNamespaceOptions @@ -16,7 +14,7 @@ The cluster to get the object from. By default uses the current cluster being vi #### Defined in -[lib/k8s/cluster.ts:234](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L234) +[lib/k8s/cluster.ts:235](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L235) ___ @@ -28,7 +26,7 @@ The namespace to get the object from. #### Defined in -[lib/k8s/cluster.ts:230](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L230) +[lib/k8s/cluster.ts:231](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L231) ___ @@ -40,4 +38,4 @@ The parameters to be passed to the API endpoint. #### Defined in -[lib/k8s/cluster.ts:232](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L232) +[lib/k8s/cluster.ts:233](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L233) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.AuthRequestResourceAttrs.md b/docs/development/api/interfaces/lib_k8s_cluster.AuthRequestResourceAttrs.md index 275c94eb51..14fa6bade8 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.AuthRequestResourceAttrs.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.AuthRequestResourceAttrs.md @@ -1,8 +1,6 @@ ---- -title: "Interface: AuthRequestResourceAttrs" -linkTitle: "AuthRequestResourceAttrs" -slug: "lib_k8s_cluster.AuthRequestResourceAttrs" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / AuthRequestResourceAttrs + +# Interface: AuthRequestResourceAttrs [lib/k8s/cluster](../modules/lib_k8s_cluster.md).AuthRequestResourceAttrs @@ -14,7 +12,7 @@ slug: "lib_k8s_cluster.AuthRequestResourceAttrs" #### Defined in -[lib/k8s/cluster.ts:329](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L329) +[lib/k8s/cluster.ts:330](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L330) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:324](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L324) +[lib/k8s/cluster.ts:325](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L325) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:327](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L327) +[lib/k8s/cluster.ts:328](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L328) ___ @@ -44,7 +42,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:325](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L325) +[lib/k8s/cluster.ts:326](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L326) ___ @@ -54,7 +52,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:326](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L326) +[lib/k8s/cluster.ts:327](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L327) ___ @@ -64,7 +62,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:330](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L330) +[lib/k8s/cluster.ts:331](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L331) ___ @@ -74,4 +72,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:328](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L328) +[lib/k8s/cluster.ts:329](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L329) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.Cluster.md b/docs/development/api/interfaces/lib_k8s_cluster.Cluster.md index 625c48ce93..d6deb91be5 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.Cluster.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.Cluster.md @@ -1,8 +1,6 @@ ---- -title: "Interface: Cluster" -linkTitle: "Cluster" -slug: "lib_k8s_cluster.Cluster" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / Cluster + +# Interface: Cluster [lib/k8s/cluster](../modules/lib_k8s_cluster.md).Cluster @@ -20,7 +18,7 @@ Either 'oidc' or ''. '' means unknown. #### Defined in -[lib/k8s/cluster.ts:35](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L35) +[lib/k8s/cluster.ts:36](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L36) ___ @@ -30,7 +28,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:30](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L30) +[lib/k8s/cluster.ts:31](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L31) ___ @@ -40,4 +38,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:31](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L31) +[lib/k8s/cluster.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L32) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.ContainerState.md b/docs/development/api/interfaces/lib_k8s_cluster.ContainerState.md index 3b09d1c840..e35ae0d32d 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.ContainerState.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.ContainerState.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ContainerState" -linkTitle: "ContainerState" -slug: "lib_k8s_cluster.ContainerState" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / ContainerState + +# Interface: ContainerState [lib/k8s/cluster](../modules/lib_k8s_cluster.md).ContainerState @@ -20,7 +18,7 @@ slug: "lib_k8s_cluster.ContainerState" #### Defined in -[lib/k8s/cluster.ts:1227](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1227) +[lib/k8s/cluster.ts:1255](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1255) ___ @@ -42,7 +40,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1230](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1230) +[lib/k8s/cluster.ts:1258](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1258) ___ @@ -59,4 +57,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1239](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1239) +[lib/k8s/cluster.ts:1267](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1267) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeCondition.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeCondition.md index ef3a3a4c3a..80ee5435f5 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeCondition.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeCondition.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeCondition" -linkTitle: "KubeCondition" -slug: "lib_k8s_cluster.KubeCondition" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeCondition + +# Interface: KubeCondition [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeCondition @@ -16,7 +14,7 @@ Last time we probed the condition. #### Defined in -[lib/k8s/cluster.ts:864](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L864) +[lib/k8s/cluster.ts:892](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L892) ___ @@ -26,7 +24,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:865](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L865) +[lib/k8s/cluster.ts:893](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L893) ___ @@ -36,7 +34,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:866](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L866) +[lib/k8s/cluster.ts:894](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L894) ___ @@ -46,7 +44,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:867](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L867) +[lib/k8s/cluster.ts:895](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L895) ___ @@ -58,7 +56,7 @@ Unique, one-word, CamelCase reason for the condition's last transition. #### Defined in -[lib/k8s/cluster.ts:869](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L869) +[lib/k8s/cluster.ts:897](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L897) ___ @@ -70,7 +68,7 @@ Status of the condition, one of True, False, Unknown. #### Defined in -[lib/k8s/cluster.ts:871](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L871) +[lib/k8s/cluster.ts:899](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L899) ___ @@ -80,4 +78,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:872](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L872) +[lib/k8s/cluster.ts:900](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L900) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeContainer.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeContainer.md index 2d8e6da059..dc67aad734 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeContainer.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeContainer.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeContainer" -linkTitle: "KubeContainer" -slug: "lib_k8s_cluster.KubeContainer" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeContainer + +# Interface: KubeContainer [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeContainer @@ -26,7 +24,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:891](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L891) +[lib/k8s/cluster.ts:919](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L919) ___ @@ -46,7 +44,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:903](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L903) +[lib/k8s/cluster.ts:931](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L931) ___ @@ -58,7 +56,7 @@ List of environment variables to set in the container. Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:906](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L906) +[lib/k8s/cluster.ts:934](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L934) ___ @@ -68,7 +66,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:968](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L968) +[lib/k8s/cluster.ts:996](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L996) ___ @@ -83,7 +81,7 @@ default or override container images in workload controllers like Deployments an #### Defined in -[lib/k8s/cluster.ts:992](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L992) +[lib/k8s/cluster.ts:1020](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1020) ___ @@ -98,7 +96,7 @@ specified, or IfNotPresent otherwise. Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:1000](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1000) +[lib/k8s/cluster.ts:1028](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1028) ___ @@ -113,7 +111,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:1010](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1010) +[lib/k8s/cluster.ts:1038](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1038) ___ @@ -128,7 +126,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:1018](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1018) +[lib/k8s/cluster.ts:1046](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1046) ___ @@ -147,7 +145,7 @@ https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#containerpo #### Defined in -[lib/k8s/cluster.ts:1030](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1030) +[lib/k8s/cluster.ts:1058](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1058) ___ @@ -164,7 +162,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:1053](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1053) +[lib/k8s/cluster.ts:1081](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1081) ___ @@ -176,7 +174,7 @@ Resources resize policy for the container. #### Defined in -[lib/k8s/cluster.ts:1055](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1055) +[lib/k8s/cluster.ts:1083](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1083) ___ @@ -205,7 +203,7 @@ https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#resourcereq #### Defined in -[lib/k8s/cluster.ts:1074](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1074) +[lib/k8s/cluster.ts:1102](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1102) ___ @@ -220,7 +218,7 @@ Default is false. #### Defined in -[lib/k8s/cluster.ts:1141](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1141) +[lib/k8s/cluster.ts:1169](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1169) ___ @@ -240,7 +238,7 @@ Default is false #### Defined in -[lib/k8s/cluster.ts:1153](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1153) +[lib/k8s/cluster.ts:1181](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1181) ___ @@ -258,7 +256,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:1116](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1116) +[lib/k8s/cluster.ts:1144](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1144) ___ @@ -276,7 +274,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:1127](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1127) +[lib/k8s/cluster.ts:1155](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1155) ___ @@ -291,7 +289,7 @@ Default is false. #### Defined in -[lib/k8s/cluster.ts:1160](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1160) +[lib/k8s/cluster.ts:1188](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1188) ___ @@ -306,7 +304,7 @@ patch merge key: devicePath #### Defined in -[lib/k8s/cluster.ts:1167](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1167) +[lib/k8s/cluster.ts:1195](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1195) ___ @@ -316,7 +314,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1129](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1129) +[lib/k8s/cluster.ts:1157](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1157) ___ @@ -330,4 +328,4 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:1178](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1178) +[lib/k8s/cluster.ts:1206](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1206) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeContainerProbe.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeContainerProbe.md index 7195c319c5..4f79894ca8 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeContainerProbe.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeContainerProbe.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeContainerProbe" -linkTitle: "KubeContainerProbe" -slug: "lib_k8s_cluster.KubeContainerProbe" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeContainerProbe + +# Interface: KubeContainerProbe [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeContainerProbe @@ -20,7 +18,7 @@ slug: "lib_k8s_cluster.KubeContainerProbe" #### Defined in -[lib/k8s/cluster.ts:1188](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1188) +[lib/k8s/cluster.ts:1216](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1216) ___ @@ -30,7 +28,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1198](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1198) +[lib/k8s/cluster.ts:1226](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1226) ___ @@ -49,7 +47,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1182](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1182) +[lib/k8s/cluster.ts:1210](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1210) ___ @@ -59,7 +57,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1194](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1194) +[lib/k8s/cluster.ts:1222](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1222) ___ @@ -69,7 +67,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1196](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1196) +[lib/k8s/cluster.ts:1224](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1224) ___ @@ -79,7 +77,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1197](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1197) +[lib/k8s/cluster.ts:1225](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1225) ___ @@ -95,7 +93,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1191](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1191) +[lib/k8s/cluster.ts:1219](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1219) ___ @@ -105,4 +103,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1195](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1195) +[lib/k8s/cluster.ts:1223](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1223) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeContainerStatus.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeContainerStatus.md index f7bda2f50b..102ceb3da3 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeContainerStatus.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeContainerStatus.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeContainerStatus" -linkTitle: "KubeContainerStatus" -slug: "lib_k8s_cluster.KubeContainerStatus" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeContainerStatus + +# Interface: KubeContainerStatus [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeContainerStatus @@ -14,7 +12,7 @@ slug: "lib_k8s_cluster.KubeContainerStatus" #### Defined in -[lib/k8s/cluster.ts:1246](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1246) +[lib/k8s/cluster.ts:1274](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1274) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1247](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1247) +[lib/k8s/cluster.ts:1275](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1275) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1248](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1248) +[lib/k8s/cluster.ts:1276](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1276) ___ @@ -44,7 +42,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1252](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1252) +[lib/k8s/cluster.ts:1280](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1280) ___ @@ -54,7 +52,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1249](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1249) +[lib/k8s/cluster.ts:1277](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1277) ___ @@ -64,7 +62,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1250](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1250) +[lib/k8s/cluster.ts:1278](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1278) ___ @@ -74,7 +72,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1251](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1251) +[lib/k8s/cluster.ts:1279](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1279) ___ @@ -84,7 +82,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1254](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1254) +[lib/k8s/cluster.ts:1282](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1282) ___ @@ -94,4 +92,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1253](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1253) +[lib/k8s/cluster.ts:1281](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1281) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeManagedFields.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeManagedFields.md index 724627ba28..16b7bcb0c6 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeManagedFields.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeManagedFields.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeManagedFields" -linkTitle: "KubeManagedFields" -slug: "lib_k8s_cluster.KubeManagedFields" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeManagedFields + +# Interface: KubeManagedFields [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeManagedFields @@ -31,7 +29,7 @@ automatically converted. #### Defined in -[lib/k8s/cluster.ts:248](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L248) +[lib/k8s/cluster.ts:249](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L249) ___ @@ -48,7 +46,7 @@ There is currently only one possible value: "FieldsV1" #### Defined in -[lib/k8s/cluster.ts:253](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L253) +[lib/k8s/cluster.ts:254](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L254) ___ @@ -64,7 +62,7 @@ FieldsV1 holds the first JSON version format as described in the "FieldsV1" type #### Defined in -[lib/k8s/cluster.ts:257](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L257) +[lib/k8s/cluster.ts:258](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L258) ___ @@ -80,7 +78,7 @@ Manager is an identifier of the workflow managing these fields. #### Defined in -[lib/k8s/cluster.ts:261](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L261) +[lib/k8s/cluster.ts:262](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L262) ___ @@ -97,7 +95,7 @@ created. The only valid values for this field are 'Apply' and 'Update'. #### Defined in -[lib/k8s/cluster.ts:266](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L266) +[lib/k8s/cluster.ts:267](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L267) ___ @@ -118,7 +116,7 @@ Subresource field and it always corresponds to the version of the main resource. #### Defined in -[lib/k8s/cluster.ts:275](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L275) +[lib/k8s/cluster.ts:276](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L276) ___ @@ -137,4 +135,4 @@ removed from the entry because another manager took it over. #### Defined in -[lib/k8s/cluster.ts:282](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L282) +[lib/k8s/cluster.ts:283](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L283) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeManagedFieldsEntry.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeManagedFieldsEntry.md index ba26912f57..733234974f 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeManagedFieldsEntry.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeManagedFieldsEntry.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeManagedFieldsEntry" -linkTitle: "KubeManagedFieldsEntry" -slug: "lib_k8s_cluster.KubeManagedFieldsEntry" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeManagedFieldsEntry + +# Interface: KubeManagedFieldsEntry [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeManagedFieldsEntry @@ -28,7 +26,7 @@ automatically converted. #### Defined in -[lib/k8s/cluster.ts:248](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L248) +[lib/k8s/cluster.ts:249](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L249) ___ @@ -41,7 +39,7 @@ There is currently only one possible value: "FieldsV1" #### Defined in -[lib/k8s/cluster.ts:253](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L253) +[lib/k8s/cluster.ts:254](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L254) ___ @@ -53,7 +51,7 @@ FieldsV1 holds the first JSON version format as described in the "FieldsV1" type #### Defined in -[lib/k8s/cluster.ts:257](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L257) +[lib/k8s/cluster.ts:258](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L258) ___ @@ -65,7 +63,7 @@ Manager is an identifier of the workflow managing these fields. #### Defined in -[lib/k8s/cluster.ts:261](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L261) +[lib/k8s/cluster.ts:262](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L262) ___ @@ -78,7 +76,7 @@ created. The only valid values for this field are 'Apply' and 'Update'. #### Defined in -[lib/k8s/cluster.ts:266](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L266) +[lib/k8s/cluster.ts:267](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L267) ___ @@ -95,7 +93,7 @@ Subresource field and it always corresponds to the version of the main resource. #### Defined in -[lib/k8s/cluster.ts:275](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L275) +[lib/k8s/cluster.ts:276](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L276) ___ @@ -110,4 +108,4 @@ removed from the entry because another manager took it over. #### Defined in -[lib/k8s/cluster.ts:282](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L282) +[lib/k8s/cluster.ts:283](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L283) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeMetadata.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeMetadata.md index ba9992ba40..12f591736a 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeMetadata.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeMetadata.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeMetadata" -linkTitle: "KubeMetadata" -slug: "lib_k8s_cluster.KubeMetadata" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeMetadata + +# Interface: KubeMetadata [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeMetadata @@ -23,7 +21,7 @@ retrieve arbitrary metadata about this object #### Defined in -[lib/k8s/cluster.ts:75](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L75) +[lib/k8s/cluster.ts:76](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L76) ___ @@ -35,7 +33,7 @@ An RFC 3339 date of the date and time an object was created #### Defined in -[lib/k8s/cluster.ts:79](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L79) +[lib/k8s/cluster.ts:80](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L80) ___ @@ -50,7 +48,7 @@ Read-only. #### Defined in -[lib/k8s/cluster.ts:86](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L86) +[lib/k8s/cluster.ts:87](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L87) ___ @@ -70,7 +68,7 @@ the resource may be deleted prior to this time. #### Defined in -[lib/k8s/cluster.ts:98](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L98) +[lib/k8s/cluster.ts:99](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L99) ___ @@ -95,7 +93,7 @@ patch strategy: merge #### Defined in -[lib/k8s/cluster.ts:115](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L115) +[lib/k8s/cluster.ts:116](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L116) ___ @@ -116,7 +114,7 @@ return a 409. Applied only if Name is not specified. #### Defined in -[lib/k8s/cluster.ts:128](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L128) +[lib/k8s/cluster.ts:129](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L129) ___ @@ -130,7 +128,7 @@ Read-only. #### Defined in -[lib/k8s/cluster.ts:134](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L134) +[lib/k8s/cluster.ts:135](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L135) ___ @@ -144,7 +142,7 @@ A map of string keys and values that can be used to organize and categorize obje #### Defined in -[lib/k8s/cluster.ts:140](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L140) +[lib/k8s/cluster.ts:141](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L141) ___ @@ -160,7 +158,7 @@ version that the workflow used when modifying the object. #### Defined in -[lib/k8s/cluster.ts:148](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L148) +[lib/k8s/cluster.ts:149](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L149) ___ @@ -175,7 +173,7 @@ This value is used in the path when retrieving an individual object. #### Defined in -[lib/k8s/cluster.ts:155](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L155) +[lib/k8s/cluster.ts:156](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L156) ___ @@ -192,7 +190,7 @@ those objects will be empty. Must be a DNS_LABEL. Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:164](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L164) +[lib/k8s/cluster.ts:165](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L165) ___ @@ -207,7 +205,7 @@ set to true. There cannot be more than one managing controller. #### Defined in -[lib/k8s/cluster.ts:171](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L171) +[lib/k8s/cluster.ts:172](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L172) ___ @@ -225,7 +223,7 @@ resources, or different servers. #### Defined in -[lib/k8s/cluster.ts:181](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L181) +[lib/k8s/cluster.ts:182](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L182) ___ @@ -237,7 +235,7 @@ Deprecated: selfLink is a legacy read-only field that is no longer populated by #### Defined in -[lib/k8s/cluster.ts:185](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L185) +[lib/k8s/cluster.ts:186](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L186) ___ @@ -253,4 +251,4 @@ operations. Populated by the system. Read-only. #### Defined in -[lib/k8s/cluster.ts:193](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L193) +[lib/k8s/cluster.ts:194](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L194) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeMetrics.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeMetrics.md index 26324ac404..1ea1a3e682 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeMetrics.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeMetrics.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeMetrics" -linkTitle: "KubeMetrics" -slug: "lib_k8s_cluster.KubeMetrics" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeMetrics + +# Interface: KubeMetrics [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeMetrics @@ -14,7 +12,7 @@ slug: "lib_k8s_cluster.KubeMetrics" #### Defined in -[lib/k8s/cluster.ts:1213](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1213) +[lib/k8s/cluster.ts:1241](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1241) ___ @@ -32,7 +30,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1218](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1218) +[lib/k8s/cluster.ts:1246](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1246) ___ @@ -49,4 +47,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1214](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1214) +[lib/k8s/cluster.ts:1242](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1242) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeObjectIface.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeObjectIface.md index bda046a8d6..46c910ff0f 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeObjectIface.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeObjectIface.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeObjectIface" -linkTitle: "KubeObjectIface" -slug: "lib_k8s_cluster.KubeObjectIface" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeObjectIface + +# Interface: KubeObjectIface [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeObjectIface @@ -30,7 +28,7 @@ slug: "lib_k8s_cluster.KubeObjectIface" #### Defined in -[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L317) +[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L318) ## Properties @@ -40,7 +38,7 @@ slug: "lib_k8s_cluster.KubeObjectIface" #### Defined in -[lib/k8s/cluster.ts:318](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L318) +[lib/k8s/cluster.ts:319](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L319) ## Methods @@ -62,7 +60,7 @@ slug: "lib_k8s_cluster.KubeObjectIface" #### Defined in -[lib/k8s/cluster.ts:293](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L293) +[lib/k8s/cluster.ts:294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L294) ___ @@ -83,7 +81,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:320](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L320) +[lib/k8s/cluster.ts:321](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L321) ___ @@ -103,7 +101,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:316](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L316) +[lib/k8s/cluster.ts:317](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L317) ___ @@ -126,7 +124,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L303) +[lib/k8s/cluster.ts:304](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L304) ___ @@ -148,7 +146,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:298](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L298) +[lib/k8s/cluster.ts:299](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L299) ___ @@ -169,7 +167,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:312](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L312) +[lib/k8s/cluster.ts:313](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L313) ___ @@ -189,4 +187,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:309](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L309) +[lib/k8s/cluster.ts:310](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L310) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeObjectInterface.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeObjectInterface.md index f5395fa768..d7a3391ba8 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeObjectInterface.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeObjectInterface.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeObjectInterface" -linkTitle: "KubeObjectInterface" -slug: "lib_k8s_cluster.KubeObjectInterface" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeObjectInterface + +# Interface: KubeObjectInterface [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeObjectInterface @@ -93,7 +91,7 @@ that all Kubernetes resources have. #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -112,7 +110,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -122,4 +120,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.KubeOwnerReference.md b/docs/development/api/interfaces/lib_k8s_cluster.KubeOwnerReference.md index ca4ad7d843..52214ca934 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.KubeOwnerReference.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.KubeOwnerReference.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeOwnerReference" -linkTitle: "KubeOwnerReference" -slug: "lib_k8s_cluster.KubeOwnerReference" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / KubeOwnerReference + +# Interface: KubeOwnerReference [lib/k8s/cluster](../modules/lib_k8s_cluster.md).KubeOwnerReference @@ -16,7 +14,7 @@ API version of the referent. #### Defined in -[lib/k8s/cluster.ts:198](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L198) +[lib/k8s/cluster.ts:199](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L199) ___ @@ -35,7 +33,7 @@ otherwise 422 (Unprocessable Entity) will be returned. #### Defined in -[lib/k8s/cluster.ts:210](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L210) +[lib/k8s/cluster.ts:211](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L211) ___ @@ -47,7 +45,7 @@ If true, this reference points to the managing controller. #### Defined in -[lib/k8s/cluster.ts:212](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L212) +[lib/k8s/cluster.ts:213](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L213) ___ @@ -59,7 +57,7 @@ Kind of the referent. #### Defined in -[lib/k8s/cluster.ts:214](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L214) +[lib/k8s/cluster.ts:215](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L215) ___ @@ -71,7 +69,7 @@ Name of the referent. #### Defined in -[lib/k8s/cluster.ts:216](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L216) +[lib/k8s/cluster.ts:217](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L217) ___ @@ -83,4 +81,4 @@ UID of the referent. #### Defined in -[lib/k8s/cluster.ts:218](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L218) +[lib/k8s/cluster.ts:219](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L219) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.LabelSelector.md b/docs/development/api/interfaces/lib_k8s_cluster.LabelSelector.md index c9caf00640..b30bf57b79 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.LabelSelector.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.LabelSelector.md @@ -1,8 +1,6 @@ ---- -title: "Interface: LabelSelector" -linkTitle: "LabelSelector" -slug: "lib_k8s_cluster.LabelSelector" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / LabelSelector + +# Interface: LabelSelector [lib/k8s/cluster](../modules/lib_k8s_cluster.md).LabelSelector @@ -14,7 +12,7 @@ slug: "lib_k8s_cluster.LabelSelector" #### Defined in -[lib/k8s/cluster.ts:1202](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1202) +[lib/k8s/cluster.ts:1230](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1230) ___ @@ -28,4 +26,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:1207](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L1207) +[lib/k8s/cluster.ts:1235](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L1235) diff --git a/docs/development/api/interfaces/lib_k8s_cluster.StringDict.md b/docs/development/api/interfaces/lib_k8s_cluster.StringDict.md index 68c7612121..6ca249dcd2 100644 --- a/docs/development/api/interfaces/lib_k8s_cluster.StringDict.md +++ b/docs/development/api/interfaces/lib_k8s_cluster.StringDict.md @@ -1,8 +1,6 @@ ---- -title: "Interface: StringDict" -linkTitle: "StringDict" -slug: "lib_k8s_cluster.StringDict" ---- +[API](../API.md) / [lib/k8s/cluster](../modules/lib_k8s_cluster.md) / StringDict + +# Interface: StringDict [lib/k8s/cluster](../modules/lib_k8s_cluster.md).StringDict diff --git a/docs/development/api/interfaces/lib_k8s_configMap.KubeConfigMap.md b/docs/development/api/interfaces/lib_k8s_configMap.KubeConfigMap.md index 424fdcf083..9a1c972137 100644 --- a/docs/development/api/interfaces/lib_k8s_configMap.KubeConfigMap.md +++ b/docs/development/api/interfaces/lib_k8s_configMap.KubeConfigMap.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeConfigMap" -linkTitle: "KubeConfigMap" -slug: "lib_k8s_configMap.KubeConfigMap" ---- +[API](../API.md) / [lib/k8s/configMap](../modules/lib_k8s_configMap.md) / KubeConfigMap + +# Interface: KubeConfigMap [lib/k8s/configMap](../modules/lib_k8s_configMap.md).KubeConfigMap @@ -24,7 +22,7 @@ slug: "lib_k8s_configMap.KubeConfigMap" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/configMap.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/configMap.ts#L5) +[lib/k8s/configMap.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/configMap.ts#L5) ___ @@ -57,7 +55,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -71,4 +69,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) diff --git a/docs/development/api/interfaces/lib_k8s_crd.CRClassArgs.md b/docs/development/api/interfaces/lib_k8s_crd.CRClassArgs.md index 8428780c38..5cb51cec75 100644 --- a/docs/development/api/interfaces/lib_k8s_crd.CRClassArgs.md +++ b/docs/development/api/interfaces/lib_k8s_crd.CRClassArgs.md @@ -1,8 +1,6 @@ ---- -title: "Interface: CRClassArgs" -linkTitle: "CRClassArgs" -slug: "lib_k8s_crd.CRClassArgs" ---- +[API](../API.md) / [lib/k8s/crd](../modules/lib_k8s_crd.md) / CRClassArgs + +# Interface: CRClassArgs [lib/k8s/crd](../modules/lib_k8s_crd.md).CRClassArgs @@ -14,7 +12,7 @@ slug: "lib_k8s_crd.CRClassArgs" #### Defined in -[lib/k8s/crd.ts:94](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L94) +[lib/k8s/crd.ts:120](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L120) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/crd.ts:100](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L100) +[lib/k8s/crd.ts:126](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L126) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/crd.ts:98](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L98) +[lib/k8s/crd.ts:124](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L124) ___ @@ -44,4 +42,4 @@ ___ #### Defined in -[lib/k8s/crd.ts:99](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L99) +[lib/k8s/crd.ts:125](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L125) diff --git a/docs/development/api/interfaces/lib_k8s_crd.KubeCRD.md b/docs/development/api/interfaces/lib_k8s_crd.KubeCRD.md index b0b14feaa5..f462e25faa 100644 --- a/docs/development/api/interfaces/lib_k8s_crd.KubeCRD.md +++ b/docs/development/api/interfaces/lib_k8s_crd.KubeCRD.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeCRD" -linkTitle: "KubeCRD" -slug: "lib_k8s_crd.KubeCRD" ---- +[API](../API.md) / [lib/k8s/crd](../modules/lib_k8s_crd.md) / KubeCRD + +# Interface: KubeCRD [lib/k8s/crd](../modules/lib_k8s_crd.md).KubeCRD @@ -24,7 +22,7 @@ slug: "lib_k8s_crd.KubeCRD" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -78,7 +76,8 @@ ___ | Name | Type | | :------ | :------ | | `group` | `string` | -| `names` | { `kind`: `string` ; `listKind`: `string` ; `plural`: `string` ; `singular`: `string` } | +| `names` | { `categories?`: `string`[] ; `kind`: `string` ; `listKind`: `string` ; `plural`: `string` ; `singular`: `string` } | +| `names.categories?` | `string`[] | | `names.kind` | `string` | | `names.listKind` | `string` | | `names.plural` | `string` | @@ -89,4 +88,26 @@ ___ #### Defined in -[lib/k8s/crd.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L6) +[lib/k8s/crd.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L6) + +___ + +### status + +• `Optional` **status**: `Object` + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `acceptedNames?` | { `categories?`: `string`[] ; `kind`: `string` ; `plural`: `string` ; `shortNames`: `string`[] } | +| `acceptedNames.categories?` | `string`[] | +| `acceptedNames.kind` | `string` | +| `acceptedNames.plural` | `string` | +| `acceptedNames.shortNames` | `string`[] | +| `conditions?` | { `lastTransitionTime`: `string` ; `message`: `string` ; `reason`: `string` ; `status`: `string` ; `type`: `string` }[] | +| `storedVersions?` | `string`[] | + +#### Defined in + +[lib/k8s/crd.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L32) diff --git a/docs/development/api/interfaces/lib_k8s_cronJob.KubeCronJob.md b/docs/development/api/interfaces/lib_k8s_cronJob.KubeCronJob.md index ee79d74d83..ed1a11ca89 100644 --- a/docs/development/api/interfaces/lib_k8s_cronJob.KubeCronJob.md +++ b/docs/development/api/interfaces/lib_k8s_cronJob.KubeCronJob.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeCronJob" -linkTitle: "KubeCronJob" -slug: "lib_k8s_cronJob.KubeCronJob" ---- +[API](../API.md) / [lib/k8s/cronJob](../modules/lib_k8s_cronJob.md) / KubeCronJob + +# Interface: KubeCronJob [lib/k8s/cronJob](../modules/lib_k8s_cronJob.md).KubeCronJob @@ -30,7 +28,7 @@ CronJob structure returned by the k8s API. #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -53,7 +51,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -67,7 +65,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -99,7 +97,7 @@ ___ #### Defined in -[lib/k8s/cronJob.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cronJob.ts#L12) +[lib/k8s/cronJob.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cronJob.ts#L12) ___ @@ -113,4 +111,4 @@ ___ #### Defined in -[lib/k8s/cronJob.ts:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cronJob.ts#L32) +[lib/k8s/cronJob.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cronJob.ts#L32) diff --git a/docs/development/api/interfaces/lib_k8s_daemonSet.KubeDaemonSet.md b/docs/development/api/interfaces/lib_k8s_daemonSet.KubeDaemonSet.md index 76c5cce7ab..b10e5df2e0 100644 --- a/docs/development/api/interfaces/lib_k8s_daemonSet.KubeDaemonSet.md +++ b/docs/development/api/interfaces/lib_k8s_daemonSet.KubeDaemonSet.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeDaemonSet" -linkTitle: "KubeDaemonSet" -slug: "lib_k8s_daemonSet.KubeDaemonSet" ---- +[API](../API.md) / [lib/k8s/daemonSet](../modules/lib_k8s_daemonSet.md) / KubeDaemonSet + +# Interface: KubeDaemonSet [lib/k8s/daemonSet](../modules/lib_k8s_daemonSet.md).KubeDaemonSet @@ -24,7 +22,7 @@ slug: "lib_k8s_daemonSet.KubeDaemonSet" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -88,7 +86,7 @@ ___ #### Defined in -[lib/k8s/daemonSet.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/daemonSet.ts#L12) +[lib/k8s/daemonSet.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/daemonSet.ts#L12) ___ @@ -102,4 +100,4 @@ ___ #### Defined in -[lib/k8s/daemonSet.ts:26](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/daemonSet.ts#L26) +[lib/k8s/daemonSet.ts:26](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/daemonSet.ts#L26) diff --git a/docs/development/api/interfaces/lib_k8s_deployment.KubeDeployment.md b/docs/development/api/interfaces/lib_k8s_deployment.KubeDeployment.md index 88712bbee5..7a90cc6adc 100644 --- a/docs/development/api/interfaces/lib_k8s_deployment.KubeDeployment.md +++ b/docs/development/api/interfaces/lib_k8s_deployment.KubeDeployment.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeDeployment" -linkTitle: "KubeDeployment" -slug: "lib_k8s_deployment.KubeDeployment" ---- +[API](../API.md) / [lib/k8s/deployment](../modules/lib_k8s_deployment.md) / KubeDeployment + +# Interface: KubeDeployment [lib/k8s/deployment](../modules/lib_k8s_deployment.md).KubeDeployment @@ -24,7 +22,7 @@ slug: "lib_k8s_deployment.KubeDeployment" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -86,7 +84,7 @@ ___ #### Defined in -[lib/k8s/deployment.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/deployment.ts#L12) +[lib/k8s/deployment.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/deployment.ts#L12) ___ @@ -100,4 +98,4 @@ ___ #### Defined in -[lib/k8s/deployment.ts:24](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/deployment.ts#L24) +[lib/k8s/deployment.ts:24](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/deployment.ts#L24) diff --git a/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpoint.md b/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpoint.md index 12bda392b9..3ce4dd2e9a 100644 --- a/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpoint.md +++ b/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpoint.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeEndpoint" -linkTitle: "KubeEndpoint" -slug: "lib_k8s_endpoints.KubeEndpoint" ---- +[API](../API.md) / [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md) / KubeEndpoint + +# Interface: KubeEndpoint [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md).KubeEndpoint @@ -24,7 +22,7 @@ slug: "lib_k8s_endpoints.KubeEndpoint" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,4 +69,4 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:28](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L28) +[lib/k8s/endpoints.ts:28](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L28) diff --git a/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointAddress.md b/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointAddress.md index 3bca9856bb..fe673652de 100644 --- a/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointAddress.md +++ b/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointAddress.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeEndpointAddress" -linkTitle: "KubeEndpointAddress" -slug: "lib_k8s_endpoints.KubeEndpointAddress" ---- +[API](../API.md) / [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md) / KubeEndpointAddress + +# Interface: KubeEndpointAddress [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md).KubeEndpointAddress @@ -14,7 +12,7 @@ slug: "lib_k8s_endpoints.KubeEndpointAddress" #### Defined in -[lib/k8s/endpoints.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L12) +[lib/k8s/endpoints.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L12) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:13](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L13) +[lib/k8s/endpoints.ts:13](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L13) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:14](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L14) +[lib/k8s/endpoints.ts:14](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L14) ___ @@ -44,4 +42,4 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:15](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L15) +[lib/k8s/endpoints.ts:15](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L15) diff --git a/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointPort.md b/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointPort.md index e54c160c22..386e1d0ce7 100644 --- a/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointPort.md +++ b/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointPort.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeEndpointPort" -linkTitle: "KubeEndpointPort" -slug: "lib_k8s_endpoints.KubeEndpointPort" ---- +[API](../API.md) / [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md) / KubeEndpointPort + +# Interface: KubeEndpointPort [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md).KubeEndpointPort @@ -14,7 +12,7 @@ slug: "lib_k8s_endpoints.KubeEndpointPort" #### Defined in -[lib/k8s/endpoints.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L6) +[lib/k8s/endpoints.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L6) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L5) +[lib/k8s/endpoints.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L5) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L7) +[lib/k8s/endpoints.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L7) ___ @@ -44,4 +42,4 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L8) +[lib/k8s/endpoints.ts:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L8) diff --git a/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointSubset.md b/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointSubset.md index 2a1303d6b2..276df6744c 100644 --- a/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointSubset.md +++ b/docs/development/api/interfaces/lib_k8s_endpoints.KubeEndpointSubset.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeEndpointSubset" -linkTitle: "KubeEndpointSubset" -slug: "lib_k8s_endpoints.KubeEndpointSubset" ---- +[API](../API.md) / [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md) / KubeEndpointSubset + +# Interface: KubeEndpointSubset [lib/k8s/endpoints](../modules/lib_k8s_endpoints.md).KubeEndpointSubset @@ -14,7 +12,7 @@ slug: "lib_k8s_endpoints.KubeEndpointSubset" #### Defined in -[lib/k8s/endpoints.ts:22](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L22) +[lib/k8s/endpoints.ts:22](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L22) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:23](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L23) +[lib/k8s/endpoints.ts:23](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L23) ___ @@ -34,4 +32,4 @@ ___ #### Defined in -[lib/k8s/endpoints.ts:24](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/endpoints.ts#L24) +[lib/k8s/endpoints.ts:24](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/endpoints.ts#L24) diff --git a/docs/development/api/interfaces/lib_k8s_event.KubeEvent.md b/docs/development/api/interfaces/lib_k8s_event.KubeEvent.md index 43de3a71eb..575d7d16cd 100644 --- a/docs/development/api/interfaces/lib_k8s_event.KubeEvent.md +++ b/docs/development/api/interfaces/lib_k8s_event.KubeEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeEvent" -linkTitle: "KubeEvent" -slug: "lib_k8s_event.KubeEvent" ---- +[API](../API.md) / [lib/k8s/event](../modules/lib_k8s_event.md) / KubeEvent + +# Interface: KubeEvent [lib/k8s/event](../modules/lib_k8s_event.md).KubeEvent @@ -30,7 +28,7 @@ slug: "lib_k8s_event.KubeEvent" #### Defined in -[lib/k8s/event.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L12) +[lib/k8s/event.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L12) ___ @@ -40,7 +38,7 @@ ___ #### Defined in -[lib/k8s/event.ts:10](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L10) +[lib/k8s/event.ts:10](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L10) ___ @@ -50,7 +48,7 @@ ___ #### Defined in -[lib/k8s/event.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L11) +[lib/k8s/event.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L11) ___ @@ -60,7 +58,7 @@ ___ #### Defined in -[lib/k8s/event.ts:9](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L9) +[lib/k8s/event.ts:9](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L9) ___ @@ -70,4 +68,4 @@ ___ #### Defined in -[lib/k8s/event.ts:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/event.ts#L8) +[lib/k8s/event.ts:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/event.ts#L8) diff --git a/docs/development/api/interfaces/lib_k8s_hpa.CrossVersionObjectReference.md b/docs/development/api/interfaces/lib_k8s_hpa.CrossVersionObjectReference.md index 595095f909..b739334edc 100644 --- a/docs/development/api/interfaces/lib_k8s_hpa.CrossVersionObjectReference.md +++ b/docs/development/api/interfaces/lib_k8s_hpa.CrossVersionObjectReference.md @@ -1,8 +1,6 @@ ---- -title: "Interface: CrossVersionObjectReference" -linkTitle: "CrossVersionObjectReference" -slug: "lib_k8s_hpa.CrossVersionObjectReference" ---- +[API](../API.md) / [lib/k8s/hpa](../modules/lib_k8s_hpa.md) / CrossVersionObjectReference + +# Interface: CrossVersionObjectReference [lib/k8s/hpa](../modules/lib_k8s_hpa.md).CrossVersionObjectReference @@ -14,7 +12,7 @@ slug: "lib_k8s_hpa.CrossVersionObjectReference" #### Defined in -[lib/k8s/hpa.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L5) +[lib/k8s/hpa.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L5) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/hpa.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L6) +[lib/k8s/hpa.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L6) ___ @@ -34,4 +32,4 @@ ___ #### Defined in -[lib/k8s/hpa.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L7) +[lib/k8s/hpa.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L7) diff --git a/docs/development/api/interfaces/lib_k8s_hpa.KubeHPA.md b/docs/development/api/interfaces/lib_k8s_hpa.KubeHPA.md index 775a92ee61..f42be532c5 100644 --- a/docs/development/api/interfaces/lib_k8s_hpa.KubeHPA.md +++ b/docs/development/api/interfaces/lib_k8s_hpa.KubeHPA.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeHPA" -linkTitle: "KubeHPA" -slug: "lib_k8s_hpa.KubeHPA" ---- +[API](../API.md) / [lib/k8s/hpa](../modules/lib_k8s_hpa.md) / KubeHPA + +# Interface: KubeHPA [lib/k8s/hpa](../modules/lib_k8s_hpa.md).KubeHPA @@ -24,7 +22,7 @@ slug: "lib_k8s_hpa.KubeHPA" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,7 +69,7 @@ ___ #### Defined in -[lib/k8s/hpa.ts:158](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L158) +[lib/k8s/hpa.ts:158](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L158) ___ @@ -81,4 +79,4 @@ ___ #### Defined in -[lib/k8s/hpa.ts:159](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/hpa.ts#L159) +[lib/k8s/hpa.ts:159](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/hpa.ts#L159) diff --git a/docs/development/api/interfaces/lib_k8s_ingress.IngressBackend.md b/docs/development/api/interfaces/lib_k8s_ingress.IngressBackend.md index 7497dc9613..9bcaf4c5c3 100644 --- a/docs/development/api/interfaces/lib_k8s_ingress.IngressBackend.md +++ b/docs/development/api/interfaces/lib_k8s_ingress.IngressBackend.md @@ -1,8 +1,6 @@ ---- -title: "Interface: IngressBackend" -linkTitle: "IngressBackend" -slug: "lib_k8s_ingress.IngressBackend" ---- +[API](../API.md) / [lib/k8s/ingress](../modules/lib_k8s_ingress.md) / IngressBackend + +# Interface: IngressBackend [lib/k8s/ingress](../modules/lib_k8s_ingress.md).IngressBackend @@ -22,7 +20,7 @@ slug: "lib_k8s_ingress.IngressBackend" #### Defined in -[lib/k8s/ingress.ts:38](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L38) +[lib/k8s/ingress.ts:38](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L38) ___ @@ -41,4 +39,4 @@ ___ #### Defined in -[lib/k8s/ingress.ts:31](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L31) +[lib/k8s/ingress.ts:31](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L31) diff --git a/docs/development/api/interfaces/lib_k8s_ingress.IngressRule.md b/docs/development/api/interfaces/lib_k8s_ingress.IngressRule.md index 5d0c250655..bdeb0ca3c2 100644 --- a/docs/development/api/interfaces/lib_k8s_ingress.IngressRule.md +++ b/docs/development/api/interfaces/lib_k8s_ingress.IngressRule.md @@ -1,8 +1,6 @@ ---- -title: "Interface: IngressRule" -linkTitle: "IngressRule" -slug: "lib_k8s_ingress.IngressRule" ---- +[API](../API.md) / [lib/k8s/ingress](../modules/lib_k8s_ingress.md) / IngressRule + +# Interface: IngressRule [lib/k8s/ingress](../modules/lib_k8s_ingress.md).IngressRule @@ -14,7 +12,7 @@ slug: "lib_k8s_ingress.IngressRule" #### Defined in -[lib/k8s/ingress.ts:15](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L15) +[lib/k8s/ingress.ts:15](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L15) ___ @@ -30,4 +28,4 @@ ___ #### Defined in -[lib/k8s/ingress.ts:16](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L16) +[lib/k8s/ingress.ts:16](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L16) diff --git a/docs/development/api/interfaces/lib_k8s_ingress.KubeIngress.md b/docs/development/api/interfaces/lib_k8s_ingress.KubeIngress.md index d504ec1843..79624ce0d4 100644 --- a/docs/development/api/interfaces/lib_k8s_ingress.KubeIngress.md +++ b/docs/development/api/interfaces/lib_k8s_ingress.KubeIngress.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeIngress" -linkTitle: "KubeIngress" -slug: "lib_k8s_ingress.KubeIngress" ---- +[API](../API.md) / [lib/k8s/ingress](../modules/lib_k8s_ingress.md) / KubeIngress + +# Interface: KubeIngress [lib/k8s/ingress](../modules/lib_k8s_ingress.md).KubeIngress @@ -24,7 +22,7 @@ slug: "lib_k8s_ingress.KubeIngress" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -93,4 +91,4 @@ ___ #### Defined in -[lib/k8s/ingress.ts:46](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingress.ts#L46) +[lib/k8s/ingress.ts:46](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingress.ts#L46) diff --git a/docs/development/api/interfaces/lib_k8s_ingressClass.KubeIngressClass.md b/docs/development/api/interfaces/lib_k8s_ingressClass.KubeIngressClass.md index 9f447b3af0..2c2045a535 100644 --- a/docs/development/api/interfaces/lib_k8s_ingressClass.KubeIngressClass.md +++ b/docs/development/api/interfaces/lib_k8s_ingressClass.KubeIngressClass.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeIngressClass" -linkTitle: "KubeIngressClass" -slug: "lib_k8s_ingressClass.KubeIngressClass" ---- +[API](../API.md) / [lib/k8s/ingressClass](../modules/lib_k8s_ingressClass.md) / KubeIngressClass + +# Interface: KubeIngressClass [lib/k8s/ingressClass](../modules/lib_k8s_ingressClass.md).KubeIngressClass @@ -24,7 +22,7 @@ slug: "lib_k8s_ingressClass.KubeIngressClass" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -81,4 +79,4 @@ ___ #### Defined in -[lib/k8s/ingressClass.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/ingressClass.ts#L5) +[lib/k8s/ingressClass.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/ingressClass.ts#L5) diff --git a/docs/development/api/interfaces/lib_k8s_job.KubeJob.md b/docs/development/api/interfaces/lib_k8s_job.KubeJob.md index 219a8ac0c6..e47ae9aa91 100644 --- a/docs/development/api/interfaces/lib_k8s_job.KubeJob.md +++ b/docs/development/api/interfaces/lib_k8s_job.KubeJob.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeJob" -linkTitle: "KubeJob" -slug: "lib_k8s_job.KubeJob" ---- +[API](../API.md) / [lib/k8s/job](../modules/lib_k8s_job.md) / KubeJob + +# Interface: KubeJob [lib/k8s/job](../modules/lib_k8s_job.md).KubeJob @@ -24,7 +22,7 @@ slug: "lib_k8s_job.KubeJob" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -84,7 +82,7 @@ ___ #### Defined in -[lib/k8s/job.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/job.ts#L12) +[lib/k8s/job.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/job.ts#L12) ___ @@ -98,4 +96,4 @@ ___ #### Defined in -[lib/k8s/job.ts:20](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/job.ts#L20) +[lib/k8s/job.ts:20](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/job.ts#L20) diff --git a/docs/development/api/interfaces/lib_k8s_kubeconfig.KubeconfigObject.md b/docs/development/api/interfaces/lib_k8s_kubeconfig.KubeconfigObject.md index ba52cc96ae..88f1080fb3 100644 --- a/docs/development/api/interfaces/lib_k8s_kubeconfig.KubeconfigObject.md +++ b/docs/development/api/interfaces/lib_k8s_kubeconfig.KubeconfigObject.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeconfigObject" -linkTitle: "KubeconfigObject" -slug: "lib_k8s_kubeconfig.KubeconfigObject" ---- +[API](../API.md) / [lib/k8s/kubeconfig](../modules/lib_k8s_kubeconfig.md) / KubeconfigObject + +# Interface: KubeconfigObject [lib/k8s/kubeconfig](../modules/lib_k8s_kubeconfig.md).KubeconfigObject @@ -29,7 +27,7 @@ version of the kubeconfig file. #### Defined in -[lib/k8s/kubeconfig.ts:14](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/kubeconfig.ts#L14) +[lib/k8s/kubeconfig.ts:14](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/kubeconfig.ts#L14) ___ @@ -43,13 +41,13 @@ Clusters is a map of referencable names to cluster configs. #### Defined in -[lib/k8s/kubeconfig.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/kubeconfig.ts#L34) +[lib/k8s/kubeconfig.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/kubeconfig.ts#L34) ___ ### contexts -• **contexts**: { `context`: { `cluster`: `string` ; `extensions?`: { `extension`: {} ; `name`: `string` }[] ; `namespace?`: `string` ; `user`: `string` } ; `name`: `string` }[] +• **contexts**: { `context`: { `cluster`: `string` ; `extensions?`: { `extension`: { `customName?`: `string` } ; `name`: `string` }[] ; `namespace?`: `string` ; `user`: `string` } ; `name`: `string` }[] Contexts is a map of referencable names to context configs. @@ -57,7 +55,7 @@ Contexts is a map of referencable names to context configs. #### Defined in -[lib/k8s/kubeconfig.ts:130](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/kubeconfig.ts#L130) +[lib/k8s/kubeconfig.ts:130](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/kubeconfig.ts#L130) ___ @@ -69,7 +67,7 @@ CurrentContext is the name of the context that you would like to use by default #### Defined in -[lib/k8s/kubeconfig.ts:151](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/kubeconfig.ts#L151) +[lib/k8s/kubeconfig.ts:154](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/kubeconfig.ts#L154) ___ @@ -83,7 +81,7 @@ Extensions holds additional information. This is useful for extenders so that re #### Defined in -[lib/k8s/kubeconfig.ts:155](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/kubeconfig.ts#L155) +[lib/k8s/kubeconfig.ts:158](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/kubeconfig.ts#L158) ___ @@ -95,7 +93,7 @@ kind is the type of the kubeconfig file. It is always 'Config'. #### Defined in -[lib/k8s/kubeconfig.ts:16](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/kubeconfig.ts#L16) +[lib/k8s/kubeconfig.ts:16](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/kubeconfig.ts#L16) ___ @@ -116,7 +114,7 @@ Preferences holds general information to be use for cli interactions #### Defined in -[lib/k8s/kubeconfig.ts:20](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/kubeconfig.ts#L20) +[lib/k8s/kubeconfig.ts:20](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/kubeconfig.ts#L20) ___ @@ -130,4 +128,4 @@ AuthInfos is a map of referencable names to user configs. #### Defined in -[lib/k8s/kubeconfig.ts:67](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/kubeconfig.ts#L67) +[lib/k8s/kubeconfig.ts:67](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/kubeconfig.ts#L67) diff --git a/docs/development/api/interfaces/lib_k8s_lease.KubeLease.md b/docs/development/api/interfaces/lib_k8s_lease.KubeLease.md index f918fb31ed..c286131144 100644 --- a/docs/development/api/interfaces/lib_k8s_lease.KubeLease.md +++ b/docs/development/api/interfaces/lib_k8s_lease.KubeLease.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeLease" -linkTitle: "KubeLease" -slug: "lib_k8s_lease.KubeLease" ---- +[API](../API.md) / [lib/k8s/lease](../modules/lib_k8s_lease.md) / KubeLease + +# Interface: KubeLease [lib/k8s/lease](../modules/lib_k8s_lease.md).KubeLease @@ -24,7 +22,7 @@ slug: "lib_k8s_lease.KubeLease" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,4 +69,4 @@ ___ #### Defined in -[lib/k8s/lease.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/lease.ts#L12) +[lib/k8s/lease.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/lease.ts#L12) diff --git a/docs/development/api/interfaces/lib_k8s_lease.LeaseSpec.md b/docs/development/api/interfaces/lib_k8s_lease.LeaseSpec.md index 741962e8b6..90bea281a4 100644 --- a/docs/development/api/interfaces/lib_k8s_lease.LeaseSpec.md +++ b/docs/development/api/interfaces/lib_k8s_lease.LeaseSpec.md @@ -1,8 +1,6 @@ ---- -title: "Interface: LeaseSpec" -linkTitle: "LeaseSpec" -slug: "lib_k8s_lease.LeaseSpec" ---- +[API](../API.md) / [lib/k8s/lease](../modules/lib_k8s_lease.md) / LeaseSpec + +# Interface: LeaseSpec [lib/k8s/lease](../modules/lib_k8s_lease.md).LeaseSpec @@ -14,7 +12,7 @@ slug: "lib_k8s_lease.LeaseSpec" #### Defined in -[lib/k8s/lease.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/lease.ts#L5) +[lib/k8s/lease.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/lease.ts#L5) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/lease.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/lease.ts#L6) +[lib/k8s/lease.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/lease.ts#L6) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/lease.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/lease.ts#L7) +[lib/k8s/lease.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/lease.ts#L7) ___ @@ -44,4 +42,4 @@ ___ #### Defined in -[lib/k8s/lease.ts:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/lease.ts#L8) +[lib/k8s/lease.ts:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/lease.ts#L8) diff --git a/docs/development/api/interfaces/lib_k8s_limitRange.KubeLimitRange.md b/docs/development/api/interfaces/lib_k8s_limitRange.KubeLimitRange.md index da82f4a7f8..e8f6d41250 100644 --- a/docs/development/api/interfaces/lib_k8s_limitRange.KubeLimitRange.md +++ b/docs/development/api/interfaces/lib_k8s_limitRange.KubeLimitRange.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeLimitRange" -linkTitle: "KubeLimitRange" -slug: "lib_k8s_limitRange.KubeLimitRange" ---- +[API](../API.md) / [lib/k8s/limitRange](../modules/lib_k8s_limitRange.md) / KubeLimitRange + +# Interface: KubeLimitRange [lib/k8s/limitRange](../modules/lib_k8s_limitRange.md).KubeLimitRange @@ -24,7 +22,7 @@ slug: "lib_k8s_limitRange.KubeLimitRange" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,4 +69,4 @@ ___ #### Defined in -[lib/k8s/limitRange.tsx:27](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/limitRange.tsx#L27) +[lib/k8s/limitRange.tsx:27](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/limitRange.tsx#L27) diff --git a/docs/development/api/interfaces/lib_k8s_limitRange.LimitRangeSpec.md b/docs/development/api/interfaces/lib_k8s_limitRange.LimitRangeSpec.md index 6d1c32e36d..751b48a28b 100644 --- a/docs/development/api/interfaces/lib_k8s_limitRange.LimitRangeSpec.md +++ b/docs/development/api/interfaces/lib_k8s_limitRange.LimitRangeSpec.md @@ -1,8 +1,6 @@ ---- -title: "Interface: LimitRangeSpec" -linkTitle: "LimitRangeSpec" -slug: "lib_k8s_limitRange.LimitRangeSpec" ---- +[API](../API.md) / [lib/k8s/limitRange](../modules/lib_k8s_limitRange.md) / LimitRangeSpec + +# Interface: LimitRangeSpec [lib/k8s/limitRange](../modules/lib_k8s_limitRange.md).LimitRangeSpec @@ -14,4 +12,4 @@ slug: "lib_k8s_limitRange.LimitRangeSpec" #### Defined in -[lib/k8s/limitRange.tsx:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/limitRange.tsx#L5) +[lib/k8s/limitRange.tsx:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/limitRange.tsx#L5) diff --git a/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeMutatingWebhookConfiguration.md b/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeMutatingWebhookConfiguration.md index 2b32a096b1..e26298306a 100644 --- a/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeMutatingWebhookConfiguration.md +++ b/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeMutatingWebhookConfiguration.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeMutatingWebhookConfiguration" -linkTitle: "KubeMutatingWebhookConfiguration" -slug: "lib_k8s_mutatingWebhookConfiguration.KubeMutatingWebhookConfiguration" ---- +[API](../API.md) / [lib/k8s/mutatingWebhookConfiguration](../modules/lib_k8s_mutatingWebhookConfiguration.md) / KubeMutatingWebhookConfiguration + +# Interface: KubeMutatingWebhookConfiguration [lib/k8s/mutatingWebhookConfiguration](../modules/lib_k8s_mutatingWebhookConfiguration.md).KubeMutatingWebhookConfiguration @@ -24,7 +22,7 @@ slug: "lib_k8s_mutatingWebhookConfiguration.KubeMutatingWebhookConfiguration" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,4 +69,4 @@ ___ #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:24](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L24) +[lib/k8s/mutatingWebhookConfiguration.ts:24](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L24) diff --git a/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeRuleWithOperations.md b/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeRuleWithOperations.md index 3600e52353..8cec5ed84d 100644 --- a/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeRuleWithOperations.md +++ b/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeRuleWithOperations.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeRuleWithOperations" -linkTitle: "KubeRuleWithOperations" -slug: "lib_k8s_mutatingWebhookConfiguration.KubeRuleWithOperations" ---- +[API](../API.md) / [lib/k8s/mutatingWebhookConfiguration](../modules/lib_k8s_mutatingWebhookConfiguration.md) / KubeRuleWithOperations + +# Interface: KubeRuleWithOperations [lib/k8s/mutatingWebhookConfiguration](../modules/lib_k8s_mutatingWebhookConfiguration.md).KubeRuleWithOperations @@ -14,7 +12,7 @@ slug: "lib_k8s_mutatingWebhookConfiguration.KubeRuleWithOperations" #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L5) +[lib/k8s/mutatingWebhookConfiguration.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L5) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L6) +[lib/k8s/mutatingWebhookConfiguration.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L6) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L7) +[lib/k8s/mutatingWebhookConfiguration.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L7) ___ @@ -44,7 +42,7 @@ ___ #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L8) +[lib/k8s/mutatingWebhookConfiguration.ts:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L8) ___ @@ -54,4 +52,4 @@ ___ #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:9](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L9) +[lib/k8s/mutatingWebhookConfiguration.ts:9](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L9) diff --git a/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeWebhookClientConfig.md b/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeWebhookClientConfig.md index 65bcc2ef47..6a538eaac0 100644 --- a/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeWebhookClientConfig.md +++ b/docs/development/api/interfaces/lib_k8s_mutatingWebhookConfiguration.KubeWebhookClientConfig.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeWebhookClientConfig" -linkTitle: "KubeWebhookClientConfig" -slug: "lib_k8s_mutatingWebhookConfiguration.KubeWebhookClientConfig" ---- +[API](../API.md) / [lib/k8s/mutatingWebhookConfiguration](../modules/lib_k8s_mutatingWebhookConfiguration.md) / KubeWebhookClientConfig + +# Interface: KubeWebhookClientConfig [lib/k8s/mutatingWebhookConfiguration](../modules/lib_k8s_mutatingWebhookConfiguration.md).KubeWebhookClientConfig @@ -14,7 +12,7 @@ slug: "lib_k8s_mutatingWebhookConfiguration.KubeWebhookClientConfig" #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:13](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L13) +[lib/k8s/mutatingWebhookConfiguration.ts:13](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L13) ___ @@ -33,7 +31,7 @@ ___ #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:15](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L15) +[lib/k8s/mutatingWebhookConfiguration.ts:15](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L15) ___ @@ -43,4 +41,4 @@ ___ #### Defined in -[lib/k8s/mutatingWebhookConfiguration.ts:14](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L14) +[lib/k8s/mutatingWebhookConfiguration.ts:14](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/mutatingWebhookConfiguration.ts#L14) diff --git a/docs/development/api/interfaces/lib_k8s_namespace.KubeNamespace.md b/docs/development/api/interfaces/lib_k8s_namespace.KubeNamespace.md index 482fa4e033..c71fe00be4 100644 --- a/docs/development/api/interfaces/lib_k8s_namespace.KubeNamespace.md +++ b/docs/development/api/interfaces/lib_k8s_namespace.KubeNamespace.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeNamespace" -linkTitle: "KubeNamespace" -slug: "lib_k8s_namespace.KubeNamespace" ---- +[API](../API.md) / [lib/k8s/namespace](../modules/lib_k8s_namespace.md) / KubeNamespace + +# Interface: KubeNamespace [lib/k8s/namespace](../modules/lib_k8s_namespace.md).KubeNamespace @@ -24,7 +22,7 @@ slug: "lib_k8s_namespace.KubeNamespace" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -77,4 +75,4 @@ ___ #### Defined in -[lib/k8s/namespace.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/namespace.ts#L5) +[lib/k8s/namespace.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/namespace.ts#L5) diff --git a/docs/development/api/interfaces/lib_k8s_networkpolicy.IPBlock.md b/docs/development/api/interfaces/lib_k8s_networkpolicy.IPBlock.md index 11ca8a0021..6df5599612 100644 --- a/docs/development/api/interfaces/lib_k8s_networkpolicy.IPBlock.md +++ b/docs/development/api/interfaces/lib_k8s_networkpolicy.IPBlock.md @@ -1,8 +1,6 @@ ---- -title: "Interface: IPBlock" -linkTitle: "IPBlock" -slug: "lib_k8s_networkpolicy.IPBlock" ---- +[API](../API.md) / [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md) / IPBlock + +# Interface: IPBlock [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md).IPBlock @@ -14,7 +12,7 @@ slug: "lib_k8s_networkpolicy.IPBlock" #### Defined in -[lib/k8s/networkpolicy.tsx:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L11) +[lib/k8s/networkpolicy.tsx:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L11) ___ @@ -24,4 +22,4 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L12) +[lib/k8s/networkpolicy.tsx:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L12) diff --git a/docs/development/api/interfaces/lib_k8s_networkpolicy.KubeNetworkPolicy.md b/docs/development/api/interfaces/lib_k8s_networkpolicy.KubeNetworkPolicy.md index 916e9ae586..f8724985a2 100644 --- a/docs/development/api/interfaces/lib_k8s_networkpolicy.KubeNetworkPolicy.md +++ b/docs/development/api/interfaces/lib_k8s_networkpolicy.KubeNetworkPolicy.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeNetworkPolicy" -linkTitle: "KubeNetworkPolicy" -slug: "lib_k8s_networkpolicy.KubeNetworkPolicy" ---- +[API](../API.md) / [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md) / KubeNetworkPolicy + +# Interface: KubeNetworkPolicy [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md).KubeNetworkPolicy @@ -24,7 +22,7 @@ slug: "lib_k8s_networkpolicy.KubeNetworkPolicy" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L32) +[lib/k8s/networkpolicy.tsx:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L32) ___ @@ -44,7 +42,7 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:33](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L33) +[lib/k8s/networkpolicy.tsx:33](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L33) ___ @@ -67,7 +65,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -81,7 +79,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -91,7 +89,7 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L34) +[lib/k8s/networkpolicy.tsx:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L34) ___ @@ -101,4 +99,4 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:35](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L35) +[lib/k8s/networkpolicy.tsx:35](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L35) diff --git a/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyEgressRule.md b/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyEgressRule.md index ae6eb6b1e4..905e8dbf79 100644 --- a/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyEgressRule.md +++ b/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyEgressRule.md @@ -1,8 +1,6 @@ ---- -title: "Interface: NetworkPolicyEgressRule" -linkTitle: "NetworkPolicyEgressRule" -slug: "lib_k8s_networkpolicy.NetworkPolicyEgressRule" ---- +[API](../API.md) / [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md) / NetworkPolicyEgressRule + +# Interface: NetworkPolicyEgressRule [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md).NetworkPolicyEgressRule @@ -14,7 +12,7 @@ slug: "lib_k8s_networkpolicy.NetworkPolicyEgressRule" #### Defined in -[lib/k8s/networkpolicy.tsx:22](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L22) +[lib/k8s/networkpolicy.tsx:22](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L22) ___ @@ -24,4 +22,4 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:23](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L23) +[lib/k8s/networkpolicy.tsx:23](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L23) diff --git a/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyIngressRule.md b/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyIngressRule.md index e27d14d10a..a33eba26f8 100644 --- a/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyIngressRule.md +++ b/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyIngressRule.md @@ -1,8 +1,6 @@ ---- -title: "Interface: NetworkPolicyIngressRule" -linkTitle: "NetworkPolicyIngressRule" -slug: "lib_k8s_networkpolicy.NetworkPolicyIngressRule" ---- +[API](../API.md) / [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md) / NetworkPolicyIngressRule + +# Interface: NetworkPolicyIngressRule [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md).NetworkPolicyIngressRule @@ -14,7 +12,7 @@ slug: "lib_k8s_networkpolicy.NetworkPolicyIngressRule" #### Defined in -[lib/k8s/networkpolicy.tsx:28](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L28) +[lib/k8s/networkpolicy.tsx:28](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L28) ___ @@ -24,4 +22,4 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:27](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L27) +[lib/k8s/networkpolicy.tsx:27](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L27) diff --git a/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyPeer.md b/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyPeer.md index e82ee1711e..b8ce780d08 100644 --- a/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyPeer.md +++ b/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyPeer.md @@ -1,8 +1,6 @@ ---- -title: "Interface: NetworkPolicyPeer" -linkTitle: "NetworkPolicyPeer" -slug: "lib_k8s_networkpolicy.NetworkPolicyPeer" ---- +[API](../API.md) / [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md) / NetworkPolicyPeer + +# Interface: NetworkPolicyPeer [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md).NetworkPolicyPeer @@ -14,7 +12,7 @@ slug: "lib_k8s_networkpolicy.NetworkPolicyPeer" #### Defined in -[lib/k8s/networkpolicy.tsx:16](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L16) +[lib/k8s/networkpolicy.tsx:16](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L16) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:17](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L17) +[lib/k8s/networkpolicy.tsx:17](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L17) ___ @@ -34,4 +32,4 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L18) +[lib/k8s/networkpolicy.tsx:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L18) diff --git a/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyPort.md b/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyPort.md index 7aebc7b7c9..b69813d6c8 100644 --- a/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyPort.md +++ b/docs/development/api/interfaces/lib_k8s_networkpolicy.NetworkPolicyPort.md @@ -1,8 +1,6 @@ ---- -title: "Interface: NetworkPolicyPort" -linkTitle: "NetworkPolicyPort" -slug: "lib_k8s_networkpolicy.NetworkPolicyPort" ---- +[API](../API.md) / [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md) / NetworkPolicyPort + +# Interface: NetworkPolicyPort [lib/k8s/networkpolicy](../modules/lib_k8s_networkpolicy.md).NetworkPolicyPort @@ -14,7 +12,7 @@ slug: "lib_k8s_networkpolicy.NetworkPolicyPort" #### Defined in -[lib/k8s/networkpolicy.tsx:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L7) +[lib/k8s/networkpolicy.tsx:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L7) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L5) +[lib/k8s/networkpolicy.tsx:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L5) ___ @@ -34,4 +32,4 @@ ___ #### Defined in -[lib/k8s/networkpolicy.tsx:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/networkpolicy.tsx#L6) +[lib/k8s/networkpolicy.tsx:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/networkpolicy.tsx#L6) diff --git a/docs/development/api/interfaces/lib_k8s_node.KubeNode.md b/docs/development/api/interfaces/lib_k8s_node.KubeNode.md index 781dcdf757..87c4f8d161 100644 --- a/docs/development/api/interfaces/lib_k8s_node.KubeNode.md +++ b/docs/development/api/interfaces/lib_k8s_node.KubeNode.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeNode" -linkTitle: "KubeNode" -slug: "lib_k8s_node.KubeNode" ---- +[API](../API.md) / [lib/k8s/node](../modules/lib_k8s_node.md) / KubeNode + +# Interface: KubeNode [lib/k8s/node](../modules/lib_k8s_node.md).KubeNode @@ -24,7 +22,7 @@ slug: "lib_k8s_node.KubeNode" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -82,7 +80,7 @@ ___ #### Defined in -[lib/k8s/node.ts:45](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/node.ts#L45) +[lib/k8s/node.ts:45](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/node.ts#L45) ___ @@ -124,4 +122,4 @@ ___ #### Defined in -[lib/k8s/node.ts:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/node.ts#L8) +[lib/k8s/node.ts:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/node.ts#L8) diff --git a/docs/development/api/interfaces/lib_k8s_persistentVolume.KubePersistentVolume.md b/docs/development/api/interfaces/lib_k8s_persistentVolume.KubePersistentVolume.md index f59f9cc5e1..677993dd6d 100644 --- a/docs/development/api/interfaces/lib_k8s_persistentVolume.KubePersistentVolume.md +++ b/docs/development/api/interfaces/lib_k8s_persistentVolume.KubePersistentVolume.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubePersistentVolume" -linkTitle: "KubePersistentVolume" -slug: "lib_k8s_persistentVolume.KubePersistentVolume" ---- +[API](../API.md) / [lib/k8s/persistentVolume](../modules/lib_k8s_persistentVolume.md) / KubePersistentVolume + +# Interface: KubePersistentVolume [lib/k8s/persistentVolume](../modules/lib_k8s_persistentVolume.md).KubePersistentVolume @@ -24,7 +22,7 @@ slug: "lib_k8s_persistentVolume.KubePersistentVolume" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -82,7 +80,7 @@ ___ #### Defined in -[lib/k8s/persistentVolume.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolume.ts#L5) +[lib/k8s/persistentVolume.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolume.ts#L5) ___ @@ -100,4 +98,4 @@ ___ #### Defined in -[lib/k8s/persistentVolume.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolume.ts#L11) +[lib/k8s/persistentVolume.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolume.ts#L11) diff --git a/docs/development/api/interfaces/lib_k8s_persistentVolumeClaim.KubePersistentVolumeClaim.md b/docs/development/api/interfaces/lib_k8s_persistentVolumeClaim.KubePersistentVolumeClaim.md index 244959cbc0..e6a375a719 100644 --- a/docs/development/api/interfaces/lib_k8s_persistentVolumeClaim.KubePersistentVolumeClaim.md +++ b/docs/development/api/interfaces/lib_k8s_persistentVolumeClaim.KubePersistentVolumeClaim.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubePersistentVolumeClaim" -linkTitle: "KubePersistentVolumeClaim" -slug: "lib_k8s_persistentVolumeClaim.KubePersistentVolumeClaim" ---- +[API](../API.md) / [lib/k8s/persistentVolumeClaim](../modules/lib_k8s_persistentVolumeClaim.md) / KubePersistentVolumeClaim + +# Interface: KubePersistentVolumeClaim [lib/k8s/persistentVolumeClaim](../modules/lib_k8s_persistentVolumeClaim.md).KubePersistentVolumeClaim @@ -24,7 +22,7 @@ slug: "lib_k8s_persistentVolumeClaim.KubePersistentVolumeClaim" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -88,7 +86,7 @@ ___ #### Defined in -[lib/k8s/persistentVolumeClaim.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolumeClaim.ts#L5) +[lib/k8s/persistentVolumeClaim.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolumeClaim.ts#L5) ___ @@ -111,4 +109,4 @@ ___ #### Defined in -[lib/k8s/persistentVolumeClaim.ts:19](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/persistentVolumeClaim.ts#L19) +[lib/k8s/persistentVolumeClaim.ts:19](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/persistentVolumeClaim.ts#L19) diff --git a/docs/development/api/interfaces/lib_k8s_pod.ExecOptions.md b/docs/development/api/interfaces/lib_k8s_pod.ExecOptions.md index f5920f22d9..2b86a69011 100644 --- a/docs/development/api/interfaces/lib_k8s_pod.ExecOptions.md +++ b/docs/development/api/interfaces/lib_k8s_pod.ExecOptions.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ExecOptions" -linkTitle: "ExecOptions" -slug: "lib_k8s_pod.ExecOptions" ---- +[API](../API.md) / [lib/k8s/pod](../modules/lib_k8s_pod.md) / ExecOptions + +# Interface: ExecOptions [lib/k8s/pod](../modules/lib_k8s_pod.md).ExecOptions @@ -26,7 +24,7 @@ Additional WebSocket protocols to use when connecting. #### Defined in -[lib/k8s/apiProxy.ts:1262](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1262) +[lib/k8s/apiProxy.ts:1286](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1286) ___ @@ -40,7 +38,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1273](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1273) +[lib/k8s/apiProxy.ts:1297](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1297) ___ @@ -50,7 +48,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:49](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L49) +[lib/k8s/pod.ts:49](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L49) ___ @@ -66,7 +64,7 @@ Whether the stream is expected to receive JSON data. #### Defined in -[lib/k8s/apiProxy.ts:1260](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1260) +[lib/k8s/apiProxy.ts:1284](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1284) ___ @@ -82,7 +80,7 @@ Whether to attempt to reconnect the WebSocket connection if it fails. #### Defined in -[lib/k8s/apiProxy.ts:1266](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1266) +[lib/k8s/apiProxy.ts:1290](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1290) ___ @@ -96,7 +94,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1272](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1272) +[lib/k8s/apiProxy.ts:1296](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1296) ___ @@ -110,7 +108,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1270](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1270) +[lib/k8s/apiProxy.ts:1294](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1294) ___ @@ -124,7 +122,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1271](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1271) +[lib/k8s/apiProxy.ts:1295](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1295) ___ @@ -138,7 +136,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1269](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1269) +[lib/k8s/apiProxy.ts:1293](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1293) ## Methods @@ -158,7 +156,7 @@ A callback function to execute when the WebSocket connection is established. #### Defined in -[lib/k8s/apiProxy.ts:1264](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1264) +[lib/k8s/apiProxy.ts:1288](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1288) ___ @@ -178,4 +176,4 @@ A callback function to execute when the WebSocket connection fails. #### Defined in -[lib/k8s/apiProxy.ts:1268](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1268) +[lib/k8s/apiProxy.ts:1292](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1292) diff --git a/docs/development/api/interfaces/lib_k8s_pod.KubePod.md b/docs/development/api/interfaces/lib_k8s_pod.KubePod.md index 26b8912493..4336d2615f 100644 --- a/docs/development/api/interfaces/lib_k8s_pod.KubePod.md +++ b/docs/development/api/interfaces/lib_k8s_pod.KubePod.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubePod" -linkTitle: "KubePod" -slug: "lib_k8s_pod.KubePod" ---- +[API](../API.md) / [lib/k8s/pod](../modules/lib_k8s_pod.md) / KubePod + +# Interface: KubePod [lib/k8s/pod](../modules/lib_k8s_pod.md).KubePod @@ -24,7 +22,7 @@ slug: "lib_k8s_pod.KubePod" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,7 +69,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:32](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L32) +[lib/k8s/pod.ts:32](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L32) ___ @@ -90,7 +88,7 @@ ___ | `conditions` | [`KubeCondition`](lib_k8s_cluster.KubeCondition.md)[] | | `containerStatuses` | [`KubeContainerStatus`](lib_k8s_cluster.KubeContainerStatus.md)[] | | `ephemeralContainerStatuses?` | [`KubeContainerStatus`](lib_k8s_cluster.KubeContainerStatus.md)[] | -| `hostIP` | `string` | +| `hostIP?` | `string` | | `initContainerStatuses?` | [`KubeContainerStatus`](lib_k8s_cluster.KubeContainerStatus.md)[] | | `message?` | `string` | | `phase` | `string` | @@ -100,4 +98,4 @@ ___ #### Defined in -[lib/k8s/pod.ts:33](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L33) +[lib/k8s/pod.ts:33](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L33) diff --git a/docs/development/api/interfaces/lib_k8s_pod.KubePodSpec.md b/docs/development/api/interfaces/lib_k8s_pod.KubePodSpec.md index bfd613187a..b461b4a309 100644 --- a/docs/development/api/interfaces/lib_k8s_pod.KubePodSpec.md +++ b/docs/development/api/interfaces/lib_k8s_pod.KubePodSpec.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubePodSpec" -linkTitle: "KubePodSpec" -slug: "lib_k8s_pod.KubePodSpec" ---- +[API](../API.md) / [lib/k8s/pod](../modules/lib_k8s_pod.md) / KubePodSpec + +# Interface: KubePodSpec [lib/k8s/pod](../modules/lib_k8s_pod.md).KubePodSpec @@ -14,7 +12,7 @@ slug: "lib_k8s_pod.KubePodSpec" #### Defined in -[lib/k8s/pod.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L18) +[lib/k8s/pod.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L18) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:24](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L24) +[lib/k8s/pod.ts:24](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L24) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:23](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L23) +[lib/k8s/pod.ts:23](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L23) ___ @@ -44,7 +42,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:19](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L19) +[lib/k8s/pod.ts:19](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L19) ___ @@ -58,7 +56,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:20](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L20) +[lib/k8s/pod.ts:20](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L20) ___ @@ -68,7 +66,7 @@ ___ #### Defined in -[lib/k8s/pod.ts:25](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L25) +[lib/k8s/pod.ts:25](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L25) ___ @@ -78,4 +76,4 @@ ___ #### Defined in -[lib/k8s/pod.ts:28](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L28) +[lib/k8s/pod.ts:28](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L28) diff --git a/docs/development/api/interfaces/lib_k8s_pod.KubeVolume.md b/docs/development/api/interfaces/lib_k8s_pod.KubeVolume.md index 939a1cff6e..f954df849f 100644 --- a/docs/development/api/interfaces/lib_k8s_pod.KubeVolume.md +++ b/docs/development/api/interfaces/lib_k8s_pod.KubeVolume.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeVolume" -linkTitle: "KubeVolume" -slug: "lib_k8s_pod.KubeVolume" ---- +[API](../API.md) / [lib/k8s/pod](../modules/lib_k8s_pod.md) / KubeVolume + +# Interface: KubeVolume [lib/k8s/pod](../modules/lib_k8s_pod.md).KubeVolume @@ -18,4 +16,4 @@ slug: "lib_k8s_pod.KubeVolume" #### Defined in -[lib/k8s/pod.ts:13](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L13) +[lib/k8s/pod.ts:13](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L13) diff --git a/docs/development/api/interfaces/lib_k8s_pod.LogOptions.md b/docs/development/api/interfaces/lib_k8s_pod.LogOptions.md index c032cc8303..08720a58e6 100644 --- a/docs/development/api/interfaces/lib_k8s_pod.LogOptions.md +++ b/docs/development/api/interfaces/lib_k8s_pod.LogOptions.md @@ -1,8 +1,6 @@ ---- -title: "Interface: LogOptions" -linkTitle: "LogOptions" -slug: "lib_k8s_pod.LogOptions" ---- +[API](../API.md) / [lib/k8s/pod](../modules/lib_k8s_pod.md) / LogOptions + +# Interface: LogOptions [lib/k8s/pod](../modules/lib_k8s_pod.md).LogOptions @@ -16,7 +14,7 @@ Whether to follow the log stream #### Defined in -[lib/k8s/pod.ts:60](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L60) +[lib/k8s/pod.ts:60](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L60) ___ @@ -28,7 +26,7 @@ Whether to show the logs from previous runs of the container (only for restarted #### Defined in -[lib/k8s/pod.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L56) +[lib/k8s/pod.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L56) ___ @@ -40,7 +38,7 @@ Whether to show the timestamps in the logs #### Defined in -[lib/k8s/pod.ts:58](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L58) +[lib/k8s/pod.ts:58](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L58) ___ @@ -52,7 +50,7 @@ The number of lines to display from the end side of the log #### Defined in -[lib/k8s/pod.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L54) +[lib/k8s/pod.ts:54](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L54) ## Methods @@ -68,4 +66,4 @@ Callback to be called when the reconnection attempts stop #### Defined in -[lib/k8s/pod.ts:62](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/pod.ts#L62) +[lib/k8s/pod.ts:62](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/pod.ts#L62) diff --git a/docs/development/api/interfaces/lib_k8s_podDisruptionBudget.KubePDB.md b/docs/development/api/interfaces/lib_k8s_podDisruptionBudget.KubePDB.md index de17e40e30..38f79fe32e 100644 --- a/docs/development/api/interfaces/lib_k8s_podDisruptionBudget.KubePDB.md +++ b/docs/development/api/interfaces/lib_k8s_podDisruptionBudget.KubePDB.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubePDB" -linkTitle: "KubePDB" -slug: "lib_k8s_podDisruptionBudget.KubePDB" ---- +[API](../API.md) / [lib/k8s/podDisruptionBudget](../modules/lib_k8s_podDisruptionBudget.md) / KubePDB + +# Interface: KubePDB [lib/k8s/podDisruptionBudget](../modules/lib_k8s_podDisruptionBudget.md).KubePDB @@ -24,7 +22,7 @@ slug: "lib_k8s_podDisruptionBudget.KubePDB" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -84,7 +82,7 @@ ___ #### Defined in -[lib/k8s/podDisruptionBudget.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/podDisruptionBudget.ts#L5) +[lib/k8s/podDisruptionBudget.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/podDisruptionBudget.ts#L5) ___ @@ -106,4 +104,4 @@ ___ #### Defined in -[lib/k8s/podDisruptionBudget.ts:19](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/podDisruptionBudget.ts#L19) +[lib/k8s/podDisruptionBudget.ts:19](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/podDisruptionBudget.ts#L19) diff --git a/docs/development/api/interfaces/lib_k8s_priorityClass.KubePriorityClass.md b/docs/development/api/interfaces/lib_k8s_priorityClass.KubePriorityClass.md index f609cdb14f..0562a88fc0 100644 --- a/docs/development/api/interfaces/lib_k8s_priorityClass.KubePriorityClass.md +++ b/docs/development/api/interfaces/lib_k8s_priorityClass.KubePriorityClass.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubePriorityClass" -linkTitle: "KubePriorityClass" -slug: "lib_k8s_priorityClass.KubePriorityClass" ---- +[API](../API.md) / [lib/k8s/priorityClass](../modules/lib_k8s_priorityClass.md) / KubePriorityClass + +# Interface: KubePriorityClass [lib/k8s/priorityClass](../modules/lib_k8s_priorityClass.md).KubePriorityClass @@ -24,7 +22,7 @@ slug: "lib_k8s_priorityClass.KubePriorityClass" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L8) +[lib/k8s/priorityClass.ts:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L8) ___ @@ -44,7 +42,7 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L7) +[lib/k8s/priorityClass.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L7) ___ @@ -67,7 +65,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -81,7 +79,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -91,7 +89,7 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L6) +[lib/k8s/priorityClass.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L6) ___ @@ -101,4 +99,4 @@ ___ #### Defined in -[lib/k8s/priorityClass.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClass.ts#L5) +[lib/k8s/priorityClass.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClass.ts#L5) diff --git a/docs/development/api/interfaces/lib_k8s_replicaSet.KubeReplicaSet.md b/docs/development/api/interfaces/lib_k8s_replicaSet.KubeReplicaSet.md index 9274c4f610..616e00b358 100644 --- a/docs/development/api/interfaces/lib_k8s_replicaSet.KubeReplicaSet.md +++ b/docs/development/api/interfaces/lib_k8s_replicaSet.KubeReplicaSet.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeReplicaSet" -linkTitle: "KubeReplicaSet" -slug: "lib_k8s_replicaSet.KubeReplicaSet" ---- +[API](../API.md) / [lib/k8s/replicaSet](../modules/lib_k8s_replicaSet.md) / KubeReplicaSet + +# Interface: KubeReplicaSet [lib/k8s/replicaSet](../modules/lib_k8s_replicaSet.md).KubeReplicaSet @@ -24,7 +22,7 @@ slug: "lib_k8s_replicaSet.KubeReplicaSet" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -86,7 +84,7 @@ ___ #### Defined in -[lib/k8s/replicaSet.ts:13](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/replicaSet.ts#L13) +[lib/k8s/replicaSet.ts:13](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/replicaSet.ts#L13) ___ @@ -107,4 +105,4 @@ ___ #### Defined in -[lib/k8s/replicaSet.ts:23](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/replicaSet.ts#L23) +[lib/k8s/replicaSet.ts:23](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/replicaSet.ts#L23) diff --git a/docs/development/api/interfaces/lib_k8s_resourceQuota.KubeResourceQuota.md b/docs/development/api/interfaces/lib_k8s_resourceQuota.KubeResourceQuota.md index 149267d726..eea7c1bb75 100644 --- a/docs/development/api/interfaces/lib_k8s_resourceQuota.KubeResourceQuota.md +++ b/docs/development/api/interfaces/lib_k8s_resourceQuota.KubeResourceQuota.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeResourceQuota" -linkTitle: "KubeResourceQuota" -slug: "lib_k8s_resourceQuota.KubeResourceQuota" ---- +[API](../API.md) / [lib/k8s/resourceQuota](../modules/lib_k8s_resourceQuota.md) / KubeResourceQuota + +# Interface: KubeResourceQuota [lib/k8s/resourceQuota](../modules/lib_k8s_resourceQuota.md).KubeResourceQuota @@ -24,7 +22,7 @@ slug: "lib_k8s_resourceQuota.KubeResourceQuota" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,7 +69,7 @@ ___ #### Defined in -[lib/k8s/resourceQuota.ts:29](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/resourceQuota.ts#L29) +[lib/k8s/resourceQuota.ts:29](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/resourceQuota.ts#L29) ___ @@ -81,4 +79,4 @@ ___ #### Defined in -[lib/k8s/resourceQuota.ts:30](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/resourceQuota.ts#L30) +[lib/k8s/resourceQuota.ts:30](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/resourceQuota.ts#L30) diff --git a/docs/development/api/interfaces/lib_k8s_role.KubeRole.md b/docs/development/api/interfaces/lib_k8s_role.KubeRole.md index 1d3fcc499a..c3058e8cd6 100644 --- a/docs/development/api/interfaces/lib_k8s_role.KubeRole.md +++ b/docs/development/api/interfaces/lib_k8s_role.KubeRole.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeRole" -linkTitle: "KubeRole" -slug: "lib_k8s_role.KubeRole" ---- +[API](../API.md) / [lib/k8s/role](../modules/lib_k8s_role.md) / KubeRole + +# Interface: KubeRole [lib/k8s/role](../modules/lib_k8s_role.md).KubeRole @@ -24,7 +22,7 @@ slug: "lib_k8s_role.KubeRole" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -81,4 +79,4 @@ ___ #### Defined in -[lib/k8s/role.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/role.ts#L5) +[lib/k8s/role.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/role.ts#L5) diff --git a/docs/development/api/interfaces/lib_k8s_roleBinding.KubeRoleBinding.md b/docs/development/api/interfaces/lib_k8s_roleBinding.KubeRoleBinding.md index 200248eba6..a5478b21b3 100644 --- a/docs/development/api/interfaces/lib_k8s_roleBinding.KubeRoleBinding.md +++ b/docs/development/api/interfaces/lib_k8s_roleBinding.KubeRoleBinding.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeRoleBinding" -linkTitle: "KubeRoleBinding" -slug: "lib_k8s_roleBinding.KubeRoleBinding" ---- +[API](../API.md) / [lib/k8s/roleBinding](../modules/lib_k8s_roleBinding.md) / KubeRoleBinding + +# Interface: KubeRoleBinding [lib/k8s/roleBinding](../modules/lib_k8s_roleBinding.md).KubeRoleBinding @@ -24,7 +22,7 @@ slug: "lib_k8s_roleBinding.KubeRoleBinding" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -79,7 +77,7 @@ ___ #### Defined in -[lib/k8s/roleBinding.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/roleBinding.ts#L5) +[lib/k8s/roleBinding.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/roleBinding.ts#L5) ___ @@ -89,4 +87,4 @@ ___ #### Defined in -[lib/k8s/roleBinding.ts:10](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/roleBinding.ts#L10) +[lib/k8s/roleBinding.ts:10](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/roleBinding.ts#L10) diff --git a/docs/development/api/interfaces/lib_k8s_runtime.KubeRuntimeClass.md b/docs/development/api/interfaces/lib_k8s_runtime.KubeRuntimeClass.md index 287012ce19..8ca747b028 100644 --- a/docs/development/api/interfaces/lib_k8s_runtime.KubeRuntimeClass.md +++ b/docs/development/api/interfaces/lib_k8s_runtime.KubeRuntimeClass.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeRuntimeClass" -linkTitle: "KubeRuntimeClass" -slug: "lib_k8s_runtime.KubeRuntimeClass" ---- +[API](../API.md) / [lib/k8s/runtime](../modules/lib_k8s_runtime.md) / KubeRuntimeClass + +# Interface: KubeRuntimeClass [lib/k8s/runtime](../modules/lib_k8s_runtime.md).KubeRuntimeClass @@ -24,7 +22,7 @@ slug: "lib_k8s_runtime.KubeRuntimeClass" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/runtime.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/runtime.ts#L5) +[lib/k8s/runtime.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/runtime.ts#L5) ___ @@ -57,7 +55,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -71,4 +69,4 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) diff --git a/docs/development/api/interfaces/lib_k8s_secret.KubeSecret.md b/docs/development/api/interfaces/lib_k8s_secret.KubeSecret.md index 868e36c03b..88d0d3d3f4 100644 --- a/docs/development/api/interfaces/lib_k8s_secret.KubeSecret.md +++ b/docs/development/api/interfaces/lib_k8s_secret.KubeSecret.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeSecret" -linkTitle: "KubeSecret" -slug: "lib_k8s_secret.KubeSecret" ---- +[API](../API.md) / [lib/k8s/secret](../modules/lib_k8s_secret.md) / KubeSecret + +# Interface: KubeSecret [lib/k8s/secret](../modules/lib_k8s_secret.md).KubeSecret @@ -24,7 +22,7 @@ slug: "lib_k8s_secret.KubeSecret" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/k8s/secret.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/secret.ts#L5) +[lib/k8s/secret.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/secret.ts#L5) ___ @@ -57,7 +55,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -71,7 +69,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -81,4 +79,4 @@ ___ #### Defined in -[lib/k8s/secret.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/secret.ts#L6) +[lib/k8s/secret.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/secret.ts#L6) diff --git a/docs/development/api/interfaces/lib_k8s_service.KubeLoadBalancerIngress.md b/docs/development/api/interfaces/lib_k8s_service.KubeLoadBalancerIngress.md index 36393546bd..c57224784b 100644 --- a/docs/development/api/interfaces/lib_k8s_service.KubeLoadBalancerIngress.md +++ b/docs/development/api/interfaces/lib_k8s_service.KubeLoadBalancerIngress.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeLoadBalancerIngress" -linkTitle: "KubeLoadBalancerIngress" -slug: "lib_k8s_service.KubeLoadBalancerIngress" ---- +[API](../API.md) / [lib/k8s/service](../modules/lib_k8s_service.md) / KubeLoadBalancerIngress + +# Interface: KubeLoadBalancerIngress [lib/k8s/service](../modules/lib_k8s_service.md).KubeLoadBalancerIngress @@ -14,7 +12,7 @@ slug: "lib_k8s_service.KubeLoadBalancerIngress" #### Defined in -[lib/k8s/service.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L12) +[lib/k8s/service.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L12) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/service.ts:13](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L13) +[lib/k8s/service.ts:13](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L13) ___ @@ -34,4 +32,4 @@ ___ #### Defined in -[lib/k8s/service.ts:14](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L14) +[lib/k8s/service.ts:14](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L14) diff --git a/docs/development/api/interfaces/lib_k8s_service.KubePortStatus.md b/docs/development/api/interfaces/lib_k8s_service.KubePortStatus.md index 0f6fee9121..a40a885454 100644 --- a/docs/development/api/interfaces/lib_k8s_service.KubePortStatus.md +++ b/docs/development/api/interfaces/lib_k8s_service.KubePortStatus.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubePortStatus" -linkTitle: "KubePortStatus" -slug: "lib_k8s_service.KubePortStatus" ---- +[API](../API.md) / [lib/k8s/service](../modules/lib_k8s_service.md) / KubePortStatus + +# Interface: KubePortStatus [lib/k8s/service](../modules/lib_k8s_service.md).KubePortStatus @@ -14,7 +12,7 @@ slug: "lib_k8s_service.KubePortStatus" #### Defined in -[lib/k8s/service.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L6) +[lib/k8s/service.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L6) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/k8s/service.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L7) +[lib/k8s/service.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L7) ___ @@ -34,4 +32,4 @@ ___ #### Defined in -[lib/k8s/service.ts:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L8) +[lib/k8s/service.ts:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L8) diff --git a/docs/development/api/interfaces/lib_k8s_service.KubeService.md b/docs/development/api/interfaces/lib_k8s_service.KubeService.md index 3c12ff1a02..13c767261b 100644 --- a/docs/development/api/interfaces/lib_k8s_service.KubeService.md +++ b/docs/development/api/interfaces/lib_k8s_service.KubeService.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeService" -linkTitle: "KubeService" -slug: "lib_k8s_service.KubeService" ---- +[API](../API.md) / [lib/k8s/service](../modules/lib_k8s_service.md) / KubeService + +# Interface: KubeService [lib/k8s/service](../modules/lib_k8s_service.md).KubeService @@ -24,7 +22,7 @@ slug: "lib_k8s_service.KubeService" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -79,13 +77,13 @@ ___ | :------ | :------ | | `clusterIP` | `string` | | `externalIPs` | `string`[] | -| `ports` | { `name`: `string` ; `nodePort`: `number` ; `port`: `number` ; `protocol`: `string` ; `targetPort`: `string` \| `number` }[] | +| `ports?` | { `name`: `string` ; `nodePort`: `number` ; `port`: `number` ; `protocol`: `string` ; `targetPort`: `string` \| `number` }[] | | `selector` | { `[key: string]`: `string`; } | | `type` | `string` | #### Defined in -[lib/k8s/service.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L18) +[lib/k8s/service.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L18) ___ @@ -103,4 +101,4 @@ ___ #### Defined in -[lib/k8s/service.ts:34](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/service.ts#L34) +[lib/k8s/service.ts:34](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/service.ts#L34) diff --git a/docs/development/api/interfaces/lib_k8s_serviceAccount.KubeServiceAccount.md b/docs/development/api/interfaces/lib_k8s_serviceAccount.KubeServiceAccount.md index 641c062fd0..42a5b1df8d 100644 --- a/docs/development/api/interfaces/lib_k8s_serviceAccount.KubeServiceAccount.md +++ b/docs/development/api/interfaces/lib_k8s_serviceAccount.KubeServiceAccount.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeServiceAccount" -linkTitle: "KubeServiceAccount" -slug: "lib_k8s_serviceAccount.KubeServiceAccount" ---- +[API](../API.md) / [lib/k8s/serviceAccount](../modules/lib_k8s_serviceAccount.md) / KubeServiceAccount + +# Interface: KubeServiceAccount [lib/k8s/serviceAccount](../modules/lib_k8s_serviceAccount.md).KubeServiceAccount @@ -24,7 +22,7 @@ slug: "lib_k8s_serviceAccount.KubeServiceAccount" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,4 +69,4 @@ ___ #### Defined in -[lib/k8s/serviceAccount.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/serviceAccount.ts#L5) +[lib/k8s/serviceAccount.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/serviceAccount.ts#L5) diff --git a/docs/development/api/interfaces/lib_k8s_statefulSet.KubeStatefulSet.md b/docs/development/api/interfaces/lib_k8s_statefulSet.KubeStatefulSet.md index ac83d62fe2..d14ba4eb57 100644 --- a/docs/development/api/interfaces/lib_k8s_statefulSet.KubeStatefulSet.md +++ b/docs/development/api/interfaces/lib_k8s_statefulSet.KubeStatefulSet.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeStatefulSet" -linkTitle: "KubeStatefulSet" -slug: "lib_k8s_statefulSet.KubeStatefulSet" ---- +[API](../API.md) / [lib/k8s/statefulSet](../modules/lib_k8s_statefulSet.md) / KubeStatefulSet + +# Interface: KubeStatefulSet [lib/k8s/statefulSet](../modules/lib_k8s_statefulSet.md).KubeStatefulSet @@ -24,7 +22,7 @@ slug: "lib_k8s_statefulSet.KubeStatefulSet" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -88,7 +86,7 @@ ___ #### Defined in -[lib/k8s/statefulSet.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/statefulSet.ts#L12) +[lib/k8s/statefulSet.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/statefulSet.ts#L12) ___ @@ -102,4 +100,4 @@ ___ #### Defined in -[lib/k8s/statefulSet.ts:26](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/statefulSet.ts#L26) +[lib/k8s/statefulSet.ts:26](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/statefulSet.ts#L26) diff --git a/docs/development/api/interfaces/lib_k8s_storageClass.KubeStorageClass.md b/docs/development/api/interfaces/lib_k8s_storageClass.KubeStorageClass.md index bb2061b31f..bc6366d962 100644 --- a/docs/development/api/interfaces/lib_k8s_storageClass.KubeStorageClass.md +++ b/docs/development/api/interfaces/lib_k8s_storageClass.KubeStorageClass.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeStorageClass" -linkTitle: "KubeStorageClass" -slug: "lib_k8s_storageClass.KubeStorageClass" ---- +[API](../API.md) / [lib/k8s/storageClass](../modules/lib_k8s_storageClass.md) / KubeStorageClass + +# Interface: KubeStorageClass [lib/k8s/storageClass](../modules/lib_k8s_storageClass.md).KubeStorageClass @@ -24,7 +22,7 @@ slug: "lib_k8s_storageClass.KubeStorageClass" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,7 +69,7 @@ ___ #### Defined in -[lib/k8s/storageClass.ts:5](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L5) +[lib/k8s/storageClass.ts:5](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L5) ___ @@ -81,7 +79,7 @@ ___ #### Defined in -[lib/k8s/storageClass.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L6) +[lib/k8s/storageClass.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L6) ___ @@ -91,4 +89,4 @@ ___ #### Defined in -[lib/k8s/storageClass.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/storageClass.ts#L7) +[lib/k8s/storageClass.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/storageClass.ts#L7) diff --git a/docs/development/api/interfaces/lib_k8s_token.KubeToken.md b/docs/development/api/interfaces/lib_k8s_token.KubeToken.md index 9e2f939707..b5fbd1eef1 100644 --- a/docs/development/api/interfaces/lib_k8s_token.KubeToken.md +++ b/docs/development/api/interfaces/lib_k8s_token.KubeToken.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeToken" -linkTitle: "KubeToken" -slug: "lib_k8s_token.KubeToken" ---- +[API](../API.md) / [lib/k8s/token](../modules/lib_k8s_token.md) / KubeToken + +# Interface: KubeToken [lib/k8s/token](../modules/lib_k8s_token.md).KubeToken @@ -24,7 +22,7 @@ slug: "lib_k8s_token.KubeToken" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -78,7 +76,7 @@ ___ #### Defined in -[lib/k8s/token.ts:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/token.ts#L8) +[lib/k8s/token.ts:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/token.ts#L8) ___ @@ -95,4 +93,4 @@ ___ #### Defined in -[lib/k8s/token.ts:4](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/token.ts#L4) +[lib/k8s/token.ts:4](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/token.ts#L4) diff --git a/docs/development/api/interfaces/lib_k8s_validatingWebhookConfiguration.KubeValidatingWebhookConfiguration.md b/docs/development/api/interfaces/lib_k8s_validatingWebhookConfiguration.KubeValidatingWebhookConfiguration.md index 7a690dc000..7265310ddb 100644 --- a/docs/development/api/interfaces/lib_k8s_validatingWebhookConfiguration.KubeValidatingWebhookConfiguration.md +++ b/docs/development/api/interfaces/lib_k8s_validatingWebhookConfiguration.KubeValidatingWebhookConfiguration.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeValidatingWebhookConfiguration" -linkTitle: "KubeValidatingWebhookConfiguration" -slug: "lib_k8s_validatingWebhookConfiguration.KubeValidatingWebhookConfiguration" ---- +[API](../API.md) / [lib/k8s/validatingWebhookConfiguration](../modules/lib_k8s_validatingWebhookConfiguration.md) / KubeValidatingWebhookConfiguration + +# Interface: KubeValidatingWebhookConfiguration [lib/k8s/validatingWebhookConfiguration](../modules/lib_k8s_validatingWebhookConfiguration.md).KubeValidatingWebhookConfiguration @@ -24,7 +22,7 @@ slug: "lib_k8s_validatingWebhookConfiguration.KubeValidatingWebhookConfiguration #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,4 +69,4 @@ ___ #### Defined in -[lib/k8s/validatingWebhookConfiguration.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/validatingWebhookConfiguration.ts#L6) +[lib/k8s/validatingWebhookConfiguration.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/validatingWebhookConfiguration.ts#L6) diff --git a/docs/development/api/interfaces/lib_k8s_vpa.KubeVPA.md b/docs/development/api/interfaces/lib_k8s_vpa.KubeVPA.md index 4353ae0eb1..25f0f036ec 100644 --- a/docs/development/api/interfaces/lib_k8s_vpa.KubeVPA.md +++ b/docs/development/api/interfaces/lib_k8s_vpa.KubeVPA.md @@ -1,8 +1,6 @@ ---- -title: "Interface: KubeVPA" -linkTitle: "KubeVPA" -slug: "lib_k8s_vpa.KubeVPA" ---- +[API](../API.md) / [lib/k8s/vpa](../modules/lib_k8s_vpa.md) / KubeVPA + +# Interface: KubeVPA [lib/k8s/vpa](../modules/lib_k8s_vpa.md).KubeVPA @@ -24,7 +22,7 @@ slug: "lib_k8s_vpa.KubeVPA" #### Defined in -[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L55) +[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L56) ___ @@ -47,7 +45,7 @@ Cannot be updated. #### Defined in -[lib/k8s/cluster.ts:54](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L54) +[lib/k8s/cluster.ts:55](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L55) ___ @@ -61,7 +59,7 @@ ___ #### Defined in -[lib/k8s/cluster.ts:56](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/cluster.ts#L56) +[lib/k8s/cluster.ts:57](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/cluster.ts#L57) ___ @@ -71,7 +69,7 @@ ___ #### Defined in -[lib/k8s/vpa.ts:75](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/vpa.ts#L75) +[lib/k8s/vpa.ts:75](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/vpa.ts#L75) ___ @@ -81,4 +79,4 @@ ___ #### Defined in -[lib/k8s/vpa.ts:76](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/vpa.ts#L76) +[lib/k8s/vpa.ts:76](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/vpa.ts#L76) diff --git a/docs/development/api/interfaces/lib_router.Route.md b/docs/development/api/interfaces/lib_router.Route.md index c9b4e297e2..80d352238d 100644 --- a/docs/development/api/interfaces/lib_router.Route.md +++ b/docs/development/api/interfaces/lib_router.Route.md @@ -1,8 +1,6 @@ ---- -title: "Interface: Route" -linkTitle: "Route" -slug: "lib_router.Route" ---- +[API](../API.md) / [lib/router](../modules/lib_router.md) / Route + +# Interface: Route [lib/router](../modules/lib_router.md).Route @@ -16,7 +14,7 @@ Whether the route should be disabled (not registered). #### Defined in -[lib/router.tsx:118](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L118) +[lib/router.tsx:118](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L118) ___ @@ -28,7 +26,7 @@ When true, will only match if the path matches the location.pathname exactly. #### Defined in -[lib/router.tsx:97](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L97) +[lib/router.tsx:97](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L97) ___ @@ -40,7 +38,7 @@ Hide the appbar at the top. #### Defined in -[lib/router.tsx:116](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L116) +[lib/router.tsx:116](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L116) ___ @@ -52,7 +50,7 @@ Human readable name. Capitalized and short. #### Defined in -[lib/router.tsx:99](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L99) +[lib/router.tsx:99](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L99) ___ @@ -64,7 +62,7 @@ This route does not require Authentication. #### Defined in -[lib/router.tsx:110](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L110) +[lib/router.tsx:110](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L110) ___ @@ -78,7 +76,7 @@ In case this route does *not* need a cluster prefix and context. #### Defined in -[lib/router.tsx:104](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L104) +[lib/router.tsx:104](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L104) ___ @@ -90,7 +88,7 @@ Any valid URL path or array of paths that path-to-regexp@^1.7.0 understands. #### Defined in -[lib/router.tsx:95](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L95) +[lib/router.tsx:95](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L95) ___ @@ -102,7 +100,7 @@ The sidebar entry this Route should enable, or null if it shouldn't enable any. #### Defined in -[lib/router.tsx:112](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L112) +[lib/router.tsx:112](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L112) ___ @@ -114,7 +112,7 @@ Should URL have the cluster prefix? (default=true) #### Defined in -[lib/router.tsx:108](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L108) +[lib/router.tsx:108](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L108) ## Methods @@ -130,4 +128,4 @@ Shown component for this route. #### Defined in -[lib/router.tsx:114](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L114) +[lib/router.tsx:114](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L114) diff --git a/docs/development/api/interfaces/lib_router.RouteURLProps.md b/docs/development/api/interfaces/lib_router.RouteURLProps.md index 66c086c42e..8f99b43a10 100644 --- a/docs/development/api/interfaces/lib_router.RouteURLProps.md +++ b/docs/development/api/interfaces/lib_router.RouteURLProps.md @@ -1,8 +1,6 @@ ---- -title: "Interface: RouteURLProps" -linkTitle: "RouteURLProps" -slug: "lib_router.RouteURLProps" ---- +[API](../API.md) / [lib/router](../modules/lib_router.md) / RouteURLProps + +# Interface: RouteURLProps [lib/router](../modules/lib_router.md).RouteURLProps @@ -18,4 +16,4 @@ slug: "lib_router.RouteURLProps" #### Defined in -[lib/router.tsx:815](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L815) +[lib/router.tsx:815](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L815) diff --git a/docs/development/api/interfaces/lib_util.TimeAgoOptions.md b/docs/development/api/interfaces/lib_util.TimeAgoOptions.md index 076f3a1e3e..27722da551 100644 --- a/docs/development/api/interfaces/lib_util.TimeAgoOptions.md +++ b/docs/development/api/interfaces/lib_util.TimeAgoOptions.md @@ -1,8 +1,6 @@ ---- -title: "Interface: TimeAgoOptions" -linkTitle: "TimeAgoOptions" -slug: "lib_util.TimeAgoOptions" ---- +[API](../API.md) / [lib/util](../modules/lib_util.md) / TimeAgoOptions + +# Interface: TimeAgoOptions [lib/util](../modules/lib_util.md).TimeAgoOptions @@ -14,4 +12,4 @@ slug: "lib_util.TimeAgoOptions" #### Defined in -[lib/util.ts:36](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L36) +[lib/util.ts:36](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L36) diff --git a/docs/development/api/interfaces/plugin_lib.AppMenu.md b/docs/development/api/interfaces/plugin_lib.AppMenu.md index 8abcd26b9d..94c1f027f4 100644 --- a/docs/development/api/interfaces/plugin_lib.AppMenu.md +++ b/docs/development/api/interfaces/plugin_lib.AppMenu.md @@ -1,8 +1,6 @@ ---- -title: "Interface: AppMenu" -linkTitle: "AppMenu" -slug: "plugin_lib.AppMenu" ---- +[API](../API.md) / [plugin/lib](../modules/plugin_lib.md) / AppMenu + +# Interface: AppMenu [plugin/lib](../modules/plugin_lib.md).AppMenu @@ -26,7 +24,7 @@ The submenus of this menu #### Defined in -[plugin/lib.ts:74](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L74) +[plugin/lib.ts:74](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L74) ___ @@ -38,4 +36,4 @@ A URL to open (if not starting with http, then it'll be opened in the external b #### Defined in -[plugin/lib.ts:72](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/lib.ts#L72) +[plugin/lib.ts:72](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/lib.ts#L72) diff --git a/docs/development/api/interfaces/plugin_registry.AppLogoProps.md b/docs/development/api/interfaces/plugin_registry.AppLogoProps.md index c32da87648..1aebfa8019 100644 --- a/docs/development/api/interfaces/plugin_registry.AppLogoProps.md +++ b/docs/development/api/interfaces/plugin_registry.AppLogoProps.md @@ -1,8 +1,6 @@ ---- -title: "Interface: AppLogoProps" -linkTitle: "AppLogoProps" -slug: "plugin_registry.AppLogoProps" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / AppLogoProps + +# Interface: AppLogoProps [plugin/registry](../modules/plugin_registry.md).AppLogoProps @@ -20,7 +18,7 @@ A class to use on your SVG. #### Defined in -[components/App/AppLogo.tsx:19](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/App/AppLogo.tsx#L19) +[components/App/AppLogo.tsx:19](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/AppLogo.tsx#L19) ___ @@ -32,7 +30,7 @@ The size of the logo. 'small' for in mobile view, and 'large' for tablet and des #### Defined in -[components/App/AppLogo.tsx:15](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/App/AppLogo.tsx#L15) +[components/App/AppLogo.tsx:15](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/AppLogo.tsx#L15) ___ @@ -44,7 +42,7 @@ SxProps to use on your SVG. #### Defined in -[components/App/AppLogo.tsx:21](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/App/AppLogo.tsx#L21) +[components/App/AppLogo.tsx:21](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/AppLogo.tsx#L21) ___ @@ -56,4 +54,4 @@ User selected theme. By default it checks which is is active. #### Defined in -[components/App/AppLogo.tsx:17](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/App/AppLogo.tsx#L17) +[components/App/AppLogo.tsx:17](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/AppLogo.tsx#L17) diff --git a/docs/development/api/interfaces/plugin_registry.ClusterChooserProps.md b/docs/development/api/interfaces/plugin_registry.ClusterChooserProps.md index 0443391d64..bb796135d7 100644 --- a/docs/development/api/interfaces/plugin_registry.ClusterChooserProps.md +++ b/docs/development/api/interfaces/plugin_registry.ClusterChooserProps.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ClusterChooserProps" -linkTitle: "ClusterChooserProps" -slug: "plugin_registry.ClusterChooserProps" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / ClusterChooserProps + +# Interface: ClusterChooserProps [plugin/registry](../modules/plugin_registry.md).ClusterChooserProps @@ -14,7 +12,7 @@ slug: "plugin_registry.ClusterChooserProps" #### Defined in -[components/cluster/ClusterChooser.tsx:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/cluster/ClusterChooser.tsx#L8) +[components/cluster/ClusterChooser.tsx:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/cluster/ClusterChooser.tsx#L8) ## Methods @@ -34,4 +32,4 @@ slug: "plugin_registry.ClusterChooserProps" #### Defined in -[components/cluster/ClusterChooser.tsx:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/cluster/ClusterChooser.tsx#L7) +[components/cluster/ClusterChooser.tsx:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/cluster/ClusterChooser.tsx#L7) diff --git a/docs/development/api/interfaces/plugin_registry.CreateResourceEvent.md b/docs/development/api/interfaces/plugin_registry.CreateResourceEvent.md index 006265cbfd..6837f8d4b0 100644 --- a/docs/development/api/interfaces/plugin_registry.CreateResourceEvent.md +++ b/docs/development/api/interfaces/plugin_registry.CreateResourceEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: CreateResourceEvent" -linkTitle: "CreateResourceEvent" -slug: "plugin_registry.CreateResourceEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / CreateResourceEvent + +# Interface: CreateResourceEvent [plugin/registry](../modules/plugin_registry.md).CreateResourceEvent @@ -22,7 +20,7 @@ Event fired when creating a resource. #### Defined in -[redux/headlampEventSlice.ts:193](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L193) +[redux/headlampEventSlice.ts:193](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L193) ___ @@ -32,4 +30,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:192](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L192) +[redux/headlampEventSlice.ts:192](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L192) diff --git a/docs/development/api/interfaces/plugin_registry.DeleteResourceEvent.md b/docs/development/api/interfaces/plugin_registry.DeleteResourceEvent.md index 015383a749..c62058ed20 100644 --- a/docs/development/api/interfaces/plugin_registry.DeleteResourceEvent.md +++ b/docs/development/api/interfaces/plugin_registry.DeleteResourceEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: DeleteResourceEvent" -linkTitle: "DeleteResourceEvent" -slug: "plugin_registry.DeleteResourceEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / DeleteResourceEvent + +# Interface: DeleteResourceEvent [plugin/registry](../modules/plugin_registry.md).DeleteResourceEvent @@ -33,7 +31,7 @@ Event fired when a resource is to be deleted. #### Defined in -[redux/headlampEventSlice.ts:85](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L85) +[redux/headlampEventSlice.ts:85](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L85) ___ @@ -47,4 +45,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:68](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L68) +[redux/headlampEventSlice.ts:68](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L68) diff --git a/docs/development/api/interfaces/plugin_registry.DetailsViewSectionProps.md b/docs/development/api/interfaces/plugin_registry.DetailsViewSectionProps.md index b773f615c4..7267664e6a 100644 --- a/docs/development/api/interfaces/plugin_registry.DetailsViewSectionProps.md +++ b/docs/development/api/interfaces/plugin_registry.DetailsViewSectionProps.md @@ -1,8 +1,6 @@ ---- -title: "Interface: DetailsViewSectionProps" -linkTitle: "DetailsViewSectionProps" -slug: "plugin_registry.DetailsViewSectionProps" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / DetailsViewSectionProps + +# Interface: DetailsViewSectionProps [plugin/registry](../modules/plugin_registry.md).DetailsViewSectionProps @@ -14,4 +12,4 @@ slug: "plugin_registry.DetailsViewSectionProps" #### Defined in -[components/DetailsViewSection/DetailsViewSection.tsx:8](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/DetailsViewSection.tsx#L8) +[components/DetailsViewSection/DetailsViewSection.tsx:8](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/DetailsViewSection.tsx#L8) diff --git a/docs/development/api/interfaces/plugin_registry.EditResourceEvent.md b/docs/development/api/interfaces/plugin_registry.EditResourceEvent.md index 9239fa4cf5..18faacef63 100644 --- a/docs/development/api/interfaces/plugin_registry.EditResourceEvent.md +++ b/docs/development/api/interfaces/plugin_registry.EditResourceEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: EditResourceEvent" -linkTitle: "EditResourceEvent" -slug: "plugin_registry.EditResourceEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / EditResourceEvent + +# Interface: EditResourceEvent [plugin/registry](../modules/plugin_registry.md).EditResourceEvent @@ -23,7 +21,7 @@ Event fired when editing a resource. #### Defined in -[redux/headlampEventSlice.ts:100](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L100) +[redux/headlampEventSlice.ts:100](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L100) ___ @@ -33,4 +31,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:99](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L99) +[redux/headlampEventSlice.ts:99](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L99) diff --git a/docs/development/api/interfaces/plugin_registry.ErrorBoundaryEvent.md b/docs/development/api/interfaces/plugin_registry.ErrorBoundaryEvent.md index 5a7a484cd9..eff3059746 100644 --- a/docs/development/api/interfaces/plugin_registry.ErrorBoundaryEvent.md +++ b/docs/development/api/interfaces/plugin_registry.ErrorBoundaryEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ErrorBoundaryEvent" -linkTitle: "ErrorBoundaryEvent" -slug: "plugin_registry.ErrorBoundaryEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / ErrorBoundaryEvent + +# Interface: ErrorBoundaryEvent [plugin/registry](../modules/plugin_registry.md).ErrorBoundaryEvent @@ -18,7 +16,7 @@ The error that was thrown. #### Defined in -[redux/headlampEventSlice.ts:78](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L78) +[redux/headlampEventSlice.ts:78](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L78) ___ @@ -28,4 +26,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:76](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L76) +[redux/headlampEventSlice.ts:76](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L76) diff --git a/docs/development/api/interfaces/plugin_registry.EventListEvent.md b/docs/development/api/interfaces/plugin_registry.EventListEvent.md index 05e7623b1f..91e5baccdd 100644 --- a/docs/development/api/interfaces/plugin_registry.EventListEvent.md +++ b/docs/development/api/interfaces/plugin_registry.EventListEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: EventListEvent" -linkTitle: "EventListEvent" -slug: "plugin_registry.EventListEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / EventListEvent + +# Interface: EventListEvent [plugin/registry](../modules/plugin_registry.md).EventListEvent @@ -23,7 +21,7 @@ Event fired when kubernetes events are loaded (for a resource or not). #### Defined in -[redux/headlampEventSlice.ts:270](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L270) +[redux/headlampEventSlice.ts:270](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L270) ___ @@ -33,4 +31,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:269](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L269) +[redux/headlampEventSlice.ts:269](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L269) diff --git a/docs/development/api/interfaces/plugin_registry.HeadlampEvent.md b/docs/development/api/interfaces/plugin_registry.HeadlampEvent.md index 33135c0da1..0fa05e8c30 100644 --- a/docs/development/api/interfaces/plugin_registry.HeadlampEvent.md +++ b/docs/development/api/interfaces/plugin_registry.HeadlampEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: HeadlampEvent" -linkTitle: "HeadlampEvent" -slug: "plugin_registry.HeadlampEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / HeadlampEvent + +# Interface: HeadlampEvent [plugin/registry](../modules/plugin_registry.md).HeadlampEvent @@ -28,7 +26,7 @@ Represents a Headlamp event. It can be one of the default events or a custom eve #### Defined in -[redux/headlampEventSlice.ts:69](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L69) +[redux/headlampEventSlice.ts:69](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L69) ___ @@ -38,4 +36,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:68](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L68) +[redux/headlampEventSlice.ts:68](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L68) diff --git a/docs/development/api/interfaces/plugin_registry.LogsEvent.md b/docs/development/api/interfaces/plugin_registry.LogsEvent.md index 88e1ea0b54..b745228569 100644 --- a/docs/development/api/interfaces/plugin_registry.LogsEvent.md +++ b/docs/development/api/interfaces/plugin_registry.LogsEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: LogsEvent" -linkTitle: "LogsEvent" -slug: "plugin_registry.LogsEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / LogsEvent + +# Interface: LogsEvent [plugin/registry](../modules/plugin_registry.md).LogsEvent @@ -23,7 +21,7 @@ Event fired when viewing pod logs. #### Defined in -[redux/headlampEventSlice.ts:145](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L145) +[redux/headlampEventSlice.ts:145](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L145) ___ @@ -33,4 +31,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:144](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L144) +[redux/headlampEventSlice.ts:144](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L144) diff --git a/docs/development/api/interfaces/plugin_registry.PluginLoadingErrorEvent.md b/docs/development/api/interfaces/plugin_registry.PluginLoadingErrorEvent.md index 437dc7f349..9298bdf116 100644 --- a/docs/development/api/interfaces/plugin_registry.PluginLoadingErrorEvent.md +++ b/docs/development/api/interfaces/plugin_registry.PluginLoadingErrorEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: PluginLoadingErrorEvent" -linkTitle: "PluginLoadingErrorEvent" -slug: "plugin_registry.PluginLoadingErrorEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / PluginLoadingErrorEvent + +# Interface: PluginLoadingErrorEvent [plugin/registry](../modules/plugin_registry.md).PluginLoadingErrorEvent @@ -25,7 +23,7 @@ Event fired when there is an error while loading a plugin. #### Defined in -[redux/headlampEventSlice.ts:206](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L206) +[redux/headlampEventSlice.ts:206](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L206) ___ @@ -35,4 +33,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:205](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L205) +[redux/headlampEventSlice.ts:205](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L205) diff --git a/docs/development/api/interfaces/plugin_registry.PluginSettingsDetailsProps.md b/docs/development/api/interfaces/plugin_registry.PluginSettingsDetailsProps.md index 503b3f00f0..069ba59fb9 100644 --- a/docs/development/api/interfaces/plugin_registry.PluginSettingsDetailsProps.md +++ b/docs/development/api/interfaces/plugin_registry.PluginSettingsDetailsProps.md @@ -1,8 +1,6 @@ ---- -title: "Interface: PluginSettingsDetailsProps" -linkTitle: "PluginSettingsDetailsProps" -slug: "plugin_registry.PluginSettingsDetailsProps" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / PluginSettingsDetailsProps + +# Interface: PluginSettingsDetailsProps [plugin/registry](../modules/plugin_registry.md).PluginSettingsDetailsProps @@ -23,7 +21,7 @@ readonly - The data object is readonly and cannot be modified. #### Defined in -[plugin/pluginsSlice.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/pluginsSlice.ts#L18) +[plugin/pluginsSlice.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/pluginsSlice.ts#L18) ## Methods @@ -45,4 +43,4 @@ Callback function to be triggered when there's a change in data. #### Defined in -[plugin/pluginsSlice.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/pluginsSlice.ts#L12) +[plugin/pluginsSlice.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/pluginsSlice.ts#L12) diff --git a/docs/development/api/interfaces/plugin_registry.PluginsLoadedEvent.md b/docs/development/api/interfaces/plugin_registry.PluginsLoadedEvent.md index 72eb47c962..2d95c43c9f 100644 --- a/docs/development/api/interfaces/plugin_registry.PluginsLoadedEvent.md +++ b/docs/development/api/interfaces/plugin_registry.PluginsLoadedEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: PluginsLoadedEvent" -linkTitle: "PluginsLoadedEvent" -slug: "plugin_registry.PluginsLoadedEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / PluginsLoadedEvent + +# Interface: PluginsLoadedEvent [plugin/registry](../modules/plugin_registry.md).PluginsLoadedEvent @@ -22,7 +20,7 @@ Event fired when all plugins are loaded. #### Defined in -[redux/headlampEventSlice.ts:224](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L224) +[redux/headlampEventSlice.ts:224](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L224) ___ @@ -32,4 +30,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:223](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L223) +[redux/headlampEventSlice.ts:223](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L223) diff --git a/docs/development/api/interfaces/plugin_registry.PodAttachEvent.md b/docs/development/api/interfaces/plugin_registry.PodAttachEvent.md index fe97396d0e..6589223ffd 100644 --- a/docs/development/api/interfaces/plugin_registry.PodAttachEvent.md +++ b/docs/development/api/interfaces/plugin_registry.PodAttachEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: PodAttachEvent" -linkTitle: "PodAttachEvent" -slug: "plugin_registry.PodAttachEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / PodAttachEvent + +# Interface: PodAttachEvent [plugin/registry](../modules/plugin_registry.md).PodAttachEvent @@ -23,7 +21,7 @@ Event fired when attaching to a pod. #### Defined in -[redux/headlampEventSlice.ts:178](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L178) +[redux/headlampEventSlice.ts:178](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L178) ___ @@ -33,4 +31,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:177](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L177) +[redux/headlampEventSlice.ts:177](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L177) diff --git a/docs/development/api/interfaces/plugin_registry.ResourceDetailsViewLoadedEvent.md b/docs/development/api/interfaces/plugin_registry.ResourceDetailsViewLoadedEvent.md index 22cac46c7a..27b33662e8 100644 --- a/docs/development/api/interfaces/plugin_registry.ResourceDetailsViewLoadedEvent.md +++ b/docs/development/api/interfaces/plugin_registry.ResourceDetailsViewLoadedEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ResourceDetailsViewLoadedEvent" -linkTitle: "ResourceDetailsViewLoadedEvent" -slug: "plugin_registry.ResourceDetailsViewLoadedEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / ResourceDetailsViewLoadedEvent + +# Interface: ResourceDetailsViewLoadedEvent [plugin/registry](../modules/plugin_registry.md).ResourceDetailsViewLoadedEvent @@ -23,7 +21,7 @@ Event fired when a resource is loaded in the details view. #### Defined in -[redux/headlampEventSlice.ts:242](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L242) +[redux/headlampEventSlice.ts:242](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L242) ___ @@ -33,4 +31,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:241](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L241) +[redux/headlampEventSlice.ts:241](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L241) diff --git a/docs/development/api/interfaces/plugin_registry.ResourceListViewLoadedEvent.md b/docs/development/api/interfaces/plugin_registry.ResourceListViewLoadedEvent.md index 400964ed13..2c768cc9a8 100644 --- a/docs/development/api/interfaces/plugin_registry.ResourceListViewLoadedEvent.md +++ b/docs/development/api/interfaces/plugin_registry.ResourceListViewLoadedEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ResourceListViewLoadedEvent" -linkTitle: "ResourceListViewLoadedEvent" -slug: "plugin_registry.ResourceListViewLoadedEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / ResourceListViewLoadedEvent + +# Interface: ResourceListViewLoadedEvent [plugin/registry](../modules/plugin_registry.md).ResourceListViewLoadedEvent @@ -24,7 +22,7 @@ Event fired when a list view is loaded for a resource. #### Defined in -[redux/headlampEventSlice.ts:255](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L255) +[redux/headlampEventSlice.ts:255](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L255) ___ @@ -34,4 +32,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:254](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L254) +[redux/headlampEventSlice.ts:254](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L254) diff --git a/docs/development/api/interfaces/plugin_registry.RestartResourceEvent.md b/docs/development/api/interfaces/plugin_registry.RestartResourceEvent.md index 20677a7ff3..eeccead362 100644 --- a/docs/development/api/interfaces/plugin_registry.RestartResourceEvent.md +++ b/docs/development/api/interfaces/plugin_registry.RestartResourceEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: RestartResourceEvent" -linkTitle: "RestartResourceEvent" -slug: "plugin_registry.RestartResourceEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / RestartResourceEvent + +# Interface: RestartResourceEvent [plugin/registry](../modules/plugin_registry.md).RestartResourceEvent @@ -23,7 +21,7 @@ Event fired when restarting a resource. #### Defined in -[redux/headlampEventSlice.ts:130](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L130) +[redux/headlampEventSlice.ts:130](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L130) ___ @@ -33,4 +31,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:129](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L129) +[redux/headlampEventSlice.ts:129](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L129) diff --git a/docs/development/api/interfaces/plugin_registry.ScaleResourceEvent.md b/docs/development/api/interfaces/plugin_registry.ScaleResourceEvent.md index cf2cd14c6b..f49de7303c 100644 --- a/docs/development/api/interfaces/plugin_registry.ScaleResourceEvent.md +++ b/docs/development/api/interfaces/plugin_registry.ScaleResourceEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: ScaleResourceEvent" -linkTitle: "ScaleResourceEvent" -slug: "plugin_registry.ScaleResourceEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / ScaleResourceEvent + +# Interface: ScaleResourceEvent [plugin/registry](../modules/plugin_registry.md).ScaleResourceEvent @@ -23,7 +21,7 @@ Event fired when scaling a resource. #### Defined in -[redux/headlampEventSlice.ts:115](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L115) +[redux/headlampEventSlice.ts:115](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L115) ___ @@ -33,4 +31,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:114](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L114) +[redux/headlampEventSlice.ts:114](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L114) diff --git a/docs/development/api/interfaces/plugin_registry.SectionFuncProps.md b/docs/development/api/interfaces/plugin_registry.SectionFuncProps.md index b762ccb6a3..bd22846007 100644 --- a/docs/development/api/interfaces/plugin_registry.SectionFuncProps.md +++ b/docs/development/api/interfaces/plugin_registry.SectionFuncProps.md @@ -1,8 +1,6 @@ ---- -title: "Interface: SectionFuncProps" -linkTitle: "SectionFuncProps" -slug: "plugin_registry.SectionFuncProps" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / SectionFuncProps + +# Interface: SectionFuncProps [plugin/registry](../modules/plugin_registry.md).SectionFuncProps @@ -14,7 +12,7 @@ slug: "plugin_registry.SectionFuncProps" #### Defined in -[plugin/registry.tsx:68](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L68) +[plugin/registry.tsx:69](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L69) ## Methods @@ -35,4 +33,4 @@ slug: "plugin_registry.SectionFuncProps" #### Defined in -[plugin/registry.tsx:69](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L69) +[plugin/registry.tsx:70](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L70) diff --git a/docs/development/api/interfaces/plugin_registry.SidebarEntryProps.md b/docs/development/api/interfaces/plugin_registry.SidebarEntryProps.md index a91aac4301..cdf4b35e51 100644 --- a/docs/development/api/interfaces/plugin_registry.SidebarEntryProps.md +++ b/docs/development/api/interfaces/plugin_registry.SidebarEntryProps.md @@ -1,8 +1,6 @@ ---- -title: "Interface: SidebarEntryProps" -linkTitle: "SidebarEntryProps" -slug: "plugin_registry.SidebarEntryProps" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / SidebarEntryProps + +# Interface: SidebarEntryProps [plugin/registry](../modules/plugin_registry.md).SidebarEntryProps @@ -20,7 +18,7 @@ An iconify string or icon object that will be used for the sidebar's icon #### Defined in -[components/Sidebar/sidebarSlice.ts:43](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L43) +[components/Sidebar/sidebarSlice.ts:43](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L43) ___ @@ -32,7 +30,7 @@ Label to display. #### Defined in -[components/Sidebar/sidebarSlice.ts:25](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L25) +[components/Sidebar/sidebarSlice.ts:25](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L25) ___ @@ -44,7 +42,7 @@ Name of this SidebarItem. #### Defined in -[components/Sidebar/sidebarSlice.ts:17](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L17) +[components/Sidebar/sidebarSlice.ts:17](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L17) ___ @@ -56,7 +54,7 @@ Name of the parent SidebarEntry. #### Defined in -[components/Sidebar/sidebarSlice.ts:29](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L29) +[components/Sidebar/sidebarSlice.ts:29](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L29) ___ @@ -68,7 +66,7 @@ The sidebar to display this item in. If not specified, it will be displayed in t #### Defined in -[components/Sidebar/sidebarSlice.ts:46](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L46) +[components/Sidebar/sidebarSlice.ts:46](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L46) ___ @@ -80,7 +78,7 @@ Text to display under the name. #### Defined in -[components/Sidebar/sidebarSlice.ts:21](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L21) +[components/Sidebar/sidebarSlice.ts:21](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L21) ___ @@ -92,7 +90,7 @@ URL to go to when this item is followed. #### Defined in -[components/Sidebar/sidebarSlice.ts:33](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L33) +[components/Sidebar/sidebarSlice.ts:33](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L33) ___ @@ -104,4 +102,4 @@ Should URL have the cluster prefix? (default=true) #### Defined in -[components/Sidebar/sidebarSlice.ts:37](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/Sidebar/sidebarSlice.ts#L37) +[components/Sidebar/sidebarSlice.ts:37](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/Sidebar/sidebarSlice.ts#L37) diff --git a/docs/development/api/interfaces/plugin_registry.TerminalEvent.md b/docs/development/api/interfaces/plugin_registry.TerminalEvent.md index 977c8194dc..1e7568738d 100644 --- a/docs/development/api/interfaces/plugin_registry.TerminalEvent.md +++ b/docs/development/api/interfaces/plugin_registry.TerminalEvent.md @@ -1,8 +1,6 @@ ---- -title: "Interface: TerminalEvent" -linkTitle: "TerminalEvent" -slug: "plugin_registry.TerminalEvent" ---- +[API](../API.md) / [plugin/registry](../modules/plugin_registry.md) / TerminalEvent + +# Interface: TerminalEvent [plugin/registry](../modules/plugin_registry.md).TerminalEvent @@ -23,7 +21,7 @@ Event fired when using the terminal. #### Defined in -[redux/headlampEventSlice.ts:163](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L163) +[redux/headlampEventSlice.ts:163](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L163) ___ @@ -33,4 +31,4 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:162](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L162) +[redux/headlampEventSlice.ts:162](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L162) diff --git a/docs/development/api/modules/_index.md b/docs/development/api/modules/_index.md deleted file mode 100644 index 4e67df57dc..0000000000 --- a/docs/development/api/modules/_index.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: "Namespaces" ---- \ No newline at end of file diff --git a/docs/development/api/modules/lib_k8s.md b/docs/development/api/modules/lib_k8s.md index 8258f5ff2c..dde57e9828 100644 --- a/docs/development/api/modules/lib_k8s.md +++ b/docs/development/api/modules/lib_k8s.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s" -linkTitle: "lib/k8s" -slug: "lib_k8s" ---- +[API](../API.md) / lib/k8s + +# Module: lib/k8s ## References @@ -162,7 +160,7 @@ Renames and re-exports [lib/k8s/storageClass](lib_k8s_storageClass.md) #### Defined in -[lib/k8s/index.ts:144](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L144) +[lib/k8s/index.ts:144](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L144) ## Variables @@ -176,7 +174,7 @@ Renames and re-exports [lib/k8s/storageClass](lib_k8s_storageClass.md) #### Defined in -[lib/k8s/index.ts:88](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L88) +[lib/k8s/index.ts:88](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L88) ## Functions @@ -196,7 +194,7 @@ Renames and re-exports [lib/k8s/storageClass](lib_k8s_storageClass.md) #### Defined in -[lib/k8s/index.ts:140](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L140) +[lib/k8s/index.ts:140](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L140) ___ @@ -221,7 +219,7 @@ See [Label selector examples](https://kubernetes.io/docs/concepts/overview/worki #### Defined in -[lib/k8s/index.ts:174](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L174) +[lib/k8s/index.ts:174](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L174) ___ @@ -241,7 +239,7 @@ ___ #### Defined in -[lib/k8s/index.ts:209](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L209) +[lib/k8s/index.ts:209](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L209) ___ @@ -262,7 +260,7 @@ ___ #### Defined in -[lib/k8s/index.ts:189](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L189) +[lib/k8s/index.ts:189](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L189) ___ @@ -276,7 +274,7 @@ ___ #### Defined in -[lib/k8s/index.ts:112](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L112) +[lib/k8s/index.ts:112](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L112) ___ @@ -298,7 +296,7 @@ the clusters configuration. #### Defined in -[lib/k8s/index.ts:97](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L97) +[lib/k8s/index.ts:97](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L97) ___ @@ -322,7 +320,7 @@ a map with cluster -> version-info, and a map with cluster -> error. #### Defined in -[lib/k8s/index.ts:286](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L286) +[lib/k8s/index.ts:286](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L286) ___ @@ -342,4 +340,4 @@ ___ #### Defined in -[lib/k8s/index.ts:146](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/index.ts#L146) +[lib/k8s/index.ts:146](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/index.ts#L146) diff --git a/docs/development/api/modules/lib_k8s_apiProxy.md b/docs/development/api/modules/lib_k8s_apiProxy.md index 565435c762..951ec4944e 100644 --- a/docs/development/api/modules/lib_k8s_apiProxy.md +++ b/docs/development/api/modules/lib_k8s_apiProxy.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/apiProxy" -linkTitle: "lib/k8s/apiProxy" -slug: "lib_k8s_apiProxy" ---- +[API](../API.md) / lib/k8s/apiProxy + +# Module: lib/k8s/apiProxy ## Interfaces @@ -40,7 +38,7 @@ The callback that's called when there's an error streaming the results. #### Defined in -[lib/k8s/apiProxy.ts:457](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L457) +[lib/k8s/apiProxy.ts:466](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L466) ___ @@ -66,7 +64,7 @@ The callback that's called when some results are streamed in. #### Defined in -[lib/k8s/apiProxy.ts:455](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L455) +[lib/k8s/apiProxy.ts:464](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L464) ## Functions @@ -96,12 +94,12 @@ An API client for the specified Kubernetes resource(s). | `isNamespaced` | `boolean` | | `list` | (`cb`: [`StreamResultsCb`](lib_k8s_apiProxy.md#streamresultscb), `errCb`: [`StreamErrCb`](lib_k8s_apiProxy.md#streamerrcb), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<() => `void`\> | | `patch` | (`body`: `OpPatch`[], `name`: `string`, `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | -| `post` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | +| `post` | (`body`: `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | | `put` | (`body`: [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md), `queryParams?`: [`QueryParameters`](../interfaces/lib_k8s_apiProxy.QueryParameters.md), `cluster?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/apiProxy.ts:571](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L571) +[lib/k8s/apiProxy.ts:580](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L580) ___ @@ -121,13 +119,14 @@ ___ | Name | Type | | :------ | :------ | -| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | +| `scale?` | { `get`: (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> ; `patch`: (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> ; `put`: (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> } | | `scale.get` | (`namespace`: `string`, `name`: `string`, `clusterName?`: `string`) => `Promise`<`any`\> | +| `scale.patch` | (`body`: { `spec`: { `replicas`: `number` } }, `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md), `clusterName?`: `string`) => `Promise`<`any`\> | | `scale.put` | (`body`: { `metadata`: [`KubeMetadata`](../interfaces/lib_k8s_cluster.KubeMetadata.md) ; `spec`: { `replicas`: `number` } }, `clusterName?`: `string`) => `Promise`<`any`\> | #### Defined in -[lib/k8s/apiProxy.ts:700](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L700) +[lib/k8s/apiProxy.ts:712](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L712) ___ @@ -154,7 +153,7 @@ The response from the kubernetes API server. #### Defined in -[lib/k8s/apiProxy.ts:1521](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1521) +[lib/k8s/apiProxy.ts:1545](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1545) ___ @@ -183,7 +182,7 @@ A Promise that resolves to the JSON response from the API server. #### Defined in -[lib/k8s/apiProxy.ts:339](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L339) +[lib/k8s/apiProxy.ts:348](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L348) ___ @@ -203,7 +202,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1673](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1673) +[lib/k8s/apiProxy.ts:1687](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1687) ___ @@ -240,7 +239,7 @@ deletePlugin('examplePlugin') #### Defined in -[lib/k8s/apiProxy.ts:1925](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1925) +[lib/k8s/apiProxy.ts:2010](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L2010) ___ @@ -272,7 +271,7 @@ to get the status of the drain node process. #### Defined in -[lib/k8s/apiProxy.ts:1810](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1810) +[lib/k8s/apiProxy.ts:1883](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1883) ___ @@ -305,7 +304,7 @@ the status of the drain node process. #### Defined in -[lib/k8s/apiProxy.ts:1852](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1852) +[lib/k8s/apiProxy.ts:1931](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1931) ___ @@ -329,7 +328,7 @@ the list of port forwards for the cluster. #### Defined in -[lib/k8s/apiProxy.ts:1787](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1787) +[lib/k8s/apiProxy.ts:1860](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1860) ___ @@ -356,7 +355,30 @@ A function to cancel the metrics request. #### Defined in -[lib/k8s/apiProxy.ts:1583](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1583) +[lib/k8s/apiProxy.ts:1607](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1607) + +___ + +### parseKubeConfig + +▸ **parseKubeConfig**(`clusterReq`): `Promise`<`any`\> + +parseKubeConfig sends call to backend to parse kubeconfig and send back +the parsed clusters and contexts. + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `clusterReq` | [`ClusterRequest`](../interfaces/lib_k8s_apiProxy.ClusterRequest.md) | The cluster request object. | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[lib/k8s/apiProxy.ts:1735](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1735) ___ @@ -379,7 +401,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:976](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L976) +[lib/k8s/apiProxy.ts:1000](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1000) ___ @@ -392,7 +414,7 @@ ___ | Name | Type | Default value | | :------ | :------ | :------ | | `url` | `string` | `undefined` | -| `json` | `object` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md) \| `JSON` | `undefined` | +| `json` | `object` \| `JSON` \| [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md) | `undefined` | | `autoLogoutOnAuthError` | `boolean` | `true` | | `options` | [`ClusterRequestParams`](../interfaces/lib_k8s_apiProxy.ClusterRequestParams.md) | `{}` | @@ -402,7 +424,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:957](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L957) +[lib/k8s/apiProxy.ts:981](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L981) ___ @@ -425,7 +447,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:996](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L996) +[lib/k8s/apiProxy.ts:1020](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1020) ___ @@ -446,7 +468,32 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1015](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1015) +[lib/k8s/apiProxy.ts:1039](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1039) + +___ + +### renameCluster + +▸ **renameCluster**(`cluster`, `newClusterName`, `source`): `Promise`<`any`\> + +renameCluster sends call to backend to update a field in kubeconfig which +is the custom name of the cluster used by the user. + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `cluster` | `string` | +| `newClusterName` | `string` | +| `source` | `string` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[lib/k8s/apiProxy.ts:1709](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1709) ___ @@ -477,7 +524,7 @@ A Promise that resolves to the JSON response from the API server. #### Defined in -[lib/k8s/apiProxy.ts:303](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L303) +[lib/k8s/apiProxy.ts:312](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L312) ___ @@ -497,7 +544,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1635](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1635) +[lib/k8s/apiProxy.ts:1659](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1659) ___ @@ -531,7 +578,7 @@ The response from the API. #### Defined in -[lib/k8s/apiProxy.ts:1710](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1710) +[lib/k8s/apiProxy.ts:1777](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1777) ___ @@ -559,7 +606,7 @@ The response from the API. #### Defined in -[lib/k8s/apiProxy.ts:1760](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1760) +[lib/k8s/apiProxy.ts:1833](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1833) ___ @@ -592,7 +639,7 @@ the stream, and `getSocket`, which returns the WebSocket object. #### Defined in -[lib/k8s/apiProxy.ts:1287](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1287) +[lib/k8s/apiProxy.ts:1311](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1311) ___ @@ -621,7 +668,7 @@ A function to cancel the stream. #### Defined in -[lib/k8s/apiProxy.ts:1033](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1033) +[lib/k8s/apiProxy.ts:1057](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1057) ___ @@ -648,7 +695,7 @@ A function to cancel the stream. #### Defined in -[lib/k8s/apiProxy.ts:1100](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1100) +[lib/k8s/apiProxy.ts:1124](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1124) ___ @@ -670,19 +717,20 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1121](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1121) +[lib/k8s/apiProxy.ts:1145](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1145) ___ ### testAuth -▸ **testAuth**(`cluster?`): `Promise`<`any`\> +▸ **testAuth**(`cluster?`, `namespace?`): `Promise`<`any`\> #### Parameters | Name | Type | Default value | | :------ | :------ | :------ | | `cluster` | `string` | `''` | +| `namespace` | `string` | `'default'` | #### Returns @@ -690,7 +738,7 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1620](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1620) +[lib/k8s/apiProxy.ts:1644](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1644) ___ @@ -710,4 +758,4 @@ ___ #### Defined in -[lib/k8s/apiProxy.ts:1630](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/apiProxy.ts#L1630) +[lib/k8s/apiProxy.ts:1654](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/apiProxy.ts#L1654) diff --git a/docs/development/api/modules/lib_k8s_cluster.md b/docs/development/api/modules/lib_k8s_cluster.md index 668b8fbecf..05efeb6cea 100644 --- a/docs/development/api/modules/lib_k8s_cluster.md +++ b/docs/development/api/modules/lib_k8s_cluster.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/cluster" -linkTitle: "lib/k8s/cluster" -slug: "lib_k8s_cluster" ---- +[API](../API.md) / lib/k8s/cluster + +# Module: lib/k8s/cluster ## References diff --git a/docs/development/api/modules/lib_k8s_clusterRole.md b/docs/development/api/modules/lib_k8s_clusterRole.md index 3175565345..968c8a6f41 100644 --- a/docs/development/api/modules/lib_k8s_clusterRole.md +++ b/docs/development/api/modules/lib_k8s_clusterRole.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/clusterRole" -linkTitle: "lib/k8s/clusterRole" -slug: "lib_k8s_clusterRole" ---- +[API](../API.md) / lib/k8s/clusterRole + +# Module: lib/k8s/clusterRole ## Classes diff --git a/docs/development/api/modules/lib_k8s_clusterRoleBinding.md b/docs/development/api/modules/lib_k8s_clusterRoleBinding.md index 0ba4828650..a855973b5c 100644 --- a/docs/development/api/modules/lib_k8s_clusterRoleBinding.md +++ b/docs/development/api/modules/lib_k8s_clusterRoleBinding.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/clusterRoleBinding" -linkTitle: "lib/k8s/clusterRoleBinding" -slug: "lib_k8s_clusterRoleBinding" ---- +[API](../API.md) / lib/k8s/clusterRoleBinding + +# Module: lib/k8s/clusterRoleBinding ## Classes diff --git a/docs/development/api/modules/lib_k8s_configMap.md b/docs/development/api/modules/lib_k8s_configMap.md index 972cff6ee6..358487ad55 100644 --- a/docs/development/api/modules/lib_k8s_configMap.md +++ b/docs/development/api/modules/lib_k8s_configMap.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/configMap" -linkTitle: "lib/k8s/configMap" -slug: "lib_k8s_configMap" ---- +[API](../API.md) / lib/k8s/configMap + +# Module: lib/k8s/configMap ## Classes diff --git a/docs/development/api/modules/lib_k8s_crd.md b/docs/development/api/modules/lib_k8s_crd.md index eb2ecdd7b2..c5081e7296 100644 --- a/docs/development/api/modules/lib_k8s_crd.md +++ b/docs/development/api/modules/lib_k8s_crd.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/crd" -linkTitle: "lib/k8s/crd" -slug: "lib_k8s_crd" ---- +[API](../API.md) / lib/k8s/crd + +# Module: lib/k8s/crd ## Classes @@ -34,7 +32,7 @@ slug: "lib_k8s_crd" #### Defined in -[lib/k8s/crd.ts:104](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L104) +[lib/k8s/crd.ts:130](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L130) ▸ **makeCustomResourceClass**(`args`): `ReturnType` @@ -50,4 +48,4 @@ slug: "lib_k8s_crd" #### Defined in -[lib/k8s/crd.ts:108](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/crd.ts#L108) +[lib/k8s/crd.ts:134](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/crd.ts#L134) diff --git a/docs/development/api/modules/lib_k8s_cronJob.md b/docs/development/api/modules/lib_k8s_cronJob.md index 5766e215f7..a3dbea9dc2 100644 --- a/docs/development/api/modules/lib_k8s_cronJob.md +++ b/docs/development/api/modules/lib_k8s_cronJob.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/cronJob" -linkTitle: "lib/k8s/cronJob" -slug: "lib_k8s_cronJob" ---- +[API](../API.md) / lib/k8s/cronJob + +# Module: lib/k8s/cronJob ## Classes diff --git a/docs/development/api/modules/lib_k8s_daemonSet.md b/docs/development/api/modules/lib_k8s_daemonSet.md index 6fb2c2dbb2..30f2652f1f 100644 --- a/docs/development/api/modules/lib_k8s_daemonSet.md +++ b/docs/development/api/modules/lib_k8s_daemonSet.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/daemonSet" -linkTitle: "lib/k8s/daemonSet" -slug: "lib_k8s_daemonSet" ---- +[API](../API.md) / lib/k8s/daemonSet + +# Module: lib/k8s/daemonSet ## Classes diff --git a/docs/development/api/modules/lib_k8s_deployment.md b/docs/development/api/modules/lib_k8s_deployment.md index 001af0a78e..a593e604b4 100644 --- a/docs/development/api/modules/lib_k8s_deployment.md +++ b/docs/development/api/modules/lib_k8s_deployment.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/deployment" -linkTitle: "lib/k8s/deployment" -slug: "lib_k8s_deployment" ---- +[API](../API.md) / lib/k8s/deployment + +# Module: lib/k8s/deployment ## Classes diff --git a/docs/development/api/modules/lib_k8s_endpoints.md b/docs/development/api/modules/lib_k8s_endpoints.md index cbb1da51cf..61d865eb8e 100644 --- a/docs/development/api/modules/lib_k8s_endpoints.md +++ b/docs/development/api/modules/lib_k8s_endpoints.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/endpoints" -linkTitle: "lib/k8s/endpoints" -slug: "lib_k8s_endpoints" ---- +[API](../API.md) / lib/k8s/endpoints + +# Module: lib/k8s/endpoints ## Classes diff --git a/docs/development/api/modules/lib_k8s_event.md b/docs/development/api/modules/lib_k8s_event.md index 34035ea945..576c01d8f8 100644 --- a/docs/development/api/modules/lib_k8s_event.md +++ b/docs/development/api/modules/lib_k8s_event.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/event" -linkTitle: "lib/k8s/event" -slug: "lib_k8s_event" ---- +[API](../API.md) / lib/k8s/event + +# Module: lib/k8s/event ## Classes diff --git a/docs/development/api/modules/lib_k8s_hpa.md b/docs/development/api/modules/lib_k8s_hpa.md index de32a6a44a..01bce056c4 100644 --- a/docs/development/api/modules/lib_k8s_hpa.md +++ b/docs/development/api/modules/lib_k8s_hpa.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/hpa" -linkTitle: "lib/k8s/hpa" -slug: "lib_k8s_hpa" ---- +[API](../API.md) / lib/k8s/hpa + +# Module: lib/k8s/hpa ## Classes diff --git a/docs/development/api/modules/lib_k8s_ingress.md b/docs/development/api/modules/lib_k8s_ingress.md index 53e09d117b..54a81f2f77 100644 --- a/docs/development/api/modules/lib_k8s_ingress.md +++ b/docs/development/api/modules/lib_k8s_ingress.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/ingress" -linkTitle: "lib/k8s/ingress" -slug: "lib_k8s_ingress" ---- +[API](../API.md) / lib/k8s/ingress + +# Module: lib/k8s/ingress ## Classes diff --git a/docs/development/api/modules/lib_k8s_ingressClass.md b/docs/development/api/modules/lib_k8s_ingressClass.md index 199e1e50fe..1a6eabd25f 100644 --- a/docs/development/api/modules/lib_k8s_ingressClass.md +++ b/docs/development/api/modules/lib_k8s_ingressClass.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/ingressClass" -linkTitle: "lib/k8s/ingressClass" -slug: "lib_k8s_ingressClass" ---- +[API](../API.md) / lib/k8s/ingressClass + +# Module: lib/k8s/ingressClass ## Classes diff --git a/docs/development/api/modules/lib_k8s_job.md b/docs/development/api/modules/lib_k8s_job.md index 1b0ba0963c..68cfd3513b 100644 --- a/docs/development/api/modules/lib_k8s_job.md +++ b/docs/development/api/modules/lib_k8s_job.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/job" -linkTitle: "lib/k8s/job" -slug: "lib_k8s_job" ---- +[API](../API.md) / lib/k8s/job + +# Module: lib/k8s/job ## Classes diff --git a/docs/development/api/modules/lib_k8s_kubeconfig.md b/docs/development/api/modules/lib_k8s_kubeconfig.md index 532f0da6bb..6d192345ed 100644 --- a/docs/development/api/modules/lib_k8s_kubeconfig.md +++ b/docs/development/api/modules/lib_k8s_kubeconfig.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/kubeconfig" -linkTitle: "lib/k8s/kubeconfig" -slug: "lib_k8s_kubeconfig" ---- +[API](../API.md) / lib/k8s/kubeconfig + +# Module: lib/k8s/kubeconfig ## Interfaces diff --git a/docs/development/api/modules/lib_k8s_lease.md b/docs/development/api/modules/lib_k8s_lease.md index 25309ae9a9..22dd1ca9d8 100644 --- a/docs/development/api/modules/lib_k8s_lease.md +++ b/docs/development/api/modules/lib_k8s_lease.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/lease" -linkTitle: "lib/k8s/lease" -slug: "lib_k8s_lease" ---- +[API](../API.md) / lib/k8s/lease + +# Module: lib/k8s/lease ## Classes diff --git a/docs/development/api/modules/lib_k8s_limitRange.md b/docs/development/api/modules/lib_k8s_limitRange.md index 0e9e2a6bfd..cb75fb2235 100644 --- a/docs/development/api/modules/lib_k8s_limitRange.md +++ b/docs/development/api/modules/lib_k8s_limitRange.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/limitRange" -linkTitle: "lib/k8s/limitRange" -slug: "lib_k8s_limitRange" ---- +[API](../API.md) / lib/k8s/limitRange + +# Module: lib/k8s/limitRange ## Classes diff --git a/docs/development/api/modules/lib_k8s_mutatingWebhookConfiguration.md b/docs/development/api/modules/lib_k8s_mutatingWebhookConfiguration.md index 41824a1d0a..1f871f9c7f 100644 --- a/docs/development/api/modules/lib_k8s_mutatingWebhookConfiguration.md +++ b/docs/development/api/modules/lib_k8s_mutatingWebhookConfiguration.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/mutatingWebhookConfiguration" -linkTitle: "lib/k8s/mutatingWebhookConfiguration" -slug: "lib_k8s_mutatingWebhookConfiguration" ---- +[API](../API.md) / lib/k8s/mutatingWebhookConfiguration + +# Module: lib/k8s/mutatingWebhookConfiguration ## Classes diff --git a/docs/development/api/modules/lib_k8s_namespace.md b/docs/development/api/modules/lib_k8s_namespace.md index e832d46b50..657e45ebd8 100644 --- a/docs/development/api/modules/lib_k8s_namespace.md +++ b/docs/development/api/modules/lib_k8s_namespace.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/namespace" -linkTitle: "lib/k8s/namespace" -slug: "lib_k8s_namespace" ---- +[API](../API.md) / lib/k8s/namespace + +# Module: lib/k8s/namespace ## Classes diff --git a/docs/development/api/modules/lib_k8s_networkpolicy.md b/docs/development/api/modules/lib_k8s_networkpolicy.md index 297393882d..96e52cca6e 100644 --- a/docs/development/api/modules/lib_k8s_networkpolicy.md +++ b/docs/development/api/modules/lib_k8s_networkpolicy.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/networkpolicy" -linkTitle: "lib/k8s/networkpolicy" -slug: "lib_k8s_networkpolicy" ---- +[API](../API.md) / lib/k8s/networkpolicy + +# Module: lib/k8s/networkpolicy ## Classes diff --git a/docs/development/api/modules/lib_k8s_node.md b/docs/development/api/modules/lib_k8s_node.md index 46af3cae59..0e5537a31b 100644 --- a/docs/development/api/modules/lib_k8s_node.md +++ b/docs/development/api/modules/lib_k8s_node.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/node" -linkTitle: "lib/k8s/node" -slug: "lib_k8s_node" ---- +[API](../API.md) / lib/k8s/node + +# Module: lib/k8s/node ## Classes diff --git a/docs/development/api/modules/lib_k8s_persistentVolume.md b/docs/development/api/modules/lib_k8s_persistentVolume.md index 4d785a88fb..e596a502a2 100644 --- a/docs/development/api/modules/lib_k8s_persistentVolume.md +++ b/docs/development/api/modules/lib_k8s_persistentVolume.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/persistentVolume" -linkTitle: "lib/k8s/persistentVolume" -slug: "lib_k8s_persistentVolume" ---- +[API](../API.md) / lib/k8s/persistentVolume + +# Module: lib/k8s/persistentVolume ## Classes diff --git a/docs/development/api/modules/lib_k8s_persistentVolumeClaim.md b/docs/development/api/modules/lib_k8s_persistentVolumeClaim.md index a2b3fffcd9..f9471e4ee8 100644 --- a/docs/development/api/modules/lib_k8s_persistentVolumeClaim.md +++ b/docs/development/api/modules/lib_k8s_persistentVolumeClaim.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/persistentVolumeClaim" -linkTitle: "lib/k8s/persistentVolumeClaim" -slug: "lib_k8s_persistentVolumeClaim" ---- +[API](../API.md) / lib/k8s/persistentVolumeClaim + +# Module: lib/k8s/persistentVolumeClaim ## Classes diff --git a/docs/development/api/modules/lib_k8s_pod.md b/docs/development/api/modules/lib_k8s_pod.md index 89a3e9f2cf..d6f5d9a3e1 100644 --- a/docs/development/api/modules/lib_k8s_pod.md +++ b/docs/development/api/modules/lib_k8s_pod.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/pod" -linkTitle: "lib/k8s/pod" -slug: "lib_k8s_pod" ---- +[API](../API.md) / lib/k8s/pod + +# Module: lib/k8s/pod ## Classes diff --git a/docs/development/api/modules/lib_k8s_podDisruptionBudget.md b/docs/development/api/modules/lib_k8s_podDisruptionBudget.md index 85f61de75d..a38af809c1 100644 --- a/docs/development/api/modules/lib_k8s_podDisruptionBudget.md +++ b/docs/development/api/modules/lib_k8s_podDisruptionBudget.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/podDisruptionBudget" -linkTitle: "lib/k8s/podDisruptionBudget" -slug: "lib_k8s_podDisruptionBudget" ---- +[API](../API.md) / lib/k8s/podDisruptionBudget + +# Module: lib/k8s/podDisruptionBudget ## Classes diff --git a/docs/development/api/modules/lib_k8s_priorityClass.md b/docs/development/api/modules/lib_k8s_priorityClass.md index 960af05d3a..22fd222ebd 100644 --- a/docs/development/api/modules/lib_k8s_priorityClass.md +++ b/docs/development/api/modules/lib_k8s_priorityClass.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/priorityClass" -linkTitle: "lib/k8s/priorityClass" -slug: "lib_k8s_priorityClass" ---- +[API](../API.md) / lib/k8s/priorityClass + +# Module: lib/k8s/priorityClass ## Classes diff --git a/docs/development/api/modules/lib_k8s_priorityClasses.md b/docs/development/api/modules/lib_k8s_priorityClasses.md index e619098c2b..ba11d5b1a2 100644 --- a/docs/development/api/modules/lib_k8s_priorityClasses.md +++ b/docs/development/api/modules/lib_k8s_priorityClasses.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/priorityClasses" -linkTitle: "lib/k8s/priorityClasses" -slug: "lib_k8s_priorityClasses" ---- +[API](../API.md) / lib/k8s/priorityClasses + +# Module: lib/k8s/priorityClasses ## References @@ -24,4 +22,4 @@ Renames and re-exports [PriorityClass](../classes/lib_k8s_priorityClass.Priority #### Defined in -[lib/k8s/priorityClasses.ts:6](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/k8s/priorityClasses.ts#L6) +[lib/k8s/priorityClasses.ts:6](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/k8s/priorityClasses.ts#L6) diff --git a/docs/development/api/modules/lib_k8s_replicaSet.md b/docs/development/api/modules/lib_k8s_replicaSet.md index 438cadc9ac..79772c4f93 100644 --- a/docs/development/api/modules/lib_k8s_replicaSet.md +++ b/docs/development/api/modules/lib_k8s_replicaSet.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/replicaSet" -linkTitle: "lib/k8s/replicaSet" -slug: "lib_k8s_replicaSet" ---- +[API](../API.md) / lib/k8s/replicaSet + +# Module: lib/k8s/replicaSet ## Classes diff --git a/docs/development/api/modules/lib_k8s_resourceQuota.md b/docs/development/api/modules/lib_k8s_resourceQuota.md index b5a53d465c..e23774131b 100644 --- a/docs/development/api/modules/lib_k8s_resourceQuota.md +++ b/docs/development/api/modules/lib_k8s_resourceQuota.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/resourceQuota" -linkTitle: "lib/k8s/resourceQuota" -slug: "lib_k8s_resourceQuota" ---- +[API](../API.md) / lib/k8s/resourceQuota + +# Module: lib/k8s/resourceQuota ## Classes diff --git a/docs/development/api/modules/lib_k8s_role.md b/docs/development/api/modules/lib_k8s_role.md index 3743c3a56e..2958a43a8a 100644 --- a/docs/development/api/modules/lib_k8s_role.md +++ b/docs/development/api/modules/lib_k8s_role.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/role" -linkTitle: "lib/k8s/role" -slug: "lib_k8s_role" ---- +[API](../API.md) / lib/k8s/role + +# Module: lib/k8s/role ## Classes diff --git a/docs/development/api/modules/lib_k8s_roleBinding.md b/docs/development/api/modules/lib_k8s_roleBinding.md index 3f3a1c9850..9a9a3d8be6 100644 --- a/docs/development/api/modules/lib_k8s_roleBinding.md +++ b/docs/development/api/modules/lib_k8s_roleBinding.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/roleBinding" -linkTitle: "lib/k8s/roleBinding" -slug: "lib_k8s_roleBinding" ---- +[API](../API.md) / lib/k8s/roleBinding + +# Module: lib/k8s/roleBinding ## Classes diff --git a/docs/development/api/modules/lib_k8s_runtime.md b/docs/development/api/modules/lib_k8s_runtime.md index 31425f6822..2eb43cd92f 100644 --- a/docs/development/api/modules/lib_k8s_runtime.md +++ b/docs/development/api/modules/lib_k8s_runtime.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/runtime" -linkTitle: "lib/k8s/runtime" -slug: "lib_k8s_runtime" ---- +[API](../API.md) / lib/k8s/runtime + +# Module: lib/k8s/runtime ## Classes diff --git a/docs/development/api/modules/lib_k8s_secret.md b/docs/development/api/modules/lib_k8s_secret.md index 62ba647f00..f31eed2a83 100644 --- a/docs/development/api/modules/lib_k8s_secret.md +++ b/docs/development/api/modules/lib_k8s_secret.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/secret" -linkTitle: "lib/k8s/secret" -slug: "lib_k8s_secret" ---- +[API](../API.md) / lib/k8s/secret + +# Module: lib/k8s/secret ## Classes diff --git a/docs/development/api/modules/lib_k8s_service.md b/docs/development/api/modules/lib_k8s_service.md index bb5c297789..57850c02b9 100644 --- a/docs/development/api/modules/lib_k8s_service.md +++ b/docs/development/api/modules/lib_k8s_service.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/service" -linkTitle: "lib/k8s/service" -slug: "lib_k8s_service" ---- +[API](../API.md) / lib/k8s/service + +# Module: lib/k8s/service ## Classes diff --git a/docs/development/api/modules/lib_k8s_serviceAccount.md b/docs/development/api/modules/lib_k8s_serviceAccount.md index d236722aec..7ecd6f5af4 100644 --- a/docs/development/api/modules/lib_k8s_serviceAccount.md +++ b/docs/development/api/modules/lib_k8s_serviceAccount.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/serviceAccount" -linkTitle: "lib/k8s/serviceAccount" -slug: "lib_k8s_serviceAccount" ---- +[API](../API.md) / lib/k8s/serviceAccount + +# Module: lib/k8s/serviceAccount ## Classes diff --git a/docs/development/api/modules/lib_k8s_statefulSet.md b/docs/development/api/modules/lib_k8s_statefulSet.md index dd78724a58..59d3750229 100644 --- a/docs/development/api/modules/lib_k8s_statefulSet.md +++ b/docs/development/api/modules/lib_k8s_statefulSet.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/statefulSet" -linkTitle: "lib/k8s/statefulSet" -slug: "lib_k8s_statefulSet" ---- +[API](../API.md) / lib/k8s/statefulSet + +# Module: lib/k8s/statefulSet ## Classes diff --git a/docs/development/api/modules/lib_k8s_storageClass.md b/docs/development/api/modules/lib_k8s_storageClass.md index c870800d4e..c66006f329 100644 --- a/docs/development/api/modules/lib_k8s_storageClass.md +++ b/docs/development/api/modules/lib_k8s_storageClass.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/storageClass" -linkTitle: "lib/k8s/storageClass" -slug: "lib_k8s_storageClass" ---- +[API](../API.md) / lib/k8s/storageClass + +# Module: lib/k8s/storageClass ## Classes diff --git a/docs/development/api/modules/lib_k8s_token.md b/docs/development/api/modules/lib_k8s_token.md index d1658c8a13..1cb3f5641c 100644 --- a/docs/development/api/modules/lib_k8s_token.md +++ b/docs/development/api/modules/lib_k8s_token.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/token" -linkTitle: "lib/k8s/token" -slug: "lib_k8s_token" ---- +[API](../API.md) / lib/k8s/token + +# Module: lib/k8s/token ## Interfaces diff --git a/docs/development/api/modules/lib_k8s_validatingWebhookConfiguration.md b/docs/development/api/modules/lib_k8s_validatingWebhookConfiguration.md index 16583a22fd..ce93fdf331 100644 --- a/docs/development/api/modules/lib_k8s_validatingWebhookConfiguration.md +++ b/docs/development/api/modules/lib_k8s_validatingWebhookConfiguration.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/validatingWebhookConfiguration" -linkTitle: "lib/k8s/validatingWebhookConfiguration" -slug: "lib_k8s_validatingWebhookConfiguration" ---- +[API](../API.md) / lib/k8s/validatingWebhookConfiguration + +# Module: lib/k8s/validatingWebhookConfiguration ## Classes diff --git a/docs/development/api/modules/lib_k8s_vpa.md b/docs/development/api/modules/lib_k8s_vpa.md index 764c3650dd..e286f1e0b5 100644 --- a/docs/development/api/modules/lib_k8s_vpa.md +++ b/docs/development/api/modules/lib_k8s_vpa.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/k8s/vpa" -linkTitle: "lib/k8s/vpa" -slug: "lib_k8s_vpa" ---- +[API](../API.md) / lib/k8s/vpa + +# Module: lib/k8s/vpa ## Classes diff --git a/docs/development/api/modules/lib_router.md b/docs/development/api/modules/lib_router.md index e76e8077e1..8f148a908c 100644 --- a/docs/development/api/modules/lib_router.md +++ b/docs/development/api/modules/lib_router.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/router" -linkTitle: "lib/router" -slug: "lib_router" ---- +[API](../API.md) / lib/router + +# Module: lib/router ## Interfaces @@ -28,7 +26,7 @@ slug: "lib_router" #### Defined in -[lib/router.tsx:761](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L761) +[lib/router.tsx:761](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L761) ## Functions @@ -49,7 +47,7 @@ slug: "lib_router" #### Defined in -[lib/router.tsx:819](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L819) +[lib/router.tsx:819](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L819) ___ @@ -63,7 +61,7 @@ ___ #### Defined in -[lib/router.tsx:847](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L847) +[lib/router.tsx:847](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L847) ___ @@ -83,7 +81,7 @@ ___ #### Defined in -[lib/router.tsx:770](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L770) +[lib/router.tsx:770](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L770) ___ @@ -103,7 +101,7 @@ ___ #### Defined in -[lib/router.tsx:803](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L803) +[lib/router.tsx:803](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L803) ___ @@ -128,4 +126,4 @@ true when a cluster URL contains cluster in the URL. eg. /c/minikube/my-url #### Defined in -[lib/router.tsx:791](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/router.tsx#L791) +[lib/router.tsx:791](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/router.tsx#L791) diff --git a/docs/development/api/modules/lib_util.auth.md b/docs/development/api/modules/lib_util.auth.md index 1b1c31d31b..416a6e6555 100644 --- a/docs/development/api/modules/lib_util.auth.md +++ b/docs/development/api/modules/lib_util.auth.md @@ -1,8 +1,6 @@ ---- -title: "Namespace: auth" -linkTitle: "auth" -slug: "lib_util.auth" ---- +[API](../API.md) / [lib/util](lib_util.md) / auth + +# Namespace: auth [lib/util](lib_util.md).auth @@ -18,7 +16,7 @@ slug: "lib_util.auth" #### Defined in -[lib/auth.ts:41](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/auth.ts#L41) +[lib/auth.ts:41](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/auth.ts#L41) ___ @@ -38,7 +36,7 @@ ___ #### Defined in -[lib/auth.ts:7](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/auth.ts#L7) +[lib/auth.ts:7](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/auth.ts#L7) ___ @@ -58,7 +56,7 @@ ___ #### Defined in -[lib/auth.ts:17](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/auth.ts#L17) +[lib/auth.ts:17](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/auth.ts#L17) ___ @@ -78,7 +76,7 @@ ___ #### Defined in -[lib/auth.ts:22](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/auth.ts#L22) +[lib/auth.ts:22](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/auth.ts#L22) ___ @@ -92,7 +90,7 @@ ___ #### Defined in -[lib/auth.ts:45](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/auth.ts#L45) +[lib/auth.ts:45](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/auth.ts#L45) ___ @@ -113,4 +111,4 @@ ___ #### Defined in -[lib/auth.ts:30](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/auth.ts#L30) +[lib/auth.ts:30](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/auth.ts#L30) diff --git a/docs/development/api/modules/lib_util.md b/docs/development/api/modules/lib_util.md index a4a88a58e1..01c8034077 100644 --- a/docs/development/api/modules/lib_util.md +++ b/docs/development/api/modules/lib_util.md @@ -1,8 +1,6 @@ ---- -title: "Module: lib/util" -linkTitle: "lib/util" -slug: "lib_util" ---- +[API](../API.md) / lib/util + +# Module: lib/util ## Namespaces @@ -21,7 +19,7 @@ slug: "lib_util" #### Defined in -[lib/util.ts:33](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L33) +[lib/util.ts:33](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L33) ___ @@ -31,7 +29,7 @@ ___ #### Defined in -[lib/util.ts:31](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L31) +[lib/util.ts:31](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L31) ## Variables @@ -41,7 +39,7 @@ ___ #### Defined in -[lib/util.ts:29](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L29) +[lib/util.ts:29](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L29) ## Functions @@ -62,13 +60,13 @@ ___ #### Defined in -[lib/util.ts:301](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L301) +[lib/util.ts:302](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L302) ___ ### filterGeneric -▸ **filterGeneric**<`T`\>(`item`, `filter`, `matchCriteria?`): `boolean` +▸ **filterGeneric**<`T`\>(`item`, `search?`, `matchCriteria?`): `boolean` Filters a generic item based on the filter state. @@ -86,7 +84,7 @@ matches the filter.search contents. Case matching is insensitive. | Name | Type | Description | | :------ | :------ | :------ | | `item` | `T` | The item to filter. | -| `filter` | `FilterState` | The filter state. | +| `search?` | `string` | - | | `matchCriteria?` | `string`[] | The JSONPath criteria to match. | #### Returns @@ -95,13 +93,13 @@ matches the filter.search contents. Case matching is insensitive. #### Defined in -[redux/filterSlice.ts:73](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/filterSlice.ts#L73) +[redux/filterSlice.ts:71](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/filterSlice.ts#L71) ___ ### filterResource -▸ **filterResource**(`item`, `filter`, `matchCriteria?`): `boolean` +▸ **filterResource**(`item`, `filter`, `search?`, `matchCriteria?`): `boolean` Filters a resource based on the filter state. @@ -111,6 +109,7 @@ Filters a resource based on the filter state. | :------ | :------ | :------ | | `item` | [`KubeObjectInterface`](../interfaces/lib_k8s_cluster.KubeObjectInterface.md) \| [`KubeEvent`](../interfaces/lib_k8s_event.KubeEvent.md) | The item to filter. | | `filter` | `FilterState` | The filter state. | +| `search?` | `string` | - | | `matchCriteria?` | `string`[] | The JSONPath criteria to match. | #### Returns @@ -121,7 +120,7 @@ True if the item matches the filter, false otherwise. #### Defined in -[redux/filterSlice.ts:27](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/filterSlice.ts#L27) +[redux/filterSlice.ts:24](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/filterSlice.ts#L24) ___ @@ -146,7 +145,7 @@ The formatted duration. #### Defined in -[lib/util.ts:65](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L65) +[lib/util.ts:65](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L65) ___ @@ -162,7 +161,7 @@ The current cluster name, or null if not in a cluster context. #### Defined in -[lib/cluster.ts:20](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/cluster.ts#L20) +[lib/cluster.ts:20](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/cluster.ts#L20) ___ @@ -186,7 +185,7 @@ The given path does not start with a /, it will be added. #### Defined in -[lib/cluster.ts:9](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/cluster.ts#L9) +[lib/cluster.ts:9](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/cluster.ts#L9) ___ @@ -207,7 +206,7 @@ ___ #### Defined in -[lib/util.ts:102](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L102) +[lib/util.ts:102](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L102) ___ @@ -227,7 +226,7 @@ ___ #### Defined in -[lib/util.ts:111](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L111) +[lib/util.ts:111](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L111) ___ @@ -249,7 +248,7 @@ ___ #### Defined in -[lib/util.ts:129](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L129) +[lib/util.ts:129](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L129) ___ @@ -270,7 +269,7 @@ ___ #### Defined in -[lib/util.ts:119](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L119) +[lib/util.ts:119](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L119) ___ @@ -290,7 +289,7 @@ ___ #### Defined in -[lib/util.ts:115](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L115) +[lib/util.ts:115](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L115) ___ @@ -310,7 +309,7 @@ ___ #### Defined in -[lib/util.ts:85](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L85) +[lib/util.ts:85](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L85) ___ @@ -331,7 +330,7 @@ ___ #### Defined in -[lib/util.ts:310](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L310) +[lib/util.ts:311](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L311) ___ @@ -356,7 +355,7 @@ The formatted date. #### Defined in -[lib/util.ts:46](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L46) +[lib/util.ts:46](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L46) ___ @@ -376,13 +375,15 @@ ___ #### Defined in -[lib/util.ts:168](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L168) +[lib/util.ts:169](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L169) ___ ### useFilterFunc -▸ **useFilterFunc**<`T`\>(`matchCriteria?`): (`item`: `T`) => `boolean` +▸ **useFilterFunc**<`T`\>(`matchCriteria?`): (`item`: `T`, `search?`: `string`) => `boolean` + +Get a function to filter kube resources based on the current global filter state. #### Type parameters @@ -402,13 +403,14 @@ ___ A filter function that can be used to filter a list of items. -▸ (`item`): `boolean` +▸ (`item`, `search?`): `boolean` ##### Parameters | Name | Type | | :------ | :------ | | `item` | `T` | +| `search?` | `string` | ##### Returns @@ -416,7 +418,7 @@ A filter function that can be used to filter a list of items. #### Defined in -[lib/util.ts:153](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L153) +[lib/util.ts:154](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L154) ___ @@ -439,7 +441,7 @@ If UNDER_TEST is set to true, it will return the same ID every time, so snapshot #### Defined in -[lib/util.ts:389](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L389) +[lib/util.ts:390](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L390) ___ @@ -462,7 +464,7 @@ A hook to manage a state variable that is also stored in the URL. #### Defined in -[lib/util.ts:193](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L193) +[lib/util.ts:194](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L194) ▸ **useURLState**(`key`, `valueOrParams`): [`number`, `React.Dispatch`<`React.SetStateAction`<`number`\>\>] @@ -481,4 +483,4 @@ A hook to manage a state variable that is also stored in the URL. #### Defined in -[lib/util.ts:197](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/util.ts#L197) +[lib/util.ts:198](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/util.ts#L198) diff --git a/docs/development/api/modules/lib_util.units.md b/docs/development/api/modules/lib_util.units.md index f5e33252fb..2821fe7b9a 100644 --- a/docs/development/api/modules/lib_util.units.md +++ b/docs/development/api/modules/lib_util.units.md @@ -1,8 +1,6 @@ ---- -title: "Namespace: units" -linkTitle: "units" -slug: "lib_util.units" ---- +[API](../API.md) / [lib/util](lib_util.md) / units + +# Namespace: units [lib/util](lib_util.md).units @@ -14,7 +12,7 @@ slug: "lib_util.units" #### Defined in -[lib/units.ts:10](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/units.ts#L10) +[lib/units.ts:10](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/units.ts#L10) ___ @@ -24,7 +22,7 @@ ___ #### Defined in -[lib/units.ts:12](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/units.ts#L12) +[lib/units.ts:12](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/units.ts#L12) ___ @@ -34,7 +32,7 @@ ___ #### Defined in -[lib/units.ts:11](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/units.ts#L11) +[lib/units.ts:11](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/units.ts#L11) ## Functions @@ -54,7 +52,7 @@ ___ #### Defined in -[lib/units.ts:62](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/units.ts#L62) +[lib/units.ts:62](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/units.ts#L62) ___ @@ -74,7 +72,7 @@ ___ #### Defined in -[lib/units.ts:14](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/units.ts#L14) +[lib/units.ts:14](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/units.ts#L14) ___ @@ -94,7 +92,7 @@ ___ #### Defined in -[lib/units.ts:18](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/units.ts#L18) +[lib/units.ts:18](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/units.ts#L18) ___ @@ -119,7 +117,7 @@ ___ #### Defined in -[lib/units.ts:72](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/units.ts#L72) +[lib/units.ts:72](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/units.ts#L72) ___ @@ -144,4 +142,4 @@ ___ #### Defined in -[lib/units.ts:49](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/lib/units.ts#L49) +[lib/units.ts:49](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/lib/units.ts#L49) diff --git a/docs/development/api/modules/plugin_lib.md b/docs/development/api/modules/plugin_lib.md index 6659130c99..a388331235 100644 --- a/docs/development/api/modules/plugin_lib.md +++ b/docs/development/api/modules/plugin_lib.md @@ -1,8 +1,6 @@ ---- -title: "Module: plugin/lib" -linkTitle: "plugin/lib" -slug: "plugin_lib" ---- +[API](../API.md) / plugin/lib + +# Module: plugin/lib ## Classes diff --git a/docs/development/api/modules/plugin_registry.md b/docs/development/api/modules/plugin_registry.md index ccf3db5a77..4c217d4cd5 100644 --- a/docs/development/api/modules/plugin_registry.md +++ b/docs/development/api/modules/plugin_registry.md @@ -1,8 +1,6 @@ ---- -title: "Module: plugin/registry" -linkTitle: "plugin/registry" -slug: "plugin_registry" ---- +[API](../API.md) / plugin/registry + +# Module: plugin/registry ## Enumerations @@ -12,6 +10,7 @@ slug: "plugin_registry" ## Classes +- [PluginManager](../classes/plugin_registry.PluginManager.md) - [Registry](../classes/plugin_registry.Registry.md) ## Interfaces @@ -60,7 +59,7 @@ slug: "plugin_registry" #### Defined in -[redux/actionButtonsSlice.ts:59](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/actionButtonsSlice.ts#L59) +[redux/actionButtonsSlice.ts:59](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/actionButtonsSlice.ts#L59) ___ @@ -70,7 +69,7 @@ ___ #### Defined in -[components/App/AppLogo.tsx:25](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/App/AppLogo.tsx#L25) +[components/App/AppLogo.tsx:25](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/AppLogo.tsx#L25) ___ @@ -80,7 +79,7 @@ ___ #### Defined in -[components/cluster/ClusterChooser.tsx:10](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/cluster/ClusterChooser.tsx#L10) +[components/cluster/ClusterChooser.tsx:10](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/cluster/ClusterChooser.tsx#L10) ___ @@ -90,7 +89,7 @@ ___ #### Defined in -[plugin/registry.tsx:114](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L114) +[plugin/registry.tsx:115](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L115) ___ @@ -100,7 +99,7 @@ ___ #### Defined in -[plugin/registry.tsx:115](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L115) +[plugin/registry.tsx:116](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L116) ___ @@ -110,7 +109,7 @@ ___ #### Defined in -[components/DetailsViewSection/DetailsViewSection.tsx:10](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/DetailsViewSection/DetailsViewSection.tsx#L10) +[components/DetailsViewSection/DetailsViewSection.tsx:10](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/DetailsViewSection/DetailsViewSection.tsx#L10) ___ @@ -134,7 +133,7 @@ ___ #### Defined in -[redux/headlampEventSlice.ts:278](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/redux/headlampEventSlice.ts#L278) +[redux/headlampEventSlice.ts:278](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/redux/headlampEventSlice.ts#L278) ___ @@ -146,7 +145,7 @@ PluginSettingsComponentType is the type of the component associated with the plu #### Defined in -[plugin/pluginsSlice.ts:24](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/pluginsSlice.ts#L24) +[plugin/pluginsSlice.ts:24](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/pluginsSlice.ts#L24) ___ @@ -172,7 +171,7 @@ ___ #### Defined in -[plugin/registry.tsx:106](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L106) +[plugin/registry.tsx:107](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L107) ## Variables @@ -182,7 +181,7 @@ ___ #### Defined in -[plugin/registry.tsx:100](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L100) +[plugin/registry.tsx:101](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L101) ___ @@ -192,7 +191,7 @@ ___ #### Defined in -[plugin/registry.tsx:101](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L101) +[plugin/registry.tsx:102](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L102) ## Functions @@ -208,7 +207,7 @@ Returns headers for making API calls to the headlamp-server backend. #### Defined in -[helpers/index.ts:368](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/helpers/index.ts#L368) +[helpers/index.ts:369](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/helpers/index.ts#L369) ___ @@ -251,7 +250,7 @@ registerAppBarAction(ConsoleLogger); #### Defined in -[plugin/registry.tsx:446](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L446) +[plugin/registry.tsx:450](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L450) ___ @@ -285,7 +284,7 @@ More complete logo example in plugins/examples/change-logo: #### Defined in -[plugin/registry.tsx:546](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L546) +[plugin/registry.tsx:550](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L550) ___ @@ -319,7 +318,7 @@ registerClusterChooser(({ clickHandler, cluster }: ClusterChooserProps) => { #### Defined in -[plugin/registry.tsx:569](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L569) +[plugin/registry.tsx:573](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L573) ___ @@ -360,7 +359,7 @@ registerDetailsViewHeaderAction(IconAction); #### Defined in -[plugin/registry.tsx:350](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L350) +[plugin/registry.tsx:351](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L351) ___ @@ -395,7 +394,7 @@ More complete detail view example in plugins/examples/details-view: #### Defined in -[plugin/registry.tsx:373](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L373) +[plugin/registry.tsx:374](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L374) ___ @@ -437,7 +436,7 @@ registerDetailsViewSection(({ resource }: DetailsViewSectionProps) => { #### Defined in -[plugin/registry.tsx:480](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L480) +[plugin/registry.tsx:484](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L484) ___ @@ -488,7 +487,7 @@ registerDetailsViewSectionsProcessor(function addTopSection( resource, sections #### Defined in -[plugin/registry.tsx:518](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L518) +[plugin/registry.tsx:522](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L522) ___ @@ -518,7 +517,7 @@ registerGetTokenFunction(() => { #### Defined in -[plugin/registry.tsx:603](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L603) +[plugin/registry.tsx:607](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L607) ___ @@ -558,7 +557,7 @@ registerHeadlampEventCallback((event: HeadlampEvent) => { #### Defined in -[plugin/registry.tsx:629](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L629) +[plugin/registry.tsx:633](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L633) ___ @@ -619,7 +618,7 @@ void #### Defined in -[plugin/registry.tsx:675](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L675) +[plugin/registry.tsx:679](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L679) ___ @@ -639,9 +638,12 @@ registerResourceTableColumnsProcessor(function ageRemover({ id, columns }) { if (id === 'headlamp-pods') { columns.push({ label: 'Init Containers', + // return plain value to allow filtering and sorting getValue: (pod: Pod) => { return pod.spec.initContainers.length; - }, + } + // (optional) customise how the cell value is rendered + render: (pod: Pod) =>
{pod.spec.initContainers.length}
}); } @@ -653,7 +655,7 @@ registerResourceTableColumnsProcessor(function ageRemover({ id, columns }) { | Name | Type | Description | | :------ | :------ | :------ | -| `processor` | `TableColumnsProcessor` \| (`args`: { `columns`: (`ResourceTableColumn` \| `ColumnType`)[] ; `id`: `string` }) => (`ResourceTableColumn` \| `ColumnType`)[] | The processor ID and function. See #TableColumnsProcessor. | +| `processor` | `TableColumnsProcessor` \| (`args`: { `columns`: (`ColumnType` \| `ResourceTableColumn`<`T`\>)[] ; `id`: `string` }) => (`ColumnType` \| `ResourceTableColumn`<`T`\>)[] | The processor ID and function. See #TableColumnsProcessor. | #### Returns @@ -661,7 +663,7 @@ registerResourceTableColumnsProcessor(function ageRemover({ id, columns }) { #### Defined in -[plugin/registry.tsx:404](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L404) +[plugin/registry.tsx:408](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L408) ___ @@ -701,7 +703,7 @@ registerRoute({ #### Defined in -[plugin/registry.tsx:322](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L322) +[plugin/registry.tsx:323](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L323) ___ @@ -731,7 +733,7 @@ registerRouteFilter(route => (route.path === '/workloads' ? null : route)); #### Defined in -[plugin/registry.tsx:295](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L295) +[plugin/registry.tsx:296](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L296) ___ @@ -761,7 +763,7 @@ registerSetTokenFunction((cluster: string, token: string | null) => { #### Defined in -[plugin/registry.tsx:585](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L585) +[plugin/registry.tsx:589](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L589) ___ @@ -793,7 +795,7 @@ registerSidebarEntry({ parent: 'cluster', name: 'traces', label: 'Traces', url: #### Defined in -[plugin/registry.tsx:241](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L241) +[plugin/registry.tsx:242](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L242) ___ @@ -823,7 +825,7 @@ registerSidebarEntryFilter(entry => (entry.name === 'workloads' ? null : entry)) #### Defined in -[plugin/registry.tsx:276](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/plugin/registry.tsx#L276) +[plugin/registry.tsx:277](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/plugin/registry.tsx#L277) ___ @@ -878,4 +880,4 @@ An object with `stdout`, `stderr`, and `on` properties. You can listen for 'data #### Defined in -[components/App/runCommand.ts:27](https://github.com/headlamp-k8s/headlamp/blob/45b84205/frontend/src/components/App/runCommand.ts#L27) +[components/App/runCommand.ts:27](https://github.com/headlamp-k8s/headlamp/blob/072d2509b/frontend/src/components/App/runCommand.ts#L27) diff --git a/docs/development/backend.md b/docs/development/backend.md index e60cff3639..bb41cd403f 100644 --- a/docs/development/backend.md +++ b/docs/development/backend.md @@ -1,6 +1,6 @@ --- title: Backend -weight: 5 +sidebar_position: 1 --- Headlamp's backend is written in Go and is in charge of redirecting the @@ -23,7 +23,6 @@ make backend Once built, it can be run in development mode (insecure / don't use in production) using: - ```bash make run-backend ``` diff --git a/docs/development/frontend.md b/docs/development/frontend.md index 11ff837545..ec0f141fc2 100644 --- a/docs/development/frontend.md +++ b/docs/development/frontend.md @@ -1,13 +1,14 @@ --- title: Frontend -weight: 5 +sidebar_position: 2 --- The frontend is written in Typescript and React, as well as a few other important modules like: -* Material UI -* React Router -* Redux -* Redux Sagas + +- Material UI +- React Router +- Redux +- Redux Sagas ## Building and running @@ -19,7 +20,6 @@ make frontend Once built, it can be run in development mode (auto-refresh) using: - ```bash make run-frontend ``` @@ -27,7 +27,6 @@ make run-frontend This command leverages the `create-react-app`'s start script that launches a development server for the frontend (by default at `localhost:3000`). - ## API documentation API documentation for TypeScript is done with [typedoc](https://typedoc.org/) and [typedoc-plugin-markdown](https://github.com/tgreyuk/typedoc-plugin-markdown), and is configured in tsconfig.json @@ -40,7 +39,6 @@ The API output markdown is generated in docs/development/api and is not committed to git, but is shown on the website at [headlamp/latest/development/api](https://headlamp.dev/docs/latest/development/api/) - ## Storybook Components can be discovered, developed, and tested inside the 'storybook'. @@ -72,6 +70,7 @@ components via eslint or via unit tests. Any issues found are reported in the developer console. To enable the alert message during development, use the following: + ```bash REACT_APP_SKIP_A11Y=false make run-frontend ``` diff --git a/docs/development/i18n/contributing.md b/docs/development/i18n/contributing.md index f1a3cf11bb..5044557e3e 100644 --- a/docs/development/i18n/contributing.md +++ b/docs/development/i18n/contributing.md @@ -1,6 +1,6 @@ --- title: Contributing to Internationalization -linkTitle: Contributing +sidebar_label: Contributing --- This section introduces some concepts for contributing translations, and is @@ -17,8 +17,8 @@ be translated and which should be left in the original form. We have only two main [i18next namespaces](https://www.i18next.com/principles/namespaces): -* **glossary**: For Kubernetes jargon or terms/sentences that are very technical. -* **translation**: Default namespace, used for everything else not in the **glossary** namespace. +- **glossary**: For Kubernetes jargon or terms/sentences that are very technical. +- **translation**: Default namespace, used for everything else not in the **glossary** namespace. We do have a third namespace that concerns only the desktop app related strings: **app**. @@ -29,7 +29,7 @@ In Headlamp, namespaces are separated by a `|` character. E.g. `t('glossary|Pod' In order to better express context for a translation, we use the [i18next context](https://www.i18next.com/principles/context) feature. It is used like this: ```typescript - return t('translation|Desired', { context: 'pods' }); +return t("translation|Desired", { context: "pods" }); ``` In the example above, we give the extra context of "pods" for the word "Desired", meaning it refers to the concept of pod, and precisely more than one (in case the target language of @@ -37,15 +37,15 @@ the translation distinguishes between plural and singular for this word). In the translated files, the context will show up in the respective key as: - ```json - "Desired//context:pods": "" - ``` +```json + "Desired//context:pods": "" +``` And should be translated without that context suffix. For example, for Spanish: - ```json - "Desired//context:pods": "Deseados" - ``` +```json + "Desired//context:pods": "Deseados" +``` #### Technical Jargon words @@ -67,7 +67,6 @@ like `1.000.000`. Here is an example which can use number formatting: - ```JavaScript return t('{{numReady, number}} / {{numItems, number}} Requested', { numReady: podsReady.length, @@ -83,7 +82,7 @@ Here's an example of using date formatting: ```Javascript return t('appsection:When {{ date, date }}', { - date: new Date(), + }); ``` @@ -106,13 +105,13 @@ be stored as empty strings (defaulting to English) in the translation files. In order to more easily spot and translate the missing strings, we have two CLI tools: -* *extract-empty-translations.js*: This script (in ./frontend/src/i18n/tools/) +- _extract-empty-translations.js_: This script (in ./frontend/src/i18n/tools/) will extract the strings without a corresponding translation from the translation files, and copy them into a new file. E.g. `$ node copy-empty-translations.js ../locales/de/translation.json` will by default create a `../locales/de/translation_empty.json`. This file can be used to translate the strings in a more isolated way. -* *copy-translations.js*: This script (in ./frontend/src/i18n/tools/) +- _copy-translations.js_: This script (in ./frontend/src/i18n/tools/) by default copies any existing translations from one source translation file to a target one, if the same key is not translated in the destination file. E.g. `$ node copy-translations.js ../locales/de/translation_no_longer_empty.json ../locales/de/translation.json` will diff --git a/docs/development/i18n/_index.md b/docs/development/i18n/index.md similarity index 86% rename from docs/development/i18n/_index.md rename to docs/development/i18n/index.md index 2fbae54471..07d06ce0b3 100644 --- a/docs/development/i18n/_index.md +++ b/docs/development/i18n/index.md @@ -1,6 +1,7 @@ --- title: i18n Internationalization / Localization -linkTitle: Internationalization +sidebar_label: Internationalization +sidebar_position: 5 --- Headlamp's internationalization uses the i18next, i18next-parser, and @@ -27,5 +28,4 @@ One way to change the locale is to use `?lng=en` in the URL. Dynamic imports and the webpack code splitting feature we load locale files from `src/i18n/locales/{{lng}}/{{ns}}.json` -where {{lng}} is the language code, and {{ns}} is the namespace. - +where `{{lng}}` is the language code, and `{{ns}}` is the namespace. diff --git a/docs/development/_index.md b/docs/development/index.md similarity index 95% rename from docs/development/_index.md rename to docs/development/index.md index 92a84e4cfa..64c808e2ab 100644 --- a/docs/development/_index.md +++ b/docs/development/index.md @@ -1,5 +1,6 @@ --- title: Development +sidebar_position: 5 --- This is a quickstart guide for building and running Headlamp for development. @@ -16,7 +17,7 @@ These are the required dependencies to get started. Other dependencies are pulle - [Node.js](https://nodejs.org/en/download/) Latest LTS (20.11.1 at time of writing). Many of us use [nvm](https://github.com/nvm-sh/nvm) for installing multiple versions of Node. - [Go](https://go.dev/doc/install), (1.22 at time of writing) - [Make](https://www.gnu.org/software/make/) (GNU). Often installed by default. On Windows this can be installed with the "chocolatey" package manager that is installed with node. -- [Kubernetes](https://kubernetes.io/), we suggest [minikube](https://minikube.sigs.k8s.io/docs/) as one good K8s installation for testing locally. Other k8s installations are supported (see [platforms](../platforms.md)). +- [Kubernetes](https://kubernetes.io/), we suggest [minikube](https://minikube.sigs.k8s.io/docs/) as one good K8s installation for testing locally. Other k8s installations are supported (see [platforms](../platforms.md). ## Build the code @@ -100,7 +101,6 @@ make app-win-msi See the generated app files in app/dist/ . - ### Running the app on Ubuntu WSL Headlamp on WSL requires some packages installed (maybe it requires more) to run the app. @@ -115,7 +115,6 @@ Some of these are also needed some of them only for the end to end tests. sudo apt-get install firefox libgstreamer-plugins-bad1.0-0 libegl1 libnotify4 libopengl0 libwoff1 libharfbuzz-icu0 libgstreamer-gl1.0-0 libwebpdemux2 libenchant1c2a libsecret-1-0 libhyphen0 libevdev2 libgles2 gstreamer1.0-libav ``` - ## Build a container image The following command builds a container image for Headlamp from the current @@ -128,7 +127,7 @@ make image ### Custom container base images -The Dockerfile takes a build argument for the base image used. You can specify the +The Dockerfile takes a build argument for the base image used. You can specify the base image used using the IMAGE_BASE environment variable with make. ```bash @@ -139,7 +138,7 @@ If no IMAGE_BASE is specified, then a default image is used (see Dockerfile for This is useful if there are requirements on what base images can be used in an environment. -So far Debian variants (including Ubuntu), and Alpine Linux are supported. +So far Debian variants (including Ubuntu), and Alpine Linux are supported. If you have other requirements, please get in touch. ### Running the container image @@ -181,14 +180,14 @@ This is needed because minikube looks for container images in there, not ones made in the local docker environment. ```bash -$ eval $(minikube docker-env) -$ DOCKER_IMAGE_VERSION=development make image +eval $(minikube docker-env) +DOCKER_IMAGE_VERSION=development make image ``` #### Create a deployment yaml. ```bash -$ kubectl create deployment headlamp -n kube-system --image=headlamp-k8s/headlamp:development -o yaml --dry-run -- /headlamp/headlamp-server -html-static-dir /headlamp/frontend -in-cluster -plugins-dir=/headlamp/plugins > minikube-headlamp.yaml +kubectl create deployment headlamp -n kube-system --image=headlamp-k8s/headlamp:development -o yaml --dry-run -- /headlamp/headlamp-server -html-static-dir /headlamp/frontend -in-cluster -plugins-dir=/headlamp/plugins > minikube-headlamp.yaml ``` To use the local container image we change the `imagePullPolicy` to Never. @@ -232,12 +231,12 @@ status: {} Now we create the deployment. ```bash -$ kubectl apply -f minikube-headlamp.yaml +kubectl apply -f minikube-headlamp.yaml ``` Then we expose the deployment, and get a URL where we can see it. -```bash +``` $ kubectl expose deployment headlamp -n kube-system --type=NodePort --port=4466 service/headlamp exposed @@ -272,7 +271,7 @@ as well as showing the release notes after updating to a new version. This behavior can be turned off by adding the following to a `.env` file in the `app/` folder: -``` +```bash HEADLAMP_CHECK_FOR_UPDATES=false ``` diff --git a/docs/development/oidc.md b/docs/development/oidc.md index c5e25828df..b91a877706 100644 --- a/docs/development/oidc.md +++ b/docs/development/oidc.md @@ -1,6 +1,6 @@ --- title: Testing OIDC -weight: 5 +sidebar_position: 4 --- OIDC (OpenID Connect) is a protocol that allows web applications to authenticate users through an identity provider and obtain basic profile information about the user. diff --git a/docs/development/plugins/building.md b/docs/development/plugins/building.md index f8c4e80e85..8670df89bf 100644 --- a/docs/development/plugins/building.md +++ b/docs/development/plugins/building.md @@ -1,6 +1,6 @@ --- title: Building and Shipping Plugins -linktitle: Building & Shipping +sidebar_label: Building & Shipping --- This section explains how to start developing a Headlamp plugin, and how @@ -19,7 +19,7 @@ npm run start There's some basic code inside src/index.tsx. Now run Headlamp (the desktop app or the -[development version](../_index.md#run-the-code)), +[development version](../index.md#run-the-code)), and your plugin should be loaded. Using the above commands means that Headlamp will **automatically reload** @@ -78,7 +78,7 @@ This will create a file with the bundled plugin in ### Building a folder of packages at once -For convienience the `headlamp-plugin build` command can build a +For convienience the `headlamp-plugin build` command can build a package or folder of packages. ```bash @@ -94,15 +94,15 @@ be placed in a "plugins directory", for Headlamp to load them. For example, if we have built 3 plugins called MyPlugin1, MyPlugin2, and MyPlugin3, they should be added to a directory in the following structure: - ``` - .plugins/ - MyPlugin1/ - main.js - MyPlugin2/ - main.js - MyPlugin3/ - main.js - ``` +``` +.plugins/ + MyPlugin1/ + main.js + MyPlugin2/ + main.js + MyPlugin3/ + main.js +``` If our plugins are places in `myplugins`, we can conveniently create that folder with the following command: @@ -112,6 +112,7 @@ npx @kinvolk/headlamp-plugin extract ./myplugins /path/to/.plugins ``` This also works individually (for each plugin): + ```bash npx @kinvolk/headlamp-plugin extract ./myplugins/MyPlugin1 /path/to/./plugins ``` @@ -133,7 +134,7 @@ or within the current folder as `.plugins` if the former doesn't exist. ### Bundling plugins with desktop version -To build a Headlamp app with a set of plugins, first extract some plugins +To build a Headlamp app with a set of plugins, first extract some plugins into the .plugins folder in the root of the "headlamp" repo. ```bash @@ -158,11 +159,11 @@ for more information on building a container image with your plugins. ## Writing storybook stories -What is a storybook story? +What is a storybook story? From https://storybook.js.org/docs/web-components/get-started/introduction -> Storybook is a tool for UI development. It makes development faster and +> Storybook is a tool for UI development. It makes development faster and > easier by isolating components. This allows you to work on one component > at a time. You can develop entire UIs without needing to start up a > complex dev stack, force certain data into your database, @@ -179,7 +180,7 @@ $ npm run storybook ``` Your browser should open and show you a Message component with three -different states the component can be in. +different states the component can be in. Notices that there is a Message.stories.tsx to go along with the Message.tsx which has the `` component defined within it. See that file for an @@ -187,13 +188,13 @@ example of how to write a story. ### Snapshot testing -Another benefit of writing storybook stories is that they can act as -unit tests for regression testing. With storyshots it will save snapshots -of html for the different states that a component can be in. See the +Another benefit of writing storybook stories is that they can act as +unit tests for regression testing. With storyshots it will save snapshots +of html for the different states that a component can be in. See the [Snapshot tests](https://storybook.js.org/docs/react/writing-tests/snapshot-testing) guide in the storybook documentation for more information. -This is in addition to the benefit of making sure your components can be +This is in addition to the benefit of making sure your components can be manually tested and developed quickly in isolation. See the [storybook documentation](https://storybook.js.org/docs/) for full @@ -212,13 +213,12 @@ name: Headlamp plugin linting, type checking, and testing on: push: - branches: [ main ] + branches: [main] pull_request: - branches: [ main ] + branches: [main] jobs: build: - runs-on: ubuntu-latest defaults: @@ -244,14 +244,13 @@ jobs: Please see the github documentation for further details on workflows and actions. - ## Upgrading package There's a command which handles much of upgrading plugins to the latest headlamp-plugin version. This upgrade command also audits packages, formats code, lints and type checks. Additionally this handles some code changes needed for plugins. For example, it handles running the material-ui 4 to mui 5 'codemod' code changes, and creates missing configuration added in different versions of headlamp-plugin. -Testing is necessary after running the upgrade command. +Testing is necessary after running the upgrade command. Of course make sure you have a backup of your plugin folder before running it. ```bash diff --git a/docs/development/plugins/functionality.md b/docs/development/plugins/functionality.md index 10e2987656..0a645e4cc3 100644 --- a/docs/development/plugins/functionality.md +++ b/docs/development/plugins/functionality.md @@ -1,6 +1,6 @@ --- title: Plugins Functionality -linktitle: Functionality +sidebar_label: Functionality --- Headlamp's plugins exist for changing or adding functionality related to @@ -40,12 +40,12 @@ These are: Thus, plugins only need to install dependencies that are not yet provided by Headlamp. Yet, if any dependencies already covered by Headlamp are installed by the plugins, you just need to make sure they are the same version that Headlamp supports, as these will -not be bundled when [building the plugin](../building.md). +not be bundled when [building the plugin](./building.md). Particularly, the mentioned modules will be replaced by their version that's included in a global objects called `pluginLib`. Older plugin development guides still asked developers to use e.g. React in the following -way `const React = window.pluginLib.React`, but this is no longer needed. +way `const React: window.pluginLib.React`, but this is no longer needed. ## Functionality @@ -61,7 +61,7 @@ Show a component in the app bar (in the top right) with ![screenshot of the header showing two actions](./images/podcounter_screenshot.png) -- Example plugin shows [How To Register an App Bar Action](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/pod-counter) +- Example plugin shows [How To Register an App Bar Action](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/pod-counter) - API reference for [registerAppBarAction](../api/modules/plugin_registry.md#registerappbaraction) ### App Logo @@ -71,18 +71,18 @@ Change the logo (at the top left) with ![screenshot of the logo being changed](./images/change-logo.png) -- Example plugin shows [How To Change The Logo](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/change-logo) +- Example plugin shows [How To Change The Logo](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/change-logo) - API reference for [registerAppLogo](../api/modules/plugin_registry.md#registerapplogo) ### App Menus Add menus when Headlamp is running as an app. -[Headlamp.setAppMenu](../api/classes/plugin_lib.Headlamp.md/#setappmenu) +[Headlamp.setAppMenu](../api/classes/plugin_lib.Headlamp.md#setappmenu) ![screenshot of the logo being changed](./images/app-menus.png) -- Example plugin shows [How To Add App Menus](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/app-menus) -- API reference for [Headlamp.setAppMenu](../api/classes/plugin_lib.Headlamp.md/#setappmenu) +- Example plugin shows [How To Add App Menus](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/app-menus) +- API reference for [Headlamp.setAppMenu](../api/classes/plugin_lib.Headlamp.md#setappmenu) ### Cluster Chooser @@ -91,7 +91,7 @@ Change the Cluster Chooser button (in the middle top of the Headlamp app bar) wi ![screenshot of the cluster chooser button](./images/cluster-chooser.png) -- Example plugin shows [How To Register Cluster Chooser button](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/clusterchooser) +- Example plugin shows [How To Register Cluster Chooser button](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/clusterchooser) - API reference for [registerClusterChooser](../api/modules/plugin_registry.md#registerclusterchooser) ### Details View Header Action @@ -102,19 +102,19 @@ Show a component to the top right area of a detail view ![screenshot of the header showing two actions](./images/header_actions_screenshot.png) -- Example plugin shows [How To set a Details View Header Action](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/details-view) +- Example plugin shows [How To set a Details View Header Action](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/details-view) - API reference for [registerDetailsViewHeaderAction](../api/modules/plugin_registry.md#registerdetailsviewheaderaction) ### Details View Section -Change sections in cluster resources' details views with [registerDetailsViewSectionsProcessor](../api/modules/plugin_registry.md#registerDetailsViewSectionsProcessor). This allows you to remove, add, update, or shuffle sections within details views, including the back link. +Change sections in cluster resources' details views with [registerDetailsViewSectionsProcessor](../api/modules/plugin_registry.md#registerdetailsviewsectionsprocessor). This allows you to remove, add, update, or shuffle sections within details views, including the back link. Or simply append a component at the bottom of different details views with [registerDetailsViewSection](../api/modules/plugin_registry.md#registerdetailsviewsection). ![screenshot of the appended Details View Section](./images/details-view.jpeg) -- Example plugin shows [How To set a Details View Section](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/details-view) +- Example plugin shows [How To set a Details View Section](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/details-view) - API reference for [registerDetailsViewSection](../api/modules/plugin_registry.md#registerdetailsviewsection) ### Dynamic Clusters @@ -122,7 +122,7 @@ Or simply append a component at the bottom of different details views with Set a cluster dynamically, rather than have the backend read it from configuration files. [Headlamp.setCluster](../api/classes/plugin_lib.Headlamp.md#setcluster). -- Example plugin shows [How To Dynamically Set a Cluster](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/dynamic-clusters) +- Example plugin shows [How To Dynamically Set a Cluster](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/dynamic-clusters) - API reference for [Headlamp.setCluster](../api/classes/plugin_lib.Headlamp.md#setcluster) ### Route @@ -130,11 +130,10 @@ Set a cluster dynamically, rather than have the backend read it from configurati Show a component (in Headlamps main area) at a given URL with [registerRoute](../api/modules/plugin_registry.md#registerroute). -- Example plugin shows [How To Register a Route](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/sidebar), and how to remove a route. +- Example plugin shows [How To Register a Route](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/sidebar), and how to remove a route. - API reference for [registerRoute](../api/modules/plugin_registry.md#registerroute) - API reference for [registerRouteFilter](../api/modules/plugin_registry.md#registerroutefilter) - ### Sidebar Item Add sidebar items (menu on the left) with @@ -143,7 +142,7 @@ Remove sidebar items with [registerSidebarEntryFilter](../api/modules/plugin_reg ![screenshot of the sidebar being changed](./images/sidebar.png) -- Example plugin shows [How To add items to the sidebar](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/sidebar), and also how to remove sidebar items. +- Example plugin shows [How To add items to the sidebar](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/sidebar), and also how to remove sidebar items. - API reference for [registerSidebarEntry](../api/modules/plugin_registry.md#registersidebarentry) - API reference for [registerSidebarEntryFilter](../api/modules/plugin_registry.md#registersidebarentryfilter) @@ -153,7 +152,7 @@ Change what tables across Headlamp show with [registerResourceTableColumnsProces ![screenshot of the pods list with a context menu added by a plugin](./images/table-context-menu.png) -- Example plugin shows [How to add a context menu to each row in the pods list table](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/tables). +- Example plugin shows [How to add a context menu to each row in the pods list table](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/tables). - API reference for [registerResourceTableColumnsProcessor](../api/modules/plugin_registry.md#registerresourcetablecolumnsprocessor) ### Headlamp Events @@ -164,14 +163,13 @@ React to Headlamp events with [registerHeadlampEventCallback](../api/modules/plu ![screenshot of a snackbar notification when an event occurred](./images/event-snackbar.png) -- Example plugin shows [How to show snackbars for Headlamp events](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/headlamp-events). +- Example plugin shows [How to show snackbars for Headlamp events](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/headlamp-events). - API reference for [registerHeadlampEventCallback](../api/modules/plugin_registry.md#registerheadlampeventcallback) - ### Plugin Settings The plugins can have user configurable settings that can be used to change the behavior of the plugin. The plugin settings can be created using [registerPluginSettings](../api/modules/plugin_registry.md#registerpluginsettings). -- Example plugin shows [How to create plugin settings and use them](https://github.com/kinvolk/headlamp/tree/main/plugins/examples/change-logo) +- Example plugin shows [How to create plugin settings and use them](https://github.com/headlamp-k8s/headlamp/tree/main/plugins/examples/change-logo) -![screenshot of the plugin settings](./images/plugin-settings.png) \ No newline at end of file +![screenshot of the plugin settings](./images/plugin-settings.png) diff --git a/docs/development/plugins/how-to.md b/docs/development/plugins/how-to.md index b301872316..daed1a8b26 100644 --- a/docs/development/plugins/how-to.md +++ b/docs/development/plugins/how-to.md @@ -1,13 +1,12 @@ --- title: How to create a Plugin -linktitle: How-to --- This section will walk you through a basic plugin development. ## Types -If you are using Typescript for developing the plugin, the +If you are using Typescript for developing the plugin, the `@kinvolk/headlamp-plugin` package does ship some type declarations in `@kinvolk/headlamp-plugin/types`. Please notice that the whole external plugin mechanics are still in an early development phase and thus only the @@ -20,8 +19,8 @@ The following example will show a basic plugin declaration and registration in a file that should match the `src/index.tsx` structure explained in the [building](./building) section. -```tsx -import { registerAppBarAction } from '@kinvolk/headlamp-plugin/lib'; +```tsx title="/src/index.tsx" +import { registerAppBarAction } from "@kinvolk/headlamp-plugin/lib"; registerAppBarAction(Hello Kubernetes); ``` @@ -30,13 +29,13 @@ registerAppBarAction(Hello Kubernetes); Let's create a plugin that just gets the number of pods in the cluster and displays that information in the top bar (i.e. registers an "app bar action"). -```tsx +```tsx title="/src/index.tsx" import { K8s, registerAppBarAction } from '@kinvolk/headlamp-plugin/lib'; import { Typography } from '@mui/material'; function PodCounter() { - const [pods, error] = K8s.ResourceClasses.Pod.useList(); - const msg = pods === null ? 'Loading…' : pods.length.toString(); + const [pods, error]: K8s.ResourceClasses.Pod.useList(); + const msg: pods === null ? 'Loading…' : pods.length.toString(); return ( diff --git a/docs/development/plugins/_index.md b/docs/development/plugins/index.md similarity index 88% rename from docs/development/plugins/_index.md rename to docs/development/plugins/index.md index 21a923ceeb..93a725e74a 100644 --- a/docs/development/plugins/_index.md +++ b/docs/development/plugins/index.md @@ -1,11 +1,11 @@ --- title: Plugins -linkTitle: Plugins +sidebar_position: 6 --- Plugins are one of the key features of Headlamp. They allow you to change how and what information is displayed, as well as other functionality. The ultimate goal of the plugins system is to allow vendors to build and deploy Headlamp with extra functionality without having to maintain a fork of the project. -# Using plugins +## Using plugins Headlamp looks for plugins in different places. It looks at the Headlamp's configuration folder first: @@ -27,10 +27,10 @@ MyPlugin3/ main.js ``` -See the [shipping & deploying plugins](./building.md#shipping--deploying-plugins) section +See the [shipping & deploying plugins](./building.md#shipping-and-deploying-plugins) section for more details. -# Developing Plugins +## Developing Plugins Plugins are supposed to be built and shipped out-of-tree, i.e. instead of managing the plugins' code within the Headlamp project or a Headlamp fork (which would require diff --git a/docs/development/testing.md b/docs/development/testing.md index 7ba1767c53..807720e524 100644 --- a/docs/development/testing.md +++ b/docs/development/testing.md @@ -1,6 +1,6 @@ --- title: Testing -weight: 5 +sidebar_position: 3 --- ## Load testing Headlamp @@ -18,9 +18,9 @@ Steps: - Create load in a cluster - Run Headlamp and see if it works well compared to low load - - performance profiles - - CPU/memory usage - - feel + - performance profiles + - CPU/memory usage + - feel ### Kwok for low resource usage load testing of Headlamp @@ -71,7 +71,7 @@ node scripts/create-events.js 9000 1 & node scripts/create-nodes.js 100 1 & node #### Cleaning up clusters -Kwok clusters can take up a lot of resources even doing nothing, +Kwok clusters can take up a lot of resources even doing nothing, due to the Kubernetes API server using resources even when idle. So when you're done, you can delete them like this. diff --git a/docs/faq.md b/docs/faq.md index dc2f32c213..eaf97f4a07 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,89 +1,90 @@ --- -Title: Frequently Asked Questions +title: Frequently Asked Questions +sidebar_position: 5 --- ## General Questions -### Q: What is Headlamp and who is it for? +### What is Headlamp and who is it for? -**A:** Headlamp is a graphical user interface specifically tailored for simplifying the management of Kubernetes clusters. +Headlamp is a graphical user interface specifically tailored for simplifying the management of Kubernetes clusters. -### Q: What Kubernetes flavors or vendors does Headlamp support? +### What Kubernetes flavors or vendors does Headlamp support? -A: Headlamp is designed to be vendor-agnostic, supporting a variety of Kubernetes flavors. For a comprehensive list of compatible platforms please refer to our [platforms section in the documentation](./docs/platforms.md). +Headlamp is designed to be vendor-agnostic, supporting a variety of Kubernetes flavors. For a comprehensive list of compatible platforms please refer to our [platforms section in the documentation](./platforms.md). -### Q: Is Headlamp a desktop or web application? +### Is Headlamp a desktop or web application? -**A:** Headlamp is available both as a desktop application and a web application. The desktop version can be installed on your local machine and the web version can be accessed through a browser. +Headlamp is available both as a desktop application and a web application. The desktop version can be installed on your local machine and the web version can be accessed through a browser. -### Q: Is there any cost involved in using Headlamp? +### Is there any cost involved in using Headlamp? -**A:** Headlamp a 100% open source project, under the Apache 2.0 License. It is thus available at no charge, and users are encouraged to modify and redistribute it in accordance with the license terms. +Headlamp a 100% open source project, under the Apache 2.0 License. It is thus available at no charge, and users are encouraged to modify and redistribute it in accordance with the license terms. -### Q: Can I use Headlamp for commercial purposes? +### Can I use Headlamp for commercial purposes? -**A:** Yes, and it's encouraged. Headlamp is developed under the permissive Apache 2.0 License making it ideal for personal and commercial use. +Yes, and it's encouraged. Headlamp is developed under the permissive Apache 2.0 License making it ideal for personal and commercial use. -### Q: Where can I find the source code for Headlamp? +### Where can I find the source code for Headlamp? -**A:** The source code for Headlamp is publicly available on [GitHub](https://github.com/headlamp-k8s/headlamp). You are welcome to explore, fork, and contribute to the codebase. +The source code for Headlamp is publicly available on [GitHub](https://github.com/headlamp-k8s/headlamp). You are welcome to explore, fork, and contribute to the codebase. -### Q: Who maintains Headlamp? +### Who maintains Headlamp? -**A:** You can find the list of Headlamp's maintainers in its [MAINTAINERS.md](https://github.com/headlamp-k8s/headlamp/blob/main/MAINTAINERS.md) file in the repository. As a 100% open source project and a CNCF Sandbox project, Headlamp encourages any users/developers to participate in it. +You can find the list of Headlamp's maintainers in its [MAINTAINERS.md](https://github.com/headlamp-k8s/headlamp/blob/main/MAINTAINERS.md) file in the repository. As a 100% open source project and a CNCF Sandbox project, Headlamp encourages any users/developers to participate in it. -### Q: What capabilities / credentials does Headlamp require to access my Kubernetes cluster? +### What capabilities / credentials does Headlamp require to access my Kubernetes cluster? -**A:** Headlamp doesn't require access to the cluster in itself. It instead relies to RBAC when connecting to the Kubernetes API server, meaning that it's the users that are required the credentials to access the cluster (via a service token or client certificate). Headlamp may store the token in the browser's local storage, but never in its backend/server. +Headlamp doesn't require access to the cluster in itself. It instead relies to RBAC when connecting to the Kubernetes API server, meaning that it's the users that are required the credentials to access the cluster (via a service token or client certificate). Headlamp may store the token in the browser's local storage, but never in its backend/server. -### Q: Is Headlamp customizable? +### Is Headlamp customizable? -**A:** Yes, Headlamp is highly customizable, thanks to its robust plugin system. This system allows for the extension of Headlamp's core functionalities, catering to specific use cases and workflows. For more information on creating and managing plugins, visit our [plugins page](./development/plugins/building.md). +Yes, Headlamp is highly customizable, thanks to its robust plugin system. This system allows for the extension of Headlamp's core functionalities, catering to specific use cases and workflows. For more information on creating and managing plugins, visit our [plugins page](./development/plugins/building.md). -### Q: How often is Headlamp updated? +### How often is Headlamp updated? -**A:** Headlamp tries to have a new features version released every month. Sometimes, there may be delays for a couple of weeks. Bug fix versions can be released in between feature versions, whenever appropriate (releases fixing critical bugs are often released quickly after a fix is added). +Headlamp tries to have a new features version released every month. Sometimes, there may be delays for a couple of weeks. Bug fix versions can be released in between feature versions, whenever appropriate (releases fixing critical bugs are often released quickly after a fix is added). --- ## Installation and Setup -### Q: How can I install and access Headlamp? +### How can I install and access Headlamp? -**A:** To install Headlamp, follow the detailed instructions provided in the [official installation guide](./installation/_index.md). The process will guide you through downloading the application, setting up your Kubernetes cluster access, and launching Headlamp to connect to your cluster. For desktop applications, you can find additional information in the [desktop installation guide](./installation/desktop/_index.md). +To install Headlamp, follow the detailed instructions provided in the [official installation guide](./installation/index.mdx). The process will guide you through downloading the application, setting up your Kubernetes cluster access, and launching Headlamp to connect to your cluster. For desktop applications, you can find additional information in the [desktop installation guide](./installation/desktop/index.mdx). -### Q: Can I install Headlamp in my Kubernetes cluster? +### Can I install Headlamp in my Kubernetes cluster? -**A:** Absolutely, Headlamp can be deployed directly within your Kubernetes cluster. Detailed instructions for in-cluster installation can be found in the [in-cluster installation guide](./installation/in-cluster/_index.md). +Absolutely, Headlamp can be deployed directly within your Kubernetes cluster. Detailed instructions for in-cluster installation can be found in the [in-cluster installation guide](./installation/in-cluster/index.md). --- ## Usage and Features -### Q: Can I monitor multiple clusters with Headlamp? +### Can I monitor multiple clusters with Headlamp? -**A:** Yes, Headlamp allows you to monitor multiple clusters. You can switch between different clusters using the cluster switcher in the Headlamp interface. +Yes, Headlamp allows you to monitor multiple clusters. You can switch between different clusters using the cluster switcher in the Headlamp interface. -### Q: Can I manage my Kubernetes resources directly through Headlamp? +### Can I manage my Kubernetes resources directly through Headlamp? -**A:** Yes, Headlamp enables direct management of Kubernetes resources through its user interface as allowed by the user's role and permissions. +Yes, Headlamp enables direct management of Kubernetes resources through its user interface as allowed by the user's role and permissions. -### Q: Headlamp is not showing delete/edit/scale buttons in a resource, why is that? +### Headlamp is not showing delete/edit/scale buttons in a resource, why is that? -**A:** Headlamp shows controls based on the user's role (RBAC), so if the user has e.g. no permissions to delete a resource, the delete button is not shown. +Headlamp shows controls based on the user's role (RBAC), so if the user has e.g. no permissions to delete a resource, the delete button is not shown. -### Q: I cannot access any section in my cluster, it keeps saying Access Denied. +### I cannot access any section in my cluster, it keeps saying Access Denied. -**A:** By default, Headlamp assumes users can list all namespaces. If you only have the permissions to list resources in certain namespaces, please access the cluster settings and set up the accessible namespaces. +By default, Headlamp assumes users can list all namespaces. If you only have the permissions to list resources in certain namespaces, please access the cluster settings and set up the accessible namespaces. -### Q: How do I add or remove plugins in Headlamp? +### How do I add or remove plugins in Headlamp? -**A:** To add or remove plugins in Headlamp, you can follow the plugin management instructions provided in the [Headlamp plugin documentation](./development/plugins/_index.md). +To add or remove plugins in Headlamp, you can follow the plugin management instructions provided in the [Headlamp plugin documentation](./development/plugins/index.md). -### Q: Is there a way to contribute to the development of Headlamp features? +### Is there a way to contribute to the development of Headlamp features? -**A:** Absolutely! As an open-source project, Headlamp thrives on community contributions. You can contribute in various ways, including submitting pull requests, creating plugins, reporting issues, and suggesting new features. For more details on how to get involved, visit our [contribution section](./contributing.md). +Absolutely! As an open-source project, Headlamp thrives on community contributions. You can contribute in various ways, including submitting pull requests, creating plugins, reporting issues, and suggesting new features. For more details on how to get involved, visit our [contribution section](./contributing.md). -### Q: How can I get help or assistance for Headlamp? +### How can I get help or assistance for Headlamp? -**A:** For support, refer to the [Headlamp documentation](./development/_index.md). For further assistance, join the [Headlamp community on Slack](https://kubernetes.slack.com/messages/headlamp) or file an issue on the [GitHub issues page](https://github.com/headlamp-k8s/headlamp/issues). +For support, refer to the [Headlamp documentation](./development/index.md). For further assistance, join the [Headlamp community on Slack](https://kubernetes.slack.com/messages/headlamp) or file an issue on the [GitHub issues page](https://github.com/headlamp-k8s/headlamp/issues). diff --git a/docs/_index.md b/docs/index.md similarity index 94% rename from docs/_index.md rename to docs/index.md index f4dd3aa469..700279cce1 100644 --- a/docs/_index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- -title: Headlamp +title: Introduction +sidebar_position: 1 --- Headlamp is an easy-to-use and extensible Kubernetes web UI. @@ -21,3 +22,4 @@ in the Kubernetes Slack. ## Frequently Asked Questions For more information about Headlamp, see the [Headlamp FAQ](./faq.md). + diff --git a/docs/installation/base-url.md b/docs/installation/base-url.md index f914e575e8..8ebbfc569d 100644 --- a/docs/installation/base-url.md +++ b/docs/installation/base-url.md @@ -1,14 +1,14 @@ --- title: Run Headlamp with a base-url -linkTitle: Base URL +sidebar_label: Base URL +sidebar_position: 3 --- -Normally Headlamp runs at the root of the domain. Hower you can also ask +Normally Headlamp runs at the root of the domain. Hower you can also ask to run it at a base-url like "/headlamp" for example. - default at the root of the domain: `https://headlamp.example.com/`. -- base-url `https://example.com/headlamp/` - +- base-url `https://example.com/headlamp/` ## A warning about multiple apps on the same sub domain @@ -16,10 +16,8 @@ Hosting multiple websites (apps) on the [same origin](https://developer.mozilla. If in doubt, host Headlamp on a separate origin (domain or port, don't use the `-base-url` option). - ## How to use with a base-url - ### Dev mode ```bash @@ -29,7 +27,6 @@ PUBLIC_URL="/headlamp" make run-frontend Then go to http://localhost:3000/headlamp/ in your browser. - ### Static build mode ```bash @@ -39,20 +36,18 @@ cd frontend && npm install && npm run build && cd .. Then go to http://localhost:4466/headlamp/ in your browser. - ### Docker mode Append `--base-url /headlamp` to the docker run command. Note the extra "-". - ### Kubernetes You can modify your kubernetes deployment file to add `-base-url /headlamp` to the containers args. ```yaml - args: - - "-in-cluster" - - "-plugins-dir=/headlamp/plugins" - - "-base-url=/headlamp" +args: + - "-in-cluster" + - "-plugins-dir=/headlamp/plugins" + - "-base-url=/headlamp" ``` diff --git a/docs/installation/desktop/headless.md b/docs/installation/desktop/headless.md deleted file mode 100644 index c18170516c..0000000000 --- a/docs/installation/desktop/headless.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Running in headless mode -linktitle: Headless Mode -weight: 50 ---- - -Some users prefer running Headlamp using the desktop app, but directly in their web browser instead -of the Electron's environment as this allows them to leverage the browser's functionality such as -bookmarks, groups, etc. - -Running Headlamp in the system's browser can be done by using the `--headless` CLI option. -Assuming you have already downloaded and installed Headlamp on your desktop, you can run it in headless mode as follows: - -Example: - - On Linux: `flatpak run io.kinvolk.Headlamp --headless` (or `./Headlamp.AppImage --headless` for AppImage) - - On MacOS: `./Headlamp --headless` - - On Windows: `./Headlamp.exe --headless` diff --git a/docs/installation/desktop/headless.mdx b/docs/installation/desktop/headless.mdx new file mode 100644 index 0000000000..c73203109c --- /dev/null +++ b/docs/installation/desktop/headless.mdx @@ -0,0 +1,37 @@ +--- +title: Running in headless mode +sidebar_label: Headless Mode +sidebar_position: 4 +--- + +Some users prefer running Headlamp using the desktop app, but directly in their web browser instead +of the Electron's environment as this allows them to leverage the browser's functionality such as +bookmarks, groups, etc. + +Running Headlamp in the system's browser can be done by using the `--headless` CLI option. +Assuming you have already downloaded and installed Headlamp on your desktop, you can run it in headless mode as follows: + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + ```bash + flatpak run io.kinvolk.Headlamp --headless + ``` + or + ```bash + ./Headlamp.AppImage --headless # for AppImage + ``` + + + ```bash + ./Headlamp --headless + ``` + + + ```powershell + ./Headlamp.exe --headless + ``` + + diff --git a/docs/installation/desktop/_index.md b/docs/installation/desktop/index.mdx similarity index 78% rename from docs/installation/desktop/_index.md rename to docs/installation/desktop/index.mdx index fe2e9b533d..727af728c9 100644 --- a/docs/installation/desktop/_index.md +++ b/docs/installation/desktop/index.mdx @@ -1,6 +1,6 @@ --- -title: Desktop App Installation -weight: 100 +title: Desktop App +sidebar_position: 2 --- Headlamp can be run as a desktop application, for users who don't want to @@ -10,6 +10,10 @@ Currently there are desktop apps for [Linux](./linux-installation.md), [Mac](./m Please check the following guides for the installation in your desired platform. +import DocCardList from '@theme/DocCardList'; + + + ## Use a non-default kube config file If you wish to use a non-default kube config file, then you can do it by @@ -30,15 +34,23 @@ KUBECONFIG=/my/different/kubeconfig /path/to/headlamp If you need to use more than one kube config file at the same time, you can list each config file path with a separator. -On unix: -```bash -KUBECONFIG=kubeconfig1:kubeconfig2:kubeconfig3 /path/to/headlamp -``` +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + ```bash + KUBECONFIG=kubeconfig1:kubeconfig2:kubeconfig3 /path/to/headlamp + ``` + + + ```powershell + KUBECONFIG=kubeconfig1;kubeconfig2;kubeconfig3 /path/to/headlamp + ``` + + + -On windows cmd/PowerShell: -``` -KUBECONFIG=kubeconfig1;kubeconfig2;kubeconfig3 /path/to/headlamp -``` ## Access using OIDC diff --git a/docs/installation/desktop/linux-installation.md b/docs/installation/desktop/linux-installation.md index 309ba40450..f99b9ad631 100644 --- a/docs/installation/desktop/linux-installation.md +++ b/docs/installation/desktop/linux-installation.md @@ -1,7 +1,7 @@ --- title: Linux Installation -linktitle: Linux -weight: 15 +sidebar_label: Linux +sidebar_position: 1 --- We ship Headlamp the Linux desktop in several formats: [Flatpak](#flatpak), [AppImage](#appimage), [Tarballs](#tarballs). @@ -25,6 +25,7 @@ flatpak run io.kinvolk.Headlamp ### Upgrading To upgrading Headlamp when it's installed via Flatpak, run: + ```bash flatpak update io.kinvolk.Headlamp ``` @@ -44,6 +45,7 @@ You can then run it with the following command (examplified for the AMD64, 0.16. To run Headlamp from one of the tarballs, after downloading the tarball for the [latest release](https://github.com/headlamp-k8s/headlamp/releases/latest), you have to extract the contents from it and run the `headlamp` binary in the resulting folder (examplified below for the AMD64, 0.16.0 version): + ```bash tar xvzf ./Headlamp-0.16.0-linux-x64.tar.gz cd Headlamp-0.16.0-linux-x64 diff --git a/docs/installation/desktop/mac-installation.md b/docs/installation/desktop/mac-installation.md index 9047a865b9..246c5239c6 100644 --- a/docs/installation/desktop/mac-installation.md +++ b/docs/installation/desktop/mac-installation.md @@ -1,7 +1,7 @@ --- title: Mac OS Installation -linktitle: Mac OS -weight: 20 +sidebar_label: Mac OS +sidebar_position: 2 --- ## Install via Homebrew @@ -15,6 +15,7 @@ brew install --cask headlamp ### Upgrading To upgrade Headlamp when it's installed via Homebrew, run: + ```sh brew upgrade headlamp ``` @@ -24,7 +25,7 @@ read the [official documentation](https://docs.brew.sh/Manpage). ## Install via Github Releases -For Mac OS we provide a _.dmg_ file, so you need to download it from the [releases page](https://github.com/kinvolk/headlamp/releases) +For Mac OS we provide a _.dmg_ file, so you need to download it from the [releases page](https://github.com/headlamp-k8s/headlamp/releases) and then follow the below steps : 1. Double click the downloaded file to make its content available (name will show up in the Finder sidebar), usually a window opens showing the content as well @@ -34,4 +35,4 @@ Once the installation process is completed you can find Headlamp as a desktop ap ### Upgrading -Until we have an automatic update, to upgrade Headlamp when it's installed directly via the releases page, you have to download any newer version and re-install it. \ No newline at end of file +Until we have an automatic update, to upgrade Headlamp when it's installed directly via the releases page, you have to download any newer version and re-install it. diff --git a/docs/installation/desktop/win-installation.md b/docs/installation/desktop/win-installation.md index 55aea52b61..cb53b099cc 100644 --- a/docs/installation/desktop/win-installation.md +++ b/docs/installation/desktop/win-installation.md @@ -1,15 +1,16 @@ --- title: Windows Installation -linktitle: Windows -weight: 20 +sidebar_label: Windows +sidebar_position: 3 --- -Headlamp is available for Windows as a direct download from its [releases page](https://github.com/kinvolk/headlamp/releases) on Github (.exe file) and from package registries +Headlamp is available for Windows as a direct download from its [releases page](https://github.com/headlamp-k8s/headlamp/releases) on Github (.exe file) and from package registries like [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/) and [Chocolatey](https://chocolatey.org/). ## Install via Winget To install Headlamp from the Winget registry. Simply run the following command: + ```powershell winget install headlamp ``` @@ -17,16 +18,17 @@ winget install headlamp ### Upgrading To upgrade Headlamp when its installed with Winget, run the command: + ```powershell winget upgrade headlamp ``` - ## Install via Chocolatey To install Headlamp from the Chocolatey registry, first install the choco command by following its [official instructions](https://chocolatey.org/install#generic). After `choco` is available, [install Headlamp](https://community.chocolatey.org/packages/headlamp#install) by running the following command: + ```powershell choco install headlamp ``` @@ -34,6 +36,7 @@ choco install headlamp ### Upgrading To upgrade Headlamp when its installed with Chocolatey, run the command: + ```powershell choco upgrade headlamp ``` @@ -45,4 +48,4 @@ To install Headlamp from its official installer, first download the _.exe_ file ### Upgrading Until we have an automatic update, to upgrade Headlamp when it's installed directly from its -installer, you have to download the new version of the installer and re-install it. \ No newline at end of file +installer, you have to download the new version of the installer and re-install it. diff --git a/docs/installation/in-cluster/dex/_index.md b/docs/installation/in-cluster/dex/index.md similarity index 86% rename from docs/installation/in-cluster/dex/_index.md rename to docs/installation/in-cluster/dex/index.md index 4aa2ceb0eb..f5afa6bb4c 100644 --- a/docs/installation/in-cluster/dex/_index.md +++ b/docs/installation/in-cluster/dex/index.md @@ -1,21 +1,18 @@ --- title: How to Set Up Headlamp in minikube with Dex OIDC Authentication -linktitle: 'Tutorial: OIDC with Dex' +sidebar_label: "Tutorial: OIDC with Dex" --- In this tutorial, we'll walk through the process of configuring Headlamp within a Minikube cluster while utilizing Dex for OIDC (OpenID Connect) authentication. This tutorial is based on Dex version 2.38.0, Minikube version v1.31.2, and Headlamp version 0.22.0. - ## Configuring Dex To enable OIDC authentication in your Minikube cluster, you'll need to configure Dex. Before proceeding, follow the [getting started guide](https://dexidp.io/docs/getting-started/) to set up your Dex instance.Follow these steps to configure Dex: -1. Create a Dex configuration file. The following example demonstrates a basic configuration file for Dex, containing a -static client, connector, and static password. - -**dex-config.yaml** +1. Create a Dex configuration file. The following example demonstrates a basic configuration file for Dex, containing a + static client, connector, and static password. -```yaml +```yaml title="dex-config.yaml" issuer: storage: @@ -25,27 +22,28 @@ web: http: 0.0.0.0:5556 staticClients: -- id: example-app - redirectURIs: - - 'http://localhost:8000' - name: 'Example App' - secret: ZXhhbXBsZS1hcHAtc2VjcmV0 + - id: example-app + redirectURIs: + - "http://localhost:8000" + name: "Example App" + secret: ZXhhbXBsZS1hcHAtc2VjcmV0 connectors: -- type: mockCallback - id: mock - name: Example + - type: mockCallback + id: mock + name: Example # Let dex keep a list of passwords which can be used to login to dex. enablePasswordDB: true staticPasswords: -- email: "admin@example.com" - # bcrypt hash of the string "password": $(echo password | htpasswd -BinC 10 admin | cut -d: -f2) - hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W" - username: "admin" - userID: "08a8684b-db88-4b73-90a9-3cd1661f5466" + - email: "admin@example.com" + # bcrypt hash of the string "password": $(echo password | htpasswd -BinC 10 admin | cut -d: -f2) + hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W" + username: "admin" + userID: "08a8684b-db88-4b73-90a9-3cd1661f5466" ``` + 2. Start Dex with the following command: ```shell @@ -75,21 +73,19 @@ Replace `` with the actual URL of your Dex instance and ` \ --oidc-clien ![OIDC Login Setup](./oidc-login-setup1.jpg) ![OIDC Login Setup](./oidc-login-setup2.jpg) - 3. Create OIDC User for the Cluster, later this user will be mapped to the dex cluster. ```shell @@ -149,24 +145,22 @@ kubectl get ns Upon running this command, a new browser window will open, prompting you to log in. Once you've completed the login process, you can close the window. You should see the namespaces in your cluster. - # Setting up Headlamp with Dex OIDC Authentication To configure Headlamp, you can use the Headlamp Helm chart. Follow these steps to set it up with OIDC(OpenID Connect) authentication: 1. Before setting up Headlamp add `http://localhost:4466/oidc-callback` to the `redirectURIs` -in the Dex configuration. - + in the Dex configuration. 2. Create a `values.yaml` file and add the following OIDC configuration to it: -```yaml +```yaml title="values.yaml" config: - oidc: - clientID: "" - clientSecret: "" - issuerURL: "" - scopes: "email" + oidc: + clientID: "" + clientSecret: "" + issuerURL: "" + scopes: "email" ``` Replace ``,``,`` with your specific OIDC configuration details. @@ -182,7 +176,6 @@ helm install headlamp-oidc headlamp/headlamp -f values.yaml --namespace=headlamp This will install Headlamp in the headlamp namespace with the OIDC configuration from the values.yaml file. - 4. After a successful installation, you can access Headlamp by port-forwarding to the pod: ```shell diff --git a/docs/installation/in-cluster/eks/_index.md b/docs/installation/in-cluster/eks/index.md similarity index 69% rename from docs/installation/in-cluster/eks/_index.md rename to docs/installation/in-cluster/eks/index.md index d3be599f2d..91cb67a58b 100644 --- a/docs/installation/in-cluster/eks/_index.md +++ b/docs/installation/in-cluster/eks/index.md @@ -1,6 +1,6 @@ --- title: How to Set Up Headlamp in EKS with Cognito as the OIDC provider -linktitle: 'Tutorial: Headlamp on EKS with Cognito' +sidebar_label: "Tutorial: Headlamp on EKS with Cognito" --- This tutorial is about configuring Headlamp 0.23.2 with: @@ -10,83 +10,91 @@ This tutorial is about configuring Headlamp 0.23.2 with: 3. Kubernetes 1.29 ## Configuring Cognito + Cognito is a fully managed identity provider that allows you to create and manage users for your applications. In this tutorial, we will use Cognito as the OIDC provider for our EKS cluster. Before proceeding, follow the [getting started guide](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html) to know more about Cognito. We will start by creating a Cognito user pool. This tutorial uses the AWS portal, but you can also use the 'ekctl' or AWS CLI tools for configuration. 1. Go to the AWS console and navigate to the Cognito service. -![Cognito](./cognito/cognito-service.png) + ![Cognito](./cognito/cognito-service.png) 2. Click on Create user pool. -![Create User Pool](./cognito/create-user-pool.png) + ![Create User Pool](./cognito/create-user-pool.png) 3. On the configure sign-in experience view, select User name, email and Allow user to sign in with a preferred username options. -![Sign-in Experience](./cognito/sign-in-experience.png) + ![Sign-in Experience](./cognito/sign-in-experience.png) 4. Click next to go to the Configure security requirements view 5. You can configure the password policy as per your requirements. For this tutorial we will use the default settings. -![Security Requirements](./cognito/security-requirements.png) + ![Security Requirements](./cognito/security-requirements.png) 6. Click next to go to the Configure sign-up experience 7. You can configure the email and phone verification settings as per your requirements. For this tutorial we will use the default settings. -![Sign-up Experience](./cognito/sign-up-experience.png) + ![Sign-up Experience](./cognito/sign-up-experience.png) 8. Click next to go to the Configure message delivery view 9. You can either chose sending email from Amazon SES or with Cognito, These emails are for MFA, account recovery, sign up, sign in workflows. For this tutorial we will use sending emails through Cognito. -![congigure-message-delivery](./cognito/configure-message-delivery.png) + ![congigure-message-delivery](./cognito/configure-message-delivery.png) 10. Click next to go to the Integrate your app view -11. There are few things you have to take care of here, +11. There are few things you have to take care of here, - You can either use the hosted UI or create your own UI for the authentication workflows (We are using the Cognito hosted UI). - You can also configure the domain name for the hosted UI (Also remember this is the issuer URL as well which we will later use to setup EKS with). We are using Cognito domain for this tutorial but you can chose your own custom domain as well. - - You can also configure the callback URLs for the auth flow. For this tutorial we are setting it to be - http://localhost:8000/oidc-callback as we will be running headlamp on this port but you can chose your own callback host as well based on your needs make sure to append /oidc-callback to the host since this is where headlamp expect the redirect from auth to occur. + - You can also configure the callback URLs for the auth flow. For this tutorial we are setting it to be + http://localhost:8000/oidc-callback as we will be running headlamp on this port but you can chose your own callback host as well based on your needs make sure to append /oidc-callback to the host since this is where headlamp expect the redirect from auth to occur. - Client Secret - We want to generate a client secret as our headlamp app needs it to start the auth dance, So select Generate a client secret client secret column. - You can also configure the scopes and claims for the tokens. For this tutorial make sure openid, profile, email scopes are selected, other scopes are optional. ![Part one of three of a long form Cognito uses for App Configuration](./cognito/integrate-your-app1.png) ![Second part of Integrating App Cognito Form](./cognito/integrate-your-app2.png) ![Final part of Integrating App Cognito Form](./cognito/integrate-your-app3.png) -In the above configurations make sure The Oauth 2.0 grant type is set to Authorization code grant. -12. Click next and you will be taken to the Review and Create view where you can review all the settings and create the user pool. +In the above configurations make sure The Oauth 2.0 grant type is set to Authorization code grant. 12. Click next and you will be taken to the Review and Create view where you can review all the settings and create the user pool. ## Setting up EKS cluster + We will first start by creating an EKS cluster. For this tutorial we will use the aws console to create the cluster but you can use the eksctl or aws CLI as well. 1. Go to the AWS console and navigate to the EKS service. -![EKS](./cluster/elastic_kubernetes_cluster.png) + ![EKS](./cluster/elastic_kubernetes_cluster.png) 2. Click on Create Cluster or Add Cluster to create a new cluster. -![Create Cluster](./cluster/create_cluster.png) -4. On the Configure Cluster view, select the EKS platform version, Kubernetes version, and the IAM role that has the necessary permissions to create the cluster. You can chose these configurations based on your requirements. -![Configure Cluster](./cluster/configure_cluster1.png) -![Configure Cluster](./cluster/configure_cluster2.png) -5. Click next to go to the Configure Networking view -6. You can configure the VPC, Subnets, and Security Groups for the cluster. For this tutorial we will use the default settings. -![Specify Networking](./cluster/specify_networking.png) -7. Click next to go to the Configure Observability view, For this tutorial we will use the default settings. -![Configure Observability](./cluster/configure_observability.png) -8. Click next to go to the Select Add-ons view, For this tutorial we will use the default selected add-ons. -![Select Add-ons](./cluster/select_addons.png) -9. Click next to go to the Configure selected add-ons view, For this tutorial we will use the default settings. -![Configure Add-ons](./cluster/configure_addons.png) -10. Click next to go to the Review and Create view where you can review all the settings and create the cluster. + ![Create Cluster](./cluster/create_cluster.png) +3. On the Configure Cluster view, select the EKS platform version, Kubernetes version, and the IAM role that has the necessary permissions to create the cluster. You can chose these configurations based on your requirements. + ![Configure Cluster](./cluster/configure_cluster1.png) + ![Configure Cluster](./cluster/configure_cluster2.png) +4. Click next to go to the Configure Networking view +5. You can configure the VPC, Subnets, and Security Groups for the cluster. For this tutorial we will use the default settings. + ![Specify Networking](./cluster/specify_networking.png) +6. Click next to go to the Configure Observability view, For this tutorial we will use the default settings. + ![Configure Observability](./cluster/configure_observability.png) +7. Click next to go to the Select Add-ons view, For this tutorial we will use the default selected add-ons. + ![Select Add-ons](./cluster/select_addons.png) +8. Click next to go to the Configure selected add-ons view, For this tutorial we will use the default settings. + ![Configure Add-ons](./cluster/configure_addons.png) +9. Click next to go to the Review and Create view where you can review all the settings and create the cluster. ## Configuring OIDC provider for EKS + After creating the EKS cluster, we need to configure the OIDC provider for the cluster. This will allow the cluster to authenticate users using Cognito. + 1. Go to the access tab on the cluster overview page of the cluster you created above and click on the Associate OIDC Identity provider. 2. In the Associate OIDC Identity provider view - 2.1 Enter a name for the Identity Provider Configuration - 2.2 Enter the issuer URL which can be found in the cognito user pool view you created. It should be something like "https://cognito-idp..amazonaws.com/USER_POOL_ID" - 2.3 Client ID can be found in the app integration tab on the user pool overview page. - 2.4 The other fields can be filled as shown in the image below. -![Associate OIDC Identity provider](./cluster/associate_oidc_identity_provider.png) + 2.1 Enter a name for the Identity Provider Configuration + 2.2 Enter the issuer URL which can be found in the cognito user pool view you created. It should be something like `https://cognito-idp..amazonaws.com/USER_POOL_ID` + 2.3 Client ID can be found in the app integration tab on the user pool overview page. + 2.4 The other fields can be filled as shown in the image below. + ![Associate OIDC Identity provider](./cluster/associate_oidc_identity_provider.png) ## Fetching EKS cluster locally to deploy Headlamp on it + Make Sure you have the aws cli installed and setup with the necessary permissions to interact with the EKS cluster. + 1. Installation steps for aws cli can be found [here](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) 2. Signin to the aws cli can be done by following the steps [here](https://docs.aws.amazon.com/signin/latest/userguide/command-line-sign-in.html) After setting up the aws cli, you can fetch the kubeconfig for the EKS cluster by running the following command + ```bash aws eks --region update-kubeconfig --name ``` -Where is the region where the EKS cluster is created and is the name of the EKS cluster. + +Where `` is the region where the EKS cluster is created and `` is the name of the EKS cluster. ## Deploying Headlamp on the EKS cluster + 1. First make sure you have the [Helm package manager](https://helm.sh/) installed on your local machine. There is a [Helm installation guide](https://helm.sh/docs/intro/install/) if you need to install it. 2. Your cluster should be running. 3. Create a Cognito user through the AWS console. You will need the email for the next step. @@ -100,13 +108,13 @@ kind: ClusterRoleBinding metadata: name: admin-user-clusterrolebinding subjects: -- kind: User - name: admin@example.com - apiGroup: rbac.authorization.k8s.io -roleRef: - kind: ClusterRole - name: cluster-admin + - kind: User + name: admin@example.com apiGroup: rbac.authorization.k8s.io +roleRef: + kind: ClusterRole + name: cluster-admin + apiGroup: rbac.authorization.k8s.io ``` Create the ClusterRoleBinding by running the following command: @@ -114,15 +122,16 @@ Create the ClusterRoleBinding by running the following command: ```shell kubectl apply -f clusterRoleBinding.yaml ``` + 5. Create a `values.yaml` file and add the following OIDC configuration to it: ```yaml config: - oidc: - clientID: "" - clientSecret: "" - issuerURL: "https://cognito-idp..amazonaws.com/" - scopes: "profile,email,openid" + oidc: + clientID: "" + clientSecret: "" + issuerURL: "https://cognito-idp..amazonaws.com/" + scopes: "profile,email,openid" ``` Replace ``,``,`` with your specific Cognito user pool app configuration details. @@ -134,11 +143,10 @@ helm repo add headlamp https://headlamp-k8s.github.io/headlamp/ helm install headlamp-oidc headlamp/headlamp -f values.yaml --namespace=headlamp --create-namespace ``` -![Headlamp install](./headlamp-install.jpg) + This will install Headlamp in the headlamp namespace with the OIDC configuration from the values.yaml file. - 7. After a successful installation, you can access Headlamp by port-forwarding to the pod: Make sure the portforwarding is done to a port that you also set as the callback URL in the Cognito user pool configuration. So in our case if the callback URL is http://localhost:8000/oidc-callback then we should port forward to 8000. @@ -148,6 +156,6 @@ kubectl port-forward svc/headlamp-oidc 8000:80 -n headlamp ``` 8. Open your web browser and go to http://localhost:8000. Click on "sign-in." After completing the login flow successfully, you'll gain access to your Kubernetes cluster using Headlamp. -![Headlamp Login](./headlamp_auth_screen.png) -![Cognito Login](./cognito_auth.png) -![Headlamp Dashboard](./headlamp_dashboard.png) \ No newline at end of file + ![Headlamp Login](./headlamp_auth_screen.png) + ![Cognito Login](./cognito_auth.png) + ![Headlamp Dashboard](./headlamp_dashboard.png) diff --git a/docs/installation/in-cluster/_index.md b/docs/installation/in-cluster/index.md similarity index 91% rename from docs/installation/in-cluster/_index.md rename to docs/installation/in-cluster/index.md index 19e223b093..cc9a9e58d7 100644 --- a/docs/installation/in-cluster/_index.md +++ b/docs/installation/in-cluster/index.md @@ -1,11 +1,13 @@ --- -title: In-cluster Deployment -weight: 10 +title: In-cluster +sidebar_position: 1 --- A common use-case for any Kubernetes web UI is to deploy it in-cluster and set up an ingress server for having it available to users. +## Using Helm + The easiest way to install headlamp in your existing cluster is to use [helm](https://helm.sh/docs/intro/quickstart/) with our [helm chart](https://github.com/headlamp-k8s/headlamp/tree/main/charts/headlamp). @@ -24,11 +26,12 @@ As usual it is possible to configure the helm release via the [values file](http helm install my-headlamp headlamp/headlamp --namespace kube-system -f values.yaml # install headlamp by setting your values directly - helm install my-headlamp headlamp/headlamp --namespace kube-system --set replicaCount=2 ``` -We also maintain a simple/vanilla [file](https://github.com/kinvolk/headlamp/blob/main/kubernetes-headlamp.yaml) +## Using simple yaml + +We also maintain a simple/vanilla [file](https://github.com/headlamp-k8s/headlamp/blob/main/kubernetes-headlamp.yaml) for setting up a Headlamp deployment and service. Be sure to review it and change anything you need. @@ -45,7 +48,7 @@ kubectl apply -f https://raw.githubusercontent.com/kinvolk/headlamp/main/kuberne With the instructions in the previous section, the Headlamp service should be running, but you still need the ingress server as mentioned. We provide an example sample ingress yaml file -for this purpose, but you have to manually replace the __URL__ placeholder +for this purpose, but you have to manually replace the **URL** placeholder with the desired URL (the ingress file also assumes that you have contour and a cert-manager set up, but if you don't then you'll just not have TLS). @@ -57,6 +60,7 @@ curl -s https://raw.githubusercontent.com/kinvolk/headlamp/main/kubernetes-headl ``` and with that, you'll have a configured ingress file, so verify it and apply it: + ```bash kubectl apply -f ./headlamp-ingress.yaml ``` diff --git a/docs/installation/in-cluster/keycloak/_index.md b/docs/installation/in-cluster/keycloak/index.md similarity index 92% rename from docs/installation/in-cluster/keycloak/_index.md rename to docs/installation/in-cluster/keycloak/index.md index 0a84132f7a..20c466cb71 100644 --- a/docs/installation/in-cluster/keycloak/_index.md +++ b/docs/installation/in-cluster/keycloak/index.md @@ -1,6 +1,6 @@ --- title: How to Set Up Headlamp in minikube with Keycloak OIDC Authentication -linktitle: 'Tutorial: OIDC with Keycloak' +sidebar_label: "Tutorial: OIDC with Keycloak" --- In this tutorial, we'll walk through the process of configuring Headlamp within a Minikube cluster while utilizing Keycloak for OIDC (OpenID Connect) authentication. This tutorial is based on Keycloak version 22.0.4, Minikube version v1.31.2, and Headlamp version 0.20.1. @@ -12,22 +12,21 @@ Note: This tutorial assumes that you have Keycloak hosted on a remote server. If To enable OIDC authentication in your Minikube cluster, you'll need to create a Keycloak client.Before proceeding, follow the [getting started guide](https://www.keycloak.org/guides#getting-started) to set up your Keycloak instance. When creating a user in Keycloak, don't forget to also set the email address.Follow these steps to configure the client in your Keycloak admin panel: 1. Start by accessing your Keycloak admin panel. -> \/admin + > \/admin ![Keycloak Admin Panel](./keycloak-admin-panel.jpeg) 2. Navigate to the "Clients" section and Click on the "Create client" option. -![Keycloak Clients Page](./keycloak-clients-list.jpeg) + ![Keycloak Clients Page](./keycloak-clients-list.jpeg) 3. Fill in the "client-id" and "Name" fields and proceed to the next step. -![Keycloak Create Client](./keycloak-create-client1.jpeg) + ![Keycloak Create Client](./keycloak-create-client1.jpeg) 4. In the "Capability Config" step, enable "Client authentication" and proceed to the next step. -![Keycloak Create Client](./keycloak-create-client2.jpeg) - -5. Add "http://localhost:8000/*" to the "Valid redirect URIs" and save your settings. -![Keycloak Create Client](./keycloak-create-client3.jpeg) + ![Keycloak Create Client](./keycloak-create-client2.jpeg) +5. Add "http://localhost:8000/\*" to the "Valid redirect URIs" and save your settings. + ![Keycloak Create Client](./keycloak-create-client3.jpeg) ## Setting up Minikube with the Keycloak OIDC Configuration @@ -41,7 +40,7 @@ minikube start -p=keycloak \ --extra-config=apiserver.oidc-issuer-url=/realms/ \ --extra-config=apiserver.oidc-username-claim=email \ --extra-config=apiserver.oidc-client-id= - ``` +``` ![Minikube start](./minikube-start.jpg) @@ -60,14 +59,15 @@ kind: ClusterRoleBinding metadata: name: admin-user-clusterrolebinding subjects: -- kind: User - name: # Please note that the name is case-sensitive - apiGroup: rbac.authorization.k8s.io + - kind: User + name: # Please note that the name is case-sensitive + apiGroup: rbac.authorization.k8s.io roleRef: kind: ClusterRole - name: cluster-admin # Specify the name of the ClusterRole to be bound + name: cluster-admin # Specify the name of the ClusterRole to be bound apiGroup: rbac.authorization.k8s.io ``` + Note: Please replace `` with your keycloak user email. Create the cluster role binding by running the following command: @@ -81,11 +81,12 @@ Create the cluster role binding by running the following command: Once you've set up your cluster and created a ClusterRoleBinding, it's time to configure `kubectl` to work with your OIDC user for authentication. Follow these steps: 1. Install the `oidc-login` plugin with [krew](https://krew.sigs.k8s.io/docs/user-guide/quickstart/) by executing the following command: + ```shell kubectl krew install oidc-login ``` -![OIDC Login Install](./oidc-login-install.jpg) +![OIDC Login Install](./oidc-login-install.jpg) 2. Set Up `oidc-login`, Configure oidc-login with the necessary parameters by running the following command: @@ -95,6 +96,7 @@ Once you've set up your cluster and created a ClusterRoleBinding, it's time to c --oidc-client-id= \ --oidc-client-secret= ``` + ![OIDC Login Setup](./oidc-login-setup1.jpg) ![OIDC Login Setup](./oidc-login-setup2.jpg) @@ -116,7 +118,6 @@ kubectl config set-credentials keycloak-oidc \ 4. Link the User to the Cluster: To associate the user with the cluster, create a new context using these commands: - ```shell kubectl config set-context keycloak-oidc --namespace=default --cluster=keycloak --user=keycloak-oidc kubectl config use-context keycloak-oidc @@ -132,7 +133,6 @@ Upon running this command, a new browser window will open, prompting you to log Note: Make sure to replace ``, ``, ``, and `` with your specific Keycloak configuration details wherever necessary. - # Setting up Headlamp with OIDC Configuration To configure Headlamp, you can use the Headlamp Helm chart. Follow these steps to set it up with OIDC (OpenID Connect) authentication: @@ -150,7 +150,7 @@ config: clientSecret: "" issuerURL: "/realms/" scopes: "email,profile" - ``` +``` Replace ``, ``, ``, and `` with your specific OIDC configuration details. @@ -165,7 +165,6 @@ helm install headlamp-oidc headlamp/headlamp -f values.yaml --namespace=headlamp This will install Headlamp in the headlamp namespace with the OIDC configuration from the values.yaml file. - 4. After a successful installation, you can access Headlamp by port-forwarding to the pod: ```shell @@ -182,4 +181,4 @@ kubectl port-forward svc/headlamp-oidc 4466:80 -n headlamp In this tutorial, we've explored the process of setting up Headlamp within a Kubernetes cluster, integrating it with OIDC (OpenID Connect) authentication provided by Keycloak. By following the steps outlined in this guide, you've successfully configured Headlamp to enhance your Kubernetes cluster management. -This setup allows you to benefit from Headlamp's user-friendly interface and advanced features, all while ensuring a secure and streamlined authentication through Keycloak. With the power of OIDC, you can easily and safely access and manage your Kubernetes resources. \ No newline at end of file +This setup allows you to benefit from Headlamp's user-friendly interface and advanced features, all while ensuring a secure and streamlined authentication through Keycloak. With the power of OIDC, you can easily and safely access and manage your Kubernetes resources. diff --git a/docs/installation/in-cluster/oidc.md b/docs/installation/in-cluster/oidc.md index c9220bb864..2f2dc450d5 100644 --- a/docs/installation/in-cluster/oidc.md +++ b/docs/installation/in-cluster/oidc.md @@ -1,7 +1,6 @@ --- title: Accessing using OpenID Connect -linktitle: OIDC -weight: 10 +sidebar_label: OIDC --- Headlamp supports OIDC for cluster users to effortlessly log in using a "Sign in" button. @@ -10,10 +9,10 @@ Headlamp supports OIDC for cluster users to effortlessly log in using a "Sign in For OIDC to be used, Headlamp needs to know how to configure it, so you have to provide the different OIDC-related arguments to Headlamp from your OIDC provider. Those are: - * the client ID: `-oidc-client-id` or env var `HEADLAMP_CONFIG_OIDC_CLIENT_ID` - * the client secret: `-oidc-client-secret` or env var `HEADLAMP_CONFIG_OIDC_CLIENT_SECRET` - * the issuer URL: `-oidc-idp-issuer-url` or env var `HEADLAMP_CONFIG_OIDC_IDP_ISSUER_URL` - * (optionally) the OpenId scopes: `-oidc-scopes` or env var `HEADLAMP_CONFIG_OIDC_SCOPES` +- the client ID: `-oidc-client-id` or env var `HEADLAMP_CONFIG_OIDC_CLIENT_ID` +- the client secret: `-oidc-client-secret` or env var `HEADLAMP_CONFIG_OIDC_CLIENT_SECRET` +- the issuer URL: `-oidc-idp-issuer-url` or env var `HEADLAMP_CONFIG_OIDC_IDP_ISSUER_URL` +- (optionally) the OpenId scopes: `-oidc-scopes` or env var `HEADLAMP_CONFIG_OIDC_SCOPES` and you have to tell the OIDC provider about the callback URL, which in Headlamp it is your URL + the `/oidc-callback` path, e.g.: `https://YOUR_URL/oidc-callback`. @@ -28,7 +27,7 @@ include the default ones if you need them when using that option. For example, if you need to keep the default scopes and add Github's `repo`, then add them all to the option: - `-oidc-scopes=profile,email,repo` +`-oidc-scopes=profile,email,repo` **Note:** Before Headlamp 0.3.0, a scope _groups_ was also included, as it's used by Dex and other services, but since it's not part of the default spec, @@ -45,10 +44,10 @@ you can check the If you are using Dex and want to configure Headlamp to use it for OIDC, then you have to: - * Add the callback URL (e.g. `https://YOUR_URL/oidc-callback`) to Dex's `staticClient.redirectURIs` - * Set `-oidc-client-id` as Dex's `staticClient.id` - * Set `-oidc-client-secret` as Dex's `staticClient.secret` - * Set `-oidc-idp-issuer-url` as Dex's URL (same as in `--oidc-issuer-url` in the Kubernetes APIServer) - * Set `-oidc-scopes` if needed, e.g. `-oidc-scopes=profile,email,groups` +- Add the callback URL (e.g. `https://YOUR_URL/oidc-callback`) to Dex's `staticClient.redirectURIs` +- Set `-oidc-client-id` as Dex's `staticClient.id` +- Set `-oidc-client-secret` as Dex's `staticClient.secret` +- Set `-oidc-idp-issuer-url` as Dex's URL (same as in `--oidc-issuer-url` in the Kubernetes APIServer) +- Set `-oidc-scopes` if needed, e.g. `-oidc-scopes=profile,email,groups` **Note** If you already have another static client configured for Kubernetes to be used by the [apiserver's OIDC](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#configuring-the-api-server) (OpenID Connect) configuration, it is important to ensure that a **single static client ID** i.e `-oidc-client-id` is used for both Dex and Headlamp. Additionally, the **redirectURIs** need to be specified for each client. diff --git a/docs/installation/_index.md b/docs/installation/index.mdx similarity index 53% rename from docs/installation/_index.md rename to docs/installation/index.mdx index a314733b40..f1b27679a1 100644 --- a/docs/installation/_index.md +++ b/docs/installation/index.mdx @@ -1,13 +1,9 @@ --- -title: Installation / Deployment -linktitle: Installation -weight: 2 +title: Installation +sidebar_position: 2 --- -Headlamp can be deployed in a Kubernetes [cluster](./in-cluster), or run as a [desktop](./desktop/) application. - -Please check the guides in this section for [installing the desktop application](./desktop/) -or deploying Headlamp [in your cluster](./in-cluster/). +Headlamp can be deployed in a Kubernetes [cluster](./in-cluster/index.md), or run as a [desktop](./desktop/index.mdx) application. ## Authentication / Log-in @@ -28,28 +24,46 @@ kubectl -n kube-system create serviceaccount headlamp-admin ``` 2. Give admin rights to the account (check the -[RBAC docs](https://kubernetes.io/docs/reference/access-authn-authz/rbac) if you want to set more -restrictive permissions): + : + +:::tip + +Check [RBAC docs](https://kubernetes.io/docs/reference/access-authn-authz/rbac) if you want to set more + restrictive permissions) + +::: ```shell kubectl create clusterrolebinding headlamp-admin --serviceaccount=kube-system:headlamp-admin --clusterrole=cluster-admin ``` -3. If you are running Headlamp in a Kubernetes cluster with version greater than 1.24, create the token using the following command: +3. Create the token using the following command: + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + ```shell + kubectl create token headlamp-admin -n kube-system + ``` + + + ```shell + export HEADLAMP_SECRET=$(kubectl get secrets --namespace kube-system -o custom-columns=":metadata.name" | grep "headlamp-admin-token") + kubectl get secret $HEADLAMP_SECRET --namespace kube-system --template=\{\{.data.token\}\} | base64 --decode + ``` + + + -```shell -kubectl create token headlamp-admin -n kube-system -``` Otherwise, run the following command to get the token associated with the service account: -```shell -export HEADLAMP_SECRET=$(kubectl get secrets --namespace kube-system -o custom-columns=":metadata.name" | grep "headlamp-admin-token") -kubectl get secret $HEADLAMP_SECRET --namespace kube-system --template=\{\{.data.token\}\} | base64 --decode -``` + Once you have the Service Account token, paste it when prompted by Headlamp. ### Use OIDC -For OpenIDConnect, please see the [in-cluster installation](./in-cluster/oidc.md#accessing-using-oidc) docs. +For OpenIDConnect, please see the [in-cluster installation](./in-cluster/oidc.md) docs. diff --git a/docs/installation/metrics-server.md b/docs/installation/metrics-server.md index abeaaa8cba..feb59776d0 100644 --- a/docs/installation/metrics-server.md +++ b/docs/installation/metrics-server.md @@ -1,6 +1,7 @@ --- title: Kubernetes Metrics Server -linkTitle: Metrics Server +sidebar_label: Metrics Server +sidebar_position: 4 --- Headlamp can show information for resources usage if the Metrics Server is @@ -21,4 +22,3 @@ enabling the ```shell minikube addons enable metrics-server ``` - diff --git a/docs/platforms.md b/docs/platforms.md index d53aa075f6..37331c8e9e 100644 --- a/docs/platforms.md +++ b/docs/platforms.md @@ -1,7 +1,6 @@ --- -title: Tested Kubernetes, Desktop and Browser Platforms -linkTitle: Platforms -weight: 300 +title: Platforms +sidebar_position: 3 --- ## Tested Kubernetes Platforms @@ -10,43 +9,42 @@ This section shows the different platforms where Headlamp has been tested (in-cl If you have tested Headlamp on a different flavor or Kubernetes, please file a PR or [issue](https://github.com/headlamp-k8s/headlamp/issues/new/choose) to add your remarks to the list. The "works" column refers to the overall Kubernetes related functionality when running in the respective platform; it may have 3 different values: + - ✔️ : Has been tried and works fine to the extent of what has been tested - ❌ : Has been tried and didn't work or had issues that prevented a regular use of it - ❔: Hasn't been tried/reported yet -Platform
| Works | Comments -----------------------------------------------|:-----:|------------------------------------------------------------------------------------------ -[Amazon EKS](https://aws.amazon.com/eks/) | ✔️ | - As reported [here](https://github.com/headlamp-k8s/headlamp/issues/266). -[Azure Kubernetes AKS](https://azure.microsoft.com/products/kubernetes-service) | ✔️ | Worked fine in-cluster and also working perfectly while using kubeconfig file with headlamp application. -[DigitalOcean Kubernetes](https://www.digitalocean.com/products/kubernetes/) | ❔ | - Have you tried Headlamp on this platform? Please report your experience. -[Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine) | ❔ | - Have you tried Headlamp on this platform? Please report your experience. -[K3s](https://k3s.io/) | ✔️ | - Simple to install / expose with the regular [in-cluster instructions](https://headlamp.dev/docs/latest/installation/in-cluster/). -[Kind](https://kind.sigs.k8s.io/) | ✔️ | - Simple to install / expose with the regular [in-cluster instructions](https://headlamp.dev/docs/latest/installation/in-cluster/). -[Microsoft AKS](https://azure.microsoft.com/) | ✔️ | - Testing (not suitable for production):
- Deploy Headlamp from the [in-cluster instructions](https://headlamp.dev/docs/latest/installation/in-cluster/)
- [Enable the http_application_routing addon](https://docs.microsoft.com/en-us/azure/aks/http-application-routing#use-http-routing) (this creates a DNS zone)
- Use the DNS zone name as the domain for Headlamp, i.e. if it is `1234567.eastus.aksapp.io`, then apply [Headlamp's ingress](https://raw.githubusercontent.com/headlamp-k8s/headlamp/main/kubernetes-headlamp-ingress-sample.yaml) using `headlamp.1234567.eastus.aksapp.io` as the path and use ``kubernetes.io/ingress.class: addon-http-application-routing`` as the ingress class annotation.

For production, please follow the [intructions to deploy with an HTTPS ingress controller](https://docs.microsoft.com/en-us/azure/aks/ingress-tls). -[Minikube](https://minikube.sigs.k8s.io/) | ✔️ | - For exposing with an ingress, enable ingresses with `minikube addons enable ingress`:
- There are docs about the [development](../development/) with Minikube.| -[Vultr Kubernetes Engine](https://www.vultr.com/kubernetes/) | ✔️ | - Simple to install / expose with the regular [in-cluster instructions](https://headlamp.dev/docs/latest/installation/in-cluster/). - +| Platform | Works | Comments | +| ------------------------------------------------------------------------------- | :---: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [Amazon EKS](https://aws.amazon.com/eks/) | ✔️ | - As reported [here](https://github.com/headlamp-k8s/headlamp/issues/266). | +| [Azure Kubernetes AKS](https://azure.microsoft.com/products/kubernetes-service) | ✔️ | Worked fine in-cluster and also working perfectly while using kubeconfig file with headlamp application. | +| [DigitalOcean Kubernetes](https://www.digitalocean.com/products/kubernetes/) | ❔ | - Have you tried Headlamp on this platform? Please report your experience. | +| [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine) | ❔ | - Have you tried Headlamp on this platform? Please report your experience. | +| [K3s](https://k3s.io/) | ✔️ | - Simple to install / expose with the regular [in-cluster instructions](https://headlamp.dev/docs/latest/installation/in-cluster/). | +| [Kind](https://kind.sigs.k8s.io/) | ✔️ | - Simple to install / expose with the regular [in-cluster instructions](https://headlamp.dev/docs/latest/installation/in-cluster/). | +| [Microsoft AKS](https://azure.microsoft.com/) | ✔️ | - Testing (not suitable for production):
- Deploy Headlamp from the [in-cluster instructions](https://headlamp.dev/docs/latest/installation/in-cluster/)
- [Enable the http_application_routing addon](https://docs.microsoft.com/en-us/azure/aks/http-application-routing#use-http-routing) (this creates a DNS zone)
- Use the DNS zone name as the domain for Headlamp, i.e. if it is `1234567.eastus.aksapp.io`, then apply [Headlamp's ingress](https://raw.githubusercontent.com/headlamp-k8s/headlamp/main/kubernetes-headlamp-ingress-sample.yaml) using `headlamp.1234567.eastus.aksapp.io` as the path and use `kubernetes.io/ingress.class: addon-http-application-routing` as the ingress class annotation.

For production, please follow the [intructions to deploy with an HTTPS ingress controller](https://docs.microsoft.com/en-us/azure/aks/ingress-tls). | +| [Minikube](https://minikube.sigs.k8s.io/) | ✔️ | - For exposing with an ingress, enable ingresses with `minikube addons enable ingress`:
- There are docs about the [development](./development/index.md#minikube-in-cluster) with Minikube. | +| [Vultr Kubernetes Engine](https://www.vultr.com/kubernetes/) | ✔️ | - Simple to install / expose with the regular [in-cluster instructions](https://headlamp.dev/docs/latest/installation/in-cluster/). | ## Tested Browsers We mostly test with 'modern browsers' defined as the latest version and two older versions. But we try to make Headlamp work with web standards, so it's quite likely other standards conforming browsers will also work. -Platform
| Works | Comments -----------------------------------------------|:-----:|------------------------------------------------------------------------------------------ -Edge | ✔️ | -Safari | ✔️ | -Firefox | ✔️ | -Chrome | ✔️ | -Internet Explorer 11 | ❌ | - +| Platform | Works | Comments | +| -------------------- | :---: | -------- | +| Edge | ✔️ | +| Safari | ✔️ | +| Firefox | ✔️ | +| Chrome | ✔️ | +| Internet Explorer 11 | ❌ | ## Tested Desktop OS, for App version We test on MacOS, various flavours of Linux, and Windows. Headlamp runs in the browser, but also as an App. -Platform
| Works | Comments -----------------------------------------------|:-----:|------------------------------------------------------------------------------------------ -Windows 10, 11 (including in WSL2) | ✔️ | -MacOS (arm, x86) | ✔️ | -Ubuntu 20.04, 22.04, 22.10 | ✔️ | -Fedora | ✔️ | +| Platform | Works | Comments | +| ---------------------------------- | :---: | -------- | +| Windows 10, 11 (including in WSL2) | ✔️ | +| MacOS (arm, x86) | ✔️ | +| Ubuntu 20.04, 22.04, 22.10 | ✔️ | +| Fedora | ✔️ | diff --git a/frontend/package-lock.json b/frontend/package-lock.json index c0c15e49d7..3964757a6e 100644 --- a/frontend/package-lock.json +++ b/frontend/package-lock.json @@ -129,7 +129,6 @@ "resize-observer-polyfill": "^1.5.1", "storybook": "^7.6.7", "typedoc": "0.22.10", - "typedoc-hugo-theme": "1.0.0", "typedoc-plugin-markdown": "3.11.14", "typedoc-plugin-rename-defaults": "0.4.0", "vitest-canvas-mock": "^0.3.3", @@ -13070,8 +13069,7 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/cssfontparser/-/cssfontparser-1.2.1.tgz", "integrity": "sha512-6tun4LoZnj7VN6YeegOVb67KBX/7JJsqvj+pv3ZA7F878/eN33AbGa5b/S/wXxS/tcp8nc40xRUrsPlxIyNUPg==", - "dev": true, - "license": "MIT" + "dev": true }, "node_modules/cssstyle": { "version": "4.0.1", @@ -18646,7 +18644,6 @@ "resolved": "https://registry.npmjs.org/jest-canvas-mock/-/jest-canvas-mock-2.5.2.tgz", "integrity": "sha512-vgnpPupjOL6+L5oJXzxTxFrlGEIbHdZqFU+LFNdtLxZ3lRDCl17FlTMM7IatoRQkrcyOTMlDinjUguqmQ6bR2A==", "dev": true, - "license": "MIT", "dependencies": { "cssfontparser": "^1.2.1", "moo-color": "^1.0.2" @@ -19303,8 +19300,7 @@ "version": "3.3.1", "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.3.1.tgz", "integrity": "sha512-HUgH65KyejrUFPvHFPbqOY0rsFip3Bo5wb4ngvdi1EpCYWUQDC5V+Y7mZws+DLkr4M//zQJoanu1SP+87Dv1oQ==", - "dev": true, - "license": "MIT" + "dev": true }, "node_modules/jsonfile": { "version": "6.1.0", @@ -20033,8 +20029,7 @@ "version": "2.3.9", "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", - "dev": true, - "license": "MIT" + "dev": true }, "node_modules/lz-string": { "version": "1.5.0", @@ -20132,7 +20127,6 @@ "resolved": "https://registry.npmjs.org/marked/-/marked-3.0.8.tgz", "integrity": "sha512-0gVrAjo5m0VZSJb4rpL59K1unJAMb/hm8HRXqasD8VeC8m91ytDPMritgFSlKonfdt+rRYYpP/JfLxgIX8yoSw==", "dev": true, - "license": "MIT", "bin": { "marked": "bin/marked" }, @@ -21067,7 +21061,6 @@ "resolved": "https://registry.npmjs.org/moo-color/-/moo-color-1.0.3.tgz", "integrity": "sha512-i/+ZKXMDf6aqYtBhuOcej71YSlbjT3wCO/4H1j8rPvxDJEifdwgg5MaFyu6iYAT8GBZJg2z0dkgK4YMzvURALQ==", "dev": true, - "license": "MIT", "dependencies": { "color-name": "^1.1.4" } @@ -24985,7 +24978,6 @@ "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.9.15.tgz", "integrity": "sha512-/Y0z9IzhJ8nD9nbceORCqu6NgT9X6I8Fk8c3SICHI5NbZRLdZYFaB233gwct9sU0vvSypyaL/qaKvzyQGJBZSw==", "dev": true, - "license": "MIT", "dependencies": { "jsonc-parser": "^3.0.0", "vscode-oniguruma": "^1.6.1", @@ -26512,7 +26504,6 @@ "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.22.10.tgz", "integrity": "sha512-hQYZ4WtoMZ61wDC6w10kxA42+jclWngdmztNZsDvIz7BMJg7F2xnT+uYsUa7OluyKossdFj9E9Ye4QOZKTy8SA==", "dev": true, - "license": "Apache-2.0", "dependencies": { "glob": "^7.2.0", "lunr": "^2.3.9", @@ -26530,24 +26521,11 @@ "typescript": "4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x || 4.5.x" } }, - "node_modules/typedoc-hugo-theme": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/typedoc-hugo-theme/-/typedoc-hugo-theme-1.0.0.tgz", - "integrity": "sha512-FkH7Y0469W6QN26F4N+3vSVy7PcZDJhXEc68XNBLR36gsOfRSdxC6PeBxoIyaLZ2TJHVWtwSllvqrNaUI9DiUw==", - "deprecated": "Deprecated because of a lack of interest. If you are interested in contributing and bringing this plugin back to life please start a discussion at typedoc-plugin-markdown.", - "dev": true, - "license": "MIT", - "peerDependencies": { - "typedoc": ">=0.22.9", - "typedoc-plugin-markdown": ">=3.11.10" - } - }, "node_modules/typedoc-plugin-markdown": { "version": "3.11.14", "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.11.14.tgz", "integrity": "sha512-lh47OQvl0079nB18YL9wuTRRhMpjo300SZKfx/xpQY8qG+GINeSxTod95QBELeI0NP81sNtUbemRDrn5nyef4Q==", "dev": true, - "license": "MIT", "dependencies": { "handlebars": "^4.7.7" }, @@ -26560,7 +26538,6 @@ "resolved": "https://registry.npmjs.org/typedoc-plugin-rename-defaults/-/typedoc-plugin-rename-defaults-0.4.0.tgz", "integrity": "sha512-7m7MbNZKcxCA4Z+0MW06sFEmuQ+he1xfc+rLRtvvQcQypPTd3fgFmkEJKVu42t8mONC+kKS/WkbmqwzsiqI1YQ==", "dev": true, - "license": "MIT", "peerDependencies": { "typedoc": "0.22.x" } @@ -26571,7 +26548,6 @@ "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", "deprecated": "Glob versions prior to v9 are no longer supported", "dev": true, - "license": "ISC", "dependencies": { "fs.realpath": "^1.0.0", "inflight": "^1.0.4", @@ -26591,7 +26567,6 @@ "version": "4.5.5", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.5.5.tgz", "integrity": "sha512-TCTIul70LyWe6IJWT8QSYeA54WQe8EjQFU4wY52Fasj5UKx88LNYKCgBEHcOMOrFF1rKGbD8v/xcNWVUq9SymA==", - "license": "Apache-2.0", "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -27902,7 +27877,6 @@ "resolved": "https://registry.npmjs.org/vitest-canvas-mock/-/vitest-canvas-mock-0.3.3.tgz", "integrity": "sha512-3P968tYBpqYyzzOaVtqnmYjqbe13576/fkjbDEJSfQAkHtC5/UjuRHOhFEN/ZV5HVZIkaROBUWgazDKJ+Ibw+Q==", "dev": true, - "license": "MIT", "dependencies": { "jest-canvas-mock": "~2.5.2" }, @@ -28089,15 +28063,13 @@ "version": "1.7.0", "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", - "dev": true, - "license": "MIT" + "dev": true }, "node_modules/vscode-textmate": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", - "dev": true, - "license": "MIT" + "dev": true }, "node_modules/vue-template-compiler": { "version": "2.7.16", diff --git a/frontend/package.json b/frontend/package.json index 06970c9bce..900586bf1c 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -207,7 +207,6 @@ "resize-observer-polyfill": "^1.5.1", "storybook": "^7.6.7", "typedoc": "0.22.10", - "typedoc-hugo-theme": "1.0.0", "typedoc-plugin-markdown": "3.11.14", "typedoc-plugin-rename-defaults": "0.4.0", "vitest-canvas-mock": "^0.3.3", diff --git a/frontend/tsconfig.json b/frontend/tsconfig.json index ca056cc902..24d1f28c9b 100644 --- a/frontend/tsconfig.json +++ b/frontend/tsconfig.json @@ -22,7 +22,7 @@ "out": "../docs/development/api", "entryPoints": [ "src/lib/k8s/", - "src/redux/reducers/config.tsx", + "src/redux/reducers/reducers.tsx", "src/lib/k8s/cluster.ts", "src/lib/router.tsx", "src/lib/util.ts", @@ -30,13 +30,13 @@ "src/plugin/registry.tsx" ], "entryPointStrategy": "expand", - "theme": "hugo", "excludeExternals": true, "excludePrivate": true, "excludeProtected": true, - "hideBreadcrumbs": true, "readme": "none", "hideInPageTOC": true, - "indexTitle": "API" + "name": "API", + "indexTitle": "API Reference", + "entryDocument": "API.md" } }