UNCLASSIFIED

Commit 5497b519 authored by alexander.klepal's avatar alexander.klepal
Browse files

Merge branch 'init' into 'development'

Init

See merge request !14
parents 37db64f6 314c63a3
Pipeline #214131 passed with stages
in 10 minutes and 35 seconds
ARG BASE_REGISTRY=registry1.dso.mil/ironbank
ARG BASE_IMAGE=redhat/openjdk/openjdk8
ARG BASE_TAG=latest
FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG}
USER 0
RUN dnf upgrade -y && \
dnf clean all && \
rm -rf /var/cache/dnf
RUN mkdir -p /app/logs \
mkdir -p /app/config
RUN chown -R 1001:1001 /app
RUN chmod 755 /app
WORKDIR /app
USER 1001
COPY ./gitlab-scm-collector.jar .
COPY ./scripts/collector-launch.sh ./scripts/collector-launch.sh
CMD ./scripts/collector-launch.sh
HEALTHCHECK NONE
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# <application name> ---
title: Gitlab Collector
tags:
keywords:
summary:
sidebar: hygieia_sidebar
permalink: gitlab.html
---
Configure the Gitlab Collector to display and monitor information (related to code contribution activities) on the Hygieia Dashboard, from the Gitlab repository. Collect source code details from Gitlab based on the repository URL.
This project uses Spring Boot to package the collector as an executable JAR file with dependencies.
### Setup Instructions
* **Set Parameters via environment variables to create the Application Properties File or reference existing properties file**
Environment Variables:
There are two added properties to assist configuration:
```
SKIP_PROPERTIES_BUILDER: Boolean (true or false). Defaults to true. For creating the application.properties file from environment variables.
PROP_FILE: Location of the properties file. Default: /app/config/application.properties
```
The remaining properties map as such to the below sample configuration:
```
GITLAB_USE_PROJECT_ID: gitlab.useProjectId
DB_NAME: dbname
DB_HOST: dbhost
DB_PORT: dbport
DB_REPLICA_SET: Boolean ('true' or 'false')
DB_HOST_PORT: dbhostport
DB_USERNAME: dbusername
DB_PASSWORD: dbpassword
LOGS_PATH: logging.file
COLLECTOR_CRON : gitlab.cron
GITLAB_HOST: gitlab.host
GITLAB_PROTOCOL: gitlab.protocol
GITLAB_PORT: gitlab.port
GITLAB_PATH: gitlab.path
GITLAB_SELF_SIGNED_CERT: gitlab.selfSignedCertificate
GITLAB_API_TOKEN: gitlab.apiToken
GITLAB_COMMIT_THREASHOLD_DAYS: gitlab.commitThresholdDays
GITLAB_KEY: gitlab.key
```
### Sample Application Properties File
The sample `application.properties` file lists parameter values to configure the Gitlab Collector. Set the parameters based on your environment setup.
```
# Database Name
dbname=dashboarddb
# Database HostName - default is localhost
dbhost=localhost
# Database Port - default is 27017
dbport=27017
# MongoDB replicaset
dbreplicaset=[false if you are not using MongoDB replicaset]
dbhostport=[host1:port1,host2:port2,host3:port3]
# Database Username - default is blank
dbusername=dashboarduser
# Database Password - default is blank
dbpassword=dbpassword
# Logging File location
logging.file=./logs/gitlab.log
#Collector schedule (required)
gitlab.cron=0 0/1 * * * *
#Gitlab host (optional, defaults to 'gitlab.com')
gitlab.host=gitlab.company.com
#Gitlab protocol (optional, defaults to 'http')
gitlab.protocol=http
#If enabled, dashboard URL configured in UI follows this example <gitlab.protocol>://<gitlab.host>/<gitlab_project_id>
#gitlab.useProjectId (optional, defaults to false)
#Gitlab port (optional, defaults to protocol default port)
gitlab.port=80
#Gitlab path (optional, if your instance of gitlab requires a path)
gitlab.path=/gitlab/resides/here
#If your instance of Gitlab is using a self-signed certificate, set to true, default is false
gitlab.selfSignedCertificate=false
#Gitlab API Token (required, user token the collector will use by default, can be overridden on a per repo basis from the UI. API token provided by Gitlab)
gitlab.apiToken=
#Maximum number of previous days from current date, when fetching commits
gitlab.commitThresholdDays=15
# Gitlab key for private repos
gitlab.key=<your-generated-key>
```
For more information visit: https://hygieia.github.io/Hygieia/gitlab.html
Project template for all Iron Bank container repositories.
\ No newline at end of file
# Database Name
dbname=dashboarddb
# Database HostName - default is localhost
dbhost=localhost
# Database Port - default is 27017
dbport=27017
# MongoDB replicaset
dbreplicaset=[false if you are not using MongoDB replicaset]
dbhostport=[host1:port1,host2:port2,host3:port3]
# Database Username - default is blank
dbusername=
# Database Password - default is blank
dbpassword=
# Logging File location
logging.file=./logs/gitlab.log
#Collector schedule (required)
gitlab.cron=0 0/1 * * * *
#Gitlab host (optional, defaults to 'gitlab.com')
gitlab.host=gitlab.company.com
#Gitlab protocol (optional, defaults to 'http')
gitlab.protocol=http
#If enabled, dashboard URL configured in UI follows this example <gitlab.protocol>://<gitlab.host>/<gitlab_project_id>
#gitlab.useProjectId (optional, defaults to false)
#Gitlab port (optional, defaults to protocol default port)
gitlab.port=80
#Gitlab path (optional, if your instance of gitlab requires a path)
gitlab.path=/gitlab/resides/here
#If your instance of Gitlab is using a self-signed certificate, set to true, default is false
gitlab.selfSignedCertificate=false
#Gitlab API Token (required, user token the collector will use by default, can be overridden on a per repo basis from the UI. API token provided by Gitlab)
gitlab.apiToken=
#Maximum number of previous days from current date, when fetching commits
gitlab.commitThresholdDays=15
# Gitlab key for private repos
gitlab.key=<your-generated-key>
---
apiVersion: v1
# The repository name in registry1, excluding /ironbank/
name: "opensource/hygieia/hygieia-scm-gitlab-collector"
# List of tags to push for the repository in registry1
# The most specific version should be the first tag and will be shown
# on ironbank.dsop.io
tags:
- "v3.1.0"
- "latest"
# Build args passed to Dockerfile ARGs
args:
BASE_IMAGE: "redhat/ubi/ubi8"
BASE_TAG: "8.3"
# Docker image labels
labels:
org.opencontainers.image.title: "hygieia-scm-gitlab-collector"
## Human-readable description of the software packaged in the image
org.opencontainers.image.description: "Prometheus exporter for various metrics about ElasticSearch, written in Go."
## License(s) under which contained software is distributed
org.opencontainers.image.licenses: "Apache-2.0"
## URL to find more information on the image
org.opencontainers.image.url: "https://github.com/bitnami/bitnami-docker-elasticsearch-exporter"
## Name of the distributing entity, organization or individual
org.opencontainers.image.vendor: "hygieia"
org.opencontainers.image.version: "v3.1.0"
## Keywords to help with search (ex. "cicd,gitops,golang")
mil.dso.ironbank.image.keywords: "configmap,hygieia,gitlab,collector"
## This value can be "opensource" or "commercial"
mil.dso.ironbank.image.type: "opensource"
## Product the image belongs to for grouping multiple images
mil.dso.ironbank.product.name: "hygieia-scm-gitlab-collector"
# List of resources to make available to the offline build context
resources:
- filename: gitlab-scm-collector.jar
url: https://repo.maven.apache.org/maven2/com/capitalone/dashboard/gitlab-scm-collector/3.1.0/gitlab-scm-collector-3.1.0.jar
validation:
type: sha256
value: 57f53acb6edaae368291050af44f1662b1ba80a891b58780535291c36f5eadbc
# List of project maintainers
maintainers:
- name: "Chris Byrd"
username: "crbcos"
email: "chris.byrd@parsons.com"
cht_member: true
{
"assignees": [
"@chris.byrd"
],
"baseBranches": [
"development"
],
"regexManagers": [
{
"matchStrings": [
"version=\"(?<currentValue>.*?)\""
],
"depNameTemplate": "hygieia/hygieia-scm-gitlab-collector",
"datasourceTemplate": "docker"
},
{
"fileMatch": [
"^hardening_manifest.yaml$"
],
"matchStrings": [
"org\\.opencontainers\\.image\\.version:\\s+\"(?<currentValue>.+?)\""
],
"depNameTemplate": "hygieia/hygieia-scm-gitlab-collector:v3.1.0",
"datasourceTemplate": "docker"
},
{
"fileMatch": [
"^hardening_manifest.yaml$"
],
"matchStrings": [
"tags:\\s+-\\s+\"(?<currentValue>.+?)\""
],
"depNameTemplate": "hygieia/hygieia-scm-gitlab-collector:v3.1.0",
"datasourceTemplate": "docker"
}
]
}
#!/bin/bash
if [ "$SKIP_PROPERTIES_BUILDER" = true ]; then
echo "Skipping properties builder"
java -jar gitlab-scm-collector.jar --spring.config.name=gitlab --spring.config.location=${PROP_FILE}
exit 0
fi
if ! [ "$PROP_FILE" ]; then
echo "PROP_FILE not set. Defaulting to /app/config/application.properties"
export PROP_FILE=/app/config/application.properties
sudo touch $PROP_FILE
fi
if [ "$GITLAB_USE_PROJECT_ID" ]; then
echo "GITLAB_USE_PROJECT_ID set."
export GITLAB_USE_PROJECT_ID_TITLE=gitlab.useProjectId
else
echo "GITLAB_USE_PROJECT_ID not set. Skipping."
export GITLAB_USE_PROJECT_ID_TITLE=\#gitlab.useProjectId
fi
if ! [ "DB_NAME" ]; then
echo "DB_NAME not set. Defaulting to empty string."
export DB_NAME=""
fi
if ! [ "$DB_HOST" ]; then
echo "DB_HOST not set. Defaulting to localhost"
export DB_HOST=localhost
fi
if ! [ "$DB_PORT" ]; then
echo "DB_PORT not set. Defaulting to 27017"
export DB_PORT=27017
fi
if ! [ "$DB_REPLICA_SET" ]; then
echo "DB_REPLICA_SET not set. Defaulting to false."
export DB_REPLICA_SET=false
fi
if ! [ "$DB_HOST_PORT" ]; then
echo "DB_HOST_PORT not set. Defaulting to empty string."
export DB_HOST_PORT=""
fi
if ! [ "$DB_USERNAME" ]; then
echo "DB_USERNAME not set. Defaulting to empty string."
export DB_USER_NAME=""
fi
if ! [ "$DB_PASSWORD" ]; then
echo "DB_PASSWORD not set. Defaulting to empty string."
export DB_PASSWORD=""
fi
if ! [ "$LOGS_PATH" ]; then
echo "LOGS_PATH not set. Defaulting to /app/logs/gitlab.log."
export LOGS_PATH="/app/logs"
fi
if ! [ "$COLLECTOR_CRON" ]; then
echo "COLLECTOR_CRON not set. Defaulting to 0 0/1 * * * *"
export COLLECTOR_CRON="0 0/1 * * * *"
fi
if ! [ "$GITLAB_HOST" ]; then
echo "GITLAB_HOST not set. Defaulting to gitlab.company.com"
export GITLAB_HOST=gitlab.company.com
fi
if ! [ "$GITLAB_PROTOCOL" ]; then
echo "GITLAB_PROTOCOL not set. Defaulting to http"
export GITLAB_PROTOCOL=http
fi
if ! [ "$GITLAB_PORT" ]; then
echo "GITLAB_PORT not set. Defaulting to 80"
export GITLAB_PORT=80
fi
if ! [ "$GITLAB_PATH" ]; then
echo "GITLAB_PATH not set. Defaulting to empty string"
export GITLAB_PATH=""
fi
if ! [ "$GITLAB_SELF_SIGNED_CERT" ]; then
echo "GITLAB_SELF_SIGNED_CERT not set. Defaulting to false"
export GITLAB_SELF_SIGNED_CERT=false
fi
if ! [ "$GITLAB_API_TOKEN" ]; then
echo "GITLAB_API_TOKEN not set. Value is required."
exit 0
fi
if ! [ "$GITLAB_COMMIT_THREASHOLD_DAYS" ]; then
echo "GITLAB_COMMIT_THREASHOLD_DAYS not set. Defaulting to 15 days."
export GITLAB_COMMIT_THREASHOLD_DAYS=15
fi
if ! [ "$GITLAB_KEY" ]; then
echo "GITLAB_KEY not set. Defaulting to empty string"
export GITLAB_KEY=""
fi
cat > $PROP_FILE <<EOF
# Database Name
dbname=$DB_NAME
# Database HostName - default is localhost
dbhost=$DB_HOST
# Database Port - default is 27017
dbport=$DB_PORT
# MongoDB replicaset
dbreplicaset=$DB_REPLICA_SET
dbhostport=$DB_HOST_PORT
# Database Username - default is blank
dbusername=$DB_USERNAME
# Database Password - default is blank
dbpassword=$DB_PASSWORD
# Logging File location - ./logs/gitlab.log
logging.file=$LOGS_PATH
#Collector schedule (required) - 0 0/1 * * * *
gitlab.cron=$COLLECTOR_CRON
#Gitlab host (optional, defaults to 'gitlab.com') - gitlab.company.com
gitlab.host=$GITLAB_HOST
#Gitlab protocol (optional, defaults to 'http') - http
gitlab.protocol=$GITLAB_PROTOCOL
#If enabled, dashboard URL configured in UI follows this example <gitlab.protocol>://<gitlab.host>/<gitlab_project_id> - (optional, defaults to false)
$GITLAB_USE_PROJECT_ID_TITLE=$GITLAB_USE_PROJECT_ID
#Gitlab port (optional, defaults to protocol default port) - 80
gitlab.port=$GITLAB_PORT
#Gitlab path (optional, if your instance of gitlab requires a path) - /gitlab/resides/here
gitlab.path=$GITLAB_PATH
#If your instance of Gitlab is using a self-signed certificate, set to true, default is false - false
gitlab.selfSignedCertificate=$GITLAB_SELF_SIGNED_CERT
#Gitlab API Token (required, user token the collector will use by default, can be overridden on a per repo basis from the UI. API token provided by Gitlab)
gitlab.apiToken=$GITLAB_API_TOKEN
#Maximum number of previous days from current date, when fetching commits - 15
gitlab.commitThresholdDays=$GITLAB_COMMIT_THREASHOLD_DAYS
# Gitlab key for private repos
gitlab.key=$GITLAB_KEY
EOF
echo "
===========================================
Properties file created: $PROP_FILE
Note: passwords hidden
===========================================
`cat $PROP_FILE |egrep -vi 'password|Credentials'`
"
java -jar gitlab-scm-collector.jar --spring.config.name=gitlab --spring.config.location=${PROP_FILE}
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment