自建Gitlab遷移
本文為您介紹使用Codeup-CLI工具助力自建Gitlab數(shù)據(jù)遷移,輕松實現(xiàn)Git代碼、用戶權限及合并請求的批量遷移,大幅降低企業(yè)遷移成本,最小化對業(yè)務的影響。
一、前提條件
操作前,請確認工具已安裝并運行正常,具體請參見安裝本地遷移工具。
二、遷移準備
例如,您有一個自建的Gitlab服務,上面有若干個用戶,以及若干代碼庫和已經(jīng)設置好的代碼庫成員權限、保護分支規(guī)則,正在進行合并請求中等。
本工具可以幫助您進行如下數(shù)據(jù)的遷移:
代碼庫Git數(shù)據(jù)。
代碼庫的基本設置:僅包括庫的描述信息、庫的默認分支設置。
代碼庫的保護分支規(guī)則:僅包括分支名、允許推送角色、允許合并角色。
代碼庫的成員權限:根據(jù)提供的用戶映射配置文件,將Gitlab用戶映射到Codeup的庫用戶,并將用戶添加到Codeup的對應代碼庫成員中,轉變?yōu)镃odeup的庫角色時有如下映射原則。
Gitlab 庫角色
Codeup 庫角色
Owner/Mantainer
庫管理員
Developer
庫開發(fā)者
Repertor/Guest
庫瀏覽者
代碼庫中正在進行中的合并請求(已開啟的合并請求):會在Codeup中以遷移操作人的身份創(chuàng)建同名的合并請求,并將能識別到映射關系的評審者進行遷移。不會保留已有的評論、動態(tài)和創(chuàng)建人等信息。
代碼庫已配置的Webhooks。
如果您已經(jīng)安裝好工具,并測試工具正??蛇\行,確認遷移的數(shù)據(jù)內(nèi)容如上述。我們推薦您遵照下面的遷移計劃:
在正式遷移生產(chǎn)庫前,建議使用非正式庫進行試遷移,保障配置正確后在進行正式遷移。
在遷移操作時建議控制自建Gitlab的庫變更和寫入行為,一旦倉庫遷移成功后,重復遷移不會刷新變更的代碼數(shù)據(jù),即遷移后Gitlab的新增內(nèi)容不會更新至Codeup。
三、定義遷移配置文件
開始遷移前,請輸入以下命令,初始化本次遷移所需的配置文件。
./codeup-cli init
此時可以看到配置文件初始化成功的提示。
demo:workspace my$ ./codeup-cli init 【提示】 配置文件路徑:/Users/my/config.yaml 【成功】 初始化 config.yaml 成功,路徑地址為:/Users/my/config.yaml,請按照幫助文檔正確填寫配置。
接著根據(jù)提示的路徑,打開這個config.yaml文件,開始填寫源和目標平臺的配置參數(shù),用于代碼庫拉取和導入。
配置文件字段說明如下,請?zhí)顚懕靥畹淖侄危?b>其中HTTP或SSH克隆二選一填寫,不需要的字段請自行刪除:
source - 源平臺參數(shù)配置
是否必填
參數(shù)說明
platform
必填
暫支持:gitlab
apiEndpoint
必填
自建GitLab平臺的首頁地址 ,如 https://gitlab.example.com。
host
必填
GitLab代碼庫克隆URL的一級地址,如 HTTP 克隆地址為“https://gitlab.my-example.com/demo.git”,則host 為“https://gitlab.my-example.com”。
accessToken
必填
GitLab管理員賬號的AccessToken,需勾選授予權限r(nóng)ead_api,參見Access Token 訪問令牌如何獲???。
username
如用HTTP克隆必填
自建GitLab平臺可用于HTTP克隆的用戶名。
password
如用HTTP克隆必填
自建GitLab平臺可用于HTTP克隆的密碼。
accessKey
暫無
系統(tǒng)預留字段。
secretKey
暫無
系統(tǒng)預留字段。
orgID
暫無
系統(tǒng)預留字段。
localSSHKeyPath
如用SSH克隆必填
自建GitLab平臺已配置的SSH key對應的本地私鑰key路徑,注意填寫完整路徑,如 /Users/my/.ssh/id_rsa。
具體路徑請根據(jù)實際本機私鑰存放路徑填寫。
asMember
必填
true:僅遷移操作人是成員的代碼庫;
false:遷移操作人有讀權限的庫(針對整站搬遷的場景,用戶可能擁有平臺Admin權限,但并不屬于庫成員,此時可將該參數(shù)設置為 false,此時會查詢所有有讀權限的庫,而不限于必須有庫成員權限)。
target - 目標平臺參數(shù)配置
是否必填
參數(shù)說明
platform
必填
codeup (初始化已配置,請勿修改)。
apiEndpoint
必填
devops.cn-hangzhou.aliyuncs.com(初始化已配置,請勿修改)。
host
必填
codeup.aliyun.com(初始化已配置,請勿修改)。
accessToken
必填
阿里云主賬號在Codeup的個人訪問令牌,需勾選授予權限 write:repo,參見個人訪問令牌。
username
如用HTTP克隆必填
Codeup可用于HTTP克隆的用戶名
password
如用HTTP克隆必填
Codeup可用于HTTP克隆的密碼
accessKey
必填
阿里云的主賬號(同時需要作為Codeup目標企業(yè)的擁有者)AK (AccessKey ID)參見如何獲取
secretKey
必填
阿里云的主賬號(同時需要作為Codeup目標企業(yè)的擁有者)SK(AccessKey Secret)參見如何獲取
orgID
必填
期望遷移到的Codeup企業(yè)ID,可在云效企業(yè)管理后臺查看
localSSHKeyPath
如用SSH克隆必填
Codeup已配置的SSH key對應的本地私鑰key路徑,注意需填寫完整路徑,如 /Users/my/.ssh/id_rsa。
具體路徑請根據(jù)實際本機私鑰存放路徑填寫。
以SSH方式為例,簡化的配置文件內(nèi)容如下:
import: source: platform: gitlab apiEndpoint: https://gitlab.example.com accessToken: xxxxx host: https://gitlab.my-example.com localSSHKeyPath: /Users/my/.ssh/id_rsa asMember:true target: platform: codeup apiEndpoint: devops.cn-hangzhou.aliyuncs.com accessToken: xxxxx host: codeup.aliyun.com accessKey: xxxxx secretKey: xxxxx orgID: xxxxx localSSHKeyPath: /Users/my/.ssh/id_rsa # projectlistpath指定步驟五里遷移庫范圍文件路徑。 projectlistpath: projects.csv # usermappath指定步驟四里用戶映射文件路徑。 usermappath: users.csv # workdir指定遷移的工作目錄路徑,遷移完成后將自動清理目錄。 workdir: /Users/my/workspace
四、定義 Gitlab 用戶映射文件(可選)
GitLab和Codeup用戶關系存在以下兩種情況:
GitLab用戶已經(jīng)在Codeup上手動自己創(chuàng)建了一個用戶(可能同名或不同名)。
Gitlab用戶在Codeup上沒有對應的用戶。
首先要明確的是GitLab的用戶數(shù)據(jù)和Codeup上的用戶數(shù)據(jù)是獨立不相關的,對于Codeup來說需要提供映射關系表。
即使您知道Codeup上有個叫張三的用戶,在Gitlab有一個zhangsan的用戶,兩個用戶其實是同一個人,那么也是需要告訴工具,兩個賬號的關聯(lián)關系。這樣就需要一個用戶的映射配置文件,遷移工具會根據(jù)這個用戶映射文件,將GitLab用戶權限關系數(shù)據(jù)遷移到Codeup對應代碼庫內(nèi)。
使用以下命令初始化三方平臺與云效成員映射文件:
./codeup-cli import --gen user
在工作目錄下可以看到生成了一個用于描述用戶映射關系的文件users.csv,打開文件,其內(nèi)容的格式是每一行都是 [Gitlab的用戶名],[Codeup用戶的阿里云ID],示例如下:
#GitLab用戶名(username),Codeup用戶的阿里云ID
zhangsan,11232342143245234
lisi,1231312312311
您可以手動編輯這個文件,增加或刪除用戶映射的配置。
請注意,為了保證遷移時Codeup能夠識別到對應阿里云用戶,請確保該用戶已經(jīng)登錄訪問過 Codeup。
阿里云賬號ID獲取方式:在 https://www.aliyun.com主頁右上角點擊頭像-賬號ID
五、定義遷移代碼庫范圍
您需要告知遷移工具要遷移的代碼庫列表范圍,這也需要一個配置文件。
可以通過以下命令,自動分析出在GitLab中的所有代碼庫并生成這個遷移庫范圍的配置文件。
./codeup-cli import --gen project
命令執(zhí)行完成后會在當前目錄下生成一個projects.csv的配置文件,打開文件,其內(nèi)容格式是每一行都是[GitLab代碼庫路徑],[Codeup代碼庫路徑],[Codeup代碼庫可見性],形如:
#GitLab代碼庫路徑(不包括域名前綴),Codeup代碼庫路徑,Codeup代碼庫可見性
groupname/demo,groupname/demo,10
其中代碼庫可見性 0 表示公開性為「私有」,10 表示公開性為「企業(yè)內(nèi)公開」。若自定義時輸入任意非 0 的數(shù)字將被自動轉換為 10,即企業(yè)內(nèi)公開。
您可以手動編輯這個文件,增加或刪除期望遷移的代碼庫范圍。至此,您已經(jīng)明確了遷移的代碼庫范圍。
六、執(zhí)行遷移
即將大功告成,請確認目前工作目錄下3個配置文件(遷移配置文件、用戶映射文件、代碼庫范圍文件)和存放代碼庫的文件夾(例如自定義的“repo”)已準備完畢:
通過以下命令啟動執(zhí)行遷移:
./codeup-cli import --run true
# 遷移過程中會展示遷移的細節(jié),如果有問題會顯示報錯信息
如 Git 數(shù)據(jù)遷移失敗,該庫狀態(tài)為遷移失敗,其他附屬成員權限、保護分支、合并請求遷移失敗僅做警告,不阻斷導入。
若重復執(zhí)行導入,歷史已導入成功的代碼庫將提示已存在跳過執(zhí)行,未導入成功的代碼庫可繼續(xù)嘗試導入。
工具執(zhí)行完后,如果一切正常,您便可以前往Codeup企業(yè)查看已遷移的代碼庫、成員和合并請求等信息,以確認遷移無誤。
遷移過程中遇到無法處理的問題,請?zhí)砑俞斸斎鹤稍兗夹g支持:32027065。