红帽全球峰会1.11. Policy API
1.11.1. 概述
本文档介绍了与 Red Hat Advanced Cluster Management for Kubernetes 的策略（Policy）资源相关的 API 信息。Policy 资源有 4 个可用的请求：create、query、delete 和 update。
1.11.1.1. 版本信息
版本 : 2.12.0
1.11.1.2. URI scheme
BasePath : /kubernetes/apis
Schemes : HTTPS
1.11.1.3. Tags
- policy.open-cluster-management.io/v1 : 创建和管理策略
1.11.2. 路径
1.11.2.1. 创建策略
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}1.11.2.1.1. 描述
创建策略
1.11.2.1.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
| Body |
body | 描述要创建策略的参数。 |
1.11.2.1.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.11.2.1.4. 使用
-
application/json
1.11.2.1.5. Tags
- policy.open-cluster-management.io
1.11.2.1.6. HTTP 请求示例
1.11.2.1.6.1. 请求正文
{
"apiVersion": "policy.open-cluster-management.io/v1",
"kind": "Policy",
"metadata": {
"name": "test-policy-swagger",
"description": "Example body for Policy API Swagger docs"
},
"spec": {
"remediationAction": "enforce",
"customMessage": {
"compliant": [],
"noncompliant": []
},
"namespaces": {
"include": [
"default"
],
"exclude": [
"kube*"
]
},
"policy-templates": {
"kind": "ConfigurationPolicy",
"apiVersion": "policy.open-cluster-management.io/v1",
"complianceType": "musthave",
"metadataComplianceType": "musthave",
"metadata": {
"namespace": null,
"name": "test-role"
},
"selector": {
"matchLabels": {
"cloud": "IBM"
}
},
"spec" : {
"object-templates": {
"complianceType": "musthave",
"metadataComplianceType": "musthave",
"objectDefinition": {
"apiVersion": "rbac.authorization.k8s.io/v1",
"kind": "Role",
"metadata": {
"name": "role-policy",
},
"rules": [
{
"apiGroups": [
"extensions",
"apps"
],
"resources": [
"deployments"
],
"verbs": [
"get",
"list",
"watch",
"delete"
]
},
{
"apiGroups": [
"core"
],
"resources": [
"pods"
],
"verbs": [
"create",
"update",
"patch"
]
},
{
"apiGroups": [
"core"
],
"resources": [
"secrets"
],
"verbs": [
"get",
"watch",
"list",
"create",
"delete",
"update",
"patch"
],
},
],
},
},
},
},1.11.2.2. 查询所有策略
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.11.2.2.1. 描述
查询您的策略以获得更详细的信息。
1.11.2.2.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
namespace | 要应用策略的命名空间，如 default。 | 字符串 |
1.11.2.2.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.11.2.2.4. 使用
-
application/json
1.11.2.2.5. Tags
- policy.open-cluster-management.io
1.11.2.3. 查询单个策略
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.11.2.3.1. 描述
查询单个策略以获取更多详细信息。
1.11.2.3.2. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
policy_name | 要查询的策略的名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.11.2.3.3. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.11.2.3.4. Tags
- policy.open-cluster-management.io
1.11.2.4. 删除策略
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.11.2.4.1. 参数
| 类型 | Name | 描述 | 模式 |
|---|---|---|---|
| 标头 |
COOKIE | 身份验证：Bearer {ACCESS_TOKEN} ; ACCESS_TOKEN 是用户访问令牌。 | 字符串 |
| 路径 |
policy_name | 要删除的策略名称。 | 字符串 |
| 路径 |
namespace | 要使用的命名空间，如 default。 | 字符串 |
1.11.2.4.2. 响应
| HTTP 代码 | 描述 | 模式 |
|---|---|---|
| 200 | 成功 | 无内容 |
| 403 | 禁止访问 | 无内容 |
| 404 | 未找到资源 | 无内容 |
| 500 | 内部服务错误 | 无内容 |
| 503 | 服务不可用 | 无内容 |
1.11.2.4.3. Tags
- policy.open-cluster-management.io
1.11.3. 定义
1.11.3.1. policy
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 策略的版本化模式（schema）。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | 描述定义策略的规则。 | 对象 |
spec
| Name | 描述 | 模式 |
|---|---|---|
|
remediationAction | 代表资源中定义的处理违反情况的值。 | string |
|
customMessage |
参数字段，您可以根据合规性状态配置来自配置策略的自定义消息。您可以使用配置策略控制器中策略当前状态的 | string |
|
namespaceSelector | 代表策略要应用到的命名空间的值。 | 字符串 |
policy-templates
| Name | 描述 | 模式 |
|---|---|---|
|
apiVersion | 策略的版本化模式（schema）。 | 字符串 |
|
kind | 代表 REST 资源的字符串值。 | 字符串 |
|
metadata | 描述定义策略的规则。 | 对象 |
| complianceType | 用于列出必须被评估或应用到受管集群的角色的预期行为和任何 Kubernetes 对象。 | 字符串 |
|
metadataComplianceType |
为用户提供处理对象标签和注解的方式与其他字段不同。参数值默认为 | 字符串 |
| 定义标签的部分。 | 字符串 | |
|
rules | 字符串 |
clusterConditions
| Name | 描述 | 模式 |
|---|---|---|
|
matchLabels | 策略应用到一个命名空间所需的标签。 | 对象 |
|
cloud | 策略应用到一个云供应商所需的标签。 | 字符串 |
rules
| Name | 描述 | 模式 |
|---|---|---|
|
apiGroups | 适用于该规则的 API 列表。 | 字符串 |
|
resources | 资源类型列表。 | 对象 |
|
verbs | 动词列表。 | 字符串 |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}