bitbucket-git-auth-sidecar 镜像文档

镜像概述和主要用途

本镜像为一个sidecar容器，作为Git HTTP(S)代理服务，用于增强对bitbucket.org特定仓库的请求，提供透明认证能力。主要用途是在容器化环境中安全访问私有Bitbucket仓库，自动注入认证信息，避免直接暴露凭证到代码或配置中。

核心功能和特性

• 透明认证注入：自动将OAuth令牌封装为Basic Auth头部，添加到对bitbucket.org目标仓库的HTTP(S)请求中
• Git协议代理：专注处理Git HTTP(S)协议请求，适配git clone/pull/push等标准操作
• 环境变量驱动配置：通过环境变量动态指定目标仓库和认证令牌，无需修改配置文件
• 轻量级sidecar设计：低资源占用，可无缝集成到现有Docker/Kubernetes工作流

使用场景和适用范围

典型使用场景

• 容器化应用依赖拉取：从私有Bitbucket仓库拉取代码或依赖包时，自动注入认证信息
• CI/CD流水线集成：在Jenkins、GitHub Actions等CI/CD系统中，为容器化构建任务提供仓库访问权限
• 多容器协同环境：在Kubernetes Pod中作为sidecar与业务容器共享网络，提供统一的仓库访问入口

适用范围

• Docker单机环境、Kubernetes集群等容器编排平台
• 需要安全访问Bitbucket私有仓库的开发/生产环境
• 对认证凭证管理有严格要求的企业级应用场景

使用方法和配置说明

核心配置参数（环境变量）

Docker部署示例

1. 基础部署（docker run）

docker run -d \
  --name bitbucket-auth-proxy \
  -e repo_slug="my-company/private-repo" \
  -e oauth_token="atlassian-token-xxxxx" \
  --network=app-network \  # 与业务容器共享网络（如需）
  bitbucket-git-auth-sidecar:latest

2. Docker Compose部署

创建docker-compose.yml：

version: '3.8'
services:
  app:
    image: your-business-app:latest
    depends_on:
      - bitbucket-proxy
    environment:
      - http_proxy=[***]  # 指向sidecar代理地址
      - https_proxy=[***]
    networks:
      - app-net

  bitbucket-proxy:
    image: bitbucket-git-auth-sidecar:latest
    environment:
      - repo_slug="my-company/private-repo"
      - oauth_token="atlassian-token-xxxxx"
    networks:
      - app-net

networks:
  app-net:

使用流程说明

1. 配置环境变量：根据目标仓库信息设置repo_slug（账户/仓库名）和有效的oauth_token（Bitbucket个人访问令牌或OAuth令牌）
2. 启动sidecar容器：通过docker run或编排工具启动容器，确保与业务容器处于同一网络（如需直接通信）
3. 配置业务容器代理：在业务容器中设置HTTP(S)代理指向sidecar容器（如[***]，端口需根据镜像实际暴露端口调整）
4. 验证访问：执行git clone [***]等操作，验证是否无需手动输入凭证即可访问

注：代理端口（如示例中的8080）需根据镜像实际实现确认，若未明确指定，建议咨询镜像维护者获取默认端口配置。