diff options
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 6 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 94 | ||||
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | interface-definitions/protocols-isis.xml.in | 12 | ||||
| -rw-r--r-- | op-mode-definitions/show-ip-route.xml | 6 | ||||
| -rw-r--r-- | python/vyos/limericks.py | 16 | ||||
| -rwxr-xr-x | src/conf_mode/protocols_isis.py | 7 |
7 files changed, 114 insertions, 28 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index adbe21090..cc5e2f536 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,12 @@ <!-- All PR should follow this template to allow a clean and transparent review --> -<!-- Text placed between these delimiters is considered a commend and not rendered --> +<!-- Text placed between these delimiters is considered a commend and is not rendered --> ## Change Summary <!--- Provide a general summary of your changes in the Title above --> ## Types of changes -<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> +<!--- What types of changes does your code introduce? Put an 'x' in all the boxes that apply. --> +<!--- NOTE: Markdown requires no leading or trailing whitespace inside the [ ] for checking the box, please use [x] --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Code style update (formatting, renaming) @@ -17,6 +18,7 @@ <!-- All submitted PRs must be linked to a Task on Phabricator. --> ## Component(s) name +<!-- A rather incomplete list of components: ethernet, wireguard, bgp, mpls, ldp, l2tp, dhcp ... --> ## Proposed changes <!--- Describe your changes in detail --> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d8177a5f5..7ac48ee4c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,90 @@ # Contributing to VyOS -You wan't to help us improve VyOS? This is awesome. We accept any kind of Pull -Requests on GitHub. To make the life of the maintainers and you as future -contributor (or maybe maintainer) much easier we have come up with some basic -rules. Instead of copy/pasting or maintaining two instances of how to contribute -to VyOS you can find the entire process documented in our online documentation: -https://docs.vyos.io/en/latest/contributing/development.html +You wan't to help us improve VyOS? This is awesome! -Also this guide might not be complete so any PR is much appreciated. +We accept any kind of Pull Requests on GitHub. In order to get your changes into +the main repository as smooth as possible please take yourself some time and +review this contribution guideline. -It might also worth browsing our blog: https://blog.vyos.io +The following paragraphs are an excerpt from our Documentation. + +## Bug Report/Issue +Issues or bugs are found in any software project. VyOS is not an exception. + +All issues should be reported to the developers. This lets the developers know +what is not working properly. Without this sort of feedback every developer +will believe that everything is working correctly. + +### I have found a bug, what should I do? + +When you believe you have found a bug, it is always a good idea to verify the +issue prior to opening a bug request. + +* Consult our [Documentation](https://docs.vyos.io) to ensure that you have + configured your system correctly +* Get community support via [Slack](https://slack.vyos.io) or our online + [Forum](https://forum.vyos.io) + +#### Ensure the problem is reproducible + +When you are able to verify that it is actually a bug, spend some time to +document how to reproduce the issue. This documentation can be invaluable. + +When you wish to have a developer fix a bug that you found, helping them +reproduce the issue is beneficial to everyone. Be sure to include information +about the hardware you are using, commands that you were running, any other +activities that you may have been doing at the time. This additional +information can be very useful. + +* What were you attempting to achieve? +* What was the configuration prior to the change? +* What commands did you use? Use e.g. ``show configuration commands`` + +#### Include output + +The output you get when you find a bug can provide lots of information. If you +get an error message on the screen, copy it exactly. Having the exact message +can provide detail that the developers can use. Like wise if you have any log +messages that also are from the time of the issue, include those. They may +also contain information that is helpful for the development team. + +### Reporting + +In order to open up a bug-report/feature request you need to create yourself +an account on [Phabricator](https://phabricator.vyos.net). On the left +side of the specific project (VyOS 1.2 or VyOS 1.3) you will find quick-links +for opening a bug-report/feature request. + +* Provide as much information as you can +* Which version of VyOS are you using? Use operational level command: + ``show version`` +* How can we reproduce this Bug? Please include a CLI configuration, you can + use ``show configuration command | strip-private`` to remove sensitive + information before publishing. + +## Feature Request + +You have an idea of how to make VyOS better or you are in need of a specific +feature which all users of VyOS would benefit from? To send a feature request +please search [Phabricator](https://phabricator.vyos.net) if there is already a +request pending. You can enhance it or if you don't find one, create a new one +by use the quick link in the left side under the specific project. + +## Code Contribution + +For contributing code to VyOS please take a short moment and review the guideline +outlined in our Documentation at +https://docs.vyos.io/en/latest/contributing/development.html#submit-a-patch + +### Coding Guidelines + +We have some small coding guidelines which are defined in a separate section of +at https://docs.vyos.io/en/latest/contributing/development.html#coding-guidelines. +The guidelines cover how to create the necessary XML structure for new features +and also how to read in the code from the CLI into the Python based scripting +backend. + +Thank you for taking the time reading this guide. + +It might also worth browsing our [Blog](https://blog.vyos.io) for additional +info and updates. @@ -79,7 +79,6 @@ interface_definitions: $(BUILD_DIR) $(obj) rm -f $(TMPL_DIR)/interfaces/wireguard/node.tag/ipv6/node.def rm -f $(TMPL_DIR)/protocols/node.def rm -rf $(TMPL_DIR)/protocols/nbgp - rm -rf $(TMPL_DIR)/protocols/isis rm -f $(TMPL_DIR)/protocols/static/node.def rm -f $(TMPL_DIR)/policy/node.def rm -f $(TMPL_DIR)/system/node.def diff --git a/interface-definitions/protocols-isis.xml.in b/interface-definitions/protocols-isis.xml.in index 988231108..c98b04220 100644 --- a/interface-definitions/protocols-isis.xml.in +++ b/interface-definitions/protocols-isis.xml.in @@ -5,7 +5,7 @@ <children> <tagNode name="isis" owner="${vyos_conf_scripts_dir}/protocols_isis.py"> <properties> - <help>Intermediate System to Intermediate System (ISIS)</help> + <help>Intermediate System to Intermediate System (IS-IS)</help> <valueHelp> <format>text(TAG)</format> <description>ISO Routing area tag</description> @@ -264,7 +264,7 @@ </node> <node name="connected"> <properties> - <help>Redistribute connected routes into ISIS</help> + <help>Redistribute connected routes into IS-IS</help> </properties> <children> #include <include/isis-redistribute-ipv4.xml.i> @@ -272,7 +272,7 @@ </node> <node name="kernel"> <properties> - <help>Redistribute kernel routes into ISIS</help> + <help>Redistribute kernel routes into IS-IS</help> </properties> <children> #include <include/isis-redistribute-ipv4.xml.i> @@ -280,7 +280,7 @@ </node> <node name="ospf"> <properties> - <help>Redistribute OSPF routes into ISIS</help> + <help>Redistribute OSPF routes into IS-IS</help> </properties> <children> #include <include/isis-redistribute-ipv4.xml.i> @@ -288,7 +288,7 @@ </node> <node name="rip"> <properties> - <help>Redistribute RIP routes into ISIS</help> + <help>Redistribute RIP routes into IS-IS</help> </properties> <children> #include <include/isis-redistribute-ipv4.xml.i> @@ -296,7 +296,7 @@ </node> <node name="static"> <properties> - <help>Redistribute static routes into ISIS</help> + <help>Redistribute static routes into IS-IS</help> </properties> <children> #include <include/isis-redistribute-ipv4.xml.i> diff --git a/op-mode-definitions/show-ip-route.xml b/op-mode-definitions/show-ip-route.xml index 48ebbc74a..a98048785 100644 --- a/op-mode-definitions/show-ip-route.xml +++ b/op-mode-definitions/show-ip-route.xml @@ -55,6 +55,12 @@ </properties> <command>ip -s route list $5</command> </tagNode> + <leafNode name="isis"> + <properties> + <help>Show IP IS-IS routes</help> + </properties> + <command>/usr/bin/vtysh -c "show ip route isis"</command> + </leafNode> <leafNode name="kernel"> <properties> <help>Show IP kernel routes</help> diff --git a/python/vyos/limericks.py b/python/vyos/limericks.py index e03ccd32b..3c6744816 100644 --- a/python/vyos/limericks.py +++ b/python/vyos/limericks.py @@ -18,18 +18,18 @@ import random limericks = [ """ -A programmer who's name was Searle -Once wrote a long program in Perl. -Despite very few quirks -No one got how it works, -Not even the interpreter. +A programmer whose name was Searle +once wrote a long program in Perl. +Despite very few quirks, +no one got how it works. +Not even the interpreter perl(1). """, """ There was a young lady of Maine -Who set up IPsec VPN. +who set up IPsec VPN. Problems didn't arise -'til other vendors' device +till other vendors' device had to add she to that VPN. """, @@ -45,7 +45,7 @@ to get the damn build scripts to work. A network admin from Hong Kong knew MPPE cipher's not strong. But he was behind NAT, -so he put up we that, +so he put up with that, sad network admin from Hong Kong. """, diff --git a/src/conf_mode/protocols_isis.py b/src/conf_mode/protocols_isis.py index df03fd990..bd372a7b3 100755 --- a/src/conf_mode/protocols_isis.py +++ b/src/conf_mode/protocols_isis.py @@ -1,6 +1,6 @@ #!/usr/bin/env python3 # -# Copyright (C) 2017-2020 VyOS maintainers and contributors +# Copyright (C) 2020 VyOS maintainers and contributors # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License version 2 or later as @@ -118,15 +118,16 @@ def apply(isis): # Save original configuration prior to starting any commit actions frr_cfg = {} frr_cfg['original_config'] = frr.get_configuration(daemon='isisd') - frr_cfg['modified_config'] = frr.replace_section(frr_cfg['original_config'], isis['new_frr_config'], from_re='router isis .*') + frr_cfg['modified_config'] = frr.replace_section(frr_cfg['original_config'], isis['new_frr_config'], from_re='interface .*') # Debugging + ''' print('') print('--------- DEBUGGING ----------') print(f'Existing config:\n{frr_cfg["original_config"]}\n\n') print(f'Replacement config:\n{isis["new_frr_config"]}\n\n') print(f'Modified config:\n{frr_cfg["modified_config"]}\n\n') - + ''' # FRR mark configuration will test for syntax errors and throws an # exception if any syntax errors is detected frr.mark_configuration(frr_cfg['modified_config']) |