harbor镜像清理（卸载harbor）

背景

最近在巡检过程中，发现harbor存储空间使用率已经达到了80%。于是，去看了一下各项目下的镜像标签数。发现有个别项目下的镜像标签数竟然有好几百个。细问之下得知，该项目目前处于调试阶段，每天调试很多次。既然存储空间不多了，那就去harbor上删除掉之前的镜像标签，保留最近的几个就好了。在手动删除的过程中，发现几百个，每页才展示十个。我得先按照推送时间排序，然后一页一页的删除。心想着这种情况经历一次就好了，不要再有下一次。后来，仔细想想，这个也是不好控制的，每次巡检发现了就得手动删除太麻烦。所以就打算写一个脚本，每次通过脚本去删除镜像的标签，保留最近的几个就好了。刚好最近在学习golang，就用它来写就好了。比较尴尬的是，我脚本写完了，测试没问题后，发现新版本harbor已经可以在UI上设置保留策略了。自我安慰一下，就当作是一种练习、尝试好了!

目标

1. 通过命令行能够查询当前所有的项目、无论是否公开、仓库数量
2. 通过命令行能够查询项目下的仓库名和镜像名、拉取次数
3. 在命令行能够指定标签和保留个数进行删除镜像标签
4. 能够获取镜像的标签数
5. 删除后，不支持立刻垃圾清理，请手动进行垃圾清理(考虑清理过程中无法推拉镜像)

声明

该脚本纯属个人练习所写，不构成任何建议

初学golang，仅仅是为了实现目标，代码质量极差，请谅解

本次使用的harbor是v2.3.1

全部代码请移步至github

实现

获取harbor中所有的项目，API可通过harbor的 swagger获取

1. //根据harborswagger测试出来的结果定义要获取的数据结构
2. typeMetaDatastruct{
3. Publicstring`json:"public"`
4. }
5. typeProjectDatastruct{
6. MetaDataMetaData`json:"metadata"`
7. ProjectIdint`json:"project_id"`
8. Namestring`json:"name"`
9. RepoCountint`json:"repo_count"`
10. }
12. typePData[]ProjectData
13. //提供harbor地址获取project
14. funcGetProject(urlstring)[]map[string]string{
15. //定义url
16. url=url+"/api/v2.0/projects"
17. //url=url+"/api/projects"
18. //构造请求
19. request,_:=http.NewRequest(http.MethodGet,url,nil)
20. //取消验证
21. tr:=&http.Transport{
22. TLSClientConfig:&tls.Config{InsecureSkipVerify:true},
23. }
24. //定义客户端
25. client:=&http.Client{Timeout:10*time.Second,Transport:tr}
26. //client:=&http.Client{Timeout:10*time.Second}
27. request.Header.Set("accept","application/json")
28. //设置用户和密码
29. request.SetBasicAuth("admin","Harbor12345")
30. response,err:=client.Do(request)
32. iferr!=nil{
33. fmt.Println("excutefailed")
34. fmt.Println(err)
35. }
36. //获取body
37. body,_:=ioutil.ReadAll(response.Body)
38. deferresponse.Body.Close()
39. ret:=PData{}
40. json.Unmarshal([]byte(string(body)),&ret)
41. varps=[]map[string]string{}
42. //获取返回的数据
43. fori:=0;i<len(ret);i++{
44. RData:=make(map[string]string)
45. RData["name"]=(ret[i].Name)
46. RData["project_id"]=strconv.Itoa(ret[i].ProjectId)
47. RData["repo_count"]=strconv.Itoa(ret[i].RepoCount)
48. RData["public"]=ret[i].MetaData.Public
50. ps=append(ps,RData)
51. }
52. returnps
53. }

获取项目下的repo

1. //定义要获取的数据结构
2. typeReposiDatastruct{
3. Idint`json:"id"`
4. Namestring`json:"name"`
5. ProjectIdint`json:"project_id"`
6. PullCountint`json:"pull_count"`
7. }
9. typeRepoData[]ReposiData
10. //通过提供harbor地址和对应的项目来获取项目下的repo
11. funcGetRepoData(urlstring,projstring)[]map[string]string{
12. ///api/v2.0/projects/goharbor/repositories
13. url=url+"/api/v2.0/projects/"+proj+"/repositories"
14. //构造请求
15. request,_:=http.NewRequest(http.MethodGet,url,nil)
16. //忽略认证
17. tr:=&http.Transport{
18. TLSClientConfig:&tls.Config{InsecureSkipVerify:true},
19. }
20. client:=&http.Client{Timeout:10*time.Second,Transport:tr}
21. request.Header.Set("accept","application/json")
22. //设置用户名和密码
23. request.SetBasicAuth("admin","Harbor12345")
24. response,err:=client.Do(request)
26. iferr!=nil{
27. fmt.Println("excutefailed")
28. fmt.Println(err)
29. }
30. //获取body
31. body,_:=ioutil.ReadAll(response.Body)
32. deferresponse.Body.Close()
33. ret:=RepoData{}
34. json.Unmarshal([]byte(string(body)),&ret)
35. varps=[]map[string]string{}
36. //获取返回的数据
37. fori:=0;i<len(ret);i++{
38. RData:=make(map[string]string)
39. RData["name"]=(ret[i].Name)
40. pId:=strconv.Itoa(ret[i].ProjectId)
41. RData["project_id"]=pId
42. RData["id"]=(strconv.Itoa(ret[i].Id))
43. RData["pullCount"]=(strconv.Itoa(ret[i].PullCount))
44. ps=append(ps,RData)
45. }
46. returnps
47. }

镜像tag操作

1. //定义要获取的tag数据结构
2. typeTagstruct{
3. ArtifactIdint`json:"artifact_id"`
4. Idint`json:"id"`
5. Namestring`json:"name"`
6. RepositoryIdint`json:"repository_id"`
7. PushTimtestring`json:"push_time"`
8. }
10. typeTag2struct{
11. ArtifactIdstring`json:"artifact_id"`
12. Idstring`json:"id"`
13. Namestring`json:"name"`
14. RepositoryIdstring`json:"repository_id"`
15. PushTimtestring`json:"push_time"`
16. }
18. typeTag2s[]Tag2
19. //deletetagbyspecifiedcount，这里通过count先获取要删除的tag列表
20. funcDeleTagsByCount(tags[]map[string]string,countint)[]string{
21. varre[]string
23. tt:=tags[0]["tags"]
24. ss:=Tag2s{}
25. json.Unmarshal([]byte(tt),&ss)
27. //haveasort
28. fori:=0;i<len(ss);i++{
29. forj:=i+1;j<len(ss);j++{
30. //根据pushtime进行排序
31. ifss[i].PushTimte>ss[j].PushTimte{
32. ss[i],ss[j]=ss[j],ss[i]
33. }
34. }
35. }
36. //getalltags
37. fori:=0;i<len(ss);i++{
38. re=append(re,ss[i].Name)
39. }
40. //返回count个会被删除的tag，
41. returnre[0:count]
42. }
44. //deletetagbyspecifiedtag删除指定的tag
45. funcDelTags(urlstring,projectstring,repostring,tagstring)(int,map[string]interface{}){
46. url=url+"/api/v2.0/projects/"+project+"/repositories/"+repo+"/artifacts/"+tag+"/tags/"+tag
47. request,_:=http.NewRequest(http.MethodDelete,url,nil)
48. tr:=&http.Transport{
49. TLSClientConfig:&tls.Config{InsecureSkipVerify:true},
50. }
51. client:=&http.Client{Timeout:10*time.Second,Transport:tr}
52. request.Header.Set("accept","application/json")
53. request.SetBasicAuth("admin","Pwd123456")
54. //执行删除tag
55. response,_:=client.Do(request)
56. deferresponse.Body.Close()
58. varresultmap[string]interface{}
59. bd,err:=ioutil.ReadAll(response.Body)
60. iferr==nil{
61. err=json.Unmarshal(bd,&result)
62. }
63. returnresponse.StatusCode,result
65. }
70. //定义要获取的tag数据结构
71. typeArtiDatastruct{
72. Idint`json:"id"`
73. ProjectIdint`json:"project_id"`
74. RepositoryIdint`json:"repository_id"`
75. //Digeststring`json:"digest"`
76. Tags[]Tag`json:"tags"`
77. }
79. typeAData[]ArtiData
80. //根据harbor地址、project和repo获取tag数据
81. funcGetTags(urlstring,projectstring,repostring)[]map[string]string{
82. url=url+"/api/v2.0/projects/"+project+"/repositories/"+repo+"/artifacts"
83. request,_:=http.NewRequest(http.MethodGet,url,nil)
84. tr:=&http.Transport{
85. TLSClientConfig:&tls.Config{InsecureSkipVerify:true},
86. }
87. client:=&http.Client{Timeout:10*time.Second,Transport:tr}
88. request.Header.Set("accept","application/json")
89. request.Header.Set("X-Accept-Vulnerabilities","application/vnd.scanner.adapter.vuln.report.harbor+json;version=1.0")
90. request.SetBasicAuth("admin","Harbor12345")
91. //获取tag
92. response,err:=client.Do(request)
94. iferr!=nil{
95. fmt.Println("excutefailed")
96. fmt.Println(err)
97. }
99. body,_:=ioutil.ReadAll(response.Body)
100. deferresponse.Body.Close()
101. ret:=AData{}
102. json.Unmarshal([]byte(string(body)),&ret)
103. varps=[]map[string]string{}
104. sum:=0
105. RData:=make(map[string]string)
106. RData["name"]=repo
107. //获取返回的数据
108. fori:=0;i<len(ret);i++{
110. RData["id"]=(strconv.Itoa(ret[i].Id))
111. RData["project_id"]=(strconv.Itoa(ret[i].ProjectId))
112. RData["repository_id"]=(strconv.Itoa(ret[i].RepositoryId))
113. //RData["digest"]=ret[i].Digest
114. vartdata=[]map[string]string{}
115. sum=len((ret[i].Tags))
116. //获取tag
117. forj:=0;j<len((ret[i].Tags));j++{
118. TagData:=make(map[string]string)
119. TagData["artifact_id"]=strconv.Itoa((ret[i].Tags)[j].ArtifactId)
120. TagData["id"]=strconv.Itoa((ret[i].Tags)[j].Id)
121. TagData["name"]=(ret[i].Tags)[j].Name
122. TagData["repository_id"]=strconv.Itoa((ret[i].Tags)[j].RepositoryId)
123. TagData["push_time"]=(ret[i].Tags)[j].PushTimte
124. tdata=append(tdata,TagData)
125. }
126. RData["count"]=strconv.Itoa(sum)
127. ss,err:=json.Marshal(tdata)
128. iferr!=nil{
129. fmt.Println("failed")
130. os.Exit(2)
131. }
132. RData["tags"]=string(ss)
133. ps=append(ps,RData)
135. }
136. returnps
137. }

获取用户命令行输入，列出harbor中所有的项目

1. //定义获取harbor中project的相关命令操作
2. varprojectCmd=&cobra.Command{
3. Use:"project",
4. Short:"tooperatorproject",
5. Run:func(cmd*cobra.Command,args[]string){
7. output,err:=ExecuteCommand("harbor","project",args...)
8. iferr!=nil{
9. Error(cmd,args,err)
10. }
11. fmt.Fprint(os.Stdout,output)
12. },
13. }
14. //projectlist
15. varprojectLsCmd=&cobra.Command{
16. Use:"ls",
17. Short:"listallproject",
18. Run:func(cmd*cobra.Command,args[]string){
19. url,_:=cmd.Flags().GetString("url")
20. iflen(url)==0{
21. fmt.Println("urlisnull,pleasespecifiedtheharborurlfirst!!!!")
22. os.Exit(2)
23. }
24. //获取所有的project
25. output:=harbor.GetProject(url)
26. fmt.Println("项目名访问级别仓库数量")
27. fori:=0;i<len(output);i++{
29. fmt.Println(output[i]["name"],output[i]["public"],output[i]["repo_count"])
30. }
31. },
32. }
33. //init
34. funcinit(){
35. //./harborprojectls-uhttps://
36. rootCmd.AddCommand(projectCmd)
37. projectCmd.AddCommand(projectLsCmd)
38. projectLsCmd.Flags().StringP("url","u","","defaults:[https://127.0.0.1]")
39. }

获取repo列表

1. //repocommand
2. varrepoCmd=&cobra.Command{
3. Use:"repo",
4. Short:"tooperatorrepository",
5. Run:func(cmd*cobra.Command,args[]string){
7. output,err:=ExecuteCommand("harbor","repo",args...)
8. iferr!=nil{
9. Error(cmd,args,err)
10. }
11. fmt.Fprint(os.Stdout,output)
12. },
13. }
14. //repolist
15. varrepoLsCmd=&cobra.Command{
16. Use:"ls",
17. Short:"listproject'srepository",
18. Run:func(cmd*cobra.Command,args[]string){
19. url,_:=cmd.Flags().GetString("url")
20. project,_:=cmd.Flags().GetString("project")
21. iflen(project)==0{
22. fmt.Println("sorry,youmustspecifiedtheprojectwhichyouwanttoshowrepository!!!")
23. os.Exit(2)
24. }
25. //getallrepo
26. output:=harbor.GetRepoData(url,project)
27. //展示数据
28. fmt.Println("仓库名----------拉取次数")
29. fori:=0;i<len(output);i++{
30. fmt.Println(output[i]["name"],output[i]["pullCount"])
31. }
32. },
33. }
35. funcinit(){
36. //./harborrepols-uhttps://-pxxx
37. rootCmd.AddCommand(repoCmd)
38. repoCmd.AddCommand(repoLsCmd)
39. repoLsCmd.Flags().StringP("url","u","","defaults:[https://127.0.0.1]")
40. repoLsCmd.Flags().StringP("project","p","","theproject")
41. }

tag操作

1. //tagcommand
2. vartagCmd=&cobra.Command{
3. Use:"tag",
4. Short:"tooperatorimage",
5. Run:func(cmd*cobra.Command,args[]string){
7. output,err:=ExecuteCommand("harbor","tag",args...)
8. iferr!=nil{
9. Error(cmd,args,err)
10. }
11. fmt.Fprint(os.Stdout,output)
12. },
13. }
14. //tagls
15. vartagLsCmd=&cobra.Command{
16. Use:"ls",
17. Short:"listalltagsoftherepositoryyouhavespecifiedwhichyoushouldspecifiedprojectatthesametime",
18. Run:func(cmd*cobra.Command,args[]string){
19. url,_:=cmd.Flags().GetString("url")
20. project,_:=cmd.Flags().GetString("project")
21. repo,_:=cmd.Flags().GetString("repo")
22. //getalltags
23. ss:=harbor.GetTags(url,project,repo)
24. fori:=0;i<len(ss);i++{
25. count,_:=strconv.Atoi((ss[i])["count"])
26. fmt.Printf("therepo%shas%dimages\n",repo,count)
27. }
29. },
30. }
32. //tagdelbytagorthenumberofimageyouwanttosave
33. vartagDelCmd=&cobra.Command{
34. Use:"del",
35. Short:"deletethetagsoftherepositoryyouhavespecifiedwhichyoushouldspecifiedprojectatthesametime",
36. Run:func(cmd*cobra.Command,args[]string){
37. //获取用户输入并转格式
38. url,_:=cmd.Flags().GetString("url")
39. project,_:=cmd.Flags().GetString("project")
40. repo,_:=cmd.Flags().GetString("repo")
41. tag,_:=cmd.Flags().GetString("tag")
42. count,_:=cmd.Flags().GetString("count")
43. ret,_:=strconv.Atoi(count)
44. iflen(tag)!=0&&ret!=0{
45. fmt.Println("Youcan'tchoosebothbetweencountandtag")
46. os.Exit(2)
47. }elseiflen(tag)==0&&ret!=0{
48. //getalltags
49. retu:=harbor.GetTags(url,project,repo)
50. //deletetagbyyouhsvespeciedthenumberoftheimagesyouwanttosave
51. rTagCount,_:=strconv.Atoi((retu[0])["count"])
52. //根据用户输入的count和实际tag数进行对比，决定是否去执行删除tag
53. ifret==rTagCount{
54. fmt.Printf("therepository%softheproject%sonlyhave%dtags,soyoucan'tdeletetagsandwewilldonothing!!\n",repo,project,ret)
55. }elseifret>rTagCount{
56. fmt.Printf("therepository%softheproject%sonlyhave%dtags,butyouwanttodelete%dtags,sowesuggestyoutohavearestandwewilldonothing!!\n",repo,project,rTagCount,ret)
57. }else{
58. //可以执行删除tag
59. fmt.Printf("wewillsavethelatest%dtagsanddeleteother%dtags!!!\n",ret,(rTagCount-ret))
60. tags:=harbor.GetTags(url,project,repo)
61. retu:=harbor.DeleTagsByCount(tags,(rTagCount-ret))
62. fori:=0;i<len(retu);i++{
63. //todeletetag
64. code,msg:=harbor.DelTags(url,project,repo,retu[i])
65. fmt.Printf("thetag%sisdeleted,statuscodeis%d,msgis%s\n",retu[i],code,msg)
66. }
67. }
68. }else{
69. //deletetagbyyouspeciedtag
70. code,msg:=harbor.DelTags(url,project,repo,tag)
71. fmt.Println(code,msg["errors"])
72. }
73. },
74. }
78. funcinit(){
79. //./harbortagls-u-p-r
80. rootCmd.AddCommand(tagCmd)
81. tagCmd.AddCommand(tagLsCmd)
82. tagLsCmd.Flags().StringP("url","u","","defaults:[https://127.0.0.1]")
83. tagLsCmd.Flags().StringP("project","p","","theproject")
84. tagLsCmd.Flags().StringP("repo","r","","therepository")
85. //./harbortagdel-u-p-r[-t|-c]
86. tagCmd.AddCommand(tagDelCmd)
87. tagDelCmd.Flags().StringP("url","u","","defaults:[https://127.0.0.1]")
88. tagDelCmd.Flags().StringP("project","p","","theprojectwhichyoushouldspecifiedifyouwanttodeletethetagofanyrepository")
89. tagDelCmd.Flags().StringP("repo","r","","therepositorywhichyoushouldspecifiedifyouwanttodeletethetag")
90. tagDelCmd.Flags().StringP("tag","t","","thetag,Youcan'tchooseitwithtagtogether")
91. tagDelCmd.Flags().StringP("count","c","","thetotalnumberyouwanttosave.forexample:youset--count=10,wewillsavethe10latesttagsbyusepush_timetosort,can'tchooseitwithtagtogether")
92. }

测试

1. //获取帮助
2. harbor%./harbor-hhttps://harbor.zaizai.com
3. Usage:
4. harbor[flags]
5. harbor[command]
7. AvailableCommands:
8. completiongeneratetheautocompletionscriptforthespecifiedshell
9. helpHelpaboutanycommand
10. projecttooperatorproject
11. repotooperatorrepository
12. tagtooperatorimage
14. Flags:
15. -h,--helphelpforharbor
17. Use"harbor[command]--help"formoreinformationaboutacommand.
19. //列出所有project
20. harbor%./harborprojectls-uhttps://harbor.zaizai.com
21. 项目名访问级别仓库数量
22. goharborfalse3
23. librarytrue0
24. publictrue1
26. //列出所有repo
27. harbor%./harborrepols-uhttps://harbor.zaizai.com-pgoharbor
28. 仓库名----------拉取次数
29. goharbor/harbor-portal0
30. goharbor/harbor-db1
31. goharbor/prepare0
33. //列出tagsharbor%./harbortagls-uhttps://harbor.zaizai.com-pgoharbor-rharbor-db
34. therepoharbor-dbhas9images
36. //通过保留最近20个镜像去删除tag
37. harbor%./harbortagdel-uhttps://harbor.zaizai.com-pgoharbor-rharbor-db-c20
38. therepositoryharbor-dboftheprojectgoharboronlyhave9tags,butyouwanttodelete20tags,sowesuggestyoutohavearestandwewilldonothing!!
40. //通过保留最近10个镜像去删除tag
41. harbor%./harbortagdel-uhttps://harbor.zaizai.com-pgoharbor-rharbor-db-c10
42. therepositoryharbor-dboftheprojectgoharboronlyhave9tags,butyouwanttodelete10tags,sowesuggestyoutohavearestandwewilldonothing!!
44. //通过保留最近5个镜像去删除tag
45. harbor%./harbortagdel-uhttps://harbor.zaizai.com-pgoharbor-rharbor-db-c5
46. wewillsavethelatest5tagsanddeleteother4tags!!!
47. thetagv2.3.9isdeleted,statuscodeis200,msgismap[]
48. thetagv2.3.10isdeleted,statuscodeis200,msgismap[]
49. thetagv2.3.8isdeleted,statuscodeis200,msgismap[]
50. thetagv2.3.7isdeleted,statuscodeis200,msgismap[]
52. //指定tag进行删除
53. caicloud@MacBook-Pro-2harbor%./harbortagdel-uhttps://harbor.zaizai.com-pgoharbor-rharbor-db-tv2.3.6
54. 200<nil>
56. ！！！！最后需要手动去harborUI上进行垃圾回收！！！

参考

https://github.com/spf13/cobra

harbor swagger

原文链接：https://mp.weixin.qq.com/s/64D9omkJx7MJaksOwVnb8g

如果您对该产品感兴趣，请填写办理（客服微信：xiaoxiongyidong）

您的姓名 *

身份证号码 *

手机号码 *

选择地区 *

详细地址 *

留言备注 *