2017-03-09 15:12:01 -05:00
|
|
|
# Overview - Scripts and Commands
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This is an overview of the available scripts and commands.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Scripts
|
|
|
|
|
The scripts are located inside `<aio-builds-setup-dir>/scripts/`. The following scripts are
|
|
|
|
|
available:
|
|
|
|
|
|
2017-05-12 04:15:08 -04:00
|
|
|
- `create-image.sh`:
|
2017-03-09 15:12:01 -05:00
|
|
|
Can be used for creating a preconfigured docker image.
|
|
|
|
|
See [here](vm-setup--create-docker-image.md) for more info.
|
|
|
|
|
|
2017-06-19 07:52:58 -04:00
|
|
|
- `test.sh`:
|
2017-03-09 15:12:01 -05:00
|
|
|
Can be used for running the tests for `<aio-builds-setup-dir>/dockerbuild/scripts-js/`. This is
|
|
|
|
|
useful for CI integration. See [here](misc--integrate-with-ci.md) for more info.
|
|
|
|
|
|
2017-06-19 07:52:58 -04:00
|
|
|
- `update-preview-server.sh`:
|
2017-05-17 10:09:53 -04:00
|
|
|
Can be used for updating the docker container (and image) based on the latest changes checked out
|
|
|
|
|
from a git repository. See [here](vm-setup--update-docker-container.md) for more info.
|
2017-03-09 15:12:01 -05:00
|
|
|
|
2017-06-19 07:52:58 -04:00
|
|
|
|
2018-05-09 13:54:53 -04:00
|
|
|
## Production Commands
|
2017-03-09 15:12:01 -05:00
|
|
|
The following commands are available globally from inside the docker container. They are either used
|
|
|
|
|
by the container to perform its various operations or can be used ad-hoc, mainly for testing
|
|
|
|
|
purposes. Each command is backed by a corresponding script inside
|
|
|
|
|
`<aio-builds-setup-dir>/dockerbuild/scripts-sh/`.
|
|
|
|
|
|
|
|
|
|
- `aio-clean-up`:
|
|
|
|
|
Cleans up the builds directory by removing the artifacts that do not correspond to an open PR.
|
|
|
|
|
_It is run as a daily cronjob._
|
|
|
|
|
|
|
|
|
|
- `aio-health-check`:
|
|
|
|
|
Runs a basic health-check, verifying that the necessary services are running, the servers are
|
|
|
|
|
responding and there is a working internet connection.
|
|
|
|
|
_It is used periodically by docker for determining the container's health status._
|
|
|
|
|
|
|
|
|
|
- `aio-init`:
|
|
|
|
|
Initializes the container (mainly by starting the necessary services).
|
|
|
|
|
_It is run (by default) when starting the container._
|
|
|
|
|
|
2018-08-15 08:47:45 -04:00
|
|
|
- `aio-preview-server-prod`:
|
|
|
|
|
Spins up a Node.js preview-server instance.
|
2017-03-09 15:12:01 -05:00
|
|
|
_It is used in `aio-init` (see above) during initialization._
|
|
|
|
|
|
2018-05-09 13:54:53 -04:00
|
|
|
|
|
|
|
|
## Developer Commands
|
|
|
|
|
|
2018-08-15 08:47:45 -04:00
|
|
|
- `aio-preview-server-test`:
|
|
|
|
|
Spins up a Node.js preview-server instance for tests.
|
2017-03-09 15:12:01 -05:00
|
|
|
_It is used in `aio-verify-setup` (see below) for running tests._
|
|
|
|
|
|
|
|
|
|
- `aio-verify-setup`:
|
|
|
|
|
Runs a suite of e2e-like tests, mainly verifying the correct (inter)operation of nginx and the
|
2018-08-15 08:47:45 -04:00
|
|
|
Node.js preview-server.
|
2018-05-09 13:54:53 -04:00
|
|
|
|
|
|
|
|
- `aio-verify-setup-and-log`:
|
2018-08-15 08:47:45 -04:00
|
|
|
Runs the `aio-verify-setup` command but also then dumps the logs from the preview server, which
|
2018-05-09 13:54:53 -04:00
|
|
|
gives additional useful debugging information. See the [debugging docs](misc--debug-docker-container.md)
|
|
|
|
|
for more info.
|
|
|
|
|
|
|
|
|
|
- `aio-dev-mode`:
|
|
|
|
|
Links external source files (from the Docker host) to interal source files (in the Docker
|
|
|
|
|
container). This makes it easier to use an IDE to edit files in the host that are then
|
|
|
|
|
tested in the container. See the [debugging docs](misc--debug-docker-container.md) for more info.
|
