第 1 章 在 OpenStack 上安装
1.1. 使用自定义配置在 OpenStack 上安装集群
在 OpenShift Container Platform 版本 4.3 中,您可以在 Red Hat OpenStack Platform (RHOSP) 上安装自定义集群。要自定义安装,请在安装集群前修改 install-config.yaml
中的参数。
1.1.1. 先决条件
查看有关 OpenShift Container Platform 安装和更新流程的详细信息。
- 在 Available platforms 部分验证 OpenShift Container Platform 4.3 是否与您的 RHOSP 版本兼容。您还可以查看 OpenShift Container Platform 在 RHOSP 中的支持来比较不同版本的平台支持。
- 在 RHOSP 中启用了元数据服务
1.1.2. 在 RHOSP 上安装 OpenShift Container Platform 的资源指南
您的配额必须满足以下要求,才能在 Red Hat OpenStack Platform (RHOSP) 中运行 OpenShift Container Platform 安装程序:
资源 | 值 |
---|---|
浮动 IP 地址 | 2 |
端口 | 15 |
路由器 | 1 |
子网 | 1 |
RAM | 112 GB |
vCPUs | 28 |
卷存储 | 175 GB |
实例 | 7 |
安全组 | 3 |
安全组规则 | 60 |
Swift 容器 | 2 |
Swift 对象 | 1 |
Swift 可用空间 | 10 MB 或以上 |
根据 bootstrap Ignition 文件和镜像 registry 的大小,Swift 空间要求会有所不同。
集群或许能使用少于推荐数量的资源来运作,但其性能无法保证。
默认情况下,您的安全组和安全组规则配额可能较低。如果遇到问题,请以 admin 的身份运行 openstack quota set --secgroups 3 --secgroup-rules 60 <project>
来提高配额。
OpenShift Container Platform 部署由 control plane 机器、计算机器和 bootstrap 机器组成。
1.1.2.1. control plane 和计算机器
默认情况下,OpenShift Container Platform 安装程序支持三台 control plane 和计算机器。
每台机器都需要:
- 来自 RHOSP 配额的实例
- 来自 RHOSP 配额的端口
- 其类别至少有 16 GB 内存、4 个 vCPU 和 25GB 存储空间
计算机器托管您在 OpenShift Container Platform 上运行的应用程序;运行数量应尽可能多。
1.1.2.2. bootstrap 机器
在安装时,会临时置备 bootstrap 机器来支持 control plane。生产控制平面就绪后,bootstrap 机器会被取消置备。
bootstrap 机器需要:
- 来自 RHOSP 配额的实例
- 来自 RHOSP 配额的端口
- 其类别至少有 16 GB 内存、4 个 vCPU 和 25GB 存储空间
安装程序无法将证书颁发机构捆绑包传递给 control plane 机器上的 Ignition。因此,如果端点使用自签名证书,bootstrap 机器将无法从 Swift 检索 Ignition 配置。
1.1.3. OpenShift Container Platform 对互联网和 Telemetry 的访问
在 OpenShift Container Platform 4.3 中,您需要访问互联网来安装集群。默认运行的 Telemetry 服务提供有关集群健康状况和成功更新的指标,这也需要访问互联网。如果您的集群连接到互联网,Telemetry 会自动运行,而且集群会注册到 Red Hat OpenShift Cluster Manager(OCM)。
确认 Red Hat OpenShift Cluster Manager 清单正确后,可以由 Telemetry 自动维护,也可以使用 OCM 手动维护,使用订阅监控 来跟踪帐户或多集群级别的 OpenShift Container Platform 订阅。
您必须具有以下互联网访问权限:
- 访问 Red Hat OpenShift Cluster Manager 页面,以下载安装程序并执行订阅管理。如果集群可以访问互联网,并且没有禁用 Telemetry,该服务会自动授权您的集群。
- 访问 Quay.io,以获取安装集群所需的软件包。
- 获取执行集群更新所需的软件包。
如果您的集群无法直接访问互联网,则可以在置备的某些类基础架构上执行受限网络安装。在此过程中,您要下载所需的内容,并使用它在镜像 registry(mirror registry) 中填充安装集群并生成安装程序所需的软件包。对于某些安装类型,集群要安装到的环境不需要访问互联网。在更新集群之前,要更新 registry 镜像系统中的内容。
1.1.4. 在 OpenStack 中启用 Swift
在 Red Hat OpenStack Platform (RHOSP) 上的 OpenShift Container Platform 使用 RHOSP Object Storage (Swift) 来存储和提供用户配置文件。
Swift 由具有 swiftoperator
角色的用户帐户操控。
先决条件
- 目标环境中的 RHOSP 管理员帐户
-
Ceph RGW 上必须启用
account in url
选项
流程
在 RHOSP 上启用 Swift:
在 RHOSP CLI 中以管理员身份,将
swiftoperator
角色添加到要访问 Swift 的帐户:$ openstack role add --user <user> --project <project> swiftoperator
您的 RHOSP 部署现在可以使用 Swift 来存储和提供文件。
1.1.5. 验证外部网络访问
OpenShift Container Platform 安装程序需要外部网络访问权限。您必须为其提供外部网络值,否则部署会失败。在运行安装程序之前,请验证 Red Hat OpenStack Platform (RHOSP) 中是否存在具有外部路由器类型的网络。
先决条件
在 RHOSP 中,必须将
NeutronDhcpAgentDnsmasqDnsServers
参数配置为允许 DHCP 代理转发实例的 DNS 查询。设置这个参数的方法之一为:- 在模板目录中创建新环境文件 。
在文件中提供参数值 。例如:
parameter_defaults: NeutronDhcpAgentDnsmasqDnsServers: ['<DNS_server_address_1>','<DNS_server_address_2']
在 Overcloud 部署命令中包括 环境文件。例如:
$ openstack overcloud deploy --templates -e neutron-dhcp-agent-dnsmasq-dns-servers.yaml ...
流程
使用 RHOSP CLI 验证“外部”网络的名称和 ID:
$ openstack network list --long -c ID -c Name -c "Router Type" +--------------------------------------+----------------+-------------+ | ID | Name | Router Type | +--------------------------------------+----------------+-------------+ | 148a8023-62a7-4672-b018-003462f8d7dc | public_network | External | +--------------------------------------+----------------+-------------+
网络列表中会显示具有外部路由器类型的网络。如果最少有一个没有,请参阅 创建默认浮动 IP 网络和创建默认供应商网络。
如果外部网络 CIDR 范围与某一个默认网络范围重叠,您必须在运行安装程序前更改 install-config.yaml
文件中匹配的网络范围。
默认的网络范围:
网络 | 范围 |
---|---|
machineCIDR | 10.0.0.0/16 |
serviceNetwork | 172.30.0.0/16 |
clusterNetwork | 10.128.0.0/14 |
如果安装程序找到多个同名的镜像,它会随机设置其中之一。为避免这种行为,请在 RHOSP 中为资源创建唯一名称。
如果启用了 Neutron 中继服务插件,则默认创建中继端口。如需更多信息,请参阅 Neutron 中继端口。
1.1.6. 为安装程序定义参数
OpenShift Container Platform 安装程序依赖于一个名为 clouds.yaml
的文件。该文件描述了 Red Hat OpenStack Platform (RHOSP) 配置参数,包括项目名称、登录信息和授权服务 URL。
流程
创建
clouds.yaml
文件:如果您的 RHOSP 发行版包含 Horizon web UI,请在该 UI 中生成
clouds.yaml
文件。重要请记住在
auth
字段中添加密码。您也可以把 secret 保存在clouds.yaml
以外的一个独立的文件中。如果您的 RHOSP 发行版不包含 Horizon Web UI,或者您不想使用 Horizon,请自行创建该文件。如需有关
clouds.yaml
的详细信息,请参阅 RHOSP 文档中的配置文件。clouds: shiftstack: auth: auth_url: http://10.10.14.42:5000/v3 project_name: shiftstack username: shiftstack_user password: XXX user_domain_name: Default project_domain_name: Default dev-env: region_name: RegionOne auth: username: 'devuser' password: XXX project_name: 'devonly' auth_url: 'https://10.10.14.22:5001/v2.0'
将您生成的文件放在以下位置之一:
-
OS_CLIENT_CONFIG_FILE
环境变量的值 - 当前目录
-
特定于 Unix 的用户配置目录,如
~/.config/openstack/clouds.yaml
特定于 Unix 的站点配置目录,如
/etc/openstack/clouds.yaml
安装程序会按照以上顺序搜索
clouds.yaml
。
-
1.1.7. 获取安装程序
在安装 OpenShift Container Platform 之前,将安装文件下载到本地计算机上。
先决条件
- 必须从使用 Linux 或 macOS 的计算机安装集群。
- 需要 500 MB 本地磁盘空间来下载安装程序。
流程
- 访问 Red Hat OpenShift Cluster Manager 网站的 Infrastructure Provider 页面。如果您有红帽帐号,请使用自己的凭证登录。如果没有,请创建一个帐户。
进入适用于您的安装类型的页面,下载您的操作系统的安装程序,并将文件放在要保存安装配置文件的目录中。。
重要安装程序会在用来安装集群的计算机上创建若干文件。在完成集群安装后,您必须保留安装程序和安装程序所创建的文件。
重要删除安装程序创建的文件不会删除您的集群,即使集群在安装过程中失败也是如此。您必须完成针对特定云供应商的 OpenShift Container Platform 卸载流程,才能完全删除您的集群。
提取安装程序。例如,在使用 Linux 操作系统的计算机上运行以下命令:
$ tar xvf <installation_program>.tar.gz
-
在 Red Hat OpenShift Cluster Manager 站点的 Pull Secret 页面中,下载您的安装 pull secret 的
.txt
文件。通过此 pull secret,您可以进行所含授权机构提供的服务的身份验证,这些服务包括为 OpenShift Container Platform 组件提供容器镜像的 Quay.io。
1.1.8. 创建安装配置文件
您可以自定义 Red Hat OpenStack Platform(RHOSP)上的 OpenShift Container Platform 安装。
先决条件
- 获取 OpenShift Container Platform 安装程序以及集群的 pull secret。
流程
创建
install-config.yaml
文件。运行以下命令:
$ ./openshift-install create install-config --dir=<installation_directory> 1
- 1
- 对于
<installation_directory>
,请指定用于保存安装程序所创建的文件的目录名称。
重要指定一个空目录。一些安装信息,如 bootstrap X.509 证书,有较短的过期间隔,因此不要重复使用安装目录。如果要重复使用另一个集群安装中的个别文件,可以将其复制到您的目录中。但是,一些安装数据的文件名可能会在发行版本之间有所改变。从 OpenShift Container Platform 老版本中复制安装文件时要格外小心。
在提示符处,提供您的云的配置详情:
可选:选择用来访问集群机器的 SSH 密钥。
注意对于您要在其上执行安装调试或灾难恢复的生产环境 OpenShift Container Platform 集群,请指定
ssh-agent
进程使用的 SSH 密钥。- 选择 openstack 作为目标平台。
- 指定用于安装集群的 Red Hat OpenStack Platform (RHOSP) 外部网络名称。
- 指定用于从外部访问 OpenShift API 的浮动 IP 地址。
- 指定至少有 16 GB RAM 用于 control plane 和计算节点的 RHOSP 类别。
- 选择集群要部署到的基域。所有 DNS 记录都将是这个基域的子域,并包含集群名称。
- 为集群输入一个名称。名称不能多于 14 个字符。
- 粘贴从 Red Hat OpenShift Cluster Manager 站点的 Pull Secret 页面中获取的 pull secret。
-
修改
install-config.yaml
文件。您可以在安装配置参数部分中找到有关可用参数的更多信息。 备份
install-config.yaml
文件,以便用于安装多个集群。重要install-config.yaml
文件会在安装过程中消耗掉。如果要重复使用此文件,必须现在备份。
1.1.9. 安装配置参数
在部署 OpenShift Container Platform 集群前,您可以提供参数值,以描述托管集群的云平台的帐户并选择性地自定义集群平台。在创建 install-config.yaml
安装配置文件时,您可以通过命令行来提供所需的参数的值。如果要自定义集群,可以修改 install-config.yaml
文件来提供关于平台的更多信息。
安装之后,您无法修改 install-config.yaml
文件中的这些参数。
参数 | 描述 | 值 |
---|---|---|
|
云供应商的基域。此值用于创建到 OpenShift Container Platform 集群组件的路由。集群的完整 DNS 名称是 |
完全限定域名或子域名,如 |
|
托管 control plane 机器的云供应商。此参数值必须与 |
|
|
托管 worker 机器的云供应商。此参数值必须与 |
|
| 集群的名称。 |
包含大写字母或小写字母的字符串,如 |
| 集群要部署到的区域。 |
云的有效区域,如 AWS 的 |
| 从 Red Hat OpenShift Cluster Manager 站点的 Pull Secret 页面中获取的 pull secret。您可以使用此 pull secret 来进行所含授权机构提供的服务的身份验证,这些服务包括为 OpenShift Container Platform 组件提供容器镜像的 Quay.io。 |
{ "auths":{ "cloud.openshift.com":{ "auth":"b3Blb=", "email":"you@example.com" }, "quay.io":{ "auth":"b3Blb=", "email":"you@example.com" } } } |
参数 | 描述 | 值 |
---|---|---|
| 用于访问集群机器的 SSH 密钥。 注意
对于您要在其上执行安装调试或灾难恢复的生产环境 OpenShift Container Platform 集群,请指定 |
添加到 |
| 是否启用或禁用 FIPS 模式。默认情况下不启用 FIPS 模式。如果启用了 FIPS 模式,运行 OpenShift Container Platform 的 Red Hat Enterprise Linux CoreOS (RHCOS) 机器会绕过默认的 Kubernetes 加密套件,并使用由 RHCOS 提供的加密模块。 |
|
| 如何发布集群的面向用户的端点。 |
|
|
是否在计算机器上启用或禁用并发多线程或 重要 如果禁用并发多线程,请确保在容量规划时考虑到机器性能可能会显著降低的问题。 |
|
| 要置备的计算机器数量,也称为 worker 机器。 |
大于或等于 |
|
是否在 control plane 机器上启用或禁用并发多线程或 重要 如果禁用并发多线程,请确保在容量规划时考虑到机器性能可能会显著降低的问题。 |
|
| 要置备的 control plane 机器数量。 |
大于或等于 |
参数 | 描述 | 值 |
---|---|---|
| 对于计算机器,以 GB 为单位表示的根卷大小。如果您不设置这个值,机器将使用临时存储。 |
整数,如 |
| 对于计算机器,根卷的类型。 |
字符串,如 |
| 对于 control plane 机器,以 GB 为单位表示的根卷大小。如果您不设置这个值,机器将使用临时存储。 |
整数,如 |
| 对于 control plane 机器,根卷的类型。 |
字符串,如 |
| 在其中创建 RHOSP 集群的区域。 |
字符串,如 |
|
要使用的 RHOSP 云的名称,来自于 |
字符串,如 |
| 用于安装的 RHOSP 外部网络名称。 |
字符串,如 |
| 用于 control plane 和计算机器的 RHOSP 类别。 |
字符串,如 |
| 与负载均衡器 API 关联的现有浮动 IP 地址。 |
IP 地址,如 |
参数 | 描述 | 值 |
---|---|---|
| 集群实例用于进行 DNS 解析的外部 DNS 服务器的 IP 地址。 |
包括 IP 地址列表的字符串,如 |
| 默认机器池平台配置。 |
{ "type": "ml.large", "rootVolume": { "size": 30, "type": "performance" } } |
| 安装程序从中下载 RHCOS 镜像的位置。 您必须设置此参数以便在受限网络中执行安装。 | HTTP 或 HTTPS URL,可选使用 SHA-256 checksum。
例如:
该值也可以是现有 Glance 镜像的名称,如 |
1.1.9.1. RHOSP 的自定义 install-config.yaml
文件示例
此示例 install-config.yaml
展示了所有可能的 Red Hat OpenStack Platform (RHOSP) 自定义选项。
此示例文件仅供参考。您必须使用安装程序来获取 install-config.yaml
文件。
apiVersion: v1 baseDomain: example.com clusterID: os-test controlPlane: name: master platform: {} replicas: 3 compute: - name: worker platform: openstack: type: ml.large replicas: 3 metadata: name: example networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 machineCIDR: 10.0.0.0/16 serviceNetwork: - 172.30.0.0/16 networkType: OpenShiftSDN platform: openstack: region: region1 cloud: mycloud externalNetwork: external computeFlavor: m1.xlarge lbFloatingIP: 128.0.0.1 fips: false pullSecret: '{"auths": ...}' sshKey: ssh-ed25519 AAAA...
1.1.10. 生成 SSH 私钥并将其添加到代理中
如果要在集群上执行安装调试或灾难恢复,则必须为 ssh-agent
和安装程序提供 SSH 密钥。
在生产环境中,您需要进行灾难恢复和调试。
您可以使用此密钥以 core
用户身份通过 SSH 连接到 master 节点。在部署集群时,此密钥会添加到 core
用户的 ~/.ssh/authorized_keys
列表中。
您必须使用一个本地密钥,而不要使用在特定平台上配置的密钥,如 AWS 密钥对。
流程
如果还没有为计算机上免密码身份验证而配置的 SSH 密钥,请创建一个。例如,在使用 Linux 操作系统的计算机上运行以下命令:
$ ssh-keygen -t rsa -b 4096 -N '' \ -f <path>/<file_name> 1
- 1
- 指定 SSH 密钥的路径和文件名,如
~/.ssh/id_rsa
。不要指定已存在的 SSH 密钥,因为它会被覆盖。
运行此命令会在指定的位置生成不需要密码的 SSH 密钥。
作为后台任务启动
ssh-agent
进程:$ eval "$(ssh-agent -s)" Agent pid 31874
将 SSH 私钥添加到
ssh-agent
:$ ssh-add <path>/<file_name> 1 Identity added: /home/<you>/<path>/<file_name> (<computer_name>)
- 1
- 指定 SSH 私钥的路径和文件名,如
~/.ssh/id_rsa
后续步骤
- 在安装 OpenShift Container Platform 时,为安装程序提供 SSH 公钥。
1.1.11. 启用对环境的访问
在部署时,所有 OpenShift Container Platform 机器都是在 Red Hat OpenStack Platform (RHOSP) 租户网络中创建的。因此,大多数 RHOSP 部署中都无法直接访问它们。
您可以配置 OpenShift Container Platform API,以便能使用或不使用浮动 IP 地址来访问。
1.1.11.1. 启用通过浮动 IP 地址进行访问
将两个浮动 IP (FIP) 地址附加到 OpenShift Container Platform API 端点以便可以访问这些端点:一个用于 API 负载均衡器 (lb FIP
),另一个用于 OpenShift Container Platform 应用程序 (apps FIP
)。
install-config.yaml
文件中也会使用负载均衡器 FIP。
流程
使用 Red Hat OpenStack Platform (RHOSP) CLI,创建一个新的外部网络:
$ openstack floating ip create <external network>
向您的 DNS 服务器中添加一条符合此模式的记录:
api.<cluster name>.<base domain> IN A <lb FIP>
注意如果您不控制 DNS 服务器,可以改为将记录添加到
/etc/hosts
文件中。此操作使 API 可供您自己访问,不适合于生产部署。这可用于进行开发和测试的安装。
您可以通过分配浮动 IP 地址并更新防火墙配置,使 OpenShift Container Platform 资源在集群之外可用。
1.1.11.2. 启用不通过浮动 IP 地址进行访问
如果您无法使用浮动 IP 地址,OpenShift Container Platform 安装或许仍然可以完成。不过,安装程序在等待 API 访问超时后会失败。
安装程序超时后,集群或许仍然可以初始化。 bootstrap 过程开始后,它必须完成。但是,您必须在部署后编辑集群网络配置。
1.1.12. 部署集群
您可以在兼容云平台中安装 OpenShift Container Platform。
安装程序的 create cluster
命令只能在初始安装过程中运行一次。
先决条件
- 获取 OpenShift Container Platform 安装程序以及集群的 pull secret。
流程
运行安装程序:
$ ./openshift-install create cluster --dir=<installation_directory> \ 1 --log-level=info 2
注意如果您在主机上配置的云供应商帐户没有足够的权限来部署集群,安装过程将会停止,并且显示缺少的权限。
集群部署完成后,终端会显示访问集群的信息,包括指向其 Web 控制台的链接和
kubeadmin
用户的凭证。重要安装程序生成的 Ignition 配置文件中所含的证书会在 24 小时后过期。您必须以非降级状态持续运行集群 24 小时,以确保完成第一次证书轮转。
重要您不得删除安装程序或安装程序所创建的文件。需要这两者才能删除集群。
1.1.13. 验证集群状态
在安装过程中或安装后验证 OpenShift Container Platform 集群的状态:
流程
在集群环境中,导出管理员的 kubeconfig 文件:
$ export KUBECONFIG=<installation_directory>/auth/kubeconfig 1
- 1
- 对于
<installation_directory>
,请指定安装文件保存到的目录的路径。
kubeconfig
文件包含关于集群的信息,供 CLI 用于将客户端连接到正确集群和 API 服务器。查看部署后创建的 control plane 和计算机器:
$ oc get nodes
查看集群的版本:
$ oc get clusterversion
查看 Operator 的状态:
$ oc get clusteroperator
查看集群中所有正在运行的 Pod:
$ oc get pods -A
1.1.14. 登录集群
您可以通过导出集群 kubeconfig
文件,以默认系统用户身份登录集群。kubeconfig
文件包含关于集群的信息,供 CLI 用于将客户端连接到正确集群和 API 服务器。该文件特只适用于一个特定的集群,在 OpenShift Container Platform 安装过程中创建。
先决条件
- 部署 OpenShift Container Platform 集群。
-
安装
oc
CLI。
流程
导出
kubeadmin
凭证:$ export KUBECONFIG=<installation_directory>/auth/kubeconfig 1
- 1
- 对于
<installation_directory>
,请指定安装文件保存到的目录的路径。
使用导出的配置,验证能否成功运行
oc
命令:$ oc whoami system:admin
1.1.15. 使用浮动 IP 地址配置应用程序访问
安装 OpenShift Container Platform 后,请配置 Red Hat OpenStack Platform (RHOSP) 以允许应用程序网络流量。
先决条件
- 必须已安装 OpenShift Container Platform 集群
- 已启用浮动 IP 地址,如启用对环境的访问中所述。
流程
在安装 OpenShift Container Platform 集群后,将浮动 IP 地址附加到入口端口:
显示端口:
$ openstack port show <cluster name>-<clusterID>-ingress-port
将端口附加到 IP 地址:
$ openstack floating ip set --port <ingress port ID> <apps FIP>
在您的 DNS 文件中,为
*apps.
添加一条通配符A
记录。*.apps.<cluster name>.<base domain> IN A <apps FIP>
如果您不控制 DNS 服务器,但希望为非生产用途启用应用程序访问,您可以将这些主机名添加到 /etc/hosts
:
<apps FIP> console-openshift-console.apps.<cluster name>.<base domain> <apps FIP> integrated-oauth-server-openshift-authentication.apps.<cluster name>.<base domain> <apps FIP> oauth-openshift.apps.<cluster name>.<base domain> <apps FIP> prometheus-k8s-openshift-monitoring.apps.<cluster name>.<base domain> <apps FIP> grafana-openshift-monitoring.apps.<cluster name>.<base domain> <apps FIP> <app name>.apps.<cluster name>.<base domain>
1.1.16. 后续步骤
- 自定义集群。
- 若有需要,您可以选择不使用远程健康报告。
- 如果您需要启用对节点端口的外部访问,请使用 NodePort 配置集群流量。