doc: announce removal of interactive setup script
diff mbox series

Message ID 20200804102643.3345674-1-thomas@monjalon.net
State Superseded, archived
Headers show
Series
  • doc: announce removal of interactive setup script
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Thomas Monjalon Aug. 4, 2020, 10:26 a.m. UTC
Environment configuration is the responsibility of distributions
or upper-level frameworks.
DPDK focus on documenting the requirements and some recommendations.

Maintaining a good adaptative deployment setup is a project by itself.
Anyway this script was interactive, useful only for experimenters.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Maxime Coquelin Aug. 4, 2020, 10:30 a.m. UTC | #1
On 8/4/20 12:26 PM, Thomas Monjalon wrote:
> Environment configuration is the responsibility of distributions
> or upper-level frameworks.
> DPDK focus on documenting the requirements and some recommendations.
> 
> Maintaining a good adaptative deployment setup is a project by itself.
> Anyway this script was interactive, useful only for experimenters.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/rel_notes/deprecation.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index ea4cfa7a48..7ce9fc3e4f 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -151,3 +151,7 @@ Deprecation Notices
>    Python 2 support will be completely removed in 20.11.
>    In 20.08, explicit deprecation warnings will be displayed when running
>    scripts with Python 2.
> +
> +* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
> +  ``make``. Given environments are too much variables for such a simple script,
> +  it will be removed in DPDK 20.11.
> 

Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime
Jerin Jacob Aug. 4, 2020, 10:33 a.m. UTC | #2
On Tue, Aug 4, 2020 at 4:00 PM Maxime Coquelin
<maxime.coquelin@redhat.com> wrote:
>
>
>
> On 8/4/20 12:26 PM, Thomas Monjalon wrote:
> > Environment configuration is the responsibility of distributions
> > or upper-level frameworks.
> > DPDK focus on documenting the requirements and some recommendations.
> >
> > Maintaining a good adaptative deployment setup is a project by itself.
> > Anyway this script was interactive, useful only for experimenters.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index ea4cfa7a48..7ce9fc3e4f 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -151,3 +151,7 @@ Deprecation Notices
> >    Python 2 support will be completely removed in 20.11.
> >    In 20.08, explicit deprecation warnings will be displayed when running
> >    scripts with Python 2.
> > +
> > +* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
> > +  ``make``. Given environments are too much variables for such a simple script,
> > +  it will be removed in DPDK 20.11.
> >
>
> Acked-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>



>
> Thanks,
> Maxime
>
Ferruh Yigit Aug. 5, 2020, 4:19 p.m. UTC | #3
On 8/4/2020 11:26 AM, Thomas Monjalon wrote:
> Environment configuration is the responsibility of distributions
> or upper-level frameworks.
> DPDK focus on documenting the requirements and some recommendations.
> 
> Maintaining a good adaptative deployment setup is a project by itself.
> Anyway this script was interactive, useful only for experimenters.
> 
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> ---
>  doc/guides/rel_notes/deprecation.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index ea4cfa7a48..7ce9fc3e4f 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -151,3 +151,7 @@ Deprecation Notices
>    Python 2 support will be completely removed in 20.11.
>    In 20.08, explicit deprecation warnings will be displayed when running
>    scripts with Python 2.
> +
> +* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
> +  ``make``. Given environments are too much variables for such a simple script,
> +  it will be removed in DPDK 20.11.
> 

Personally I use script as a shortcut to allocate hugemaps, and find that bit
useful.

Agree that the environment configuration or deployment script is something else,
and not sure if this script ever claimed to be one, it is more a user helper
script I think.

What do you think remove the build part, which depends to Make build system as
mentioned above, and keep the rest as a helper script (and perhaps rename to
highlight the intention), so basically keep only below part:

----------------------------------------------------------
 Step 2: Setup linux environment
----------------------------------------------------------
[45] Insert IGB UIO module
[46] Insert VFIO module
[47] Insert KNI module
[48] Setup hugepage mappings for non-NUMA systems
[49] Setup hugepage mappings for NUMA systems
[50] Display current Ethernet/Baseband/Crypto device settings
[51] Bind Ethernet/Baseband/Crypto device to IGB UIO module
[52] Bind Ethernet/Baseband/Crypto device to VFIO module
[53] Setup VFIO permissions

----------------------------------------------------------
 Step 4: Other tools
----------------------------------------------------------
[56] List hugepage info from /proc/meminfo

----------------------------------------------------------
 Step 5: Uninstall and system cleanup
----------------------------------------------------------
[57] Unbind devices from IGB UIO or VFIO driver
[58] Remove IGB UIO module
[59] Remove VFIO module
[60] Remove KNI module
[61] Remove hugepage mappings
Thomas Monjalon Aug. 5, 2020, 4:26 p.m. UTC | #4
05/08/2020 18:19, Ferruh Yigit:
> On 8/4/2020 11:26 AM, Thomas Monjalon wrote:
> > Environment configuration is the responsibility of distributions
> > or upper-level frameworks.
> > DPDK focus on documenting the requirements and some recommendations.
> > 
> > Maintaining a good adaptative deployment setup is a project by itself.
> > Anyway this script was interactive, useful only for experimenters.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> > 
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index ea4cfa7a48..7ce9fc3e4f 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -151,3 +151,7 @@ Deprecation Notices
> >    Python 2 support will be completely removed in 20.11.
> >    In 20.08, explicit deprecation warnings will be displayed when running
> >    scripts with Python 2.
> > +
> > +* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
> > +  ``make``. Given environments are too much variables for such a simple script,
> > +  it will be removed in DPDK 20.11.
> > 
> 
> Personally I use script as a shortcut to allocate hugemaps, and find that bit
> useful.
> 
> Agree that the environment configuration or deployment script is something else,
> and not sure if this script ever claimed to be one, it is more a user helper
> script I think.
> 
> What do you think remove the build part, which depends to Make build system as
> mentioned above, and keep the rest as a helper script (and perhaps rename to
> highlight the intention), so basically keep only below part:
> 
> ----------------------------------------------------------
>  Step 2: Setup linux environment
> ----------------------------------------------------------
> [45] Insert IGB UIO module
> [46] Insert VFIO module

It does not cover other kernel modules.

> [47] Insert KNI module
> [48] Setup hugepage mappings for non-NUMA systems
> [49] Setup hugepage mappings for NUMA systems

It does not use the standard hugepage directory.

> [50] Display current Ethernet/Baseband/Crypto device settings
> [51] Bind Ethernet/Baseband/Crypto device to IGB UIO module
> [52] Bind Ethernet/Baseband/Crypto device to VFIO module

These are just calling another script in usertools.

> [53] Setup VFIO permissions
> 
> ----------------------------------------------------------
>  Step 4: Other tools
> ----------------------------------------------------------
> [56] List hugepage info from /proc/meminfo
> 
> ----------------------------------------------------------
>  Step 5: Uninstall and system cleanup
> ----------------------------------------------------------
> [57] Unbind devices from IGB UIO or VFIO driver
> [58] Remove IGB UIO module
> [59] Remove VFIO module
> [60] Remove KNI module
> [61] Remove hugepage mappings

This script has bad quality and is very partial.
Are we sure we want to keep above parts?
What about adding separate scripts for VFIO permissions
or hugepage mapping and info?
Trahe, Fiona Aug. 5, 2020, 5:46 p.m. UTC | #5
+1 for keeping at least the huge-page setup  part - I use this all the time.

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Thomas Monjalon
> Sent: Wednesday, August 5, 2020 5:27 PM
> To: Yigit, Ferruh <ferruh.yigit@intel.com>
> Cc: dev@dpdk.org; david.marchand@redhat.com; arybchenko@solarflare.com; Richardson, Bruce
> <bruce.richardson@intel.com>; stephen@networkplumber.org; ajit.khaparde@broadcom.com;
> jerinj@marvell.com; maxime.coquelin@redhat.com; akhil.goyal@nxp.com; bluca@debian.org;
> ktraynor@redhat.com; honnappa.nagarahalli@arm.com
> Subject: Re: [dpdk-dev] [PATCH] doc: announce removal of interactive setup script
> 
> 05/08/2020 18:19, Ferruh Yigit:
> > On 8/4/2020 11:26 AM, Thomas Monjalon wrote:
> > > Environment configuration is the responsibility of distributions
> > > or upper-level frameworks.
> > > DPDK focus on documenting the requirements and some recommendations.
> > >
> > > Maintaining a good adaptative deployment setup is a project by itself.
> > > Anyway this script was interactive, useful only for experimenters.
> > >
> > > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > > ---
> > >  doc/guides/rel_notes/deprecation.rst | 4 ++++
> > >  1 file changed, 4 insertions(+)
> > >
> > > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > > index ea4cfa7a48..7ce9fc3e4f 100644
> > > --- a/doc/guides/rel_notes/deprecation.rst
> > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > @@ -151,3 +151,7 @@ Deprecation Notices
> > >    Python 2 support will be completely removed in 20.11.
> > >    In 20.08, explicit deprecation warnings will be displayed when running
> > >    scripts with Python 2.
> > > +
> > > +* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
> > > +  ``make``. Given environments are too much variables for such a simple script,
> > > +  it will be removed in DPDK 20.11.
> > >
> >
> > Personally I use script as a shortcut to allocate hugemaps, and find that bit
> > useful.
> >
> > Agree that the environment configuration or deployment script is something else,
> > and not sure if this script ever claimed to be one, it is more a user helper
> > script I think.
> >
> > What do you think remove the build part, which depends to Make build system as
> > mentioned above, and keep the rest as a helper script (and perhaps rename to
> > highlight the intention), so basically keep only below part:
> >
> > ----------------------------------------------------------
> >  Step 2: Setup linux environment
> > ----------------------------------------------------------
> > [45] Insert IGB UIO module
> > [46] Insert VFIO module
> 
> It does not cover other kernel modules.
> 
> > [47] Insert KNI module
> > [48] Setup hugepage mappings for non-NUMA systems
> > [49] Setup hugepage mappings for NUMA systems
> 
> It does not use the standard hugepage directory.
> 
> > [50] Display current Ethernet/Baseband/Crypto device settings
> > [51] Bind Ethernet/Baseband/Crypto device to IGB UIO module
> > [52] Bind Ethernet/Baseband/Crypto device to VFIO module
> 
> These are just calling another script in usertools.
> 
> > [53] Setup VFIO permissions
> >
> > ----------------------------------------------------------
> >  Step 4: Other tools
> > ----------------------------------------------------------
> > [56] List hugepage info from /proc/meminfo
> >
> > ----------------------------------------------------------
> >  Step 5: Uninstall and system cleanup
> > ----------------------------------------------------------
> > [57] Unbind devices from IGB UIO or VFIO driver
> > [58] Remove IGB UIO module
> > [59] Remove VFIO module
> > [60] Remove KNI module
> > [61] Remove hugepage mappings
> 
> This script has bad quality and is very partial.
> Are we sure we want to keep above parts?
> What about adding separate scripts for VFIO permissions
> or hugepage mapping and info?
>
Stephen Hemminger Aug. 5, 2020, 6:26 p.m. UTC | #6
On Wed, 5 Aug 2020 17:46:21 +0000
"Trahe, Fiona" <fiona.trahe@intel.com> wrote:

> +1 for keeping at least the huge-page setup  part - I use this all the time.

Huge page setup should be made its own script.
Bruce Richardson Aug. 6, 2020, 9:35 a.m. UTC | #7
On Wed, Aug 05, 2020 at 11:26:13AM -0700, Stephen Hemminger wrote:
> On Wed, 5 Aug 2020 17:46:21 +0000
> "Trahe, Fiona" <fiona.trahe@intel.com> wrote:
> 
> > +1 for keeping at least the huge-page setup  part - I use this all the time.
> 
> Huge page setup should be made its own script.

Hugepage parameters should just be added to the kernel parameters in
/etc/default/grub and then forgotten about! :-)
Kinsella, Ray Aug. 6, 2020, 1:51 p.m. UTC | #8
Suggest we keep the deprecation notice, 
and note that the script will be replaced with a specific script for hugepages?

Ray K

On 06/08/2020 10:35, Bruce Richardson wrote:
> On Wed, Aug 05, 2020 at 11:26:13AM -0700, Stephen Hemminger wrote:
>> On Wed, 5 Aug 2020 17:46:21 +0000
>> "Trahe, Fiona" <fiona.trahe@intel.com> wrote:
>>
>>> +1 for keeping at least the huge-page setup  part - I use this all the time.
>>
>> Huge page setup should be made its own script.
> 
> Hugepage parameters should just be added to the kernel parameters in
> /etc/default/grub and then forgotten about! :-)
>
Thomas Monjalon Aug. 6, 2020, 2:43 p.m. UTC | #9
06/08/2020 15:51, Kinsella, Ray:
> Suggest we keep the deprecation notice, 
> and note that the script will be replaced with a specific script for hugepages?

OK I send a v2 keeping acks from Maxime and Jerin.



> On 06/08/2020 10:35, Bruce Richardson wrote:
> > On Wed, Aug 05, 2020 at 11:26:13AM -0700, Stephen Hemminger wrote:
> >> On Wed, 5 Aug 2020 17:46:21 +0000
> >> "Trahe, Fiona" <fiona.trahe@intel.com> wrote:
> >>
> >>> +1 for keeping at least the huge-page setup  part - I use this all the time.
> >>
> >> Huge page setup should be made its own script.
> > 
> > Hugepage parameters should just be added to the kernel parameters in
> > /etc/default/grub and then forgotten about! :-)
> > 
>

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ea4cfa7a48..7ce9fc3e4f 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -151,3 +151,7 @@  Deprecation Notices
   Python 2 support will be completely removed in 20.11.
   In 20.08, explicit deprecation warnings will be displayed when running
   scripts with Python 2.
+
+* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
+  ``make``. Given environments are too much variables for such a simple script,
+  it will be removed in DPDK 20.11.