Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 34 additions & 30 deletions docs/installation/systemd-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
This guide covers installing the pgEdge Control Plane on Linux hosts that use
the RPM Package Manager (RPM) package format (e.g., Red Hat Enterprise Linux
(RHEL), Rocky Linux, AlmaLinux) or the Debian (deb) package format (e.g.,
Ubuntu, Debian) using the package files attached to each
[GitHub release](https://github.com/pgedge/control-plane/releases).
Ubuntu, Debian). We recommend installing from the pgEdge Enterprise package
repositories; package files are also attached to each [GitHub
release](https://github.com/pgedge/control-plane/releases) for hosts without
repository access.

Unlike the Docker Swarm installation method, the system package installation
runs the Control Plane directly on the host. The Control Plane uses systemd to
Expand Down Expand Up @@ -83,18 +85,44 @@ sudo systemctl disable --now postgresql@${POSTGRES_MAJOR_VERSION}-main.service

## Installing the Control Plane

The pgEdge Control Plane packages are published with each release on the
[GitHub releases page](https://github.com/pgedge/control-plane/releases) for
both `amd64` and `arm64` architectures.
The pgEdge Control Plane packages are published for both `amd64` and `arm64`
architectures.

Every package will install the following files:

- The Control Plane binary is installed at `/usr/sbin/pgedge-control-plane`.
- The systemd service unit is installed at `/usr/lib/systemd/system/pgedge-control-plane.service`.
- The default configuration file is installed at `/etc/pgedge-control-plane/config.json`.

We recommend installing the Control Plane from the pgEdge Enterprise package
repositories you configured in the [Packages](#packages) section above. If you
don't have access to those repositories, see [Installing from GitHub
Releases](#installing-from-github-releases) below.
Comment thread
coderabbitai[bot] marked this conversation as resolved.

### RPM Package

Use the following command to install the Control Plane on RHEL-like hosts:

```sh
sudo dnf install -y pgedge-control-plane
```

### Deb Package

Use the following command to install the Control Plane on Debian-based hosts:

```sh
sudo apt install -y pgedge-control-plane
```

### Installing from GitHub Releases

If you don't have access to the pgEdge Enterprise package repositories, you can
download and install packages directly from the [GitHub releases
page](https://github.com/pgedge/control-plane/releases).

#### RPM Package

Use the following commands to download and install the RPM:

```sh
Expand All @@ -111,7 +139,7 @@ curl -LO "https://github.com/pgedge/control-plane/releases/download/${VERSION}/p
sudo rpm -i pgedge-control-plane_${VERSION#v}_linux_${ARCH}.rpm
```

### Deb Package
#### Deb Package

Use the following commands to download and install the deb package:

Expand Down Expand Up @@ -275,30 +303,6 @@ instructions.
> systemd clusters. As with other port fields, you can specify `0` to assign a
> random port.

### Deb Package

Use the following commands to download and install the deb package:

```sh
# (Optional) print the current version via the API
curl http://localhost:3000/v1/version

# Detect architecture
ARCH=$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/')

# Set the new version to install
VERSION="v0.9.0"

# Download the deb package
curl -LO --output-dir /tmp "https://github.com/pgedge/control-plane/releases/download/${VERSION}/pgedge-control-plane_${VERSION#v}_linux_${ARCH}.deb"

# Install the deb package
sudo apt install /tmp/pgedge-control-plane_${VERSION#v}_linux_${ARCH}.deb

# (Optional) print the updated version via the API
curl http://localhost:3000/v1/version
```

## Uninstalling the Control Plane

This section describes how to fully remove the Control Plane and its data from
Expand Down
41 changes: 39 additions & 2 deletions docs/installation/systemd-upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,46 @@ automatically restart the Control Plane service after the update is complete.
> The package upgrade will preserve any modifications to the configuration file
> at `/etc/pgedge-control-plane/config.json`.

We recommend updating the Control Plane using the pgEdge Enterprise package
repositories you configured in the [Packages](systemd-installation.md#packages)
section. If you installed the Control Plane manually, see [Updating from
GitHub Releases](#updating-from-github-releases) below.

## Updating the Control Plane

### RPM Package
Comment thread
coderabbitai[bot] marked this conversation as resolved.

```sh
# (Optional) print the current version via the API
curl http://localhost:3000/v1/version

# Upgrade the package
sudo dnf upgrade -y pgedge-control-plane

# (Optional) print the updated version via the API
curl http://localhost:3000/v1/version
```

### Deb Package

```sh
# (Optional) print the current version via the API
curl http://localhost:3000/v1/version

# Upgrade the package
sudo apt install --only-upgrade -y pgedge-control-plane

# (Optional) print the updated version via the API
curl http://localhost:3000/v1/version
```

### Updating from GitHub Releases

If you installed the Control Plane manually from GitHub releases, download and
install the updated package version.

#### RPM Package

Use the following commands to download and install the updated RPM:

```sh
Expand All @@ -30,8 +68,7 @@ sudo rpm -U pgedge-control-plane_${VERSION#v}_linux_${ARCH}.rpm
curl http://localhost:3000/v1/version
```


### Deb Package
#### Deb Package

Use the following commands to download and install the deb package:

Expand Down