Skip to content
Open
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
2 changes: 1 addition & 1 deletion docs/config/_default/menus.toml
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@
[[preview_integrations]]
name = "Drivers and ORMs"
weight = 3
url = "/preview/drivers-orms/"
url = "/preview/develop/drivers-orms/"
[preview_integrations.params]
showSection = true

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ $ ulimit -n <value>

{{< note title="Restart servers" >}}

After changing a ulimit setting, the YB-Master and YB-TServer servers must be restarted in order for the new settings to take effect. Check the [yb-tserver.INFO](../start-masters/#verify-tserver-health) file to verify that the ulimits are applied. You can also check the `/proc/<process pid>` file to see the current settings.
If you change a ulimit setting on a node where the YB-Master and YB-TServer servers are already running, you must restart the servers for the new settings to take effect. Check the [yb-tserver.INFO](../start-masters/#verify-tserver-health) file to verify that the ulimits are applied. You can also check the `/proc/<process pid>` file to see the current settings.

{{< /note >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ On Red Hat Enterprise Linux 8-based systems (Red Hat Enterprise Linux 8, Oracle
DefaultLimitNOFILE=1048576
```

You must reboot the system for these two settings to take effect.
_You must reboot the system for these two settings to take effect._

#### Transparent hugepages

Expand All @@ -48,7 +48,7 @@ Transparent hugepages (THP) should be enabled for optimal performance. Download

- [install-yb-enable-transparent-huge-pages-service.sh](/files/install-yb-enable-transparent-huge-pages-service.sh)

You must reboot the system for these settings to take effect.
_You must reboot the system for these settings to take effect._

<details>
<summary>More information</summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ For each node VM, perform the following:
- [Install systemd-related database service unit files](#install-systemd-related-database-service-unit-files)
- [Install the node agent](#install-node-agent)

After you have provisioned the nodes, you can proceed to [Add instances to the on-prem provider](../../../configure-yugabyte-platform/on-premises-nodes/#add-instances).
After you have provisioned the VM, reboot the system.

You can then proceed to [Add the instance to the on-prem provider](../../../configure-yugabyte-platform/on-premises-nodes/#add-instances).

{{<note title="Root-level systemd or cron">}}
The following instructions use user-level systemd to provide the necessary access to system resources. Versions prior to v2.20 use root-level systemd or cron. If you have previously provisioned nodes for this provider using either root-level systemd or cron, you should use the same steps, as all nodes in a provider need to be provisioned in the same way. For instructions on provisioning using root-level systemd or cron, see the [instructions for v2.18](https://docs-archive.yugabyte.com/v2.18/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/on-premises-manual/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,14 @@ rightNav:

When deploying universes using an on-premises provider, YugabyteDB Anywhere relies on you to manually create the VMs for the database nodes and provide these pre-created VMs to YugabyteDB Anywhere.

With the on-premises provider, you must provide one, three, five, or more VM(s) with the following installed:
## Prerequisites

- [Supported Linux OS](../#linux-os)
- [Additional software](../#additional-software)
- If you are not connected to the Internet, [additional software for airgapped](../#additional-software-for-airgapped-deployment)
- Provide one, three, five, or more VM(s) with the following installed:
- [Supported Linux OS](../#linux-os)
- [Additional software](../#additional-software)
- If you are not connected to the Internet, [additional software for airgapped](../#additional-software-for-airgapped-deployment)

- YugabyteDB Anywhere is [installed and running](../../../install-yugabyte-platform/).

## How to prepare the nodes for use in a database cluster

Expand All @@ -30,7 +33,7 @@ After you have created the VMs with the operating system and additional software
1. Modify the configuration file.
1. Run the provisioning script (as root or via sudo).

These steps prepare the node for use by YugabyteDB Anywhere. If you have already [installed YugabyteDB Anywhere](../../../install-yugabyte-platform/) and it is running (recommended), the script additionally creates (or updates) an [on-premises provider](../../../configure-yugabyte-platform/on-premises/) with the node already added.
These steps prepare the node for use by YugabyteDB Anywhere, including setting ulimits and transparent hugepages. If you have already [installed YugabyteDB Anywhere](../../../install-yugabyte-platform/) and it is running (recommended), the script additionally creates (or updates) an [on-premises provider](../../../configure-yugabyte-platform/on-premises/) with the node already added.

Root or sudo privileges are only required to provision the nodes. After the node is provisioned (with [YugabyteDB Anywhere node agent](/preview/faq/yugabyte-platform/#what-is-a-node-agent) installed), sudo is no longer required.

Expand Down Expand Up @@ -95,7 +98,7 @@ Configure data directories or mount points for the node (typically `/data`). If

Edit the `node-agent-provision.yaml` file in the scripts directory.

Set the following options in the provisioning file to the correct values:
The following table describes options that are changed for a typical installation. The file is commented; you can [review the file](https://github.com/yugabyte/yugabyte-db/blob/{{< yb-version version="preview" format="short">}}/managed/node-agent/resources/node-agent-provision.yaml) and its default settings on GitHub.

| Option | Value |
| :--- | :--- |
Expand Down Expand Up @@ -148,9 +151,11 @@ sudo ./node-agent-provision.sh

The script provisions the node and installs node agent, and then runs preflight checks to ensure the node is ready for use.

If specified, node agent creates the on-premises provider configuration; or, if the provider already exists, adds the instance to the provider.
If specified, node agent also creates the on-premises provider configuration; or, if the provider configuration already exists, adds the instance to the provider.

After the node is provisioned, reboot the node.

After the node is provisioned, YugabyteDB Anywhere does not need sudo access to the node.
If the preflight check fails, rebooting the node may solve some issues (for example, incorrect ulimit settings).

#### Preflight check

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,18 @@ tls:

When configured, YugabyteDB Anywhere sets the common name to the name of the service created for the pod, and adds common name to the certificate request sent to cert-manager.

### Configurable common names

You can configure a custom common name suffix for cert-manager certificates using the following helm override:

```yml
tls:
certManager:
certificates:
commonNameRequired: true
commonNameSuffix: "yugabyte.com"
```

## Troubleshoot

If you encounter problems, you should verify the name of Issuer or ClusterIssuer in the Kubernetes cluster, as well as ensure that the Kubernetes cluster is in Ready state. You can use the following commands:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ $ ulimit -n <value>

{{< note title="Restart servers" >}}

After changing a ulimit setting, the YB-Master and YB-TServer servers must be restarted in order for the new settings to take effect. Check the [yb-tserver.INFO](../start-masters/#verify-tserver-health) file to verify that the ulimits are applied. You can also check the `/proc/<process pid>` file to see the current settings.
If you change a ulimit setting on a node where the YB-Master and YB-TServer servers are already running, you must restart the servers for the new settings to take effect. Check the [yb-tserver.INFO](../start-masters/#verify-tserver-health) file to verify that the ulimits are applied. You can also check the `/proc/<process pid>` file to see the current settings.

{{< /note >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ On Red Hat Enterprise Linux 8-based systems (Red Hat Enterprise Linux 8, Oracle
DefaultLimitNOFILE=1048576
```

You must reboot the system for these two settings to take effect.
_You must reboot the system for these two settings to take effect._

#### Transparent hugepages

Expand All @@ -45,7 +45,7 @@ Transparent hugepages (THP) should be enabled for optimal performance. Download

- [install-yb-enable-transparent-huge-pages-service.sh](/files/install-yb-enable-transparent-huge-pages-service.sh)

You must reboot the system for these settings to take effect.
_You must reboot the system for these settings to take effect._

<details>
<summary>More information</summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ For each node VM, perform the following:
- [Install systemd-related database service unit files](#install-systemd-related-database-service-unit-files)
- [Install the node agent](#install-node-agent)

After you have provisioned the nodes, you can proceed to [Add instances to the on-prem provider](../../../configure-yugabyte-platform/on-premises-nodes/#add-instances).
After you have provisioned the VM, reboot the system.

You can then proceed to [Add the instance to the on-prem provider](../../../configure-yugabyte-platform/on-premises-nodes/#add-instances).

{{<note title="Root-level systemd or cron">}}
The following instructions use user-level systemd to provide the necessary access to system resources. Versions prior to v2.20 use root-level systemd or cron. If you have previously provisioned nodes for this provider using either root-level systemd or cron, you should use the same steps, as all nodes in a provider need to be provisioned in the same way. For instructions on provisioning using root-level systemd or cron, see the [instructions for v2.18](https://docs-archive.yugabyte.com/v2.18/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/on-premises-manual/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,14 @@ rightNav:

When deploying universes using an on-premises provider, YugabyteDB Anywhere relies on you to manually create the VMs for the database nodes and provide these pre-created VMs to YugabyteDB Anywhere.

With the on-premises provider, you must provide one, three, five, or more VM(s) with the following installed:
## Prerequisites

- [Supported Linux OS](../#linux-os)
- [Additional software](../#additional-software)
- If you are not connected to the Internet, [additional software for airgapped](../#additional-software-for-airgapped-deployment)
- Provide one, three, five, or more VM(s) with the following installed:
- [Supported Linux OS](../#linux-os)
- [Additional software](../#additional-software)
- If you are not connected to the Internet, [additional software for airgapped](../#additional-software-for-airgapped-deployment)

- YugabyteDB Anywhere is [installed and running](../../../install-yugabyte-platform/).

## How to prepare the nodes for use in a database cluster

Expand All @@ -30,7 +33,7 @@ After you have created the VMs with the operating system and additional software
1. Modify the configuration file.
1. Run the provisioning script (as root or via sudo).

These steps prepare the node for use by YugabyteDB Anywhere. If you have already [installed YugabyteDB Anywhere](../../../install-yugabyte-platform/) and it is running (recommended), the script additionally creates (or updates) an [on-premises provider](../../../configure-yugabyte-platform/on-premises/) with the node already added.
These steps prepare the node for use by YugabyteDB Anywhere, including setting ulimits and transparent hugepages. If you have already [installed YugabyteDB Anywhere](../../../install-yugabyte-platform/) and it is running (recommended), the script additionally creates (or updates) an [on-premises provider](../../../configure-yugabyte-platform/on-premises/) with the node already added.

Root or sudo privileges are only required to provision the nodes. After the node is provisioned (with [YugabyteDB Anywhere node agent](/preview/faq/yugabyte-platform/#what-is-a-node-agent) installed), sudo is no longer required.

Expand Down Expand Up @@ -95,7 +98,7 @@ Configure data directories or mount points for the node (typically `/data`). If

Edit the `node-agent-provision.yaml` file in the scripts directory.

Set the following options in the provisioning file to the correct values:
The following table describes options that are changed for a typical installation. The file is commented; you can [review the file](https://github.com/yugabyte/yugabyte-db/blob/{{< yb-version version="stable" format="short">}}/managed/node-agent/resources/node-agent-provision.yaml) and its default settings on GitHub.

| Option | Value |
| :--- | :--- |
Expand Down Expand Up @@ -148,9 +151,11 @@ sudo ./node-agent-provision.sh

The script provisions the node and installs node agent, and then runs preflight checks to ensure the node is ready for use.

If specified, node agent creates the on-premises provider configuration; or, if the provider already exists, adds the instance to the provider.
If specified, node agent also creates the on-premises provider configuration; or, if the provider configuration already exists, adds the instance to the provider.

After the node is provisioned, reboot the node.

After the node is provisioned, YugabyteDB Anywhere does not need sudo access to the node.
If the preflight check fails, rebooting the node may solve some issues (for example, incorrect ulimit settings).

#### Preflight check

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,18 @@ tls:

When configured, YugabyteDB Anywhere sets the common name to the name of the service created for the pod, and adds common name to the certificate request sent to cert-manager.

### Configurable common names

You can configure a custom common name suffix for cert-manager certificates using the following helm override:

```yml
tls:
certManager:
certificates:
commonNameRequired: true
commonNameSuffix: "yugabyte.com"
```

## Troubleshoot

If you encounter problems, you should verify the name of Issuer or ClusterIssuer in the Kubernetes cluster, as well as ensure that the Kubernetes cluster is in Ready state. You can use the following commands:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ $ ulimit -n <value>

{{< note title="Restart servers" >}}

After changing a ulimit setting, the YB-Master and YB-TServer servers must be restarted in order for the new settings to take effect. Check the [yb-tserver.INFO](../start-tservers/#verify-health) file to verify that the ulimits are applied. You can also check the `/proc/<process pid>` file to see the current settings.
If you change a ulimit setting on a node where the YB-Master and YB-TServer servers are already running, you must restart the servers for the new settings to take effect. Check the [yb-tserver.INFO](../start-masters/#verify-tserver-health) file to verify that the ulimits are applied. You can also check the `/proc/<process pid>` file to see the current settings.

{{< /note >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ On Red Hat Enterprise Linux 8-based systems (Red Hat Enterprise Linux 8, Oracle
DefaultLimitNOFILE=1048576
```

You must reboot the system for these two settings to take effect.
_You must reboot the system for these two settings to take effect._

#### Transparent hugepages

Expand All @@ -45,7 +45,7 @@ Transparent hugepages (THP) should be enabled for optimal performance. Download

- [install-yb-enable-transparent-huge-pages-service.sh](/files/install-yb-enable-transparent-huge-pages-service.sh)

You must reboot the system for these settings to take effect.
_You must reboot the system for these settings to take effect._

<details>
<summary>More information</summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ For each node VM, perform the following:
- [Install systemd-related database service unit files](#install-systemd-related-database-service-unit-files)
- [Install the node agent](#install-node-agent)

After you have provisioned the nodes, you can proceed to [Add instances to the on-prem provider](../../../configure-yugabyte-platform/on-premises-nodes/#add-instances).
After you have provisioned the VM, reboot the system.

You can then proceed to [Add the instance to the on-prem provider](../../../configure-yugabyte-platform/on-premises-nodes/#add-instances).

{{<note title="Root-level systemd or cron">}}
The following instructions use user-level systemd to provide the necessary access to system resources. Versions prior to v2.20 use root-level systemd or cron. If you have previously provisioned nodes for this provider using either root-level systemd or cron, you should use the same steps, as all nodes in a provider need to be provisioned in the same way. For instructions on provisioning using root-level systemd or cron, see the [instructions for v2.18](https://docs-archive.yugabyte.com/v2.18/yugabyte-platform/configure-yugabyte-platform/set-up-cloud-provider/on-premises-manual/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,14 @@ rightNav:

When deploying universes using an on-premises provider, YugabyteDB Anywhere relies on you to manually create the VMs for the database nodes and provide these pre-created VMs to YugabyteDB Anywhere.

With the on-premises provider, you must provide one, three, five, or more VM(s) with the following installed:
## Prerequisites

- [Supported Linux OS](../#linux-os)
- [Additional software](../#additional-software)
- If you are not connected to the Internet, [additional software for airgapped](../#additional-software-for-airgapped-deployment)
- Provide one, three, five, or more VM(s) with the following installed:
- [Supported Linux OS](../#linux-os)
- [Additional software](../#additional-software)
- If you are not connected to the Internet, [additional software for airgapped](../#additional-software-for-airgapped-deployment)

- YugabyteDB Anywhere is [installed and running](../../../install-yugabyte-platform/).

## How to prepare the nodes for use in a database cluster

Expand All @@ -30,7 +33,7 @@ After you have created the VMs with the operating system and additional software
1. Modify the configuration file.
1. Run the provisioning script (as root or via sudo).

These steps prepare the node for use by YugabyteDB Anywhere. If you have already [installed YugabyteDB Anywhere](../../../install-yugabyte-platform/) and it is running (recommended), the script additionally creates (or updates) an [on-premises provider](../../../configure-yugabyte-platform/on-premises/) with the node already added.
These steps prepare the node for use by YugabyteDB Anywhere, including setting ulimits and transparent hugepages. If you have already [installed YugabyteDB Anywhere](../../../install-yugabyte-platform/) and it is running (recommended), the script additionally creates (or updates) an [on-premises provider](../../../configure-yugabyte-platform/on-premises/) with the node already added.

Root or sudo privileges are only required to provision the nodes. After the node is provisioned (with [YugabyteDB Anywhere node agent](/preview/faq/yugabyte-platform/#what-is-a-node-agent) installed), sudo is no longer required.

Expand Down Expand Up @@ -95,7 +98,7 @@ Configure data directories or mount points for the node (typically `/data`). If

Edit the `node-agent-provision.yaml` file in the scripts directory.

Set the following options in the provisioning file to the correct values:
The following table describes options that are changed for a typical installation. The file is commented; you can [review the file](https://github.com/yugabyte/yugabyte-db/blob/{{< yb-version version="v2.20" format="short">}}/managed/node-agent/resources/node-agent-provision.yaml) and its default settings on GitHub.

| Option | Value |
| :--- | :--- |
Expand Down Expand Up @@ -149,9 +152,11 @@ sudo ./node-agent-provision.sh

The script provisions the node and installs node agent, and then runs preflight checks to ensure the node is ready for use.

If specified, node agent creates the on-premises provider configuration; or, if the provider already exists, adds the instance to the provider.
If specified, node agent also creates the on-premises provider configuration; or, if the provider configuration already exists, adds the instance to the provider.

After the node is provisioned, reboot the node.

After the node is provisioned, YugabyteDB Anywhere does not need sudo access to the node.
If the preflight check fails, rebooting the node may solve some issues (for example, incorrect ulimit settings).

#### Preflight check

Expand Down
Loading