安装 Label Studio

本文档提供了将 Label Studio 部署到 Kubernetes 集群以及常用配置参数的详细说明。

下载

下载 Label Studio 安装包，然后按照上架软件包上传该软件包。

部署

准备存储

Label Studio 将数据存储在数据库中，并且需要持久化存储。集群需要预先安装 CSI，或者预先准备好 PersistentVolume。

准备数据库

Label Studio 支持以下数据库：

PostgreSQL：版本 13 或更高

Data Services 提供的 PostgreSQL operator 可用于创建 PostgreSQL cluster。

可在 Data Services 中 PostgreSQL 实例详情里查看访问地址和密码。

准备 Redis（可选）

Redis 不是必需的，但建议在生产环境中使用。

可使用 Data Services 创建 Redis 实例。

**注意：**Label Studio 仅支持以 standalone 模式访问 Redis。

创建 standalone 模式的 Redis：
1. 创建 Redis 实例时，在 Architecture 中选择 Redis Sentinel。
2. 设置完所有参数后，切换到 YAML 模式，将 spec.arch 改为 standalone，然后点击 Create 按钮。
3. 创建完成后，切换到 Alauda Container Platform 视图，找到名为 rfr-<Redis instance name>-read-write 的 Service，这就是该 Redis 实例的访问地址。

创建应用

进入 Alauda Container Platform 视图，选择要部署 Label Studio 的 namespace。
在左侧导航中，选择 Applications / Applications，然后点击右侧页面上的 Create 按钮。
在弹窗中选择 Create from Catalog，页面将跳转到 Catalog 视图。
找到 3rdparty/chart-label-studio，点击 Create 创建该应用。
在 Catalog / Create label-studio 表单中，填写 Name（建议为 label-studio）以及 Values 中的 Custom 配置，然后点击 Create 按钮完成创建。Custom 内容将在下文说明。也可以在创建后通过 Update 应用方式进行修改。

配置

用户可以修改应用的 Custom Values 来调整配置。主要需要关注的配置如下：

1. 配置存储

1.1 配置 Storage Class 和存储大小

可以通过添加以下配置来指定 storage class：

label-studio:
  persistence:
    storageClass: storage-class-name
    size: 20Gi                               # Replace with the actual required space size

2. 配置数据库

2.1 配置 PostgreSQL

可以通过设置以下字段来配置 PostgreSQL 访问信息：

global:
  pgConfig:
    host: localhost                          # PostgreSQL access address
    port: 5432                               # PostgreSQL access port, default: 5432
    dbName: labelstudio                      # Database name, note: database will be created automatically
    userName: postgres                       # Database username
    password:
      secretName: postgre-secret             # Secret name storing database access password
      secretKey: password                    # Secret key storing database access password

2.2 配置 Redis

可以通过设置以下字段来配置 Redis 访问信息：

global:
  redisConfig:
    host: "redis://your-redis-host:6379/1"    # Redis connection address, format: redis://[:password]@host:port/db
    password:                                 # Optional, password can be included in host or provided separately via Secret
      secretName: "redis-secret"              # Secret name storing Redis access password
      secretKey: "password"                   # Secret key storing Redis password
    ssl:                                      # Optional
      redisSslCertReqs: "optional"            # SSL certificate requirements: "" means not required, "optional", "required"
      redisSslSecretName: "redis-ssl-secret"  # SSL certificate Secret name
      redisSslCaCertsSecretKey: "ca.crt"      # CA certificate Secret key
      redisSslCertFileSecretKey: "tls.crt"    # Client certificate Secret key
      redisSslKeyFileSecretKey: "tls.key"     # Client private key Secret key

3. 配置访问方式

默认使用 LoadBalancer 提供访问地址。

3.1 修改 Service 类型

可以通过设置以下字段来修改 Service 类型：

label-studio:
  app:
    service:
      type: LoadBalancer                     # Can be changed to NodePort or ClusterIP

3.2 启用 Ingress

可以通过设置以下字段来配置 Ingress。启用 Ingress 后，Service 类型通常会改为 ClusterIP：

label-studio:
  app:
    ingress:
      enabled: true                          # Enable Ingress functionality
      host: localhost                        # Access domain (must be DNS name, not IP address)
      tls:
        - secretName: certificate-secret     # Secret name storing TLS certificate
global:
  extraEnvironmentVars:
    LABEL_STUDIO_HOST: https://x.x.x.x       # Web access URL for frontend resource loading

3.3 配置 OAuth2 Proxy（可选）

oauth2_proxy:
  enabled: true
  oidcIssuer: "https://x.x.x.com/dex"          # OIDC Issuer address
  oidcClientID: "your-client-id"               # OIDC client ID
  oidcClientSecret: "your-client-secret"       # OIDC client secret (recommended to use Secret)

  ingress:                                     # Optional, use ingress to access OAuth2 proxy
    enabled: true                              # Default is false
    host: localhost                            # Access domain, must be set, cannot use IP address, only domain name
    tls:
      - secretName: certificate-secret         # Secret name storing TLS certificate

如果要将 Alauda Container Platform 配置为 OIDC Provider，请按以下方式配置：

oauth2_proxy.oidcIssuer 为平台访问地址加上 /dex
oauth2_proxy.oidcClientID 固定为 label-studio
oauth2_proxy.oidcClientSecret 固定为 ZXhhbXBsZS1hcHAtc2VjcmV0

还需要在 global 集群中创建一个 OAuth2Client 资源，以配置 Label Studio 的客户端信息：

apiVersion: dex.coreos.com/v1
kind: OAuth2Client
metadata:
  name: nrqwezlmfvzxi5lenfx4x4u44scceizf
  namespace: cpaas-system
id: label-studio                                # Must match oauth2_proxy.oidcClientID in values
name: Label Studio
secret: ZXhhbXBsZS1hcHAtc2VjcmV0                # Must match oauth2_proxy.oidcClientSecret in values
redirectURIs:
- http://xxx.xxx.xxxx.xxx:xxxxx/*               # OAuth2-Proxy access address, see below for how to obtain
                                                # If multiple Label Studio instances are deployed, add all access addresses here

注意：OAuth2 proxy 的访问地址可从 <Application Name>-oauth2-proxy 这个 Service 获取，请根据 Service 类型使用相应的访问方式。

4. 配置用户管理

4.1 禁用用户注册

可以通过设置以下字段来禁用用户注册：

global:
  extraEnvironmentVars:
    LABEL_STUDIO_DISABLE_SIGNUP_WITHOUT_LINK: true

访问地址

1. 通过 Service 访问

Label Studio 通过 Service 提供外部访问。请查看其 Service 以获取访问地址。

如果未启用 OAuth2 proxy，则 Service 名称为：<Application Name>-ls-app
如果启用 OAuth2 proxy，则 Service 名称为：<Application Name>-oauth2-proxy

如果 Service 类型为 LoadBalancer，且环境中的负载均衡器控制器已经分配了访问地址，请通过该地址访问。

对于 LoadBalancer 或 NodePort 服务类型，也可以通过节点 IP 和其 NodePort 访问。

2. 通过 Ingress 访问

如果启用了 Ingress，请通过配置好的 LABEL_STUDIO_HOST 访问。

用户管理

Label Studio 默认没有用户名和密码。用户可以在登录页面填写邮箱和密码完成新用户注册。

注意：

默认配置允许任何人注册新用户
所有用户具有相同的功能权限，并且可以访问所有项目
如需限制用户注册，请配置环境变量 LABEL_STUDIO_DISABLE_SIGNUP_WITHOUT_LINK=true，请参见：4.1 禁用用户注册

#安装 Label Studio

#目录

#下载

#部署

#准备存储

#准备数据库

#准备 Redis（可选）

#创建应用

#配置

#1. 配置存储

#1.1 配置 Storage Class 和存储大小

#2. 配置数据库

#2.1 配置 PostgreSQL

#2.2 配置 Redis

#3. 配置访问方式

#3.1 修改 Service 类型

#3.2 启用 Ingress

#3.3 配置 OAuth2 Proxy（可选）

#4. 配置用户管理

#4.1 禁用用户注册

#访问地址

#1. 通过 Service 访问

#2. 通过 Ingress 访问

#用户管理