基本配置¶

Glance 有许多选项可用于配置 Glance API 服务器以及 Glance 可以用于存储镜像的各种存储后端。

大多数配置是通过配置文件完成的。

启动 Glance 服务器时，可以指定要使用的配置文件（请参阅关于控制 Glance 服务器的文档）。如果您没有指定配置文件，Glance 将按顺序在以下目录中查找配置文件

~/.glance
~/
/etc/glance
/etc

Glance API 服务器配置文件应命名为 glance-api.conf。由于 Glance 为其每个服务维护一个配置文件，因此还有许多其他配置文件。如果您通过操作系统的包管理系统安装了 Glance，那么您可能会在 /etc/glance 中安装示例配置文件。

此外，每个服务器应用程序的示例配置文件以及详细注释都可以在 Glance 示例配置部分中找到。

PasteDeploy 配置（控制每个组件的 WSGI 应用程序的部署）默认情况下可以在 <component>-paste.ini 中找到，与主配置文件 <component>.conf 位于同一位置。例如，glance-api-paste.ini 对应于 glance-api.conf。paste 配置的路径是可配置的，如下所示

[paste_deploy]
config_file = /path/to/paste/config

Glance 中的常用配置选项¶

Glance 有一些命令行选项，这些选项在所有 Glance 程序中都是通用的

--verbose

可选。默认值：False

可以在命令行和配置文件中指定。

启用日志记录的 INFO 级别，并打印更详细的命令行界面输出。

--debug

可选。默认值：False

可以在命令行和配置文件中指定。

启用日志记录的 DEBUG 级别。

--config-file=PATH

可选。默认值：请参阅下面的默认搜索顺序。

仅在命令行上指定。

获取运行程序时要使用的配置文件的路径。如果未指定此命令行选项，则我们会检查第一个参数是否为文件。如果是，则尝试将其用作配置文件。如果没有文件或没有参数，则按以下顺序搜索配置文件

~/.glance
~/
/etc/glance
/etc

搜索的文件名取决于服务器应用程序的名称。因此，如果您正在启动 API 服务器，则会搜索 glance-api.conf。

--config-dir=DIR

可选。默认值：None

仅在命令行上指定。

获取包含所有 *.conf 片段的配置目录的路径。当通过部署框架生成未知数量的配置片段时，这提供了一种替代方案，而不是显式列出所有配置文件。

如果设置了 --config-dir，则会忽略 --config-file。

一个示例用法是

$ glance-api --config-dir=/etc/glance/glance-api.d

$ ls /etc/glance/glance-api.d
  00-core.conf
  01-swift.conf
  02-ssl.conf
  ... etc.

上述示例中的数字前缀仅在需要特定的解析顺序时才必要（即，如果在后面的片段中覆盖了早期片段中设置的单个配置选项）。

请注意，glance-manage 当前从三个文件加载配置

glance-api.conf
glance-manage.conf

默认情况下，glance-manage.conf 仅指定自定义日志文件，但 glance-manage 的其他配置选项应迁移到其中。警告：在 glance-manage.conf 中设置的选项将覆盖 glance-api.conf 中设置的相同部分和名称的选项

配置服务器启动选项¶

可以将以下选项放在 glance-api.conf 文件中，在 [DEFAULT] 部分下。它们分别启用 API 服务器的启动和绑定行为。

bind_host=ADDRESS

要绑定的主机地址。

可选。默认值：0.0.0.0

bind_port=PORT

服务器应绑定的端口。

可选。默认值：API 服务器的 9292

backlog=REQUESTS

配置套接字的回退请求数。

可选。默认值：4096

tcp_keepidle=SECONDS

为每个服务器套接字设置 TCP_KEEPIDLE 的值（以秒为单位）。不支持在 OS X 上。

可选。默认值：600

client_socket_timeout=SECONDS

客户端连接套接字操作的超时时间。如果传入连接在此期间空闲，则将关闭该连接。值为 0 表示等待永远。

可选。默认值：900

workers=PROCESSES

要启动的 Glance API 工作进程数。每个工作进程将在同一端口上侦听。增加此值可以提高性能（尤其是在启用压缩的 SSL 时）。通常建议每个 CPU 使用一个工作进程。值为 0 将阻止创建任何新的工作进程。

可选。默认值：将默认使用可用的 CPU 数量。

max_request_id_length=LENGTH

限制 x-openstack-request-id 标头的最大大小，该标头被记录。仅当配置了上下文中间件时才影响。

可选。默认值：64（受 max_header_line 默认值限制：16384）

配置 Glance 中的日志记录¶

Glance 中有许多配置选项控制 Glance 服务器如何记录消息。

--log-config=PATH

可选。默认值：None

仅在命令行上指定。

获取用于配置日志记录的配置文件的路径。

仅在配置文件中可用的日志记录选项¶

您需要在应用程序配置文件的 [DEFAULT] 部分中放置不同的日志记录选项。例如，您可以在名为 etc/glance-api.conf 的配置文件中执行以下操作

[DEFAULT]
log_file = /var/log/glance/api.log

log_file

用于记录 Glance 服务器消息的文件的文件路径。如果丢失，默认情况下会将消息输出到 stdout，因此如果您以守护程序模式运行 Glance 服务器（使用 glance-control），则应确保将 log_file 选项设置为适当的值。

log_dir

用于日志文件的文件路径。如果未指定（默认值），则将 log_file 用作绝对文件路径。

log_date_format

日志输出中时间戳的格式字符串。

默认值为 %Y-%m-%d %H:%M:%S。有关设置此格式字符串的更多信息，请参阅 logging 模块文档。

log_use_syslog

使用 syslog 日志记录功能。

默认值为 False。

配置 Glance 存储后端¶

Glance 中有许多配置选项控制 Glance 如何存储磁盘镜像。启用的后端必须在 [DEFAULT] 部分中定义。

enabled_backends=store1_id:store1_type, store2_id:store2_type[,...]

必需。

一个以“store_id:store_type”字符串分隔的逗号列表。存储 ID 可以由用户选择，而有效的存储类型是 (file、http、rbd、swift、cinder、vmware、s3)。

然后必须在 [glance_store] 部分中设置默认后端

default_backend = store1_id

必需。

此选项必须设置为 enabled_backends 中使用的存储标识符之一。

此外，必须为 enabled_backends 中定义的每个键值对创建一个部分。每个部分必须填充特定于存储的选项。请参阅配置多个 Cinder 存储后端以获取完整示例。

配置文件系统存储后端¶

filesystem_store_datadir=PATH

可选。默认值：/var/lib/glance/images/

只能在配置文件中指定。

此选项特定于文件系统存储后端。

设置文件系统存储后端写入磁盘镜像的路径。请注意，文件系统存储后端将尝试创建此目录（如果它不存在）。确保运行 glance-api 的用户对此目录具有写权限。

filesystem_store_file_perm=PERM_MODE

可选。默认值：0

只能在配置文件中指定。

此选项特定于文件系统存储后端。

创建镜像文件所需的权限值，以八进制表示。您可以使用此值指定消耗服务的用户（例如 Nova）作为拥有创建文件的组的唯一成员。要保持默认值，请分配小于或等于 0 的权限值。请注意，文件所有者必须保留读取权限；如果此值删除了该权限，将记录错误消息并引发 BadStoreConfiguration 异常。如果 Glance 服务没有足够的权限来更改文件访问权限，仍然会保存文件，但 Glance 日志中会出现警告消息。

filesystem_store_chunk_size=SIZE_IN_BYTES

可选。默认值：65536

只能在配置文件中指定。

此选项特定于文件系统存储后端。

读取或写入镜像文件时使用的块大小。提高此值可以提高吞吐量，但处理大量请求时可能会略微增加内存使用量。

使用多个存储配置文件系统存储后端¶

filesystem_store_datadirs=PATH:PRIORITY

可选。默认值：/var/lib/glance/images/:1

示例

filesystem_store_datadirs = /var/glance/store
filesystem_store_datadirs = /var/glance/store1:100
filesystem_store_datadirs = /var/glance/store2:200

此选项只能在配置文件中指定，并且仅特定于文件系统存储后端。

filesystem_store_datadirs 选项允许管理员配置多个存储目录以在文件系统存储后端中保存 glance 镜像。可以为每个目录关联其优先级。

注意:

如果需要特定的解析顺序（即，如果在后面的片段中覆盖了早期片段中设置的单个配置选项），则可以多次指定此选项。
必须在 glance-api.conf 中指定 filesystem_store_datadir 或 filesystem_store_datadirs 选项之一
优先级为 200 的存储优先于优先级为 100 的存储。
如果未指定优先级，则默认优先级“0”与该优先级相关联。
如果两个文件系统存储具有相同的优先级，则具有最大可用空间的存储将被选择来存储镜像。
如果多次指定相同的存储，将引发 BadStoreConfiguration 异常。

配置 Swift 存储后端¶

swift_store_auth_address=URL

在使用 Swift 存储后端时必需。

只能在配置文件中指定。

已弃用。请改用 Swift 后端配置文件中的 auth_address。

此选项特定于 Swift 存储后端。

设置在向 Swift 存储系统发出调用时提供的身份验证 URL。有关 Swift 身份验证系统的更多信息，请参阅 Swift auth 文档。

重要提示：Swift 身份验证地址默认使用 HTTPS。这意味着如果您使用 HTTP 进行身份验证运行 Swift，则需要将 swift_store_auth_address 设置为完整的 URL，包括 http://。

swift_store_user=USER

在使用 Swift 存储后端时必需。

只能在配置文件中指定。

已弃用。请改用 Swift 后端配置文件中的 user。

此选项特定于 Swift 存储后端。

设置要使用 swift_store_auth_address 进行身份验证的用户。

swift_store_key=KEY

在使用 Swift 存储后端时必需。

只能在配置文件中指定。

已弃用。请改用 Swift 后端配置文件中的 key。

此选项特定于 Swift 存储后端。

设置要使用 swift_store_auth_address 为用户 swift_store_user 进行身份验证的身份验证密钥。

swift_store_container=CONTAINER

可选。默认值：glance

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

设置在 Swift 中用于 Glance 镜像的容器的名称。

swift_store_create_container_on_put

可选。默认值：False

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

如果为 true，Glance 将尝试创建容器 swift_store_container（如果它不存在）。

swift_store_large_object_size=SIZE_IN_MB

可选。默认值：5120

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

当 Glance 开始将镜像文件分块并在 Swift 中执行大型对象清单时，应该使用多大尺寸（以 MB 为单位）？默认情况下，这是 Swift 中的最大对象大小，即 5GB

swift_store_large_object_chunk_size=SIZE_IN_MB

可选。默认值：200

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

在执行大型对象清单时，Glance 应该将多大尺寸（以 MB 为单位）的块写入 Swift？默认值为 200MB。

swift_store_multi_tenant=False

可选。默认值：False

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

如果设置为 True，则启用多租户存储模式，这将导致 Glance 镜像存储在特定租户的 Swift 帐户中。如果设置为 False，Glance 将所有镜像存储在单个 Swift 帐户中。

swift_store_multiple_containers_seed

可选。默认值：0

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

如果设置为 0，则单租户存储将仅使用一个容器来存储所有镜像。如果设置为 1 到 32 之间的整数值，则单租户存储将使用多个容器来存储镜像，并且该值将确定在确定将镜像放置在哪个容器中时要检查的镜像 UUID 中的字符数。将创建的最大容器数大约等于 16^N。只有在禁用 swift_store_multi_tenant 时才使用此设置。

示例：如果将此配置选项设置为 3 且 swift_store_container = ‘glance’，则 UUID 为 ‘fdae39a1-bac5-4238-aba4-69bcc726e848’ 的镜像将被放置在容器 ‘glance_fda’ 中。UUID 中的所有连字符都包含在创建容器名称中，但不计入字符限制，因此在本例中，N=10 时，容器名称将为 ‘glance_fdae39a1-ba’。

在选择 swift_store_multiple_containers_seed 的值时，部署者应与他们的 Swift 操作团队讨论合适的值。此选项的作者建议大规模部署使用值 ‘2’，这将创建最多约 256 个容器。即使在极大规模的部署中，选择高于此值的数字也可能不会对性能产生任何积极影响，并且可能导致大量空闲未使用的容器。最大的部署可以通过提高单个容器上的 Swift 速率限制来提高性能。注意：如果关闭了动态容器创建，则此配置选项的任何高于 ‘1’ 的值可能不合理，因为部署者将必须手动创建每个容器。

swift_store_admin_tenants

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

可选。默认值：未设置。

将作为 Glance 在多租户模式下创建的容器的读写 ACL 应用的 Swift ACL 字符串列表。这将授予指定的租户/用户对所有新创建的镜像对象进行读写访问权限。允许标准的 Swift ACL 字符串格式，包括

<tenant_id>:<username> <tenant_name>:<username> *:<username>

可以使用逗号分隔的列表组合多个 ACL，例如：swift_store_admin_tenants = service:glance,*:admin

swift_store_auth_version

只能在配置文件中指定。

已弃用。请在 Swift 后端配置文件中使用 auth_version 代替。

此选项特定于 Swift 存储后端。

可选。默认值：2

一个字符串，指示要使用的 Swift OpenStack 身份验证版本。有关更多详细信息，请参阅项目 python-swiftclient。

swift_store_service_type

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

可选。默认值：object-store

一个字符串，给出要使用的 swift 服务的服务类型。只有当 swift_store_auth_version 为 2 时，才使用此设置。

swift_store_region

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

可选。默认值：未设置。

一个字符串，给出要使用的 swift 服务端点的区域。只有当 swift_store_auth_version 为 2 时，才使用此设置。此设置对于区分多个 swift 服务在身份验证期间可能出现在服务目录中特别有用。

swift_store_endpoint_type

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

可选。默认值：publicURL

一个字符串，给出要使用的 swift 服务端点的端点类型。只有当 swift_store_auth_version 为 2 时，才使用此设置。

swift_store_ssl_compression

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

可选。默认值：True。

如果设置为 False，则禁用 https swift 请求的 SSL 层压缩。对于已经处于压缩格式的镜像（例如 qcow2），设置为 ‘False’ 可能会提高性能。如果设置为 True，则将启用压缩（前提是 swift 代理支持）。

swift_store_cacert

只能在配置文件中指定。

可选。默认值：None

一个字符串，给出将允许 Glance 的服务在与 Swift 通信时执行 SSL 验证的 CA 证书捆绑包的路径。

swift_store_retry_get_count

Swift 下载将在请求失败之前重试的次数。可选。默认值：0

配置多个 Swift 帐户/存储¶

为了不在数据库中存储 Swift 帐户凭据，并支持多个帐户（或多个 Swift 后端存储），数据库中存储一个引用，并且相应的配置（凭据/参数）详细信息存储在配置文件中。可选。默认值：未启用。

此文件的位置使用配置文件中的 swift_store_config_file 配置选项在 [DEFAULT] 部分中指定。如果指定了不正确的值，Glance API Swift 存储服务将不会被配置。

swift_store_config_file=PATH

此选项特定于 Swift 存储后端。

default_swift_reference=DEFAULT_REFERENCE

配置多个 Swift 帐户/后端存储时需要。

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

它是用于添加任何新镜像的默认 swift 引用。

swift_store_auth_insecure

如果为 True，则绕过 Swift 的 SSL 证书验证。

只能在配置文件中指定。

此选项特定于 Swift 存储后端。

可选。默认值：False

配置 Swift 配置文件¶

如果设置了 swift_store_config_file，Glance 将使用此参数指定的文件的信息。

注意

swift_store_config_file 当前仅用于单租户 Swift 存储配置。如果您配置了多租户 Swift 存储后端 (swift_store_multi_tenant=True)，请确保 swift_store_config_file 和 default_swift_reference 都未设置。

该文件包含一组引用，例如

[ref1]
user = tenant:user1
key = key1
auth_version = 2
auth_address = https://:5000/v2.0

[ref2]
user = project_name:user_name2
key = key2
user_domain_id = default
project_domain_id = default
auth_version = 3
auth_address = https://:5000/v3

必须配置默认引用。其参数将在创建新镜像时使用。例如，要将 ref2 指定为默认引用，请将以下值添加到 glance-api.conf 文件的 [glance_store] 部分

default_swift_reference = ref2

在引用中，用户可以指定以下参数

user

以 project_name:user_name 格式的项目名和用户名对，用于对 Swift 身份验证服务进行身份验证。

key

用于对 Swift 身份验证服务进行身份验证的用户的身份验证密钥。

auth_address

Swift 身份验证服务所在的位置。

auth_version

要使用的 Swift OpenStack 身份验证版本。有效版本是 Keystone 的 2 和 3，以及 Swauth 和 Rackspace 的 1（已弃用）。

可选。默认值：2

project_domain_id

请求的项目级别授权范围的项目域 ID。

可选。默认值：None

如果 ``auth_version` 为 3，可以指定此选项。`

project_domain_name

请求的项目级别授权范围的项目域名称。

可选。默认值：None

如果 ``auth_version` 为 3，可以指定此选项。`

user_domain_id

请求的域级别授权范围的用户域 ID。

可选。默认值：None

如果 ``auth_version` 为 3，可以指定此选项。`

user_domain_name

请求的域级别授权范围的用户域名称。

可选。默认值：None

如果 ``auth_version` 为 3，可以指定此选项。`

配置 RBD 存储后端¶

注意：RBD 存储后端需要 librados 和 librbd 的 python 绑定。这些绑定在基于 Debian 的发行版上位于 python-ceph 包中。

rbd_store_pool=POOL

可选。默认值：rbd

只能在配置文件中指定。

此选项特定于 RBD 存储后端。

设置存储镜像的 RADOS 池。

rbd_store_chunk_size=CHUNK_SIZE_MB

可选。默认值：8

只能在配置文件中指定。

此选项特定于 RBD 存储后端。

镜像将被分成大小为（以兆字节为单位）的对象。为了获得最佳性能，这应该是一个 2 的幂。

rados_connect_timeout

可选。默认值：0

只能在配置文件中指定。

此选项特定于 RBD 存储后端。

防止 glance-api 在连接到 RBD 时挂起。设置 glance-api 在关闭连接之前等待的时间（以秒为单位）。设置 rados_connect_timeout<=0 表示没有超时。

rbd_store_ceph_conf=PATH

可选。默认值：/etc/ceph/ceph.conf、~/.ceph/config 和 ./ceph.conf

只能在配置文件中指定。

此选项特定于 RBD 存储后端。

设置要使用的 Ceph 配置文件。

rbd_store_user=NAME

可选。默认值：admin

只能在配置文件中指定。

此选项特定于 RBD 存储后端。

设置要作为 RADOS 用户进行身份验证。只有在启用 RADOS 身份验证时才需要此设置。

必须为 Ceph 配置文件中的此用户设置一个密钥环，例如使用用户 glance

[client.glance]
keyring=/etc/glance/rbd.keyring

要使用名为 glance 的用户设置最小权限，并使用名为 images 的池，请运行

rados mkpool images
ceph-authtool --create-keyring /etc/glance/rbd.keyring
ceph-authtool --gen-key --name client.glance --cap mon 'allow r' --cap osd 'allow rwx pool=images' /etc/glance/rbd.keyring
ceph auth add client.glance -i /etc/glance/rbd.keyring

配置 Cinder 存储后端¶

Cinder 存储使您能够将镜像存储在块存储 (Cinder) 服务中的卷中（每个镜像一个卷）。Glance 没有直接访问为 Cinder 配置的任何后端的能力；它只是将镜像数据交给块存储服务，Cinder 决定将数据存储在哪里。

Glance 可以通过在配置 cinder 存储时设置 cinder_volume_type 选项来影响数据将存储在何处。有关详细信息，请参阅下文。

注意：要快速从镜像创建 Cinder 卷，需要额外的设置。请参阅基于卷的镜像文档以获取更多信息。

警告

由于在用户帐户中创建的镜像卷容易受到普通用户修改，这可能会损坏镜像，因此我们建议始终将服务凭据设置在配置文件中，以便镜像卷将在不可直接访问非服务用户的内部项目中创建。

要在内部项目中创建镜像卷，我们需要将以下配置参数设置为 glance 服务用户和内部服务项目

cinder_store_user_name
cinder_store_password
cinder_store_project_name
cinder_store_auth_address

cinder_catalog_info=<service_type>:<service_name>:<endpoint_type>

可选。默认值：volumev3::publicURL

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

设置在服务目录中查找 cinder 时要匹配的信息。格式为冒号分隔的值，形式为：<service_type>:<service_name>:<endpoint_type>

cinder_endpoint_template=http://ADDR:PORT/VERSION/%(tenant)s

可选。默认值：None

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

使用模板覆盖服务目录查找 cinder 端点。请求上下文中替换 %(...)s 部分的值。例如 https://:8776/v3/%(tenant)s

os_region_name=REGION_NAME

可选。默认值：None

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

此节点的区域名称。

已弃用。请使用 cinder_os_region_name 代替。

cinder_os_region_name=REGION_NAME

可选。默认值：None

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

此节点的区域名称。如果指定，则用于从服务目录中查找 cinder。

cinder_ca_certificates_file=CA_FILE_PATH

可选。默认值：None

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

用于 cinder 客户端请求的 ca 证书文件的位置。

cinder_http_retries=TIMES

可选。默认值：3

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

在失败的 http 调用上 cinderclient 重试的次数。

cinder_state_transition_timeout

可选。默认值：300

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

等待 cinder 卷转换完成的时间段（以秒为单位）。

cinder_api_insecure=ON_OFF

可选。默认值：False

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

允许对 cinder 执行不安全的 SSL 请求。

cinder_store_user_name=NAME

可选。默认值：None

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

用于对 Cinder 进行身份验证的用户名。如果为 <None>，则使用当前上下文的用户。

注意：只有在设置了所有 cinder_store_user_name、cinder_store_password、cinder_store_project_name 和 cinder_store_auth_address 时，才应用此选项。这些选项对于将镜像卷放入内部服务项目以隐藏卷并使镜像在项目之间共享很有用。

cinder_store_user_domain_name=NAME

可选。默认值：Default

只能在配置文件中指定。

此选项特定于 Cinder 存储后端。

用于对 cinder 进行身份验证的用户的域。