Merge pull request #959 from merico-dev/feat-gitlab

Feat: The Plugin GitLab CE Enhancement

Author: aFlyBird0

docs/plugins/gitlab-ce-docker.md

@@ -2,24 +2,60 @@
 
 This plugin installs [GitLab](https://about.gitlab.com/) CE(Community Edition) on Docker.
 
-## Usage
+_NOTICE: currently, this plugin support Linux only._
 
-Note: 
-1. the user you are using must be `root` or is in `docker` group;
-2. `https` isn't supported now.
+## Background
 
-```yaml
---8<-- "gitlab-ce-docker.yaml"
+GitLab officially provides an image [gitlab-ce](https://registry.hub.docker.com/r/gitlab/gitlab-ce). We can use this image to start a container:
+
+```shell
+docker run --detach \
+  --hostname gitlab.example.com \
+  --publish 443:443 --publish 80:80 --publish 22:22 \
+  --name gitlab \
+  --restart always \
+  --volume $GITLAB_HOME/config:/etc/gitlab \
+  --volume $GITLAB_HOME/logs:/var/log/gitlab \
+  --volume $GITLAB_HOME/data:/var/opt/gitlab \
+  --shm-size 256m \
+  gitlab/gitlab-ce:rc
 ```
 
-## Some Commands May Help You
+The variable `$GITLAB_HOME` here pointing to the directory where the configuration, logs, and data files will reside.
 
-- get the password of user `root` in gitlab-ce-docker
+We can set this variable by the `export` command:
 
 ```shell
-sudo docker exec -it gitlab grep 'Password:' /etc/gitlab/initial_root_password
+export GITLAB_HOME=/srv/gitlab
 ```
 
+The GitLab container uses host mounted volumes to store persistent data:
+
+| Local location        |Container location |                    Usage                   |
+| --------------------- | ----------------- | ------------------------------------------ |
+| `$GITLAB_HOME/data`   | `/var/opt/gitlab` | For storing application data               |
+| `$GITLAB_HOME/logs`   | `/var/log/gitlab` | For storing logs                           |
+| `$GITLAB_HOME/config` | `/etc/gitlab`     | For storing the GitLab configuration files |
+
+So, we can customize the following configurations:
+
+1. hostname
+2. host port
+3. persistent data path
+4. docker image tag
+
+## Configuration
+
+Note: 
+1. the user you are using must be `root` or in the `docker` group;
+2. `https` isn't supported for now.
+
+```yaml
+--8<-- "gitlab-ce-docker.yaml"
+```
+
+## Some Commands That May Help
+
 - clone code
 
 ```shell

docs/plugins/gitlab-ce-docker.zh.md

@@ -2,7 +2,47 @@
 
 这个插件用于以 Docker 的方式安装 [GitLab](https://about.gitlab.com/) CE（社区版）。
 
-## 用法
+_注意：目前本插件仅支持 Linux。_
+
+## 背景知识
+
+GitLab 官方提供了 [gitlab-ce](https://registry.hub.docker.com/r/gitlab/gitlab-ce) 镜像，通过这个镜像我们可以实现类似这样的命令来启动一个 GitLab 容器：
+
+```shell
+docker run --detach \
+  --hostname gitlab.example.com \
+  --publish 443:443 --publish 80:80 --publish 22:22 \
+  --name gitlab \
+  --restart always \
+  --volume $GITLAB_HOME/config:/etc/gitlab \
+  --volume $GITLAB_HOME/logs:/var/log/gitlab \
+  --volume $GITLAB_HOME/data:/var/opt/gitlab \
+  --shm-size 256m \
+  gitlab/gitlab-ce:rc
+```
+
+其中 $GITLAB_HOME 表示的是本地存储卷路径，比如我们可以通过 export 命令来设置这个变量：
+
+```shell
+export GITLAB_HOME=/srv/gitlab
+```
+
+在上述命令中，我们可以看到这个容器使用了3个存储卷，含义分别如下：
+
+| 本地路径               | 容器内路径          | 用途               |
+| --------------------- | ----------------- | ----------------- |
+| `$GITLAB_HOME/data`   | `/var/opt/gitlab` | 保存应用数据        |
+| `$GITLAB_HOME/logs`   | `/var/log/gitlab` | 保存日志            |
+| `$GITLAB_HOME/config` | `/etc/gitlab`     | 保存 GitLab 配置文件 |
+
+在此基础上，我们可以自定义如下一些配置：
+
+1. hostname
+2. 本机端口
+3. 存储卷路径
+4. 镜像版本
+
+## 配置
 
 注意: 
 1. 你使用的用户必须是 `root` 或者在 `docker` 用户组里；
@@ -14,12 +54,6 @@
 
 ## 一些可能有用的命令
 
-- 查看 gitlab 的 root 用户的密码:
-
-```shell
-sudo docker exec -it gitlab grep 'Password:' /etc/gitlab/initial_root_password
-```
-
 - 克隆项目
 
 ```shell

internal/pkg/plugin/gitlabcedocker/create.go

@@ -8,21 +8,19 @@ import (
 
 func Create(options map[string]interface{}) (map[string]interface{}, error) {
 	// 1. create config and pre-handle operations
-	opts, err := preHandleOptions(options)
+	opts, err := validateAndDefault(options)
 	if err != nil {
 		return nil, err
 	}
 
-	gitlabURL = opts.getGitLabURL()
-
 	// 2. config install operations
 	runner := &plugininstaller.Runner{
 		PreExecuteOperations: []plugininstaller.MutableOperation{
 			dockerInstaller.Validate,
 		},
 		ExecuteOperations: []plugininstaller.BaseOperation{
 			dockerInstaller.InstallOrUpdate,
-			showGitLabURL,
+			showHelpMsg,
 		},
 		TerminateOperations: []plugininstaller.BaseOperation{
 			dockerInstaller.HandleRunFailure,

internal/pkg/plugin/gitlabcedocker/delete.go

@@ -7,7 +7,7 @@ import (
 
 func Delete(options map[string]interface{}) (bool, error) {
 	// 1. create config and pre-handle operations
-	opts, err := preHandleOptions(options)
+	opts, err := validateAndDefault(options)
 	if err != nil {
 		return false, err
 	}

internal/pkg/plugin/gitlabcedocker/gitlabcedocker.go

@@ -1,28 +1,19 @@
 package gitlabcedocker
 
-import (
-	"fmt"
-
-	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
-	"github.com/devstream-io/devstream/pkg/util/log"
-)
+import "github.com/devstream-io/devstream/pkg/util/types"
 
 const (
-	gitlabImageName       = "gitlab/gitlab-ce"
+	defaultHostname       = "gitlab.example.com"
+	defaultGitlabHome     = "/srv/gitlab"
+	defaultSSHPort        = 22
+	defaultHTTPPort       = 80
+	defaultHTTPSPort      = 443
 	defaultImageTag       = "rc"
+	gitlabImageName       = "gitlab/gitlab-ce"
 	gitlabContainerName   = "gitlab"
 	dockerRunShmSizeParam = "--shm-size 256m"
 )
 
-// gitlabURL is the access URL of GitLab.
-var gitlabURL string
-
-func (opts *Options) getGitLabURL() string {
-	return fmt.Sprintf("http://%s:%d", opts.Hostname, opts.HTTPPort)
-}
-
-func showGitLabURL(options plugininstaller.RawOptions) error {
-	log.Infof("GitLab access URL: %s", gitlabURL)
-
-	return nil
-}
+var (
+	defaultRMDataAfterDelete = types.Bool(false)
+)

internal/pkg/plugin/gitlabcedocker/options.go

@@ -1,43 +1,86 @@
 package gitlabcedocker
 
 import (
+	"fmt"
 	"path/filepath"
 
+	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
 	dockerInstaller "github.com/devstream-io/devstream/internal/pkg/plugininstaller/docker"
 	"github.com/devstream-io/devstream/pkg/util/docker"
+	"github.com/devstream-io/devstream/pkg/util/log"
 )
 
 // Options is the struct for configurations of the gitlab-ce-docker plugin.
 type Options struct {
+	Hostname string `validate:"hostname" mapstructure:"hostname"`
 	// 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"`
+	GitLabHome        string `mapstructure:"gitlab_home"`
+	SSHPort           uint   `mapstructure:"ssh_port"`
+	HTTPPort          uint   `mapstructure:"http_port"`
+	HTTPSPort         uint   `mapstructure:"https_port"`
+	RmDataAfterDelete *bool  `mapstructure:"rm_data_after_delete"`
 	ImageTag          string `mapstructure:"image_tag"`
 }
 
-func buildDockerOptions(opts *Options) *dockerInstaller.Options {
-	dockerOpts := &dockerInstaller.Options{}
-	dockerOpts.RmDataAfterDelete = opts.RmDataAfterDelete
-	dockerOpts.ImageName = gitlabImageName
-	dockerOpts.ImageTag = opts.ImageTag
-	dockerOpts.Hostname = opts.Hostname
-	dockerOpts.ContainerName = gitlabContainerName
-	dockerOpts.RestartAlways = true
+func (opts *Options) Defaults() {
+	if opts.Hostname == "" {
+		opts.Hostname = defaultHostname
+	}
+	if opts.GitLabHome == "" {
+		opts.GitLabHome = defaultGitlabHome
+	}
+	if opts.SSHPort == 0 {
+		opts.SSHPort = defaultSSHPort
+	}
+	if opts.HTTPPort == 0 {
+		opts.HTTPPort = defaultHTTPPort
+	}
+	if opts.HTTPSPort == 0 {
+		opts.HTTPSPort = defaultHTTPSPort
+	}
+	if opts.RmDataAfterDelete == nil {
+		opts.RmDataAfterDelete = defaultRMDataAfterDelete
+	}
+	if opts.ImageTag == "" {
+		opts.ImageTag = defaultImageTag
+	}
+}
+
+// gitlabURL is the access URL of GitLab.
+var gitlabURL string
 
+func (opts *Options) setGitLabURL() {
+	if gitlabURL != "" {
+		return
+	}
+	gitlabURL = fmt.Sprintf("http://%s:%d", opts.Hostname, opts.HTTPPort)
+}
+
+func showHelpMsg(options plugininstaller.RawOptions) error {
+	log.Infof("GitLab access URL: %s", gitlabURL)
+	log.Infof("GitLab initial root password: execute the command -> docker exec -it gitlab grep 'Password:' /etc/gitlab/initial_root_password")
+
+	return nil
+}
+
+func buildDockerOptions(opts *Options) *dockerInstaller.Options {
 	portPublishes := []docker.PortPublish{
 		{HostPort: opts.SSHPort, ContainerPort: 22},
 		{HostPort: opts.HTTPPort, ContainerPort: 80},
 		{HostPort: opts.HTTPSPort, ContainerPort: 443},
 	}
-	dockerOpts.PortPublishes = portPublishes
 
-	dockerOpts.Volumes = buildDockerVolumes(opts)
-
-	dockerOpts.RunParams = []string{dockerRunShmSizeParam}
+	dockerOpts := &dockerInstaller.Options{
+		RmDataAfterDelete: opts.RmDataAfterDelete,
+		ImageName:         gitlabImageName,
+		ImageTag:          opts.ImageTag,
+		Hostname:          opts.Hostname,
+		ContainerName:     gitlabContainerName,
+		RestartAlways:     true,
+		Volumes:           buildDockerVolumes(opts),
+		RunParams:         []string{dockerRunShmSizeParam},
+		PortPublishes:     portPublishes,
+	}
 
 	return dockerOpts
 }

internal/pkg/plugin/gitlabcedocker/options_test.go

@@ -11,15 +11,14 @@ import (
 var _ = Describe("Options", func() {
 
 	var opts *Options
-
 	BeforeEach(func() {
 		opts = &Options{
 			GitLabHome:        "/srv/gitlab",
 			Hostname:          "gitlab.example.com",
 			SSHPort:           8122,
 			HTTPPort:          8180,
 			HTTPSPort:         8443,
-			RmDataAfterDelete: false,
+			RmDataAfterDelete: nil,
 			ImageTag:          "rc",
 		}
 	})

internal/pkg/plugin/gitlabcedocker/read.go

@@ -8,13 +8,11 @@ import (
 
 func Read(options map[string]interface{}) (map[string]interface{}, error) {
 	// 1. create config and pre-handle operations
-	opts, err := preHandleOptions(options)
+	opts, err := validateAndDefault(options)
 	if err != nil {
 		return nil, err
 	}
 
-	gitlabURL = opts.getGitLabURL()
-
 	// 2. config read operations
 	runner := &plugininstaller.Runner{
 		PreExecuteOperations: []plugininstaller.MutableOperation{

internal/pkg/plugin/gitlabcedocker/update.go

@@ -8,21 +8,19 @@ import (
 
 func Update(options map[string]interface{}) (map[string]interface{}, error) {
 	// 1. create config and pre-handle operations
-	opts, err := preHandleOptions(options)
+	_, err := validateAndDefault(options)
 	if err != nil {
 		return nil, err
 	}
 
-	gitlabURL = opts.getGitLabURL()
-
 	// 2. config install operations
 	runner := &plugininstaller.Runner{
 		PreExecuteOperations: []plugininstaller.MutableOperation{
 			dockerInstaller.Validate,
 		},
 		ExecuteOperations: []plugininstaller.BaseOperation{
 			dockerInstaller.InstallOrUpdate,
-			showGitLabURL,
+			showHelpMsg,
 		},
 		GetStatusOperation: dockerInstaller.GetRunningState,
 	}