This is an automated email from the ASF dual-hosted git repository.
sxnan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-agents.git
The following commit(s) were added to refs/heads/main by this push:
new d1e8843 [docs] Add a FAQ section for common questions (#192)
d1e8843 is described below
commit d1e8843dd1c20badfa6ba941aa4334b4bd83943c
Author: Eugene <[email protected]>
AuthorDate: Thu Sep 25 12:10:44 2025 +0800
[docs] Add a FAQ section for common questions (#192)
---
docs/content/docs/faq/_index.md | 26 +++++++++++++++++++++
docs/content/docs/faq/faq.md | 52 +++++++++++++++++++++++++++++++++++++++++
2 files changed, 78 insertions(+)
diff --git a/docs/content/docs/faq/_index.md b/docs/content/docs/faq/_index.md
new file mode 100644
index 0000000..316e5c1
--- /dev/null
+++ b/docs/content/docs/faq/_index.md
@@ -0,0 +1,26 @@
+---
+title: FAQ
+icon: <i class="fa fa-comments-o title maindish" aria-hidden="true"></i>
+bold: true
+sectionBreak: true
+bookCollapseSection: true
+weight: 4
+---
+<!--
+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.
+-->
diff --git a/docs/content/docs/faq/faq.md b/docs/content/docs/faq/faq.md
new file mode 100644
index 0000000..ae90333
--- /dev/null
+++ b/docs/content/docs/faq/faq.md
@@ -0,0 +1,52 @@
+---
+title: 'General FAQ'
+weight: 1
+type: docs
+---
+<!--
+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.
+-->
+# General FAQ
+
+This page describes the solutions to some common questions for Flink Agents
users.
+
+## Q1: What are the Python environment considerations when running Flink
Agents jobs?
+
+To ensure stability and compatibility when running Flink Agents jobs, please
be aware of the following Python environment guidelines:
+
+- **Recommended Python versions**: It is advised to use officially supported
Python versions such as Python 3.10 or 3.11. These versions have been
thoroughly tested and offer the best compatibility with Flink Agents.
+
+- **Installation recommendations**:
+ - **For Linux users**: We recommend installing Python via your system
package manager (e.g., using `apt`: `sudo apt install python3`).
+ - **For macOS users**: Use Homebrew to install Python (e.g., `brew install
python`).
+ - **For Windows users**: Download and install the official version from
the [Python website](https://www.python.org/downloads/).
+
+- **Avoid using Python installed via uv**: Currently, it is not recommended to
run Flink Agents jobs with a Python interpreter installed via the `uv` tool, as
this may lead to potential compatibility issues or instability. For example,
you may encounter the following gRPC-related error:
+
+ ```
+ Logging client failed: <_MultiThreadedRendezvous of RPC that terminated
with:
+ status = StatusCode.UNAVAILABLE
+ details = "Socket closed"
+ debug_error_string = "UNKNOWN:Error received from peer
ipv6:%5B::1%5D:58663 {grpc_message:"Socket closed", grpc_status:14}"
+ >... resetting
+ Exception in thread read_grpc_client_inputs:
+ ...
+ py4j.protocol.Py4JError: An error occurred while calling o12.execute
+ ```
+
+ If you see an error like this, switch immediately to one of the officially
recommended installation methods and confirm that you're using a supported
Python version.
