ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 03:35:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

v1.3.0 install/upgrade (draft done?)

Browse Source
This commit is contained in:
mDuo13
2019-07-01 16:43:21 -07:00
parent 1d90706a62
commit c56a8e1869
5 changed files with 73 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
content/tutorials/manage-the-rippled-server/installation/install-rippled-on-centos-rhel-with-yum.md
View File

@@ -14,17 +14,35 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
1. Install the Ripple RPM repository:
$ sudo rpm -Uvh https://mirrors.ripple.com/ripple-repo-el7.rpm
$ cat << REPOFILE | sudo tee /etc/yum.repos.d/ripple.repo
[ripple-stable]
name=XRP Ledger Packages
baseurl=https://repos.ripple.com/repos/rippled-rpm/stable/
enabled=1
gpgcheck=0
gpgkey=https://repos.ripple.com/repos/rippled-rpm/stable/repodata/repomd.xml.key
repo_gpgcheck=1
REPOFILE
2. Install the `rippled` software package:
2. Fetch the latest repo updates:
$ sudo yum install --enablerepo=ripple-stable rippled
$ sudo yum -y update
3. Configure the `rippled` service to start on system boot:
3. Install the new `rippled` package:
$ sudo yum install rippled
Version 1.3.0 does not require any changes to your configuration files (`rippled.cfg` and `validators.txt`). This update procedure leaves your existing config files in place.
4. Reload systemd unit files:
$ sudo systemctl daemon-reload
5. Configure the `rippled` service to start on boot:
$ sudo systemctl enable rippled.service
4. Start the `rippled` service
6. Start the `rippled` service:
$ sudo systemctl start rippled.service
@@ -35,7 +53,8 @@ Before you install `rippled`, you must meet the [System Requirements](system-req
## See Also
- [Update Automatically on CentOS/Red Hat](update-rippled-automatically-on-centos-rhel.html)
- [Install rippled on Ubuntu Linux](install-rippled-on-ubuntu-with-alien.html) (Pre-built binary on Ubuntu)
- [Update Automatically on Linux](update-rippled-automatically-on-linux.html)
- [Install rippled on Ubuntu Linux](install-rippled-on-ubuntu.html) (Pre-built binary for Ubuntu or Debian)
- [Build and Run `rippled` on Ubuntu](build-run-rippled-ubuntu.html) (Compile `rippled` yourself on Ubuntu)
- [Build and Run `rippled` on macOS](build-run-rippled-macos.html) (Compile `rippled` yourself on macOS)
- [Compilation instructions for other platforms](https://github.com/ripple/rippled/tree/develop/Builds)

55
content/tutorials/manage-the-rippled-server/installation/rippled-1-3-0-migration-instructions.md
View File

@@ -9,9 +9,8 @@ This document provides migration steps for upgrading on supported platforms:
For other platforms, see the updated instructions for compiling from source. ([Ubuntu](build-run-rippled-ubuntu.html), [macOS](build-run-rippled-macos.html), or [Windows](https://github.com/ripple/rippled/tree/develop/Builds/VisualStudio2017))
# Migration on CentOS or Red Hat Enterprise Linux (RHEL)
***TODO: Test. Might be same as manual install steps***
## Migration on CentOS or Red Hat Enterprise Linux (RHEL)
Ripple's official RPM repository and instructions for using it have changed. To migrate from the old repository to the new one, complete the following steps:
@@ -19,45 +18,41 @@ Ripple's official RPM repository and instructions for using it have changed. To
$ sudo systemctl stop rippled.service
2. Back up your configuration files.
2. Replace Ripple's old yum repo file with the new one:
Copy your configuration files to a temporary directory. For example:
$ cat << REPOFILE | sudo tee /etc/yum.repos.d/ripple.repo
[ripple-stable]
name=XRP Ledger Packages
baseurl=https://repos.ripple.com/repos/rippled-rpm/stable/
enabled=1
gpgcheck=0
gpgkey=https://repos.ripple.com/repos/rippled-rpm/stable/repodata/repomd.xml.key
repo_gpgcheck=1
REPOFILE
$ mkdir ~/rippled_config_backup
$ cp /opt/ripple/etc/rippled.cfg ~/rippled_config_backup
$ cp /opt/ripple/etc/validators.txt ~/rippled_config_backup
3. Fetch the latest repo updates:
You may need to adjust the paths to the `rippled.cfg` and `validators.txt` files to match your configuration.
$ sudo yum -y update
3. Back up your data files.
4. Install the new `rippled` package:
Copy your rippled server's database files to a temporary directory. For example:
$ sudo yum install rippled
$ mkdir ~/rippled_data_backup
$ cp -r /var/lib/rippled/db/ ~/rippled_data_backup
Version 1.3.0 does not require any changes to your configuration files (`rippled.cfg` and `validators.txt`). This update procedure leaves your existing config files in place.
You may need to adjust the path to your database files to match your configuration. You should be sure to copy all database files, including SQLite databases (`.sqlite` and `.db` files), NuDB or RocksDB files for the [ledger store](ledger-history.html), and the [shard store](history-sharding.html) if you have history sharding enabled.
5. Reload systemd unit files:
This process may take a long time, depending on how much data you have stored.
$ sudo systemctl daemon-reload
**Caution:** You can choose to skip this step if you do not need the ledger history data. Your server can download the necessary amount of ledger data from the peer-to-peer network after it comes back online. Validators and simple stock servers do not need large amounts of historical data to keep up with the progress of the XRP Ledger.
6. Start the `rippled` service:
4. Update the
***TODO: instructions per https://github.com/ripple/ripple-dev-portal/issues/544***
Roughly:
- stop rippled
- backup data & config
- uninstall package w/ `rpm -e` or `yum remove`
- install 1.3 the standard way
- stop rippled
- restore config & data files
- start rippled, check status
$ sudo systemctl start rippled.service
# Migration on Ubuntu Linux
**Tip:** If you had [automatic updates](update-rippled-automatically-on-linux.html) enabled before 1.3.0, they should continue working after performing this migration process.
## Migration on Ubuntu Linux
Prior to version 1.3.0, the supported way to install `rippled` on Ubuntu Linux was using Alien to install the RPM package. Starting with `rippled` v1.3.0, Ripple provides a native package for Ubuntu and Debian Linux, which is the recommended way of installing it. If you already have the RPM package installed, complete the [installation steps](install-rippled-on-ubuntu.html) to upgrade the package and switch over to the native APT (`.deb`) package.
@@ -74,6 +69,6 @@ After installing the new package, if you no longer need Alien for any other pack
$ sudo apt -y autoremove
## Automatic Updates
### Automatic Updates
The `rippled` v1.3.0 package includes an updated auto-update script that works on Ubuntu and Debian Linux. For more information, see [Update `rippled` Automatically on Linux](update-rippled-automatically-on-linux.html).

10
content/tutorials/manage-the-rippled-server/installation/update-rippled-automatically-on-linux.md
View File

@@ -2,14 +2,16 @@
On Linux, you can set up `rippled` to automatically upgrade to the latest version with a one-time `cron` configuration. Ripple recommends enabling automatic updates if possible.
These instructions assume you have already installed `rippled` [from the `yum` repository (CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.html) or [using `apt`(Ubuntu/Debian)](install-rippled-on-ubuntu.html).
These instructions assume you have already installed `rippled` [from the `yum` repository (CentOS/RedHat)](install-rippled-on-centos-rhel-with-yum.html) or [using `apt` (Ubuntu/Debian)](install-rippled-on-ubuntu.html).
**Warning:** The install and upgrade process for for `rippled` 1.3.0 has changed. If you have `rippled` v1.2.4 or lower installed, follow the [rippled 1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html)
**Warning:** As of version 1.3.0, the install and upgrade process has changed. Automatic updates **will not** upgrade to `rippled` 1.3.0. If you have `rippled` v1.2.4 or lower installed, follow the [rippled 1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html) first. After performing the migration, automatic updates should work again.
To set up automatic updates, complete the following steps:
1. Check that `/opt/ripple/etc/update-rippled-cron` exists. If it does not, update manually ([CentOS/Red Hat](update-rippled-manually-on-centos-rhel.html) or [Ubuntu/Debian](update-rippled-manually-on-ubuntu.html)).
2. Create a symlink in your `cron.d` folder
2. Create a symlink in your `cron.d` folder to the `/opt/ripple/etc/update-rippled-cron` config file:
The script updates the installed `rippled` package within an hour of each new release. To reduce the chance of outages from all servers updating simultaneously, the script delays the update for a random number of minutes, up to 59.
$ sudo ln -s /opt/ripple/etc/update-rippled-cron /etc/cron.d/
This cron configuration runs a script to update installed `rippled` package within an hour of each new release. To reduce the chance of outages from all servers updating simultaneously, the script delays the update for a random number of minutes, up to 59.

16
content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-centos-rhel.md
View File

@@ -1,25 +1,19 @@
# Update Manually on CentOS/Red Hat
***TODO: update for 1.3.0***
This page describes how to update manually to the latest release of `rippled` on CentOS or Red Hat Enterprise Linux. Ripple recommends setting up [automatic updates](update-rippled-automatically-on-centos-rhel.html) instead, where possible.
This page describes how to update manually to the latest release of `rippled` on CentOS or Red Hat Enterprise Linux. Ripple recommends setting up [automatic updates](update-rippled-automatically-on-linux.html) instead, where possible.
These instructions assume you have already [installed `rippled` from the `yum` repository](install-rippled-on-centos-rhel-with-yum.html).
To update manually, complete the following steps:
1. Update the package list from Ripple's yum repository:
1. Download and install the latest `rippled` package:
$ sudo rpm -Uvh --replacepkgs https://mirrors.ripple.com/ripple-repo-el7.rpm
$ sudo yum update rippled
2. Download and install the latest `rippled` package:
$ sudo yum update --enablerepo=ripple-stable rippled
3. Reload the `systemd` unit files:
2. Reload the `systemd` unit files:
$ sudo systemctl daemon-reload
4. Restart the `rippled` service:
3. Restart the `rippled` service:
$ sudo service rippled restart

34
content/tutorials/manage-the-rippled-server/installation/update-rippled-manually-on-ubuntu.md
View File

@@ -1,37 +1,25 @@
# Update Manually on Ubuntu
# Update Manually on Ubuntu or Debian
***TODO: Update for 1.3.0***
This page describes how to update manually to the latest release of `rippled` on Ubuntu Linux. These instructions assume you have already [installed `rippled` using the native package](install-rippled-on-ubuntu.html). Ripple recommends setting up [automatic updates](update-rippled-automatically-on-linux.html) instead, where possible.
This page describes how to update manually to the latest release of `rippled` on Ubuntu Linux. These instructions assume you have already [installed `rippled` using Alien](install-rippled-on-ubuntu-with-alien.html).
**Caution:** To upgrade from `rippled` 1.2.x to 1.3.0 or higher on Ubuntu Linux, you should follow the [1.3.0 migration instructions](rippled-1-3-0-migration-instructions.html). The following instructions assume you have already installed the native APT package provided with versions 1.3.0 and up.
**Tip:** To perform these steps all at once, you can run the `/opt/ripple/bin/update-rippled.sh` script, which is included with the `rippled` package and is compatible with Ubuntu and Debian start with `rippled` version 1.3.0.
To update manually, complete the following steps:
1. Update the package list from Ripple's yum repository:
1. Update apt repositories:
$ sudo rpm -Uvh --replacepkgs https://mirrors.ripple.com/ripple-repo-el7.rpm
$ sudo apt -y update
2. Download the latest `rippled` package:
2. Upgrade the `rippled` package:
$ yumdownloader --enablerepo=ripple-stable --releasever=el7 rippled
$ sudo apt -y upgrade rippled
3. Verify the signatures on the downloaded packages:
$ rpm -K rippled*.rpm
4. Use Alien to upgrade to the new `rippled` package:
$ sudo alien -i --scripts rippled*.rpm
5. Reload the `systemd` unit files:
3. Reload the `systemd` unit files:
$ sudo systemctl daemon-reload
6. Restart the `rippled` service:
4. Restart the `rippled` service:
$ sudo service rippled restart
7. Delete the downloaded `rippled` package file:
$ rm rippled*.rpm
(This does not affect the installation, but prevents later updates from trying to re-install the old version.)