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

[doc][yba] Installing python and YBA nodes #25563

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The following built-in roles are available:

- **Super Admin** is the first user that is created during installation. This role has the highest level of privilege and allows all read and write actions on all YugabyteDB Anywhere resources. There can be only one Super Admin. Super Admin can perform the following:

- Manage all resources, including universes, nodes, backup, restore, and cloud providers.
- Manage all resources, including universes, nodes, backup, restore, and provider configurations.
- Manage the user access control by creating and managing users.

For more information, see [Create admin user](../../install-yugabyte-platform/create-admin-user/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ In cases of failover, the previous active instance may be unavailable or unreach

Afterwards, follow the steps in [Failover](#failover) to ensure that the old active does not come back up or that it goes into standby mode when it does come up.

You should be able to see that all of the data has been restored into the instance, including universes, users, metrics, alerts, task history, cloud providers, and so on.
You should be able to see that all of the data has been restored into the instance, including universes, users, metrics, alerts, task history, provider configurations, and so on.

### Verify promotion

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure the AWS cloud provider
title: Configure the AWS provider configuration
headerTitle: Create cloud provider configuration
linkTitle: Cloud providers
description: Configure the Amazon Web Services (AWS) provider configuration.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure the Microsoft Azure cloud provider
title: Configure the Microsoft Azure provider configuration
headerTitle: Create cloud provider configuration
linkTitle: Cloud providers
description: Configure the Microsoft Azure provider configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure the GCP cloud provider
title: Configure the GCP provider configuration
headerTitle: Create cloud provider configuration
linkTitle: Cloud providers
description: Configure the Google Cloud Platform (GCP) cloud provider.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure the Kubernetes cloud provider
title: Configure the Kubernetes provider configuration
headerTitle: Create Kubernetes provider configuration
linkTitle: Kubernetes
description: Configure the Kubernetes provider configuration
Expand Down Expand Up @@ -425,9 +425,9 @@ spec:

Refer to [Multi-Region YugabyteDB Deployments on Kubernetes with Istio](https://www.yugabyte.com/blog/multi-region-yugabytedb-deployments-on-kubernetes-with-istio/) for a step-by-step guide and an explanation of the options being used.

### Configure the cloud provider for MCS
### Configure the provider configuration for MCS

After you have the cluster set up, follow the instructions in [Configure the Kubernetes cloud provider](#provider-settings), and refer to this section for region and zone configuration required for multi-region universes.
After you have the cluster set up, follow the instructions in [Create a provider](#create-a-provider), and refer to this section for region and zone configuration required for multi-region universes.

#### Configure region and zone for GKE MCS

Expand All @@ -452,7 +452,7 @@ For example, if your cluster membership name is `yb-asia-south1`, then the **Add

#### Configure region and zones for OpenShift MCS

Follow the instructions in [Configure the OpenShift cloud provider](../openshift/) and [Create a provider](#create-a-provider). For all the zones from your OpenShift clusters connected via MCS (Submariner), add a region as follows:
Follow the instructions in [Create OpenShift provider configuration](../openshift/) and [Create a provider](#create-a-provider). For all the zones from your OpenShift clusters connected via MCS (Submariner), add a region as follows:

1. Specify fields such as Region, Zone, and so on as you would normally.
1. Set the **Cluster DNS Domain** to `clusterset.local`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,4 @@ After the instances are available in the **Instances** list, validate them by pe

YugabyteDB Anywhere runs the check and displays the status in the **Preflight Check** column. Click in the column to view details; you can also view the results under **Tasks**.

If all your instances successfully pass the preflight check, your on-premises cloud provider configuration is ready, and you can begin [deploying universes](../../create-deployments/).
If all your instances successfully pass the preflight check, your on-premises provider configuration is ready, and you can begin [deploying universes](../../create-deployments/).
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Configure the OpenShift cloud provider
title: Configure the OpenShift provider configuration
headerTitle: Create Kubernetes provider configuration
linkTitle: Kubernetes
description: Configure the OpenShift provider configuration
headContent: For deploying universes on OpenShift
headContent: For deploying universes on Kubernetes
aliases:
- /preview/deploy/enterprise-edition/configure-cloud-providers/openshift
menu:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Configure the VMware Tanzu cloud provider
title: Configure the VMware Tanzu provider configuration
headerTitle: Create Kubernetes provider configuration
linkTitle: Kubernetes
description: Configure the VMware Tanzu provider configuration
headContent: For deploying universes on VMware Tanzu
headContent: For deploying universes on Kubernetes
aliases:
- /deploy/pivotal-cloud-foundry/
- /preview/deploy/pivotal-cloud-foundry/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To create a multi-cloud universe, you would need to do the following:
* [Set up node instance virtual machines](#set-up-instance-vms) in each cloud (AWS, GCP, and Azure)
* [Set up VPC peering](#set-up-vpc-peering) through a VPN tunnel across these 3 clouds
* [Install YugabyteDB Anywhere](#install-yugabytedb-anywhere) on one of the nodes
* [Configure the on-premises cloud provider](#configure-the-on-premises-cloud-provider)
* [Configure the on-premises provider configuration](#configure-the-on-premises-cloud-provider)
ddhodge marked this conversation as resolved.
Show resolved Hide resolved
* [Create a universe](#create-a-universe) using the provider
* [Run the TPC-C benchmark](#run-the-tpc-c-benchmark)

Expand Down Expand Up @@ -59,7 +59,7 @@ All public cloud providers enable VPN tunneling across VPCs and their subnet to

Follow steps provided in [Install YugabyteDB Anywhere](../../install-yugabyte-platform/) to deploy YugabyteDB Anywhere on a new VM on one of your cloud providers. You will use this node to manage your YugabyteDB universe.

## Configure the on-premises cloud provider
## Configure the on-premises provider configuration

To deploy a multi-cloud universe, you first need to create an on-premises provider configuration. Refer to [Create provider configuration](../../configure-yugabyte-platform/on-premises/) for more information.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Before you start creating a universe, ensure that you have created a provider co

## Create a universe

After you have configured a cloud provider, such as, for example [Google Cloud Provider](../../configure-yugabyte-platform/gcp/) (GCP), navigate to **Universes**, click **Create Universe**, and enter the following sample values:
After you have created a provider configuration, such as, for example [Google Cloud Provider](../../configure-yugabyte-platform/gcp/) (GCP), navigate to **Universes**, click **Create Universe**, and enter the following sample values:

- In the **Name** field, enter **helloworld2**.

- In the **Provider** field, select the cloud provider you configured.
- In the **Provider** field, select the provider you configured.

- Use the **Regions** field to select the regions where you want to deploy nodes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,17 @@ A Kubernetes-based installation of YugabyteDB Anywhere requires you to address c

The core dump collection in Kubernetes requires special care due to the fact that `core_pattern` is not isolated in cgroup drivers.

You need to ensure that core dumps are enabled on the underlying Kubernetes node. Running the `ulimit -c` command within a Kubernetes pod or node must produce a large non-zero value or the `unlimited` value as an output. For more information, see [How to enable core dumps](https://www.ibm.com/support/pages/how-do-i-enable-core-dumps).
You need to ensure that core dumps are enabled on the underlying Kubernetes node. Running the `ulimit -c` command in a Kubernetes pod or node must produce a large non-zero value or the `unlimited` value as an output. For more information, see [How to enable core dumps](https://www.ibm.com/support/pages/how-do-i-enable-core-dumps).

To be able to locate your core dumps, you should be aware of the fact that the location to which core dumps are written depends on the sysctl `kernel.core_pattern` setting. For more information, see [Linux manual: core(5)](https://man7.org/linux/man-pages/man5/core.5.html#:~:text=Naming%20of%20core%20dump%20files).

To inspect the value of the sysctl within a Kubernetes pod or node, execute the following:
To inspect the value of the sysctl in a Kubernetes pod or node, execute the following:

```sh
cat /proc/sys/kernel/core_pattern
```

If the value of `core_pattern` contains a `|` pipe symbol (for example, `|/usr/share/apport/apport -p%p -s%s -c%c -d%d -P%P -u%u -g%g -- %E`), the core dump is being redirected to a specific collector on the underlying Kubernetes node, with the location depending on the exact collector. To be able to retrieve core dump files in case of a crash within the Kubernetes pod, it is important that you understand where these files are written.
If the value of `core_pattern` contains a `|` pipe symbol (for example, `|/usr/share/apport/apport -p%p -s%s -c%c -d%d -P%P -u%u -g%g -- %E`), the core dump is being redirected to a specific collector on the underlying Kubernetes node, with the location depending on the exact collector. To be able to retrieve core dump files in case of a crash in the Kubernetes pod, it is important that you understand where these files are written.

If the value of `core_pattern` is a literal path of the form `/var/tmp/core.%p`, no action is required on your part, as core dumps will be copied by the YugabyteDB node to the persistent volume directory `/mnt/disk0/cores` for future analysis.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ To change the configuration of a universe, do the following:

YugabyteDB automatically ensures that new nodes start hosting the tablet leaders for a set of tablets in such a way that the tablet leader count remains evenly balanced across all the available nodes.

To change the number of nodes of universes created with an on-premises cloud provider and secured with third-party certificates obtained from external certification authorities, you must first add the certificates to the nodes you will add to the universe. Refer to [Add certificates](../../security/enable-encryption-in-transit/add-certificate-ca/). Ensure that the certificates are signed by the same external CA and have the same root certificate. In addition, ensure that you copy the certificates to the same locations that you originally used when creating the universe.
To change the number of nodes of universes created with an on-premises provider and secured with third-party certificates obtained from external certification authorities, you must first add the certificates to the nodes you will add to the universe. Refer to [Add certificates](../../security/enable-encryption-in-transit/add-certificate-ca/). Ensure that the certificates are signed by the same external CA and have the same root certificate. In addition, ensure that you copy the certificates to the same locations that you originally used when creating the universe.

## Smart resize

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To achieve network connectivity across multiple Kubernetes clusters, you can set

GKE MCS allows clusters to be combined as a fleet on Google Cloud. These fleet clusters can export services, which enables you to do cross-cluster communication. For more information, see [Multi-cluster Services](https://cloud.google.com/kubernetes-engine/docs/concepts/multi-cluster-services) in the Google Cloud documentation.

To enable MCS on your GKE clusters, see [Configuring multi-cluster Services](https://cloud.google.com/kubernetes-engine/docs/how-to/multi-cluster-services). Note down the unique membership name of each cluster in the fleet, it will be used during the cloud provider setup in YBA.
To enable MCS on your GKE clusters, see [Configuring multi-cluster Services](https://cloud.google.com/kubernetes-engine/docs/how-to/multi-cluster-services). Note down the unique membership name of each cluster in the fleet, it will be used during the provider setup in YBA.

### Prepare OpenShift clusters for MCS

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ Take the time now to prepare the Linux disk image.

| Save for later | To configure |
| :--- | :--- |
| SSH-enabled, root-privileged user name | [Cloud provider](../../../configure-yugabyte-platform/aws/) |
| SSH-enabled, root-privileged Private Key Content PEM file | [Cloud provider](../../../configure-yugabyte-platform/aws/) |
| Disk image IDs | [Cloud provider](../../../configure-yugabyte-platform/aws/) |
| SSH-enabled, root-privileged user name | [Cloud provider configuration](../../../configure-yugabyte-platform/aws/) |
| SSH-enabled, root-privileged Private Key Content PEM file | [Cloud provider configuration](../../../configure-yugabyte-platform/aws/) |
| Disk image IDs | [Cloud provider configuration](../../../configure-yugabyte-platform/aws/) |

## Custom Linux version without Internet connectivity

Expand All @@ -60,6 +60,6 @@ Take the time now to prepare the Linux disk image.

| Save for later | To configure |
| :--- | :--- |
| SSH-enabled, root-privileged user name | [Cloud provider](../../../configure-yugabyte-platform/aws/) |
| SSH-enabled, root-privileged Private Key Content PEM file | [Cloud provider](../../../configure-yugabyte-platform/aws/) |
| Disk image IDs | [Cloud provider](../../../configure-yugabyte-platform/aws/) |
| SSH-enabled, root-privileged user name | [Cloud provider configuration](../../../configure-yugabyte-platform/aws/) |
| SSH-enabled, root-privileged Private Key Content PEM file | [Cloud provider configuration](../../../configure-yugabyte-platform/aws/) |
| Disk image IDs | [Cloud provider configuration](../../../configure-yugabyte-platform/aws/) |
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type: indexpage

{{<index/item
title="Cloud provider configuration issues"
body="Troubleshoot issues encountered when configuring cloud providers."
body="Troubleshoot issues encountered when creating provider configurations."
href="cloud-provider-config-issues/"
icon="/images/section_icons/quick_start/create_cluster.png">}}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Troubleshoot cloud provider configuration issues
title: Troubleshoot provider configuration issues
headerTitle:
linkTitle: Cloud provider configuration issues
description: Troubleshoot issues encountered when configuring cloud providers for YugabyteDB Anywhere.
linkTitle: Provider configuration issues
description: Troubleshoot issues encountered when creating provider configurations for YugabyteDB Anywhere.
menu:
preview_yugabyte-platform:
identifier: cloud-provider-config-issues
Expand All @@ -11,13 +11,13 @@ menu:
type: docs
---

You might encounter issues during configuration of cloud providers for YugabyteDB Anywhere.
You might encounter issues when creating provider configurations for YugabyteDB Anywhere.

If you have problems while troubleshooting, contact {{% support-platform %}}.

## Azure cloud provider configuration problems

You can diagnose and remedy a failure that occurred when [configuring Azure cloud provider](../../configure-yugabyte-platform/azure/) as follows:
You can diagnose and remedy a failure that occurred when [creating an Azure provider configuration](../../configure-yugabyte-platform/azure/) as follows:

- Navigate to **Tasks** on the left-side menu.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The following built-in roles are available:

- **Super Admin** is the first user that is created during installation. This role has the highest level of privilege and allows all read and write actions on all YugabyteDB Anywhere resources. There can be only one Super Admin. Super Admin can perform the following:

- Manage all resources, including universes, nodes, backup, restore, and cloud providers.
- Manage all resources, including universes, nodes, backup, restore, and provider configurations.
- Manage the user access control by creating and managing users.

For more information, see [Create admin user](../../install-yugabyte-platform/create-admin-user/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ In cases of failover, the previous active instance may be unavailable or unreach

Afterwards, follow the steps in [Failover](#failover) to ensure that the old active does not come back up or that it goes into standby mode when it does come up.

You should be able to see that all of the data has been restored into the instance, including universes, users, metrics, alerts, task history, cloud providers, and so on.
You should be able to see that all of the data has been restored into the instance, including universes, users, metrics, alerts, task history, provider configurations, and so on.

### Verify promotion

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure the AWS cloud provider
title: Configure the AWS provider configuration
headerTitle: Create cloud provider configuration
linkTitle: Cloud providers
description: Configure the Amazon Web Services (AWS) provider configuration.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure the Microsoft Azure cloud provider
title: Configure the Microsoft Azure provider configuration
headerTitle: Create cloud provider configuration
linkTitle: Cloud providers
description: Configure the Microsoft Azure provider configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure the GCP cloud provider
title: Configure the GCP provider configuration
headerTitle: Create cloud provider configuration
linkTitle: Cloud providers
description: Configure the Google Cloud Platform (GCP) cloud provider.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Configure the Kubernetes cloud provider
title: Configure the Kubernetes provider configuration
headerTitle: Create Kubernetes provider configuration
linkTitle: Kubernetes
description: Configure the Kubernetes provider configuration
Expand Down Expand Up @@ -423,9 +423,9 @@ spec:

Refer to [Multi-Region YugabyteDB Deployments on Kubernetes with Istio](https://www.yugabyte.com/blog/multi-region-yugabytedb-deployments-on-kubernetes-with-istio/) for a step-by-step guide and an explanation of the options being used.

### Configure the cloud provider for MCS
### Configure the provider configuration for MCS

After you have the cluster set up, follow the instructions in [Configure the Kubernetes cloud provider](#provider-settings), and refer to this section for region and zone configuration required for multi-region universes.
After you have the cluster set up, follow the instructions in [Create a provider](#create-a-provider), and refer to this section for region and zone configuration required for multi-region universes.

#### Configure region and zone for GKE MCS

Expand All @@ -450,7 +450,7 @@ For example, if your cluster membership name is `yb-asia-south1`, then the **Add

#### Configure region and zones for OpenShift MCS

Follow the instructions in [Configure the OpenShift cloud provider](../openshift/) and [Create a provider](#create-a-provider). For all the zones from your OpenShift clusters connected via MCS (Submariner), add a region as follows:
Follow the instructions in [Create OpenShift provider configuration](../openshift/) and [Create a provider](#create-a-provider). For all the zones from your OpenShift clusters connected via MCS (Submariner), add a region as follows:

1. Specify fields such as Region, Zone, and so on as you would normally.
1. Set the **Cluster DNS Domain** to `clusterset.local`.
Expand Down
Loading