Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/petermosmans/gitlab-demolab
Quickly get a GitLab network up and running. The network consists of a GitLab server, docker-in-docker compatible GitLab runners, and SonarQube
https://github.com/petermosmans/gitlab-demolab
dependency-track devops devsecops devsecops-pipeline gitlab gitlab-runners juice-shop sonarqube
Last synced: 2 months ago
JSON representation
Quickly get a GitLab network up and running. The network consists of a GitLab server, docker-in-docker compatible GitLab runners, and SonarQube
- Host: GitHub
- URL: https://github.com/petermosmans/gitlab-demolab
- Owner: PeterMosmans
- License: gpl-3.0
- Created: 2022-02-11T10:13:07.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T12:46:31.000Z (3 months ago)
- Last Synced: 2024-09-18T13:14:11.654Z (3 months ago)
- Topics: dependency-track, devops, devsecops, devsecops-pipeline, gitlab, gitlab-runners, juice-shop, sonarqube
- Language: Shell
- Homepage:
- Size: 131 KB
- Stars: 6
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GitLab Demolab
This repository contains all files to automatically configure and set up a local
demo environment, consisting of a CI/CD GitLab Community Edition server and
multiple (Docker-in-Docker) GitLab runners. Optionally, SonarQube Community
Edition and Dependency-Track can be configured and set up as well.
## Prerequisites
Have `curl`, `docker`, and `docker-compose` installed.
## Usage
```console
./installer.sh
```
This will fire up an instance of GitLab and two GitLab runners, capable of
performing Docker-in-Docker commands.
All variables are stored in an `.env` file: The `.env` file itself not supplied
in this repository, but an example is. If you don't create an `.env` file before
using the installer, it will automatically copy and use the `env-example` file
for you.
Then, you\'ll need to register the (group of) runners with a valid runner token,
which needs to be created manually: In GitLab, go to the Admin Area / Dashboard,
click on Instant Runners, and click on New instance runner
(`/admin/runners/new`). Select \"Run untagged jobs\" and click on Create runner.
This will generate a new runner token. Copy the token.
Lastly, execute the `register-runners.sh` script with that token as parameter.
This script will register all runners that are up and running.
## Starting and configuring SonarQube
```console
./installer.sh sonarqube
```
## Starting and configuring Dependency-Track
```console
./installer.sh dependency-track
```
## Stopping / pausing the demolab
```console
./installer.sh stop
```
## Removing the demolab
```console
docker-compose down
```
By default all data, configuration and logs will be stored in persistent Docker
volumes. They will remain, even if you stop or remove the Docker containers. To
clean everything up, remove the containers including named volumes.
```console
docker-compose down --remove-orphans --volumes
```
Please note that this is a lab setup - and not meant to be used in production in
any way. All services only bind / listen to `127.0.0.1` by default (this can be
changed in the file `docker-compose`.
Furthermore all runners share one named Docker volume as cache under
`/srv/cache`. This named volume will be initialized by default, and has lax
permissions (to ensure all tools can work with it).
## Juice Shop demonstration scripts
Furthermore, the repository contains a number of pipeline example scripts, to
help you add several automated security testing tools to a GitLab pipeline. The
pipeline definition files can be found in the folder [juice-shop](juice-shop/):
- [Basic build pipeline](juice-shop/build-pipeline/)
- [Detecting secrets in a code base with detect-secrets](juice-shop/detect-secrets/)
- [Dockerfile linting with Hadolint](juice-shop/hadolint/)
- [SAST with Njsscan](juice-shop/njsscan/)
- [SAST with SonarQube](juice-shop/sonarqube/)
- [Software composition analysis with Dependency-Check](juice-shop/dependency-check/)
- [Component analysis with Dependency-Track](juice-shop/dependency-track/)
- [Container vulnerability scanning with Trivy](juice-shop/trivy/)
- [DAST with ZAP](juice-shop/zap/)
- [DAST with Nikto](juice-shop/nikto/)
- [Full automated security testing](juice-shop/full-testing/)
## Variables
The `DEMO_NAME` allows you to run multiple instances of this demo on the same
machine, as it will generate its own \"Docker namespace\".
`DIND_VERSION` defines the Docker-in-Docker image tag being used.
`DTRACK_API_PORT` defines the port number of the Dependency-Track API interface.
`DTRACK_API_VERSION` defines the Dependency-Track API image tag.
`DTRACK_FRONTEND_PORT` defines the port number on which the web interface of
Dependency-Track will be accessible.
`DTRACK_FRONTEND_VERSION` defines the Dependency-Track frontend image tag.
`GITLAB_HOSTNAME` defines the hostname that will be used to access GitLab.
Please note that this name needs to be resolved, see the remarks at the bottom
of this page.
`GITLAB_PASSWORD` defines the initial password for user `root`.
`GITLAB_PORT` defines the port number on which the web interface of GitLab will
be accessible.
`GITLAB_SSH` defines the SSH port number for GitLab.
`GITLAB_VERSION` defines the GitLab image tag being used. Please note that the
runners always use the latest version.
`SONARQUBE_HOSTNAME` defines the hostname that will be used to access SonarQube.
Please note that this name needs to be resolved, see the remarks at the bottom
of this page.
`SONARQUBE_PASSWORD` defines the initial password for user `admin`.
`SONARQUBE_PLUGINS` defines a space-delimited list of SonarQube plugins that
will be installed at first startup.
`SONARQUBE_PORT` defines the port number on which the web interface of SonarQube
will be accessible.
`SONARQUBE_VERSION` allows you to specify which SonarQube image you would like
to use.
**Important!**
The GITLAB_PASSWORD needs to be complex, otherwise installation will fail, see
.
If you want to access the web interfaces using \"pretty host names\" that are
defined using `GITLAB_HOSTNAME` and `SONARQUBE_HOSTNAME` (instead of
`localhost`), then make sure that they can be resolved by your browser. This can
be done for instance by adding them to your local `hosts` file.
# Copyright / License
Great that you're using this code, hopefully you find it useful! All that I'm
asking is that you properly attribute the author (Peter Mosmans), and respect
the [GPLv3 license](LICENSE).