1
0
Fork 0
mirror of https://github.com/portainer/portainer.git synced 2025-07-22 23:09:41 +02:00

refactor(k8s): namespace core logic (#12142)

Co-authored-by: testA113 <aliharriss1995@gmail.com>
Co-authored-by: Anthony Lapenna <anthony.lapenna@portainer.io>
Co-authored-by: James Carppe <85850129+jamescarppe@users.noreply.github.com>
Co-authored-by: Ali <83188384+testA113@users.noreply.github.com>
This commit is contained in:
Steven Kang 2024-10-01 14:15:51 +13:00 committed by GitHub
parent da010f3d08
commit ea228c3d6d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
276 changed files with 9241 additions and 3361 deletions

View file

@ -1,12 +1,15 @@
import { Layers } from 'lucide-react';
import { useQueryClient } from '@tanstack/react-query';
import { Authorized, useAuthorizations } from '@/react/hooks/useUser';
import { useEnvironmentId } from '@/react/hooks/useEnvironmentId';
import { pluralize } from '@/portainer/helpers/strings';
import { notifyError, notifySuccess } from '@/portainer/services/notifications';
import { DeleteButton } from '@@/buttons/DeleteButton';
import { refreshableSettings } from '@@/datatables/types';
import { Datatable, TableSettingsMenu } from '@@/datatables';
import { useTableStateWithStorage } from '@@/datatables/useTableState';
import { DeleteButton } from '@@/buttons/DeleteButton';
import { useRepeater } from '@@/datatables/useRepeater';
import { AddButton } from '@@/buttons';
import { systemResourcesSettings } from '../../datatables/SystemResourcesSettings';
@ -17,19 +20,16 @@ import {
} from '../../datatables/DefaultDatatableSettings';
import { SystemResourceDescription } from '../../datatables/SystemResourceDescription';
import { isDefaultNamespace } from '../isDefaultNamespace';
import { useNamespacesQuery } from '../queries/useNamespacesQuery';
import { PortainerNamespace } from '../types';
import { useDeleteNamespaces } from '../queries/useDeleteNamespaces';
import { queryKeys } from '../queries/queryKeys';
import { NamespaceViewModel } from './types';
import { useColumns } from './columns/useColumns';
export function NamespacesDatatable({
dataset,
onRemove,
onRefresh,
}: {
dataset: Array<NamespaceViewModel>;
onRemove(items: Array<NamespaceViewModel>): void;
onRefresh(): void;
}) {
export function NamespacesDatatable() {
const environmentId = useEnvironmentId();
const tableState = useTableStateWithStorage<TableSettings>(
'kube-namespaces',
'Name',
@ -38,6 +38,11 @@ export function NamespacesDatatable({
...refreshableSettings(set),
})
);
const namespacesQuery = useNamespacesQuery(environmentId, {
autoRefreshRate: tableState.autoRefreshRate * 1000,
withResourceQuota: true,
});
const namespaces = Object.values(namespacesQuery.data ?? []);
const hasWriteAuthQuery = useAuthorizations(
'K8sResourcePoolDetailsW',
@ -45,40 +50,30 @@ export function NamespacesDatatable({
true
);
const columns = useColumns();
useRepeater(tableState.autoRefreshRate, onRefresh);
const filteredDataset = tableState.showSystemResources
? dataset
: dataset.filter((item) => !item.Namespace.IsSystem);
? namespaces
: namespaces.filter((namespace) => !namespace.IsSystem);
return (
<Datatable
<Datatable<PortainerNamespace>
data-cy="k8sNamespace-namespaceTable"
dataset={filteredDataset}
columns={columns}
settingsManager={tableState}
isLoading={namespacesQuery.isLoading}
title="Namespaces"
titleIcon={Layers}
getRowId={(item) => item.Namespace.Id}
getRowId={(item) => item.Id}
disableSelect={!hasWriteAuthQuery.authorized}
isRowSelectable={({ original: item }) =>
hasWriteAuthQuery.authorized &&
!item.Namespace.IsSystem &&
!isDefaultNamespace(item.Namespace.Name)
!item.IsSystem && !isDefaultNamespace(item.Name)
}
renderTableActions={(selectedItems) => (
<Authorized authorizations="K8sResourcePoolDetailsW" adminOnlyCE>
<DeleteButton
onClick={() => onRemove(selectedItems)}
disabled={selectedItems.length === 0}
data-cy="delete-namespace-button"
/>
<AddButton color="secondary" data-cy="add-namespace-form-button">
Add with form
</AddButton>
<CreateFromManifestButton data-cy="k8s-namespaces-deploy-button" />
</Authorized>
<TableActions
selectedItems={selectedItems}
namespaces={namespacesQuery.data}
/>
)}
renderTableSettings={() => (
<TableSettingsMenu>
@ -93,3 +88,101 @@ export function NamespacesDatatable({
/>
);
}
function TableActions({
selectedItems,
namespaces: namespacesQueryData,
}: {
selectedItems: PortainerNamespace[];
namespaces?: PortainerNamespace[];
}) {
const queryClient = useQueryClient();
const environmentId = useEnvironmentId();
const deleteNamespacesMutation = useDeleteNamespaces(environmentId);
const selectedNamespacePlural = pluralize(selectedItems.length, 'namespace');
const includesTerminatingNamespace = selectedItems.some(
(ns) => ns.Status.phase === 'Terminating'
);
const message = includesTerminatingNamespace
? 'At least one namespace is in a terminating state. For terminating state namespaces, you may continue and force removal, but doing so without having properly cleaned up may lead to unstable and unpredictable behavior. Are you sure you wish to proceed?'
: `Do you want to remove the selected ${selectedNamespacePlural}? All the resources associated to the selected ${selectedNamespacePlural} will be removed too. Are you sure you wish to proceed?`;
return (
<Authorized authorizations="K8sResourcePoolDetailsW" adminOnlyCE>
<DeleteButton
onConfirmed={() => onRemoveNamespaces(selectedItems)}
disabled={selectedItems.length === 0}
data-cy="delete-namespace-button"
confirmMessage={message}
/>
<AddButton color="secondary" data-cy="add-namespace-form-button">
Add with form
</AddButton>
<CreateFromManifestButton data-cy="k8s-namespaces-deploy-button" />
</Authorized>
);
function onRemoveNamespaces(selectedNamespaces: Array<PortainerNamespace>) {
deleteNamespacesMutation.mutate(
{
namespaceNames: selectedNamespaces.map((namespace) => namespace.Name),
},
{
onSuccess: (resp) => {
// gather errors and deleted namespaces
const errors = resp.data?.errors || [];
const erroredNamespacePlural = pluralize(errors.length, 'namespace');
const selectedNamespaceNames = selectedNamespaces.map(
(ns) => ns.Name
);
const deletedNamespaces =
resp.data?.deleted || selectedNamespaceNames;
const deletedNamespacePlural = pluralize(
deletedNamespaces.length,
'namespace'
);
// notify user of success and errors
if (errors.length > 0) {
notifyError(
'Error',
new Error(
`Failed to delete ${erroredNamespacePlural}: ${errors
.map((err) => `${err.namespaceName}: ${err.error}`)
.join(', ')}`
)
);
}
if (deletedNamespaces.length > 0) {
notifySuccess(
'Success',
`Successfully deleted ${deletedNamespacePlural}: ${deletedNamespaces.join(
', '
)}`
);
}
// Plain invalidation / refetching is confusing because namespaces hang in a terminating state
// instead, optimistically update the cache manually to hide the deleting (terminating) namespaces
queryClient.setQueryData(
queryKeys.list(environmentId, {
withResourceQuota: true,
}),
() =>
deletedNamespaces.reduce(
(acc, ns) => {
delete acc[ns as keyof typeof acc];
return acc;
},
{ ...namespacesQueryData }
)
);
},
}
);
}
}