Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #448: Document MetricsHub Enterprise upgrade procedure #449

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
19 changes: 19 additions & 0 deletions metricshub-doc/src/site/markdown/installation/debian-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,25 @@ To uninstall **MetricsHub Enterprise**, run the command below:
sudo dpkg -r metricshub
```

### Upgrade

If you have installed a previous version of **MetricsHub Enterprise** and want to upgrade to the latest version **${enterpriseVersion}**, follow these steps:

1. From [MetricsHub's Web site](https://metricshub.com/downloads), download **metricshub-enterprise-debian-${enterpriseVersion}-amd64.deb** and copy the file into the `/usr/local` directory.

2. Run the following command to stop the **MetricsHub Enterprise** service:

```shell-session
systemctl stop metricshub-enterprise-service
```

3. Run the following `dpkg` command:

```shell-session
cd /usr/local
sudo dpkg -i metricshub-enterprise-debian-${enterpriseVersion}-amd64.deb
```

## Community Edition

### Download
Expand Down
46 changes: 46 additions & 0 deletions metricshub-doc/src/site/markdown/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Then, build the docker image using the following command:
cd /docker/metricshub
sudo docker build -t metricshub:latest .
```

### Configure

* In the **./lib/config/metricshub.yaml** file, located under the `/docker/metricshub` installation directory, configure the [resources to be monitored](../configuration/configure-monitoring.html#configure-resources).
Expand Down Expand Up @@ -75,6 +76,51 @@ services:
restart: unless-stopped
```

### Upgrade

If you have installed a previous version of **MetricsHub Enterprise** and want to upgrade to the latest version **${enterpriseVersion}**, follow these steps:

1. From [MetricsHub's website](https://metricshub.com/downloads), download **metricshub-enterprise-debian-${enterpriseVersion}-docker.tar.gz** and copy it into the `/tmp` directory.

2. Stop and remove the currently running **MetricsHub** container:

```shell-session
sudo docker stop metricshub
sudo docker rm metricshub
```

3. Before upgrading, rename the current **metricshub** directory to **metricshub-previous** to backup your configuration files and preserve any custom settings. Ensure that there isn't already a directory named **metricshub-previous**; if there is, you may need to choose a different name:

```shell-session
sudo mv /docker/metricshub /docker/metricshub-previous
```

4. Unzip the new version into the same directory where the previous version was installed:

```shell-session
sudo tar xzf /tmp/metricshub-enterprise-debian-${enterpriseVersion}-docker.tar.gz -C /docker
```

5. Rebuild the **MetricsHub** Docker image with the latest version:

```shell-session
cd /docker/metricshub
sudo docker build -t metricshub:latest .
```

6. Restore the configuration files to the correct locations:

```shell-session
sudo cp /docker/metricshub-previous/lib/config/metricshub.yaml /docker/metricshub/lib/config/metricshub.yaml
sudo cp /docker/metricshub-previous/lib/otel/otel-config.yaml /docker/metricshub/lib/otel/otel-config.yaml
```

7. Start the **MetricsHub** container using the upgraded image:

```shell-session
sudo docker run -d --name=metricshub -p 24375:24375 -p 13133:13133 -v /docker/metricshub/lib/config:/opt/metricshub/lib/config -v /docker/metricshub/lib/otel:/opt/metricshub/lib/otel -v /docker/metricshub/lib/logs:/opt/metricshub/lib/logs -v /docker/metricshub/lib/security:/opt/metricshub/lib/security metricshub:latest
```

## Community Edition

### Download
Expand Down
19 changes: 19 additions & 0 deletions metricshub-doc/src/site/markdown/installation/redhat-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,25 @@ To uninstall **MetricsHub Enterprise**, run the command below:
sudo rpm -e metricshub-${enterpriseVersion}-1.x86_64
```

### Upgrade

If you have installed a previous version of **MetricsHub Enterprise** and want to upgrade to the latest version **${enterpriseVersion}**, follow these steps:

1. From [MetricsHub's Web site](https://metricshub.com/downloads), download **metricshub-enterprise-rhel-${enterpriseVersion}-1.x86_64.rpm** and copy the file into the `/usr/local` directory.

2. Run the following command to stop the **MetricsHub Enterprise** service:

```shell-session
systemctl stop metricshub-enterprise-service
```

3. Run the following `rpm` command:

```shell-session
cd /usr/local
sudo rpm -U metricshub-enterprise-rhel-${enterpriseVersion}-1.x86_64.rpm
```

## Community Edition

### Download
Expand Down
8 changes: 8 additions & 0 deletions metricshub-doc/src/site/markdown/installation/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,14 @@ To start the **MetricsHub Enterprise** service, open **services.msc** and start

To uninstall **MetricsHub Enterprise**, double-click the **metricshub-enterprise-windows-${enterpriseVersion}.msi** file and click **Remove** when prompted.

### Upgrade

If you have installed a previous version of **MetricsHub Enterprise** and want to upgrade to the latest version **${enterpriseVersion}**, follow these steps:

1. From [MetricsHub's Web site](https://metricshub.com/downloads), download **metricshub-enterprise-windows-${enterpriseVersion}.msi**.
2. Open **services.msc** and stop the **MetricsHub Enterprise** service.
3. Double-click the `.msi` file you previously downloaded. The Installation Wizard will automatically start and guide you through the upgrade process.

## Community Edition

### Download
Expand Down