bitnamicharts/appsmith

Bitnami Appsmith 软件包

Appsmith 是一个开源平台，用于构建和维护内部工具，例如自定义仪表板、管理面板或 CRUD 应用。

Appsmith 概述

商标说明：本软件列表由 Bitnami 打包。所提及的相关商标归各自公司所有，使用这些商标并不意味着任何关联或背书。

TL;DR

console
helm install my-release oci://registry-1.docker.io/bitnamicharts/appsmith

如需在生产环境使用 Appsmith，可尝试 VMware Tanzu Application Catalog，即 Bitnami 目录的商业版。

⚠️ 重要通知：Bitnami 目录即将变更

自 2025 年 8 月 28 日起，Bitnami 将升级其公共目录，在新的 Bitnami Secure Images 计划下提供精选的强化、安全聚焦镜像集。作为此次过渡的一部分：

• 首次向社区用户开放热门容器镜像的安全优化版本访问权限。
• Bitnami 将开始在免费层级中弃用对非强化、基于 Debian 的软件镜像的支持，并将逐步从公共目录中移除非最新标签。因此，社区用户将只能访问数量减少的强化镜像，这些镜像仅以“latest”标签发布，适用于开发目的。
• 自 8 月 28 日起，在两周内，所有现有容器镜像（包括旧版本或特定版本标签，如 2.50.0、10.6）将从公共目录（docker.io/bitnami）迁移至“Bitnami Legacy”仓库（docker.io/bitnamilegacy），且不再接收更新。
• 对于生产工作负载和长期支持，建议用户采用 Bitnami Secure Images，包括强化容器、更小的***面、CVE 透明度（通过 VEX/KEV）、SBOM 以及企业支持。

这些变更旨在通过推广软件供应链完整性和最新部署的最佳实践，提升所有 Bitnami 用户的安全态势。更多详情，请访问 https://github.com/bitnami/containers/issues/83267%E3%80%82

介绍

Bitnami Charts for Helm 经过精心设计、积极维护，是在 Kubernetes 集群上部署容器的最快、最简单方式，可直接用于处理生产工作负载。

本 Chart 使用 Helm 包管理器在 Kubernetes 集群中引导 Appsmith 部署。

前提条件

• Kubernetes 1.23+
• Helm 3.8.0+
• 底层基础设施支持 PV 供应器
• 用于部署扩展的 ReadWriteMany 卷

安装 Chart

要使用发布名称 my-release 安装 Chart：

console
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/appsmith

注意：需将占位符 REGISTRY_NAME 和 REPOSITORY_NAME 替换为 Helm Chart 仓库和存储库的引用。例如，对于 Bitnami，需使用 REGISTRY_NAME=registry-1.docker.io 和 REPOSITORY_NAME=bitnamicharts。

该命令使用默认配置在 Kubernetes 集群上部署 Appsmith。参数 部分列出了安装过程中可配置的参数。

提示：使用 helm list 列出所有发布版本

配置和安装详情

资源请求和限制

Bitnami Charts 允许为 Chart 部署中的所有容器设置资源请求和限制。这些设置位于 resources 值中（参见参数表）。为生产工作负载设置请求至关重要，应根据具体使用场景进行调整。

为简化此过程，Chart 包含 resourcesPreset 值，可根据不同预设自动设置 resources 部分。查看 https://github.com/bitnami/charts/blob/main/bitnami/common/templates/_resources.tpl#L15 中的这些预设。但在生产工作负载中，不建议使用 resourcesPreset，因为它可能无法完全适应具体需求。有关容器资源管理的更多信息，请参阅 Kubernetes 官方文档。

滚动标签与不可变标签

强烈建议在生产环境中使用不可变标签。这可确保即使相同标签更新为不同镜像，部署也不会自动更改。

如果主容器有新版本、重大变更或严重漏洞，Bitnami 将发布新 Chart 更新其容器。

更新凭据

Bitnami Charts 在首次启动时配置凭据。后续对密钥或凭据的任何更改都需要手动干预。请按照以下说明操作：

• 按照 上游文档 更新用户密码
• 使用新值更新密码密钥（替换 SECRET_NAME、PASSWORD、ENCRYPTION_SALT 和 ENCRYPTION_PASSWORD 占位符）

shell
kubectl create secret generic SECRET_NAME --from-literal=admin-password=PASSWORD --from-literal=encryption-salt=ENCRYPTION_SALT --from-literal=encryption-password=ENCRYPTION_PASSWORD --dry-run -o yaml | kubectl apply -f -

外部数据库支持

您可能希望 Appsmith 连接到外部数据库，而不是在集群内安装数据库。典型原因包括使用托管数据库服务，或为所有应用共享公共数据库服务器。为此，Chart 允许通过 externalDatabase 参数 指定外部数据库凭据。还应使用 mongodb.enabled 选项禁用 MongoDB 安装。示例如下：

console
mongodb.enabled=false
externalDatabase.hosts=[]
externalDatabase.user=myuser
externalDatabase.password=mypassword
externalDatabase.database=mydatabase
externalDatabase.port=27017

外部 Redis 支持

您可能希望 Appsmith 连接到外部 Redis，而不是在集群内安装 Redis。典型原因包括使用托管 Redis 服务，或为所有应用共享公共 Redis 服务器。为此，Chart 允许通过相关参数指定外部 Redis 凭据。还应使用 redis.enabled 选项禁用 Redis 安装。示例如下：

console
redis.enabled=false
externalRedis.host=myexternalhost
externalRedis.password=mypassword
externalRedis.port=6379

Ingress

本 Chart 支持 Ingress 资源。如果集群上安装了 Ingress 控制器（如 https://github.com/bitnami/charts/tree/main/bitnami/nginx-ingress-controller 或 https://github.com/bitnami/charts/tree/main/bitnami/contour%EF%BC%89%EF%BC%8C%E5%8F%AF%E5%88%A9%E7%94%A8 Ingress 控制器提供应用服务。要启用 Ingress 集成，需将 client.ingress.enabled 设置为 true。

最常见的场景是将一个主机名映射到部署。此时，可使用 client.ingress.hostname 属性设置主机名。client.ingress.tls 参数可用于为此主机添加 TLS 配置。

不过，也可以有多个主机。为此，可将 client.ingress.extraHosts 参数（如可用）设置为包含主机名的数组。client.ingress.extraTLS 参数（如可用）也可用于为额外主机添加 TLS 配置。

注意：对于 client.ingress.extraHosts 参数中指定的每个主机，需设置名称、路径以及 Ingress 控制器应了解的任何注解。并非所有注解都受所有 Ingress 控制器支持，但 https://github.com/kubernetes/ingress-nginx/blob/master/docs/user-guide/nginx-configuration/annotations.md 列出了许多流行 Ingress 控制器支持的注解。

添加 TLS 参数（如可用）将使 Chart 生成 HTTPS URL，应用将在端口 443 上可用。TLS 密钥不一定需要由此 Chart 生成。但是，如果启用了 TLS，则 Ingress 记录在 TLS 密钥存在之前无法工作。

了解更多关于 Ingress 控制器的信息。

使用 TLS 保护流量

本 Chart 便于创建用于 Ingress 控制器的 TLS 密钥（尽管这不是强制性的）。有几种常见用例：

• 基于 Chart 参数生成证书密钥。
• 启用外部生成的证书。
• 通过外部服务（如 https://github.com/jetstack/cert-manager/%EF%BC%89%E7%AE%A1%E7%90%86%E5%BA%94%E7%94%A8%E8%AF%81%E4%B9%A6%E3%80%82
• 在 Chart 内创建自签名证书（如支持）。

在前两种情况下，需要证书和密钥。文件应为 .pem 格式。

以下是证书文件示例：

注意：如果存在证书链，可能有多个证书。

text
-----BEGIN CERTIFICATE-----
MIID6TCCAtGgAwIBAgIJAIaCwivkeB5EMA0GCSqGSIb3DQEBCwUAMFYxCzAJBgNV
...
jScrvkiBO65F46KioCL9h5tDvomdU1aqpI/CBzhvZn1c0ZTf87tGQR8NK7v7
-----END CERTIFICATE-----

以下是证书密钥示例：

text
-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAvLYcyu8f3skuRyUgeeNpeDvYBCDcgq+LsWap6zbX5f8oLqp4
...
wrj2wDbCDCFmfqnSJ+dKI3vFLlEz44sAV8jX/kd4Y6ZTQhlLbYc=
-----END RSA PRIVATE KEY-----

• 如果使用 Helm 基于参数管理证书，将这些值复制到给定 *.ingress.secrets 条目的 certificate 和 key 值中。
• 如果单独管理 TLS 密钥，需创建名称为 INGRESS_HOSTNAME-tls 的 TLS 密钥（其中 INGRESS_HOSTNAME 是占位符，需替换为使用 *.ingress.hostname 参数设置的主机名）。
• 如果集群有 https://github.com/jetstack/cert-manager 插件用于自动管理和颁发 TLS 证书，需将 相应注解 添加到 *.ingress.annotations 中。
• 如果使用 Helm 创建的自签名证书，需将 *.ingress.tls 和 *.ingress.selfSigned 都设置为 true。

额外环境变量

如需添加额外环境变量（用于高级操作，如自定义初始化脚本），可在 client、backend 和 rts 部分使用 extraEnvVars 属性。

yaml
appsmith:
  backend:
    extraEnvVars:
      - name: LOG_LEVEL
        value: error

或者，可使用包含环境变量的 ConfigMap 或 Secret。为此，在 client、backend 和 rts 部分使用 extraEnvVarsCM 或 extraEnvVarsSecret 值。

Sidecars

如果 Appsmith 所在的同一个 Pod 中需要额外容器（如额外指标或日志导出器），可在 client、backend 和 rts 部分使用 sidecars 参数定义。

yaml
sidecars:
- name: your-image-name
  image: your-image
  imagePullPolicy: Always
  ports:
  - name: portname
    containerPort: 1234

如果这些 sidecar 导出额外端口，可使用 service.extraPorts 参数（如可用）添加额外端口定义，如下例所示：

yaml
service:
  extraPorts:
  - name: extraPort
    port: 11311
    targetPort: 11311

注意：此 Helm Chart 已包含 Prometheus 导出器的 sidecar 容器（如适用）。可在部署时添加 --enable-metrics=true 参数激活它们。因此，sidecars 参数应仅用于额外的 sidecar 容器。

如果同一个 Pod 中需要额外的 init 容器，可使用 initContainers 参数定义。示例如下：

yaml
initContainers:
  - name: your-image-name
    image: your-image
    imagePullPolicy: Always
    ports:
      - name: portname
        containerPort: 1234

了解更多关于 sidecar 容器 和 init 容器 的信息。

Pod 亲和性

本 Chart 允许使用 affinity 参数设置自定义亲和性。有关 Pod 亲和性的更多信息，请参阅 Kubernetes 文档。

作为替代方案，可使用 https://github.com/bitnami/charts/tree/main/bitnami/common#affinities Chart 中提供的 Pod 亲和性、Pod 反亲和性和节点亲和性预设配置。为此，在 client、backend 和 rts 部分设置 podAffinityPreset、podAntiAffinityPreset 或 nodeAffinityPreset 参数。

备份和恢复

要在 Kubernetes 上备份和恢复 Helm Chart 部署，需使用 Velero（Kubernetes 备份/恢复工具）备份源部署的持久卷，并将其附加到新部署。在 本指南 中查找使用 Velero 的说明。

持久化

https://github.com/bitnami/containers/tree/main/bitnami/appsmith 镜像将 appsmith 数据和配置存储在容器的 /bitnami 路径下。持久卷声明用于跨部署保留数据。已知在 GCE、AWS 和 minikube 中可正常工作。

参数

全局参数

通用参数