配置说明
参数文件
此 Helm Chart 使用参数的方式较为特殊,这里使用了字典合并的方式处理(父 Chart).Values.global
和(子 Chart).Values
参数,即所有参数均声明在.Values.global
下(global 参数和子 Chart 参数)。
注意:尽管如此,依然存在个别子 Chart 的参数配置方式使用了常规的映射方式,但是这并不在用户自定义修改的范围内。
详细说明
注意:所有可调整参数均位于 global 下。以下并未列出所有可配置参数,仅列出了此应用主要配置参数,对于一些默认资源类配置忽略。
常规说明
Chart范围 | 参数名 | 类型 | 默认值 | 用途 |
---|---|---|---|---|
global | imagePullSecret | list | Null | 指定镜像使用的私有镜像仓库的 docker-registry 凭据。 |
pdb.create | dict | true | 是否创建 Pod Disruption Budget 保持应用可用性。 | |
pdb.minAvailable | dict | 1 | 指定同一类型 pod 的最小可用数量。 | |
pdb.maxUnavailable | dict | 0 | 指定同一类型 pod 的最大不可用数量。 | |
global.ingress | enable | dict | true | 是否启用 ingress。 |
className | dict | nginx | 因为某些特殊需要,默认内置了 ingress-nginx。 | |
hosts | dict | example.com | 访问应用所要使用域名的父域名,通常为二级域名,应用启动后可以通过安装后提示以及 ingress 资源查看具体的访问域名。 | |
service.type | dict | NodePort | 可选值 NodePort 或者 LoadBalancer。此处是一个锚点引用,勿改动锚点。 | |
service.nodePorts.http | dict | 30080 | 用于 ingress-nginx 向外暴露的80端口,如果是 LoadBalancer 此参数不生效,默认 80。 | |
service.nodePorts.https | dict | 30443 | 用于 ingress-nginx 向外暴露的443端口,如果是 LoadBalancer 此参数不生效,默认 443。 | |
service.nodePorts.tcp.[number] | dict | 2222 | 用于 ingress-nginx 向外暴露的22端口,如果是 LoadBalancer 应修改键值为22:32222 。 | |
tls.enabled | dict | false | 控制是否启用 ingess TLS 加密访问。 | |
tls.verify | dict | false | 控制 ingress 代理请求时是否验证与上游服务器的 SSL 证书。 | |
tls.autoGenerated | dict | false | 是否自动生成证书(自签证书),参数暂未生效(会在下一个版本中添加)。 | |
tls.caSecretName | dict | Null | 使用自定义 CA 证书创建的 Secret 名字。 | |
tls.secretName | dict | Null | 使用自定义 CA 证书签发证书创建的 Secret 名字。 | |
annotations | dict | Null | 其他注解。 | |
global.server | replicas | dict | 1 | 设置 server pod 副本数,默认数量为 1。 |
image.repository | dict | opencsg-registry.cn-beijing.cr.aliyuncs.com/opencsg_public/csghub_server | csghub_server 镜像URL。 | |
image.tag | dict | vN.N.N | 镜像版本号。 | |
image.pullPolicy | dict | IfNotPresent | 镜像拉取策略。 | |
image.pullSecret | list | Null | 拉取私有镜像仓库所要使用的Secret凭据。优先级高于 global.imagePullSecret。 | |
service.type | dict | ClusterIP | 服务类型。 | |
service.port | dict | 8080 | 暴露的服务端口。 | |
postgresql.host | dict | Null | 指定使用外部数据库的地址。仅 global.postgresql.enabled=false时有效。 | |
postgresql.port | dict | Null | 指定使用外部数据库的端口。仅 global.postgresql.enabled=false时有效。 | |
postgresql.user | dict | Null | 指定使用外部数据库的用户名。仅 global.postgresql.enabled=false时有效。 | |
postgresql.password | dict | Null | 指定使用外部数据库的密码。仅 global.postgresql.enabled=false时有效。 | |
postgresql.database | dict | Null | 指定使用外部数据库的数据库名。仅 global.postgresql.enabled=false时有效。 | |
postgresql.timezone | dict | Null | 指定使用外部数据库的时区(可选)。仅 global.postgresql.enabled=false时有效。 | |
objectStorage.endpoint | dict | Null | 指定外部对象存储的 endpoint。仅 global.minio.enabled=false时有效。 | |
objectStorage.accessKey | dict | Null | 指定外部对象存储的 accessKey。仅 global.minio.enabled=false时有效。 | |
objectStorage.accessSecret | dict | Null | 指定外部对象存储的 accessSecret。仅 global.minio.enabled=false时有效。 | |
objectStorage.bucket | dict | Null | 指定外部对象存储的存储桶。仅 global.minio.enabled=false时有效。 | |
objectStorage.region | dict | Null | 指定外部对象存储的地理位置。仅 global.minio.enabled=false时有效。 | |
timezone | dict | Asia/Shanghai | 服务启动默认使用的时区。 | |
global.portal | replicas | dict | 1 | 作用同上。 |
image{} | dict | / | 作用同上。 | |
postgresql{} | dict | / | 作用同上。 | |
objectStorage{} | dict | / | 作用同上。 | |
global.runner | replicas | dict | 1 | 作用同上。 |
image{} | dict | / | 作用同上。 | |
namespace | dict | space | space应用所属的 kubernetes namespace。 | |
service{} | dict | / | 作用同上。 | |
kubeConfig.secretName | dict | kube-configs | 包含一个或多个目标集群 .kube/config* 文件的 Secret。 | |
global.proxy | replicas | dict | 1 | 作用同上。 |
image{} | dict | / | 作用同上。 | |
service{} | dict | / | 作用同上。 | |
global.builder | replicas | dict | 1 | 作用同上。 |
image{} | dict | / | 作用同上。 | |
service{} | dict | / | 作用同上。 | |
internal[n].domain | dict | app.internal | 指定目标集群 Knative Serving 所要使用的内部域名。 | |
internal[n].service.host | dict | Null | 指定目标集群 Knative Serving 所要使用 Kourier 网络组件的对外访问地址。 | |
internal[n].service.port | dict | Null | 指定目标集群 Knative Serving 所要使用 Kourier 网络组件的对外访问端口。 | |
redis.host | dict | Null | 指定使用外部 Redis 的主机。 | |
redis.port | dict | Null | 指定使用外部 Redis 的端口。 | |
redis.password | dict | Null | 指定使用外部 Redis 的密码。 | |
registry.repository | dict | Null | 指定使用外置 Registry 仓库的地址。例如:docker.io | |
registry.namesace | dict | Null | 指定使用外置 Registry 仓库的命名空间。例如:csghub, 和以上参数合并后即为 docker.io/csghub | |
registry.username | dict | Null | 指定使用外置 Registry 仓库的用户名。 | |
registry.password | dict | Null | 指定使用外置 Registry 仓库的密码。 | |
securityContext.runAsUser | dict | 0 | 以 root 管理员用户权限运行此Pod。请保持默认。 | |
securityContext.runAsGroup | dict | 0 | 以 root 管理员用户权限运行此Pod。请保持默认。 | |
securityContext.fsGroup | dict | 0 | 以 root 管理员用户权限运行此Pod。请保持默认。 | |
podSecurityContext.privileged | dict | true | 以 root 管理员用户权限运行此Pod。请保持默认。 | |
podSecurityContext.allowPrivilegeEscalation | dict | true | 以 root 管理员用户权限运行此Pod。请保持默认。 | |
podSecurityContext.readOnlyRootFilesystem | dict | false | 关闭只读文件系统。请保持默认。 | |
persistence.storageClass | dict | Null | 目前仅 StatefulSet 资源配置了申请 PVC,如果您的集群没有默认的 storageClass,请通过此参数指定所要使用的 storageClass 类型。 | |
persistence.accessMode | dict | ReadWriteOnce | 持久化存储的访问方式。 | |
global.gitea | image{} | dict | / | 作用同上。 |
service{} | dict | / | 作用同上。 | |
authentication.username | dict | gitea | 指定 gitea 的默认管理员用户。 | |
authentication.password | dict | Null | 随机生成管理员用户的密码。 | |
authentication.email | dict | gitea@example.com | 指定管理员用户的邮箱。(暂无实际意义) | |
postgresql{} | dict | Null | 指定存储 Gitea 元数据的外置 PostgreSQL。默认使用内置 PostgreSQL。 | |
objectStorage{} | dict | Null | 指定 Gitea 存储 LFS 文件所要使用的对象存储。默认使用内置 Minio。 | |
smtp.enabled | dict | false | 配置 gitea 是否启用 smtp。 | |
smtp.from | dict | Null | 指定 smtp 发件人标识。 | |
smtp.host | dict | Null | 指定 smtp 发件服务器。 | |
smtp.port | dict | Null | 指定 smtp 发件服务器端口。 | |
smtp.user | dict | Null | 指定 smtp 发件用户名。 | |
smtp.password | dict | Null | 指定 smtp 发件用户密码。 | |
persistence{} | dict | Null | 作用同上。 | |
global.postgresql | enabled | dict | true | 是否启用内置 postgresql。 |
image{} | dict | Null | 作用同上。 | |
service{} | dict | Null | 作用同上。 | |
database | list | csghub_portal csghub_server gitea casdoor | 默认创建的数据库。 | |
persistence{} | dict | Null | 作用同上。 | |
global.redis | enabled | dict | true | 是否启用内置 redis。 |
image{} | dict | Null | 作用同上。 | |
service{} | dict | Null | 作用同上。 | |
persistence{} | dict | Null | 作用同上。 | |
global.minio | enabled | dict | true | 是否启用内置 redis。 |
image{} | dict | Null | 作用同上。 | |
service.type | dict | ClusterIP | 指定服务类型。 | |
service.ports.api | dict | 9000 | Minio API访问端口 | |
service.ports.console | dict | 9001 | Minio 页面控制台访问端口 | |
buckets | list | csghub-portal csghub-server csghub-git | 默认创建的存储桶。 | |
region | dict | cn-north-1 | Minio默认标识的地区。 | |
authentication.username | dict | minio | Minio 默认管理员密码。 | |
authentication。password | dict | Null | Minio 默认管理员密码,默认随机生成。 | |
persistence{} | dict | Null | 作用同上。 | |
global.registry | enabled | dict | true | 是否启用内置的 registry。 |
image{} | dict | Null | 作用同上。 | |
service{} | dict | Null | 作用同上。 | |
namespace | dict | space | 指定默认 registry 使用的命名空间。 | |
authentication.username | dict | registry | Registry 默认管理员。 | |
authentication.password | dict | Null | Registry 默认管理员密码,默认随机生成。 | |
persistence{} | dict | Null | 作用同上。 | |
global.coredns | replicas | dict | 1 | 默认 coredns 副本数量。 |
image{} | dict | Null | 作用同上。 | |
global.nats | image{} | dict | Null | 作用同上。 |
global.account | image{} | dict | Null | 作用同上。 |
global.casdoor | image{} | dict | Null | 作用同上。 |
service{} | dict | Null | 作用同上。 | |
Ingress{} | dict | Null | 作用同上。 | |
global.user | image{} | dict | Null | 作用同上。 |
global.fluent | elasticsearch.host | dict | Null | 指定写入 Elasticsearch 服务器的地址。 |
elasticsearch.port | dict | 9200 | 指定了 Elasticsearch 服务的端口。 | |
elasticsearch.index | dict | Null | 配置了将日志数据存储到 Elasticsearch 中的索引名 csghub 。 | |
补充说明
ingress.hosts
通常情况下此参数需要指定一个可用的二级域名,程序会自动使用如下域名作组件对外访问的域名。
csghub.example.com
主程序域名casdoor.example.com
casdoor 管理页面域名minio.example.com
内置对象存储的