apache/seatunnel

[Docs] Improve Kubernetes documentation with managed platform deployment guides

Open

#10927 opened on May 21, 2026

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Java (6,897 stars) (1,432 forks)batch import
good first issuehelp wanted

Description

Motivation

SeaTunnel users increasingly run workloads on Kubernetes, including managed Kubernetes services provided by different cloud vendors. It would be helpful to enrich the Kubernetes documentation so users can more easily deploy, configure, operate, and troubleshoot SeaTunnel in these environments.

Proposed documentation improvements

Add or expand Kubernetes-related documentation covering:

  • A clear end-to-end deployment guide for running SeaTunnel on Kubernetes.
  • Recommended configuration patterns for ConfigMap, Secret, ServiceAccount, RBAC, resource requests/limits, and environment variables.
  • Connector/plugin management in Kubernetes environments, including how to package or mount connector dependencies.
  • Networking and service exposure guidance for common deployment modes.
  • Storage and state-related considerations, such as checkpoint/state paths, persistent volumes, and object storage integration where applicable.
  • Observability and troubleshooting guidance, including logs, metrics, common startup failures, permission issues, image/plugin loading issues, and job submission failures.
  • Production-readiness notes such as image versioning, upgrade strategy, high availability, and resource planning.

Managed Kubernetes platforms to consider

The documentation could include vendor-specific notes or examples for major Kubernetes platforms, for example:

  • Amazon EKS
  • Google Kubernetes Engine (GKE)
  • Azure Kubernetes Service (AKS)
  • Alibaba Cloud Container Service for Kubernetes (ACK)
  • Tencent Kubernetes Engine (TKE)
  • Huawei Cloud CCE
  • Volcengine VKE
  • Red Hat OpenShift

The goal does not need to be a full separate guide for every platform at first. A cloud-neutral guide plus concise platform-specific differences, prerequisites, and known caveats would already be very valuable.

Expected benefit

This would lower the adoption barrier for users running SeaTunnel in cloud-native environments and reduce repeated deployment/troubleshooting questions around Kubernetes.

Contributor guide

Tech stack
kubernetes
Domain
documentationdevopscloud
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Kubernetes knowledgeFamiliarity with SeaTunnelAccess to a Kubernetes cluster
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Start by reviewing the existing Kubernetes documentation in the SeaTunnel docs directory. Then create a cloud neutral end to end deployment guide. For each managed platform (EKS, GKE, AKS, etc.), add platform specific notes under a separate section. Ensure to cover ConfigMap, Secret, RBAC, resource limits, and observability. Refer to issue #10927 for full scope.