Skip to content

Commit 18bda55

Browse files
committed
Doc: update Cloudberry naming in devops dir
Update documentation and configuration files to use consistent "Apache Cloudberry" naming instead of "Cloudberry Database". This change affects Docker files, RPM specs, README files, and configuration templates to maintain brand consistency across the project. Main changes include: - Updated Dockerfile comments and descriptions - Modified RPM package summaries and descriptions - Standardized product names in README documentation - Updated gpinitsystem configuration file headers - Reorganized pom.xml excludes for better structure - Update the README.me for a better Cloudberry build guide - Ajust the pom.xml for a better layout This commit are mostly used for improving the PR apache#1292 .
1 parent b382c21 commit 18bda55

File tree

13 files changed

+83
-84
lines changed

13 files changed

+83
-84
lines changed

deploy/README.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

devops/README.md

Lines changed: 48 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -17,72 +17,92 @@
1717
under the License.
1818
-->
1919

20-
# Auto-Build Cloudberry Database from Source Code
20+
# Auto-Build Apache Cloudberry from Source Code
2121

22-
You can build Cloudberry Database from source code in two ways: manually or automatically.
22+
You can build Apache Cloudberry from source code in two ways: manually or automatically.
2323

2424
For the manual build, you need to manually set up many system configurations and download third-party dependencies, which is quite cumbersome and error-prone.
2525

2626
To make the job easier, it is recommended that you use the automated deployment method and scripts provided here. The automation method simplifies the deployment process, reduces time costs, and allows developers to focus more on business code development.
2727

28-
## 1. Setup docker environment
28+
## 1. Setup Docker environment
2929

30-
Nothing special, just follow the [official documentation](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)
30+
Nothing special, just follow the [official documentation](https://docs.docker.com/engine/install/) to install Docker on your machine based on your OS.
3131

32-
## 2. Create docker build image
32+
## 2. Create Docker build image
3333

34-
Go to the supported OS directory, for example Rocky Linux 9
34+
Go to the supported OS directory, for example Rocky Linux 8:
3535

36-
`cd devops/deploy/docker/build/rocky8/`
36+
```bash
37+
cd devops/deploy/docker/build/rocky8/
38+
```
3739

38-
And build image
40+
And build image:
3941

40-
`docker build -t cloudberry-db-env . `
42+
```bash
43+
docker build -t apache-cloudberry-env .
44+
```
4145

4246
The whole process usually takes about 5 minutes. You can use the created base image as many times as you want, just launch a new container for your specific task.
4347

4448
## 3. Launch container
4549

46-
Just run
50+
Launch the container in detached mode with a long-running process:
4751

48-
`docker run -h cdw -it cloudberry-db-env`
52+
```bash
53+
docker run -h cdw -d --name cloudberry-build apache-cloudberry-env bash -c "/tmp/init_system.sh && tail -f /dev/null"
54+
```
55+
56+
> [!NOTE]
57+
> The container will be named `cloudberry-build` and run in the background for easy reference in subsequent commands.
58+
> If you need to:
59+
> - access the container interactively, use `docker exec -it cloudberry-build bash`
60+
> - check if the container is running, use `docker ps`
4961
5062
## 4. Checkout git repo inside container
5163

5264
The same way you did it on your laptop
5365

54-
`docker exec <container ID> bash -c "cd /home/gpadmin && git clone --recurse-submodules https://github.com/apache/cloudberry.git"`
66+
```bash
67+
docker exec cloudberry-build bash -c "cd /home/gpadmin && git clone --recurse-submodules --branch main --depth 1 https://github.com/apache/cloudberry.git"
68+
```
5569

56-
## 5. Set envoronment and configure build container
70+
## 5. Set environment and configure build container
5771

58-
Create direcory for store logs
72+
Create direcory for store logs:
5973

60-
`SRC_DIR=/home/gpadmin/cloudberry && docker exec <container ID> bash -c "mkdir ${SRC_DIR}/build-logs"`
74+
```bash
75+
SRC_DIR=/home/gpadmin/cloudberry && docker exec cloudberry-build bash -c "mkdir ${SRC_DIR}/build-logs"
76+
```
6177

62-
Execute configure and check if system is ready for build
78+
Execute configure and check if system is ready for build:
6379

64-
`SRC_DIR=/home/gpadmin/cloudberry && docker exec <container ID> bash -c "cd ${SRC_DIR} && SRC_DIR=${SRC_DIR} ./devops/build/automation/cloudberry/scripts/configure-cloudberry.sh"`
80+
```bash
81+
SRC_DIR=/home/gpadmin/cloudberry && docker exec cloudberry-build bash -c "cd ${SRC_DIR} && SRC_DIR=${SRC_DIR} ./devops/build/automation/cloudberry/scripts/configure-cloudberry.sh"
82+
```
6583

66-
## 6. Build binary
84+
## 6. Build and install binary
6785

68-
The building consumes all available CPU resources and can take minutes to complete
86+
The building consumes all available CPU resources and can take minutes to complete:
6987

70-
`SRC_DIR=/home/gpadmin/cloudberry && docker exec <container ID> bash -c "cd ${SRC_DIR} && SRC_DIR=${SRC_DIR} ./devops/build/automation/cloudberry/scripts/build-cloudberry.sh"`
88+
```bash
89+
SRC_DIR=/home/gpadmin/cloudberry && docker exec cloudberry-build bash -c "cd ${SRC_DIR} && SRC_DIR=${SRC_DIR} ./devops/build/automation/cloudberry/scripts/build-cloudberry.sh"
90+
```
7191

7292
## 7. Install binary and create demo cluster
7393

74-
By default `make install` copy compiled binary to `/usr/local/cloudberry-db`
75-
76-
`SRC_DIR=/home/gpadmin/cloudberry && docker exec <container ID> bash -c "cd ${SRC_DIR} && SRC_DIR=${SRC_DIR} make install"`
77-
78-
To create demo cluster just launch `create-cloudberry-demo-cluster.sh`
94+
The build script above has already installed the binaries to `/usr/local/cloudberry-db` inside the container. Now create the demo cluster just launch `create-cloudberry-demo-cluster.sh`
7995

80-
`SRC_DIR=/home/gpadmin/cloudberry && docker exec <container ID> bash -c "cd ${SRC_DIR} && SRC_DIR=${SRC_DIR} ./devops/build/automation/cloudberry/scripts/create-cloudberry-demo-cluster.sh"`
96+
```bash
97+
SRC_DIR=/home/gpadmin/cloudberry && docker exec cloudberry-build bash -c "cd ${SRC_DIR} && SRC_DIR=${SRC_DIR} ./devops/build/automation/cloudberry/scripts/create-cloudberry-demo-cluster.sh"
98+
```
8199

82100
## 8. Execute test query
83101

84-
Now you could set environment and execute queries
102+
Now you could set environment and execute queries:
85103

86-
`docker exec 7197206b0645 bash -c "source /usr/local/cloudberry-db/cloudberry-env.sh && source /home/gpadmin/cloudberry/gpAux/gpdemo/gpdemo-env.sh && psql -U gpadmin -d postgres -c 'SELECT 42'"`
104+
```bash
105+
docker exec cloudberry-build bash -c "source /usr/local/cloudberry-db/cloudberry-env.sh && source /home/gpadmin/cloudberry/gpAux/gpdemo/gpdemo-env.sh && psql -U gpadmin -d postgres -c 'SELECT 42'"
106+
```
87107

88108
All done!

devops/build/packaging/rpm/apache-cloudberry-db-incubating.spec

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Summary: High-performance, open-source data warehouse based on PostgreSQL
3939

4040
License: ASL 2.0
4141
URL: https://cloudberry.apache.org
42-
Vendor: Apache Cloudberry (incubating)
42+
Vendor: Apache Cloudberry (Incubating)
4343
Group: Applications/Databases
4444
Prefix: %{cloudberry_install_dir}
4545

@@ -107,7 +107,7 @@ Requires: xz
107107

108108
%description
109109

110-
Apache Cloudberry (incubating) is an advanced, open-source, massively
110+
Apache Cloudberry (Incubating) is an advanced, open-source, massively
111111
parallel processing (MPP) data warehouse developed from PostgreSQL and
112112
Greenplum. It is designed for high-performance analytics on
113113
large-scale data sets, offering powerful analytical capabilities and
@@ -125,7 +125,7 @@ Apache Cloudberry supports both batch processing and real-time data
125125
warehousing, making it a versatile solution for modern data
126126
environments.
127127

128-
Apache Cloudberry (incubating) is an effort undergoing incubation at
128+
Apache Cloudberry (Incubating) is an effort undergoing incubation at
129129
the Apache Software Foundation (ASF), sponsored by the Apache
130130
Incubator PMC.
131131

devops/build/packaging/rpm/apache-cloudberry-hll-incubating.spec

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,18 @@
2121
Name: apache-cloudberry-hll-incubating
2222
Version: 2.18.0
2323
Release: %{?release}%{!?release:1}
24-
Summary: HyperLogLog extension for Cloudberry Database %{cloudberry_version}
24+
Summary: HyperLogLog extension for Apache Cloudberry %{cloudberry_version}
2525
License: ASL 2.0
2626
URL: https://github.com/citusdata/postgresql-hll
27-
Vendor: Apache Cloudberry (incubating)
27+
Vendor: Apache Cloudberry (Incubating)
2828
Group: Applications/Databases
2929
BuildArch: x86_64
3030
Requires: apache-cloudberry-db-incubating >= %{cloudberry_version}
3131
Prefix: %{cloudberry_install_dir}
3232

3333
%description
3434
HLL is an open-source PostgreSQL extension (compatible with Apache
35-
Cloudberry (incubating) %{cloudberry_version}) adding HyperLogLog data
35+
Cloudberry (Incubating) %{cloudberry_version}) adding HyperLogLog data
3636
structures as a native data type. HyperLogLog is a fixed-size,
3737
set-like structure used for distinct value counting with tunable
3838
precision.
@@ -59,10 +59,10 @@ cp -R %{cloudberry_install_dir}/share/postgresql/extension/hll* \
5959
%{prefix}/share/postgresql/extension/hll.control
6060

6161
%post
62-
echo "HLL extension for Cloudberry Database %{cloudberry_version} has been installed in %{prefix}."
62+
echo "HLL extension for Apache Cloudberry %{cloudberry_version} has been installed in %{prefix}."
6363
echo "To enable it in a database, run:"
6464
echo " CREATE EXTENSION hll;"
6565

6666
%postun
67-
echo "HLL extension for Cloudberry Database %{cloudberry_version} has been removed from %{prefix}."
67+
echo "HLL extension for Apache Cloudberry %{cloudberry_version} has been removed from %{prefix}."
6868
echo "You may need to manually clean up any database objects that were using the extension."

devops/build/packaging/rpm/apache-cloudberry-pgvector-incubating.spec

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
Name: cloudberry-pgvector
2323
Version: %{pgvector_version}
2424
Release: %{?release}%{!?release:1}
25-
Summary: pgvector extension for Cloudberry Database %{cloudberry_version}
25+
Summary: pgvector extension for Apache Cloudberry %{cloudberry_version}
2626
License: PostgreSQL
2727
URL: https://github.com/pgvector/pgvector
2828
Vendor: Cloudberry Open Source
@@ -33,7 +33,7 @@ Prefix: %{cloudberry_install_dir}
3333

3434
%description
3535
pgvector is an open-source vector similarity search extension for
36-
PostgreSQL and Cloudberry Database %{cloudberry_version}. It provides
36+
PostgreSQL and Apache Cloudberry %{cloudberry_version}. It provides
3737
vector data types and vector similarity search functions, allowing for
3838
efficient similarity search operations on high-dimensional data.
3939

@@ -61,10 +61,10 @@ cp -R %{cloudberry_install_dir}/share/postgresql/extension/vector* \
6161
%{prefix}/share/postgresql/extension/vector.control
6262

6363
%post
64-
echo "pgvector extension version %{version} for Cloudberry Database %{cloudberry_version} has been installed in %{prefix}."
64+
echo "pgvector extension version %{version} for Apache Cloudberry %{cloudberry_version} has been installed in %{prefix}."
6565
echo "To enable it in a database, run:"
6666
echo " CREATE EXTENSION vector;"
6767

6868
%postun
69-
echo "pgvector extension version %{version} for Cloudberry Database %{cloudberry_version} has been removed from %{prefix}."
69+
echo "pgvector extension version %{version} for Apache Cloudberry %{cloudberry_version} has been removed from %{prefix}."
7070
echo "You may need to manually clean up any database objects that were using the extension."

devops/build/packaging/rpm/cloudberry-dev-repo.spec

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,26 @@
1818
Name: cloudberry-dev-repo
1919
Version: 1.0
2020
Release: 1%{?dist}
21-
Summary: Cloudberry Database Repository Configuration
21+
Summary: Apache Cloudberry Repository Configuration
2222
License: ASL 2.0
2323
Group: Applications/Databases
2424
URL: https://cloudberrydb.org
2525
Vendor: Cloudberry Open Source
2626
BuildArch: noarch
2727

2828
%description
29-
This package configures the Cloudberry Database repository on your
30-
system. Cloudberry Database is an open-source project aimed at
29+
This package configures the Apache Cloudberry repository on your
30+
system. Apache Cloudberry is an open-source project aimed at
3131
providing a scalable, high-performance SQL database for
3232
analytics. This repository provides access to the latest RPM packages
33-
for Cloudberry Database, allowing you to easily install and stay
33+
for Apache Cloudberry, allowing you to easily install and stay
3434
up-to-date with the latest developments.
3535

3636
%install
3737
mkdir -p %{buildroot}%{_sysconfdir}/yum.repos.d/
3838
cat > %{buildroot}%{_sysconfdir}/yum.repos.d/cloudberry-dev.repo <<EOF
3939
[cloudberry-dev]
40-
name=Cloudberry Database Repository
40+
name=Apache Cloudberry Repository
4141
baseurl=https://cloudberry-rpm-dev-bucket.s3.amazonaws.com/repo/el%{rhel}/x86_64/
4242
enabled=1
4343
gpgcheck=1

devops/deploy/docker/build/rocky8/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#
1919
# --------------------------------------------------------------------
2020
#
21-
# Apache Cloudberry (incubating) is an effort undergoing incubation at
21+
# Apache Cloudberry (Incubating) is an effort undergoing incubation at
2222
# the Apache Software Foundation (ASF), sponsored by the Apache
2323
# Incubator PMC.
2424
#

devops/deploy/docker/build/rocky9/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#
1919
# --------------------------------------------------------------------
2020
#
21-
# Apache Cloudberry (incubating) is an effort undergoing incubation at
21+
# Apache Cloudberry (Incubating) is an effort undergoing incubation at
2222
# the Apache Software Foundation (ASF), sponsored by the Apache
2323
# Incubator PMC.
2424
#

devops/deploy/docker/test/rocky8/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
#
1919
# --------------------------------------------------------------------
2020
#
21-
# Apache Cloudberry (incubating) is an effort undergoing incubation at
21+
# Apache Cloudberry (Incubating) is an effort undergoing incubation at
2222
# the Apache Software Foundation (ASF), sponsored by the Apache
2323
# Incubator PMC.
2424
#

devops/deploy/docker/test/rocky8/configs/gpinitsystem.conf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717
# permissions and limitations under the License.
1818
#
1919
# --------------------------------------------------------------------
20-
# gpinitsystem Configuration File for Cloudberry Database
20+
# gpinitsystem Configuration File for Apache Cloudberry
2121
# --------------------------------------------------------------------
22-
# This configuration file is used to initialize a Cloudberry Database
22+
# This configuration file is used to initialize a Apache Cloudberry
2323
# cluster. It defines the settings for the coordinator, primary segments,
2424
# and mirrors, as well as other important configuration options.
2525
# --------------------------------------------------------------------

0 commit comments

Comments
 (0)