🍀 Proposal: Expose image_tag config in gitlab-ce-docker plugin

[aFlyBird0]

What Would You Like to Add? Why Is This Needed?

We added a new plugin gitlab-ce-docker a few days ago to install gitlab-ce in docker.

However, the image tag is hardcoded now.

devstream/internal/pkg/plugin/gitlabcedocker/gitlabcedocker.go

Lines 8 to 19 in 6d2c54a

	const (
	gitlabImageName = "gitlab/gitlab-ce"
	// TODO expose image tag to user in config file to customize
	gitlabImageTag = "rc"
	tcp = "tcp"
	)
	var (
	gitlabImageNameWithTag = fmt.Sprintf("%v:%v", gitlabImageName, gitlabImageTag)
	gitlabContainerName = "gitlab"
	)

As you can see, the image name is a const, and only support rc now.

We want to expose this var to the config file to make the user customize it.

Design && Guides

Note: This good first issue looks like a little bit difficult. But trust me, it is easy in fact and I will give you as much guidance as I can.

1. Here is the config file, just put new config image_tag here.

devstream/internal/pkg/show/config/plugins/gitlab-ce-docker.yaml

Lines 9 to 24 in 6d2c54a

	options:
	# hostname for running docker
	hostname: gitlab.devstream.io
	# the directory where you store docker volumes of gitlab
	# 1. it should be a absolute path
	# 2. once the tool is applied, it can't be changed
	gitlab_home: /srv/gitlab
	# ssh port exposed in the host machine
	ssh_port: 22
	# http port exposed in the host machine
	http_port: 80
	# https port exposed in the host machine
	# todo: support https, reference: https://docs.gitlab.com/omnibus/settings/nginx.html#enable-https
	https_port: 443
	# whether to delete the gitlab_home directory when the tool is removed
	rm_data_after_delete: false

2. Modify the Options structure, which corresponds to the configuration file of the first step

devstream/internal/pkg/plugin/gitlabcedocker/options.go

Lines 1 to 12 in 6d2c54a

	package gitlabcedocker
	// Options is the struct for configurations of the gitlab-ce-docker plugin.
	type Options struct {
	// GitLab home directory, we assume the path set by user is always correct.
	GitLabHome string `validate:"required" mapstructure:"gitlab_home"`
	Hostname string `validate:"required,hostname" mapstructure:"hostname"`
	SSHPort uint `validate:"required" mapstructure:"ssh_port"`
	HTTPPort uint `validate:"required" mapstructure:"http_port"`
	HTTPSPort uint `validate:"required" mapstructure:"https_port"`
	RmDataAfterDelete bool `mapstructure:"rm_data_after_delete"`
	}

3. change the generate logic of gitlabImageNameWithTag

Now it is generate by two const: gitlabImageName and gitlabImageTag.

We should generate it by gitlabImageName and the image tag from options.

Anything else

Please feel free to ask any questions.

[wendao365]

let me?

[wendao365]

The level is still relatively low, but I want to try my best

[aFlyBird0]

let me?

Sorry, you are very active. Thank you sincerely. But this is "good first issue" meaning only new contributors can be assigned. And you have submitted a pr in #739 . You are our "old friends" now.

(By the way, if this issue has not been claimed for a long time, I may transform it into "help wanted". Then you could try this.)

Do you have any other issues you want to work on? Or, just look through our source code, find something that doesn't make sense or can be improved, and feel free to submit issues and pr! @wendao365

[amdaous]

let me?

[aFlyBird0]

let me?

Enjoy your coding!