diff --git a/source/Installation.rst b/source/Installation.rst index d8a1675453..4b91947677 100644 --- a/source/Installation.rst +++ b/source/Installation.rst @@ -8,6 +8,8 @@ Installation Installation/Crystal Installation/Dashing + Installation/Install-Connext-Security-Plugins + Installation/Install-Connext-University-Eval ROS 2 Installation Options -------------------------- diff --git a/source/Installation/Crystal/Install-Connext-Security-Plugins.rst b/source/Installation/Crystal/Install-Connext-Security-Plugins.rst deleted file mode 100644 index 89d3465ab5..0000000000 --- a/source/Installation/Crystal/Install-Connext-Security-Plugins.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. redirect-from:: - - Install-Connext-Security-Plugins - Installation/Install-Connext-Security-Plugins - -Installing Connext security plugins -=================================== - -The Connext DDS Libraries are included with ROS2 under a `non-commercial -license `__ and do not include the security -plug-in libraries. These libraries are available in the commercial, -university and research license versions of RTI Connext DDS Pro, which -is bundled with tools for system debugging, monitoring, record/replay, -etc. - -A video walk-thru of this installation (tools and security plug-ins) is -available -`here `__ at -the RTI website. The steps are: - -**Install Connext DDS Pro (Host)** -This is a host-specific installer application (for Windows, Linux, MacOS) to install a 'Host' bundle which includes the Launcher, tools, and other software services. -At the end of the installation, the RTI 'Launcher' program will be started. -The Launcher is used to install target libraries, security plugins, and other layered services. - -**Use the Package Installer in Launcher** - -.. figure:: https://cdn2.hubspot.net/hub/1754418/file-3649043118-png/blog-files/launchermacos.png - :alt: Launcher Image - - Launcher Image - -The 'RTI Package Installer' is used to install '.rtipkg' files -- target -libraries, security plug-ins, etc. Open the Package Installer and select -all of the .rtipkg files that were included in the Connext DDS Secure -bundle for installation: - - * Target Libraries - such as: rti\_connext\_dds-[version]-pro-target-[toolchain].rtipkg - * Security Plugin Host - such as: rti\_security\_plugins-[version]-host-[toolchain].rtipkg - * Security Plugin Target - such as: rti\_security\_plugins-[version]-target-[toolchain].rtipkg - * OpenSSL Host - such as: openssl-1.0.2x-[version]-host-[toolchain].rtipkg - -**Extract and Install OpenSSL** -This is included as an archive (.zip or -otherwise) and can be simply extracted and copied to a convenient -location on your host computer. As a suggestion, this could also be -installed into the 'rti\_connext\_dds-[version]' directory in your home -directory space (this was created during installation of the RTI host -tools). Note: this directory location may need to be placed in your PATH -environment variable. - -Installation complete. diff --git a/source/Installation/Crystal/Install-Connext-University-Eval.rst b/source/Installation/Crystal/Install-Connext-University-Eval.rst deleted file mode 100644 index 79a9f1733e..0000000000 --- a/source/Installation/Crystal/Install-Connext-University-Eval.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. redirect-from:: - - Install-Connext-University-Eval - Installation/Install-Connext-University-Eval - -Installing University or Evaluation Versions of RTI Connext DDS -=============================================================== - -A libraries-only version of RTI Connext DDS 5.3.1 may be installed per the `installation instructions ` for -Debian/Ubuntu Linux (amd64) platforms only, under a `non-commercial license `__. - -A full-suite installation of RTI Connext DDS is available for many additional platforms, for universities, evaluation, or purchase. -This installation includes diagnostic tools, layered services, and security. See below for installation details. - -.. note:: - As of the ROS2 'Dashing' release, the Connext RMW layer in ROS2 is compatible with version 5.3.x of RTI Connext DDS, but not with the most-recent version (6.0.0). - - The Connext RMW layer is being modified for 6.0.x compatibility and will be available prior to the next release of ROS2. - -RTI University Program ----------------------- - -University researchers and classroom users may be eligible for a free academic license through the `RTI University Program `__. -This includes a one-year (renewable) license to the unabridged version of Connext DDS Secure, which includes diagnostic tools and layered services. -The university license application can be found `here `__. - - -RTI Connext DDS Evaluation --------------------------- - -To install RTI Connext DDS **version 5.3.1** Evalution: - * Visit the `RTI Free Trial (5.3.1) site `__. - * Register using the online form. - * When directed to the download page, choose the **version 5.3.1** installer for your platform. - * Install RTI Connext 5.3.1 by running the installation program. When finished, it will run the RTI Launcher. - * Use the RTI Launcher to install the license file (rti_license.dat) if needed. The launcher may also be used to launch the diagnostic tools and services. diff --git a/source/Installation/Crystal/Linux-Development-Setup.rst b/source/Installation/Crystal/Linux-Development-Setup.rst index 3bb8768f07..114f0eb4b3 100644 --- a/source/Installation/Crystal/Linux-Development-Setup.rst +++ b/source/Installation/Crystal/Linux-Development-Setup.rst @@ -186,12 +186,12 @@ Note: when using ``zsh`` you need to be in the directory of the script when sour Now you can build as normal and support for RTI will be built as well. -If you want to install the Connext DDS-Security plugins please refer to `this page ` +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>` Official binary packages from RTI ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation `. +You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`. After downloading, use ``chmod +x`` on the ``.run`` executable and then execute it. Note that if you're installing to a system directory use ``sudo`` as well. diff --git a/source/Installation/Crystal/Linux-Install-Binary.rst b/source/Installation/Crystal/Linux-Install-Binary.rst index aaa7447817..e91442190d 100644 --- a/source/Installation/Crystal/Linux-Install-Binary.rst +++ b/source/Installation/Crystal/Linux-Install-Binary.rst @@ -108,7 +108,7 @@ Bouncy and earlier: RTI Connext (version 5.3.1, amd64 only) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation ` +To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` or you can install a libraries-only Debian package of RTI Connext 5.3.1, available from the OSRF Apt respository under a `non-commercial license `__. @@ -134,7 +134,7 @@ All options need you to source the setup file to set the ``NDDSHOME`` environmen Note: the above may need modification to match your RTI installation location -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. Try some examples ----------------- diff --git a/source/Installation/Crystal/Linux-Install-Debians.rst b/source/Installation/Crystal/Linux-Install-Debians.rst index 7287e15972..3f4964a52a 100644 --- a/source/Installation/Crystal/Linux-Install-Debians.rst +++ b/source/Installation/Crystal/Linux-Install-Debians.rst @@ -138,11 +138,11 @@ To install support for OpenSplice or RTI Connext on Bouncy: By setting the environment variable ``RMW_IMPLEMENTATION=rmw_opensplice_cpp`` you can switch to use OpenSplice instead. For ROS 2 releases Bouncy and newer, ``RMW_IMPLEMENTATION=rmw_connext_cpp`` can also be selected to use RTI Connext. -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. .. _linux-ros1-add-pkgs: -`University, purchase or evaluation ` options are also available for RTI Connext. +`University, purchase or evaluation <../Install-Connext-University-Eval>` options are also available for RTI Connext. Install additional packages using ROS 1 packages ------------------------------------------------ diff --git a/source/Installation/Crystal/OSX-Development-Setup.rst b/source/Installation/Crystal/OSX-Development-Setup.rst index 4bdaf050e9..ac6bf43d6d 100644 --- a/source/Installation/Crystal/OSX-Development-Setup.rst +++ b/source/Installation/Crystal/OSX-Development-Setup.rst @@ -191,7 +191,7 @@ Source the ``release.com`` file provided to set up the environment before buildi RTI Connext (5.3) ^^^^^^^^^^^^^^^^^ -If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation `. +If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`. You also need a Java runtime installed to run the RTI code generator, which you can get `here `__. @@ -210,7 +210,7 @@ The setup file and path will depend on your macOS version. You may need to increase shared memory resources following https://community.rti.com/kb/osx510. -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. .. _osx-development-setup-troubleshooting: diff --git a/source/Installation/Crystal/OSX-Install-Binary.rst b/source/Installation/Crystal/OSX-Install-Binary.rst index 7811fd56c8..8792b7b02a 100644 --- a/source/Installation/Crystal/OSX-Install-Binary.rst +++ b/source/Installation/Crystal/OSX-Install-Binary.rst @@ -140,7 +140,7 @@ For ROS 2 releases later than Ardent, set the ``OSPL_HOME`` environment variable Enable Connext support ^^^^^^^^^^^^^^^^^^^^^^ -To use RTI Connext DDS there are options available for `university, purchase or evaluation ` +To use RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` After installing, run RTI launcher and point it to your license file. @@ -152,7 +152,7 @@ Set the ``NDDSHOME`` environment variable: You may need to increase shared memory resources following https://community.rti.com/kb/osx510. -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. Set up the ROS 2 environment ---------------------------- diff --git a/source/Installation/Crystal/Windows-Development-Setup.rst b/source/Installation/Crystal/Windows-Development-Setup.rst index 4e1afae90d..6ae14bf79e 100644 --- a/source/Installation/Crystal/Windows-Development-Setup.rst +++ b/source/Installation/Crystal/Windows-Development-Setup.rst @@ -204,7 +204,7 @@ where the exact paths may need to be slightly altered depending on where you sel RTI Connext 5.3 ^^^^^^^^^^^^^^^ -If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation `. +If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>`. After installing, use the RTI Launcher to load your license file. @@ -217,7 +217,7 @@ Then before building ROS 2, set up the Connext environment: Note that this path might need to be slightly altered depending on where you selected to install RTI Connext DDS, and which version of Visual Studio was selected. The path above is the current default path as of version 5.3.1, but will change as the version numbers increment in the future. -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. If you don't install any additional DDS vendors, ROS 2 will default to using eProsima's Fast-RTPS as the middleware. diff --git a/source/Installation/Crystal/Windows-Install-Binary.rst b/source/Installation/Crystal/Windows-Install-Binary.rst index 9c7e95e960..976f863d2f 100644 --- a/source/Installation/Crystal/Windows-Install-Binary.rst +++ b/source/Installation/Crystal/Windows-Install-Binary.rst @@ -119,7 +119,7 @@ For ROS 2 releases later than Ardent, set the ``OSPL_HOME`` environment variable RTI Connext ~~~~~~~~~~~ -To use RTI Connext DDS there are options available for `university, purchase or evaluation ` +To use RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` After installing, run RTI launcher and point it to your license file. @@ -129,7 +129,7 @@ Set the ``NDDSHOME`` environment variable: set "NDDSHOME=C:\Program Files\rti_connext_dds-5.3.1" -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. Install OpenCV ^^^^^^^^^^^^^^ diff --git a/source/Installation/Dashing/Linux-Development-Setup.rst b/source/Installation/Dashing/Linux-Development-Setup.rst index dc5870cf7a..0f098abfd9 100644 --- a/source/Installation/Dashing/Linux-Development-Setup.rst +++ b/source/Installation/Dashing/Linux-Development-Setup.rst @@ -180,12 +180,12 @@ Note: when using ``zsh`` you need to be in the directory of the script when sour Now you can build as normal and support for RTI will be built as well. -If you want to install the Connext DDS-Security plugins please refer to `this page ` +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>` Official binary packages from RTI ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation ` +You can install the Connext 5.3.1 package for Linux provided by RTI, via options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` After downloading, use ``chmod +x`` on the ``.run`` executable and then execute it. Note that if you're installing to a system directory use ``sudo`` as well. diff --git a/source/Installation/Dashing/Linux-Install-Binary.rst b/source/Installation/Dashing/Linux-Install-Binary.rst index 7fb9c8dee8..557d1bfefd 100644 --- a/source/Installation/Dashing/Linux-Install-Binary.rst +++ b/source/Installation/Dashing/Linux-Install-Binary.rst @@ -93,7 +93,7 @@ To use OpenSplice you can install a Debian package built by OSRF. RTI Connext (version 5.3.1, amd64 only) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation ` +To use RTI Connext DDS there are full-suite install options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` or you can install a libraries-only Debian package of RTI Connext 5.3.1, available from the OSRF Apt respository under a `non-commercial license `__. @@ -119,7 +119,7 @@ All options need you to source the setup file to set the ``NDDSHOME`` environmen Note: the above may need modification to match your RTI installation location -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. Try some examples ----------------- diff --git a/source/Installation/Dashing/Linux-Install-Debians.rst b/source/Installation/Dashing/Linux-Install-Debians.rst index e6c49eeb4b..545fcf1a42 100644 --- a/source/Installation/Dashing/Linux-Install-Debians.rst +++ b/source/Installation/Dashing/Linux-Install-Debians.rst @@ -120,11 +120,11 @@ To install support for OpenSplice or RTI Connext on Bouncy: By setting the environment variable ``RMW_IMPLEMENTATION=rmw_opensplice_cpp`` you can switch to use OpenSplice instead. For ROS 2 releases Bouncy and newer, ``RMW_IMPLEMENTATION=rmw_connext_cpp`` can also be selected to use RTI Connext. -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. .. _Dashing_linux-ros1-add-pkgs: -`University, purchase or evaluation ` options are also available for RTI Connext. +`University, purchase or evaluation <../Install-Connext-University-Eval>` options are also available for RTI Connext. Install additional packages using ROS 1 packages ------------------------------------------------ diff --git a/source/Installation/Dashing/OSX-Development-Setup.rst b/source/Installation/Dashing/OSX-Development-Setup.rst index 1f3a5633ae..5d01be3c43 100644 --- a/source/Installation/Dashing/OSX-Development-Setup.rst +++ b/source/Installation/Dashing/OSX-Development-Setup.rst @@ -201,7 +201,7 @@ Source the ``release.com`` file provided to set up the environment before buildi RTI Connext (5.3) ^^^^^^^^^^^^^^^^^ -If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation ` +If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` You also need a Java runtime installed to run the RTI code generator, which you can get `here `__. @@ -220,7 +220,7 @@ The setup file and path will depend on your macOS version. You may need to increase shared memory resources following https://community.rti.com/kb/osx510. -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. .. _Dashing_osx-development-setup-troubleshooting: diff --git a/source/Installation/Dashing/OSX-Install-Binary.rst b/source/Installation/Dashing/OSX-Install-Binary.rst index fa65bbb2ea..5f2b961721 100644 --- a/source/Installation/Dashing/OSX-Install-Binary.rst +++ b/source/Installation/Dashing/OSX-Install-Binary.rst @@ -143,7 +143,7 @@ For ROS 2 releases later than Ardent, set the ``OSPL_HOME`` environment variable Enable Connext support ^^^^^^^^^^^^^^^^^^^^^^ -To use RTI Connext DDS there are options available for `university, purchase or evaluation ` +To use RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` After installing, run RTI launcher and point it to your license file. @@ -155,7 +155,7 @@ Set the ``NDDSHOME`` environment variable: You may need to increase shared memory resources following https://community.rti.com/kb/osx510. -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. Set up the ROS 2 environment ---------------------------- diff --git a/source/Installation/Dashing/Windows-Development-Setup.rst b/source/Installation/Dashing/Windows-Development-Setup.rst index 98c7621acb..1b059dd414 100644 --- a/source/Installation/Dashing/Windows-Development-Setup.rst +++ b/source/Installation/Dashing/Windows-Development-Setup.rst @@ -202,7 +202,7 @@ where the exact paths may need to be slightly altered depending on where you sel RTI Connext 5.3 ^^^^^^^^^^^^^^^ -If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation ` +If you would like to also build against RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` After installing, use the RTI Launcher to load your license file. @@ -215,7 +215,7 @@ Then before building ROS 2, set up the Connext environment: Note that this path might need to be slightly altered depending on where you selected to install RTI Connext DDS, and which version of Visual Studio was selected. The path above is the current default path as of version 5.3.1, but will change as the version numbers increment in the future. -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. If you don't install any additional DDS vendors, ROS 2 will default to using eProsima's Fast-RTPS as the middleware. diff --git a/source/Installation/Dashing/Windows-Install-Binary.rst b/source/Installation/Dashing/Windows-Install-Binary.rst index ff553bba4f..2d45201fab 100644 --- a/source/Installation/Dashing/Windows-Install-Binary.rst +++ b/source/Installation/Dashing/Windows-Install-Binary.rst @@ -93,7 +93,7 @@ After unpacking, set the ``OSPL_HOME`` environment variable so that it points to RTI Connext ~~~~~~~~~~~ -To use RTI Connext DDS there are options available for `university, purchase or evaluation ` +To use RTI Connext DDS there are options available for `university, purchase or evaluation <../Install-Connext-University-Eval>` After installing, run RTI launcher and point it to your license file. @@ -103,7 +103,7 @@ Set the ``NDDSHOME`` environment variable: set "NDDSHOME=C:\Program Files\rti_connext_dds-5.3.1" -If you want to install the Connext DDS-Security plugins please refer to `this page `. +If you want to install the Connext DDS-Security plugins please refer to `this page <../Install-Connext-Security-Plugins>`. Install OpenCV ^^^^^^^^^^^^^^ diff --git a/source/Installation/Dashing/Install-Connext-Security-Plugins.rst b/source/Installation/Install-Connext-Security-Plugins.rst similarity index 100% rename from source/Installation/Dashing/Install-Connext-Security-Plugins.rst rename to source/Installation/Install-Connext-Security-Plugins.rst diff --git a/source/Installation/Dashing/Install-Connext-University-Eval.rst b/source/Installation/Install-Connext-University-Eval.rst similarity index 96% rename from source/Installation/Dashing/Install-Connext-University-Eval.rst rename to source/Installation/Install-Connext-University-Eval.rst index 250541d540..140d989687 100644 --- a/source/Installation/Dashing/Install-Connext-University-Eval.rst +++ b/source/Installation/Install-Connext-University-Eval.rst @@ -1,7 +1,7 @@ Installing University or Evaluation Versions of RTI Connext DDS =============================================================== -A libraries-only version of RTI Connext DDS 5.3.1 may be installed per the `installation instructions ` for +A libraries-only version of RTI Connext DDS 5.3.1 may be installed per the `installation instructions <../Installation>` for Debian/Ubuntu Linux (amd64) platforms only, under a `non-commercial license `__. A full-suite installation of RTI Connext DDS is available for many additional platforms, for universities, evaluation, or purchase.