Add a `tool-` prefix to Harbor namespaces
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	taavi
	Apr 13 2023, 10:24 AM

Description

Harbor tool namespaces should have a tool- prefix to clearly separate them from the infrastructure components that will be hosted there. This is similar to the tool- prefix we are already using with Kubernetes namespaces.

Places that need updating/changing:

maintain_harbor
- https://gitlab.wikimedia.org/repos/cloud/toolforge/maintain-harbor/-/merge_requests/6
buildpack-admission-controller (probably https://github.com/toolforge/buildpack-admission-controller/blob/main/pkg/server/validateadmission.go#L57)
toolforge-cli (probably https://gerrit.wikimedia.org/r/plugins/gitiles/cloud/toolforge/toolforge-cli/+/refs/heads/main/toolforge_cli/build.py#37)
tools-webservice (probably https://gerrit.wikimedia.org/r/plugins/gitiles/operations/software/tools-webservice/+/refs/heads/master/scripts/webservice#35)

Details

	Subject	Repo	Branch	Lines +/-
	webservice: add tool- prefix	operations/software/tools-webservice	master	+1 -1
	cli: add tool- prefix	cloud/toolforge/toolforge-cli	main	+18 -13

Customize query in gerrit

	Title	Reference	Author	Source Branch	Dest Branch
	maintain-harbor: add a `tool-` prefix to harbor namespaces	repos/cloud/toolforge/maintain-harbor!7	raymond-ndibe	add_tool-prefix	master
	maintain-harbor: add a `tools-` prefix to harbor namespaces	repos/cloud/toolforge/maintain-harbor!6	raymond-ndibe	add_tools-_prefix	master

Customize query in GitLab

Related Objects
Search...

Status	Assigned	Task
Resolved	LucasWerkmeister	T320140 Migrate wd-shex-infer from Toolforge GridEngine to Toolforge Kubernetes
Resolved	matmarex	T319707 Migrate dtcheck from Toolforge GridEngine to Toolforge Kubernetes
Resolved	Legoktm	T320062 Migrate steve-adder from Toolforge GridEngine to Toolforge Kubernetes
Resolved	Legoktm	T320011 Migrate rfa-voting-history from Toolforge GridEngine to Toolforge Kubernetes
Open	dcaro	T194332 [Epic,builds-api,components-api,webservice,jobs-api] Make Toolforge a proper platform as a service with push-to-deploy and build packs
Resolved	dcaro	T267374 [tbs.beta] Create a toolforge build service beta release
Resolved	Raymond_Ndibe	T324827 tbs: user-story 3 - I want to cancel the build using the toolforge build cancel feature
Resolved	Raymond_Ndibe	T324828 tbs: user-story 3 - cancel cli should give the right error when the service is down
Resolved	Raymond_Ndibe	T331409 [tbs.cli] The cancel command should return a message saying that the build is already finished when trying to cancel a finished build
Resolved	Raymond_Ndibe	T331410 [tbs.cli] The cancel command should show a useful message when the connection to tekton works but returns http error (requests.exceptions.HTTPError)
Resolved	None	T332294 [tbs][cli] build cancel --help lists the -v option twice
Resolved	dcaro	T324833 tbs: user-story 5 - I want to check the status of a given build using the toolforge build show feature.
Resolved	dcaro	T324830 tbs: user-story 4 - I want to check the status of the last build using the toolforge build show feature
Resolved	Raymond_Ndibe	T324831 tbs: user-story 4 - show cli should give the right error when the service is down
Resolved	dcaro	T324823 tbs: user-story 2 - Feature: I can start a new build from a git url
Resolved	Raymond_Ndibe	T324832 tbs: user-story 4 - show cli should use the latest build if no build id is passed
Resolved	dcaro	T324834 tbs: user-story 6 - I want to start a webservice with the image I built earlier.
Resolved	Raymond_Ndibe	T316327 [tbs] Deploy on tools
Resolved	Raymond_Ndibe	T332347 Duplicate the maintain-harbor deployment for "tools"
Resolved	Raymond_Ndibe	T334657 Add a `tool-` prefix to Harbor namespaces

Event Timeline

taavi created this task.Apr 13 2023, 10:24 AM

Raymond_Ndibe claimed this task.Apr 18 2023, 1:37 PM

Raymond_Ndibe added a project: User-Raymond_Ndibe.

Raymond_Ndibe moved this task from Backlog to In Progress on the User-Raymond_Ndibe board.Apr 18 2023, 1:39 PM

Raymond_Ndibe changed the task status from Open to In Progress.Apr 18 2023, 5:01 PM

Raymond_Ndibe edited projects, added Toolforge Build Service (Iteration 13); removed Toolforge Build Service.

Raymond_Ndibe moved this task from Next Up to In Progress on the Toolforge Build Service (Iteration 13) board.

raymond-ndibe opened https://gitlab.wikimedia.org/repos/cloud/toolforge/maintain-harbor/-/merge_requests/6

maintain-harbor: add a tools- prefix to harbor namespaces

gerritbot added a project: Patch-For-Review.Apr 18 2023, 6:16 PM

Raymond_Ndibe moved this task from In Progress to In Review on the Toolforge Build Service (Iteration 13) board.Apr 18 2023, 6:47 PM

Raymond_Ndibe moved this task from In Progress to In Review on the User-Raymond_Ndibe board.Apr 18 2023, 6:51 PM

dcaro updated the task description. (Show Details)Apr 24 2023, 2:32 PM

KHernandez-WMF moved this task from Iteration 13 to Iteration 14 on the Toolforge Build Service board.Apr 25 2023, 2:12 PM

KHernandez-WMF edited projects, added Toolforge Build Service (Iteration 14); removed Toolforge Build Service (Iteration 13).

KHernandez-WMF moved this task from Next Up to In Review on the Toolforge Build Service (Iteration 14) board.

dcaro moved this task from In Review to In Progress on the Toolforge Build Service (Iteration 14) board.Apr 25 2023, 3:19 PM

raymond-ndibe merged https://gitlab.wikimedia.org/repos/cloud/toolforge/maintain-harbor/-/merge_requests/6

maintain-harbor: add a tools- prefix to harbor namespaces

Maintenance_bot removed a project: Patch-For-Review.Apr 26 2023, 1:30 AM

Change 913679 had a related patch set uploaded (by Raymond Ndibe; author: Raymond Ndibe):

[cloud/toolforge/toolforge-cli@main] cli: prefix wmcs-project to default image-name

https://gerrit.wikimedia.org/r/913679

gerritbot added a project: Patch-For-Review.Apr 30 2023, 5:52 PM

@Raymond_Ndibe @dcaro Can I ask why the patches are going in a completely different direction that what's in the task description and what was discussed on IRC when it was created?

Change 913681 had a related patch set uploaded (by Raymond Ndibe; author: Raymond Ndibe):

[operations/software/tools-webservice@master] webservice: prefix wmcs-project where neccessary

https://gerrit.wikimedia.org/r/913681

more patches:
buildpack-admission-controller: https://github.com/toolforge/buildpack-admission-controller/pull/32
buildservice: https://github.com/toolforge/buildservice/pull/20

In T334657#8815327, @taavi wrote:

@Raymond_Ndibe @dcaro Can I ask why the patches are going in a completely different direction that what's in the task description and what was discussed on IRC when it was created?

I'm not sure I understand you @taavi , can you explain a bit?

In T334657#8815327, @taavi wrote:

@Raymond_Ndibe @dcaro Can I ask why the patches are going in a completely different direction that what's in the task description and what was discussed on IRC when it was created?

I think he might mean that the code is using the vps project name as the prefix, instead of just a static 'tool-' (that was the idea of the ticket).

If it's that, yep, I noticed too, I was waiting to have a thought about it before merging any code, but the MR for the maintain-harbor was merged before I got some time (I should probably have put a note in the first review).

On one side, it makes the code a bit more complicated, and adds an extra configuration knob.

On the other, it might allow us to reuse the same harbor instance for more than one toolforge deployment at a time (ex. testing, on-demand toolsbetas, ...), though we don't really have that need yet. And makes it harder to get confused when looking at different harbor deployments (as they will have the vps project name in all the user repos).
Though I think that if we go this path, we should also take into account non-user repos.

So I think that for now, we can go with the first option, the simple one, and modify maintain-harbor to use a static 'tool-' prefix instead of using the project, and adapt the other patches accordingly.

@Raymond wdyt?

In T334657#8815904, @dcaro wrote:

@Raymond wdyt?

Sorry, I have no opinion on that because I maintain MediaWiki core and extensions most of the time only.

In T334657#8815960, @Raymond wrote:

In T334657#8815904, @dcaro wrote:

@Raymond wdyt?

Sorry, I have no opinion on that because I maintain MediaWiki core and extensions most of the time only.

Oh sorry, wrong ping xd

@Raymond_Ndibe

Yes, that's what I meant, sorry for not being clear. I can see the advantages for both approaches but I think I prefer the static prefix for consistency with k8s namespaces. I was just more surprised to see a different change that what this task said without any kind of discussion at all.

In T334657#8815904, @dcaro wrote:

In T334657#8815327, @taavi wrote:

@Raymond_Ndibe @dcaro Can I ask why the patches are going in a completely different direction that what's in the task description and what was discussed on IRC when it was created?

I think he might mean that the code is using the vps project name as the prefix, instead of just a static 'tool-' (that was the idea of the ticket).

If it's that, yep, I noticed too, I was waiting to have a thought about it before merging any code, but the MR for the maintain-harbor was merged before I got some time (I should probably have put a note in the first review).

On one side, it makes the code a bit more complicated, and adds an extra configuration knob.

On the other, it might allow us to reuse the same harbor instance for more than one toolforge deployment at a time (ex. testing, on-demand toolsbetas, ...), though we don't really have that need yet. And makes it harder to get confused when looking at different harbor deployments (as they will have the vps project name in all the user repos).
Though I think that if we go this path, we should also take into account non-user repos.

So I think that for now, we can go with the first option, the simple one, and modify maintain-harbor to use a static 'tool-' prefix instead of using the project, and adapt the other patches accordingly.

@Raymond wdyt?