GitLabForm is a specialized "configuration as a code" tool for GitLab projects, groups and more using hierarchical configuration written in YAML.
Please see the changelog for a complete list of new features and bug fixes in this release.
GitLabForm enables you to manage:
...and a combination of them.
GitLabForm uses hierarchical configuration with inheritance, merging/overwriting and addivity. GitLabForm is also using passing the parameters as-is to GitLab APIs with PUT/POST requests.
GitLabForm has roughly the same purpose as GitLab provider for Terraform (which is a tool that we love and which has inspired us to write this app), but it has a different set of features and uses a different configuration format.
Please read more about GitLab provider for Terraform vs GitLabForm. This article includes a link to the feature matrix / comparison sheet between these two tools.
To configure your GitLab instance itself (appearance, application settings, features, license) please check out the GitLab Configuration as Code (GCasC) project!
Some of the app features are limited because of the GitLab API issues. Here is the list of them. Please check the links to the GitLab issue(s) in their comments and please upvote them if they are affecting you. Note that these issues/bugs affect all the apps using GitLab API, not just GitLabForm.
pip3 install gitlabform
B. Docker: run GitLabForm in a Docker container with this oneliner:
docker run -it -v $(pwd):/config egnyte/gitlabform:latest gitlabform.
Instead of "latest" you can also use a specific version and choose from Alpine and Debian-based images.
See the GitLabForm's DockerHub page for a list of available tags.
Let's assume that you want to add a deployment key to all projects in a group "My Group" (with path "my-group"). If so then:
config_version: 2 gitlab: # You can also set in your environment GITLAB_URL url: https://gitlab.yourcompany.com # You can also set in your environment GITLAB_TOKEN token: "<private token of an admin user>" projects_and_groups: my-group/*: deploy_keys: a_friendly_deploy_key_name: # this name is only used in GitLabForm config key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC3WiHAsm2UTz2dU1vKFYUGfHI1p5fIv84BbtV/9jAKvZhVHDqMa07PgVtkttjvDC8bA1kezhOBKcO0KNzVoDp0ENq7WLxFyLFMQ9USf8LmOY70uV/l8Gpcn1ZT7zRBdEzUUgF/PjZukqVtuHqf9TCO8Ekvjag9XRfVNadKs25rbL60oqpIpEUqAbmQ4j6GFcfBBBPuVlKfidI6O039dAnDUsmeafwCOhEvQmF+N5Diauw3Mk+9TMKNlOWM+pO2DKxX9LLLWGVA9Dqr6dWY0eHjWKUmk2B1h1HYW+aUyoWX2TGsVX9DlNY7CKiQGsL5MRH9IXKMQ8cfMweKoEcwSSXJ title: ssh_key_name_that_is_shown_in_gitlab can_push: false
Watch GitLabForm add this deploy key to all projects in "My Group" group in your GitLab!
See config.yml in this repo as a well documented example of all the features, including configuring all projects in all groups, projects in "my-group" group and specifically project "my-group/my-project1".
To apply settings for a single project, run:
To apply settings for a group of projects, run:
To apply settings for all groups of projects and projects explicitly defined in the config, run:
To apply settings for all projects, run:
...to see the current set of supported command line parameters.
You can use GitLabForm as a part of your CCA (Continuous Configuration Automation) pipeline.
You can run it with a schedule on
ALL projects to unify your GitLab configuration, after it may have drifted
from the configuration. For example you may allow the users to reconfigure projects during their working hours
but automate cleaning up the drift each night.
An example for running GitLabForm using GitLab CI is provided in the .gitlab-ci.example.yml file.
Note that as a standard best practice you should not put your GitLab access token in your
config.yml (unless it is
encrypted) for security reasons - please set it in the
GITLAB_TOKEN environment variable instead.
For GitLab CI a secure place to set it would be a Secret/Protected Variable in the project configuration.
We have documented some methods of automating running GitLabForm for newly created GitLab projects here.
Please see the contribution guide for info about all kinds of contributions, like:
Contribution guide is also the place to look for info how to develop the app locally, build it, run the tests and learn about the code guidelines.
For detailed info about how the app code has been organized, where is what and where and how to fix bugs and/or add new features, please see the implementation design article.
This tool has been originally created as a workaround for missing GitLab features such as assigning deploy keys per project groups but as of now we prefer to use it ever if there are appropriate web UI features, such as secret variables per project groups (released in GitLab 9.4) to keep the configuration as code.
Later on we added features that allowed us to use GitLabForm to improve a group containing around 100 similar projects
to move to a unified development flow (by managing branches protection and the Pull Requests configuration),
basic tests and deployment process (by managing secret variables, deployment keys and files, such as
integrations (such as JIRA or Slack) and more.
GitLab is a registered trademark of GitLab, Inc. This application is not endorsed by GitLab and is not affiliated with GitLab in any way.
The GitLabForm logo is based on the GitLab logos available here, and like the original art is licensed under the Creative Commons Attribution Non-Commercial ShareAlike 4.0 International License.