JingsongLi commented on code in PR #1824: URL: https://github.com/apache/incubator-paimon/pull/1824#discussion_r1306997201
########## docs/content/engines/quick_start.md: ########## @@ -0,0 +1,332 @@ +--- +title: "Quick Start" +weight: 5 +type: docs +aliases: +- /engines/quick_start.html +--- +<!-- +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. +--> + + +# Quick Start +This document describes how to use Docker and Docker Compose +to quickly build a big data environment such as Paimon and +the big data engine Flink/Spark. +You can see more runtime information between Paimon and +Flink/Spark by looking at the corresponding section in the +documentation. + +The following steps have been tested on a Windows 11 laptop +with docker desktop and docker compose installed. + +## Prerequisites +windows/Linux/MacOS + +docker desktop for windows/Applicable to the docker of the corresponding system + +docker compose + +## Quick start paimon and flink + +Look at the version mapping between paimon and Flink +in the [Engines/Flink](https://paimon.apache.org/docs/master/engines/flink/) section of the document and select +the version you want. + +### Docker compose + +docker compose is a convenient way to manage docker containers and quickly build the application environment +you need. The following docker compose file is composed of three services, jobmanager, taskmanager and sql-client +, using the flink:1.17.1-scala_2.12 image. + +Copy the following into a ```flink_docker_compose.yml``` file. + +> Notice: +> +> The /tmp path in the container is mapped to the local./tmp path so that multiple containers can share a file system path. The reason is because the 'warehouse'='file:/tmp/paimon' option is configured when the catalog is created. If you use another path as the warehouse address, modify the volumes option in the docker compose file simultaneously. + +```shell + +version: "2.2" +services: + jobmanager: + image: flink:1.17.1-scala_2.12 + ports: + - "8081:8081" + command: jobmanager + user: flink + environment: + - | + FLINK_PROPERTIES= + jobmanager.rpc.address: jobmanager + networks: + - flink-network + volumes: + - ./custom_jars/flink-shaded-hadoop-2-uber-2.8.3-10.0.jar:/opt/flink/lib/flink-shaded-hadoop-2-uber-2.8.3-10.0.jar + - ./custom_jars/paimon-flink-1.17-0.5-20230815.001819-123.jar:/opt/flink/lib/paimon-flink-1.17-0.5-20230815.001819-123.jar Review Comment: Can here be `paimon-flink-1.17-{{< version >}}.jar`? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
