You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_openbolt_5x/release_notes.md
+61Lines changed: 61 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,79 @@ title: OpenBolt release notes
5
5
6
6
This page documents the history of the OpenBolt 5.x series.
7
7
8
+
## OpenBolt 5.6.0
9
+
10
+
Released on June 17, 2026
11
+
12
+
Please check the [GitHub OpenBolt release page](https://github.com/OpenVoxProject/openbolt/releases/tag/5.6.0) for details on new features or bug fixes.
Please check the [GitHub OpenBolt release page](https://github.com/OpenVoxProject/openbolt/releases/tag/5.5.0) for details on new features or bug fixes.
Please check the [GitHub OpenBolt release page](https://github.com/OpenVoxProject/openbolt/releases/tag/5.4.0) for details on new features or bug fixes.
All bug fixes, new features and other changes are provided on the [project's GitHub release page](https://github.com/OpenVoxProject/openvox-server/releases/tag/8.14.1).
14
+
15
+
## OpenVox Server 8.14.0
16
+
17
+
{% include alert.html type="note" title="Unreleased" content="Packages for version 8.14.0 were not released due to broken APIs for monitoring service status and performance." %}
18
+
19
+
This is an enhancement, bug-fix, and security release of OpenVox Server.
20
+
21
+
All bug fixes, new features and other changes are provided on the [project's GitHub release page](https://github.com/OpenVoxProject/openvox-server/releases/tag/8.14.0).
Copy file name to clipboardExpand all lines: docs/_openvox_8x/_hiera_context_object.md
+13-10Lines changed: 13 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,4 @@
1
+
<!-- markdownlint-disable MD041 -->
1
2
## The `Puppet::LookupContext` object
2
3
3
4
To support caching and other needs, Hiera provides backends a special `Puppet::LookupContext` object, which has several methods you can call for various effects.
@@ -24,7 +25,7 @@ The following methods are available:
24
25
25
26
### `not_found()`
26
27
27
-
[method_not]: #notfound
28
+
[method_not]: #not_found
28
29
29
30
Tells Hiera to move on to the next data source. Call this method when your function can't find a value for a given lookup. **This method does not return.**
30
31
@@ -44,13 +45,13 @@ In `lookup_key` and `data_dig` backends, you **must** call this method if you wa
44
45
45
46
### `environment_name()`
46
47
47
-
[method_env]: #environmentname
48
+
[method_env]: #environment_name
48
49
49
50
Returns the name of the environment whose hiera.yaml called the function. Returns `undef` (in Puppet) or `nil` (in Ruby) if the function was called by the global or module layer.
50
51
51
52
### `module_name()`
52
53
53
-
[method_module]: #modulename
54
+
[method_module]: #module_name
54
55
55
56
Returns the name of the module whose hiera.yaml called the function. Returns `undef` (in Puppet) or `nil` (in Ruby) if the function was called by the global or environment layer.
56
57
@@ -62,7 +63,9 @@ Caches a value, in a per-data-source private cache; also returns the cached valu
62
63
63
64
On future lookups in this data source, you can retrieve values with `cached_value(key)`. Cached values are immutable, but you can replace the value for an existing key. Cache keys can be anything valid as a key for a Ruby hash. (Notably, this means you can use `nil` as a key.)
64
65
65
-
For example, on its first invocation for a given YAML file, the built-in `eyaml_lookup_key` backend reads the whole file and caches it, and then decrypts only the specific value that was requested. On subsequent lookups into that file, it gets the encrypted value from the cache instead of reading the file from disk again. It also caches decrypted values, so that it won't have to decrypt again if the same key is looked up repeatedly.
66
+
For example, on its first invocation for a given YAML file, the built-in `eyaml_lookup_key` backend reads the whole file and caches it, and then decrypts only the specific value that was requested.
67
+
On subsequent lookups into that file, it gets the encrypted value from the cache instead of reading the file from disk again.
68
+
It also caches decrypted values, so that it won't have to decrypt again if the same key is looked up repeatedly.
66
69
67
70
The cache is also useful for storing session keys or connection objects for backends that access a network service.
68
71
@@ -77,39 +80,39 @@ If any inputs to a function change (for example, a path interpolates a local var
77
80
78
81
### `cache_all(hash)`
79
82
80
-
[method_cache_all]: #cacheallhash
83
+
[method_cache_all]: #cache_allhash
81
84
82
85
Caches all the key/value pairs from a given hash; returns `undef` (in Puppet) or `nil` (in Ruby).
83
86
84
87
### `cached_value(key)`
85
88
86
-
[method_cached]: #cachedvaluekey
89
+
[method_cached]: #cached_valuekey
87
90
88
91
Returns a previously cached value from the per-data-source private cache. Returns `nil` or `undef` if no value with this name has been cached. See [`cache(key, value)`][method_cache] above for more info about how the cache works.
89
92
90
93
### `cache_has_key(key)`
91
94
92
-
[method_haskey]: #cachehaskeykey
95
+
[method_haskey]: #cache_has_keykey
93
96
94
97
Checks whether the cache has a value for a given key yet. Returns `true` or `false`.
95
98
96
99
### `cached_entries()`
97
100
98
-
[method_allcached]: #cachedentries
101
+
[method_allcached]: #cached_entries
99
102
100
103
Returns everything in the per-data-source cache, as an iterable object. Note that this iterable object isn't a hash; if you want a hash, you can use `Hash($context.all_cached())` (in the Puppet language) or `Hash[context.all_cached()]` (in Ruby).
> **Note:** The header above uses Ruby's block syntax. To call this method in the Puppet language, you would use `cached_file_data(path) |content| { ... }`.
107
110
108
111
For best performance, use this method to read files in Hiera backends.
109
112
110
113
Returns the content of the specified file, as a string. If an optional block is provided, it passes the content to the block and returns the block's return value. For example, the built-in JSON backend uses a block to parse JSON and return a hash:
Copy file name to clipboardExpand all lines: docs/_openvox_8x/_hiera_options_hash.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,4 @@
1
+
<!-- markdownlint-disable MD041 -->
1
2
### The options hash
2
3
3
4
Hierarchy levels are configured in [hiera.yaml](./hiera_config_yaml_5.html). When calling a backend function, Hiera passes a modified version of that configuration as a hash.
@@ -6,13 +7,13 @@ The options hash contains the following keys:
6
7
7
8
*`path` --- The absolute path to a file on disk. Only present if the user set one of the `path`, `paths`, `glob`, or `globs` settings. Hiera ensures the file exists before passing it to the function.
8
9
9
-
> **Note:** If your backend uses data files, use the context object's [`cached_file_data` method][method_cached_file] to read them.
10
+
> **Note:** If your backend uses data files, use the context object's [`cached_file_data` method][method_cached_file] to read them.<!-- markdownlint-disable-line MD052 -->
10
11
*`uri` --- A URI that your function can use to locate a data source. Only present if the user set `uri` or `uris`. Hiera doesn't verify the URI before passing it to the function.
11
12
* Every key from the hierarchy level's `options` setting. In your documentation, make sure to list any options your backend requires or accepts. Note that the `path` and `uri` keys are reserved.
12
13
13
14
For example: this hierarchy level in hiera.yaml...
@@ -27,7 +28,7 @@ For example: this hierarchy level in hiera.yaml...
27
28
28
29
...would result in several different options hashes (depending on the current node's facts, whether the files exist, etc.), but they would all resemble the following:
0 commit comments