WARNING: this is a fork repository, feel free to use it and contribute here but I recommend to try the official repository first.

Introduction

Please look at the official documentation page.

Getting Started

Follow this steps to setting up huskyCI using Docker Compose.

Clone this repository

git clone https://github.com/rogeriobastos/huskyCI.git
cd huskyCI/
echo "export HUSKYCI_PATH='${PWD}'" > .env
echo "export HUSKYCI_SCRIPTS='${PWD}/deployments/scripts'" >> .env
source .env

Create certificates

This certificates are used to protect the communication between huskyCI and docker daemon.

echo "export HUSKYCI_CERT_PATH='${HUSKYCI_PATH}/certs'" >> $HUSKYCI_PATH/.env
echo "export HUSKYCI_CERT_PASSPHRASE='mypassword'" >> $HUSKYCI_PATH/.env
echo "export HUSKYCI_DOCKERAPI_HOST='address.to.dockerapi.host'" >> $HUSKYCI_PATH/.env
echo "export HUSKYCI_DOCKERAPI_ADDR='1.2.3.4'" >> $HUSKYCI_PATH/.env
echo "export HUSKYCI_HOST='address.to.huskyci.host'" >> $HUSKYCI_PATH/.env
source $HUSKYCI_PATH/.env
make create-certs

Configure the docker daemon

HuskyCI requires a docker daemon listening on a TCP port to start the security test containers. You can use the local docker daemon or a remote one (in a VM for example). For security reasons we also configure docker to only allows connections from clients authenticated by a certificate signed by that CA generated above. For more details about this configuration look at docker documentation here and here.

Use the command systemctl edit docker.service to open an override file for docker.service in a text editor.

Add the following lines.

[Service]
ExecStart=
ExecStart=/usr/bin/dockerd --tlsverify --tlscacert=/path/to/certs/docker/ca.pem --tlscert=/path/to/certs/docker/server-cert.pem --tlskey=/path/to/certs/docker/server-key.pem -H fd:// -H tcp://0.0.0.0:2376

Reload systemd and restart docker.

systemctl daemon-reload
systemctl restart docker.service

Configure MongoDB

Set up MongoDB init file.

echo "export HUSKYCI_DATABASE_DB_NAME='huskyCIDB'" >> $HUSKYCI_PATH/.env
echo "export HUSKYCI_DATABASE_DB_USERNAME='huskyCIUser'" >> $HUSKYCI_PATH/.env
echo "export HUSKYCI_DATABASE_DB_PASSWORD='huskyCIPassword'" >> $HUSKYCI_PATH/.env
source $HUSKYCI_PATH/.env
make prepare-local-mongodb

Configure HuskyCI

echo "export HUSKYCI_API_DEFAULT_USERNAME='huskyCIUser'" >> $HUSKYCI_PATH/.env
echo "export HUSKYCI_API_DEFAULT_PASSWORD='huskyCIPassword'" >> $HUSKYCI_PATH/.env
echo "export HUSKYCI_API_ALLOW_ORIGIN_CORS='\"*\"'" >> $HUSKYCI_PATH/.env
source $HUSKYCI_PATH/.env

Building and running HuskyCI Server

Docker compose will start up huskyCI and mongodb. You can reach uskyCI API at http://localhost:8888/.

make compose-up

Building and running HuskyCI Client

You can build and run it locally if you have golang installed. The command make build-client will create the binary file at ./client/cmd/huskyci-client-bin.

Export the required variables and run it.

export HUSKYCI_CLIENT_REPO_URL="https://github.com/globocom/huskyCI.git"
export HUSKYCI_CLIENT_REPO_BRANCH="poc-golang-gosec"
export HUSKYCI_CLIENT_API_ADDR="http://localhost:8888"
export HUSKYCI_CLIENT_API_USE_HTTPS="false"
./client/cmd/huskyci-client-bin

However it's possible to build and run everything inside docker (no need to install golang). The command make build-client-container will create a docker image called huskyci-client.

Create a file with the required environment variables and pass it when run the docker image. The API address will be your local IP and there is no need to use quotation marks to set variables.

cat << EOF > client-env
HUSKYCI_CLIENT_REPO_URL=https://github.com/globocom/huskyCI.git
HUSKYCI_CLIENT_REPO_BRANCH=poc-golang-gosec
HUSKYCI_CLIENT_API_ADDR=http://1.2.3.4:8888
HUSKYCI_CLIENT_API_USE_HTTPS=false
EOF

docker run --rm --env-file client-env huskyci-client

License

huskyCI is licensed under the BSD 3-Clause "New" or "Revised" License.