jalammas/gogs

OpenShift 环境下的 Gogs 镜像

Gogs 是 Go 语言开发的 Git 服务。了解更多信息请访问 [***]

在 OpenShift 上运行容器有特定的安全及其他要求。本仓库包含：

• 用于构建 OpenShift 兼容 Gogs 镜像的 Dockerfile
• 镜像中使用的各类脚本
• 用于部署镜像的 OpenShift 模板
• 使用说明

前提条件

• OpenShift 3.2+ 环境中的账户及项目
• Gogs 需要数据库存储信息。数据库的配置不在本仓库范围内。若希望在 OpenShift 上运行数据库，建议使用持久存储部署 PostgreSQL。更多关于 OpenShift PostgreSQL 部署的信息请参考：[***]

核心功能与特性

• OpenShift 兼容性：专为 OpenShift 环境设计，满足其安全及运行要求
• 完整 Git 服务：提供代码仓库管理、用户权限控制、代码审查等 Git 服务功能
• 配置持久化：通过 ConfigMap 实现配置文件持久化，避免容器重启导致配置丢失
• 数据持久化：支持通过持久卷声明（PVC）实现仓库数据持久化存储
• 灵活部署：提供 OpenShift 模板，支持自定义应用名称、路由 URL 等参数

使用场景与适用范围

适用于在 OpenShift 3.2+ 平台上部署自托管 Git 服务的场景，适合需要私有代码仓库管理、团队协作开发的企业或开发团队。

使用方法与配置说明

初始部署

使用提供的模板可轻松部署 Gogs：

bash
oc process -f gogs.yaml | oc create -f -

如需修改路由 URL 或应用组件名称，可通过参数指定：

bash
oc process -f gogs.yaml -v APPLICATION_NAME=foo,HOSTNAME_HTTP=www.bar.baz | oc create -f -

注意：当前不支持 HTTPS，欢迎提交 PR 进行改进。

部署完成后，继续进行初始设置。

初始设置

模板默认创建路由。若项目名称为 gogs，默认路由可能类似： http://gogs-gogs.apps.yourdomain.com

访问该 URL，会显示 Gogs 的初始安装页面，按照提示完成设置。安装过程会自动在数据库中创建必要的表。

注意事项：

• 若数据库部署在 OpenShift 且与 Gogs 在同一项目中，可直接使用服务名称作为数据库主机。例如，数据库服务名为 postgresql，则数据库主机填写 postgresql:5432
• "应用 URL" 为路由的完整域名（FQDN），例如上述示例中的 http://gogs-gogs.apps.yourdomain.com
• 请务必设置管理员用户，否则第一个注册用户将自动成为管理员

ConfigMap 配置持久化

初始安装后，Gogs 会在容器文件系统中创建配置文件 /etc/gogs/conf/app.ini。容器重启时该文件不会持久化，因此需使用 ConfigMap 保存配置。

1. 查找部署的 Pod 名称：

   bash
   oc get pod
   NAME                 READY     STATUS    RESTARTS   AGE
   gogs-1-h1vfn         1/1       Running   0          5m
   postgresql-1-fznew   1/1       Running   0          2m
   

2. 通过 oc exec 提取配置文件并创建 ConfigMap：

   bash
   oc create configmap gogs --from-file=appini=<(oc exec gogs-1-h1vfn -- cat /etc/gogs/conf/app.ini)
   

卷挂载

将 ConfigMap 作为卷挂载到容器文件系统，更新 Gogs 部署配置：

bash
oc volume dc/gogs --add --overwrite --name=config-volume -m /etc/gogs/conf/ --source='{"configMap":{"name":"gogs","items":[{"key":"appini","path":"app.ini"}]}}'

注意：此操作会触发 Gogs Pod 重新部署。若初始部署时修改了应用名称，需将 dc/gogs 替换为实际的部署配置名称。

仓库数据持久化存储

Gogs 将 Git 仓库数据存储在容器内的文件系统中，需配置持久化存储以确保数据在容器重启后不丢失。

持久卷（PV）和持久卷声明（PVC）的配置不在本文档范围内，更多信息请参考：[***]

假设已创建 PVC（例如 gogs-pvc），执行以下命令添加持久卷挂载：

bash
oc volume dc/gogs --add --overwrite -t persistentVolumeClaim --claim-name gogs-pvc -m /home/gogs/gogs-repositories --name repos

注意：由于 Gogs 目前仅支持本地文件系统存储，水平扩展 Gogs 服务器可能存在困难。

未来改进方向

• 添加存活/就绪探针
• 完善模板，集成持久化 PostgreSQL
• 支持 SSH 协议的 Git 访问