[VOL-5310] yamllint cleanups for pre-commit script
api/bbsim/bbsim.yaml
configs/att-services.yaml
configs/bbsim.yaml
configs/dt-fttb-services.yaml
configs/dt-services.yaml
configs/pon-interfaces.yaml
configs/tt-services.yaml
-----------------------------
o Added missing copyright notice.
o adding missing '---' header at begin-of-file.
o Line length:
- Split long comments to fit width restriction.
- Use '>' format char to wrap long urls and paths.
o [Fix] "Mapping Values Are Not Allowed Here"
- Common keys must be indented to the same line.
- ie: workflow & services
o Add missing newline at end-of-file.
o Indent comments to match lines they document.
Signed-off-by: Joey Armstrong <jarmstrong@linuxfoundation.org>
Change-Id: Ibaa909e60bcbb5a75acf9d2288bef2de1da257e4
Signed-off-by: Eric Ball <eball@linuxfoundation.org>
diff --git a/api/bbsim/bbsim.yaml b/api/bbsim/bbsim.yaml
index 8ab6c8b..10a54fa 100644
--- a/api/bbsim/bbsim.yaml
+++ b/api/bbsim/bbsim.yaml
@@ -1,4 +1,61 @@
-# Copyright 2018-2024 Open Networking Foundation (ONF) and the ONF Contributors
+---
+
+type: google.api.Service
+config_version: 3
+
+http:
+ rules:
+ - selector: bbsim.BBSim.Version
+ get: "/v1/version"
+ - selector: bbsim.BBSim.GetOlt
+ get: "/v1/olt"
+ additional_bindings:
+ - get: "/v1/olt/status"
+ - selector: bbsim.BBSim.RebootOlt
+ post: "/v1/olt/reboot"
+
+ - selector: bbsim.BBSim.GetONUs
+ get: "/v1/olt/onus"
+ - selector: bbsim.BBSim.GetONU
+ get: "/v1/olt/onus/{SerialNumber}"
+
+ - selector: bbsim.BBSim.ShutdownONU
+ delete: "/v1/olt/onus/{SerialNumber}"
+ - selector: bbsim.BBSim.ShutdownONUsOnPON
+ delete: "/v1/olt/port/{PonPortId}/onus"
+ - selector: bbsim.BBSim.ShutdownAllONUs
+ delete: "/v1/olt/onus"
+
+ - selector: bbsim.BBSim.PoweronONU
+ post: "/v1/olt/onus/{SerialNumber}"
+ - selector: bbsim.BBSim.PoweronONUsOnPON
+ post: "/v1/olt/port/{PonPortId}/onus"
+ - selector: bbsim.BBSim.PoweronAllONUs
+ post: "/v1/olt/onus"
+
+ - selector: bbsim.BBSim.GetFlows
+ get: "/v1/olt/onus/{SerialNumber}/flows"
+ additional_bindings:
+ - get: "/v1/olt/flows"
+ - selector: bbsim.BBSim.GetOnuTrafficSchedulers
+ get: "/v1/olt/onus/{SerialNumber}/trafficschedulers"
+
+ - selector: bbsim.BBSim.RestartEapol
+ post: "/v1/olt/onus/{OnuSerialNumber}/eapol"
+ - selector: bbsim.BBSim.RestartDhcp
+ post: "/v1/olt/onus/{OnuSerialNumber}/dhcp"
+ - selector: bbsim.BBSim.ChangeIgmpState
+ post: >
+ "/v1/olt/onus/{OnuSerialNumber}/{UniID}/igmp/{SubActionVal}/{GroupAddress}/{VLAN}"
+
+
+ - selector: bbsim.BBSim.SetOnuAlarmIndication
+ post: "/v1/olt/onus/{SerialNumber}/alarms/{AlarmType}/{Status}"
+ - selector: bbsim.BBSim.SetOltAlarmIndication
+ post: "/v1/olt/ports/{InterfaceType}/{InterfaceID}/alarms/los/{Status}"
+
+# -----------------------------------------------------------------------
+# Copyright 2018-2024 Open Networking Foundation Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -11,56 +68,7 @@
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
-
-type: google.api.Service
-config_version: 3
-
-http:
- rules:
- - selector: bbsim.BBSim.Version
- get: "/v1/version"
- - selector: bbsim.BBSim.GetOlt
- get: "/v1/olt"
- additional_bindings:
- - get: "/v1/olt/status"
- - selector: bbsim.BBSim.RebootOlt
- post: "/v1/olt/reboot"
-
- - selector: bbsim.BBSim.GetONUs
- get: "/v1/olt/onus"
- - selector: bbsim.BBSim.GetONU
- get: "/v1/olt/onus/{SerialNumber}"
-
- - selector: bbsim.BBSim.ShutdownONU
- delete: "/v1/olt/onus/{SerialNumber}"
- - selector: bbsim.BBSim.ShutdownONUsOnPON
- delete: "/v1/olt/port/{PonPortId}/onus"
- - selector: bbsim.BBSim.ShutdownAllONUs
- delete: "/v1/olt/onus"
-
- - selector: bbsim.BBSim.PoweronONU
- post: "/v1/olt/onus/{SerialNumber}"
- - selector: bbsim.BBSim.PoweronONUsOnPON
- post: "/v1/olt/port/{PonPortId}/onus"
- - selector: bbsim.BBSim.PoweronAllONUs
- post: "/v1/olt/onus"
-
- - selector: bbsim.BBSim.GetFlows
- get: "/v1/olt/onus/{SerialNumber}/flows"
- additional_bindings:
- - get: "/v1/olt/flows"
- - selector: bbsim.BBSim.GetOnuTrafficSchedulers
- get: "/v1/olt/onus/{SerialNumber}/trafficschedulers"
-
- - selector: bbsim.BBSim.RestartEapol
- post: "/v1/olt/onus/{OnuSerialNumber}/eapol"
- - selector: bbsim.BBSim.RestartDhcp
- post: "/v1/olt/onus/{OnuSerialNumber}/dhcp"
- - selector: bbsim.BBSim.ChangeIgmpState
- post: "/v1/olt/onus/{OnuSerialNumber}/{UniID}/igmp/{SubActionVal}/{GroupAddress}/{VLAN}"
-
-
- - selector: bbsim.BBSim.SetOnuAlarmIndication
- post: "/v1/olt/onus/{SerialNumber}/alarms/{AlarmType}/{Status}"
- - selector: bbsim.BBSim.SetOltAlarmIndication
- post: "/v1/olt/ports/{InterfaceType}/{InterfaceID}/alarms/los/{Status}"
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2018-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
diff --git a/configs/att-services.yaml b/configs/att-services.yaml
index c9116e2..fff1083 100644
--- a/configs/att-services.yaml
+++ b/configs/att-services.yaml
@@ -1,13 +1,35 @@
-# Contains a description of the services that needs to be created for each UNI and the corresponding tagging scheme
+---
+
+# Contains a description of the services that needs to be created for each
+# UNI and the corresponding tagging scheme
# ATT
workflow: att
services:
-- name: hsia
- c_tag: 900
- c_tag_allocation: unique
- s_tag: 900
- s_tag_allocation: shared
- needs_eapol: true
- needs_dhcp: true
- tp_id: 64
+ - name: hsia
+ c_tag: 900
+ c_tag_allocation: unique
+ s_tag: 900
+ s_tag_allocation: shared
+ needs_eapol: true
+ needs_dhcp: true
+ tp_id: 64
+
+# -----------------------------------------------------------------------
+# Copyright 2020-2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2020-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
diff --git a/configs/bbsim.yaml b/configs/bbsim.yaml
index 87cf625..6fa45cd 100644
--- a/configs/bbsim.yaml
+++ b/configs/bbsim.yaml
@@ -42,7 +42,7 @@
reboot_delay: 10 # reboot delay in seconds
# firmware_version: ""
# device_id: 0a:0a:0a:0a:0a:<id>
- port_stats_interval: 20 # in seconds
+ port_stats_interval: 20 # in seconds
# omci_response_rate: 10
# BBR settings
diff --git a/configs/dt-fttb-services.yaml b/configs/dt-fttb-services.yaml
index 6ade030..ab67d38 100644
--- a/configs/dt-fttb-services.yaml
+++ b/configs/dt-fttb-services.yaml
@@ -1,35 +1,57 @@
-# Contains a description of the services that needs to be created for each UNI and the corresponding tagging scheme
+---
+# Contains a description of the services that needs to be
+# created for each UNI and the corresponding tagging scheme
+#
# The service names used in this file are mandatory
# for FTTB to work correctly.
# DPU_MGMT_TRAFFIC is used in bbsim to detect when the sTag
# must be used for DHCP packets instead of the cTag, and the
# Olt app has custom behavior that is triggered by each of
# these names.
-
+#
# DT FTTB
workflow: dt-fttb
- services:
- - name: FTTB_SUBSCRIBER_TRAFFIC
- c_tag: 101
- c_tag_allocation: unique
- s_tag: 3101
- s_tag_allocation: unique
- tp_id: 64
- - name: DPU_ANCP_TRAFFIC
- c_tag: 4
- c_tag_allocation: shared
- s_tag: 40
- s_tag_allocation: shared
- us_pon_s_tag_priority: 7
- tp_id: 64
- - name: DPU_MGMT_TRAFFIC
- c_tag: 6
- c_tag_allocation: shared
- s_tag: 60
- s_tag_allocation: shared
- us_pon_c_tag_priority: 3
- us_pon_s_tag_priority: 7
- tp_id: 64
- enable_mac_learning: true
- needs_dhcp: true
\ No newline at end of file
+services:
+ - name: FTTB_SUBSCRIBER_TRAFFIC
+ c_tag: 101
+ c_tag_allocation: unique
+ s_tag: 3101
+ s_tag_allocation: unique
+ tp_id: 64
+ - name: DPU_ANCP_TRAFFIC
+ c_tag: 4
+ c_tag_allocation: shared
+ s_tag: 40
+ s_tag_allocation: shared
+ us_pon_s_tag_priority: 7
+ tp_id: 64
+ - name: DPU_MGMT_TRAFFIC
+ c_tag: 6
+ c_tag_allocation: shared
+ s_tag: 60
+ s_tag_allocation: shared
+ us_pon_c_tag_priority: 3
+ us_pon_s_tag_priority: 7
+ tp_id: 64
+ enable_mac_learning: true
+ needs_dhcp: true
+
+# -----------------------------------------------------------------------
+# Copyright 2022-2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2022-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
diff --git a/configs/dt-services.yaml b/configs/dt-services.yaml
index 3c3bcce..d064769 100644
--- a/configs/dt-services.yaml
+++ b/configs/dt-services.yaml
@@ -1,12 +1,34 @@
-# Contains a description of the services that needs to be created for each UNI and the corresponding tagging scheme
+---
+
+# Contains a description of the services that needs to be created for each
+# UNI and the corresponding tagging scheme
# DT
workflow: dt
services:
-- name: hsia
- uni_tag_match: 4096
- c_tag: 4096
- c_tag_allocation: shared
- s_tag: 900
- s_tag_allocation: unique
- tp_id: 64
\ No newline at end of file
+ - name: hsia
+ uni_tag_match: 4096
+ c_tag: 4096
+ c_tag_allocation: shared
+ s_tag: 900
+ s_tag_allocation: unique
+ tp_id: 64
+
+# -----------------------------------------------------------------------
+# Copyright 2020-2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2020-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
diff --git a/configs/pon-interfaces.yaml b/configs/pon-interfaces.yaml
index 809ed0d..9ab6063 100644
--- a/configs/pon-interfaces.yaml
+++ b/configs/pon-interfaces.yaml
@@ -1,4 +1,5 @@
---
+
num_pon_ports: 16
ranges:
-
@@ -14,4 +15,23 @@
end: 1024
gemport_id_range:
start: 256
- end: 1024
\ No newline at end of file
+ end: 1024
+
+# -----------------------------------------------------------------------
+# Copyright 2022-2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2022-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------
diff --git a/configs/tt-services.yaml b/configs/tt-services.yaml
index 78966b8..76bb60f 100644
--- a/configs/tt-services.yaml
+++ b/configs/tt-services.yaml
@@ -1,49 +1,72 @@
-# Contains a description of the services that needs to be created for each UNI and the corresponding tagging scheme
+---
+
+# Contains a description of the services that needs to be created for each
+# UNI and the corresponding tagging scheme
# TT
workflow: tt
services:
-- name: hsia
- uni_tag_match: 35
- c_tag: 900
- c_tag_allocation: unique
- s_tag: 900
- s_tag_allocation: shared
- tp_id: 64
-- name: voip
- uni_tag_match: 65
- c_tag: 444
- c_tag_allocation: shared
- s_tag: 333
- s_tag_allocation: shared
- needs_dhcp: true
- tp_id: 65
- configure_mac_address: true
- us_pon_c_tag_priority: 7
- us_pon_s_tag_priority: 7
- ds_pon_c_tag_priority: 7
- ds_pon_s_tag_priority: 7
-- name: vod
- uni_tag_match: 55
- c_tag: 55
- c_tag_allocation: shared
- s_tag: 555
- s_tag_allocation: shared
- needs_dhcp: true
- needs_igmp: true
- tp_id: 66
- configure_mac_address: true
- us_pon_c_tag_priority: 5
- us_pon_s_tag_priority: 5
- ds_pon_c_tag_priority: 5
- ds_pon_s_tag_priority: 5
-# NOTE: the multicast service must be called MC unless you set multicastServiceName to something else in org.opencord.olt.impl.Olt
-- name: MC
- c_tag: 55
- c_tag_allocation: shared
- s_tag: 550
- s_tag_allocation: shared
- tp_id: 66
- ds_pon_c_tag_priority: 5
- ds_pon_s_tag_priority: 5
-# TODO add mgmt service (same tagging scheme as void/vod), requires DHCP
\ No newline at end of file
+ - name: hsia
+ uni_tag_match: 35
+ c_tag: 900
+ c_tag_allocation: unique
+ s_tag: 900
+ s_tag_allocation: shared
+ tp_id: 64
+ - name: voip
+ uni_tag_match: 65
+ c_tag: 444
+ c_tag_allocation: shared
+ s_tag: 333
+ s_tag_allocation: shared
+ needs_dhcp: true
+ tp_id: 65
+ configure_mac_address: true
+ us_pon_c_tag_priority: 7
+ us_pon_s_tag_priority: 7
+ ds_pon_c_tag_priority: 7
+ ds_pon_s_tag_priority: 7
+ - name: vod
+ uni_tag_match: 55
+ c_tag: 55
+ c_tag_allocation: shared
+ s_tag: 555
+ s_tag_allocation: shared
+ needs_dhcp: true
+ needs_igmp: true
+ tp_id: 66
+ configure_mac_address: true
+ us_pon_c_tag_priority: 5
+ us_pon_s_tag_priority: 5
+ ds_pon_c_tag_priority: 5
+ ds_pon_s_tag_priority: 5
+ # NOTE: the multicast service must be called MC unless you set
+ # multicastServiceName to something else in org.opencord.olt.impl.Olt
+ - name: MC
+ c_tag: 55
+ c_tag_allocation: shared
+ s_tag: 550
+ s_tag_allocation: shared
+ tp_id: 66
+ ds_pon_c_tag_priority: 5
+ ds_pon_s_tag_priority: 5
+ # TODO add mgmt service (same tagging scheme as void/vod), requires DHCP
+
+# -----------------------------------------------------------------------
+# Copyright 2020-2024 Open Networking Foundation Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# -----------------------------------------------------------------------
+# SPDX-FileCopyrightText: 2020-2024 Open Networking Foundation Contributors
+# SPDX-License-Identifier: Apache-2.0
+# -----------------------------------------------------------------------