This is an automated email from the ASF dual-hosted git repository.
djwang pushed a commit to branch sync-with-upstream
in repository https://gitbox.apache.org/repos/asf/cloudberry-gpbackup.git
The following commit(s) were added to refs/heads/sync-with-upstream by this
push:
new d1059fe3 Update basic community files for repo
d1059fe3 is described below
commit d1059fe38156176ca8137567d3ae6f697c929054
Author: Dianjin Wang <wangdian...@gmail.com>
AuthorDate: Wed Sep 24 11:58:48 2025 +0800
Update basic community files for repo
---
.asf.yaml | 76 ++++++++++++
.github/ISSUE_TEMPLATE/bug-report.yml | 83 +++++++++++++
.github/workflows/build_and_unit_test.yml | 7 +-
CODE-OF-CONDUCT.md | 105 ++++------------
CONTRIBUTING.md | 80 +++++-------
LICENSE | 44 +++++++
NOTICE | 18 +--
README.md | 196 ++++++++++++++++--------------
SECURITY.md | 156 +++++++-----------------
gppkg/gpbackup_tools.spec.in | 10 +-
gppkg/gppkg_v2_spec.yml.in | 2 +-
11 files changed, 426 insertions(+), 351 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
new file mode 100644
index 00000000..9a377230
--- /dev/null
+++ b/.asf.yaml
@@ -0,0 +1,76 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+github:
+ description: Backup Utility for Apache Cloudberry (Incubating)
+ homepage: https://cloudberry.apache.org
+ labels:
+ - mpp
+ - big-data
+ - data-warehouse
+ - data-analysis
+ - olap
+ - distributed-database
+ - database
+ - postgres
+ - postgresql
+ - greenplum
+ - cloudberry
+ - backup
+ features:
+ # Enable wiki for documentation
+ wiki: false
+ # Enable issues management
+ issues: true
+ # Enable projects for project management boards
+ projects: false
+ enabled_merge_buttons:
+ # enable squash button:
+ squash: true
+ # disable merge button:
+ merge: false
+ # enable rebase button:
+ rebase: true
+ protected_branches:
+ main:
+ required_status_checks:
+ # strict means "Require branches to be up to date before merging".
+ strict: true
+ # contexts are the names of checks that must pass.
+ contexts:
+ - build_and_unit_test
+ required_pull_request_reviews:
+ dismiss_stale_reviews: false
+ required_approving_review_count: 1
+ # squash or rebase must be allowed in the repo for this setting to be
set to true.
+ required_linear_history: true
+
+ required_signatures: false
+
+ # requires all conversations to be resolved before merging is possible
+ required_conversation_resolution: true
+ del_branch_on_merge: true
+ dependabot_alerts: true
+ dependabot_updates: false
+ protected_tags:
+ - "v*.*.*"
+ - "[0-9]*.*"
+notifications:
+ commits: commits@cloudberry.apache.org
+ issues: commits@cloudberry.apache.org
+ pullrequests: commits@cloudberry.apache.org
+ pullrequests_bot_dependabot: priv...@cloudberry.apache.org
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml
b/.github/ISSUE_TEMPLATE/bug-report.yml
new file mode 100644
index 00000000..69f612eb
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,83 @@
+# --------------------------------------------------------------------
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed
+# with this work for additional information regarding copyright
+# ownership. The ASF licenses this file to You under the Apache
+# License, Version 2.0 (the "License"); you may not use this file
+# except in compliance with the License. You may obtain a copy of the
+# License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# permissions and limitations under the License.
+#
+# --------------------------------------------------------------------
+
+name: "\U0001F41B Bug Report"
+description: Problems and issues with code in cloudberry-backup for Apache
Cloudberry.
+title: "[Bug] "
+labels: ["type: Bug"]
+body:
+ - type: markdown
+ attributes:
+ value: "Thank you for reporting the problem! We really appreciate your
efforts to improve Apache Cloudberry. Before reporting it, please (ideally)
test on the latest release or main to see if the issue is fixed."
+ - type: textarea
+ attributes:
+ label: Apache Cloudberry and cloudberry-backup version
+ description: What version are you using?
+ - type: textarea
+ attributes:
+ label: What happened
+ description: Describe what happened.
+ placeholder: >
+ Please provide the context in which the problem occurred and explain
what happened
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: What you think should happen instead
+ description: What do you think went wrong?
+ placeholder: >
+ Please explain why you think the behavior is erroneous. It is
extremely helpful if you copy&paste the fragment of logs showing the exact
error messages or wrong behavior. If you can provide some screenshots or
videos, you can include files by dragging and dropping them here.
+ - type: textarea
+ attributes:
+ label: How to reproduce
+ description: >
+ What should we do to reproduce the problem? Any SQL commands or
operations?
+ placeholder: >
+ Please make sure you provide a reproducible step-by-step case of how
to reproduce the problem as minimally and precisely as possible. Remember that
non-reproducible issues will be closed! Opening a discussion is recommended as
a first step.
+ - type: input
+ attributes:
+ label: Operating System
+ description: What Operating System are you using?
+ placeholder: "You can get it via `cat /etc/os-release` for example"
+ - type: textarea
+ attributes:
+ label: Anything else
+ description: Anything else we need to know?
+ placeholder: >
+ How often does this problem occur? (Once? Every time? Only when
certain conditions are met?) Any relevant logs to include? Put them here.
+ - type: checkboxes
+ attributes:
+ label: Are you willing to submit PR?
+ description: >
+ This is absolutely not required, but we are happy to guide you in the
contribution process, especially if you already understand how to implement the
fix.
+ options:
+ - label: Yes, I am willing to submit a PR!
+ - type: checkboxes
+ attributes:
+ label: Code of Conduct
+ description: The Code of Conduct helps create a safe space for everyone.
We require that everyone agrees to it.
+ options:
+ - label: >
+ I agree to follow this project's
+ [Code of
Conduct](https://github.com/apache/cloudberry/blob/main/CODE_OF_CONDUCT.md).
+ required: true
+ - type: markdown
+ attributes:
+ value: "Thanks for completing our form!"
\ No newline at end of file
diff --git a/.github/workflows/build_and_unit_test.yml
b/.github/workflows/build_and_unit_test.yml
index d3015de7..28f69ecc 100644
--- a/.github/workflows/build_and_unit_test.yml
+++ b/.github/workflows/build_and_unit_test.yml
@@ -2,17 +2,18 @@ name: build_and_unit_test
on:
push:
- branches: [ master ]
+ branches: [ main ]
pull_request:
- branches: [ master ]
+ branches: [ main ]
types: [ opened, synchronize, reopened, edited, ready_for_review ]
+ workflow_dispatch:
jobs:
build_and_unit_test:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v4
with:
fetch-depth: 0
path: go/src/github.com/apache/cloudberry-backup
diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md
index 69290a9f..aa80fc58 100644
--- a/CODE-OF-CONDUCT.md
+++ b/CODE-OF-CONDUCT.md
@@ -1,78 +1,27 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in the
-Greenplum Database Backup project and our community a harassment-free
-experience for everyone, regardless of age, body size, disability,
-ethnicity, sex characteristics, gender identity and expression, level
-of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an
appointed
-representative at an online or offline event. Representation of a project may
be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at oss-...@vmware.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an
incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4,
-available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
-
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# Code of Conduct
+
+Apache Cloudberry (Incubating) follows the ASF [Code of
+Conduct](https://www.apache.org/foundation/policies/conduct).
+
+If you observe behavior that violates those rules please follow the
+[ASF reporting
+guidelines](https://www.apache.org/foundation/policies/conduct#reporting-guidelines).
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5f0cae00..1dc77ca6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,62 +1,42 @@
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
# Contributing
-We warmly welcome and greatly appreciate contributions from the
-community. By participating you agree to the [code of
-conduct](https://github.com/apache/cloudberry-gpbackup/blob/main/CODE-OF-CONDUCT.md).
-Overall, we follow GPDB's comprehensive contribution policy. Please
-refer to it [here](https://github.com/greenplum-db/gpdb#contributing)
-for details.
+Everyone who participates in Cloudberry, either as a user or a contributor, is
obliged to follow the [Code of Conduct](./CODE-OF-CONDUCT.md).
## Getting Started
-* Sign our [Contributor License
Agreement](https://cla.vmware.com/cla/1/preview)
-* Fork the gpbackup repository on GitHub
-* Run `go get github.com/apache/cloudberry-gpbackup/...` and add your fork as
a remote
+To get started, follow these steps:
+* Fork the `cloudberry-backup` repository on GitHub
+* Run `go get github.com/apache/cloudberry-backup/...` and add your fork as a
remote
* Run `make depend` to install required dependencies
* Follow the README to set up your environment and run the tests
## Creating a change
-* Create your own feature branch (e.g. `git checkout -b
- gpbackup_branch`) and make changes on this branch.
-* Try and follow similar coding styles as found throughout the code
- base.
+* Create your own feature branch (e.g. `git checkout -b new_branch`) and make
changes on this branch.
+* Try and follow similar coding styles as found throughout the codebase.
* Make commits as logical units for ease of reviewing.
* Rebase with main often to stay in sync with upstream.
-* Add new tests to cover your code. We use
- [Ginkgo](http://onsi.github.io/ginkgo/) and
- [Gomega](https://onsi.github.io/gomega/) for testing.
-* Ensure a well written commit message as explained
- [here](https://chris.beams.io/posts/git-commit/).
-* Run `make format`, `make test`, and `make end_to_end` in your
- feature branch and ensure they are successful.
-* Push your local branch to the fork (e.g. `git push <your_fork>
- gpbackup_branch`)
-
-## Submitting a Pull Request
-
-* Create a [pull request from your
-
fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).
-* Address PR feedback with fixup and/or squash commits:
-```
-git add .
-git commit --fixup <commit SHA>
- -- or --
-git commit --squash <commit SHA>
-```
-* Once approved, before merging into main squash your fixups with:
-```
-git rebase -i --autosquash origin/main
-git push --force-with-lease $USER <my-feature-branch>
-```
-
-Your contribution will be analyzed for product fit and engineering
-quality prior to merging. Your pull request is much more likely to be
-accepted if it is small and focused with a clear message that conveys
-the intent of your change.
-
-## Community
-
-Connect with Greenplum on:
-* [Slack](https://greenplum.slack.com/)
-* [Dev Google Group mailing
list](https://groups.google.com/a/greenplum.org/forum/#!forum/gpdb-dev/join)
+* Add new tests to cover your code. We use
[Ginkgo](http://onsi.github.io/ginkgo/) and
[Gomega](https://onsi.github.io/gomega/) for testing.
+* Ensure a well written commit message as explained
[here](https://chris.beams.io/posts/git-commit/).
+* Run `make format`, `make test`, and `make end_to_end` in your feature branch
and ensure they are successful.
+* Push your local branch to the fork (e.g. `git push <your_fork>
backup_branch`)
+* Create a Pull Request from your fork
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
index d9a10c0d..a5a1387e 100644
--- a/LICENSE
+++ b/LICENSE
@@ -174,3 +174,47 @@
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+================================================================================
+This product includes software from Greenplum Database Backup, under Apache
2.0 license:
+
+ Greenplum Database Backup
+
+Copyright 2017-Present VMware, Inc. or its affiliates. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
\ No newline at end of file
diff --git a/NOTICE b/NOTICE
index 949eac52..173b7c01 100644
--- a/NOTICE
+++ b/NOTICE
@@ -1,15 +1,5 @@
-Greenplum Database Backup
+Apache Cloudberry (Incubating)
+Copyright 2024-2025 The Apache Software Foundation
-Copyright 2017-Present VMware, Inc. or its affiliates. All Rights Reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
diff --git a/README.md b/README.md
index b8cb1b16..41782a09 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,51 @@
-# Greenplum Backup
-
-`gpbackup` and `gprestore` are Go utilities for performing Apache Cloudberry
backups. They are still currently in active development.
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+# Backup Utility for Apache Cloudberry (Incubating)
+
+[](https://communityinviter.com/apps/cloudberrydb/welcome)
+[](https://twitter.com/cloudberrydb)
+[](https://cloudberry.apache.org)
+
+---
+
+`gpbackup` and `gprestore` are Go utilities for performing Greenplum database
+backups, which are originally developed by the Greenplum Database team. This
+repo is a fork of gpbackup, dedicated to supporting Cloudberry.
## Pre-Requisites
-The project requires the Go Programming language version 1.11 or higher.
Follow the directions [here](https://golang.org/doc/) for installation, usage
and configuration instructions.
-The project also has a dependency on `sqlite3`. This is installed by default
on many platforms, but you must install it on your system if it is not present.
+The project requires the Go Programming language version 1.11 or higher.
+Follow the directions [here](https://golang.org/doc/) for installation, usage
+and configuration instructions. Make sure to set the [Go PATH environment
+variable](https://go.dev/doc/install) before starting the following steps.
+
+## Download & Build
-## Downloading
+1. Downloading the latest version:
```bash
-go get github.com/apache/cloudberry-gpbackup/...
+go install github.com/apache/cloudberry-backup@latest
```
-This will place the code in `$GOPATH/github.com/apache/cloudberry-gpbackup`.
+This will place the code in
`$GOPATH/pkg/mod/github.com/apache/cloudberry-backup`.
-## Building and installing binaries
+2. Building and installing binaries
Make the `gpbackup` directory your current working directory and run:
@@ -24,120 +54,92 @@ make depend
make build
```
-The `build` target will put the `gpbackup` and `gprestore` binaries in
`$HOME/go/bin`.
-
-This will also attempt to copy `gpbackup_helper` to the greenplum segments
(retrieving hostnames from `gp_segment_configuration`). Pay attention to the
output as it will indicate whether this operation was successful.
+The `build` target will put the `gpbackup` and `gprestore` binaries in
+`$HOME/go/bin`. This will also attempt to copy `gpbackup_helper` to the
+Cloudberry segments (retrieving hostnames from `gp_segment_configuration`).
+Pay attention to the output as it will indicate whether this operation was
+successful.
`make build_linux` is for cross compiling on macOS, and the target is Linux.
`make install` will scp the `gpbackup_helper` binary (used with
-single-data-file flag) to all hosts
+## Running the utilities
+
+The basic command for gpbackup is
+```bash
+gpbackup --dbname <your_db_name>
+```
+
+The basic command for gprestore is
+```bash
+gprestore --timestamp <YYYYMMDDHHMMSS>
+```
+
+Run `--help` with either command for a complete list of options.
+
## Validation and code quality
### Test setup
-Required for Greenplum Database 6 or higher, several tests require the
`dummy_seclabel` Greenplum contrib module. This module exists only to support
regression testing of the SECURITY LABEL statement. It is not intended to be
used in production. Use the following commands to install the module.
+Required for Cloudberry 1.0+, several tests require the
+`dummy_seclabel` Cloudberry contrib module. This module exists only to
+support regression testing of the SECURITY LABEL statement. It is not
+intended to be used in production. Use the following commands to
+install the module.
```bash
-pushd $(find ~/workspace/gpdb -name dummy_seclabel)
+pushd $(find ~/workspace/cloudberry -name dummy_seclabel)
make install
gpconfig -c shared_preload_libraries -v dummy_seclabel
gpstop -ra
gpconfig -s shared_preload_libraries | grep dummy_seclabel
popd
-
```
### Test execution
-**NOTE**: The integration and end_to_end tests require a running Apache
Cloudberry instance.
+**NOTE**: The integration and end_to_end tests require a running Cloudberry
instance.
-To run all tests except end-to-end (linters, unit, and integration), use
-```bash
-make test
-```
-To run only unit tests, use
-```bash
-make unit
-```
-To run only integration tests
-```bash
-make integration
-```
-Integration test requirements
- - Running GPDB instance
- - GPDB's gpcloud extension
-```bash
-make -C gpcontrib/gpcloud/ install
-```
- - GPDB configured with `--with-perl`
+* To run all tests except end-to-end (linters, unit, and integration), use
`make test`.
+* To run only unit tests, use `make unit`.
+* To run only integration tests (requires a running Cloudberry instance), use
`make integration`.
+* To run end to end tests (requires a running Cloudberry instance), use `make
end_to_end`.
-To run end to end tests (requires a running GPDB instance), use
-```bash
-make end_to_end
-```
-
-**We provide the following targets to help developers ensure their code fits
Go standard formatting guidelines.**
+We provide the following targets to help developers ensure their code fits
+Go standard formatting guidelines:
-To run a linting tool that checks for basic coding errors, use
-```bash
-make lint
-```
+* To run a linting tool that checks for basic coding errors, use: `make lint`.
This target runs [gometalinter](https://github.com/alecthomas/gometalinter).
-
Note: The lint target will fail if code is not formatted properly.
+* To automatically format your code and add/remove imports, use `make format`.
+This target runs
+[goimports](https://godoc.org/golang.org/x/tools/cmd/goimports) and
+[gofmt](https://golang.org/cmd/gofmt/). We will only accept code that has been
+formatted using this target or an equivalent `gofmt` call.
-To automatically format your code and add/remove imports, use
-```bash
-make format
-```
-This target runs
[goimports](https://godoc.org/golang.org/x/tools/cmd/goimports) and
[gofmt](https://golang.org/cmd/gofmt/).
-We will only accept code that has been formatted using this target or an
equivalent `gofmt` call.
-
-## Running the utilities
-
-The basic command for gpbackup is
-```bash
-gpbackup --dbname <your_db_name>
-```
-
-The basic command for gprestore is
-```bash
-gprestore --timestamp <YYYYMMDDHHMMSS>
-```
-
-Run `--help` with either command for a complete list of options.
-
-## Cleaning up
-
-To remove the compiled binaries and other generated files, run
-```bash
-make clean
-```
-
-# More Information
+### Cleaning up
-The Greenplum Backup
[wiki](https://github.com/apache/cloudberry-gpbackup/wiki) for this project has
several articles providing a more in-depth explanation of certain aspects of
gpbackup and gprestore.
+To remove the compiled binaries and other generated files, run `make clean`.
-# How to Contribute
+## Code Formatting
-See [CONTRIBUTING.md
file](https://github.com/apache/cloudberry-gpbackup/blob/master/CONTRIBUTING.md).
+We use `goimports` to format go code. See
+https://godoc.org/golang.org/x/tools/cmd/goimports The following command
+formats the gpbackup codebase excluding the vendor directory and also lists
+the files updated.
-# Code Formatting
-
-We use `goimports` to format go code. See
https://godoc.org/golang.org/x/tools/cmd/goimports
-The following command formats the gpbackup codebase excluding the vendor
directory and also lists the files updated.
```bash
goimports -w -l $(find . -type f -name '*.go' -not -path "./vendor/*")
```
-# Troubleshooting
+## Troubleshooting
-## Dummy Security Label module is not installed or configured
+1. Dummy Security Label module is not installed or configured
-If you see errors in many integration tests (below), review the
-Validation and code quality [Test setup](#Test setup) section above:
+If you see errors in many integration tests (below), review the Validation and
+code quality [Test setup](##Test setup) section above:
```
SECURITY LABEL FOR dummy ON TYPE public.testtype IS 'unclassified';
@@ -148,11 +150,11 @@ SECURITY LABEL FOR dummy ON TYPE public.testtype IS
'unclassified';
Message: "security label provider \"dummy\" is not loaded",
```
-## Tablespace already exists
+2. Tablespace already exists
-If you see errors indicating the `test_tablespace` tablespace already
-exists (below), execute `psql postgres -c 'DROP TABLESPACE
-test_tablespace'` to cleanup the environment and rerun the tests.
+If you see errors indicating the `test_tablespace` tablespace already exists
+(below), execute `psql postgres -c 'DROP TABLESPACE test_tablespace'` to
+cleanup the environment and rerun the tests.
```
CREATE TABLESPACE test_tablespace LOCATION '/tmp/test_dir'
@@ -162,3 +164,17 @@ test_tablespace'` to cleanup the environment and rerun the
tests.
Code: "42710",
Message: "tablespace \"test_tablespace\" already exists",
```
+
+## How to Contribute
+
+See [CONTRIBUTING.md file](./CONTRIBUTING.md).
+
+## License
+
+Licensed under Apache License Version 2.0. For more details, please refer to
+the [LICENSE](./LICENSE).
+
+## Acknowledgment
+
+Thanks to all the Greenplum Backup contributors, more details in its [GitHub
+page](https://github.com/greenplum-db/gpbackup-archive).
\ No newline at end of file
diff --git a/SECURITY.md b/SECURITY.md
index fabbb9d2..7cf6bc7d 100644
--- a/SECURITY.md
+++ b/SECURITY.md
@@ -1,125 +1,61 @@
-# Security Release Process
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
-Greenplum Database has adopted this security disclosure and response policy to
-ensure we responsibly handle critical issues.
+ http://www.apache.org/licenses/LICENSE-2.0
-## Reporting a Vulnerability - Private Disclosure Process
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
-Security is of the highest importance and all security vulnerabilities or
-suspected security vulnerabilities should be reported to Greenplum Database
-privately, to minimize attacks against current users of Greenplum Database
-before they are fixed. Vulnerabilities will be investigated and patched on the
-next patch (or minor) release as soon as possible. This information could be
-kept entirely internal to the project.
+# Security Policy
-If you know of a publicly disclosed security vulnerability for Greenplum
-Database, please **IMMEDIATELY** contact the Greenplum Database project team
-(secur...@greenplum.org).
+The Apache Security Team handles all security issues across Apache projects and
+coordinates the response to vulnerabilities. For details on the vulnerability
+handling process, supported versions, and what is considered a security issue,
+visit: https://www.apache.org/security/.
-**IMPORTANT: Do not file public issues on GitHub for security
vulnerabilities!**
+## Do not
-To report a vulnerability or a security-related issue, please contact the email
-address with the details of the vulnerability. The email will be fielded by the
-Greenplum Database project team. Emails will be addressed promptly, including a
-detailed plan to investigate the issue and any potential workarounds to perform
-in the meantime. Do not report non-security-impacting bugs through this
-channel. Use [GitHub issues](https://github.com/greenplum-db/gpdb/issues)
-instead.
+For better collaboration, we hope you:
-## Proposed Email Content
+- DO NOT report non-security-impacting bugs through this channel. If you have
+ any questions on using, development, please use [GitHub
+ Issues](https://github.com/apache/cloudberry/issues),
+ [Discussions](https://github.com/apache/cloudberry/discussions), [Dev mailing
+ list](https://cloudberry.apache.org/community/mailing-lists) or
+ [Slack](https://inviter.co/apache-cloudberry) instead.
+- DO NOT report security issues on public GitHub Issues, Jira tickets, mailing
+ lists, or other public forums.
-Provide a descriptive subject line and in the body of the email include the
-following information:
+## Reporting Security Issues
-* Basic identity information, such as your name and your affiliation or
company.
-* Detailed steps to reproduce the vulnerability (POC scripts, screenshots, and
- logs are all helpful to us).
-* Description of the effects of the vulnerability on Greenplum Database and the
- related hardware and software configurations, so that the Greenplum Database
- project team can reproduce it.
-* How the vulnerability affects Greenplum Database usage and an estimation of
- the attack surface, if there is one.
-* List other projects or dependencies that were used in conjunction with
- Greenplum Database to produce the vulnerability.
+Send your report to: [secur...@apache.org](mailto:secur...@apache.org).
-## When to report a vulnerability
+Please send one plain-text email per vulnerability with the following and
+additional information as necessary (as much as you can provide):
-* When you think Greenplum Database has a potential security vulnerability.
-* When you suspect a potential vulnerability but you are unsure that it impacts
- Greenplum Database.
-* When you know of or suspect a potential vulnerability on another project that
- is used by Greenplum Database.
+- Description of the vulnerability
+- Steps to reproduce
+- Affected versions
+- Potential impact
+- Any known mitigations
+- (Optional) Suggested fix
-## Patch, Release, and Disclosure
+## Public Discussion
-The Greenplum Database project team will respond to vulnerability reports as
-follows:
+For general security questions or discussions, please use the development
+mailing list: [d...@cloudberry.apache.org](mailto:d...@cloudberry.apache.org)
-1. The Greenplum project team will investigate the vulnerability and determine
-its effects and criticality.
-2. If the issue is not deemed to be a vulnerability, the Greenplum project team
-will follow up with a detailed reason for rejection.
-3. The Greenplum project team will initiate a conversation with the reporter
-promptly.
-4. If a vulnerability is acknowledged and the timeline for a fix is determined,
-the Greenplum project team will work on a plan to communicate with the
-appropriate community, including identifying mitigating steps that affected
-users can take to protect themselves until the fix is rolled out.
-5. The Greenplum project team will also create a
-[CVSS](https://www.first.org/cvss/specification-document) using the [CVSS
-Calculator](https://www.first.org/cvss/calculator/3.0). The Greenplum project
-team makes the final call on the calculated CVSS; it is better to move quickly
-than making the CVSS perfect. Issues may also be reported to
-[Mitre](https://cve.mitre.org/) using this [scoring
-calculator](https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator). The CVE will
-initially be set to private.
-6. The Greenplum project team will work on fixing the vulnerability and perform
-internal testing before preparing to roll out the fix.
-7. A public disclosure date is negotiated by the Greenplum Database project
-team, and the bug submitter. We prefer to fully disclose the bug as soon as
-possible once a user mitigation or patch is available. It is reasonable to
-delay disclosure when the bug or the fix is not yet fully understood, or the
-solution is not well-tested. The timeframe for disclosure is from immediate
-(especially if it’s already publicly known) to a few weeks. The Greenplum
-Database project team holds the final say when setting a public disclosure
-date.
-8. Once the fix is confirmed, the Greenplum project team will patch the
-vulnerability in the next patch or minor release, and backport a patch release
-into earlier supported releases as necessary. Upon release of the patched
-version of Greenplum Database, we will follow the **Public Disclosure
-Process**.
+## Preferred Languages
-## Public Disclosure Process
-
-The Greenplum project team publishes a [public
-advisory](https://github.com/greenplum-db/gpdb/security/advisories?state=published)
-to the Greenplum Database community via GitHub. In most cases, additional
-communication via Slack, Twitter, mailing lists, blog and other channels will
-assist in educating Greenplum Database users and rolling out the patched
-release to affected users.
-
-The Greenplum project team will also publish any mitigating steps users can
-take until the fix can be applied to their Greenplum Database instances.
-
-## Mailing lists
-
-* Use secur...@greenplum.org to report security concerns to the Greenplum
- Database project team, who uses the list to privately discuss security issues
- and fixes prior to disclosure.
-
-## Confidentiality, integrity and availability
-
-We consider vulnerabilities leading to the compromise of data confidentiality,
-elevation of privilege, or integrity to be our highest priority concerns.
-Availability, in particular in areas relating to DoS and resource exhaustion,
-is also a serious security concern. The Greenplum Database project team takes
-all vulnerabilities, potential vulnerabilities, and suspected vulnerabilities
-seriously and will investigate them in an urgent and expeditious manner.
-
-Note that we do not currently consider the default settings for Greenplum
-Database to be secure-by-default. It is necessary for operators to explicitly
-configure settings, role based access control, and other resource related
-features in Greenplum Database to provide a hardened Greenplum Database
-environment. We will not act on any security disclosure that relates to a lack
-of safe defaults. Over time, we will work towards improved safe-by-default
-configuration, taking into account backwards compatibility.
+We prefer all communications to be in English.
\ No newline at end of file
diff --git a/gppkg/gpbackup_tools.spec.in b/gppkg/gpbackup_tools.spec.in
index 5aa88e16..cefa5382 100644
--- a/gppkg/gpbackup_tools.spec.in
+++ b/gppkg/gpbackup_tools.spec.in
@@ -1,8 +1,8 @@
Name: gpbackup_tools_%{operating_system}
Version: %{rpm_version}
Release: 1
-Summary: Backup and restore utilities for Greenplum
-License: VMware General Terms
+Summary: Backup and restore utilities for Cloudberry
+License: Apache License 2.0
Source0: bin_gpbackup.tar.gz
BuildArch: x86_64
Prefix: /usr/local
@@ -11,19 +11,19 @@ Prefix: /usr/local
AutoReqProv: no
%description
-Backup and restore utilities for Greenplum
+Backup and restore utilities for Cloudberry
%prep
%setup -c -q -T -D -a 0
%install
mkdir -p $RPM_BUILD_ROOT%{prefix}/bin $RPM_BUILD_ROOT%{prefix}/lib
-cp open_source_licenses_VMware_Greenplum_Backup_and_Restore.txt
$RPM_BUILD_ROOT%{prefix}/
+
cp bin/gpbackup bin/gprestore bin/gpbackup_helper bin/gpbackup_manager
bin/gpbackup_ddboost_plugin bin/gpbackup_s3_plugin $RPM_BUILD_ROOT%{prefix}/bin
cp lib/libDDBoost.so $RPM_BUILD_ROOT%{prefix}/lib
%files
-%{prefix}/open_source_licenses_VMware_Greenplum_Backup_and_Restore.txt
+
%{prefix}/bin/gpbackup
%{prefix}/bin/gprestore
%{prefix}/bin/gpbackup_helper
diff --git a/gppkg/gppkg_v2_spec.yml.in b/gppkg/gppkg_v2_spec.yml.in
index eae0d1c9..dce7dd4b 100644
--- a/gppkg/gppkg_v2_spec.yml.in
+++ b/gppkg/gppkg_v2_spec.yml.in
@@ -1,4 +1,4 @@
-Pkgname: greenplum_backup_restore
+Pkgname: cloudberry_backup_restore
Format: V2
Architecture: ${ARCH}
OS: ${OS}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cloudberry.apache.org
For additional commands, e-mail: commits-h...@cloudberry.apache.org
