diff --git a/docs/config_access_mgmt.md b/docs/config_access_mgmt.md index 7d462b5a16..47b7e72d0b 100644 --- a/docs/config_access_mgmt.md +++ b/docs/config_access_mgmt.md @@ -28,8 +28,6 @@ From the terminal window: - `ctrl+a` - `d` -For additional information about the manual installation process with Screen, please refer to [Manually Installing the SSR](intro_installation_installer.md). - ### Additional SSH Parameters - SSH Mode Verification performs strict mode checking of home directory configuration files, as well as user-specific SSH configuration files to prevent one user from logging on to the system as another user. - SSH logon by a non-certificate-trusted host is not allowed. diff --git a/docs/initializer_cli_reference.md b/docs/initializer_cli_reference.md index 216ac65257..bf098302a9 100644 --- a/docs/initializer_cli_reference.md +++ b/docs/initializer_cli_reference.md @@ -5,7 +5,7 @@ sidebar_label: Initializer Command Line Reference This is a reference document for the SSR Initializer command line interface. For a guide to basic usage, see the initialization section of the -[Manual Installation Guide](intro_installation_installer.md#initialize-the-128t-node). +[Router Interactive Installation](intro_installation_bootable_media.mdx#initialize-the-ssr-node). ## Running the Initializer @@ -34,7 +34,6 @@ of 0. If any error was encountered during the operation, the return code will be non-zero. :::note - The SSR must not be running during initialization. The Initializer will detect when SSR is running and exit with this message: @@ -42,9 +41,7 @@ detect when SSR is running and exit with this message: SSR is running; cannot launch Initializer ``` -To stop SSR, follow the steps shown in the -[Installation Guide](intro_installation.md#stopping-the-128t-routing-software). - +To stop the SSR, follow the steps shown in the [Installation Guide](intro_installation.md#stopping-the-128t-routing-software). ::: ### Interactive Mode @@ -56,9 +53,7 @@ SSR. initialize128t ``` -Follow the on-screen prompts to complete the initialization process. Step-by-step -instructions for the Initializer wizard can be found in the -[Installation Guide](intro_installation_installer.md#initialize-the-128t-node). +Follow the on-screen prompts to complete the initialization process. Step-by-step instructions for the Initializer can be found in the initialization section of the [Router Interactive Installation](intro_installation_bootable_media.mdx#initialize-the-ssr-node). ### Automated Mode diff --git a/docs/installer_cli_reference.md b/docs/installer_cli_reference.md index 9644c298a8..4cae96ba13 100644 --- a/docs/installer_cli_reference.md +++ b/docs/installer_cli_reference.md @@ -59,8 +59,9 @@ install128t ``` Follow the on-screen prompts to complete the installation and initialization process. -Step-by-step instructions for the Installer wizard can be found in the -[Installation Guide](intro_installation_installer.md#install-using-128t-installer). +Step-by-step instructions for the Installer can be found starting in the +the initialization section of the +[Router Interacrive Installation](intro_installation_bootable_media.mdx#initialize-the-ssr-node. ## Automated Mode diff --git a/docs/intro_initialize_HA_conductor.md b/docs/intro_initialize_HA_conductor.md index 7c2cc9cfd5..84911523ee 100644 --- a/docs/intro_initialize_HA_conductor.md +++ b/docs/intro_initialize_HA_conductor.md @@ -32,7 +32,7 @@ Click on the link of the public cloud provider where you want to perform the Ses ## Deploying the Primary Node Conductor – Node A -If the SSR software is not already installed on the Node A VM, launch the SSR installer using the command `install128t` and follow the [Installation Procedure](intro_installation_installer.md). After the installation is complete, the system will restart and the initializer will launch automatically. +If the SSR software is not already installed on the Node A VM, refer to the [High Availability Conductor Installation](ha_conductor_install.mdx) procedure. After the installation is complete, the system will restart and the initializer will launch automatically. If the software is already installed, launch the initializer from the command line using `initialize128t`. @@ -80,7 +80,7 @@ Node A is now ready to allow access to Node B in order to form the HA pair. The ## Deploying the Secondary Node Conductor – Node B -Log in to the Node B VM. If the SSR software is not already installed, launch the SSR installer using the command `install128t` and follow the [Installation Procedure](intro_installation_installer.md). After the installation is complete, the system will restart and the initializer will launch automatically. +Log in to the Node B VM. If the SSR software is not already installed on the Node A VM, refer to the [High Availability Conductor Installation](ha_conductor_install.mdx) procedure. After the installation is complete, the system will restart and the initializer will launch automatically. If the software is already installed, launch the initializer from the command line using `initialize128t.` 1. On the SSR Initializer Wizard, use the space bar to select the Conductor role for the SSR node and press the Enter key to select OK. diff --git a/docs/intro_installation_installer.md b/docs/intro_installation_installer.md deleted file mode 100644 index 02a011a45e..0000000000 --- a/docs/intro_installation_installer.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: Manually Installing the SSR -sidebar_label: Manually Installing the SSR ---- -This section describes the manual installation process for the SSR. For automated installation see [Installing from Bootable Media](intro_installation_bootable_media.mdx). - -## Install Using SSR-Installer - -The SSR software installer package is hosted in the Juniper software repository, located at yum.128technology.com. During installation the system will need access to the internet to retrieve software applications and libraries. Please ensure the system can reach the public internet prior to commencing. For offline installation instructions, follow the [instructions for installing from bootable media](intro_installation_bootable_media.mdx). If you are performing an upgrade, see [Upgrading the SSR Networking Platform](intro_upgrading.md) for upgrade instructions. - -The SSR Software package is available from our public servers located at: `https://software.128technology.com/artifactory/list/generic-128t-legacy-isos-remote/` using the username and token provided to you. The username/token simplifies access and does not require the conversion process used for the certificate. With the latest release of the SSR Installer, both a certificate or username/token can be used for installation. However, to use a username/token for software access, Installer 3.0.0 is required. - -:::note -Do not uninstall old versions of the SSR Installer. Later versions of the SSR Installer have dependencies on the earlier versions, and uninstalling them may cause issues for rollback operations. -::: - -Juniper highly recommends upgrading your Conductor to 4.5.7, 5.0.1, or 5.1.1. These versions contain updates for using a username/token for software access. If a username/token is used and the SSR software is not upgraded, a manual process must be followed each time the username/token is changed. See the [Manual Token Process](installer_cli_reference.md#manual-token-process) for more information. - -### Manually Installing using the SSR-Installer - -1. Launch a Linux command prompt. -2. Enter the command to install the Yum repository that corresponds to the SSR software installer. - -``` -sudo yum install http://yum.128technology.com/installer/repo.rpm -``` - -3. Enter the command to download the installer. - -``` -sudo yum install 128T-installer -``` - -:::note -Beginning with Installer version 2.7.0, the use of the Screen utility is no longer necessary. However, for older versions of the Installer, it is strongly recommended to use the Screen utility when performing a manual installation to avoid SSH session timeout. -::: - -- Create a screen and attach to it. -``` -screen -d -m -s -screen -x -``` -4. Enter the command to launch the Interactive Installer wizard. - -``` -sudo install128t -``` -The installer splash screen appears. - -5. Press the **Enter** key to select **Begin** and start the installation wizard. - > Items that have a hotkey have a bold or alternate color letter within the element. If two items have the same hotkey, pressing the hotkey in succession will toggle among all items with a common hotkey shortcut. - - > To select a radio button option, navigate to the radio button using the arrow keys or **Tab** key and press the Space bar. Pressing the **Enter** key will execute the function highlighted at the bottom of the pane, typically _OK_ or _Back_. Additionally, you can navigate fields using the **Tab** key. - -6. You will be asked to enter either the client certificate or the username and token you received as part of your SSR purchase. - If your login credentials are not available, select the `Skip` button. - - - **For the username and token**, enter your username and token information. - - - **For the client certificate**, copy the entire contents of the certificate, _including the Certificate and Private key information_, and paste it into the Client Certificate window of the install wizard.
The content must begin with the line `-----BEGIN CERTIFICATE-----` and end with `-----END RSA PRIVATE KEY-----`. - - This is performed more easily when accessing the target machine over SSH using terminal software, rather than interacting with the target machine directly. Alternatively, you can also store the certificate as /etc/pki/128technology/release.pem to avoid having to copy and paste. - - - Press the **Tab** key after pasting the client certificate to select the **OK** button, and press **Enter**. - -7. From the Version Selection window, select your desired version from the list and select **OK** to continue. The installation begins, and may take several minutes to download and install. -8. Press the **Enter** key to select **OK** and close the installer. -9. Detach from the Screen utility if used. - ``` - ctrl+a - d - ``` -Upon completing the installation, the Installer automatically launches the Initializer. - -### Initialize the Node - -The Initializer is a complementary application to the Installer that tunes your operating system, prepares the platform to run the SSR software, and creates the bootstrapping files necessary to load the software. The Initializer is automatically launched once the Installation wizard is complete. - -1. On the Initializer wizard screen, use the space bar to select either a **Router** or **Conductor **role for the SSR node and press the **Enter** key to select **OK**. - ![128T Role](/img/intro_install_initializer_role.png) - -2. For routers, you will be prompted for the IP address(es) of your conductor(s). If you have conductors, enter their administrative addresses here, and this node will retrieve its configuration from the conductor. If you have only one conductor (i.e., a standalone conductor), leave the field labeled 2nd Conductor Address blank. If you have no conductors, choose **Skip**. -3. When asked _What kind of Router node is this?_, select from the following options: - - ![Identify the Node](/img/intro_install_initializer_HASetup.png) - -- **Standalone:** This router has no highly available peer, and is not currently planned for high availability. -- **1st HA Node:** This router is the first node of a high availability pair. You will be prompted for the High Availability address of this node. Note: The address _must_ be reachable by the 2nd HA Node. -- **2nd HA Node:** This router is the second node of a high availability pair, where the first node has been initialized. You will be prompted for the High Availability address of the first node. - -4. Enter the following system properties on the Node Info screen: - -![Node Information](/img/intro_install_initializer_nodeinfo.png) - -- **Node Name:** The unique name of the system within your SSR Router or Conductor, for example _labsystem1_. By default this field uses the Linux system's hostname. - :::note - Both routers and conductors can consist of one node (for standalone systems) or two nodes (for highly available systems). - ::: -- **Router/Conductor Name:** The name of the Router or Conductor system as a whole. When referring to a running SSR software instance, it is identifiable by the full name of `nodeName.routerName`; e.g., `labsystem1.boston`. The full system name is reflected in the PCLI prompt as discussed in the Document Conventions section of this document. - -5. On the **Password Setup** screen, create a password for the Admin user. The administrator password must be at least 8 characters long, contain at least 1 uppercase letter, at least 1 lowercase letter, at least 1 number, and cannot repeat characters more than 3 times. - :::note - Resetting a password requires entering the old password. If a password is lost or forgotten and the account is inaccessible, the account cannot be recovered. Please keep password records accessible and secure. - ::: - -![Password Setup](/img/intro_install_initializer_password.png) - -6. Press the **Enter** key to select **OK**. The Initializer performs a hardware compatibility check. The compatibility check may fail due to warnings or failure notices, which are displayed in the output script. If no failures are present, you can choose to continue with the installation even if multiple warnings exist. For information on why a specific test may have failed or generated a warning, contact technical support. - -7. When prompted, either reboot your system or start SSR. - - ![Initializer Complete](/img/intro_install_initializer_complete.png) - -:::note -If installing the SSR software for the first time, a system reboot is required. -::: - -### Verify Installation - -After installing the SSR Routing Software it is important to verify that the installation was completed successfully. - -#### To Verify the SSR Installation: - -1. Launch a command prompt window. - -2. Execute the command: - - ``` - sudo systemctl status 128T - ``` - - **Result:** The service is listed as _Active (running)_.
If the service is listed as _Inactive_, run the `sudo systemctl start 128T` command. This may take several minutes to fully launch the service. - -3. Once the service is listed as _Active_, log into the system as Admin using the system default password.
**Result:** The installation is verified. - -4. Close the command prompt window. - diff --git a/docs/legacy_OTP_install.md b/docs/legacy_OTP_install.md deleted file mode 100644 index a51f97de98..0000000000 --- a/docs/legacy_OTP_install.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: Installing Using the Pre-5.0 Interactive ISO -sidebar_label: Installing Using the Pre-5.0 Interactive ISO ---- - -The steps in this section describe installing the legacy Interactive ISO from bootable media. The section, [Initialize the SSR](#initialize-the-128t-node) describes using the Initializer to configure the system as a Conductor after installing from the Interactive ISO. -:::note -The Conductor installation must be completed before installing a router or routers using the OTP ISO. -::: -See [Installing Using the One Touch Provisioning ISO](intro_otp_iso_install.mdx) for details to install complex router configurations **after** installing and configuring the Conductor. - -## Prerequisites - -- Ensure that the platform you are installing on meets the SSR hardware requirements. -- Verify that the boot priority of the USB drive is properly listed in the system BIOS. - -## Installing the ISO - -After imaging the ISO onto removable media, insert it into the target machine and power it on. - -### Choose the Installation Type - -Upon boot, you are prompted with the following screen for the Linux installation: - -![Boot Screen](/img/intro_installation_bootable_media_boot.png) - -:::note -Not all hardware has video support, therefore booting to console is the default (a console user may not be able to select an option). The default option is selected after a 30 second timeout. -::: - -#### SSR System via Serial Console - -Use this option when running on hardware with no video chipset. It uses `/dev/ttyS0` as the serial console for interacting with the installer. - -:::note -Selecting the wrong type of console may result in garbage characters being displayed and the install hanging. If this is the case, reboot the target system and select the correct line for the target hardware. -::: - -#### SSR System with VGA Console - -Use this option when running on hardware that has onboard graphics chipsets. This installs the SSR using the GUI installer. - -### SSR Installation - -After the Linux installation completes, the SSR software installation begins. Note that this may take several minutes to complete. After the installation has completed, the following screen is displayed: - -![Installation Complete](/img/intro_installation_bootable_media_install_complete.png) - -After shutting down the system, remove the bootable media. -If you installed the Interactive ISO powering up the system will start the Initializer. -If you installed using One Touch Provisioning, power the system up to complete the installation process. - -### Installation Notes - -The following user accounts and passwords are created during the ISO installation process: - - | Username | Password | - | -------- | ---------- | - | root | 128tRoutes | - | t128 | 128tRoutes | - - It is *strongly recommended* that you change these passwords immediately. - -GUI login via HTTPS is enabled by default on port 443. - -## Initialize the Node - -The Initializer tunes your operating system, prepares the platform to run the SSR software, and creates the bootstrapping files necessary to load the software. The Initializer is launched after the installation reboot. - -1. On the Initializer wizard screen, use the space bar to select either a **Router** or **Conductor **role for the SSR node and press the **Enter** key to select **OK**. - ![128T Role](/img/intro_install_initializer_role.png) - -2. For routers, you will be prompted for the IP address(es) of your conductor(s). If you have conductors, Enter their administrative addresses here, and this node will retrieve its configuration from the conductor. If you have only one conductor (i.e., a standalone conductor), leave the field labeled 2nd Conductor Address blank. If you have no conductors, choose **Skip**. -3. When asked _What kind of Router node is this?_, select from the following options: - - ![Identify the Node](/img/intro_install_initializer_HASetup.png) - -- **Standalone:** This router has no highly available peer, and is not currently planned for high availability. -- **1st HA Node:** This router is the first node of a high availability pair. You will be prompted for the High Availability address of this node. Note: The address _must_ be reachable by the 2nd HA Node. -- **2nd HA Node:** This router is the second node of a high availability pair, where the first node has been initialized. You will be prompted for the High Availability address of the first node. - -4. Enter the following system properties on the Node Info screen: - - ![Node Information](/img/intro_install_initializer_nodeinfo.png) - -- **Node Name:** The unique name of the system within your Router or Conductor, for example _labsystem1_. By default this field uses the Linux system's hostname. - :::note - Both routers and conductors can consist of one node (for standalone systems) or two nodes (for highly available systems). - ::: -- **Router/Conductor Name:** The name of the Router or Conductor system as a whole. When referring to a running SSR software instance, it is identifiable by the full name of `nodeName.routerName`; e.g., `labsystem1.boston`. The full system name is reflected in the PCLI prompt as discussed in the Document Conventions section of this document. - -5. The **Advanced** button allows you to specify the number of CPU cores to be allocated for running your SSR routing software. - :::info - This is only recommended for experienced users. This setting is intended to optimize the forwarding capabilites of the SSR beyond the default settings for the target platform. - - The **Advanced** selection is only available when configuring a Router. - ::: - -6. On the **Password Setup** screen, create a password for the SSR Admin user. The administrator password must be at least 8 characters long, contain at least 1 uppercase letter, at least 1 lowercase letter, at least 1 number, and cannot repeat characters more than 3 times. - :::note - Resetting a password requires entering the old password. If a password is lost or forgotten and the account is inaccessible, the account cannot be recovered. Please keep password records accessible and secure. - ::: - - ![Password Setup](/img/intro_install_initializer_password.png) - -7. If presented with the **Anonymous Data Collection** screen, select either **Accept** or **Disable** to enable or disable the process that measures the health of your SSR router and components. - -8. Press the **Enter** key to select **OK**. The Initializer performs a hardware compatibility check. The compatibility check may fail due to warnings or failure notices, which are displayed in the output script. If no failures are present, you can choose to continue with the installation even if multiple warnings exist. For information on why a specific test may have failed or generated a warning, contact technical support. - -9. When prompted, either reboot your system or start SSR. - - ![Initializer Complete](/img/intro_install_initializer_complete.png) - - :::note - If installing the SSR software for the first time, a system reboot is required. - ::: - -### Verify Installation - -After installing the SSR Software it is important to verify that the installation was completed successfully. - -#### To Verify the SSR Installation: - -1. Launch a command prompt window. - -2. Execute the command: - - ``` - sudo systemctl status 128T - ``` - - **Result:** The service is listed as _Active (running)_. - - If the service is listed as _Inactive_, run the `sudo systemctl start 128T` command. This may take several minutes to fully launch the service. - -3. Once the service is listed as _Active_, log into the system as Admin using the system default password. - - **Result:** The installation is verified. - -4. Close the command prompt window. - diff --git a/sidebars.js b/sidebars.js index 40dadd5329..10b284a7e3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -56,9 +56,7 @@ module.exports = { "intro_rollback", ], "Supporting Install Information - Appendix": [ - "intro_installation_installer", "install_qcow2_deployment", - "legacy_OTP_install", ], "Concepts": [ "concepts_application_discovery",