30.16. PersistentVolume [v1]


Description
PersistentVolume (PV) は、管理者によってプロビジョニングされたストレージリソースです。これはノードに似ています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes
タイプ
object

30.16.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

PersistentVolumeSpec は永続ボリュームの仕様です。

status

object

PersistentVolumeStatus は、永続ボリュームの現在のステータスです。

30.16.1.1. .spec

Description
PersistentVolumeSpec は永続ボリュームの仕様です。
タイプ
object
Expand
プロパティータイプDescription

accessModes

array (string)

AccessModes には、ボリュームのマウント方法がすべて含まれています。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

awsElasticBlockStore

object

AWS の永続ディスクリソースを表します。

AWS EBS ディスクは、コンテナーにマウントする前に存在している必要があります。また、ディスクは kubelet と同じ AWS ゾーンにある必要があります。AWS EBS ディスクは、読み取り/書き込みとして 1 回だけマウントできます。AWS EBS ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

azureDisk

object

azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。

azureFile

object

AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。

capacity

オブジェクト(Quantity)

永続ボリュームのリソースおよび容量の説明。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

cephfs

object

Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。

cinder

object

Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

claimRef

object

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

csi

object

外部 CSI ボリュームドライバーによって管理されるストレージを表します (ベータ機能)

fc

object

ファイバーチャネルボリュームを表します。ファイバーチャネルボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ファイバーチャネルボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

flexVolume

object

FlexPersistentVolumeSource は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用の永続ボリュームリソースを表します。

flocker

object

Flocker エージェントによってマウントされた Flocker ボリュームを表します。datasetName および datasetUUID の 1 つだけを設定する必要があります。Flocker ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

gcePersistentDisk

object

Google Compute Engine の永続ディスクリソースを表します。

GCE PD は、コンテナーにマウントする前に存在している必要があります。ディスクは、kubelet と同じ GCE プロジェクトおよびゾーンにある必要もあります。GCE PD は、読み取り/書き込みとして 1 回のみマウントできます。また、読み取り専用としては何度でもマウントできます。GCE PD は、所有権管理および SELinux の再ラベル付けをサポートします。

glusterfs

object

Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

hostPath

object

Pod にマップされたホストパスを表します。ホストパスボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

iscsi

object

ISCSIPersistentVolumeSource は、ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

local

object

Local は、ノードアフィニティーを備えた直接接続ストレージを表します (ベータ機能)

mountOptions

array (string)

マウントオプションのリスト。例 ["ro", "soft"]検証されていません - 無効な場合、マウントは失敗します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

nfs

object

Pod の存続期間中続く NFS マウントを表します。NFS ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

nodeAffinity

object

VolumeNodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。

persistentVolumeReclaimPolicy

string

永続ボリュームが要求から解放された場合に、永続ボリュームに何が起きるか。有効なオプションは Retain (手動で作成された PersistentVolumes のデフォルト)、Delete (動的にプロビジョニングされる PersistentVolumes のデフォルト)、および Recycle (非推奨) です。Recycle は、この PersistentVolume の基礎となるボリュームプラグインでサポートされる必要があります。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

photonPersistentDisk

object

Photon Controller 永続ディスクリソースを表します。

portworxVolume

object

PortworxVolumeSource は、Portworx ボリュームリソースを表します。

quobyte

object

Pod の存続期間中続く Quobyte マウントを表します。Quobyte ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。

rbd

object

Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

scaleIO

object

ScaleIOPersistentVolumeSource は、永続的な ScaleIO ボリュームを表します

storageClassName

string

この永続ボリュームが属する StorageClass の名前。空の値は、このボリュームが StorageClass に属していないことを意味します。

storageos

object

StorageOS 永続ボリュームリソースを表します。

volumeMode

string

volumeMode は、ボリュームをフォーマットされたファイルシステムで使用するか、または raw ブロック状態のままにするかを定義します。Filesystem の値は、spec に含まれていない場合に暗示されます。

vsphereVolume

object

vSphere ボリュームリソースを表します。

30.16.1.2. .spec.awsElasticBlockStore

Description

AWS の永続ディスクリソースを表します。

AWS EBS ディスクは、コンテナーにマウントする前に存在している必要があります。また、ディスクは kubelet と同じ AWS ゾーンにある必要があります。AWS EBS ディスクは、読み取り/書き込みとして 1 回だけマウントできます。AWS EBS ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。

タイプ
object
必須
  • volumeID
Expand
プロパティータイプDescription

fsType

string

マウントするボリュームのファイルシステムタイプ。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例:ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

パーティション

integer

マウントするボリューム内のパーティション。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを 1 として指定します。同様に、/dev/sda のボリュームパーティションは 0 です (または、プロパティーを空のままにしておくこともできます)。

readOnly

boolean

true を指定すると、VolumeMounts の ReadOnly プロパティーが強制的に true に設定されます。省略した場合、デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

volumeID

string

AWS の永続ディスクリソースの一意の ID(Amazon EBS ボリューム)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

30.16.1.3. .spec.azureDisk

Description
azureDisk は、ホスト上の Azure Data Disk マウントを表し、Pod へのバインドマウントを表します。
タイプ
object
必須
  • diskName
  • diskURI
Expand
プロパティータイプDescription

cachingMode

string

ホストキャッシングモード: なし、読み取り専用、読み取り/書き込み。

diskName

string

Blob ストレージのデータディスクの名前。

diskURI

string

BLOB ストレージ内のデータディスクの URI

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。

kind

string

期待値共有: ストレージアカウントごとに複数の BLOB ディスク専用: ストレージアカウントごとに単一の BLOB ディスク管理対象:Azure 管理対象データディスク (管理対象可用性セットのみ)。デフォルトは共有

readOnly

boolean

デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

30.16.1.4. .spec.azureFile

Description
AzureFile は、ホスト上の Azure File Service マウントを表し、マウントを Pod にバインドします。
タイプ
object
必須
  • secretName
  • shareName
Expand
プロパティータイプDescription

readOnly

boolean

デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretName

string

Azure ストレージアカウントの名前とキーを含むシークレットの名前

secretNamespace

string

Azure Storage Account Name および Key のデフォルトを含むシークレットの namespace は Pod と同じです

shareName

string

共有名。

30.16.1.5. .spec.cephfs

Description
Pod の存続期間中持続する Ceph ファイルシステムマウントを表します。Cephfs ボリュームは所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • monitors
Expand
プロパティータイプDescription

monitors

array (string)

必須: モニターは Ceph モニターのコレクションです。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

path

string

オプション: 完全な Ceph ツリーではなく、マウントされたルートとして使用されます。デフォルトは/です。

readOnly

boolean

オプション: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretFile

string

オプション: SecretFile はユーザーのキーリングへのパスです。デフォルトは /etc/ceph/user.secret です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

secretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

user

string

オプション: ユーザーは rados ユーザー名、デフォルトは admin です。詳細: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

30.16.1.6. .spec.cephfs.secretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.7. .spec.cinder

Description
Openstack の cinder ボリュームリソースを表します。コンテナーにマウントする前に、Cinder ボリュームが存在している必要があります。ボリュームも、kubelet と同じ領域にある必要があります。Cinder ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
タイプ
object
必須
  • volumeID
Expand
プロパティータイプDescription

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。例:ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

readOnly

boolean

オプション: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

secretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

volumeID

string

燃えがらのボリュームを識別するために使用されるボリューム ID。詳細: https://examples.k8s.io/mysql-cinder-pd/README.md

30.16.1.8. .spec.cinder.secretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.9. .spec.claimRef

Description
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

30.16.1.10. .spec.csi

Description
外部 CSI ボリュームドライバーによって管理されるストレージを表します (ベータ機能)
タイプ
object
必須
  • driver
  • volumeHandle
Expand
プロパティータイプDescription

controllerExpandSecretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

controllerPublishSecretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

driver

string

Driver は、このボリュームに使用するドライバーの名前です。必須。

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。

nodePublishSecretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

nodeStageSecretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

readOnly

boolean

オプション: ControllerPublishVolumeRequest に渡す値。デフォルトは false (読み取り/書き込み) です。

volumeAttributes

object (string)

公開するボリュームの属性。

volumeHandle

string

VolumeHandle は、CSI ボリュームプラグインの CreateVolume により返される一意のボリューム名であり、後続のすべての呼び出しでボリュームを参照します。必須。

30.16.1.11. .spec.csi.controllerExpandSecretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.12. .spec.csi.controllerPublishSecretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.13. .spec.csi.nodePublishSecretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.14. .spec.csi.nodeStageSecretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.15. .spec.fc

Description
ファイバーチャネルボリュームを表します。ファイバーチャネルボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ファイバーチャネルボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
タイプ
object
Expand
プロパティータイプDescription

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。

lun

integer

オプション:FC ターゲットの論理ユニット番号

readOnly

boolean

オプション: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

targetWWNs

array (string)

オプション:FC ターゲットワールドワイドネーム (WWN)

wwids

array (string)

オプション:FC ボリュームのワールドワイド ID(wwids)wwids または targetWWN と lun の組み合わせのいずれかを設定する必要がありますが、両方を同時に設定することはできません。

30.16.1.16. .spec.flexVolume

Description
FlexPersistentVolumeSource は、exec ベースのプラグインを使用してプロビジョニング/接続される汎用の永続ボリュームリソースを表します。
タイプ
object
必須
  • driver
Expand
プロパティータイプDescription

driver

string

Driver は、このボリュームに使用するドライバーの名前です。

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。デフォルトのファイルシステムは FlexVolume スクリプトに依存します。

options

object (string)

オプション: 追加のコマンドオプション (ある場合)。

readOnly

boolean

オプション: デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

30.16.1.17. .spec.flexVolume.secretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.18. .spec.flocker

Description
Flocker エージェントによってマウントされた Flocker ボリュームを表します。datasetName および datasetUUID の 1 つだけを設定する必要があります。Flocker ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
Expand
プロパティータイプDescription

datasetName

string

メタデータとして保存されているデータセットの名前→Flocker のデータセットの名前は非推奨と見なす必要があります

datasetUUID

string

データセットの UUID。これは Flocker データセットの一意の識別子です

30.16.1.19. .spec.gcePersistentDisk

Description

Google Compute Engine の永続ディスクリソースを表します。

GCE PD は、コンテナーにマウントする前に存在している必要があります。ディスクは、kubelet と同じ GCE プロジェクトおよびゾーンにある必要もあります。GCE PD は、読み取り/書き込みとして 1 回のみマウントできます。また、読み取り専用としては何度でもマウントできます。GCE PD は、所有権管理および SELinux の再ラベル付けをサポートします。

タイプ
object
必須
  • pdName
Expand
プロパティータイプDescription

fsType

string

マウントするボリュームのファイルシステムタイプ。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例:ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

パーティション

integer

マウントするボリューム内のパーティション。省略した場合、デフォルトではボリューム名でマウントします。例: ボリューム/dev/sda1 の場合、パーティションを 1 として指定します。同様に、/dev/sda のボリュームパーティションは 0 です (または、プロパティーを空のままにしておくこともできます)。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

pdName

string

GCE での PD リソースの一意の名前。GCE でディスクを識別するために使用されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

readOnly

boolean

ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

30.16.1.20. .spec.glusterfs

Description
Pod の存続期間中続く Glusterfs マウントを表します。Glusterfs ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • endpoints
  • path
Expand
プロパティータイプDescription

endpoints

string

EndpointsName は、Glusterfs トポロジーの詳細を示すエンドポイント名です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

endpointsNamespace

string

EndpointsNamespace は、Glusterfs エンドポイントを含む namespace です。このフィールドが空の場合、EndpointNamespace はデフォルトでバインドされた PVC と同じ namespace になります。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

path

string

パスは Glusterfs ボリュームパスです。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

readOnly

boolean

ここでの読み取り専用は、Glusterfs ボリュームを読み取り専用のアクセス許可で強制的にマウントします。デフォルトは false です。詳細: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

30.16.1.21. .spec.hostPath

Description
Pod にマップされたホストパスを表します。ホストパスボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • path
Expand
プロパティータイプDescription

path

string

ホスト上のディレクトリーのパス。パスがシンボリックリンクの場合、実際のパスへのリンクをたどります。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

type

string

HostPath ボリュームのデフォルトのタイプは "" です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

30.16.1.22. .spec.iscsi

Description
ISCSIPersistentVolumeSource は、ISCSI ディスクを表します。ISCSI ボリュームは、読み取り/書き込みとして 1 回だけマウントできます。ISCSI ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
タイプ
object
必須
  • targetPortal
  • iqn
  • lun
Expand
プロパティータイプDescription

chapAuthDiscovery

boolean

iSCSI ディスカバリー CHAP 認証をサポートするかどうか

chapAuthSession

boolean

iSCSI セッション CHAP 認証をサポートするかどうか

fsType

string

マウントするボリュームのファイルシステムタイプ。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例:ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

initiatorName

string

カスタム iSCSI イニシエーター名。iscsiInterface と同時に initiatorName を指定すると、接続用に新しい iSCSI インターフェイス < ターゲットポータル >:< ボリューム名 > が作成されます。

iqn

string

ターゲット iSCSI 修飾名。

iscsiInterface

string

iSCSI トランスポートを使用する iSCSI インターフェイス名。デフォルトは defaults (tcp) です。

lun

integer

iSCSI ターゲットの Lun 番号。

portals

array (string)

iSCSI ターゲットポータルリスト。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

readOnly

boolean

ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。デフォルトは false です。

secretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

targetPortal

string

iSCSI ターゲットポータル。ポートがデフォルト以外の場合、ポータルは IP または ip_addr:port のいずれかです (通常は TCP ポート 860 および 3260)。

30.16.1.23. .spec.iscsi.secretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.24. .spec.local

Description
Local は、ノードアフィニティーを備えた直接接続ストレージを表します (ベータ機能)
タイプ
object
必須
  • path
Expand
プロパティータイプDescription

fsType

string

マウントするファイルシステムタイプ。Path がブロックデバイスの場合にのみ適用されます。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。デフォルト値は、指定されていないと、ファイルシステムを自動選択します。

path

string

ノード上のボリュームへのフルパス。これは、ディレクトリーまたはブロックデバイス (ディスク、パーティションなど) のいずれかです。

30.16.1.25. .spec.nfs

Description
Pod の存続期間中続く NFS マウントを表します。NFS ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • server
  • path
Expand
プロパティータイプDescription

path

string

NFS サーバーがエクスポートしているパス。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

readOnly

boolean

ここでの読み取り専用は、NFS エクスポートを読み取り専用のアクセス許可でマウントするように強制します。デフォルトは false です。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

server

string

サーバーは、NFS サーバーのホスト名または IP アドレスです。詳細: https://kubernetes.io/docs/concepts/storage/volumes#nfs

30.16.1.26. .spec.nodeAffinity

Description
VolumeNodeAffinity は、このボリュームにアクセスできるノードを制限する制約を定義します。
タイプ
object
Expand
プロパティータイプDescription

required

object

ノードセレクターは、ノードのセットに対する 1 つ以上のラベルクエリーの結果の和集合を表します。つまり、ノードセレクター用語で表されるセレクターの OR を表します。

30.16.1.27. .spec.nodeAffinity.required

Description
ノードセレクターは、ノードのセットに対する 1 つ以上のラベルクエリーの結果の和集合を表します。つまり、ノードセレクター用語で表されるセレクターの OR を表します。
タイプ
object
必須
  • nodeSelectorTerms
Expand
プロパティータイプDescription

nodeSelectorTerms

array

必須。ノードセレクター用語のリスト。用語は OR されています。

nodeSelectorTerms[]

object

null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。

30.16.1.28. .spec.nodeAffinity.required.nodeSelectorTerms

Description
必須。ノードセレクター用語のリスト。用語は OR されています。
タイプ
array

30.16.1.29. .spec.nodeAffinity.required.nodeSelectorTerms[]

Description
null または空のノードセレクター用語はオブジェクトに一致しません。これらの要件は AND で結合されます。TopologySelectorTerm タイプは、NodeSelectorTerm のサブセットを実装します。
タイプ
object
Expand
プロパティータイプDescription

matchExpressions

array

ノードのラベルごとのノードセレクター要件のリスト。

matchExpressions[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

matchFields

array

ノードのフィールドごとのノードセレクター要件のリスト。

matchFields[]

object

ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。

30.16.1.30. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions

Description
ノードのラベルごとのノードセレクター要件のリスト。
タイプ
array

30.16.1.31. .spec.nodeAffinity.required.nodeSelectorTerms[].matchExpressions[]

Description
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
タイプ
object
必須
  • key
  • operator
Expand
プロパティータイプDescription

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

30.16.1.32. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields

Description
ノードのフィールドごとのノードセレクター要件のリスト。
タイプ
array

30.16.1.33. .spec.nodeAffinity.required.nodeSelectorTerms[].matchFields[]

Description
ノードセレクター要件は、値、キー、およびキーと値を関連付ける Operator を含むセレクターです。
タイプ
object
必須
  • key
  • operator
Expand
プロパティータイプDescription

key

string

セレクターが適用されるラベルキー。

operator

string

キーと値のセットの関係を表します。有効な Operator は、In、NotIn、Exists、DoesNotExist です。Gt、および Lt。

array (string)

文字列値の配列。operator が In または NotIn の場合には、values 配列を空白にできません。operator が Exists または DoesNotExist の場合には、values 配列は空白でなければなりません。Operator が Gt または Lt の場合、values 配列には、整数として解釈される単一の要素が必要です。この配列は、ストラテジーに基づいたマージパッチの適用中に置き換えられます。

30.16.1.34. .spec.photonPersistentDisk

Description
Photon Controller 永続ディスクリソースを表します。
タイプ
object
必須
  • pdID
Expand
プロパティータイプDescription

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。

pdID

string

PhotonController 永続ディスクを識別する ID

30.16.1.35. .spec.portworxVolume

Description
PortworxVolumeSource は、Portworx ボリュームリソースを表します。
タイプ
object
必須
  • volumeID
Expand
プロパティータイプDescription

fsType

string

FSType は、マウントするファイルシステムタイプを表します。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs。指定されていない場合、暗黙的に ext4 であると推測されます。

readOnly

boolean

デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

volumeID

string

VolumeID は、Portworx ボリュームを一意に識別します

30.16.1.36. .spec.quobyte

Description
Pod の存続期間中続く Quobyte マウントを表します。Quobyte ボリュームは、所有権管理または SELinux の再ラベル付けをサポートしていません。
タイプ
object
必須
  • レジストリー
  • ボリューム
Expand
プロパティータイプDescription

group

string

ボリュームアクセスをデフォルトにマップするグループはグループではありません

readOnly

boolean

ここでの読み取り専用は、Quobyte ボリュームを読み取り専用のアクセス許可で強制的にマウントします。デフォルトは false です。

レジストリー

string

レジストリーは、ボリュームの中央レジストリーとして機能する host:port ペア (複数のエントリーはコンマで区切られます) として文字列として指定された単一または複数の Quobyte レジストリーサービスを表します

tenant

string

バックエンドで特定の Quobyte ボリュームを所有しているテナント動的にプロビジョニングされた Quobyte ボリュームで使用され、値はプラグインによって設定されます

user

string

ボリュームアクセスをデフォルトにマップするユーザーから serivceaccount ユーザー

ボリューム

string

ボリュームは、すでに作成されているクオバイトボリュームを名前で参照する文字列です。

30.16.1.37. .spec.rbd

Description
Pod の存続時間中続く Rados Block Device マウントを表します。RBD ボリュームは、所有権管理および SELinux の再ラベル付けをサポートします。
タイプ
object
必須
  • monitors
  • image
Expand
プロパティータイプDescription

fsType

string

マウントするボリュームのファイルシステムタイプ。ヒント: ファイルシステムタイプがホストオペレーティングシステムでサポートされていることを確認してください。例:ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。詳細: https://kubernetes.io/docs/concepts/storage/volumes#rbd

image

string

rados イメージ名。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

keyring

string

キーリングは、RBDUser のキーリングへのパスです。デフォルトは/etc/ceph/keyring です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

monitors

array (string)

Ceph Monitor のコレクション。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

pool

string

rados プール名。デフォルトは rbd です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

readOnly

boolean

ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。デフォルトは false です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

secretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

user

string

rados ユーザー名。これにより、プール内にイメージを作成できます。 デフォルトは admin です。詳細: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

30.16.1.38. .spec.rbd.secretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.39. .spec.scaleIO

Description
ScaleIOPersistentVolumeSource は、永続的な ScaleIO ボリュームを表します
タイプ
object
必須
  • gateway
  • system
  • secretRef
Expand
プロパティータイプDescription

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。デフォルトは xfs です。

gateway

string

ScaleIOAPI ゲートウェイのホストアドレス。

protectionDomain

string

設定されたストレージの ScaleIO 保護ドメインの名前。

readOnly

boolean

デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります

sslEnabled

boolean

ゲートウェイとの SSL 通信を有効/無効にするフラグ、デフォルトは false

storageMode

string

ボリュームのストレージを ThickProvisioned にするか ThinProvisioned にするかを示します。デフォルトは ThinProvisioned です。

storagePool

string

保護ドメインに関連付けられた ScaleIO ストレージプール。

system

string

ScaleIO で設定されたストレージシステムの名前。

volumeName

string

このボリュームソースに関連付けられている、ScaleIO システムですでに作成されているボリュームの名前。

30.16.1.40. .spec.scaleIO.secretRef

Description
SecretReference は、シークレットリファレンスを表します。任意の名前空間でシークレットを取得するのに十分な情報があります
タイプ
object
Expand
プロパティータイプ説明

name

string

名前は、名前空間内で一意であり、秘密のリソースを参照します。

namespace

string

名前空間は、秘密の名前が一意でなければならないスペースを定義します。

30.16.1.41. .spec.storageos

Description
StorageOS 永続ボリュームリソースを表します。
タイプ
object
Expand
プロパティータイプDescription

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。

readOnly

boolean

デフォルトは false (読み取り/書き込み) です。ここで ReadOnly を指定すると、VolumeMounts で ReadOnly 設定が強制的に実行されます。

secretRef

object

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

volumeName

string

VolumeName は、人間が読める形式の StorageOS ボリュームの名前です。ボリューム名は、ネームスペース内でのみ一意です。

volumeNamespace

string

VolumeNamespace は、StorageOS 内のボリュームのスコープを指定します。名前空間が指定されていない場合は、Pod の名前空間が使用されます。これにより、Kubernetes の名前スコープを StorageOS 内にミラーリングして、より緊密に統合することができます。VolumeName を任意の名前に設定して、デフォルトの動作をオーバーライドします。StorageOS 内で名前空間を使用していない場合は、デフォルトに設定します。StorageOS 内に事前に存在しない名前空間が作成されます。

30.16.1.42. .spec.storageos.secretRef

Description
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

30.16.1.43. .spec.vsphereVolume

Description
vSphere ボリュームリソースを表します。
タイプ
object
必須
  • volumePath
Expand
プロパティータイプDescription

fsType

string

マウントするファイルシステムタイプ。ホストオペレーティングシステムでサポートされているファイルシステムタイプである必要があります。元。ext4、xfs、ntfs。指定されていない場合、暗黙的に ext4 であると推測されます。

storagePolicyID

string

StoragePolicyName に関連付けられたストレージポリシーベースの管理 (SPBM) プロファイル ID。

storagePolicyName

string

ストレージポリシーベースの管理 (SPBM) プロファイル名。

volumePath

string

vSphere ボリューム vmdk を識別するパス

30.16.1.44. .status

Description
PersistentVolumeStatus は、永続ボリュームの現在のステータスです。
タイプ
object
Expand
プロパティータイプDescription

message

string

ボリュームがこの状態にある理由の詳細を示す、人が判読できる形式のメッセージ。

phase

string

Phase は、ボリュームが使用可能か、クレームにバインドされているか、またはクレームによってリリースされているかを示します。詳細: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase

reason

string

Reason は、障害を説明する簡単な CamelCase 文字列であり、CLI でのマシンの解析と整理された表示を目的としています。

30.16.2. API エンドポイント

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

  • /api/v1/persistentvolumes

    • DELETE: PersistentVolume のコレクションを削除する
    • GET: PersistentVolume 種類のオブジェクトを一覧表示または監視する
    • POST: PersistentVolume を作成する
  • /api/v1/watch/persistentvolumes

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

    • DELETE: PersistentVolume を削除する
    • GET: 指定された PersistentVolume を読み取る
    • PATCH: 指定された PersistentVolume を部分的に更新する
    • PUT: 指定された PersistentVolume を置き換える
  • /api/v1/watch/persistentvolumes/{name}

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

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

30.16.2.1. /api/v1/persistentvolumes

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

pretty

string

'true' の場合、出力はきれいに印刷されます。

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

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

orphanDependents

boolean

非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

Expand
表30.389 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions スキーマ

 
Expand
表30.390 HTTP 応答
HTTP コードレスポンス本文

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
PersistentVolume 種類のオブジェクトを一覧表示または監視する
Expand
表30.391 クエリーパラメーター
パラメータータイプ説明

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

Expand
表30.392 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolumeList schema

401 - Unauthorized

空白

HTTP メソッド
POST
Description
PersistentVolume を作成する
Expand
表30.393 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表30.394 ボディパラメーター
パラメータータイプ説明

body

PersistentVolume スキーマ

 
Expand
表30.395 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

202 - Accepted

PersistentVolume スキーマ

401 - Unauthorized

空白

30.16.2.2. /api/v1/watch/persistentvolumes

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

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

30.16.2.3. /api/v1/persistentvolumes/{name}

Expand
表30.398 グローバルパスパラメーター
パラメータータイプ説明

name

string

PersistentVolume の名前

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

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
DELETE
Description
PersistentVolume を削除する
Expand
表30.400 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

gracePeriodSeconds

integer

オブジェクトが削除されるまでの時間 (秒)。値は負の値ではない整数にする必要があります。値をゼロに指定すると、ただちに削除されます。この値が nil の場合、指定されたタイプのデフォルトの猶予期間が使用されます。指定しない場合、デフォルトでオブジェクトごとの値になります。ゼロはすぐに削除することを意味します。

orphanDependents

boolean

非推奨: PropagationPolicy を使用してください。このフィールドは 1.7 で非推奨となります。依存オブジェクトが孤立している必要があります。true/false の場合、孤立したファイナライザーがオブジェクトのファイナライザー一覧で追加/削除されます。このフィールドまたは PropagationPolicy のいずれかを設定できますが、両方を設定することはできません。

propagationPolicy

string

ガベージコレクションが実行されるかどうか、およびその方法。このフィールドまたは OrphanDependents のどちらかを設定できますが、両方を設定することはできません。デフォルトポリシーは、metadata.finalizers に設定されている既存のファイナライザーとリソース固有のデフォルトポリシーによって決定されます。許容値は次のとおりです。'Orphan' - 依存を削除して孤立させます。'Background' - ガベージコレクターがバックグラウンドで依存関係を削除できるようにします。'Foreground' - フォアグラウンド内のすべての依存関係を削除するカスケードポリシー。

Expand
表30.401 ボディパラメーター
パラメータータイプ説明

body

DeleteOptions スキーマ

 
Expand
表30.402 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolume スキーマ

202 - Accepted

PersistentVolume スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された PersistentVolume を読み取る
Expand
表30.403 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolume スキーマ

401 - Unauthorized

空白

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

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、適用要求 (application/apply-patch) には必須ですが、非適用パッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) にはオプションです。

force

boolean

Force は Apply リクエストを強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合、強制フラグを設定解除する必要があります。

Expand
表30.405 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表30.406 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

401 - Unauthorized

空白

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

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表30.408 ボディパラメーター
パラメータータイプ説明

body

PersistentVolume スキーマ

 
Expand
表30.409 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

401 - Unauthorized

空白

30.16.2.4. /api/v1/watch/persistentvolumes/{name}

Expand
表30.410 グローバルパスパラメーター
パラメータータイプ説明

name

string

PersistentVolume の名前

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

allowWatchBookmarks

boolean

allowWatchBookmarks は、タイプが BOOKMARK の監視イベントを要求します。ブックマークを実装していないサーバーはこのフラグを無視する可能性があり、ブックマークはサーバーの裁量で送信されます。クライアントは、ブックマークが特定の間隔で返されると想定したり、サーバーがセッション中に BOOKMARK イベントを送信すると想定したりすることはできません。これが watch でない場合には、このフィールドは無視されます。

continue

string

サーバーからさらに結果を取得する場合は、continue オプションを設定する必要があります。この値はサーバー定義であるため、クライアントは同じクエリーパラメーター (continue の値を除く) で前のクエリー結果からの continue 値のみを使用でき、サーバーは認識しない continue 値を拒否できます。指定された continue の値が有効期限切れ (通常 5-15 分) やサーバーでの設定変更により無効となった場合、サーバーは 410 ResourceExpired エラーと continue トークンを返します。クライアントが一貫性のあるリストを必要とする場合、続行フィールドなしでリストを再起動する必要があります。そうしないと、クライアントは 410 エラーで受信したトークンを使用して別のリスト要求を送信する可能性があり、サーバーは次のキーから始まるリストで応答しますが、前のリスト結果と矛盾する最新のスナップショットから - 作成されたオブジェクト、変更、または削除された後、最初のリストリクエストは、それらのキーが次のキーの後にある限り、応答に含まれます。

watch が true の場合、このフィールドはサポートされません。クライアントは、サーバーから返された最後の resourceVersion 値から監視を開始し、変更を見逃すことはありません。

fieldSelector

string

返されるオブジェクトのリストをフィールドごとに制限するセレクター。デフォルトはすべてです。

labelSelector

string

返されるオブジェクトのリストをラベルで制限するためのセレクターです。デフォルトはすべてです。

limit

integer

limit は、リスト呼び出しに対して返される応答の最大数です。さらにアイテムが存在する場合、サーバーはリストメタデータの continue フィールドを、同じ初期クエリーで使用して次の結果セットを取得できる値に設定します。制限を設定すると、要求されたすべてのオブジェクトが除外された場合に、要求された量より少ないアイテム (最大 0 個のアイテム) が返される場合があります。クライアントは、続行フィールドの存在のみを使用して、より多くの結果が利用可能かどうかを判断する必要があります。サーバーは limit 引数をサポートしないことを選択でき、利用可能なすべての結果を返します。制限が指定され、続行フィールドが空の場合、クライアントはこれ以上結果が利用できないと想定する場合があります。watch が true の場合、このフィールドはサポートされません。

サーバーは、continue を使用したときに返されるオブジェクトが、制限なしで単一のリスト呼び出しを発行するのと同じであることを保証します。つまり、最初の要求が発行された後に作成、変更、または削除されたオブジェクトは、後続の継続要求に含まれません。これは、一貫性のあるスナップショットと呼ばれることもあり、制限を使用して非常に大きな結果の小さなチャンクを受信するクライアントが、すべての可能なオブジェクトを確実に表示できるようにします。チャンクリスト中にオブジェクトが更新された場合、最初のリスト結果が計算されたときに存在していたオブジェクトのバージョンが返されます。

pretty

string

'true' の場合、出力はきれいに印刷されます。

resourceVersion

string

resourceVersion は、リクエストが提供される可能性のあるリソースバージョンに制約を設定します。詳細は、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch は、resourceVersion をリスト呼び出しに適用する方法を決定します。resourceVersion が設定されているリスト呼び出しには resourceVersionMatch を設定することを強くお勧めします。詳細については、https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions を参照してください。

Defaults to unset

timeoutSeconds

integer

リスト/ウォッチコールのタイムアウト。これにより、アクティビティーまたは非アクティブに関係なく、通話時間が制限されます。

watch

boolean

説明されているリソースへの変更を監視し、それらを追加、更新、および削除の通知のストリームとして返します。resourceVersion を指定します。

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

30.16.2.5. /api/v1/persistentvolumes/{name}/status

Expand
表30.413 グローバルパスパラメーター
パラメータータイプ説明

name

string

PersistentVolume の名前

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

pretty

string

'true' の場合、出力はきれいに印刷されます。

HTTP メソッド
GET
Description
指定された PersistentVolume のステータスを読み取る
Expand
表30.415 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolume スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された PersistentVolume のステータスを部分的に更新する
Expand
表30.416 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。このフィールドは、適用要求 (application/apply-patch) には必須ですが、非適用パッチタイプ (JsonPatch、MergePatch、StrategicMergePatch) にはオプションです。

force

boolean

Force は Apply リクエストを強制します。これは、ユーザーが他の人が所有する競合するフィールドを再取得することを意味します。非適用パッチ要求の場合、強制フラグを設定解除する必要があります。

Expand
表30.417 ボディパラメーター
パラメータータイプ説明

body

Patch schema

 
Expand
表30.418 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された PersistentVolume のステータスを置き換える
Expand
表30.419 クエリーパラメーター
パラメータータイプ説明

dryRun

string

これがある場合、変更を永続化してはならないことを示します。無効または認識されない dryRun ディレクティブは、エラーレスポンスを引き起こし、リクエストをそれ以上処理しません。有効な値: - All: すべてのドライランステージが処理されます。

fieldManager

string

fieldManager は、これらの変更を行っているアクターまたはエンティティーに関連付けられた名前です。値は 128 文字未満である必要があり、https://golang.org/pkg/unicode/#IsPrint で定義されているように、印刷可能な文字のみが含まれている必要があります。

Expand
表30.420 ボディパラメーター
パラメータータイプ説明

body

PersistentVolume スキーマ

 
Expand
表30.421 HTTP 応答
HTTP コードレスポンス本文

200 - OK

PersistentVolume スキーマ

201 - Created

PersistentVolume スキーマ

401 - Unauthorized

空白

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

Theme

© 2025 Red Hat