Skip to content

Commit

Permalink
Cleanup the build tools and guide directories
Browse files Browse the repository at this point in the history
In this PR, we have some changes for the build guides and deploy tools.
Including:

- Rename `readmes/*` -> `deploy/build/*`
- Rename `hooks/*` -> `src/tools/hooks/*`
- Move `python-dependencies.txt` to the top dir
- Move `README.Conda.md` out from the main repo to the
  `cloudberrydb/cloudberrydb-site` repo because it's for the data
  analytics guide, not how to build a Cloudberry Database.

Note that we have not verified the files in `deploy/vagrant`,
`deploy/docker`, and `deploy/k8s`. We cannot make sure it can run
successfully. We will do that in the following months.
  • Loading branch information
tuhaihe committed May 29, 2024
1 parent 6b5c6a2 commit 8ba10ab
Show file tree
Hide file tree
Showing 26 changed files with 13 additions and 93 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Database.

### Build from source

You can follow [these guides](./readmes) to build the Cloudberry Database on
You can follow [these guides](./deploy/build) to build the Cloudberry Database on
Linux OS(including CentOS, RHEL/Rocky Linux, and Ubuntu) and macOS.

### Try out quickly
Expand Down
File renamed without changes.
10 changes: 5 additions & 5 deletions readmes/README.Linux.md → deploy/build/README.Linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ Enter the repository and install dependencies according to your operating system

The following steps 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.
1. Run the bash script `README.CentOS.bash` in the `deploy/build` directory of the `cloudberrydb/cloudberrydb` repository. To run this script, password is required. Then, some required dependencies will be automatically downloaded.

```bash
cd cloudberrydb/readmes
cd cloudberrydb/deploy/build
./README.CentOS.bash
```

Expand Down Expand Up @@ -81,16 +81,16 @@ The following steps work on CentOS 7. For other CentOS versions, these steps mig
3. Install more dependencies by running the `README.Rhel-Rocky.bash` script.

```bash
~/cloudberrydb/readmes/README.Rhel-Rocky.bash
~/cloudberrydb/deploy/build/README.Rhel-Rocky.bash
```

### For Ubuntu 18.04 or later

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

```shell
# You need to enter your password to run.
sudo ~/cloudberrydb/readmes/README.Ubuntu.bash
sudo ~/cloudberrydb/deploy/build/README.Ubuntu.bash
```

> [!Note]
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions readmes/README.macOS.md → deploy/build/README.macOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ According to our test, these steps work well on macOS Ventura 13.4+ with both In
Run the following command to install the needed dependencies. You will be asked to enter the `sudo` password of your macOS system.

```bash
source readmes/README.macOS.bash
source deploy/build/README.macOS.bash
```

> [!NOTE]
Expand Down Expand Up @@ -66,7 +66,7 @@ source $(cd ~; pwd)/install/cbdb/greenplum_path.sh
# 4. Install the Python dependencies.
pip3 install --user -r readmes/python-dependencies.txt
pip3 install --user -r python-dependencies.txt
# 5. Start a demo cluster.
Expand Down
10 changes: 5 additions & 5 deletions readmes/README.md → deploy/build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Greenplum Database READE.md here. Thanks all the original writers.-->

This guides describes how to build Cloudberry Database from source code.

- For building on Linux systems, see [Compile and Install Cloudberry Database on Linux](/readmes/README.Linux.md).
- For building on macOS system, see [Compile and Install Cloudberry Database on macOS](/readmes/README.macOS.md).
- For building on Linux systems, see [Compile and Install Cloudberry Database on Linux](./README.Linux.md).
- For building on macOS system, see [Compile and Install Cloudberry Database on macOS](./README.macOS.md).

## Build the database

Expand Down Expand Up @@ -98,7 +98,7 @@ make distclean

PXF is an extension framework for Greenplum Database/Cloudberry
Database to enable fast access to external Hadoop datasets. Refer to
[PXF extension](../gpcontrib/pxf/README.md) for more information.
[PXF extension](../../gpcontrib/pxf_fdw/README.md) for more information.

Currently, CBDB is built with PXF by default (--enable-pxf is on).
In order to build CBDB without pxf, simply invoke `./configure` with additional option `--disable-pxf`.
Expand All @@ -108,9 +108,9 @@ PXF requires curl, so `--enable-pxf` is not compatible with the `--without-libcu

Cloudberry Database supports Python3 with plpython3u UDF

See [how to enable Python3](../src/pl/plpython/README.md) for details.
See [how to enable Python3](../../src/pl/plpython/README.md) for details.


# Development with Vagrant

There is a Vagrant-based [quickstart guide for developers](../src/tools/vagrant/README.md).
There is a Vagrant-based [quickstart guide for developers](../vagrant/README.md).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
80 changes: 0 additions & 80 deletions readmes/README.Conda.md

This file was deleted.

File renamed without changes.
File renamed without changes.

0 comments on commit 8ba10ab

Please sign in to comment.