Skip to content

Commit

Permalink
docs(changelog): version 1.3.0 [citest skip]
Browse files Browse the repository at this point in the history
Update changelog and .README.html for version 1.3.0

Signed-off-by: Rich Megginson <[email protected]>
  • Loading branch information
richm committed Jul 2, 2024
1 parent 6d6edb3 commit f870662
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 14 deletions.
36 changes: 22 additions & 14 deletions .README.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
<style type="text/css">code{white-space: pre;}</style>
<style type="text/css">
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
Expand All @@ -70,7 +70,7 @@
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
Expand Down Expand Up @@ -173,80 +173,88 @@ <h1 id="role-variables">Role Variables</h1>
<p>These are the variables that can be passed to the role:</p>
<table>
<thead>
<tr class="header">
<tr>
<th><strong>Variable</strong></th>
<th><strong>Default/Choices</strong></th>
<th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<tr>
<td><code>nbde_client_provider</code></td>
<td><code>clevis</code></td>
<td>identifies the provider for the <code>nbde_client</code> role. We
currently support <code>clevis</code>.</td>
</tr>
<tr class="even">
<tr>
<td><code>nbde_client_bindings</code></td>
<td></td>
<td>a list containing binding configurations, which include e.g. devices
and slots.</td>
</tr>
<tr>
<td><code>nbde_client_early_boot</code></td>
<td><code>true</code></td>
<td>by default nbde_client will configure the initrd to unlock the
volume. This may need to be disabled if the managed host is using static
IP addressing, or if the volume should be unlocked by
clevis-luks-askpass</td>
</tr>
</tbody>
</table>
<h2 id="nbde_client_bindings">nbde_client_bindings</h2>
<p><code>nbde_client_bindings</code> is a list of dictionaries that
support the following keys:</p>
<table>
<thead>
<tr class="header">
<tr>
<th><strong>Name</strong></th>
<th><strong>Default/Choices</strong></th>
<th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<tr>
<td><code>device</code></td>
<td></td>
<td>specifies the path of the backing device of an encrypted device on
the managed host. This device must be already configured as a LUKS
device before using the role (<strong>REQUIRED</strong>).</td>
</tr>
<tr class="even">
<tr>
<td><code>encryption_password</code></td>
<td></td>
<td>a valid password or passphrase for opening/unlocking the specified
device. Recommend vault encrypting the value. See <a
href="https://docs.ansible.com/ansible/latest/user_guide/vault.html">https://docs.ansible.com/ansible/latest/user_guide/vault.html</a></td>
</tr>
<tr class="odd">
<tr>
<td><code>encryption_key_src</code></td>
<td></td>
<td>either the absolute or relative path, on the control node, of a file
containing an encryption key valid for opening/unlocking the specified
device. The role will copy this file to the managed node(s).</td>
</tr>
<tr class="even">
<tr>
<td><code>state</code></td>
<td><strong>present</strong> / absent</td>
<td>specifies whether a binding with the configuration described should
be added or removed. Setting state to present (the default) means a
binding will be added; setting state to absent means a binding will be
removed from the device/slot.</td>
</tr>
<tr class="odd">
<tr>
<td><code>slot</code></td>
<td><code>1</code></td>
<td>specifies the slot to use for the binding.</td>
</tr>
<tr class="even">
<tr>
<td><code>servers</code></td>
<td></td>
<td>specifies a list of servers to bind to. To enable high availability,
specify more than one server here.</td>
</tr>
<tr class="odd">
<tr>
<td><code>threshold</code></td>
<td><code>1</code></td>
<td>specifies the threshold for the Shamir Secret Sharing (SSS) scheme
Expand All @@ -255,7 +263,7 @@ <h2 id="nbde_client_bindings">nbde_client_bindings</h2>
succeed, in terms of decryption, in order to complete the process of
recovering the LUKS passphrase to open the device.</td>
</tr>
<tr class="even">
<tr>
<td><code>password_temporary</code></td>
<td><code>false</code></td>
<td>If <code>true</code>, the password or passphrase that was provided
Expand Down
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,22 @@
Changelog
=========

[1.3.0] - 2024-07-02
--------------------

### New Features

- feat: Allow initrd configuration to be skipped (#165)

### Bug Fixes

- fix: add support for EL10 (#166)

### Other Changes

- test: some files not created by nm implementation (#164)
- ci: ansible-lint action now requires absolute directory (#167)

[1.2.20] - 2024-06-11
--------------------

Expand Down

0 comments on commit f870662

Please sign in to comment.