| Charles Chan | fcfe890 | 2022-02-02 17:06:27 -0800 | [diff] [blame] | 1 | .. SPDX-FileCopyrightText: 2021 Open Networking Foundation <info@opennetworking.org> |
| 2 | .. SPDX-License-Identifier: Apache-2.0 |
| 3 | |
| Charles Chan | caebcf3 | 2021-09-20 22:17:52 -0700 | [diff] [blame] | 4 | Component Configuration |
| 5 | ======================= |
| Wailok Shum | 2f05cd3 | 2021-09-30 22:18:19 +0800 | [diff] [blame] | 6 | |
| 7 | Different from network configurations, |
| 8 | component configurations are attributes and feature flags specific to ONOS components. |
| 9 | |
| Carmelo Cascone | 4398998 | 2021-10-12 00:01:19 -0700 | [diff] [blame] | 10 | For more details, please check the ONOS Wiki `Component Configuration <https://wiki.onosproject.org/display/ONOS/Component+Configuration>`_ |
| Wailok Shum | 2f05cd3 | 2021-09-30 22:18:19 +0800 | [diff] [blame] | 11 | |
| 12 | Enable/Disable Phased Recovery |
| 13 | ------------------------------ |
| Carmelo Cascone | 4398998 | 2021-10-12 00:01:19 -0700 | [diff] [blame] | 14 | Phased recovery is an experimental feature that aims at minimizing traffic |
| 15 | disruption when recovering from a switch failure. When enabled, a recovering |
| 16 | switch is programmed before pointing traffic from other switches towards it. |
| Charles Chan | 0bc8bf5 | 2021-10-07 12:53:55 -0700 | [diff] [blame] | 17 | |
| Wailok Shum | 2f05cd3 | 2021-09-30 22:18:19 +0800 | [diff] [blame] | 18 | To check current status: |
| 19 | |
| 20 | .. code-block:: console |
| 21 | |
| 22 | onos > cfg get org.onosproject.segmentrouting.phasedrecovery.impl.PhasedRecoveryManager phasedRecovery |
| 23 | name=phasedRecovery, type=boolean, value=false, defaultValue=false, description=Enabling phased recovery. |
| 24 | |
| 25 | |
| 26 | We can see that the default value of phased recovery is false. |
| 27 | Which means it is disabled by default. |
| 28 | |
| 29 | To enable phased recovery: |
| 30 | |
| 31 | .. code-block:: console |
| 32 | |
| 33 | onos > cfg set org.onosproject.segmentrouting.phasedrecovery.impl.PhasedRecoveryManager phasedRecovery true |
| 34 | onos > cfg get org.onosproject.segmentrouting.phasedrecovery.impl.PhasedRecoveryManager phasedRecovery |
| 35 | name=phasedRecovery, type=boolean, value=true, defaultValue=false, description=Enabling phased recovery. |
| 36 | |
| Carmelo Cascone | 4398998 | 2021-10-12 00:01:19 -0700 | [diff] [blame] | 37 | Now the value is true and we have successfully enabled phased recovery. |
| Wailok Shum | 2f05cd3 | 2021-09-30 22:18:19 +0800 | [diff] [blame] | 38 | |
| 39 | To disable phased recovery, change the value to ``false``. |
| 40 | |
| 41 | |
| 42 | .. tip:: |
| Carmelo Cascone | 4398998 | 2021-10-12 00:01:19 -0700 | [diff] [blame] | 43 | Simply run ``cfg get`` in the ONOS CLI to view all available component configurations supported by ONOS. |
| Wailok Shum | 2f05cd3 | 2021-09-30 22:18:19 +0800 | [diff] [blame] | 44 | The default values are fine-tuned for SD-Fabric, and therefore we use them for most of the cases. |