From 3325fed0a56f11cf9cc125a3fc0a70aa890f3567 Mon Sep 17 00:00:00 2001 From: Dianjin Wang Date: Tue, 26 Nov 2024 15:16:52 +0800 Subject: [PATCH] Doc: update the project name to Apache Cloudberry Rename the Cloudberry Database to Apache Cloudberry to address the lastest project name change. --- CONTRIBUTING.md | 2 +- README.md | 2 +- deploy/build/README.Linux.md | 16 ++++++++-------- deploy/build/README.macOS.md | 12 ++++++------ deploy/build/README.md | 20 ++++++++++---------- 5 files changed, 26 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6cf5b3370ca..6c22b84a0ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -47,7 +47,7 @@ You can participate by: * [Reporting security issues](./SECURITY.md). * Testing code, testing releases. * Creating educational content (Blog posts, tutorials, videos, etc.) -* Spreading the word about Cloudberry Database on social media(eg, +* Spreading the word about Apache Cloudberry on social media(eg, Twitter, LinkedIn). * ... * More things to make Cloudberry better. diff --git a/README.md b/README.md index 29eceb5f9fc..ee0901af3f4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ - Cloudberry Database Logo + Apache Cloudberry Logo

diff --git a/deploy/build/README.Linux.md b/deploy/build/README.Linux.md index 2e4805f694f..e0406c7344c 100644 --- a/deploy/build/README.Linux.md +++ b/deploy/build/README.Linux.md @@ -1,13 +1,13 @@ -# Compile and Install Cloudberry Database on Linux +# Compile and Install Apache Cloudberry on Linux -This document shares how to compile and install Cloudberry Database on Linux systems (CentOS 7, RHEL, and Ubuntu). Note that this document is for developers to try out Cloudberry Database in a single-node environments. DO NOT use this document for production environments. +This document shares how to compile and install Apache Cloudberry on Linux systems (CentOS 7, RHEL, and Ubuntu). Note that this document is for developers to try out Apache Cloudberry in a single-node environments. DO NOT use this document for production environments. Take the following steps to set up the development environments: 1. [Clone the GitHub repo](#step-1-clone-the-github-repo). 2. [Install dependencies](#step-2-install-dependencies). 3. [Perform prerequisite platform tasks](#step-3-perform-prerequisite-platform-tasks). -4. [Build Cloudberry Database](#step-4-build-cloudberry-database). +4. [Build Apache Cloudberry](#step-4-build-apache-cloudberry). 5. [Verify the cluster](#step-5-verify-the-cluster). ## Step 1. Clone the GitHub repo @@ -112,7 +112,7 @@ The following steps work on CentOS 7. For other CentOS versions, these steps mig ## 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 operations include manually running `ldconfig`, creating the `gpadmin` user, and setting up a password to start the Cloudberry Database and test. +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 Apache Cloudberry. These operations include manually running `ldconfig`, creating the `gpadmin` user, and setting up a password to start the Apache Cloudberry and test. 1. Make sure that you add `/usr/local/lib` and `/usr/local/lib64` to the `/etc/ld.so.conf` file. @@ -145,9 +145,9 @@ After you have installed all the dependencies for your operating system, it is t exit ``` -## Step 4. Build Cloudberry Database +## Step 4. Build Apache Cloudberry -After you have installed all the dependencies and performed the prerequisite platform tasks, you can start to build Cloudberry Database. Run the following commands in sequence. +After you have installed all the dependencies and performed the prerequisite platform tasks, you can start to build Apache Cloudberry. Run the following commands in sequence. 1. Configure the build environment. Enter the `cloudberrydb` directory and run the `configure` script. @@ -214,7 +214,7 @@ After you have installed all the dependencies and performed the prerequisite pla 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). +2. Connect to the Apache Cloudberry 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). ```sql $ psql -p 7000 postgres @@ -224,7 +224,7 @@ After you have installed all the dependencies and performed the prerequisite pla 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 + PostgreSQL 14.4 (Apache Cloudberry 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; diff --git a/deploy/build/README.macOS.md b/deploy/build/README.macOS.md index 3231f983486..b23a21a2f9e 100644 --- a/deploy/build/README.macOS.md +++ b/deploy/build/README.macOS.md @@ -1,6 +1,6 @@ -# Compile and Install Cloudberry Database on macOS +# Compile and Install Apache Cloudberry on macOS -This document shares how to build, compile, and install Cloudberry Database on macOS for development purposes. Follow the steps below. +This document shares how to build, compile, and install Apache Cloudberry on macOS for development purposes. Follow the steps below. According to our test, these steps work well on macOS Ventura 13.4+ with both Intel and Apple silicon processors (M1 or M2). If you have an older version of macOS, upgrading is recommended. @@ -55,12 +55,12 @@ source deploy/build/README.macOS.bash BREWPREFIX=$(brew --prefix); export PATH="$BREWPREFIX/opt/gnu-sed/libexec/gnubin:$BREWPREFIX/opt/apr/bin:$PATH"; CXXFLAGS="-I $BREWPREFIX/include" CFLAGS="-ggdb -Og -g3 -fno-omit-frame-pointer -I $BREWPREFIX/include" LDFLAGS="-L $BREWPREFIX/lib" CC=$(which gcc-13) CXX=$(which g++-13) ./configure --enable-debug --prefix=$(cd ~; pwd)/install/cbdb; -# 2. Compile and install Cloudberry Database. +# 2. Compile and install Apache Cloudberry. make -j8 make -j8 install -# 3. Bring in Greenplum environment for Cloudberry Database into your running shell. +# 3. Bring in Greenplum environment for Apache Cloudberry into your running shell. source $(cd ~; pwd)/install/cbdb/greenplum_path.sh @@ -84,7 +84,7 @@ source gpAux/gpdemo/gpdemo-env.sh 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). +2. Connect to the Apache Cloudberry 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). ```sql $ psql -p 8000 postgres @@ -102,7 +102,7 @@ source gpAux/gpdemo/gpdemo-env.sh postgres=# select version(); version ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - PostgreSQL 14.4 (Cloudberry Database 1.0.0+1c0d6e2224 build dev) on x86_64-apple-darwin22.4.0, compiled by gcc-13 (Homebrew GCC 13.2.0) 13.2.0, 64-bit compiled on Sep 22 2023 10:56:01 + PostgreSQL 14.4 (Apache Cloudberry 1.0.0+1c0d6e2224 build dev) on x86_64-apple-darwin22.4.0, compiled by gcc-13 (Homebrew 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; diff --git a/deploy/build/README.md b/deploy/build/README.md index 7798efa9604..527548a0262 100644 --- a/deploy/build/README.md +++ b/deploy/build/README.md @@ -1,12 +1,12 @@ -# Build Cloudberry Database from Source Code +# Build Apache Cloudberry from Source Code -This guides describes how to build Cloudberry Database from source code. +This guides describes how to build Apache Cloudberry from source code. -- 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). +- For building on Linux systems, see [Compile and Install Apache Cloudberry on Linux](./README.Linux.md). +- For building on macOS system, see [Compile and Install Apache Cloudberry on macOS](./README.macOS.md). ## Build the database @@ -63,14 +63,14 @@ make installcheck-world parts, the respective targets can be run separately. * The PostgreSQL __check__ target does not work. Setting up a - Cloudberry Database cluster is more complicated than a single-node + Apache Cloudberry cluster is more complicated than a single-node PostgreSQL installation, and no-one's done the work to have __make check__ create a cluster. Create a cluster manually or use gpAux/gpdemo/ (example below) and run the toplevel __make installcheck-world__ against that. Patches are welcome! * The PostgreSQL __installcheck__ target does not work either, because - some tests are known to fail with Cloudberry Database. The + some tests are known to fail with Apache Cloudberry. The __installcheck-good__ schedule in __src/test/regress__ excludes those tests. @@ -81,7 +81,7 @@ make installcheck-world # Alternative Configurations -## Building Cloudberry Database without GPORCA +## Building Apache Cloudberry without GPORCA Currently, CBDB is built with GPORCA by default. If you want to build CBDB without GPORCA, configure requires `--disable-orca` flag to be set. @@ -94,7 +94,7 @@ make distclean ./configure --disable-orca --with-perl --with-python --with-libxml --prefix=/usr/local/cloudberrydb ``` -## Building Cloudberry Database with PXF +## Building Apache Cloudberry with PXF PXF is an extension framework for Greenplum Database/Cloudberry Database to enable fast access to external Hadoop datasets. Refer to @@ -104,9 +104,9 @@ 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`. PXF requires curl, so `--enable-pxf` is not compatible with the `--without-libcurl` option. -## Building Cloudberry Database with Python3 enabled +## Building Apache Cloudberry with Python3 enabled -Cloudberry Database supports Python3 with plpython3u UDF +Apache Cloudberry supports Python3 with plpython3u UDF See [how to enable Python3](../../src/pl/plpython/README.md) for details.