Compare commits
6 Commits
1.0.0
...
relax-boun
Author | SHA1 | Date | |
---|---|---|---|
d075adc50d
|
|||
2e3d6bf892 | |||
d8125f4777 | |||
7eb47daace | |||
5e74393578 | |||
ec238fe51b |
25
README.md
25
README.md
@ -21,6 +21,20 @@ useful, please support my maintenance work financially through my
|
||||
Sponsor profile](https://github.com/sponsors/decentral1se). I do not receive
|
||||
any financial support from RedHat or Hetzner Cloud for this work.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
$ pip install molecule-hetznercloud
|
||||
```
|
||||
|
||||
## Upgrade
|
||||
|
||||
Please see the [CHANGELOG.md](./CHANGELOG.md) for migration guides.
|
||||
|
||||
```bash
|
||||
$ pip install --upgrade molecule-hetznercloud
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
You need to expose a `HCLOUD_TOKEN` environment variable in your environment.
|
||||
@ -31,10 +45,9 @@ Find out more about how to get one of those [over here](https://docs.hetzner.clo
|
||||
$ export HCLOUD_TOKEN=mycoolapitoken
|
||||
```
|
||||
|
||||
Then install the required Python package.
|
||||
Then create a role using the driver plugin.
|
||||
|
||||
```bash
|
||||
$ pip install molecule-hetznercloud
|
||||
$ molecule init role myrolename -d hetznercloud
|
||||
```
|
||||
|
||||
@ -78,12 +91,16 @@ It is possible to have the driver manage volumes during the test run.
|
||||
|
||||
You can add the following stanza to your Molecule configuration to have
|
||||
Molecule create this volume for the managed VPS. This volume will be cleaned up
|
||||
after use.
|
||||
after use (**Please note**: there is a bug raised against clean-up right now,
|
||||
see [#24](https://github.com/ansible-community/molecule-hetznercloud/issues/24)
|
||||
for more).
|
||||
|
||||
```yaml
|
||||
volumes:
|
||||
- name: "molecule-hetznercloud-volume-1-${INSTANCE_UUID}"
|
||||
location: /foo/bar
|
||||
- name: "molecule-hetznercloud-volume-2-${INSTANCE_UUID}"
|
||||
size: 20
|
||||
```
|
||||
|
||||
Supported keys are:
|
||||
@ -145,6 +162,6 @@ Only doable by [Autonomic Cooperative](https://autonomic.zone/) members.
|
||||
$ sudo apt install -y direnv
|
||||
$ cp .envrc.sample .envrc
|
||||
$ direnv allow
|
||||
$ pip install -e .
|
||||
$ pip install -e . ansible
|
||||
$ cd integration && molecule test
|
||||
```
|
||||
|
Reference in New Issue
Block a user