etnaagent/gnomon

Gnomon命名应用 Docker镜像文档

镜像概述

Gnomon命名应用Docker镜像是一个轻量级工具，旨在提供便捷的命名规则生成与管理功能。该镜像封装了Gnomon命名应用的核心功能，支持通过简单配置实现自定义命名规则，帮助用户在各类场景中创建规范、一致的命名方案，提升命名效率与规范性。

核心功能与特性

• 灵活的命名规则定义：支持通过配置文件或环境变量自定义命名规则，满足不同场景下的命名需求
• 多类型命名生成：可生成项目名称、资源标识、实体标签等多种类型的命名
• 规则模板管理：内置常用命名模板，同时支持用户自定义模板的导入与管理
• 轻量级部署：基于精简基础镜像构建，资源占用低，部署便捷
• 跨平台兼容：支持在任何支持Docker的环境中运行，包括Linux、Windows和macOS

使用场景

• 软件开发项目中生成统一的模块、组件或变量命名
• 云资源管理中为服务器、容器、存储等资源创建规范命名
• 团队协作中统一文档、文件或版本的命名格式
• 自动化流程中为生成的资源或输出物自动分配符合规则的名称

使用方法

基本运行方式

通过以下命令启动Gnomon命名应用容器：

bash
docker run -d --name gnomon-naming-app gnomon-naming:latest

自定义配置

通过环境变量配置

支持通过环境变量设置基本命名规则：

bash
docker run -d --name gnomon-naming-app \
  -e NAMING_TEMPLATE="project-{date}-{random:4}" \
  -e DATE_FORMAT="YYYYMMDD" \
  gnomon-naming:latest

• NAMING_TEMPLATE：命名模板，支持变量如{date}（日期）、{random:N}（N位随机数）、{project}（项目名）等
• DATE_FORMAT：日期格式，遵循ISO 8601标准，如"YYYYMMDD"、"YYYY-MM-DD"等

通过配置文件挂载

将自定义配置文件挂载到容器中：

bash
docker run -d --name gnomon-naming-app \
  -v /path/to/your/config.yaml:/app/config.yaml \
  gnomon-naming:latest

配置文件示例（config.yaml）：

yaml
templates:
  default: "resource-{type}-{random:6}"
  project: "project-{name}-v{version}"
date_format: "YYYYMMDD"
random_length: 6

Docker Compose配置

创建docker-compose.yml文件：

yaml
version: '3'
services:
  gnomon-naming:
    image: gnomon-naming:latest
    container_name: gnomon-naming-app
    environment:
      - NAMING_TEMPLATE="service-{name}-{env}"
      - DATE_FORMAT="YYYY-MM-DD"
    volumes:
      - ./config.yaml:/app/config.yaml
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

注意事项

• 首次运行时，容器会自动生成默认配置文件，可通过挂载自定义配置覆盖默认设置
• 支持通过容器日志查看命名生成记录，使用docker logs gnomon-naming-app命令查看
• 如需持久化命名记录，可挂载数据卷到/app/data目录：-v /path/to/data:/app/data