Skip to content

Commit

Permalink
Added a separate page for installing on AL2023 (#977)
Browse files Browse the repository at this point in the history
new file:   docs/install/amazon-linux.md
	modified:   docs/install/yum.md
	modified:   mkdocs-base.yml
	new file:   snippets/yum-install.md
  • Loading branch information
nastena1606 authored Feb 19, 2025
1 parent cbc4f08 commit ece8e90
Show file tree
Hide file tree
Showing 4 changed files with 183 additions and 118 deletions.
37 changes: 37 additions & 0 deletions docs/install/amazon-linux.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Install Percona Server for MongoDB on Amazon Linux 2023

This guide walks you through the installation of Percona Server for MongoDB on Amazon Linux 2023.

We gather [Telemetry data](../telemetry.md) to understand the use of the software and improve our products.

--8<-- "yum-install.md:1:48"

=== ":octicons-number-16: Install a specific version"

To install a specific version of *Percona Server for MongoDB*, do the following:

1. List available versions:

```{.bash data-prompt="$"}
$ sudo yum list percona-server-mongodb --showduplicates
```

Sample output:

```{.bash .no-copy}
Available Packages
percona-server-mongodb.aarch64 {{release}}.amzn2023 psmdb-80-release-aarch64
```

2. Install a specific version packages. For example, to install *Percona Server for MongoDB* {{release}}, run the following command:

```{.bash data-prompt="$"}
$ sudo yum install percona-server-mongodb-{{release}}.amzn2023
```

--8<-- "yum-install.md:74:140"

## Next steps

[Connect to MongoDB :material-arrow-right:](../connect.md){.md-button}
119 changes: 3 additions & 116 deletions docs/install/yum.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,56 +4,9 @@ This document describes how to install Percona Server for MongoDB on RPM-based d

!!! note

Percona Server for MongoDB should work on other RPM-based distributions (for example, Amazon Linux AMI and Oracle Linux), but it is tested only on platforms listed on the [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mongodb) page.
Percona Server for MongoDB should work on other RPM-based distributions (for example, Oracle Linux), but it is tested only on platforms listed on the [Percona Software and Platform Lifecycle](https://www.percona.com/services/policies/percona-software-platform-lifecycle#mongodb) page.

??? admonition "Package contents"

| Package | Contains |
| ----------------------- | -----------------------------------------|
| `percona-server-mongodb`| The `mongosh` shell, import/export tools, other client utilities, server software, default configuration, and `init.d` scripts. |
| `percona-server-mongodb-server`| The `mongod` server, default configuration files, and `init.d` scripts|
| `percona-server-mongodb-shell` | The `mongosh` shell |
| `percona-server-mongodb-mongos`| The `mongos` sharded cluster query router |
| `percona-server-mongodb-tools` | Mongo tools for high-performance MongoDB fork from Percona|
| `percona-server-mongodb-dbg` | Debug symbols for the server |

## Procedure

Before you start, check the [system requirements](../system-requirements.md).

### Configure Percona repository

Percona provides the [`percona-release`](https://docs.percona.com/percona-software-repositories/index.html) configuration tool that simplifies operating repositories and enables to install and update both Percona Server for MongoDB packages and required dependencies smoothly.

1. Install **percona-release**:

```{.bash data-prompt="$"}
$ sudo yum install https://repo.percona.com/yum/percona-release-latest.noarch.rpm
```

??? example "Example output"

```{.bash .no-copy }
Retrieving https://repo.percona.com/yum/percona-release-latest.noarch.rpm
Preparing... ########################################### [100%]
1:percona-release ########################################### [100%]
```

2. Enable the repository:

```{.bash data-prompt="$"}
$ sudo percona-release enable psmdb-80 release
```

### Install Percona Server for MongoDB packages

=== ":material-run-fast: Install the latest version"

To install the latest version of *Percona Server for MongoDB*, use the following command:

```{.bash data-prompt="$"}
$ sudo yum install percona-server-mongodb
```
--8<-- "yum-install.md:1:48"

=== ":octicons-number-16: Install a specific version"

Expand All @@ -79,73 +32,7 @@ Percona provides the [`percona-release`](https://docs.percona.com/percona-softwa
$ sudo yum install percona-server-mongodb-{{release}}.el9
```

By default, Percona Server for MongoDB stores data files in `/var/lib/mongodb/`
and configuration parameters in `/etc/mongod.conf`.

## Enable Transparent Hugepages (THP)

Enable Transparent Hugepages (THP) before starting Percona Server for MongoDB 8.0. THP is required to use the new TCMalloc version with MongoDB. For how to enable THP, see [Enable Transparent Hugepages (THP)](https://www.mongodb.com/docs/upcoming/administration/tcmalloc-performance/#enable-transparent-hugepages--thp-) section of documentation.

## Run Percona Server for MongoDB

!!! note

If you use SELinux in enforcing mode, you must customize your SELinux user policies to allow access to certain `/sys` and `/proc` files for OS-level statistics. Also, you must customize directory and port access policies if you are using non-default locations.

Please refer to [Configure SELinux](https://docs.mongodb.com/v8.0/tutorial/install-mongodb-on-red-hat/#configure-selinux) section of MongoDB Documentation for policy configuration guidelines.

By default, Percona Server for MongoDB stores data files in `/var/lib/mongodb/`
and configuration parameters in `/etc/mongod.conf`.

**Start the service**

Percona Server for MongoDB is not started automatically after installation.
Start it manually using the following command:

```{.bash data-prompt="$"}
$ sudo systemctl start mongod
```

**Confirm that service is running**

Check the service status using the following command: `service mongod status`

```{.bash data-prompt="$"}
$ sudo systemctl status mongod
```

**Stop the service**

Stop the service using the following command: `service mongod stop`

```{.bash data-prompt="$"}
$ sudo systemctl stop mongod
```

**Restart the service**

Restart the service using the following command: `service mongod restart`

```{.bash data-prompt="$"}
$ sudo systemctl restart mongod
```

### Run after reboot

The `mongod` service is not automatically started
after you reboot the system.

To make it start automatically after reboot, enable it using the systemctl utility:

```{.bash data-prompt="$"}
$ sudo systemctl enable mongod
```

Then start the `mongod` service:

```{.bash data-prompt="$"}
$ sudo systemctl start mongod
```
--8<-- "yum-install.md:74:140"

## Next steps

Expand Down
5 changes: 3 additions & 2 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ markdown_extensions:
pymdownx.inlinehilite: {}
pymdownx.snippets:
base_path: ["snippets"]
auto_append:
- services-banner.md
# auto_append:
# - services-banner.md
pymdownx.tasklist:
custom_checkbox: true
pymdownx.emoji:
Expand Down Expand Up @@ -172,6 +172,7 @@ nav:
- 'System requirements': 'system-requirements.md'
- "On Debian and Ubuntu": install/apt.md
- "On RHEL and derivatives": install/yum.md
- "On Amazon Linux 2023": install/amazon-linux.md
- "From tarballs": install/tarball.md
- install/source.md
- "Run in Docker": install/docker.md
Expand Down
140 changes: 140 additions & 0 deletions snippets/yum-install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
??? admonition "Package contents"

| Package | Contains |
| ----------------------- | -----------------------------------------|
| `percona-server-mongodb`| The `mongosh` shell, import/export tools, other client utilities, server software, default configuration, and `init.d` scripts. |
| `percona-server-mongodb-server`| The `mongod` server, default configuration files, and `init.d` scripts|
| `percona-server-mongodb-shell` | The `mongosh` shell |
| `percona-server-mongodb-mongos`| The `mongos` sharded cluster query router |
| `percona-server-mongodb-tools` | Mongo tools for high-performance MongoDB fork from Percona|
| `percona-server-mongodb-dbg` | Debug symbols for the server|

## Procedure

Before you start, check the [system requirements](../system-requirements.md).

### Configure Percona repository

Percona provides the [`percona-release`](https://docs.percona.com/percona-software-repositories/index.html) configuration tool that simplifies operating repositories and enables to install and update both Percona Server for MongoDB packages and required dependencies smoothly.

1. Install **percona-release**:

```{.bash data-prompt="$"}
$ sudo yum install https://repo.percona.com/yum/percona-release-latest.noarch.rpm
```

??? example "Example output"

```{.bash .no-copy }
Retrieving https://repo.percona.com/yum/percona-release-latest.noarch.rpm
Preparing... ########################################### [100%]
1:percona-release ########################################### [100%]
```

2. Enable the repository:

```{.bash data-prompt="$"}
$ sudo percona-release enable psmdb-80 release
```

### Install Percona Server for MongoDB packages

=== ":material-run-fast: Install the latest version"

To install the latest version of *Percona Server for MongoDB*, use the following command:

```{.bash data-prompt="$"}
$ sudo yum install percona-server-mongodb
```

=== ":octicons-number-16: Install a specific version"

To install a specific version of *Percona Server for MongoDB*, do the following:

1. List available versions:

```{.bash data-prompt="$"}
$ sudo yum list percona-server-mongodb --showduplicates
```

Sample output:

```{.bash .no-copy}
Available Packages
percona-server-mongodb.x86_64 {{release}}.el9 psmdb-80-release-x86_64
```

2. Install a specific version packages. For example, to install *Percona Server for MongoDB* {{release}}, run the following command:

```{.bash data-prompt="$"}
$ sudo yum install percona-server-mongodb-{{release}}.el9
```

By default, Percona Server for MongoDB stores data files in `/var/lib/mongodb/`
and configuration parameters in `/etc/mongod.conf`.

## Enable Transparent Hugepages (THP)

Enable Transparent Hugepages (THP) before starting Percona Server for MongoDB 8.0. THP is required to use the new TCMalloc version with MongoDB. For how to enable THP, see [Enable Transparent Hugepages (THP)](https://www.mongodb.com/docs/upcoming/administration/tcmalloc-performance/#enable-transparent-hugepages--thp-) section of documentation.

## Run Percona Server for MongoDB

!!! note

If you use SELinux in enforcing mode, you must customize your SELinux user policies to allow access to certain `/sys` and `/proc` files for OS-level statistics. Also, you must customize directory and port access policies if you are using non-default locations.

Please refer to [Configure SELinux](https://docs.mongodb.com/v8.0/tutorial/install-mongodb-on-red-hat/#configure-selinux) section of MongoDB Documentation for policy configuration guidelines.

By default, Percona Server for MongoDB stores data files in `/var/lib/mongodb/`
and configuration parameters in `/etc/mongod.conf`.

**Start the service**

Percona Server for MongoDB is not started automatically after installation.
Start it manually using the following command:

```{.bash data-prompt="$"}
$ sudo systemctl start mongod
```

**Confirm that the service is running**

Check the service status using the following command:

```{.bash data-prompt="$"}
$ sudo systemctl status mongod
```

**Stop the service**

Stop the service using the following command:

```{.bash data-prompt="$"}
$ sudo systemctl stop mongod
```

**Restart the service**

Restart the service using the following command:

```{.bash data-prompt="$"}
$ sudo systemctl restart mongod
```

### Run after reboot

The `mongod` service is not automatically started
after you reboot the system.

To make it start automatically after reboot, enable it using the systemctl utility:

```{.bash data-prompt="$"}
$ sudo systemctl enable mongod
```

Then start the `mongod` service:

```{.bash data-prompt="$"}
$ sudo systemctl start mongod
```

0 comments on commit ece8e90

Please sign in to comment.