Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor(eos_cli_config_gen)!: Make router_traffic_engineering.enabled required #4403

Merged
merged 1 commit into from
Aug 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions ansible_collections/arista/avd/docs/porting-guides/5.x.x.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,28 @@ As of AVD 5.0.0 "null" option for esp integrity and encryption has been replaced
+ encryption: disabled
```

### `router_traffic_engineering.enabled` is required

In AVD 4.0.0, setting `enabled: true` under `router_traffic_engineering` was not
required and it was possible to render

```eos
router traffic-engineering
```

using the following input

```yaml
router_traffic_engineering:
```

As of AVD 5.0.0, the `enabled` keyword is required under `router_traffic_engineering`:

```yaml
router_traffic_engineering:
enabled: true
```

### Removal of default type `switched` from ethernet interfaces and port-channel interfaces

In AVD 4.0.0, we had "switched" as the default value for `ethernet_interfaces[].type` and `port_channel_interfaces[].type`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,15 @@ See the [porting guide](../porting-guides/5.x.x.md#no-auto-conversion-of-old-dat

See the [porting guide](../porting-guides/5.x.x.md#ip_securitysa_policiesespintegrity-and-encryption-null-option-has-been-replaced-with-disabled) for details.

#### `router_traffic_engineering.enabled` is required

See the [porting guide](../porting-guides/5.x.x.md#router_traffic_engineeringenabled-is-required) for details.

#### Removal of schema in JSON format

The `eos_cli_config_gen.jsonschema.json` is no longer generated. This schema was not being used and had never been complete.

### Removal of default type `switched` from ethernet interfaces and port-channel interfaces
#### Removal of default type `switched` from ethernet interfaces and port-channel interfaces

Starting AVD 5.0.0, the default value for `type` in `ethernet_interfaces` and `port_channel_interfaces` is no longer supported. The `type` key must now be explicitly defined in the input variables if it is needed in the configuration and documentation.

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@
that can be found in the LICENSE file.
#}
{# doc - router traffic engineering #}
{# for AVD 5.0.0, the first part of the if statement will be removed #}
{% if router_traffic_engineering is arista.avd.defined or router_traffic_engineering.enabled is arista.avd.defined(true) %}
{% if router_traffic_engineering.enabled is arista.avd.defined(true) %}

### Router Traffic-Engineering
{% if router_traffic_engineering.enabled is arista.avd.defined(true) %}

- Traffic Engineering is enabled.
{% endif %}
{% if router_traffic_engineering.segment_routing is arista.avd.defined %}

#### Segment Routing Summary
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
that can be found in the LICENSE file.
#}
{# eos - router traffic engineering #}
{# for AVD 5.0.0, the first part of the if statement will be removed #}
{% if router_traffic_engineering is arista.avd.defined or router_traffic_engineering.enabled is arista.avd.defined(true) %}
{% if router_traffic_engineering.enabled is arista.avd.defined(true) %}
!
router traffic-engineering
{% if router_traffic_engineering.segment_routing is arista.avd.defined %}
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ keys:
keys:
enabled:
type: bool
required: true
router_id:
type: dict
keys:
Expand Down