From f7fc3ce017b03f7c9f4a20a94e2a4d03ee935852 Mon Sep 17 00:00:00 2001 From: fett0 Date: Thu, 17 Jun 2021 14:02:39 -0300 Subject: automation: add custom pre/post-commit hooks --- docs/automation/command-scripting.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index 6bc6690c..b48b8dbf 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -105,6 +105,25 @@ group, the script can be safeguarded like this: exec sg vyattacfg -c "/bin/vbash $(readlink -f $0) $@" fi +Executing pre-hooks/post-hooks Scripts +------------------------------- + +Vyos has the ability to run custom scripts before and after each commit + +≈ + +The default folder where you put your custom Scripts is: + +.. code-block:: none + + +/config/scripts/commit/pre-hooks.d - folder with scripts that run before each commit +/config/scripts/commit/post-hooks.d - folder with scripts that run after each commit + +Scripts are run in alphabetical order. Their names must consist entirely of ASCII upper- and lower-case letters, ASCII digits, ASCII underscores, and ASCII minus-hyphens. +No other characters are allowed. + + Postconfig on boot ------------------ -- cgit v1.2.3 From 6f94d588f55a8794f5379112adcfef901a9cf754 Mon Sep 17 00:00:00 2001 From: fett0 Date: Fri, 18 Jun 2021 17:09:30 -0300 Subject: automation: add custom pre/post-commit hooks --- docs/automation/command-scripting.rst | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index b48b8dbf..43614c21 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -106,23 +106,39 @@ group, the script can be safeguarded like this: fi Executing pre-hooks/post-hooks Scripts -------------------------------- +-------------------------------------- Vyos has the ability to run custom scripts before and after each commit -≈ - -The default folder where you put your custom Scripts is: +The default directories where your custom Scripts should be located are: .. code-block:: none + /config/scripts/commit/pre-hooks.d - Directory with scripts that run before each commit + /config/scripts/commit/post-hooks.d - Directory with scripts that run after each commit -/config/scripts/commit/pre-hooks.d - folder with scripts that run before each commit -/config/scripts/commit/post-hooks.d - folder with scripts that run after each commit - -Scripts are run in alphabetical order. Their names must consist entirely of ASCII upper- and lower-case letters, ASCII digits, ASCII underscores, and ASCII minus-hyphens. +Scripts are run in alphabetical order. Their names must consist entirely of ASCII upper- and +lower-case letters,ASCII digits, ASCII underscores, and ASCII minus-hyphens. No other characters are allowed. +.. note:: Custom scripts are not executed with root privileges (Use sudo inside if this is necessary). + +A simple example is shown below, where the ops command executed in the post-hook script is "show interfaces". + +.. code-block:: none + + vyos@vyos# set interfaces ethernet eth1 address 30.30.30.30/24 + vyos@vyos# commit + Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down + Interface IP Address S/L Description + --------- ---------- --- ----------- + eth0 10.10.10.10/24 u/u + eth1 30.30.30.30/24 u/u + eth2 10.10.20.20/24 u/u + eth3 - u/u + lo 127.0.0.1/8 u/u + ::1/128 + Postconfig on boot ------------------ -- cgit v1.2.3 From d83da4ec55488ae1a3c09d8ca8d3b7d910adf0f2 Mon Sep 17 00:00:00 2001 From: fett0 Date: Fri, 18 Jun 2021 17:52:10 -0300 Subject: automation: add custom pre/post-commit hooks --- docs/automation/command-scripting.rst | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index 43614c21..cf6c1f7b 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -114,30 +114,34 @@ The default directories where your custom Scripts should be located are: .. code-block:: none - /config/scripts/commit/pre-hooks.d - Directory with scripts that run before each commit - /config/scripts/commit/post-hooks.d - Directory with scripts that run after each commit + /config/scripts/commit/pre-hooks.d - Directory with scripts that run before + each commit. -Scripts are run in alphabetical order. Their names must consist entirely of ASCII upper- and -lower-case letters,ASCII digits, ASCII underscores, and ASCII minus-hyphens. -No other characters are allowed. + /config/scripts/commit/post-hooks.d - Directory with scripts that run after + each commit. + +Scripts are run in alphabetical order. Their names must consist entirely of +ASCII upper- and lower-case letters,ASCII digits, ASCII underscores, and +ASCII minus-hyphens.No other characters are allowed. .. note:: Custom scripts are not executed with root privileges (Use sudo inside if this is necessary). -A simple example is shown below, where the ops command executed in the post-hook script is "show interfaces". +A simple example is shown below, where the ops command executed in +the post-hook script is "show interfaces". .. code-block:: none - vyos@vyos# set interfaces ethernet eth1 address 30.30.30.30/24 + vyos@vyos# set interfaces ethernet eth1 address 192.0.2.3/24 vyos@vyos# commit Codes: S - State, L - Link, u - Up, D - Down, A - Admin Down Interface IP Address S/L Description --------- ---------- --- ----------- - eth0 10.10.10.10/24 u/u - eth1 30.30.30.30/24 u/u - eth2 10.10.20.20/24 u/u + eth0 198.51.100.10/24 u/u + eth1 192.0.2.3/24 u/u + eth2 - u/u eth3 - u/u - lo 127.0.0.1/8 u/u - ::1/128 + lo 203.0.113.5/24 u/u + Postconfig on boot -- cgit v1.2.3 From f0b233d760ce1066b023b412c425a7976880905d Mon Sep 17 00:00:00 2001 From: fett0 Date: Wed, 23 Jun 2021 14:36:15 -0300 Subject: automation: add description preconfig on boot --- docs/automation/command-scripting.rst | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index cf6c1f7b..c186257e 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -142,7 +142,23 @@ the post-hook script is "show interfaces". eth3 - u/u lo 203.0.113.5/24 u/u +Preconfig on boot +----------------- +The ``/config/scripts/vyos-preconfig-bootup.script`` script is called on boot +before the VyOS configuration during boot process. + +Any modifications done to work around unfixed bugs and implement enhancements +which are not complete in the VyOS system can be placed here. + +The default file looks like this: + +.. code-block:: none + + #!/bin/sh + # This script is executed at boot time before VyOS configuration is applied. + # Any modifications required to work around unfixed bugs or use + # services not available through the VyOS CLI system can be placed here. Postconfig on boot ------------------ @@ -158,10 +174,10 @@ The default file looks like this: .. code-block:: none #!/bin/sh - # This script is executed at boot time after VyOS configuration is fully + # This script is executed at boot time after VyOS configuration is fullyßßßß # applied. Any modifications required to work around unfixed bugs or use # services not available through the VyOS CLI system can be placed here. -.. hint:: For configuration/upgrade management issues, modification of this +.. hint:: For configuration/upgrade management issues, modification of these script should be the last option. Always try to find solutions based on CLI commands first. -- cgit v1.2.3 From 48c9f47f2ad498c725db466ebaac31dc6a2e71a9 Mon Sep 17 00:00:00 2001 From: fett0 Date: Wed, 23 Jun 2021 15:08:48 -0300 Subject: automation: add description preconfig on boot --- docs/automation/command-scripting.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/automation/command-scripting.rst b/docs/automation/command-scripting.rst index c186257e..56c0817e 100644 --- a/docs/automation/command-scripting.rst +++ b/docs/automation/command-scripting.rst @@ -174,7 +174,7 @@ The default file looks like this: .. code-block:: none #!/bin/sh - # This script is executed at boot time after VyOS configuration is fullyßßßß + # This script is executed at boot time after VyOS configuration is fully # applied. Any modifications required to work around unfixed bugs or use # services not available through the VyOS CLI system can be placed here. -- cgit v1.2.3