# Set up development environment for Cloudberry Database on Linux

This document shares how to set up the development environments on different Linux systems (CentOS 7, RHEL, and Ubuntu). Before you start to [explore the Cloudberry Database](https://github.com/cloudberrydb/cloudberrydb/tree/main/readmes), follow this document to download and install the required tools and dependencies, and create demo user.

Take the following steps to set up the development environments:

1. [Clone GitHub repo](#step-1-clone-github-repo).
2. [Install dependencies](#step-2-install-dependencies).
3. [Perform prerequisite platform tasks](#step-3-prerequisite-platform-tasks).

## Step 1. Clone GitHub repo

Clone the GitHub repository `cloudberrydb/cloudberrydb` to the target machine:

git clone https://github.com/cloudberrydb/cloudberrydb.git

## Step 2. Install dependencies

Install dependencies according to your operating systems:

- [For CentOS 7](#For-CentOS-7)
- [For RHEL/Rocky 8](#For-RHEL/Rocky-8)
- [For Ubuntu 18.04 or later](#For-Ubuntu-1804-or-later)

### For CentOS 7

The following dependencies work on CentOS 7. For other CentOS versions, these steps might work but are not guaranteed to work.

1. Run the Bash script `README.CentOS.bash` in the `readmes` directory of the `cloudberrydb/cloudberrydb` repository. To run this script, password is required. Then, some required dependencies will be automatically downloaded.

    ./README.CentOS.bash

2. Install additional packages required for some configurations.

    yum -y install R apr apr-devel apr-util automake autoconf bash bison bison-devel bzip2 bzip2-devel centos-release-scl curl flex flex-devel gcc gcc-c++ git gdb iproute krb5-devel less libcurl libcurl-devel libevent libevent-devel libxml2 libxml2-devel libyaml libzstd-devel libzstd make openldap openssh openssh-clients openssh-server openssl openssl-devel openssl-libs perl python3-devel readline readline-devel rsync sed sudo tar vim wget which xerces-c-devel zip zlib && \
    yum -y install epel-release

3. Update the GNU Compiler Collection (GCC) to version `devtoolset-10` to support C++ 14.

    yum install centos-release-scl 
    yum -y install devtoolset-10-gcc devtoolset-10-gcc-c++ devtoolset-10-binutils 
    scl enable devtoolset-10 bash 
    source /opt/rh/devtoolset-10/enable 
    echo "source /opt/rh/devtoolset-10/enable" >> /root/.bashrc
    gcc -v

4. Link cmake3 to cmake:

    sudo ln -sf /usr/bin/cmake3 /usr/local/bin/cmake

### For RHEL/Rocky 8

1. Install Development Tools.

    sudo yum group install -y "Development Tools"

2. 下载相关依赖

    # 暂时可以使用这个链接下载README.Rhel-Rocky.bash
    wget https://public-artifacts.obs.cn-north-4.myhuaweicloud.com/README.Rhel-Rocky.bash
    chmod 777 README.Rhel-Rocky.bash && cp ~/README.Rhel-Rocky.bash ~/cloudberrydb/readmes/
    
    sudo yum install -y epel-release
    
    sudo yum install -y apr-devel bison bzip2-devel cmake3 flex gcc gcc-c++ krb5-devel libcurl-devel libevent-devel libkadm5  libxml2-devel libzstd-devel openssl-devel perl-ExtUtils-Embed python3-devel python3-pip readline-devel xerces-c-devel zlib-devel

3. Install dependencies by running the `README.Rhel-Rocky.bash` script.

    # This makes sure that git and make is installed.       
    # Then run the README.Rhel-Rocky.bash script in the `readmes` directory.
    ./README.Rhel-Rocky.bash

### For Ubuntu 18.04 or later

1. Install dependencies by running the `README.Ubuntu.bash` script in the `readmes` directory.

    ## You need to enter your password to run
    sudo ./README.Ubuntu.bash

> **Note:**
>
> - When you run the `README.Ubuntu.bash` script for dependencies, you will be asked to configure `realm` for kerberos. You can enter any realm, because this is just for testing, and during testing, it will reconfigure a local server/client. If you want to skip this manual configuration, run `export DEBIAN_FRONTEND=noninteractive`.
> - If you fail to download packages, we recommend that you can try another one software source for Ubuntu.

2. Install GCC 10. Ubuntu 18.04 and later versions should use GCC 10 or newer:

    ## Install gcc-10
    sudo apt install software-properties-common
    sudo add-apt-repository ppa:ubuntu-toolchain-r/test
    sudo apt install gcc-10 g++-10
    sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100

## Step 3. Perform prerequisite platform tasks

After you have installed all the dependencies for your operating system, it is time to do some prerequisite platform tasks before you go on building Cloudberry Database. These operation include manually running `ldconfig` on all platforms, creating the `gpadmin` user, and setting up a password to start the Cloudberry Database and test.

1. Make sure that you add `/usr/local/lib` and `/usr/local/lib64` to the `/etc/ld.so.conf` file, then run `ldconfig` command:

    echo -e "/usr/local/lib \n/usr/local/lib64" >> /etc/ld.so.conf

    ldconfig

2. Create the `gpadmin` user and set up the SSH key.

Manually create SSH keys based on different operating systems, so that you can run `ssh localhost` without a password.

- For CentOS 7 OR RHEL/Rocky:

    useradd gpadmin  # Creates gpadmin user
    su - gpadmin  # Uses the gpadmin user
    ssh-keygen  # Creates SSH key
    cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
    chmod 600 ~/.ssh/authorized_keys
    exit

- For Ubuntu:

    useradd -r -m -s /bin/bash gpadmin  # Creates gpadmin user
    su - gpadmin  # Uses the gpadmin user
    ssh-keygen  # Creates SSH key
    cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
    chmod 600 ~/.ssh/authorized_keys 
    exit

3. Build the database

    # Configure build environment to install at /usr/local/cloudberrydb
    ./configure --with-perl --with-python --with-libxml --with-gssapi --prefix=/usr/local/cloudberrydb

    # Compile and install
    make -j8
    make -j8 install

    # Bring in greenplum environment for CBDB into your running shell
    cd ..
    cp -r cloudberrydb/ /home/gpadmin/
    cd /home/gpadmin/ && chown -R gpadmin:gpadmin cloudberrydb/
    su - gpadmin
    cd cloudberrydb/
    source /usr/local/cloudberrydb/greenplum_path.sh

    # Start demo cluster
    make create-demo-cluster
    
    # (gpdemo-env.sh contains __PGPORT__ and __MASTER_DATA_DIRECTORY__ values)
    source gpAux/gpdemo/gpdemo-env.sh

CloudberryDB is built with GPORCA by default. If you want to build CBDB without GPORCA, configure requires `--disable-orca` flag to be set in the first step.

# Configure build environment to install at /usr/local/cloudberrydb
./configure --disable-orca --with-perl --with-python --with-libxml --prefix=/usr/local/cloudberrydb

## Step 4. Verify the cluster

1. You can verify whether the cluster has started successfully by running the following command. You might see many active `postgres` processes with ports ranging from `7000` to `7007`.

    ps -ef | grep postgres

2. Connect to the Cloudberry Database and see the active segment information by querying the system table `gp_segement_configuration`. For detailed description of this table, see the Greenplum document [here](https://docs.vmware.com/en/VMware-Greenplum/6/greenplum-database/ref_guide-system_catalogs-gp_segment_configuration.html).

    $ psql -p 7000 postgres
    postgres=# select version();
    postgres=# select * from gp_segment_configuration;

Example output:

    $ psql -p 7000 postgres
    psql (14.4, server 14.4)
    Type "help" for help.

    postgres=# select version();
                                                                                             version                                                                                         
    -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
     PostgreSQL 14.4 (Cloudberry Database 1.0.0+1c0d6e2224 build dev) on x86_64( GCC 13.2.0) 13.2.0, 64-bit compiled on Sep 22 2023 10:56:01
    (1 row)

    postgres=# select * from gp_segment_configuration;
 dbid | content | role | preferred_role | mode | status | port |  hostname  |  address   |                                   datadir                                    | warehouseid 
------+---------+------+----------------+------+--------+------+------------+------------+------------------------------------------------------------------------------+-------------
    1 |      -1 | p    | p              | n    | u      | 7000 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/qddir/demoDataDir-1         |           0
    8 |      -1 | m    | m              | s    | u      | 7001 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/standby                     |           0
    3 |       1 | p    | p              | s    | u      | 7003 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast2/demoDataDir1        |           0
    6 |       1 | m    | m              | s    | u      | 7006 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast_mirror2/demoDataDir1 |           0
    2 |       0 | p    | p              | s    | u      | 7002 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast1/demoDataDir0        |           0
    5 |       0 | m    | m              | s    | u      | 7005 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast_mirror1/demoDataDir0 |           0
    4 |       2 | p    | p              | s    | u      | 7004 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast3/demoDataDir2        |           0
    7 |       2 | m    | m              | s    | u      | 7007 | i-6wvpa9wt | i-6wvpa9wt | /home/gpadmin/cloudberrydb/gpAux/gpdemo/datadirs/dbfast_mirror3/demoDataDir2 |           0
(8 rows)

    postgres=#

3. Now we can finally run `installcheck-world` to test everything works fine:

    # In the folder where your cloned the source code
    make installcheck-world

Congratulations 🎉! You've successfully installed and created a CloudberryDB cluster. Happy Hacking! 😉