Commit d15ffc0a authored by Georges Racinet's avatar Georges Racinet 🦑
Browse files

Updated README for Heptapod instance config options

parent 8999a023b86d
......@@ -16,18 +16,16 @@ instance
### Heptapod install
*Changed for Heptapod 0.8 (SSH support)*
It's currently not possible to configure details about the heptapod install
(URL, passwords etc)
- Make sure the `heptapod` host name resolves to something (typically a
host-only IP address such as 127.0.0.2) from the system running the tests.
- Run a fresh Docker container named `heptapod`, answering on
`http://heptapod:81` and on `ssh://heptapod:2022`.
The tests will issue `docker exec` commands, HTTP requests and SSH
connections.
- The Gitlab root password will be initialized by the test.
- Run `ssh -p 2022 heptapod` once, to accept the server key. This will
be relaxed in future versions of these tests.
- Run a fresh Docker container named `heptapod`, answering on
`http://heptapod:81` and on `ssh://heptapod:2022` (see `Configuration` below
if you want to change these defaults).
- The tests will issue `docker exec` commands, HTTP requests and SSH
connections.
- The Gitlab root password will be initialized by the test and is not currently
customizable. The tests will fail if the Gitlab root password is already set
and does not match the expected one.
## Running the tests
......@@ -36,6 +34,29 @@ issue Docker commands.
This will test the current state of your Heptapod container.
### Configuration
It is possible to pass down options to the underlying `pytest` command:
```
tox -- --heptapod-url URL
```
Here are the custom options for these tests:
- `--heptapod-url` (default `http://heptapod:81`): HTTP URL of the tested
Heptapod instance. It must be a resolvable host *name*, not an IP address.
It does not have to be resolved through DNS, an `/etc/host` entry pointing
to the loopback interface is fine. **Never, ever run these tests on an
Heptapod instance that's not entirely meant for this**
- `--heptapod-ssh-port` (default 2022): SSH port of the tested Heptapod
instance. The same host name will be used as for HTTP. If the host name
resolves to the loopback interface, it is advised to tie it to a dedicated
address, such as `127.0.0.2`, to minimize risks with your SSH
`known_hosts` file.
- `--heptapod-container-name` (default `heptapod`)
### Choosing the version to test
The versions installed in the Docker image you're using are specified by the
......
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