oneidentity/oneim-api

One Identity Manager API Server Docker镜像

镜像概述

本镜像运行One Identity Manager API Server实例。它在启动时从配置的数据库下载必要文件，其行为可通过密钥值和环境变量控制。

要求

所有标记为windows-amd64的镜像均兼容Windows Server主机。请使用下文列出的标签检查各标签支持的Windows Server版本。

所有标记为linux-amd64的镜像均兼容Linux操作系统主机。

支持的标签

Windows Server 2022 amd64标签

• latest, 9.3, 9.2, 9.1, 9.0, 8.2, windows-amd64-9.2-windowsservercore-ltsc2022, windows-amd64-9.1-windowsservercore-ltsc2022, windows-amd64-9.0-windowsservercore-ltsc2022, windows-amd64-8.2-windowsservercore-ltsc2022, windows-amd64-latest-windowsservercore-ltsc2022

Windows Server 2019 amd64标签

• latest, 9.3, 9.2, 9.1, 9.0, 8.2, windows-amd64-9.2-windowsservercore-ltsc2019, windows-amd64-9.1-windowsservercore-ltsc2019, windows-amd64-9.0-windowsservercore-ltsc2019, windows-amd64-8.2-windowsservercore-ltsc2019, windows-amd64-latest-windowsservercore-ltsc2019

Windows Server 2016 amd64标签

• 9.2, 9.1, 9.0, 8.2, windows-amd64-9.2-windowsservercore-ltsc2016, windows-amd64-9.1-windowsservercore-ltsc2016, windows-amd64-9.0-windowsservercore-ltsc2016, windows-amd64-8.2-windowsservercore-ltsc2016

Linux标签

• latest, 9.3, 9.2, 9.1, 9.0, 8.2, linux-amd64-9.2, linux-amd64-9.1, linux-amd64-9.0, linux-amd64-8.2, linux-amd64-latest

如何使用本镜像

Linux镜像免责声明

请注意，并非Identity Manager的所有功能在Linux容器中都受支持。 Identity Manager < 9.3运行在Mono上，且并非所有底层组件在Mono中都可用。

Identity Manager 9.3运行在.NET 8上，且并非所有底层组件在Linux上的.NET 8中都兼容。

注意： 在Linux上，API服务器镜像不会自动更新。当QBMFileRevision的条目因更新或迁移而更改时，您必须启动新实例。

配置文件

Web.config

Web.config文件配置API服务器的所有设置。容器会探测两个位置以查找Web.config文件：

Windows

1. C:\ProgramData\Docker\secrets\Web.config：如果存在此文件，将直接使用，不会用环境变量替换任何占位符。可使用以下命令创建Web.config模板：

   powershell
   $P = $PWD.Path.Replace("\", "/")
   $VERSION = "latest"
   docker run -it --rm `
       -v $P:C:/Data `
       -e "CONNSTRING=Data Source=..." `
       -e "UPDATEPWD=..." `
       -e BASEURL=http://localhost:9999/ `
       -e APPSERVERCONNSTRING=URL=http://localhost/AppServer `
       oneidentity/oneim-api:$VERSION `
       --createwebcfg C:\data
   

   或者，连接字符串可来自密钥文件夹，且web.config可立即放置在那里：

   powershell
   $P = $PWD.Path.Replace("\", "/")
   $VERSION = "latest"
   docker run -it --rm `
       -v $P/secrets:C:/ProgramData/Docker/secrets `
       -e BASEURL=http://localhost:9999/ `
       oneidentity/oneim-api:$VERSION `
       --createwebcfg C:/ProgramData/Docker/secrets
   

   注意： 在生成web.config以及启动使用所创建web.config的容器期间，您需要指定相同的UPDATEACCOUNT和UPDATEPWD值。

2. 容器使用其模板，并使用密钥值或环境变量替换以下值：

密钥值优先于环境变量。

Linux

1. /run/secrets/web.config：如果存在此文件，将直接使用，不会用环境变量替换任何占位符。可使用以下命令创建web.config模板：

   sh
   VERSION=latest
   docker run -it --rm -v $PWD:/data -e "CONNSTRING=Data Source=..." -e BASEURL=http://localhost:9999/ -e APPSERVERCONNSTRING=URL=http://localhost/AppServer oneidentity/oneim-api:linux-amd64-$VERSION --createwebcfg /data
   

   或者，连接字符串可来自密钥文件夹，且web.config可立即放置在那里：

   sh
   VERSION=latest
   docker run -it --rm -v $PWD/secrets:/run/secrets -e BASEURL=http://localhost:9999/ oneidentity/oneim-api:linux-amd64-$VERSION --createwebcfg /run/secrets
   

2. 容器使用其模板，并使用密钥值或环境变量替换以下值：

密钥值优先于环境变量。

会话证书（Session certificate）

用于加密会话信息的证书将在以下位置查找：

• Windows: C:\ProgramData\Docker\secrets\SessionCertificate.pfx
• Linux: /run/secrets/SessionCertificate.pfx

以下文件夹：

• Windows: C:\ProgramData\Docker\secrets\
• Linux: /run/secrets

可挂载为卷，其中可放置同名的现有证书；如果文件夹可写，服务将尝试在该位置创建新证书。

会话证书需要在API服务器实例之间共享，以便在API服务器更新后或在API服务器集群中重新打开会话。

Windows

可通过以下命令创建会话证书：

powershell
$P = $PWD.Path.Replace("\", "/")
$VERSION = "latest'
docker run -it --rm -v $P/secrets:C:/Data oneidentity/oneim-api:$VERSION --createcert C:\Data

或使用PowerShell：

powershell
$outfile = "Path\to\SessionCertificate.pfx"
$date = (Get-Date).Date.AddDays(1000)
$cert = New-SelfSignedCertificate `
    -KeyAlgorithm RSA `
    -KeyLength 2048 `
    -HashAlgorithm SHA1 `
    -KeyExportPolicy Exportable `
    -NotAfter $date `
    -Subject "CN=API Server" `
    -Type DocumentEncryptionCert
[System.IO.File]::WriteAllBytes( `
    $outfile, `
    $cert.Export( `
        [System.Security.Cryptography.X509Certificates.X509ContentType]::Pkcs12, `
        $null))

Linux

可通过以下命令创建会话证书：

sh
VERSION=latest
docker run -it --rm -v $PWD:/data oneidentity/oneim-api:linux-amd64-$VERSION --createcert /data

或使用OpenSSL：

sh
openssl genrsa 2048 > private.pem
openssl req -x509 -sha1 -days 1000 -new -subj "/CN=API Server" -key private.pem -out public.pem
openssl pkcs12 -export -in public.pem -inkey private.pem -password pass: -out config/SessionCertificate.pfx

环境变量

DBSYSTEM

要在安装和运行时连接的数据库或应用服务器系统。有效值为：

• MSSQL：Microsoft SQL Server
• APPSERVER：通过应用服务器连接

如果未提供DBSYSTEM值，默认使用MSSQL。

可在密钥文件夹中提供。

CONNSTRING

用于连接系统的连接字符串。此参数为必填项。内容取决于所用的数据库系统。

不同系统的连接字符串示例：

MSSQL：

connectionstring
Data Source=[Server];Initial Catalog=[DB];User ID=[User];Password=[Password]

APPSERVER：

connectionstring
Url=https://my.app.server/

可在密钥文件夹中提供。

APPSERVERCONNSTRING

如果主连接使用直接Microsoft SQL Server连接，则为附加的应用服务器连接字符串。当DBSYSTEM等于MSSQL时，此参数为必填项。

connectionstring
Url=https://my.app.server/

可在密钥文件夹中提供。

TARGETS

要安装的部署目标的逗号分隔列表。默认目标为：Server\Web\BusinessAPIServer。

UPDATEUSER

用于自动更新处理和在启动期间创建QBMWebApplication条目的用户的身份验证字符串。

可在密钥文件夹中提供。

BASEURL

用于创建（如不存在）和使用QBMWebApplication条目的标识符。

可