セキュリティー API


OpenShift Container Platform 4.16

セキュリティー API のリファレンスガイド

Red Hat OpenShift Documentation Team

概要

このドキュメントでは、OpenShift Container Platform セキュリティー API オブジェクトとその詳細な仕様を説明します。

第1章 セキュリティー API

1.1. CertificateSigningRequest [certificates.k8s.io/v1]

説明

CertificateSigningRequest オブジェクトは、証明書署名要求を送信し、非同期で承認および発行することにより、x509 証明書を取得するメカニズムを提供します。

Kubelets はこの API を使用して以下を取得します。1。kube-apiserver に対して認証するクライアント証明書 ("kubernetes.io/kube-apiserver-client-kubelet" signerName を使用)。2. TLS エンドポイントのサービング証明書 kube-apiserver は安全に接続できます ("kubernetes.io/kubelet-serving" signerName を使用)。

この API を使用して、クライアント証明書に kube-apiserver への認証 ("kubernetes.io/kube-apiserver-client" signerName を使用) を要求したり、カスタムの非 Kubernetes 署名者から証明書を取得したりできます。

object

1.2. CredentialsRequest [cloudcredential.openshift.io/v1]

説明
CredentialsRequest は、credentialsrequests API のスキーマです。
object

1.3. PodSecurityPolicyReview [security.openshift.io/v1]

説明

PodSecurityPolicyReview は、問題の PodTemplateSpec を作成できるサービスアカウント (ユーザーではなく、クラスター全体であるため) をチェックします。

互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

object

1.4. PodSecurityPolicySelfSubjectReview [security.openshift.io/v1]

説明

PodSecurityPolicySelfSubjectReview は、このユーザー/SA タプルが PodTemplateSpec を作成できるかどうかを確認します

互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

object

1.5. PodSecurityPolicySubjectReview [security.openshift.io/v1]

説明

PodSecurityPolicySubjectReview は、特定のユーザー/SA タプルが PodTemplateSpec を作成できるかどうかをチェックします。

互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

object

1.6. RangeAllocation [security.openshift.io/v1]

説明

RangeAllocation が使用されるため、セキュリティーグループ用に入力された RangeAllocation を簡単に公開できます。

互換性レベル 4: 互換性は提供されていません。API は、理由を問わずいつでも変更できます。これらの機能は、長期サポートを必要とするアプリケーションで使用することはできません。

object

1.7. Secret [v1]

説明
Secret は特定のタイプのシークレットデータを保持します。Data フィールドの値の合計バイト数は MaxSecretSize バイト未満である必要があります。
object

1.8. SecurityContextConstraints [security.openshift.io/v1]

説明
SecurityContextConstraints は、コンテナーに適用される SecurityContext に影響を与える要求を行う機能を管理します。歴史的な理由から、SCC はコア Kubernetes API グループの下で公開されていました。このエクスポージャーは非推奨であり、将来のリリースで削除される予定です。代わりに、ユーザーは security.openshift.io グループを使用して SecurityContextConstraints を管理する必要があります。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) の間 Stable です。
object

1.9. ServiceAccount [v1]

説明
ServiceAccount は互いにバインドします:*ユーザーおよびおそらく周辺システムによって理解される ID の名前*認証および承認できるプリンシパル*一連のシークレット
object

第2章 CertificateSigningRequest [certificates.k8s.io/v1]

説明

CertificateSigningRequest オブジェクトは、証明書署名要求を送信し、非同期で承認および発行することにより、x509 証明書を取得するメカニズムを提供します。

Kubelets はこの API を使用して以下を取得します。1。kube-apiserver に対して認証するクライアント証明書 ("kubernetes.io/kube-apiserver-client-kubelet" signerName を使用)。2. TLS エンドポイントのサービング証明書 kube-apiserver は安全に接続できます ("kubernetes.io/kubelet-serving" signerName を使用)。

この API を使用して、クライアント証明書に kube-apiserver への認証 ("kubernetes.io/kube-apiserver-client" signerName を使用) を要求したり、カスタムの非 Kubernetes 署名者から証明書を取得したりできます。

object
必須
  • spec

2.1. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

 

spec

object

CertificateSigningRequestSpec には、証明書要求が含まれています。

status

object

CertificateSigningRequestStatus には、リクエストの承認/拒否/失敗ステータス、および発行された証明書を示すために使用される条件が含まれています。

2.1.1. .spec

説明
CertificateSigningRequestSpec には、証明書要求が含まれています。
object
必須
  • request
  • signerName
Expand
プロパティー説明

expirationSeconds

integer

expirationSeconds は、発行された証明書の要求された有効期間です。証明書の署名者は、有効期間が異なる証明書を発行する場合があるため、クライアントは、発行された証明書の notBefore フィールドと notAfter フィールドの間のデルタをチェックして、実際の期間を決定する必要があります。

有名な Kubernetes 署名者の v1.22+ ツリー内実装は、要求された期間が、Kubernetes への --cluster-signing-duration CLI フラグに従って尊重する最大期間を超えない限り、このフィールドを尊重します。コントローラーマネージャー。

証明書の署名者は、さまざまな理由でこのフィールドを尊重しない場合があります。

1.フィールドを認識しない古い署名者 (v1.22 より前のツリー内実装など)2。設定された最大値が要求された期間より短い署名者 3。設定された最小値が要求された期間よりも長い署名者

expirationSeconds の有効な最小値は 600、つまり 10 分です。

extra

object

extra には、CertificateSigningRequest を作成したユーザーの追加属性が含まれます。作成時に API サーバーによって入力され、不変です。

extra{}

array (string)

 

groups

array (string)

groups には、CertificateSigningRequest を作成したユーザーのグループメンバーシップが含まれます。作成時に API サーバーによって入力され、不変です。

request

string

要求には、"CERTIFICATE REQUEST" PEM ブロックにエンコードされた x509 証明書署名要求が含まれています。JSON または YAML としてシリアル化される場合、データはさらに base64 でエンコードされます。

signerName

string

signerName は、要求された署名者を示し、修飾された名前です。

CertificateSigningRequests のリスト/ウォッチリクエストは、"spec.signerName=NAME" fieldSelector を使用してこのフィールドでフィルタリングできます。

よく知られている Kubernetes 署名者は次のとおりです。1. "kubernetes.io/kube-apiserver-client": kube-apiserver への認証に使用できるクライアント証明書を発行します。この署名者のリクエストは、kube-controller-manager によって自動承認されることはなく、kube-controller-manager の "csrsigning" コントローラーによって発行できます。2. "kubernetes.io/kube-apiserver-client-kubelet": kubelets が kube-apiserver への認証に使用するクライアント証明書を発行します。この署名者のリクエストは、kube-controller-manager の "csrapproving" コントローラーによって自動承認され、kube-controller-manager の "csrsigning" コントローラーによって発行されます。3. "kubernetes.io/kubelet-serving" は、kubelet が TLS エンドポイントを提供するのに使用する証明書の提供を発行します。これは、kube-apiserver が安全に接続できます。この署名者のリクエストは、kube-controller-manager によって自動承認されることはなく、kube-controller-manager の "csrsigning" コントローラーによって発行できます。

詳細は、https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers を参照してください。

カスタム signerNames も指定できます。署名者は次のように定義します。1. 信頼の配布: 信頼 (CA バンドル) の配布方法。2. 許可された対象: および許可されていない対象が要求された場合の動作。3. 要求内の必須、許可、または禁止されている x509 拡張 (subjectAltNames が許可されているかどうか、どのタイプ、許可されている値の制限を含む)、および許可されていない拡張が要求された場合の動作。4. 必須、許可、または禁止されているキーの使用法/拡張キーの使用法。5. 有効期限/証明書の有効期間: 署名者によって修正されたかどうか、管理者によって設定可能かどうか。6. CA 証明書の要求が許可されるかどうか。

uid

string

uid には、CertificateSigningRequest を作成したユーザーの uid が含まれます。作成時に API サーバーによって入力され、不変です。

usages

array (string)

使用法は、発行された証明書で要求された一連の主要な使用法を指定します。

TLS クライアント証明書の要求は通常、"デジタル署名"、"キー暗号化"、"クライアント認証" を要求します。

TLS サービング証明書の要求は通常、"キー暗号化"、"デジタル署名"、"サーバー認証" を要求します。

有効な値は、"signing"、"digital signature"、"content commitment"、"key encipherment"、"key agreement"、"data encipherment"、"cert sign"、"crl sign"、"encipher only"、"decipher only"、"any"、"server auth"、"client auth"、"code signing"、"email protection"、"s/mime"、"ipsec end system"、"ipsec tunnel"、"ipsec user"、"timestamping"、"ocsp signing"、"microsoft sgc"、"netscape sgc" です。

username

string

username には、CertificateSigningRequest を作成したユーザーの名前が含まれます。作成時に API サーバーによって入力され、不変です。

2.1.2. .spec.extra

説明
extra には、CertificateSigningRequest を作成したユーザーの追加属性が含まれます。作成時に API サーバーによって入力され、不変です。
object

2.1.3. .status

説明
CertificateSigningRequestStatus には、リクエストの承認/拒否/失敗ステータス、および発行された証明書を示すために使用される条件が含まれています。
object
Expand
プロパティー説明

certificate

string

証明書には、承認済み条件が存在した後、署名者によって発行された証明書が入力されます。このフィールドは、/status サブリソースを介して設定されます。一度入力されると、このフィールドは不変です。

証明書署名要求が拒否された場合、タイプ "Denied" の条件が追加され、このフィールドは空のままになります。署名者が証明書を発行できない場合は、タイプ "Failed" の条件が追加され、このフィールドは空のままになります。

検証要件:1. 証明書には 1 つ以上の PEM ブロックが含まれている必要があります。2. すべての PEM ブロックには、"CERTIFICATE" ラベルが付いていて、ヘッダーが含まれていない必要があります。また、エンコードされたデータは、RFC5280 のセクション 4 で説明されている BER エンコードされた ASN.1 証明書構造である必要があります。3. 非 PEM コンテンツは、"CERTIFICATE" PEM ブロックの前または後に表示される場合があり、RFC7468 のセクション 5.2 で説明されている説明テキストを許可するために、検証されていません。

複数の PEM ブロックが存在し、要求された spec.signerName の定義がそれ以外を示さない場合、最初のブロックは発行された証明書であり、後続のブロックは中間証明書として扱われ、TLS ハンドシェイクで提示される必要があります。

証明書は PEM 形式でエンコードされています。

JSON または YAML としてシリアル化される場合、データはさらに base64 でエンコードされるため、次のもので構成されます。

base64( -----BEGIN CERTIFICATE----- …​ -----END CERTIFICATE----- )

conditions

array

リクエストに適用される条件。既知の条件は、"Approved"、"Denied"、および "Failed" です。

conditions[]

object

CertificateSigningRequestCondition は、CertificateSigningRequest オブジェクトの条件を記述します

2.1.4. .status.conditions

説明
リクエストに適用される条件。既知の条件は、"Approved"、"Denied"、および "Failed" です。
array

2.1.5. .status.conditions[]

説明
CertificateSigningRequestCondition は、CertificateSigningRequest オブジェクトの条件を記述します
object
必須
  • type
  • status
Expand
プロパティー説明

lastTransitionTime

time

lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。設定されていない場合、新しい条件タイプが追加されるか、既存の条件のステータスが変更されると、サーバーはこれを現在の時刻にデフォルト設定します。

lastUpdateTime

time

lastUpdateTime は、この条件が最後に更新された時刻です。

message

string

メッセージには、リクエストの状態に関する詳細を含む人間が読めるメッセージが含まれています

reason

string

reason は、リクエスト状態の簡単な理由を示します

status

string

条件のステータス、True、False、Unknown のいずれか。承認、拒否、および失敗の条件は、"False" または "Unknown" ではない場合があります。

type

string

条件の型。既知の条件は、"Approved"、"Denied"、および "Failed" です。

"Approved" 条件は /approval サブリソースを介して追加され、要求が承認され、署名者が発行する必要があることを示します。

"Denied" は /approval サブリソースを介して追加され、要求が拒否されたため、署名者が発行してはならないことを示します。

"Failed" 条件が /status サブリソースを介して追加され、署名者が証明書の発行に失敗したことを示します。

承認された条件と拒否された条件は相互に排他的です。承認済み、拒否済み、および失敗した条件は、一度追加すると削除できません。

特定のタイプの条件は 1 つだけ許可されます。

2.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/certificates.k8s.io/v1/certificatesigningrequests

    • 削除:CertificateSigningRequest のコレクションを削除します
    • GET: 種類の CertificateSigningRequest のオブジェクトをリスト表示または監視します
    • POST:CertificateSigningRequest を作成します
  • /apis/certificates.k8s.io/v1/watch/certificatesigningrequests

    • GET:CertificateSigningRequest のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}

    • 削除:CertificateSigningRequest を削除します
    • GET: 指定された CertificateSigningRequest を読み取ります
    • PATCH: 指定された CertificateSigningRequest を部分的に更新します
    • PUT: 指定された CertificateSigningRequest を置き換えます
  • /apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name}

    • GET: 種類 CertificateSigningRequest のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
  • /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status

    • GET: 指定された CertificateSigningRequest のステータスを読み取ります
    • PATCH: 指定された CertificateSigningRequest のステータスを部分的に更新します
    • PUT: 指定された CertificateSigningRequest のステータスを置き換えます
  • /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval

    • GET: 指定された CertificateSigningRequest の承認を読み取ります
    • PATCH: 指定された CertificateSigningRequest の承認を部分的に更新します
    • PUT: 指定された CertificateSigningRequest の承認を置き換えます

2.2.1. /apis/certificates.k8s.io/v1/certificatesigningrequests

HTTP メソッド
DELETE
説明
CertificateSigningRequest のコレクションを削除します
Expand
表2.1 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表2.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示または監視する CertificateSigningRequest
Expand
表2.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequestList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
CertificateSigningRequest を作成します
Expand
表2.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表2.5 ボディーパラメーター
パラメーター説明

body

CertificateSigningRequest スキーマ

 
Expand
表2.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

201 - Created

CertificateSigningRequest スキーマ

202 - Accepted

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

2.2.2. /apis/certificates.k8s.io/v1/watch/certificatesigningrequests

HTTP メソッド
GET
説明
CertificateSigningRequest のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表2.7 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

2.2.3. /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}

Expand
表2.8 グローバルパスパラメーター
パラメーター説明

name

string

CertificateSigningRequest の名前

HTTP メソッド
DELETE
説明
CertificateSigningRequest を削除します
Expand
表2.9 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表2.10 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された CertificateSigningRequest を読み取ります
Expand
表2.11 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された CertificateSigningRequest を部分的に更新します
Expand
表2.12 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表2.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

201 - Created

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された CertificateSigningRequest を置き換えます
Expand
表2.14 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表2.15 ボディーパラメーター
パラメーター説明

body

CertificateSigningRequest スキーマ

 
Expand
表2.16 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

201 - Created

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

2.2.4. /apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name}

Expand
表2.17 グローバルパスパラメーター
パラメーター説明

name

string

CertificateSigningRequest の名前

HTTP メソッド
GET
説明
種類 CertificateSigningRequest のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表2.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

2.2.5. /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status

Expand
表2.19 グローバルパスパラメーター
パラメーター説明

name

string

CertificateSigningRequest の名前

HTTP メソッド
GET
説明
指定された CertificateSigningRequest のステータスを読み取ります
Expand
表2.20 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された CertificateSigningRequest のステータスを部分的に更新します
Expand
表2.21 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表2.22 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

201 - Created

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された CertificateSigningRequest のステータスを置き換えます
Expand
表2.23 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表2.24 ボディーパラメーター
パラメーター説明

body

CertificateSigningRequest スキーマ

 
Expand
表2.25 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

201 - Created

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

2.2.6. /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/approval

Expand
表2.26 グローバルパスパラメーター
パラメーター説明

name

string

CertificateSigningRequest の名前

HTTP メソッド
GET
説明
指定された CertificateSigningRequest の承認を読み取ります
Expand
表2.27 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された CertificateSigningRequest の承認を部分的に更新します
Expand
表2.28 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表2.29 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

201 - Created

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された CertificateSigningRequest の承認を置き換えます
Expand
表2.30 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表2.31 ボディーパラメーター
パラメーター説明

body

CertificateSigningRequest スキーマ

 
Expand
表2.32 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CertificateSigningRequest スキーマ

201 - Created

CertificateSigningRequest スキーマ

401 - Unauthorized

空白

第3章 CredentialsRequest [cloudcredential.openshift.io/v1]

説明
CredentialsRequest は、credentialsrequests API のスキーマです。
object
必須
  • spec

3.1. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

spec

object

CredentialsRequestSpec は、CredentialsRequest の望ましい状態を定義します

status

object

CredentialsRequestStatus は、CredentialsRequest の監視状態を定義します

3.1.1. .spec

説明
CredentialsRequestSpec は、CredentialsRequest の望ましい状態を定義します
object
必須
  • secretRef
Expand
プロパティー説明

cloudTokenPath

string

cloudTokenPath は、認証情報シークレットを要求するワークロードのデプロイメントに Kubernetes ServiceAccount トークン (JSON Web トークン) がマウントされるパスです。このフィールドが spec.providerSpec.stsIAMRoleARN などのフィールドと組み合わせて存在する場合、CCO は、AWS Secure Token Service (STS) などのトークンベースの認証方法に必要なフィールドを含む認証情報シークレットの作成を仲介する必要があることを示します。cloudTokenPath は、ccoctl が生成する Azure 設定シークレットで使用される azure_federated_token_file パスの指定にも使用できます。デフォルトは "/var/run/secrets/openshift/serviceaccount/token" です。

providerSpec

``

ProviderSpec には、クラウドプロバイダー固有のクレデンシャル仕様が含まれています。

secretRef

object

SecretRef は、生成されたクレデンシャルを保存する必要があるシークレットを指します。

serviceAccountNames

array (string)

ServiceAccountNames には、この CredentialsRequest に関連付けられた権限を使用する ServiceAccounts のリストが含まれています。これは CCO によって使用されませんが、ServiceAccounts がクラウドクレデンシャルフローの一部として使用される場合に、クラウドプロバイダーでアクセス制御を適切に設定できるようにするための情報が必要です。

3.1.2. .spec.secretRef

説明
SecretRef は、生成されたクレデンシャルを保存する必要があるシークレットを指します。
object
Expand
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。TODO: この設計は最終版ではないので今後このフィールドは変更される可能性があります。

kind

string

参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

3.1.3. .status

説明
CredentialsRequestStatus は、CredentialsRequest の監視状態を定義します
object
必須
  • lastSyncGeneration
  • provisioned
Expand
プロパティー説明

conditions

array

条件には、CredentialsRequest の詳細なステータスが含まれます

conditions[]

object

CredentialsRequestCondition には、CredentialsRequest オブジェクトの条件の詳細が含まれています

lastSyncCloudCredsSecretResourceVersion

string

LastSyncCloudCredsSecretResourceVersion は、クレデンシャル要求リソースが最後に同期されたときのクラウドクレデンシャルシークレットリソースのリソースバージョンです。前回の同期以降にクラウドクレデンシャルが更新されたかどうかを判断するために使用されます。

lastSyncGeneration

integer

LastSyncGeneration は、最後に同期された認証情報要求リソースの生成です。オブジェクトが変更され、同期が必要かどうかを判断するために使用されます。

lastSyncTimestamp

string

LastSyncTimestamp は、認証情報が最後に同期された時刻です。

providerStatus

``

ProviderStatus には、クラウドプロバイダー固有のステータスが含まれます。

provisioned

boolean

クレデンシャルが最初にプロビジョニングされると、プロビジョニングは真になります。

3.1.4. .status.conditions

説明
条件には、CredentialsRequest の詳細なステータスが含まれます
array

3.1.5. .status.conditions[]

説明
CredentialsRequestCondition には、CredentialsRequest オブジェクトの条件の詳細が含まれています
object
必須
  • status
  • type
Expand
プロパティー説明

lastProbeTime

string

LastProbeTime は、状態をプローブした最後の時間です

lastTransitionTime

string

LastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。

message

string

message は、遷移の詳細を示す人が判読できるメッセージです。

reason

string

Reason は、条件の最後の遷移の一意の 1 単語の CamelCase 理由です。

status

string

ステータスは状態のステータスです

type

string

タイプは、条件の特定のタイプです

3.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/cloudcredential.openshift.io/v1/credentialsrequests

    • GET: 種類のオブジェクトをリスト表示する CredentialsRequest
  • /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests

    • DELETE:CredentialsRequest のコレクションを削除します
    • GET: 種類のオブジェクトをリスト表示する CredentialsRequest
    • POST:CredentialsRequest を作成します
  • /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests/{name}

    • 削除:CredentialsRequest を削除します
    • GET: 指定された CredentialsRequest を読み取ります
    • PATCH: 指定された CredentialsRequest を部分的に更新します
    • PUT: 指定された CredentialsRequest を置き換えます
  • /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests/{name}/status

    • GET: 指定された CredentialsRequest のステータスを読み取ります
    • PATCH: 指定された CredentialsRequest のステータスを部分的に更新します
    • PUT: 指定された CredentialsRequest のステータスを置き換えます

3.2.1. /apis/cloudcredential.openshift.io/v1/credentialsrequests

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する CredentialsRequest
Expand
表3.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequestList スキーマ

401 - Unauthorized

空白

3.2.2. /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests

HTTP メソッド
DELETE
説明
CredentialsRequest のコレクションを削除します
Expand
表3.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
種類のオブジェクトをリスト表示する CredentialsRequest
Expand
表3.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequestList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
CredentialsRequest を作成します。
Expand
表3.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.5 ボディーパラメーター
パラメーター説明

body

CredentialsRequest スキーマ

 
Expand
表3.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequest スキーマ

201 - Created

CredentialsRequest スキーマ

202 - Accepted

CredentialsRequest スキーマ

401 - Unauthorized

空白

3.2.3. /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests/{name}

Expand
表3.7 グローバルパスパラメーター
パラメーター説明

name

string

CredentialsRequest の名前

HTTP メソッド
DELETE
説明
CredentialsRequest を削除する
Expand
表3.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表3.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された CredentialsRequest を読み込む。
Expand
表3.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された CredentialsRequest を部分的に更新します。
Expand
表3.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された CredentialsRequest を置き換えます。
Expand
表3.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.14 ボディーパラメーター
パラメーター説明

body

CredentialsRequest スキーマ

 
Expand
表3.15 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequest スキーマ

201 - Created

CredentialsRequest スキーマ

401 - Unauthorized

空白

3.2.4. /apis/cloudcredential.openshift.io/v1/namespaces/{namespace}/credentialsrequests/{name}/status

Expand
表3.16 グローバルパスパラメーター
パラメーター説明

name

string

CredentialsRequest の名前

HTTP メソッド
GET
説明
指定された CredentialsRequest のステータスを読み取る。
Expand
表3.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された CredentialsRequest の部分的な更新状況
Expand
表3.18 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.19 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequest スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された CredentialsRequest のステータスを置き換える。
Expand
表3.20 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表3.21 ボディーパラメーター
パラメーター説明

body

CredentialsRequest スキーマ

 
Expand
表3.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

CredentialsRequest スキーマ

201 - Created

CredentialsRequest スキーマ

401 - Unauthorized

空白

第4章 PodSecurityPolicyReview [security.openshift.io/v1]

説明

PodSecurityPolicyReview は、問題の PodTemplateSpec を作成できるサービスアカウント (ユーザーではなく、クラスター全体であるため) をチェックします。

互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

object
必須
  • spec

4.1. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

spec

object

PodSecurityPolicyReviewSpec は、PodSecurityPolicyReview の仕様を定義します。

status

object

PodSecurityPolicyReviewStatus は、PodSecurityPolicyReview のステータスを表します。

4.1.1. .spec

説明
PodSecurityPolicyReviewSpec は、PodSecurityPolicyReview の仕様を定義します。
object
必須
  • template
Expand
プロパティー説明

serviceAccountNames

array (string)

serviceAccountNames は、チェックを実行する ServiceAccounts のオプションのセットです。serviceAccountName が空の場合、template.spec.serviceAccountName が使用されます。ただし、空の場合は代わりに "default" が使用されます。serviceAccountName を指定した場合、template.spec.serviceAccountName は無視されます。

template

PodTemplateSpec

テンプレートは、チェックする PodTemplateSpec です。template.spec.serviceAccountName フィールドは、serviceAccountName が空の場合に使用されます。ただし、template.spec.serviceAccountName が空の場合は、"default" が使用されます。serviceAccountName を指定した場合、template.spec.serviceAccountName は無視されます。

4.1.2. .status

説明
PodSecurityPolicyReviewStatus は、PodSecurityPolicyReview のステータスを表します。
object
必須
  • allowedServiceAccounts
Expand
プロパティー説明

allowedServiceAccounts

array

allowedServiceAccounts は、PodTemplateSpec を作成する権限を持つ この namespace 内のサービスアカウントのリストを返します。

allowedServiceAccounts[]

object

ServiceAccountPodSecurityPolicyReviewStatus は、ServiceAccount 名と関連するレビューステータスを表します

4.1.3. .status.allowedServiceAccounts

説明
allowedServiceAccounts は、PodTemplateSpec を作成する権限を持つ この namespace 内のサービスアカウントのリストを返します。
array

4.1.4. .status.allowedServiceAccounts[]

説明
ServiceAccountPodSecurityPolicyReviewStatus は、ServiceAccount 名と関連するレビューステータスを表します
object
必須
  • name
Expand
プロパティー説明

allowedBy

ObjectReference

allowedBy は、PodTemplateSpec を許可するルールへの参照です。ルールは、SecurityContextConstraint または PodSecurityPolicy A nil にすることができ、拒否されたことを示します。

name

string

name には、許可された ServiceAccount 名と拒否された ServiceAccount 名が含まれる

reason

string

この操作のステータスが "Failure" である理由の、機械による判読が可能な説明。この値が空の場合、利用可能な情報はありません。

template

PodTemplateSpec

template はデフォルト化された後の PodTemplateSpec です。

4.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicyreviews

    • POST: PodSecurityPolicyReview を作成する

4.2.1. /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicyreviews

Expand
表4.1 グローバルクエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

HTTP メソッド
POST
説明
PodSecurityPolicyReview を作成する
Expand
表4.2 本文パラメーター
パラメーター説明

body

PodSecurityPolicyReview スキーマ

 
Expand
表4.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PodSecurityPolicyReview スキーマ

201 - Created

PodSecurityPolicyReview スキーマ

202 - Accepted

PodSecurityPolicyReview スキーマ

401 - Unauthorized

空白

第5章 PodSecurityPolicySelfSubjectReview [security.openshift.io/v1]

説明

PodSecurityPolicySelfSubjectReview は、このユーザー/SA タプルが PodTemplateSpec を作成できるかどうかを確認します

互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

object
必須
  • spec

5.1. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

spec

object

PodSecurityPolicySelfSubjectReviewSpec には、PodSecurityPolicySelfSubjectReview の仕様が含まれています。

status

object

PodSecurityPolicySubjectReviewStatus は PodSecurityPolicySubjectReview に関する情報/ステータスを含んでいます。

5.1.1. .spec

説明
PodSecurityPolicySelfSubjectReviewSpec には、PodSecurityPolicySelfSubjectReview の仕様が含まれています。
object
必須
  • template
Expand
プロパティー説明

template

PodTemplateSpec

テンプレートは、チェックする PodTemplateSpec です。

5.1.2. .status

説明
PodSecurityPolicySubjectReviewStatus は PodSecurityPolicySubjectReview に関する情報/ステータスを含んでいます。
object
Expand
プロパティー説明

allowedBy

ObjectReference

allowedBy は、PodTemplateSpec を許可するルールへの参照です。ルールは、SecurityContextConstraint または PodSecurityPolicy A nil にすることができ、拒否されたことを示します。

reason

string

この操作のステータスが "Failure" である理由の、機械による判読が可能な説明。この値が空の場合、利用可能な情報はありません。

template

PodTemplateSpec

template はデフォルト化された後の PodTemplateSpec です。

5.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicyselfsubjectreviews

    • POST: PodSecurityPolicySelfSubjectReview を作成します。

5.2.1. /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicyselfsubjectreviews

Expand
表5.1 グローバルクエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

HTTP メソッド
POST
説明
PodSecurityPolicySelfSubjectReview の作成
Expand
表5.2 本文パラメーター
パラメーター説明

body

PodSecurityPolicySelfSubjectReview スキーマ

 
Expand
表5.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PodSecurityPolicySelfSubjectReview スキーマ

201 - Created

PodSecurityPolicySelfSubjectReview スキーマ

202 - Accepted

PodSecurityPolicySelfSubjectReview スキーマ

401 - Unauthorized

空白

第6章 PodSecurityPolicySubjectReview [security.openshift.io/v1]

説明

PodSecurityPolicySubjectReview は、特定のユーザー/SA タプルが PodTemplateSpec を作成できるかどうかをチェックします。

互換性レベル 2: メジャーリリース内で最低 9 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

object
必須
  • spec

6.1. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

spec

object

PodSecurityPolicySubjectReviewSpec は、PodSecurityPolicySubjectReview の仕様を定義します。

status

object

PodSecurityPolicySubjectReviewStatus は PodSecurityPolicySubjectReview に関する情報/ステータスを含んでいます。

6.1.1. .spec

説明
PodSecurityPolicySubjectReviewSpec は、PodSecurityPolicySubjectReview の仕様を定義します。
object
必須
  • template
Expand
プロパティー説明

groups

array (string)

グループは、テストしているグループです。

template

PodTemplateSpec

テンプレートは、チェックする PodTemplateSpec です。template.spec.serviceAccountName が空の場合、デフォルトになりません。空でない場合は、チェックされます。

user

string

user は、テストしているユーザーです。"user" を指定して "group" を指定しないと、"user がどのグループのメンバーでもない場合はどうなるか" と解釈されます。user と group が空の場合、テンプレート内の serviceAccountName のみで チェックを行います。

6.1.2. .status

説明
PodSecurityPolicySubjectReviewStatus は PodSecurityPolicySubjectReview に関する情報/ステータスを含んでいます。
object
Expand
プロパティー説明

allowedBy

ObjectReference

allowedBy は、PodTemplateSpec を許可するルールへの参照です。ルールは、SecurityContextConstraint または PodSecurityPolicy A nil にすることができ、拒否されたことを示します。

reason

string

この操作のステータスが "Failure" である理由の、機械による判読が可能な説明。この値が空の場合、利用可能な情報はありません。

template

PodTemplateSpec

template はデフォルト化された後の PodTemplateSpec です。

6.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicysubjectreviews

    • POST: PodSecurityPolicySubjectReview の作成

6.2.1. /apis/security.openshift.io/v1/namespaces/{namespace}/podsecuritypolicysubjectreviews

Expand
表6.1 グローバルクエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

HTTP メソッド
POST
説明
PodSecurityPolicySubjectReview の作成
Expand
表6.2 本文パラメーター
パラメーター説明

body

PodSecurityPolicySubjectReview スキーマ

 
Expand
表6.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

PodSecurityPolicySubjectReview スキーマ

201 - Created

PodSecurityPolicySubjectReview スキーマ

202 - Accepted

PodSecurityPolicySubjectReview スキーマ

401 - Unauthorized

空白

第7章 RangeAllocation [security.openshift.io/v1]

説明

RangeAllocation が使用されるため、セキュリティーグループ用に入力された RangeAllocation を簡単に公開できます。

互換性レベル 4: 互換性は提供されていません。API は、理由を問わずいつでも変更できます。これらの機能は、長期サポートを必要とするアプリケーションで使用することはできません。

object
必須
  • range
  • data

7.1. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

data

string

data は、範囲指定のシリアライズされた状態を表すバイト配列です。各ビットを 1 にして範囲を表すビットマップが取得されます。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

metadata は標準オブジェクトのメタデータです。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

range

string

range は、uid の範囲を表す一意のラベルを表す文字列で、"1000000000-2000000000/10000" です。

7.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/security.openshift.io/v1/rangeallocations

    • DELETE: RangeAllocation のコレクションを削除します
    • GET: RangeAllocation の種類のオブジェクトをリストまたは監視します。
    • POST: RangeAllocation を作成する
  • /apis/security.openshift.io/v1/watch/rangeallocations

    • GET: RangeAllocation のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /apis/security.openshift.io/v1/rangeallocations/{name}

    • DELETE: RangeAllocation を削除します
    • GET: 指定された RangeAllocation を読み込みます。
    • PATCH: 指定された RangeAllocation を部分的に更新します。
    • PUT: 指定された RangeAllocation を置き換える
  • /apis/security.openshift.io/v1/watch/rangeallocations/{name}

    • GET: RangeAllocation の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

7.2.1. /apis/security.openshift.io/v1/rangeallocations

HTTP メソッド
DELETE
説明
RangeAllocation のコレクションを削除します
Expand
表7.1 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表7.2 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
RangeAllocation の種類のオブジェクトをリストまたは監視します。
Expand
表7.3 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

RangeAllocationList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
create a RangeAllocation
Expand
表7.4 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.5 ボディーパラメーター
パラメーター説明

body

RangeAllocation スキーマ

 
Expand
表7.6 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RangeAllocation スキーマ

201 - Created

RangeAllocation スキーマ

202 - Accepted

RangeAllocation スキーマ

401 - Unauthorized

空白

7.2.2. /apis/security.openshift.io/v1/watch/rangeallocations

HTTP メソッド
GET
説明
RangeAllocation のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表7.7 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

7.2.3. /apis/security.openshift.io/v1/rangeallocations/{name}

Expand
表7.8 グローバルパスパラメーター
パラメーター説明

name

string

RangeAllocation の名前

HTTP メソッド
DELETE
説明
RangeAllocation の作成
Expand
表7.9 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表7.10 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された RangeAllocation を読み込む
Expand
表7.11 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

RangeAllocation スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された RangeAllocation を部分的に更新する
Expand
表7.12 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.13 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RangeAllocation スキーマ

201 - Created

RangeAllocation スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された RangeAllocation を置き換える
Expand
表7.14 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表7.15 ボディーパラメーター
パラメーター説明

body

RangeAllocation スキーマ

 
Expand
表7.16 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

RangeAllocation スキーマ

201 - Created

RangeAllocation スキーマ

401 - Unauthorized

空白

7.2.4. /apis/security.openshift.io/v1/watch/rangeallocations/{name}

Expand
表7.17 グローバルパスパラメーター
パラメーター説明

name

string

RangeAllocation の名前

HTTP メソッド
GET
説明
RangeAllocation の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表7.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

第8章 Secret [v1]

説明
Secret は特定のタイプのシークレットデータを保持します。Data フィールドの値の合計バイト数は MaxSecretSize バイト未満である必要があります。
object

8.1. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

data

object (string)

data にはシークレットデータが含まれます。各キーは英数字、'-'、'_'、または '.' で構成される必要があります。シークレットデータのシリアライズ形式は base64 でエンコードされた文字列で、ここでは任意 (文字列以外の場合あり) のデータ値を表します。詳細は https://tools.ietf.org/html/rfc4648#section-4 を参照してください。

immutable

boolean

true に設定されていない場合、シークレットに保存されているデータを更新できなくなります (オブジェクトメタデータのみを変更できます)。true に設定されていない場合、いつでもフィールドを変更できます。デフォルトは nil です。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

stringData

object (string)

stringData では、バイナリー以外のシークレットデータを文字列形式で指定できます。便宜上、書き込み専用の入力フィールドとして提供されています。すべてのキーと値は書き込み時にデータフィールドにマージされ、既存の値を上書きします。API から読み取るときに、stringData フィールドが出力されることはありません。

type

string

シークレットデータのプログラムによる処理を容易にするために使用されます。詳細は、https://kubernetes.io/docs/concepts/configuration/secret/#secret-types を参照してください。

8.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /api/v1/secrets

    • GET: Secret の種類のオブジェクトをリストまたは監視する。
  • /api/v1/watch/secrets

    • GET: Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
  • /api/v1/namespaces/{namespace}/secrets

    • DELETE: Secret のコレクションを削除する
    • GET: Secret の種類のオブジェクトをリストまたは監視する。
    • POST: シークレットを作成する
  • /api/v1/watch/namespaces/{namespace}/secrets

    • GET: Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
  • /api/v1/namespaces/{namespace}/secrets/{name}

    • DELETE: Secret を削除する
    • GET: 指定された Secret を読み込みます。
    • PATCH: 指定された Secret を部分的に更新します。
    • PUT: 指定された Secret を置き換えます。
  • /api/v1/watch/namespaces/{namespace}/secrets/{name}

    • GET: Secret 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

8.2.1. /api/v1/secrets

HTTP メソッド
GET
説明
Secret の種類のオブジェクトをリストまたは監視する
Expand
表8.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

SecretList スキーマ

401 - Unauthorized

空白

8.2.2. /api/v1/watch/secrets

HTTP メソッド
GET
説明
Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
Expand
表8.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

8.2.3. /api/v1/namespaces/{namespace}/secrets

HTTP メソッド
DELETE
説明
Secret のコレクションを削除します
Expand
表8.3 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表8.4 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
Secret の種類のオブジェクトをリストまたは監視する
Expand
表8.5 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

SecretList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
シークレットの作成
Expand
表8.6 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.7 ボディーパラメーター
パラメーター説明

body

Secret スキーマ

 
Expand
表8.8 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Secret スキーマ

201 - Created

Secret スキーマ

202 - Accepted

Secret スキーマ

401 - Unauthorized

空白

8.2.4. /api/v1/watch/namespaces/{namespace}/secrets

HTTP メソッド
GET
説明
Secret のリストへ個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
Expand
表8.9 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

8.2.5. /api/v1/namespaces/{namespace}/secrets/{name}

Expand
表8.10 グローバルパスパラメーター
パラメーター説明

name

string

シークレットの名前

HTTP メソッド
DELETE
説明
シークレットの削除
Expand
表8.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表8.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された Secret を読み込む
Expand
表8.13 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Secret スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された Secret を部分的に更新する
Expand
表8.14 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Secret スキーマ

201 - Created

Secret スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された Secret を置き換える
Expand
表8.16 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表8.17 ボディーパラメーター
パラメーター説明

body

Secret スキーマ

 
Expand
表8.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Secret スキーマ

201 - Created

Secret スキーマ

401 - Unauthorized

空白

8.2.6. /api/v1/watch/namespaces/{namespace}/secrets/{name}

Expand
表8.19 グローバルパスパラメーター
パラメーター説明

name

string

シークレットの名前

HTTP メソッド
GET
説明
Secret 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表8.20 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

第9章 SecurityContextConstraints [security.openshift.io/v1]

説明
SecurityContextConstraints は、コンテナーに適用される SecurityContext に影響を与える要求を行う機能を管理します。歴史的な理由から、SCC はコア Kubernetes API グループの下で公開されていました。このエクスポージャーは非推奨であり、将来のリリースで削除される予定です。代わりに、ユーザーは security.openshift.io グループを使用して SecurityContextConstraints を管理する必要があります。互換性レベル 1: メジャーリリース内で最低 12 カ月または 3 つのマイナーリリース (どちらか長い方) の間 Stable です。
object
必須
  • allowHostDirVolumePlugin
  • allowHostIPC
  • allowHostNetwork
  • allowHostPID
  • allowHostPorts
  • allowPrivilegedContainer
  • readOnlyRootFilesystem

9.1. 仕様

Expand
プロパティー説明

allowHostDirVolumePlugin

boolean

AllowHostDirVolumePlugin は、ポリシーがコンテナーに HostDir ボリュームプラグインの使用を許可するかどうかを決定します

allowHostIPC

boolean

AllowHostIPC は、ポリシーがコンテナー内のホスト ipc を許可するかどうかを決定します。

allowHostNetwork

boolean

AllowHostNetwork は、ポリシーが Pod 仕様で HostNetwork の使用を許可するかどうかを決定します。

allowHostPID

boolean

AllowHostPID は、ポリシーがコンテナー内のホスト pid を許可するかどうかを決定します。

allowHostPorts

boolean

AllowHostPorts は、ポリシーがコンテナー内のホストポートを許可するかどうかを決定します。

allowPrivilegeEscalation

``

AllowPrivilegeEscalation は、Pod が特権の昇格を許可するように要求できるかどうかを決定します。指定しない場合は、デフォルトで true になります。

allowPrivilegedContainer

boolean

AllowPrivilegedContainer は、コンテナーが特権としての実行を要求できるかどうかを判別します。

allowedCapabilities

``

AllowedCapabilities は、コンテナーに追加するように要求できる機能のリストです。このフィールドの機能は、Pod 作成者の判断で追加される場合があります。AllowedCapabilities と RequiredDropCapabilities の両方に機能を追加することはできません。すべての機能を許可するには、'*' を使用できます。

allowedFlexVolumes

``

AllowedFlexVolumes は、許可された Flexvolume のホワイトリストです。空または nil は、すべての Flexvolume を使用できることを示します。このパラメーターは、"Volumes" フィールドで Flexvolumes の使用が許可されている場合にのみ有効です。

allowedUnsafeSysctls

``

AllowedUnsafeSysctls は、明示的に許可された安全でない sysctl のリストであり、デフォルトは none です。各エントリーは、プレーンな sysctl 名であるか、"" で終わります。この場合は、許可された sysctl の接頭辞と見なされます。1 つの * は、すべての安全でない sysctl が許可されることを意味します。Kubelet は、拒否を回避するために、許可されているすべての安全でない sysctl を明示的にホワイトリストに登録する必要があります。例: たとえば、"foo/" は、"foo/bar"、"foo/baz" などを許可し、"foo.*" は、"foo.bar"、"foo.baz" などを許可します。

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

defaultAddCapabilities

``

DefaultAddCapabilities は、Pod 仕様で機能が明確に削除されない限り、コンテナーに追加されるデフォルトの機能セットです。DefaultAddCapabilities と RequiredDropCapabilities の両方に機能をリストすることはできません。

defaultAllowPrivilegeEscalation

``

DefaultAllowPrivilegeEscalation は、プロセスが親プロセスよりも多くの特権を取得できるかどうかのデフォルト設定を制御します。

forbiddenSysctls

``

ForbiddenSysctls は、明示的に禁止されている sysctl のリストであり、デフォルトは none です。各エントリーは、プレーンな sysctl 名であるか、"" で終わります。この場合は、禁止されている sysctl の接頭辞と見なされます。1 つの * は、すべての sysctl が禁止されていることを意味します。例: たとえば、"foo/" は、"foo/bar"、"foo/baz" などを禁止し、"foo.*" は、"foo.bar"、"foo.baz" などを禁止します。

fsGroup

``

FSGroup は、SecurityContext によって使用される fs グループを決定するストラテジーです。

groups

``

このセキュリティーコンテキスト制約を使用する権限を持つグループ

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

priority

``

優先度は、Users フィールドおよび Groups フィールドのアクセスに基づいて、特定の Pod 要求に対して最初に試行する SCC を評価するときに SCC の並べ替え順序に影響を与えます。int が高いほど、優先度が高くなります。値を設定しないと、優先度が 0 と見なされます。複数の SCC のスコアが等しい場合は、最も制限の厳しいものから最も制限の少ないものへと並び替えられます。優先度および制限のどちらも等しい場合、SCC は名前順に並べ替えられます。

readOnlyRootFilesystem

boolean

ReadOnlyRootFilesystem を true に設定すると、コンテナーは読み取り専用のルートファイルシステムで実行します。コンテナーが読み取り専用ではないルートファイルシステムでの実行を特に要求する場合、SCC は Pod を拒否する必要があります。false に設定すると、コンテナーは必要に応じて読み取り専用のルートファイルシステムで実行できますが、強制されることはありません。

requiredDropCapabilities

``

RequiredDropCapabilities は、コンテナーから削除するケイパビリティーです。これらは削除する必要があり、追加はできません。

runAsUser

``

RunAsUser は、SecurityContext で使用される RunAsUser を決定するストラテジーです。

seLinuxContext

``

SELinuxContext は、SecurityContext に設定されるラベルを指示するストラテジーです。

seccompProfiles

``

SeccompProfiles は、Pod またはコンテナーの seccomp アノテーションに設定できる許可されるプロファイルをリスト表示します。未設定 (nil) または空の値は、Pod またはコンテナーによってプロファイルを指定できないことを意味します。ワイルドカード '*' を使用して、すべてのプロファイルを許可できます。Pod の値を生成するために使用される場合は、最初のワイルドカード以外のプロファイルがデフォルトとして使用されます。

supplementalGroups

``

SupplementalGroups は、SecurityContext によって使用される補足グループを指示するストラテジーです。

users

``

このセキュリティーコンテキストの制約を使用する権限を持つユーザー

volumes

``

ボリュームは、許可されたボリュームプラグインのホワイトリストです。FSType は、VolumeSource のフィールド名 (azureFile、configMap、emptyDir) に直接対応します。すべてのボリュームを許可するには、"*" を使用できます。ボリュームを許可しない場合は、["none"] に設定します。

9.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /apis/security.openshift.io/v1/securitycontextconstraints

    • DELETE: SecurityContextConstraints のコレクションを削除します。
    • GET: Kind が SecurityContextConstraints のオブジェクトを一覧表示します。
    • POST: SecurityContextConstraints を作成します。
  • /apis/security.openshift.io/v1/watch/securitycontextconstraints

    • GET: SecurityContextConstraints のリストに対する個々の変更を監視します。非推奨です。代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /apis/security.openshift.io/v1/securitycontextconstraints/{name}

    • DELETE: SecurityContextConstraints を削除します。
    • GET: 指定された SecurityContextConstraints を読み取ります。
    • PATCH: 指定された SecurityContextConstraints を部分的に更新します。
    • PUT: 指定された SecurityContextConstraints を置き換えます。
  • /apis/security.openshift.io/v1/watch/securitycontextconstraints/{name}

    • GET: 種類 SecurityContextConstraints のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで 1 つの項目にフィルタリングします。

9.2.1. /apis/security.openshift.io/v1/securitycontextconstraints

HTTP メソッド
DELETE
説明
SecurityContextConstraints のコレクションを削除します。
Expand
表9.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
Kind が SecurityContextConstraints のオブジェクトを一覧表示します。
Expand
表9.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

SecurityContextConstraintsList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
SecurityContextConstraints を作成します。
Expand
表9.3 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表9.4 ボディーパラメーター
パラメーター説明

body

SecurityContextConstraints スキーマ

 
Expand
表9.5 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

SecurityContextConstraints スキーマ

201 - Created

SecurityContextConstraints スキーマ

202 - Accepted

SecurityContextConstraints スキーマ

401 - Unauthorized

空白

9.2.2. /apis/security.openshift.io/v1/watch/securitycontextconstraints

HTTP メソッド
GET
説明
SecurityContextConstraints のリストに対する個々の変更を監視します。非推奨です。代わりに、リスト操作で 'watch' パラメーターを使用してください。
Expand
表9.6 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

9.2.3. /apis/security.openshift.io/v1/securitycontextconstraints/{name}

Expand
表9.7 グローバルパスパラメーター
パラメーター説明

name

string

SecurityContextConstraints の名前

HTTP メソッド
DELETE
説明
SecurityContextConstraints を削除します。
Expand
表9.8 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表9.9 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された SecurityContextConstraints を読み込みます。
Expand
表9.10 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

SecurityContextConstraints スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された SecurityContextConstraints を部分的に更新します。
Expand
表9.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表9.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

SecurityContextConstraints スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された SecurityContextConstraints を置き換えます。
Expand
表9.13 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表9.14 ボディーパラメーター
パラメーター説明

body

SecurityContextConstraints スキーマ

 
Expand
表9.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

SecurityContextConstraints スキーマ

201 - Created

SecurityContextConstraints スキーマ

401 - Unauthorized

空白

9.2.4. /apis/security.openshift.io/v1/watch/securitycontextconstraints/{name}

Expand
表9.16 グローバルパスパラメーター
パラメーター説明

name

string

SecurityContextConstraints の名前

HTTP メソッド
GET
説明
種類 SecurityContextConstraints のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで 1 つの項目にフィルタリングします。
Expand
表9.17 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

第10章 ServiceAccount [v1]

説明
ServiceAccount は互いにバインドします:*ユーザーおよびおそらく周辺システムによって理解される ID の名前*認証および承認できるプリンシパル*一連のシークレット
object

10.1. 仕様

Expand
プロパティー説明

apiVersion

string

apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。

automountServiceAccountToken

boolean

AutomountServiceAccountToken は、このサービスアカウントとして実行している Pod に API トークンを自動的にマウントする必要があるかどうかを示します。Pod レベルでオーバーライドできます。

imagePullSecrets

array

ImagePullSecrets は、この ServiceAccount を参照する Pod 内のイメージをプルするのに使用する同じ namespace 内のシークレットへの参照のリストです。Secrets は Pod にマウントできるため、ImagePullSecrets は Secrets とは異なりますが、ImagePullSecrets には kubelet からのみアクセスできます。詳細: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod

imagePullSecrets[]

object

LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。

kind

string

kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

metadata

ObjectMeta

標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

secrets

array

Secrets は、この ServiceAccount を使用して実行されている Pod が使用できる同じ名前空間内のシークレットのリストです。このサービスアカウントの "kubernetes.io/enforce-mountable-secrets" アノテーションが "true" に設定されている場合、Pod はこのリストにのみ制限されます。このフィールドは、Pod の外部で使用する自動生成されたサービスアカウントトークンのシークレット検索に使用しないでください。代わりに、トークンは TokenRequest API を使用して直接要求することも、サービスアカウントトークンシークレットを手動で作成することも可能です。詳細: https://kubernetes.io/docs/concepts/configuration/secret

secrets[]

object

ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

10.1.1. .imagePullSecrets

説明
ImagePullSecrets は、この ServiceAccount を参照する Pod 内のイメージをプルするのに使用する同じ namespace 内のシークレットへの参照のリストです。Secrets は Pod にマウントできるため、ImagePullSecrets は Secrets とは異なりますが、ImagePullSecrets には kubelet からのみアクセスできます。詳細: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod
array

10.1.2. .imagePullSecrets[]

説明
LocalObjectReference には、同じ namespace 内で参照オブジェクトを見つけるのに十分な情報が含まれます。
object
Expand
プロパティー説明

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

10.1.3. .secrets

説明
Secrets は、この ServiceAccount を使用して実行されている Pod が使用できる同じ名前空間内のシークレットのリストです。このサービスアカウントの "kubernetes.io/enforce-mountable-secrets" アノテーションが "true" に設定されている場合、Pod はこのリストにのみ制限されます。このフィールドは、Pod の外部で使用する自動生成されたサービスアカウントトークンのシークレット検索に使用しないでください。代わりに、トークンは TokenRequest API を使用して直接要求することも、サービスアカウントトークンシークレットを手動で作成することも可能です。詳細: https://kubernetes.io/docs/concepts/configuration/secret
array

10.1.4. .secrets[]

説明
ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
object
Expand
プロパティー説明

apiVersion

string

参照先の API バージョン。

fieldPath

string

オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。

kind

string

参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。

name

string

参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace

string

参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion

string

この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid

string

参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

10.2. API エンドポイント

以下の API エンドポイントを利用できます。

  • /api/v1/serviceaccounts

    • GET: ServiceAccount の種類のオブジェクトをリスト表示または監視する
  • /api/v1/watch/serviceaccounts

    • GET: ServiceAccount のリストに対する個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用してください。
  • /api/v1/namespaces/{namespace}/serviceaccounts

    • DELETE: ServiceAccount のコレクションを削除します
    • GET: ServiceAccount の種類のオブジェクトをリスト表示または監視する
    • POST: ServiceAccount を作成します
  • /api/v1/watch/namespaces/{namespace}/serviceaccounts

    • GET: ServiceAccount のリストに対する個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用してください。
  • /api/v1/namespaces/{namespace}/serviceaccounts/{name}

    • DELETE: ServiceAccount を削除します。
    • GET: 指定された ServiceAccount を読み取ります。
    • PATCH: 指定された ServiceAccount を部分的に更新します。
    • PUT: 指定された ServiceAccount を置き換えます。
  • /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}

    • GET: ServiceAccount 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

10.2.1. /api/v1/serviceaccounts

HTTP メソッド
GET
説明
ServiceAccount の種類のオブジェクトをリスト表示または監視する
Expand
表10.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ServiceAccountList スキーマ

401 - Unauthorized

空白

10.2.2. /api/v1/watch/serviceaccounts

HTTP メソッド
GET
説明
ServiceAccount のリストに対する個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
Expand
表10.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

10.2.3. /api/v1/namespaces/{namespace}/serviceaccounts

HTTP メソッド
DELETE
説明
ServiceAccount のコレクションを削除する
Expand
表10.3 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表10.4 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
ServiceAccount の種類のオブジェクトをリスト表示または監視する
Expand
表10.5 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ServiceAccountList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ServiceAccount を作成します。
Expand
表10.6 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表10.7 ボディーパラメーター
パラメーター説明

body

ServiceAccount スキーマ

 
Expand
表10.8 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ServiceAccount スキーマ

201 - Created

ServiceAccount スキーマ

202 - Accepted

ServiceAccount スキーマ

401 - Unauthorized

空白

10.2.4. /api/v1/watch/namespaces/{namespace}/serviceaccounts

HTTP メソッド
GET
説明
ServiceAccount のリストに対する個々の変更を監視します。非推奨: 代わりにリスト操作で 'watch' パラメーターを使用します。
Expand
表10.9 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

10.2.5. /api/v1/namespaces/{namespace}/serviceaccounts/{name}

Expand
表10.10 グローバルパスパラメーター
パラメーター説明

name

string

ServiceAccount の名前

HTTP メソッド
DELETE
説明
ServiceAccount を削除する
Expand
表10.11 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

Expand
表10.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ServiceAccount スキーマ

202 - Accepted

ServiceAccount スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ServiceAccount を読み込む
Expand
表10.13 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ServiceAccount スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ServiceAccount を部分的に更新する
Expand
表10.14 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表10.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ServiceAccount スキーマ

201 - Created

ServiceAccount スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ServiceAccount を置き換える
Expand
表10.16 クエリーパラメーター
パラメーター説明

dryRun

string

これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

fieldValidation

string

fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

Expand
表10.17 ボディーパラメーター
パラメーター説明

body

ServiceAccount スキーマ

 
Expand
表10.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ServiceAccount スキーマ

201 - Created

ServiceAccount スキーマ

401 - Unauthorized

空白

10.2.6. /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}

Expand
表10.19 グローバルパスパラメーター
パラメーター説明

name

string

ServiceAccount の名前

HTTP メソッド
GET
説明
ServiceAccount 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
Expand
表10.20 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

Legal Notice

Copyright © 2025 Red Hat

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat