janssenproject/config-api

概述

Janssen配置API的Docker镜像打包，主要用于Janssen授权服务器的配置管理，提供API接口以管理Janssen部署的相关配置信息。

版本

稳定版本请参见https://github.com/JanssenProject/docker-jans-config-api/releases%E3%80%82%E5%AF%B9%E4%BA%8E%E5%89%8D%E6%B2%BF/%E4%B8%8D%E7%A8%B3%E5%AE%9A%E7%89%88%E6%9C%AC%EF%BC%8C%E4%BD%BF%E7%94%A8 janssenproject/config-api。

核心功能和特性

• 支持多种配置后端适配器（Consul、Kubernetes、Google Secret Manager）
• 支持多种密钥管理适配器（Vault、Kubernetes、Google Secret Manager）
• 兼容多种持久化存储类型（LDAP、Couchbase、混合模式）
• 可配置的Java运行参数和日志级别
• 灵活的连接超时和健康检查设置

使用场景和适用范围

适用于Janssen授权服务器部署环境中的配置管理，特别适合需要通过API接口动态管理授权服务器配置的场景，支持容器化部署环境（如Kubernetes）和传统服务器环境。

环境变量配置

容器支持以下环境变量：

配置后端相关

• CN_CONFIG_ADAPTER：配置后端适配器，可选值为consul（默认）或kubernetes。
• CN_CONFIG_CONSUL_HOST：Consul的主机名或IP，默认值为localhost。
• CN_CONFIG_CONSUL_PORT：Consul的端口，默认值为8500。
• CN_CONFIG_CONSUL_CONSISTENCY：Consul一致性模式，可选值为default、consistent或stale，默认值为stale。
• CN_CONFIG_CONSUL_SCHEME：Consul支持的协议，可选http或https。
• CN_CONFIG_CONSUL_VERIFY：是否验证证书，默认值为false。
• CN_CONFIG_CONSUL_CACERT_FILE：Consul CA证书文件路径，默认值为/etc/certs/consul_ca.crt。当CN_CONFIG_CONSUL_VERIFY设为true且该文件存在时使用。
• CN_CONFIG_CONSUL_CERT_FILE：Consul证书文件路径，默认值为/etc/certs/consul_client.crt。
• CN_CONFIG_CONSUL_KEY_FILE：Consul密钥文件路径，默认值为/etc/certs/consul_client.key。
• CN_CONFIG_CONSUL_TOKEN_FILE：包含ACL令牌的文件路径，默认值为/etc/certs/consul_token。
• CN_CONFIG_KUBERNETES_NAMESPACE：Kubernetes命名空间，默认值为default。
• CN_CONFIG_KUBERNETES_CONFIGMAP：Kubernetes配置映射名称，默认值为jans。
• CN_CONFIG_KUBERNETES_USE_KUBE_CONFIG：是否从$HOME/.kube/config加载凭据，仅在非容器环境中有用，默认值为false。
• CN_CONFIG_GOOGLE_SECRET_VERSION_ID：Google Secret Manager中的Janssen配置密钥版本ID，默认值为latest（推荐）。
• CN_CONFIG_GOOGLE_SECRET_NAME_PREFIX：Google Secret Manager中Janssen配置密钥的前缀，默认值为jans。若保持默认，将创建jans-configuration密钥。

密钥管理相关

• CN_SECRET_ADAPTER：密钥适配器，可选值为vault或kubernetes。
• CN_SECRET_VAULT_SCHEME：Vault支持的协议，可选http或https。
• CN_SECRET_VAULT_HOST：Vault的主机名或IP，默认值为localhost。
• CN_SECRET_VAULT_PORT：Vault的端口，默认值为8200。
• CN_SECRET_VAULT_VERIFY：是否验证证书，默认值为false。
• CN_SECRET_VAULT_ROLE_ID_FILE：包含Vault AppRole角色ID的文件路径，默认值为/etc/certs/vault_role_id。
• CN_SECRET_VAULT_SECRET_ID_FILE：包含Vault AppRole密钥ID的文件路径，默认值为/etc/certs/vault_secret_id。
• CN_SECRET_VAULT_CERT_FILE：Vault证书文件路径，默认值为/etc/certs/vault_client.crt。
• CN_SECRET_VAULT_KEY_FILE：Vault密钥文件路径，默认值为/etc/certs/vault_client.key。
• CN_SECRET_VAULT_CACERT_FILE：Vault CA证书文件路径，默认值为/etc/certs/vault_ca.crt。当CN_SECRET_VAULT_VERIFY设为true且该文件存在时使用。
• CN_SECRET_KUBERNETES_NAMESPACE：Kubernetes命名空间，默认值为default。
• CN_SECRET_KUBERNETES_SECRET：Kubernetes密钥名称，默认值为jans。
• CN_SECRET_KUBERNETES_USE_KUBE_CONFIG：是否从$HOME/.kube/config加载凭据，仅在非容器环境中有用，默认值为false。
• CN_SECRET_GOOGLE_SECRET_VERSION_ID：Google Secret Manager中的Janssen密钥版本ID，默认值为latest（推荐）。
• CN_SECRET_GOOGLE_SECRET_MANAGER_PASSPHRASE：Google Secret Manager中Janssen密钥的密码，建议修改，默认值为secret。
• CN_SECRET_GOOGLE_SECRET_NAME_PREFIX：Google Secret Manager中Janssen密钥的前缀，默认值为jans。若保持默认，将创建jans-secret密钥。

启动和健康检查相关

• CN_WAIT_MAX_TIME：启动"健康检查"的最长运行时间，默认值为300秒。
• CN_WAIT_SLEEP_DURATION：启动"健康检查"之间的延迟，默认值为10秒。
• CN_MAX_RAM_PERCENTAGE：传递给Java选项-XX:MaxRAMPercentage的值。

持久化存储相关

• CN_PERSISTENCE_TYPE：使用的持久化后端，可选值为ldap、couchbase或hybrid，默认值为ldap。
• CN_PERSISTENCE_LDAP_MAPPING：指定应保存在LDAP中的数据，可选值为default、user、cache、site或token，默认值为default。仅当CN_PERSISTENCE_TYPE设为hybrid时生效。
• CN_LDAP_URL：LDAP服务器的地址和端口，默认值为localhost:1636；当CN_PERSISTENCE_TYPE设为ldap或hybrid时必填。
• CN_LDAP_USE_SSL：是否使用SSL连接LDAP服务器，默认值为true。
• CN_COUCHBASE_URL：Couchbase服务器的地址，默认值为localhost；当CN_PERSISTENCE_TYPE设为couchbase或hybrid时必填。
• CN_COUCHBASE_USER：Couchbase服务器的用户名，默认值为admin；当CN_PERSISTENCE_TYPE设为couchbase或hybrid时必填。
• CN_COUCHBASE_CERT_FILE：Couchbase根证书位置，默认值为/etc/certs/couchbase.crt；当CN_PERSISTENCE_TYPE设为couchbase或hybrid时必填。
• CN_COUCHBASE_PASSWORD_FILE：包含Couchbase密码的文件路径，默认值为/etc/jans/conf/couchbase_password；当CN_PERSISTENCE_TYPE设为couchbase或hybrid时必填。
• CN_COUCHBASE_CONN_TIMEOUT：打开桶时使用的连接超时，默认值为10000毫秒。
• CN_COUCHBASE_CONN_MAX_WAIT：重试连接前的最长等待时间，默认值为20000毫秒。
• CN_COUCHBASE_SCAN_CONSISTENCY：默认扫描一致性，可选值为not_bounded、request_plus或statement_plus，默认值为not_bounded。
• CN_COUCHBASE_BUCKET_PREFIX：Couchbase桶的前缀，默认值为jans。
• CN_COUCHBASE_TRUSTSTORE_ENABLE：是否为加密Couchbase连接启用信任存储，默认值为true。
• CN_COUCHBASE_KEEPALIVE_INTERVAL：Couchbase连接的保持活动间隔，默认值为30000毫秒。
• CN_COUCHBASE_KEEPALIVE_TIMEOUT：Couchbase连接的保持活动超时，默认值为2500毫秒。

其他配置

• CN_JAVA_OPTIONS：传递给入口点的Java选项，例如-Xmx1024m，默认值为空字符串。
• CN_CONFIG_API_LOG_LEVEL：配置API的日志级别，可选值包括OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE和ALL，默认值为INFO。
• CN_AUTH_SERVER_URL：Janssen Auth服务器的基本URL，例如auth-server:8080，默认值为空字符串。
• GOOGLE_PROJECT_ID：Google项目ID，默认值为空字符串。当CN_CONFIG_ADAPTER或CN_SECRET_ADAPTER设为google时使用。
• GOOGLE_APPLICATION_CREDENTIALS：Google凭据JSON文件的路径，默认值为/etc/jans/conf/google-credentials.json。当CN_CONFIG_ADAPTER或CN_SECRET_ADAPTER设为google时使用。
• CN_GOOGLE_SPANNER_INSTANCE_ID：Google Spanner实例ID。
• CN_GOOGLE_SPANNER_DATABASE_ID：Google Spanner数据库ID。