chore: code clean

docs: add reademe

Author: zxyao145

Directory.Packages.props

@@ -4,12 +4,10 @@
   </PropertyGroup>
   <ItemGroup>
     <PackageVersion Include="Blazored.LocalStorage" Version="4.3.0" />
+    <PackageVersion Include="Blazored.SessionStorage" Version="2.3.0" />
     <PackageVersion Include="IconPark.Blazor" Version="1.3.0.3" />
     <PackageVersion Include="Jil" Version="2.17.0" />
     <PackageVersion Include="JsonPatch.Net" Version="2.0.6" />
-    <PackageVersion Include="KubeClient" Version="2.4.10" />
-    <PackageVersion Include="KubeClient.Extensions.DependencyInjection" Version="2.4.10" />
-    <PackageVersion Include="KubeClient.Extensions.WebSockets" Version="2.4.10" />
     <PackageVersion Include="KubernetesClient" Version="10.1.4" />
     <PackageVersion Include="Microsoft.AspNetCore.Components.Authorization" Version="6.0.15" />
     <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" Version="6.0.15" />
@@ -23,8 +21,8 @@
     <PackageVersion Include="Swashbuckle.AspNetCore" Version="6.5.0" />
   </ItemGroup>
   <ItemGroup>
-    <PackageVersion Include="AntDesign" Version="0.13.3" />
-    <PackageVersion Include="BcdLib.BcdForm" Version="0.6.0" />
+    <PackageVersion Include="AntDesign" Version="0.14.4" />
+    <PackageVersion Include="BcdLib.BcdForm" Version="0.7.0" />
     <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly" Version="6.0.12" />
     <PackageVersion Include="Microsoft.AspNetCore.Components.WebAssembly.DevServer" Version="6.0.12" PrivateAssets="all" />
     <PackageVersion Include="Microsoft.Extensions.Http" Version="6.0.0" />

README-ZH-CN.md

@@ -0,0 +1,113 @@
+# BasicKube
+
+一个面向业务开发的k8s基础UI系统，非开箱即用，不适用于对K8s集群进行管理操作。
+
+# 功能
+
+## 环境和组
+
+支持对资源进行环境划分：开发环境、测试环境、预发布环境、线上环境。不同环境的同一个服务或资源形成“组”。
+
+![image-20230330001432516](assets/README/image-20230330001432516.png)
+
+## K8s 基础功能支持
+
+支持对以下 K8s 资源增删改查的**基本**操作。
+
+1. - [x] Deployment
+   - - [x] 主容器镜像发布
+       ![image-20230330001651823](assets/README/image-20230330001651823.png)
+   - - [x] 伸缩
+2. - [x] Service
+     ![image-20230330001734647](assets/README/image-20230330001734647.png)
+3. - [x] Ingress
+     ![image-20230330001751219](assets/README/image-20230330001751219.png)
+4. - [x] DaemonSet
+5. - [x] Job
+
+> **注意**：
+> 在 BasicKube 中，Deployment 组又被称为应用组。应用广义上包含 Deployment、DaemonSet 等，在 BasicKube 中，在没有明确说明下，应用仅代指 Deployment。
+
+## Pod 终端
+
+BasicKube 提供一个 Web 终端，可以用来连接容器，对 Pod 进行操作。
+
+![image-20230330000903519](assets/README/image-20230330000903519.png)
+
+## Pod 事件查看
+
+![image-20230330001509325](assets/README/image-20230330001509325.png)
+
+# 配置
+
+## IAM
+
+IAM（身份验证和访问管理）受 AWS IAM 启发，用于在 k8s 集群上控制用户的命名空间权限。
+
+### 设计理念
+
+1. 通过关联一个 IAM 节点，可以将一个项目与一个 k8s 命名空间相关联。
+2. 一个项目可以有多个用户，一个用户也可在在多个项目下。
+
+![](assets/README/iam.png)
+
+### 配置IAM和命名空间的映射
+
+1. 打开 `appsettings.json` 文件
+2.  添加 `K8s:NameSpaceMap` 选项:
+
+```json
+{
+  "Logging": {
+    ...
+  },
+  "K8s": {
++    "NameSpaceMap": {
+      "1": "default"
+    }
+  }
+}
+```
+
+在 `K8s:NameSpaceMapg` 中，key 是 IAM 节点, 值是 k8s 的命名空间。
+
+## K8s集群配置
+
+1. 在 `BasicKube.Api/configs` 目录下添加K8s的配置文件
+2. 添加  `K8s:ClusterConfig` 配置项：
+
+```json
+{
+  "K8s": {
+    "NameSpaceMap": {
+      ...
+    },
++    "ClusterConfig": {
+      "dev": "./configs/k8s-cluster-config-dev",
+      "test": "./configs/k8s-cluster-config-default",
+      "staging": "./configs/k8s-cluster-config-default",
+      "prod": "./configs/k8s-cluster-config-default"
+    }
+  }
+}
+```
+
+在 `K8s:ClusterConfig ` 配置项中，key 是环境名，value 是k8s集群的配置文件。
+
+## 外部账号系统集成
+
+BasicKube 中不涉及账号系统，需要通过 `AccountController` 和现有的账号体系进行集成。`AccountController` 位于`BasicKube.Api/Controllers/Account` 目录下。
+
+# 协议
+
+禁止商业使用，对个人学习或其他使用，参考MIT协议。
+
+# OS
+
+1. ASP.NET Core full-stack
+2. Ant Design Blazor
+3. KubernetesClient
+4. Blazored.*
+5. Serilog.*
+6. ...
+

README.md

@@ -1 +1,113 @@
-# BasicKube
+# BasicKube
+
+A non-out-of-the-box basic k8s UI for business developers, not suitable for managing K8s clusters.
+
+# Features
+
+## Environment and Group
+
+Support for environment-based resource partitioning: development environment, testing environment, staging environment, and production environment.
+
+The same service or resource in different environments forms a "**group**".
+
+![image-20230330001432516](assets/README/image-20230330001432516.png)
+
+## Basic operations in Kubernetes:
+
+Support basic CRUD (create, read, update, delete) operations for the following K8s resources:
+
+1. - [x] Deployment
+   - - [x] Publishing the main container image of a Pod![image-20230330001651823](assets/README/image-20230330001651823.png)
+   - - [x] Scaling
+2. - [x] Service
+     ![image-20230330001734647](assets/README/image-20230330001734647.png)
+3. - [x] Ingress
+     ![image-20230330001751219](assets/README/image-20230330001751219.png)
+4. - [x] DaemonSet
+5. - [x] Job
+
+> **note**：
+> In BasicKube, the Deployment group is also referred to as the Application group. In a broad sense, an application includes Deployment, DaemonSet, and so on. However, in BasicKube, when not explicitly stated, the term "application" refers only to Deployment.
+
+## Pod Container Terminal
+
+BasicKube provides a web terminal that can be used to connect to containers and perform operations on Pods.
+
+![image-20230330000903519](assets/README/image-20230330000903519.png)
+
+## Viewing Pod events.
+
+![image-20230330001509325](assets/README/image-20230330001509325.png)
+
+# Configuration
+
+## IAM
+
+Identity and Access Management(IAM) inspired by AWS IAM, used to control user permissions on the k8s namespace.
+
+### Design concept
+
+1. One project is associated with a namespace by associating an IAM node. 
+2. A project can contain multiple users, and a user can also be under multiple projects.
+
+![](assets/README/iam.png)
+
+### Configure the mapping of IAM node and namespace
+
+1. Open `appsettings.json` file
+2.  Add `K8s:NameSpaceMap` configuration:
+
+```json
+{
+  "Logging": {
+    ...
+  },
+  "K8s": {
++    "NameSpaceMap": {
+      "1": "default"
+    }
+  }
+}
+```
+
+In the section `K8s:NameSpaceMapg`，key is the IAM node, and the value is k8s namespace.
+
+## K8s cluster configuration
+
+1. Add the configuration file for the k8s cluster under directory `BasicKube.Api/configs`
+2. Set the **mapping between the environment and the k8s cluster** in the `appsettings.json` file. The section is `K8s:ClusterConfig`:
+
+```json
+{
+  "K8s": {
+    "NameSpaceMap": {
+      ...
+    },
++    "ClusterConfig": {
+      "dev": "./configs/k8s-cluster-config-dev",
+      "test": "./configs/k8s-cluster-config-default",
+      "staging": "./configs/k8s-cluster-config-default",
+      "prod": "./configs/k8s-cluster-config-default"
+    }
+  }
+}
+```
+
+In the section `K8s:ClusterConfig`，key is the environment name, and the value is the configuration file for the k8s cluster .
+
+## External account system integration
+
+There is no account system function in BasicKube, it needs to be integrated with the existing account system in `AccountController`, which is under `BasicKube.Api/Controllers/Account`.
+
+# License
+
+Prohibition of commercial use, with reference to the MIT license for personal learning or other uses.
+
+# OS Reference
+
+1. ASP.NET Core full-stack
+2. Ant Design Blazor
+3. KubernetesClient
+4. Blazored.*
+5. Serilog.*
+6. ...

assets/README/iam.png

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2023-03-29T05:13:12.626Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/16.5.1 Chrome/96.0.4664.110 Electron/16.0.7 Safari/537.36" etag="hMGf2Mh31hmNzUv80xqW" version="16.5.1" type="device"><diagram id="AzPtRsoyrg-ZZ3mYgEX7" name="IAM">7VpbV+IwEP41PLqnbXrzEfCy7lkv57h7vLx4Co1ttTScNAj46zehKb1MQHRBiiIPJtNkaOb7ZiaT0ELdweSUesPwnPg4bhmaP2mho5Zh6Bpy+T8hmWYSWzvMBAGNfDmoEFxHrzifKaWjyMdpZSAjJGbRsCrskyTBfVaReZSScXXYI4mr3zr0AgwE130vhtKbyGdhJnUNp5D/xFEQ5t+s23J9Ay8fLFeShp5PxiUROm6hLiWEZa3BpItjYbzcLtm8kwVP5y9GccJWmXB7HvUukuuLE/eh7T/cdP4aQ/tAl2pevHgkV3zWPpcvzKa5FSgZJT4WirQW6ozDiOHrodcXT8ccdy4L2SDmPZ03U0bJ89xafJ0d30vD2Wzx+DGK4y6JCZ2pRscn4iPkJGESf92U/dI4x3HmunNxQhI+vAMtka8KU4YnJZG0zCkmA8zolA+ZVOkmWerK7riA3NGkLCzBjZAUepJmwVxzgQRvSDDeA4wGgAGoYJ9TVXYJZSEJSOLFx4W0U8WtGPObkKGE4wkzNpV290aMVLHEid8WXlQYm0tOIrGWmUqI9UIwUjKiffnm6ejg4MXoXV6evfauzL52ObgPDnL39miA2ZJxZjZOrH4ptBTHHoteqo78P0Ate+sSTqMUUx2AxYnIVH5S43LZO6TIi6Mg4d0+tyjm8o6gdcRDVFs+GES+P4Nb5ZhVCpSdzF6P65hV19FNC/iOrXKdNXiOEhBDCQj0nu8CiHEIg9mnAoKUgKBvC8g8aXwCIMrcAj1kG6kFpo63ks3HU4sJU4s66zYqtZgApyElT3yXC7NLgYb+9gatTvF3JPF37KicWl5QsF43FLS3N0V7aM6vvqOyVqQ9ahTtrUW0h3g1n/bGIdwObYz2SnPawJzPbtoSr2DHIt/2KG8FopV4A5wK8+1CfLGsLcYXpaGd9xt6FxhdN/T2Ge2uEMhBlC2ZbfmGD08idpsHa96+E+N+WLJ3NJHTZp1p3kn4um7LndIs0S2mzXr5vG2Uz9aKwb4Er6VAN5etnBPkN1yRiK9s0cGLjqyqhmzZclL5dKumx67qcWtqMqsANTP6zdf8cUYe7hm5uBLfNUbWKGnoH6RkndtA0YZJudIR4vdjJfoSrETrYiWqR9z1sVJZa8DdPSTlzlZhyw4V3iScvSLh1l6FLXvr+sWQlhB/J+oD5Dbt/AEWYl+d+auGWqdRzIfn1QXzd6FgqzP/Uwu2Xr9L0V373n349cfBpjm+PespYkmT78dKl87a7K8FL6cXYKJAbnFdjWqJWDMBTCqUjE2hZOxRgijNb8+aghKMTnuUgC/pJkz2n4oSvGvYo8RLoYahBGuRPUoGshuGEtw371ECeWnrKMFD+T1KIOJtffcAD6r3KIGIt0GUeLf4xW92pFb8bhod/wM=</diagram></mxfile>

assets/README/image-20230330000903519.png

@@ -0,0 +1,12 @@
+
+using System.ComponentModel;
+
+namespace BasicKube.Models;
+public class IamNodeInfo
+{
+    [DisplayName("项目")]
+    public string Project { get; set; } = "";
+
+    [DisplayName("IamId")]
+    public int IamId { get; set; }
+}

assets/README/image-20230330001432516.png

@@ -1,5 +1,4 @@
-@inject AuthenticationStateProvider _authStateProvider
-@inject NavigationManager _navigationManager
+@inject NavigationManager _navigationManager
 @inject AccountHttp _accountHttp
 @inject AuthService _authService
 
@@ -23,15 +22,14 @@
 @code {
     private async Task OnNavigateAsync(NavigationContext args)
     {
+        Console.WriteLine("OnNavigateAsync");
         var isAuthed = await _authService.GetIsAuthed();
-
-        var user = (await (_authStateProvider as IamAuthStateProvider)!.GetAuthenticationStateAsync()).User;
-        if (isAuthed && !user!.Identity!.IsAuthenticated)
+        if (isAuthed && !(await _authService.IsAuthenticated()))
         {
             var userProfile = await _accountHttp.GetUserProfile();
             if (userProfile != null)
             {
-                (_authStateProvider as IamAuthStateProvider)!.SetAuthInfo(userProfile);
+                _authService.SetUserProfile(userProfile);
             }
             else
             {

assets/README/image-20230330001509325.png

@@ -16,6 +16,7 @@
 		<PackageReference Include="AntDesign" />
 		<PackageReference Include="BcdLib.BcdForm" />
 		<PackageReference Include="Blazored.LocalStorage" />
+		<PackageReference Include="Blazored.SessionStorage" />
 		<PackageReference Include="IconPark.Blazor" />
 		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" />
 		<PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly.Authentication" />

assets/README/image-20230330001651823.png

@@ -3,6 +3,7 @@
 using BasicKube.Web.Services.Http;
 using BasicKube.Web.Services.JsIntertop;
 using Blazored.LocalStorage;
+using Blazored.SessionStorage;
 using Microsoft.AspNetCore.Components.Authorization;
 using Microsoft.AspNetCore.Components.Web;
 using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
@@ -34,6 +35,7 @@ public static async Task Main(string[] args)
             builder.Services.AddAuthorizationCore();
             builder.Services.AddScoped<AuthenticationStateProvider, IamAuthStateProvider>();
             builder.Services.AddBlazoredLocalStorage();
+            builder.Services.AddBlazoredSessionStorage();
 
             var host = builder.Build();
             host.Services.UseBcdForm();

assets/README/image-20230330001734647.png

@@ -8,7 +8,7 @@
        OnExpand="OnRowExpand"
        HidePagination
        Size=@TableSize.Middle>
-    <RowTemplate>
+    <ColumnDefinitions>
         <PropertyColumn Property="@(c=>c!.Name)" />
         <PropertyColumn Property="@(c=>c!.GetStartTimeStr())" Title="StartTime" />
         <PropertyColumn Property="@(c=>c!.HostIp)" />
@@ -46,7 +46,7 @@
                 </SpaceItem>
             </Space>
         </ActionColumn>
-    </RowTemplate>
+    </ColumnDefinitions>
     <ExpandTemplate Context="rowData">
         <Table DataSource="rowData.Data.ContainerDetails.Values.ToList()"
                Loading="@(rowData.Data.ContainerDetails==null)"
@@ -74,20 +74,20 @@
     </ExpandTemplate>
 </Table>
 
-<Drawer Width="800" Closable="true" Visible="visible" Placement="right" Title='("Basic Drawer")' OnClose="_=>close()">
+<Drawer Width="800" Closable="true" Visible="visible" Placement="right" Title='("Events")' OnClose="_=>close()">
     <Table Class="pods-events"
            DataSource="@_events"
            TItem="EventInfo"
            HidePagination
            Size=@TableSize.Middle
            Loading=@(_events.Count == 0)>
-        <RowTemplate>
+        <ColumnDefinitions>
             <PropertyColumn Property="@(c=>c!.GetDateTimeStr())" Title="EventTime"/>
             <PropertyColumn Property="@(c=>c!.Type)" />
             <PropertyColumn Property="@(c=>c!.Reason)" />
             <PropertyColumn Property="@(c=>c!.Source)" />
             <PropertyColumn Property="@(c=>c!.Message)" />
-        </RowTemplate>
+        </ColumnDefinitions>
     </Table>
 </Drawer>
 

assets/README/image-20230330001751219.png

@@ -6,27 +6,6 @@ namespace BasicKube;
 
 public class IamPage : ComponentBase
 {
-    [Inject]
-    public AuthenticationStateProvider AuthenticationStateProvider { get; set; } = default!;
-
     [Parameter]
     public int IamId { get; set; }
-
-    protected override async Task OnParametersSetAsync()
-    {
-        var authState = await AuthenticationStateProvider
-            .GetAuthenticationStateAsync();
-        var user = authState.User;
-
-        //if (user.Identity is not null && user.Identity.IsAuthenticated)
-        //{
-        //    authMessage = $"{user.Identity.Name} is authenticated.";
-        //    claims = user.Claims;
-        //    surname = user.FindFirst(c => c.Type == ClaimTypes.Surname)?.Value;
-        //}
-        //else
-        //{
-        //    authMessage = "The user is NOT authenticated.";
-        //}
-    }
 }