diff --git a/README.md b/README.md index ae7b0a57a8a94da874f226de50b45ddb11e51318..1287c2487b4d9174138d1de27a18ecfad7d85fc6 100644 --- a/README.md +++ b/README.md @@ -27,22 +27,36 @@ export CI_WRAPPER_HOME=${HOME}/.ci-wrappers ## Usage -- `ci-install-software` <br/> - Installs GitHub CLI, Docker client, docker compose plugin, vagrant and terraform in $CI_WRAPPERS_HOME -- `new-java-project testci fr.univtln.bruno.tests` <br/> - Creates a new maven projects ready for C.I. -- `docker-mvn` <br/> - Wraps maven in a container (docker needed see beelow).<br/> - For example to build a C.I. project: `docker-mvn clean verify` -- `ci-github-runner-repo` or `ci-github-runner-org` <br/> - Creates and register a new GitHub runner in a docker container for the current repository - or the organisation (account). -- A docker engine with http proxy support in VM : - - `docker-vagrant` is a wrapper for a specific Docker vagrant Box (Docker in a VBox VM). + - `ci-install-software` <br/> + Installs GitHub CLI, Docker client, docker compose plugin, vagrant and terraform in `$CI_WRAPPERS_HOME` + +### Setup docker + + - if you have an http proxy : + - sets the needed variables `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` + - and adds the variables `VAGRANT_HTTP_PROXY`, `VAGRANT_HTTPS_PROXY` and `VAGRANT_NO_PROXY` + - install the vagrant plugin for proxies : <br/> + `vagrant plugin install vagrant-proxyconf` + - To install a docker engine with http proxy support in a Virtualbox VM with vagrant : + - run `provision-docker-engine` once to create the VM + - `docker-vagrant` is a wrapper for this specific Docker vagrant Box. - `docker-vagrant up` and `docker-vagrant halt` to create/start and stop the vm. - `docker-vagrant ssh` to log in the VM. - `docker-vagrant suspend`, `docker-vagrant resume` and `docker-vagrant status` to suspend, resume and get VM status. - `docker-vagrant destroy` to destroy it (**docker named volumes will be lost**). - - `use-vagrant-docker` to sets docker client to used in the current shell (sets $DOCKER_HOST). - - `vagrant destroy` to destroy it. + - `use-vagrant-docker` sets $DOCKER_HOST for the docker client in the current shell. + - to test `docker run --rm hello-world` + - `vagrant destroy` to destroy the VM AND THE DATA. + +### Continuous Integration (C.I.) + + - `new-java-project testci fr.univtln.bruno.tests` <br/> + Creates a new maven projects ready for C.I. + - `docker-mvn` <br/> + Wraps maven in a container (docker needed see beelow).<br/> + For example to build a C.I. project: `docker-mvn clean verify` + - `ci-github-runner-repo` or `ci-github-runner-org` <br/> + Creates and register a new GitHub runner in a docker container for the current repository + or the organisation (account). +