Skip to content

Commit 3c173e8

Browse files
committed
Release: Prepare for v0.1.0
* Update configuration guide and readme
1 parent 1105577 commit 3c173e8

File tree

6 files changed

+49
-22
lines changed

6 files changed

+49
-22
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "nazara"
33
authors = ["Tiara Hock <tiara.dev@proton.me>", "Marvin Friedrich <me@mrvn.sh>"]
4-
version = "0.1.0-beta.3"
4+
version = "0.1.0"
55
edition = "2024"
66
description = "A CLI application to create and update machines and VMs in NetBox."
77
readme = "README.md"

Nazara.changes

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
-------------------------------------------------------------------
2+
Sat Nov 13 16:58:02 UTC 2025 - Tiara Hock <tiara.dev@proton.me>
3+
4+
- 0.1.0
5+
* Allow specifying of primary IPs for VMs and devices
6+
* Prepare code structure for dedicated testsuite
7+
* Fix a bug with auto mode
8+
* Create a VM testing guide for developers
9+
110
-------------------------------------------------------------------
211
Sat Oct 25 12:58:02 UTC 2025 - Tiara Hock <tiara.dev@proton.me>
312

Nazara.spec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# Please submit bugfixes or comments via https://bugs.opensuse.org/
1616

1717
Name: Nazara
18-
Version: 0.1.0_beta.3
18+
Version: 0.1.0
1919
Release: 0.1
2020
Summary: Automated registration and update of machines and VMs in NetBox
2121
License: GPL-3.0

README.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,6 @@ new machines in NetBox or population of information fields for existing ones.
77
**Nazara is in the early stages of its development. Please note that the
88
information listed below is subject to change.**
99

10-
> [!Note] Nazara is currently in a beta state. Bugs are bound to happen. If you
11-
> encounter any, please
12-
> [report them](https://github.com/The-Nazara-Project/Nazara/issues).
13-
>
14-
> Furthermore, **Nazara currently does not support custom fields for any NetBox
15-
> object**. Though, this is the next item on our agenda.
16-
1710
- [Compatibility](#compatibility)
1811
- [Installation](#installation)
1912
- [Building from source](#building-from-source)
@@ -35,12 +28,13 @@ NetBox. When major ports to newer NetBox versions happen - which usually include
3528
breaking changes - the old version of Nazara will be moved to its own branch and
3629
tagged accordingly.
3730

38-
| Nazara Version | NetBox Version | Branch | maintained? |
39-
| ---------------- | ----------------- | ----------------- | ------------------ |
40-
| `v0.1.0_beta.3` | `v4.3.x`, `v4.4.x`| `main` | :white_check_mark: |
41-
| `v0.1.0_beta.2` | `v4.3.x`, `v4.4.x`| `version/beta-2` | :x: |
42-
| `v0.1.0_beta.1` | `v4.3.x` | `version/beta-1` | :x: |
43-
| `v0.1.0_alpha.2` | `v3.6.x` | `version/alpha-2` | :x: |
31+
| Nazara Version | NetBox Version | Branch | maintained? |
32+
| ---------------- | ------------------ | ----------------- | ------------------ |
33+
| `v0.1.0` | `v4.3.x`, `v4.4.x` | `main` | :white_check_mark: |
34+
| `v0.1.0_beta.3` | `v4.3.x`, `v4.4.x` | `version/beta-3` | :x: |
35+
| `v0.1.0_beta.2` | `v4.3.x`, `v4.4.x` | `version/beta-2` | :x: |
36+
| `v0.1.0_beta.1` | `v4.3.x` | `version/beta-1` | :x: |
37+
| `v0.1.0_alpha.2` | `v3.6.x` | `version/alpha-2` | :x: |
4438

4539
Maintenance work on these older versions is not planned.
4640

@@ -155,11 +149,12 @@ When launching Nazara for the first time, it will write a stock config file to
155149
that path. Certain parameters are required to be configured there manually. You
156150
recognize them by their line not being commented out.
157151

158-
Aside from the NetBox system parameters,
159-
configuration via the `config.toml`also allows you to add certain
160-
custom fields to your system information that cannot be automatically selected. A great example would be the`System
161-
Location`entry. To specify that, simply add the parameter under the`[system]`
162-
block in your configuration file.
152+
Aside from the NetBox system parameters, configuration via the `config.toml`also
153+
allows you to add certain custom fields to your system information that cannot
154+
be automatically selected. A great example would be the`System
155+
Location`entry.
156+
To specify that, simply add the parameter under the`[system]` block in your
157+
configuration file.
163158

164159
> [!Note] Currently, configuration by config file is the proper way to use
165160
> Nazara given the amount of data required to register a machine. We are

docs/src/intro.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ to its own branch and tagged accordingly.
2424

2525
|Nazara Version |NetBox Version |Branch |maintained?|
2626
|----------------|-----------------------------|-----------------|---|
27-
|`v0.1.0_beta.3` |`v4.3.x`, `v4.4.x` and newer |`main` |yes|
28-
|`v0.1.0_beta.2` |`v4.3.x`, `v4.4.x` and newer |`version/beta-2` |no |
27+
|`v0.1.0` |`v4.3.x`, `v4.4.x` and newer |`main` |yes|
28+
|`v0.1.0_beta.3` |`v4.3.x`, `v4.4.x` and newer |`version/beta-3` |no |
29+
|`v0.1.0_beta.2` |`v4.3.x`, `v4.4.x` |`version/beta-2` |no |
2930
|`v0.1.0_beta.1` |`v4.3.x` |`version/beta-1` |no |
3031
|`v0.1.0_alpha.2`|`v3.6.x` |`version/alpha-2`|no |
3132

docs/src/users/configuration.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,28 @@ config between machines of the same type and function.
5151
{{#include ../../../src/configuration/config_template.toml}}
5252
```
5353

54+
For VMs, the `name` parameter **is required** to be able to distinguish them cleanly.
55+
56+
~~~ admonish tip
57+
The `name` parameter is optional for devices. If left empty, Nazara will assume the system's hostname as the name
58+
value for the entry. You can combine both your custom name and the machine's hostname by fixing a `@`
59+
symbol to the end of the name value. This works on both VMs and devices.
60+
61+
This way a config entry like this:
62+
63+
```toml
64+
[common]
65+
name = "aurora@"
66+
```
67+
68+
turns into:
69+
70+
```toml
71+
aurora@linux.fritz.box
72+
```
73+
in the final entry.
74+
~~~
75+
5476
### The `config` commands
5577

5678
Nazara provides you with several commands to manage your configuration files:

0 commit comments

Comments
 (0)