etcd-manage 项目安装与使用教程

1. 项目目录结构及介绍

etcd-manage/
├── bin/
│   └── ...
├── images/
│   └── ...
├── program/
│   └── ...
├── static/
│   └── ...
├── tpls/
│   └── ...
├── .gitignore
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── README_v1.md
├── docker-compose-cluster.yml
├── docker-compose.yml
├── go.mod
└── main.go

目录结构说明

• bin/: 存放编译后的二进制文件。
• images/: 存放项目相关的图片资源。
• program/: 存放项目的主要代码文件。
• static/: 存放静态资源文件，如CSS、JavaScript等。
• tpls/: 存放模板文件。
• .gitignore: Git忽略文件配置。
• Dockerfile: Docker构建文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建和编译的Makefile文件。
• README.md: 项目介绍和使用说明。
• README_v1.md: v1版本的README文件。
• docker-compose-cluster.yml: 用于集群部署的Docker Compose配置文件。
• docker-compose.yml: 用于单机部署的Docker Compose配置文件。
• go.mod: Go模块依赖管理文件。
• main.go: 项目的主入口文件。

2. 项目启动文件介绍

main.go

main.go 是项目的启动文件，负责初始化配置、启动服务等核心功能。以下是 main.go 的主要内容：

package main

import (
    "etcd-manage/program/config"
    "etcd-manage/program/server"
    "flag"
    "log"
)

func main() {
    // 解析命令行参数
    cfgFile := flag.String("config", "config.yaml", "配置文件路径")
    flag.Parse()

    // 加载配置文件
    cfg, err := config.LoadConfig(*cfgFile)
    if err != nil {
        log.Fatalf("加载配置文件失败: %v", err)
    }

    // 启动服务
    server.Start(cfg)
}

启动流程

1. 解析命令行参数: 通过 flag 包解析命令行参数，获取配置文件路径。
2. 加载配置文件: 调用 config.LoadConfig 函数加载配置文件。
3. 启动服务: 调用 server.Start 函数启动服务。

3. 项目的配置文件介绍

config.yaml

config.yaml 是项目的主要配置文件，用于配置服务的各项参数。以下是一个示例配置文件的内容：

server:
  port: 8080
  log_level: info

etcd:
  endpoints:
    - "http://127.0.0.1:2379"
  username: "admin"
  password: "123456"

database:
  type: "mysql"
  host: "localhost"
  port: 3306
  username: "root"
  password: "root"
  name: "etcd_manage"

配置项说明

• server: 服务配置

  • port: 服务监听的端口号。
  • log_level: 日志级别，可选值为 debug, info, warn, error。

• etcd: etcd 配置

  • endpoints: etcd 集群的地址列表。
  • username: etcd 认证用户名。
  • password: etcd 认证密码。

• database: 数据库配置

  • type: 数据库类型，如 mysql, postgres 等。
  • host: 数据库主机地址。
  • port: 数据库端口号。
  • username: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。

通过以上配置文件，可以灵活地配置 etcd-manage 服务的各项参数，以适应不同的运行环境。