webcenter/rancher-cattle-metadata

rancher-cattle-metadata 镜像说明

镜像概述

本镜像旨在从Rancher元数据中提取配置信息，并将其暴露在scheduler.cfg文件中。由于应用容器中使用的Confd工具无法同时从多个后端获取配置，本镜像通过生成scheduler.cfg文件，让Confd可通过环境变量读取Rancher元数据配置，从而实现更灵活的配置管理。

核心功能

镜像会生成包含以下环境变量的scheduler.cfg文件：

• SCHEDULER_CONTAINERS_IP：当前服务下所有容器的主IP列表（逗号分隔）
• SCHEDULER_CONTAINER_IP：当前容器的主IP
• SCHEDULER_CONTAINER_NAME：当前容器名称
• SCHEDULER_CONTAINER_INDEX：当前容器索引
• SCHEDULER_CONTAINER_STATE：当前容器状态
• SCHEDULER_SERVICE_NAME：当前服务名称
• SCHEDULER_SERVICE_SCALE：当前服务实例数
• SCHEDULER_SERVICE_PORTS：当前服务暴露的端口列表（逗号分隔）
• SCHEDULER_STACK_NAME：当前栈名称
• SCHEDULER_HOST_NAME：当前主机名称
• SCHEDULER_HOST_IP：当前主机公网IP
• SCHEDULER_HOST_HOSTNAME：当前主机 hostname
• SCHEDULER_CONTAINERS_COUNT：当前服务实例数量

使用场景

适用于Rancher环境中，应用容器需要通过Confd管理配置且需结合Rancher元数据的场景，作为sidekick容器为应用提供配置支持。

配置说明

步骤1：添加为sidekick容器

将本镜像作为应用容器的sidekick，并设置volume-from以共享配置：

yaml
# docker-compose.yml示例
version: '2'
services:
  app:
    image: docker.xuanyuan.run/your-app-image
    volumes_from:
      - scheduler
    # 其他应用配置
  scheduler:
    image: docker.xuanyuan.run/webcenter/rancher-cattle-metadata

步骤2：执行初始化脚本

在应用容器的初始化策略中，执行镜像暴露的/opt/scheduler/script.d目录下的所有脚本。例如使用s6-overlay时，添加/etc/cont-init.d/00-extract-scheduler.sh：

sh
#!/usr/bin/with-contenv sh
if [ -d "${SCHEDULER_VOLUME}/script.d" ]; then
  for SCRIPT in ${SCHEDULER_VOLUME}/script.d/*
  do
    if [ -f $SCRIPT ]; then
      sh $SCRIPT
    fi
  done
fi

步骤3：加载配置并运行Confd

在启动Confd前，sourcescheduler.cfg文件以加载环境变量：

sh
#!/usr/bin/with-contenv sh
if [ "${CONFD_NODES}X" == "X" ]; then
  NODE=""
else
  NODE="-node ${CONFD_NODES}"
fi
# 加载scheduler配置
if [ -f "${SCHEDULER_VOLUME}/conf/scheduler.cfg" ]; then
  source "${SCHEDULER_VOLUME}/conf/scheduler.cfg"
fi
# 运行Confd
${CONFD_HOME}/bin/confd -confdir ${CONFD_HOME}/etc -onetime -backend ${CONFD_BACKEND} ${PREFIX} ${NODE}

步骤4：Confd模板中使用环境变量

在Confd模板中通过getenv使用镜像提供的环境变量：

sh
{{ if (getenv "SCHEDULER_CONTAINERS_IP") }}
  # 使用scheduler提供的配置
{{ else }}
  # 使用默认配置
{{ end }}