Add Dockerfile pt. 2

[Samyak2]

Description

Fixes #101

Based on #106

• Added a Dockerfile based on the golang image
• grofer is installed using go install from the local source
• The whole root directory of the host has to be mounted as read only for this to work. A few other docker flags are also required.
  • the docker socket is also mounted
• See updated README for instructions
• HOST_PROC, HOST_SYS, etc. is set for gopsutil

Type of change

Please delete options that are not relevant.

• [x] New feature (non-breaking change which adds functionality)
• [x] This change requires a documentation update

Checklist:

• [x] I have read the contribution guidelines and followed it as far as possible.
• [x] I have performed a self-review of my own code (if applicable)
• [x] I have commented my code, particularly in hard-to-understand areas (if applicable)
• [x] I have run go fmt on my code (reference)
• [x] I have made corresponding changes to the documentation (if applicable)
• [x] My changes generate no new warnings
• [x] Any dependent and pending changes have been merged and published

TODO

• fix GitHub workflow to publish container

[Samyak2]

unsupported: GitHub Container Registry is currently in read only mode. Image pushes are disallowed at this time.

Looks like the container registry is under maintenance currently :(

[Samyak2]

It wooooorks!

https://github.com/orgs/pesos/packages/container/package/grofer

[MadhavJivrajani]

WOOOHOOOOOOO

[Samyak2]

I think this is ready now. I made a few changes

• Docker workflow is disabled for PRs since it will fail unless it's from an internal branch (like this)
• Changed the README to use ghcr.io/pesos/grofer instead of grofer

[Gituser143]

@Samyak2 you might want to update the branch :P

[Samyak2]

I'll rebase it on main

[Samyak2]

Is there anything left to do here?

[MadhavJivrajani]

Everything looks good to me, just to be sure: this image build will be triggered only when a new release comes out?

[Samyak2]

No. This is how it will work:

• All pushes to main (the default branch) are released as the latest image.
• New tags are released with the specific version number. For example, a 1.3.1 tagged image would be pushed on the next release.

So, pulling ghcr.io/pesos/grofer would give the image from the main branch (since that is tagged as latest). This, if I'm not wrong, is similar to go get which pulls from the default branch.

[MadhavJivrajani]

Sounds good Could you add 1-2 lines in the README along the lines of what latest means in our case and if they want to use a particular version, how they can do it?

[Samyak2]

I've added a couple of lines on that.

A few things that should be noted here:

• The latest image and release images (tags) are not tested xD. They can only be tested once we merge this (and the tag one when we make a new release). act can't test these either since it fails at the login step. We might have to make hotfixes if it breaks. On that note, is it possible to force Actions to run the release (tag) workflow manually so that the 1.3.0 image is built?
• I'm not entirely sure about the version tag. According to the code (which I ~stole~ borrowed from the starter workflows) it should be 1.3.0 without the v prefix. We might have to change this in the README if it's different.

[Samyak2]

^ Rebased on main

Is there anything else to do here?

[Gituser143]

@Samyak2 Changes look good to me! But do workflows trigger on commits? I'm asking because I don't see one for this (or I might not be looking properly, plis help :P).

[Samyak2]

@Samyak2 Changes look good to me! But do workflows trigger on commits? I'm asking because I don't see one for this (or I might not be looking properly, plis help :P).

@Gituser143 yes, but this one is run only on commits to the main branch and not on PRs. It can be enabled on PRs too, but if they aren't from an internal branch of this repo (pesos/grofer), it will just give a permission denied error. Also, it's run on push rather than commits. So if multiple commits are pushed at a time, it will run only once for the latest commit.