Script to package up Kafka Connect connector for submission to Confluent Marketplace (neé Confluent Hub) #15113
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # 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. | ||
| # | ||
| # Builds and repackages the connector for Confluent Hub submission. | ||
| # Usage: dev/confluent-hub-package.sh [TAG] | ||
| # TAG: git tag to build (default: latest tag) | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| ORIGINAL_DIR="$(pwd)" | ||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
| PROJECT_ROOT="$(dirname "$SCRIPT_DIR")" | ||
| CONNECT_RUNTIME_DIR="${PROJECT_ROOT}/kafka-connect/kafka-connect-runtime" | ||
|
|
||
| # Return to original directory on exit | ||
| trap "cd '${ORIGINAL_DIR}'" EXIT | ||
|
|
||
| # Determine tag | ||
| if [[ -n "${1:-}" ]]; then | ||
| TAG="$1" | ||
| else | ||
| git fetch --tags 2>/dev/null || true | ||
| TAG=$(git describe --tags "$(git rev-list --tags --max-count=1)") | ||
| echo "Using latest tag: $TAG" | ||
| fi | ||
|
|
||
| git checkout "$TAG" | ||
|
|
||
| # Extract version from tag (apache-iceberg-X.Y.Z -> X.Y.Z) | ||
| VERSION="${TAG#apache-iceberg-}" | ||
|
|
||
| # Create version.txt to override gradle's SNAPSHOT versioning | ||
| echo "$VERSION" > "${PROJECT_ROOT}/version.txt" | ||
| trap "rm -f '${PROJECT_ROOT}/version.txt'; cd '${ORIGINAL_DIR}'" EXIT | ||
|
|
||
| # Build (clean first to remove old artifacts) | ||
| "${PROJECT_ROOT}/gradlew" clean :iceberg-kafka-connect:iceberg-kafka-connect-runtime:distZip \ | ||
| -x test -x integrationTest --quiet | ||
|
|
||
| # Extract | ||
| DIST_DIR="${CONNECT_RUNTIME_DIR}/build/distributions" | ||
| MAIN_ZIP="${DIST_DIR}/iceberg-kafka-connect-runtime-${VERSION}.zip" | ||
| [[ -f "${MAIN_ZIP}" ]] || { echo "Distribution not found: ${MAIN_ZIP}"; exit 1; } | ||
| PACKAGE_NAME="apache-iceberg-kafka-connect-${VERSION}" | ||
| WORK_DIR="${CONNECT_RUNTIME_DIR}/build/confluent-hub-work" | ||
|
|
||
| rm -rf "${WORK_DIR}" | ||
| mkdir -p "${WORK_DIR}" | ||
| unzip -q "${MAIN_ZIP}" -d "${WORK_DIR}" | ||
| mv "${WORK_DIR}/iceberg-kafka-connect-runtime-${VERSION}" "${WORK_DIR}/${PACKAGE_NAME}" | ||
| PKG="${WORK_DIR}/${PACKAGE_NAME}" | ||
|
|
||
| # Update manifest owner | ||
| sed -i.bak 's/"username": "iceberg"/"username": "apache"/' "${PKG}/manifest.json" | ||
| rm -f "${PKG}/manifest.json.bak" | ||
|
|
||
| # Add README | ||
| cat > "${PKG}/doc/README.md" << EOF | ||
| <!-- | ||
| - 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. | ||
| --> | ||
|
|
||
| # Apache Iceberg Sink Connector | ||
|
|
||
| A Kafka Connect sink connector for writing data from Apache Kafka into Apache Iceberg tables. | ||
|
|
||
| Documentation: https://iceberg.apache.org/docs/latest/kafka-connect/ | ||
|
|
||
| License: Apache License 2.0 | ||
| EOF | ||
|
|
||
| # Add example config | ||
| mkdir -p "${PKG}/etc" | ||
| cat > "${PKG}/etc/iceberg-sink.properties.example" << 'EOF' | ||
| # 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. | ||
|
|
||
| # Iceberg Sink Connector - Example Configuration | ||
| # https://iceberg.apache.org/docs/latest/kafka-connect/ | ||
| name=iceberg-sink | ||
| connector.class=org.apache.iceberg.connect.IcebergSinkConnector | ||
| tasks.max=1 | ||
| topics=events | ||
| iceberg.tables=db.table_name | ||
| iceberg.catalog.type=rest | ||
| iceberg.catalog.uri=https://your-catalog-uri | ||
| iceberg.catalog.warehouse=your-warehouse | ||
| EOF | ||
|
|
||
| # Add logo | ||
| mkdir -p "${PKG}/assets" | ||
| cp "${CONNECT_RUNTIME_DIR}/src/main/resources/iceberg.png" "${PKG}/assets/" | ||
|
|
||
| # Security scan | ||
| docker run --rm -v "${PKG}:/scan:ro" aquasec/trivy rootfs --severity HIGH,CRITICAL /scan | ||
|
|
||
| # Create archive | ||
| OUTPUT="${DIST_DIR}/${PACKAGE_NAME}.zip" | ||
| (cd "${WORK_DIR}" && zip -rq "${OUTPUT}" "${PACKAGE_NAME}") | ||
| rm -rf "${WORK_DIR}" | ||
|
|
||
| echo "Created: ${OUTPUT}" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| #!/usr/bin/env bash | ||
| # | ||
| # 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. | ||
| # | ||
| # Builds and repackages the connector for Confluent Hub submission. | ||
| # Usage: ./confluent-hub-package.sh [TAG] | ||
| # TAG: git tag to build (default: latest tag) | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" | ||
|
rmoff marked this conversation as resolved.
|
||
| PROJECT_ROOT="${SCRIPT_DIR}/../.." | ||
|
|
||
| # Determine tag | ||
| git fetch --tags 2>/dev/null || true | ||
|
rmoff marked this conversation as resolved.
|
||
| if [[ -n "${1:-}" ]]; then | ||
| TAG="$1" | ||
| else | ||
| TAG=$(git describe --tags "$(git rev-list --tags --max-count=1)") | ||
| echo "Using latest tag: $TAG" | ||
| fi | ||
|
|
||
| git checkout "$TAG" | ||
|
|
||
| # Extract version from tag (apache-iceberg-X.Y.Z -> X.Y.Z) | ||
| VERSION="${TAG#apache-iceberg-}" | ||
|
|
||
| # Create version.txt to override gradle's SNAPSHOT versioning | ||
| echo "$VERSION" > "${PROJECT_ROOT}/version.txt" | ||
| trap "rm -f '${PROJECT_ROOT}/version.txt'" EXIT | ||
|
|
||
| # Build (clean first to remove old artifacts) | ||
| "${PROJECT_ROOT}/gradlew" clean :iceberg-kafka-connect:iceberg-kafka-connect-runtime:distZip \ | ||
| -x test -x integrationTest --quiet | ||
|
|
||
| # Extract | ||
| DIST_DIR="${SCRIPT_DIR}/build/distributions" | ||
| MAIN_ZIP="${DIST_DIR}/iceberg-kafka-connect-runtime-${VERSION}.zip" | ||
| [[ -f "${MAIN_ZIP}" ]] || { echo "Distribution not found: ${MAIN_ZIP}"; exit 1; } | ||
| PACKAGE_NAME="apache-iceberg-kafka-connect-${VERSION}" | ||
| WORK_DIR="${SCRIPT_DIR}/build/confluent-hub-work" | ||
|
|
||
| rm -rf "${WORK_DIR}" | ||
| mkdir -p "${WORK_DIR}" | ||
| unzip -q "${MAIN_ZIP}" -d "${WORK_DIR}" | ||
| mv "${WORK_DIR}/iceberg-kafka-connect-runtime-${VERSION}" "${WORK_DIR}/${PACKAGE_NAME}" | ||
| PKG="${WORK_DIR}/${PACKAGE_NAME}" | ||
|
|
||
| # Update manifest owner | ||
| sed -i.bak 's/"username": "iceberg"/"username": "apache"/' "${PKG}/manifest.json" | ||
| rm -f "${PKG}/manifest.json.bak" | ||
|
|
||
| # Add README | ||
| cat > "${PKG}/doc/README.md" << EOF | ||
| # Apache Iceberg Sink Connector | ||
|
Member
There was a problem hiding this comment. Minor note here, I'm not sure we can get away with not including the Apache License header here. Theoretically this is now a file we are distributing so I think it needs the full header like our normal github readme has. |
||
|
|
||
| A Kafka Connect sink connector for writing data from Apache Kafka into Apache Iceberg tables. | ||
|
|
||
| Documentation: https://iceberg.apache.org/docs/${VERSION}/kafka-connect/ | ||
|
|
||
| License: Apache License 2.0 | ||
| EOF | ||
|
|
||
|
Member
There was a problem hiding this comment. Same license comment here |
||
| # Add example config | ||
| mkdir -p "${PKG}/etc" | ||
| cat > "${PKG}/etc/iceberg-sink.properties.example" << 'EOF' | ||
| # Iceberg Sink Connector - Example Configuration | ||
| # https://iceberg.apache.org/docs/latest/kafka-connect/ | ||
| name=iceberg-sink | ||
| connector.class=org.apache.iceberg.connect.IcebergSinkConnector | ||
| tasks.max=1 | ||
| topics=events | ||
| iceberg.tables=db.table_name | ||
| iceberg.catalog.type=rest | ||
| iceberg.catalog.uri=https://your-catalog-uri | ||
| iceberg.catalog.warehouse=your-warehouse | ||
| EOF | ||
|
|
||
| # Add logo | ||
| mkdir -p "${PKG}/assets" | ||
| cp "${SCRIPT_DIR}/src/main/resources/iceberg.png" "${PKG}/assets/" | ||
|
|
||
| # Security scan | ||
| docker run --rm -v "${PKG}:/scan:ro" aquasec/trivy rootfs --severity HIGH,CRITICAL /scan | ||
|
|
||
| # Create archive | ||
| OUTPUT="${DIST_DIR}/${PACKAGE_NAME}.zip" | ||
| (cd "${WORK_DIR}" && zip -rq "${OUTPUT}" "${PACKAGE_NAME}") | ||
| rm -rf "${WORK_DIR}" | ||
|
|
||
| echo "Created: ${OUTPUT}" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wondering if this should be placed in the
devfolder where other build scripts lives. release manager usually runs the script of the root of the project asdev/some.sh. Also might be easier to discover.not sure what others think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good point, moved 35483df
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a little confused because it looks like we have two copies now. I not sure if this is something we want in the
devfolder though. I'm not clear on the timing of this, but I don't think this is something you would run as part of building the release, but rather after the vote succeeded.Do we intend to publish RCs?