GNU General Public License v3.0

项目介绍

opendevops-cn/codo-tools 是一个托管在 GitHub 上的开源项目,主要使用 Python 编写,采用 GNU General Public License v3.0 许可证,目前获得 145 个 Star、95 次 Fork。

仓库全名
opendevops-cn/codo-tools
开源许可证
GNU General Public License v3.0
Star 数
145
Fork 数
95
未关闭 Issue
6

README 摘要

运维工具 实现一些运维场景中用到的记录及提醒功能,目前包含以下功能 功能 告警管理 提醒管理 项目管理 事件管理 故障管理 加密解密 随机密码 持续更新.... Demo 告警管理 对接Promethues AlertManager WebHooks,平台控制哪些告警信息发送给哪些人。 示例参考 告警内容 恢复内容 报警截图示例 Email SNS 提醒管理 项目管理 事件管理 故障管理 部署文档 创建数据库 修改配置 修改settings.py配置信息 初始化表结构 Docker部署方式(建议) 修改settings.py配置文件信息,主要是MySQL和Redis配置 修改doc/nginxops.conf 域名地址 Build 镜像 docker build . -t codotools 启动,docker-compose up -d 启动后默认端口:8040 启动后默认日志…

完整内容见 GitHub 原始 README 或本页 。

常见问题

codo-tools 用什么语言开发?

主要使用 Python 编写,采用 GNU General Public License v3.0 许可证,目前有 145 个 Star。

codo-tools 可以免费商用吗?

仓库标注的许可证为 GNU General Public License v3.0,商用前请先阅读仓库 LICENSE 文件确认授权范围。

如何获取 codo-tools 的源码?

可以直接克隆仓库:git clone https://github.com/opendevops-cn/codo-tools.git,默认分支为 master;安装与运行步骤见仓库 README。

codo-tools 最近还在维护吗?

仓库最近一次更新为 2021年7月27日,当前有 6 个未关闭 Issue;Star 数为 145,可作为社区活跃度的参考。

简要分析

热度分
342
价值分
115
活跃状态
活跃

语言占比

Dockerfile
Python
Shell

README

运维工具

实现一些运维场景中用到的记录及提醒功能,目前包含以下功能

功能

  • 告警管理
  • 提醒管理
  • 项目管理
  • 事件管理
  • 故障管理
  • 加密解密
  • 随机密码
  • 持续更新…
Demo

告警管理

对接Promethues AlertManager WebHooks,平台控制哪些告警信息发送给哪些人。

示例参考

告警内容

[Prometheus AlertManager]


状态:firing  
名称:Node主机CPU利用率过高
告警实例:172.16.1.53:9100
Namespace:monitoring/k8s
告警级别:严重

描述信息:
172.16.1.53:9100: CPU利用率过高于75% (当前值: 92.73333333355065)

恢复内容

[Prometheus AlertManager]


状态:resolved
名称:Node主机CPU利用率过高
告警实例:172.16.1.53:9100
Namespace:monitoring/k8s
告警级别:严重

描述信息:
172.16.1.53:9100: CPU利用率过高于75% (当前值: 92.75000000023283)

报警截图示例

  • Email

  • SNS

提醒管理

项目管理

事件管理

故障管理

部署文档

创建数据库

create database `codo_tools` default character set utf8mb4 collate utf8mb4_unicode_ci;

修改配置

  • 修改settings.py配置信息

初始化表结构

python3 db_sync.py
#也可以直接source doc/codo_tools.sql

Docker部署方式(建议)

  • 修改settings.py配置文件信息,主要是MySQL和Redis配置

  • 修改doc/nginx_ops.conf 域名地址

  • Build 镜像 docker build . -t codo_tools

  • 启动,docker-compose up -d

  • 启动后默认端口:8040

  • 启动后默认日志:

    • 服务日志:/var/log/supervisor/tools.log
    • 定时提醒:/var/log/supervisor/cron_jobs.log

本地部署方式

建议使用虚拟环境 具体参考Dockerfile 内的安装步骤

  • 修改settings.py配置文件信息,主要是MySQL和Redis配置

  • 安装依赖

pip3 install --user --upgrade pip
pip3 install -U git+https://github.com/ss1917/ops_sdk.git
pip3 install -r /var/www/codo-tools/doc/requirements.txt
  • 从doc目录获取supervisor配置文件 使用 supervisor启动 supervisorctl restart

  • 若启动多进程请使用nginx代理出来,可参看doc/nginx_ops.conf配置文件

  • Debug参考run.sh文件,直接启动

服务注册

由于我们每个模板都是单独部署的,微服务需要在API网关进行注册

示例

rewrite_conf = {
    [gw_domain_name] = {
        rewrite_urls = {
            {
                uri = "/tools",
                rewrite_upstream = "tools.opendevops.cn:8040"  #nginx配置的域名
            },
            {
                uri = "/mg",
                rewrite_upstream = "mg.opendevops.cn:8010"
            },
            {
                uri = "/accounts",
                rewrite_upstream = "mg.opendevops.cn:8010"
            },
        }
    }
}

评论

暂无评论