主页
产品
Migration Toolkit for Virtualization
2.8
安装并使用 Migration Toolkit for Virtualization
12.2. 为 Validation 服务创建自定义规则

12.2. 为 Validation 服务创建自定义规则

Validation 服务使用 Open Policy Agent(OPA)策略规则来检查要迁移的每个虚拟机(VM)的适用性。Validation 服务为每个虚拟机生成问题列表，它们作为虚拟机属性存储在 Provider Inventory 服务中。Web 控制台显示供应商清单中的每个虚拟机的顾虑。

您可以创建自定义规则来扩展 Validation 服务的默认规则集。例如，您可以创建一个规则来检查虚拟机是否有多个磁盘。

12.2.1. 关于 Rego 文件

验证规则使用 Rego 编写，即 Open Policy Agent (OPA) 原生查询语言。规则作为 .rego 文件存储在 Validation pod 的 /usr/share/opa/policies/io/konveyor/forklift/<provider> 目录中。

每个验证规则都在单独的 .rego 文件中定义，以及对特定条件的测试。如果条件评估为 true，则该规则会将 {"category", "label", "assessment"} hash 添加到 concerns 中。concerns 内容将添加到虚拟机清单记录中的 concerns 键中。Web 控制台显示供应商清单中每个虚拟机的 concerns 键的内容。

以下 .rego 文件示例检查在 VMware 虚拟机的集群中启用了分布式资源调度：

drs_enabled.rego 示例

Copy to Clipboard Toggle word wrap

package io.konveyor.forklift.vmware 

has_drs_enabled {
    input.host.cluster.drsEnabled 
}

concerns[flag] {
    has_drs_enabled
    flag := {
        "category": "Information",
        "label": "VM running in a DRS-enabled cluster",
        "assessment": "Distributed resource scheduling is not currently supported by OpenShift Virtualization. The VM can be migrated but it will not have this feature in the target environment."
    }
}

package io.konveyor.forklift.vmware



has_drs_enabled {
    input.host.cluster.drsEnabled


}

concerns[flag] {
    has_drs_enabled
    flag := {
        "category": "Information",
        "label": "VM running in a DRS-enabled cluster",
        "assessment": "Distributed resource scheduling is not currently supported by OpenShift Virtualization. The VM can be migrated but it will not have this feature in the target environment."
    }
}

1: 每个验证规则都在软件包中定义。软件包命名空间是 io.konveyor.forklift.vmware（VMware）和 io.konveyor.forklift.ovirt（Red Hat Virtualization）。
2: 查询参数基于 Validation 服务 JSON 的 input 键。

12.2.2. 检查默认验证规则

在创建自定义规则前，您必须检查 Validation 服务的默认规则，以确保您不会创建重新定义现有默认值的规则。

示例：如果默认规则包含行 default valid_input = false，并且您创建一个包含行 default valid_input = true，则 Validation 服务将不会启动。

流程

连接到 Validation pod 的终端：
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
```
oc rsh <validation_pod>
```
```
$ oc rsh <validation_pod>
```
进入您的供应商的 OPA 策略目录：
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
```
cd /usr/share/opa/policies/io/konveyor/forklift/<provider>
```
```
$ cd /usr/share/opa/policies/io/konveyor/forklift/<provider> 
```
1
1
指定 vmware 或 ovirt。
搜索默认策略：
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
```
grep -R "default" *
```
```
$ grep -R "default" *
```

12.2.3. 创建验证规则

您可以通过将包含规则的配置映射自定义资源(CR)应用到 Validation 服务来创建验证规则。

重要

如果您创建与现有规则相同的规则，Validation 服务将使用规则执行 OR 操作。
如果您创建使用默认规则迭代的规则，则 Validation 服务将不会启动。

验证规则示例

验证规则基于由 Provider Inventory 服务收集的虚拟机(VM)属性。

例如，VMware API 使用此路径来检查 VMware 虚拟机是否配置了 NUMA 节点关联性：MOR:VirtualMachine.config.extraConfig["numa.nodeAffinity"]。

Provider Inventory 服务使用列表值简化了此配置并返回一个可测试属性：

Copy to Clipboard Toggle word wrap

"numaNodeAffinity": [
    "0",
    "1"
],

"numaNodeAffinity": [
    "0",
    "1"
],

您可以根据此属性创建一个 Rego 查询，并将其添加到 forklift-validation-config 配置映射中：

Copy to Clipboard Toggle word wrap

`count(input.numaNodeAffinity) != 0`

`count(input.numaNodeAffinity) != 0`

流程

根据以下示例创建配置映射 CR：

Copy to Clipboard Toggle word wrap

cat << EOF | oc apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
  name: <forklift-validation-config>
  namespace: openshift-mtv
data:
  vmware_multiple_disks.rego: |-
    package <provider_package>

    has_multiple_disks {
      count(input.disks) > 1
    }

    concerns[flag] {
      has_multiple_disks
        flag := {
          "category": "<Information>",
          "label": "Multiple disks detected",
          "assessment": "Multiple disks detected on this VM."
        }
    }
EOF

$ cat << EOF | oc apply -f -
apiVersion: v1
kind: ConfigMap
metadata:
  name: <forklift-validation-config>
  namespace: openshift-mtv
data:
  vmware_multiple_disks.rego: |-
    package <provider_package>



    has_multiple_disks {


      count(input.disks) > 1
    }

    concerns[flag] {
      has_multiple_disks


        flag := {
          "category": "<Information>",


          "label": "Multiple disks detected",
          "assessment": "Multiple disks detected on this VM."
        }
    }
EOF

1: 指定供应商软件包名称。允许的值是 VMware 的 io.konveyor.forklift.vmware 和 io.konveyor.forklift.ovirt。
2: 指定 concerns 名称和 Rego 查询。
3: 指定 concerns 名称和 flag 参数值。
4: 允许的值是 Critical, Warning, 和 Information。

通过将 forklift-controller 部署扩展到 0 来停止 Validation pod：

Copy to Clipboard Toggle word wrap

oc scale -n openshift-mtv --replicas=0 deployment/forklift-controller

$ oc scale -n openshift-mtv --replicas=0 deployment/forklift-controller

通过将 forklift-controller 部署扩展到 1 来启动 Validation pod：

Copy to Clipboard Toggle word wrap

oc scale -n openshift-mtv --replicas=1 deployment/forklift-controller

$ oc scale -n openshift-mtv --replicas=1 deployment/forklift-controller

检查 Validation pod 日志，以验证 pod 是否已启动：
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
```
oc logs -f <validation_pod>
```
```
$ oc logs -f <validation_pod>
```
如果自定义规则与默认规则冲突，则 Validation pod 将不会启动。

删除源供应商：

Copy to Clipboard Toggle word wrap

oc delete provider <provider> -n openshift-mtv

$ oc delete provider <provider> -n openshift-mtv

添加源供应商以应用新规则：

Copy to Clipboard Toggle word wrap

cat << EOF | oc apply -f -
apiVersion: forklift.konveyor.io/v1beta1
kind: Provider
metadata:
  name: <provider>
  namespace: openshift-mtv
spec:
  type: <provider_type>
  url: <api_end_point>
  secret:
    name: <secret>
    namespace: openshift-mtv
EOF

$ cat << EOF | oc apply -f -
apiVersion: forklift.konveyor.io/v1beta1
kind: Provider
metadata:
  name: <provider>
  namespace: openshift-mtv
spec:
  type: <provider_type>


  url: <api_end_point>


  secret:
    name: <secret>


    namespace: openshift-mtv
EOF

1: 允许的值有 ovirt、vsphere 和 openstack。
2: 指定 API 端点 URL，例如 https://<vCenter_host>/sdk for vSphere, https://<engine_host>/ovirt-engine/api for RHV, 或 https://<identity_service>/v3 (OpenStack)。
3: 指定供应商 Secret CR 的名称。

您必须在创建自定义规则后更新规则版本，以便 Inventory 服务检测到更改并验证虚拟机。

12.2.4. 更新清单规则版本

每次更新规则时，您必须更新 inventory 规则版本，以便 Provider Inventory 服务检测到更改并触发 Validation 服务。

规则版本记录在每个供应商的 rules_version.rego 文件中。

流程

检索当前的规则版本：

Copy to Clipboard Toggle word wrap

GET https://forklift-validation/v1/data/io/konveyor/forklift/<provider>/rules_version

$ GET https://forklift-validation/v1/data/io/konveyor/forklift/<provider>/rules_version

输出示例

Copy to Clipboard Toggle word wrap

{
   "result": {
       "rules_version": 5
   }
}

{
   "result": {
       "rules_version": 5
   }
}

连接到 Validation pod 的终端：
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
```
oc rsh <validation_pod>
```
```
$ oc rsh <validation_pod>
```
更新 /usr/share/opa/policies/io/konveyor/forklift/<provider>/rules_version.rego 文件中的规则版本。
从 Validation pod 终端注销。

验证更新的规则版本：

Copy to Clipboard Toggle word wrap

GET https://forklift-validation/v1/data/io/konveyor/forklift/<provider>/rules_version

$ GET https://forklift-validation/v1/data/io/konveyor/forklift/<provider>/rules_version

输出示例

Copy to Clipboard Toggle word wrap

{
   "result": {
       "rules_version": 6
   }
}

{
   "result": {
       "rules_version": 6
   }
}

返回顶部

12.2. 为 Validation 服务创建自定义规则

12.2.1. 关于 Rego 文件

12.2.2. 检查默认验证规则

12.2.3. 创建验证规则

12.2.4. 更新清单规则版本

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links