opensourcemano/keystone

OSM Keystone Interface 镜像文档

镜像概述与主要用途

OSM Keystone Interface 镜像是 Open Source MANO (OSM) 项目的核心组件之一，提供与 OpenStack Keystone 身份服务的集成接口。该镜像实现了 OSM 与 Keystone 之间的身份验证、授权及用户管理交互，为 OSM 各模块（如 NFVO、VNFM 等）提供统一的身份服务接入能力，确保 OSM 环境中资源访问的安全性与合规性。

核心功能与特性

核心功能

• 身份验证集成：与 OpenStack Keystone 服务对接，支持基于 Keystone 凭证（用户名/密码、令牌等）的用户身份验证。
• 授权管理：通过 Keystone 的角色与权限模型，实现 OSM 资源访问的细粒度授权控制（如 NFV 资源操作权限、项目级访问隔离等）。
• 用户与项目映射：支持 OSM 内部用户/项目与 Keystone 域、项目的关联映射，简化跨平台身份统一管理。
• 令牌处理：支持 Keystone 令牌的生成、验证与刷新，确保 OSM 组件间通信的安全性。

特性

• 兼容性：适配 OpenStack Keystone v3 API，支持主流 OpenStack 版本（如 Stein、Train 等）。
• 轻量化：基于精简基础镜像构建，资源占用低，部署高效。
• 可配置性：通过环境变量或配置文件灵活调整 Keystone 连接参数、超时设置等。
• 日志集成：支持标准输出日志与文件日志，便于问题排查与监控。

使用场景与适用范围

典型使用场景

• OSM 与 OpenStack 集成部署：在基于 OpenStack 的云基础设施中部署 OSM 时，作为身份服务接口，实现 OSM 与 OpenStack 统一身份认证。
• 多租户 MANO 环境：在多租户网络功能虚拟化（NFV）场景中，通过 Keystone 的域/项目模型隔离不同租户的 OSM 资源访问权限。
• 自动化运维集成：为 OSM 的自动化运维工具（如 Ansible 脚本、CI/CD 流水线）提供标准化身份验证入口。

适用范围

• 基于 OSM 的网络功能编排（MANO）环境。
• 需要与 OpenStack Keystone 进行身份集成的 NFV 管理平台。
• 对资源访问安全有严格要求的电信云或企业云场景。

使用方法与配置说明

前置条件

• 已部署 OpenStack Keystone 服务（v3 API），并创建用于 OSM 集成的用户、项目及角色。
• 已安装 Docker 环境（Docker 19.03+）。
• 网络环境中，OSM Keystone Interface 容器需能访问 Keystone 服务及 OSM 其他组件（如 NFVO）。

Docker 部署示例

1. 基础运行命令

bash
docker run -d \
  --name osm-keystone-interface \
  --network osm-net  # 需与 OSM 其他组件在同一网络（如 osm-net）\
  -e KEYSTONE_URL="http://<keystone-ip>:5000/v3" \  # Keystone v3 API 地址\
  -e USER_DOMAIN_NAME="Default" \  # 用户域名称（与 Keystone 配置一致）\
  -e PROJECT_DOMAIN_NAME="Default" \  # 项目域名称\
  -e PROJECT_NAME="osm-project" \  # OSM 服务所属 Keystone 项目\
  -e USERNAME="osm-admin" \  # Keystone 中用于 OSM 的用户名\
  -e PASSWORD="osm-keystone-password" \  # 对应用户的密码\
  -e LOG_LEVEL="INFO" \  # 日志级别（DEBUG/INFO/WARNING/ERROR）\
  -v /host/path/to/config:/etc/osm/keystone-interface  # 挂载自定义配置文件（可选）\
  opensourcemano/keystone-interface:latest

2. Docker Compose 配置示例

yaml
version: '3'
services:
  osm-keystone-interface:
    image: opensourcemano/keystone-interface:latest
    container_name: osm-keystone-interface
    networks:
      - osm-net
    environment:
      - KEYSTONE_URL=http://keystone:5000/v3
      - USER_DOMAIN_NAME=Default
      - PROJECT_DOMAIN_NAME=Default
      - PROJECT_NAME=osm-project
      - USERNAME=osm-admin
      - PASSWORD=osm-keystone-password
      - LOG_LEVEL=INFO
    volumes:
      - ./keystone-interface-config:/etc/osm/keystone-interface  # 挂载自定义配置
    restart: unless-stopped

networks:
  osm-net:
    external: true  # 假设已存在 OSM 专用网络 osm-net

配置参数与环境变量

核心环境变量

配置文件挂载（可选）

如需自定义更复杂的配置（如 SSL 证书、高级权限策略），可通过挂载配置文件目录实现。默认配置文件路径为容器内 /etc/osm/keystone-interface/config.yaml，用户可在宿主机创建配置文件后挂载：

bash
-v /host/path/to/config.yaml:/etc/osm/keystone-interface/config.yaml

许可证与合规说明

基础软件许可证

本镜像包含的 OSM 软件遵循 OSM 许可证（Apache License 2.0 或其他指定许可证，具体以 OSM 官方声明为准）。

第三方软件合规

镜像可能包含基础操作系统组件（如 Bash、libc 等）及依赖库，此类软件的许可证由其原始发行方定义（如 Debian、Ubuntu 等）。用户在使用本镜像时，需确保遵守所有包含软件的许可证要求。

用户责任

作为预构建镜像的使用者，您有责任验证并确保对本镜像的任何使用均符合相关软件的许可证条款。

参考与链接

• OSM 项目代码仓库
• OSM 开发者指南
• OpenStack Keystone v3 API 文档