# kmanager

**Repository Path**: opencloudos-op-sig/kmanager

## Basic Information

- **Project Name**: kmanager
- **Description**: 安全容器管理平台kmanager
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2023-08-28
- **Last Updated**: 2023-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Kmanager - 安全容器管理平台

欢迎使用Kmanager，一个开源的安全容器管理平台，旨在简化容器的管理和部署过程。Kmanager提供了一套请求、易用的界面和工具，帮助开发者快速构建、部署和管理容器化应用程序。通过完善的资源分类管理功能，合理规划平台资源合理使用。

## 功能特性

- **容器管理**：Kmanager支持常见的容器编排工具，如Docker Compose和Kubernetes，帮助您轻松管理容器集群。
- **界面交互简单优化**： 平台主要目的为开发或运维人员提供快速、简单、移动的容器管理交互方式。
- **应用部署**：通过Kmanager，您可以快速部署和扩展应用程序，无需手动配置和管理底层基础设施。
- **监控和日志**：Kmanager提供实时监控和日志功能，支持k8s集群日志审计功能，同时兼容支持开源监控（prometheus+grafana）、日志（elk）解决方案，帮助您追踪应用程序的性能和运行状态。
- **资源分级管理**：Kmanager实现了以及平台资源为主要背景的资源管理功能，通过对资源的分组、 分级、分类管理，可以有效防止资源、空间、权限滥用，提高系统的安全性。
- **安全性**：Kmanager支持容器平台资源分级管理策略和访问控制等相关功能，确保您的应用程序和数据的安全性。

## 运行环境

运行环境： 部署kmanager 前 请安装k8s（1.18.10 以上）
支持系统：Linux x86
开发语言： go1.18.8

## 快速开始

以下是使用Kmanager的快速开始步骤：

1. 克隆项目代码到本地：

```
git clone https://github.com/your-username/kmanager.git
```

2. 安装依赖项：

```
go mod tidy
```

3. 配置Kmanager：

编辑`config.js`文件，根据您的需求配置数据库连接、认证方式等参数。

4. 启动Kmanager：

```
go run main.go
```

5. 访问Kmanager：

在浏览器中访问`http://localhost:6123`，您将看到Kmanager的登录界面。

## 配置说明：

- **默认账户**

| 默认账户 | 密码     | 角色       | 说明                             |
| -------- | -------- | ---------- | -------------------------------- |
| admin    | admin    | 普通管理员 | 主要用于负责平台日常资源创建管理 |
| sysadm   | sysadm   | 系统管理员 | 主要用于负责平台资源分配管理     |
| auditadm | auditadm | 审计员     | 主要用于负责平台相关审计工作     |
|          |          |            |                                  |

-  **配置文件**

配置文件位于项目根目录`conf.json`

  ```json
  {
    "port": 6123, #平台服务的启动端口
    "path": "./", #平台的运行的工作目录
    "web_file_path": "./",
    "k8s_logs_path": "/var/log/kubernetes/audit/audit.log", #指定K8s日志路径 .主要此功能需要k8s kube-apiserver再带的日志审计功能，详情请见k8s官网
    "k8s_apiyaml_path": "/etc/kubernetes/manifests/kube-apiserver.yaml", #k8s kube-apiserver 的 yaml配置文件路径 
    "use_monitor": false, #是否开启监控模块:true：开；false：关
    "monitor_url":"/d/1ZDGd4W7z/kubernetes-cluster-monitoring-via-prometheus?orgId=1&var-interval=$__auto_interval_interval&var-datasource=Prometheus&var-Node=All&var-job=kubernetes-nodes-cadvisor&kiosk=tv", ##开启监控模块后，监控服务对应的url（不包含IP:PORT ）
    "monitor_ip": "Your monitor node IP", # 监控服务IP
    "monitor_port": 3000,  # 监控服务端口
    "use_elk": false,  #是否开启ELK日志:true：开；false：关
    "elksvc_node_ip": "Your ELK node IP", # ELK服务IP
    "elksvc_node_port": 32601,  # ELK服务端口
    "elksvc_url": "/app/discover#/?embed=true", # ELK服务路径配置
    "nodeport_start": 1,  #端口范围开始值，限制k8s nodeport端口范围使用： 
    "nodeport_end": 60000, #端口范围结束值，限制k8s nodeport端口范围使用：
    "db_path": "./", #数据库存储文件存放路径， 不含文件名
    "db_timeout": 100, #数据链接超时时间
  }
  ```





## 贡献

我们欢迎您为Kmanager安全容器管理平台项目做出贡献！如果您发现了bug或者有新的功能建议，请提交issue或者发起pull request。在参与贡献之前，请阅读我们的贡献指南。

## 社区支持

如果您在使用Kmanager过程中遇到问题，可以通过以下方式获取支持：

- 提交issue：在Gitee上提交问题，我们会尽快回复。
- 加入社区：加入我们的微信群或者论坛，与其他开发者交流和分享经验。

## 开源许可证

This project is licensed under GPL-2.0.