Red Hat Summit1.10. Policy API
1.10.1. 概要
このドキュメントでは、Red Hat Advanced Cluster Management for Kubernetes の Policy リソースについて説明します。Policy リソースには、create、query、delete、update の 4 つの要求を使用できます。
1.10.1.1. バージョン情報
バージョン: 2.5.0
1.10.1.2. URI スキーム
ベースパス: /kubernetes/apis
スキーム: HTTPS
1.10.1.3. タグ
- policy.open-cluster-management.io/v1: ポリシーを作成して管理します。
1.10.2. パス
1.10.2.1. ポリシーの作成
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}
POST /policy.open-cluster-management.io/v1/v1alpha1/namespaces/{namespace}/policies/{policy_name}1.10.2.1.1. 説明
ポリシーを作成します。
1.10.2.1.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
| ボディー |
body | 作成するポリシーを記述するパラメーター |
1.10.2.1.3. 応答
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.1.4. 消費
-
application/json
1.10.2.1.5. タグ
- policy.open-cluster-management.io
1.10.2.1.6. HTTP 要求の例
1.10.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",
"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"
],
},
],
},
},
},
},
{
"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",
"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.10.2.2. 全ポリシーのクエリー
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.10.2.2.1. 説明
ポリシーに対してクエリーを実行して詳細を確認します。
1.10.2.2.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
namespace | ポリシーを適用する namespace (例: default) | 文字列 |
1.10.2.2.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.2.4. 消費
-
application/json
1.10.2.2.5. タグ
- policy.open-cluster-management.io
1.10.2.3. 単一ポリシーのクエリー
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
GET /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.10.2.3.1. 説明
1 つのポリシーに対してクエリーを実行して詳細を確認します。
1.10.2.3.2. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
policy_name | 問い合わせるポリシーの名前 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.10.2.3.3. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.3.4. タグ
- policy.open-cluster-management.io
1.10.2.4. ポリシーの削除
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}
DELETE /policy.open-cluster-management.io/v1/namespaces/{namespace}/policies/{policy_name}1.10.2.4.1. パラメーター
| 型 | 名前 | 説明 | スキーマ |
|---|---|---|---|
| ヘッダー |
COOKIE | Authorization: Bearer {ACCESS_TOKEN}。ACCESS_TOKEN はユーザーのアクセストークンに置き換えます。 | 文字列 |
| パス |
policy_name | 削除するポリシーの名前 | 文字列 |
| パス |
namespace | 使用する namespace (例: default) | 文字列 |
1.10.2.4.2. レスポンス
| HTTP コード | 説明 | スキーマ |
|---|---|---|
| 200 | 成功 | コンテンツなし |
| 403 | アクセス禁止 | コンテンツなし |
| 404 | リソースが見つからない | コンテンツなし |
| 500 | 内部サービスエラー | コンテンツなし |
| 503 | サービスが利用できない | コンテンツなし |
1.10.2.4.3. タグ
- policy.open-cluster-management.io
1.10.3. 定義
1.10.3.1. Policy
| Name | 説明 | スキーマ |
|---|---|---|
|
apiVersion | Policy のバージョンスキーマ | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | ポリシーを定義するルールを記述します。 | オブジェクト |
spec
| 名前 | 説明 | スキーマ |
|---|---|---|
|
remediationAction | リソースで定義されているように違反をどのように処理するかを表す値 | string |
|
namespaceSelector | ポリシーが適用される namespace を表す値 | 文字列 |
policy-templates
| Name | 説明 | スキーマ |
|---|---|---|
|
apiVersion | Policy のバージョンスキーマ | string |
|
kind | REST リソースを表す文字列の値 | string |
|
metadata | ポリシーを定義するルールを記述します。 | オブジェクト |
| complianceType | マネージドクラスターに評価または適用する必要のあるロールおよび他の Kubernetes オブジェクトの予想される動作を一覧表示するのに使用されます。 | string |
|
metadataComplianceType |
ユーザーがオブジェクトのラベルおよび注釈を他のフィールドとは異なる方法で処理する方法を提供します。パラメーター値は、デフォルトで | string |
|
clusterConditions | ラベルを定義するセクション | string |
|
rules | string |
clusterConditions
| Name | 説明 | スキーマ |
|---|---|---|
|
matchLabels | ポリシーを namespace に適用するのに必要なラベル | object |
|
cloud | ポリシーをクラウドプロバイダーに適用するのに必要なラベル | 文字列 |
rules
| Name | 説明 | スキーマ |
|---|---|---|
|
apiGroups | このルールが適用される API の一覧 | string |
|
resources | リソースタイプの一覧 | object |
|
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}