Skip to content

Commit

Permalink
Restructure configuration repository section a little bit (#55)
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Berendt <[email protected]>
  • Loading branch information
berendt authored Oct 5, 2023
1 parent 81d70b5 commit c118e3a
Showing 1 changed file with 25 additions and 16 deletions.
41 changes: 25 additions & 16 deletions docs/getting-started/configuration-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,35 @@ $ docker run --rm -v $(pwd)/output:/output -it quay.io/osism/cookiecutter
[...]
```

### Use of a stable release
Since we run the cookiecutter inside a container, the user rights are not correct
afterwards and have to be changed with `sudo chown -R $USER: output/`.

This is done via the parameter ``manager_version``. By default, this is always set to
``latest``. If, for example, the stable release ``6.0.0`` is to be used, the value for
this parameter is set to ``6.0.0``.
When you want to Use a stable release this is done via the parameter ``manager_version``.
By default, this is always set to ``latest``. If, for example, the stable release ``6.0.0``
is to be used, the value for this parameter is set to ``6.0.0``.

```
manager_version [latest]: 6.0.0
```

If the `manager_version` parameter is set to a stable release then it is no longer necessary
to set the `ceph_version` and `openstack_version` parameters. These are then no longer needed.
The used versions result from the `manager_version`.

### Post-processing

The configuration repository that is initially created with the Cookiecutter is not directly usable.
For example, the inventory needs to be built.

When you have prepared everything the content generated by the cookiecutter in the `output` directory
is copied to a new (previously created) Git repository and committed. Be careful not to forget the
`.gitignore` file and do not add the `secrets` directory.

### Notes

* The password for Ansible Vault encrypted files, ist stored at `secrets/vaultpass`.
* The password of the generated Keepass file is `password`. This has to be changed.

### Parameters

<table>
Expand Down Expand Up @@ -143,12 +162,12 @@ manager_version [latest]: 6.0.0
</tr>
<tr>
<td><code>name_server</code></td>
<td>Nameserver</td>
<td>Nameserver. Only one nameserver is set here because the query of multiple values in Cooiecutter is weird. Add more nameservers afterwards.</td>
<td><code>149.112.112.112</code></td>
</tr>
<tr>
<td><code>ntp_server</code></td>
<td>NTP server</td>
<td>NTP server. Only one NTP server is set here because the query of multiple values in Cooiecutter is weird. Add more NTP servers afterwards.</td>
<td><code>de.pool.ntp.org</code></td>
</tr>
<tr>
Expand All @@ -167,13 +186,3 @@ manager_version [latest]: 6.0.0
<td><code>1</code></td>
</tr>
</table>

### Post-processing

* Since we run the cookiecutter inside a container, the user rights are not correct
afterwards and have to be changed with `sudo chown -R $USER: output/`.
* The content generated by the cookiecutter in the `output` directory is copied to a new
(previously created) Git repository and committed. Be careful not to forget the
`.gitignore` file and do not add the `secrets` directory.
* The password for Ansible Vault encrypted files, ist stored at `secrets/vaultpass`.
* The password of the generated Keepass file is `password`. This has to be changed.

0 comments on commit c118e3a

Please sign in to comment.