diff mbox series

[ovs-dev] docs: Explain nature of ovs dependency.

Message ID 20240426203427.955318-1-ihrachys@redhat.com
State Accepted
Headers show
Series [ovs-dev] docs: Explain nature of ovs dependency. | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot-_Build_and_Test fail github build: failed
ovsrobot/github-robot-_ovn-kubernetes fail github build: failed

Commit Message

Ihar Hrachyshka April 26, 2024, 8:34 p.m. UTC
The dependency is during build time, not runtime.

Signed-off-by: Ihar Hrachyshka <ihrachys@redhat.com>
---
 Documentation/intro/install/ovn-upgrades.rst | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

Comments

Ales Musil May 3, 2024, 5:42 a.m. UTC | #1
On Fri, Apr 26, 2024 at 10:35 PM Ihar Hrachyshka <ihrachys@redhat.com>
wrote:

> The dependency is during build time, not runtime.
>
> Signed-off-by: Ihar Hrachyshka <ihrachys@redhat.com>
> ---
>  Documentation/intro/install/ovn-upgrades.rst | 18 ++++++++++++------
>  1 file changed, 12 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/intro/install/ovn-upgrades.rst
> b/Documentation/intro/install/ovn-upgrades.rst
> index bb387e2f8..1f99a86ec 100644
> --- a/Documentation/intro/install/ovn-upgrades.rst
> +++ b/Documentation/intro/install/ovn-upgrades.rst
> @@ -40,13 +40,19 @@ Release Notes
>  You should always check the OVS and OVN release notes (NEWS file) for any
>  release specific notes on upgrades.
>
> -OVS
> ----
> +Open vSwitch
> +------------
>
> -OVN depends on and is included with OVS.  It's expected that OVS and OVN
> are
> -upgraded together, partly for convenience.  OVN is included in OVS
> releases
> -so it's easiest to upgrade them together.  OVN may also make use of new
> -features of OVS only available in that release.
> +OVN compiles with a particular version of Open vSwitch.  This is a
> build-time
> +dependency.
> +
> +In runtime, OVN should be able to work with any reasonably fresh version
> of
> +Open vSwitch (not necessarily the version that it was compiled against.)
> +
> +OVN may make use of new runtime features of Open vSwitch that are only
> +available in a particular release. OVN is expected to test for an Open
> vSwitch
> +feature presence before using it, and gracefully handle scenarios where
> Open
> +vSwitch doesn't support a particular optional feature, yet.
>
>  Upgrade procedures
>  ------------------
> --
> 2.41.0
>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>
>
Looks good to me, thanks.

Acked-by: Ales Musil <amusil@redhat.com>
Numan Siddique May 15, 2024, 9:08 p.m. UTC | #2
On Fri, May 3, 2024 at 1:43 AM Ales Musil <amusil@redhat.com> wrote:
>
> On Fri, Apr 26, 2024 at 10:35 PM Ihar Hrachyshka <ihrachys@redhat.com>
> wrote:
>
> > The dependency is during build time, not runtime.
> >
> > Signed-off-by: Ihar Hrachyshka <ihrachys@redhat.com>
> > ---
> >  Documentation/intro/install/ovn-upgrades.rst | 18 ++++++++++++------
> >  1 file changed, 12 insertions(+), 6 deletions(-)
> >
> > diff --git a/Documentation/intro/install/ovn-upgrades.rst
> > b/Documentation/intro/install/ovn-upgrades.rst
> > index bb387e2f8..1f99a86ec 100644
> > --- a/Documentation/intro/install/ovn-upgrades.rst
> > +++ b/Documentation/intro/install/ovn-upgrades.rst
> > @@ -40,13 +40,19 @@ Release Notes
> >  You should always check the OVS and OVN release notes (NEWS file) for any
> >  release specific notes on upgrades.
> >
> > -OVS
> > ----
> > +Open vSwitch
> > +------------
> >
> > -OVN depends on and is included with OVS.  It's expected that OVS and OVN
> > are
> > -upgraded together, partly for convenience.  OVN is included in OVS
> > releases
> > -so it's easiest to upgrade them together.  OVN may also make use of new
> > -features of OVS only available in that release.
> > +OVN compiles with a particular version of Open vSwitch.  This is a
> > build-time
> > +dependency.
> > +
> > +In runtime, OVN should be able to work with any reasonably fresh version
> > of
> > +Open vSwitch (not necessarily the version that it was compiled against.)
> > +
> > +OVN may make use of new runtime features of Open vSwitch that are only
> > +available in a particular release. OVN is expected to test for an Open
> > vSwitch
> > +feature presence before using it, and gracefully handle scenarios where
> > Open
> > +vSwitch doesn't support a particular optional feature, yet.
> >
> >  Upgrade procedures
> >  ------------------
> > --
> > 2.41.0
> >
> > _______________________________________________
> > dev mailing list
> > dev@openvswitch.org
> > https://mail.openvswitch.org/mailman/listinfo/ovs-dev
> >
> >
> Looks good to me, thanks.
>
> Acked-by: Ales Musil <amusil@redhat.com>

Thanks.  Applied to main.

Numan

>
> --
>
> Ales Musil
>
> Senior Software Engineer - OVN Core
>
> Red Hat EMEA <https://www.redhat.com>
>
> amusil@redhat.com
> <https://red.ht/sig>
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
diff mbox series

Patch

diff --git a/Documentation/intro/install/ovn-upgrades.rst b/Documentation/intro/install/ovn-upgrades.rst
index bb387e2f8..1f99a86ec 100644
--- a/Documentation/intro/install/ovn-upgrades.rst
+++ b/Documentation/intro/install/ovn-upgrades.rst
@@ -40,13 +40,19 @@  Release Notes
 You should always check the OVS and OVN release notes (NEWS file) for any
 release specific notes on upgrades.
 
-OVS
----
+Open vSwitch
+------------
 
-OVN depends on and is included with OVS.  It's expected that OVS and OVN are
-upgraded together, partly for convenience.  OVN is included in OVS releases
-so it's easiest to upgrade them together.  OVN may also make use of new
-features of OVS only available in that release.
+OVN compiles with a particular version of Open vSwitch.  This is a build-time
+dependency.
+
+In runtime, OVN should be able to work with any reasonably fresh version of
+Open vSwitch (not necessarily the version that it was compiled against.)
+
+OVN may make use of new runtime features of Open vSwitch that are only
+available in a particular release. OVN is expected to test for an Open vSwitch
+feature presence before using it, and gracefully handle scenarios where Open
+vSwitch doesn't support a particular optional feature, yet.
 
 Upgrade procedures
 ------------------